Jump to

• Request
• Response

Get rate plans associated for cart item by ID

get

/ccstore/v1/orders/current/items/{id}/ratePlans

This API is used by the CX Commerce OSF Storefront. This API is currently not used by CX Commerce Classic Storefront but may be used in the future. It may be used in applications outside of CX Commerce Storefront.

Get the rate plans for the given cart item ID.

This endpoint is part of a group of APIs used in conjunction with each other to perform granular actions on the cart (current incomplete order).

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  The ID of the item to retrieve.

Query Parameters

• fields: string
  This controls which fields are returned in the response body. For example, to include the field1 and field2 in the response, you can send fields=field1,field2.
• limit: integer
  Specifies the number of rate plans to be obtained
• offset: integer
  Starting index
• orderby: string
  Specifies a comma-separated list of pairs to order the response by.
• q: string
  Search criteria to filter the search results based on various fields
• totalResults: boolean
  Indicates if the total results should be included in the response.

Header Parameters

• X-CCOrganization: string
  Current organization context of the logged in user
• X-CCVisitorId: string
  ID provided by the Oracle Commerce Visit Service to uniquely identify the current visitor. It is required for every request to enable full endpoint capabilities for all shopper types.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The success response

Body ()

Root Schema : getRatePlans_response

Type: object

Show Source

• id: string
  The commerce item id for which the rate plans are fetched

  Example: ci28000413
• items: array items
• limit: integer
  Specifies the number of rate plans to be retrieved starting from offset. In case this is not present, the complete list of rate plans for the commerceItem will be returned.

  Example: 25
• offset: integer
  Starting index when paging through rate plans

  Example: 0

{
    "type":"object",
    "properties":{
        "offset":{
            "description":"Starting index when paging through rate plans",
            "type":"integer",
            "example":0
        },
        "limit":{
            "description":"Specifies the number of rate plans to be retrieved starting from offset. In case this is not present, the complete list of rate plans for the commerceItem will be returned.",
            "type":"integer",
            "example":25
        },
        "id":{
            "description":"The commerce item id for which the rate plans are fetched",
            "type":"string",
            "example":"ci28000413"
        },
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"Rate plan name",
                        "type":"string",
                        "example":"Standard Plan"
                    },
                    "id":{
                        "description":"Rate plan ID",
                        "type":"string",
                        "example":"standardPlanRA01"
                    }
                },
                "required":[
                    "name",
                    "id"
                ]
            },
            "required":[
                "offset",
                "limit",
                "id",
                "items"
            ]
        }
    },
    "example":{
        "offset":0,
        "limit":25,
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:8080/ccstore/v1/orders/current/items/ci28000413/ratePlans"
            }
        ],
        "id":"ci28000413",
        "items":[
            {
                "name":"Standard Plan",
                "id":"standardPlanRA01"
            },
            {
                "name":"Flat Rate Plan",
                "id":"flatRatePlanRA01"
            }
        ]
    }
}

Example:

{
    "offset":0,
    "limit":25,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/orders/current/items/ci28000413/ratePlans"
        }
    ],
    "id":"ci28000413",
    "items":[
        {
            "name":"Standard Plan",
            "id":"standardPlanRA01"
        },
        {
            "name":"Flat Rate Plan",
            "id":"flatRatePlanRA01"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"Rate plan name",
                "type":"string",
                "example":"Standard Plan"
            },
            "id":{
                "description":"Rate plan ID",
                "type":"string",
                "example":"standardPlanRA01"
            }
        },
        "required":[
            "name",
            "id"
        ]
    },
    "required":[
        "offset",
        "limit",
        "id",
        "items"
    ]
}

Nested Schema : items

Type: object

Show Source

• id(required): string
  Rate plan ID

  Example: standardPlanRA01
• name(required): string
  Rate plan name

  Example: Standard Plan

{
    "type":"object",
    "properties":{
        "name":{
            "description":"Rate plan name",
            "type":"string",
            "example":"Standard Plan"
        },
        "id":{
            "description":"Rate plan ID",
            "type":"string",
            "example":"standardPlanRA01"
        }
    },
    "required":[
        "name",
        "id"
    ]
}

400 Response

The error response (which alternates to the default response depending on error reason).

Body ()

Root Schema : errorModelSingleError

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Default Response

The error response.

Body ()

Root Schema : errorModelMultiErrors

Type: object

Show Source

• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top