Jump to

• Request
• Response

getAllPrices

get

/ccstore/v1/prices/{id}

Get All Prices. Return the the list, sale and complex prices for the product or SKU. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  The product ID.

Query Parameters

• skuId: string
  The sku ID. If null, price for the product is returned.
• type: string
  The type of price. Should be either of list or sale.

Header Parameters

• X-CCAsset-Language: string
  The asset language of the request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getAllPrices_response

Type: object

Show Source

• If the returned type is a product or default: object If the returned type is a product or default
  All prices information for the specified product
• If the returned type is a sku.: object If the returned type is a sku.
  List price and sale price information for the SKU.

{
    "properties":{
        "If the returned type is a product or default":{
            "description":"All prices information for the specified product",
            "type":"object",
            "properties":{
                "priceMin":{
                    "description":"The minimum price of a sku in the product.",
                    "type":"number"
                },
                "priceMax":{
                    "description":"The maximum price of a sku in the product.",
                    "type":"number"
                },
                "skuPrices":{
                    "description":"The array of SKU data.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "salePrice":{
                                "description":"The sale price of the SKU.",
                                "type":"number"
                            },
                            "skuId":{
                                "description":"SKU ID.",
                                "type":"string"
                            },
                            "listPrice":{
                                "description":"The list price of the SKU(.",
                                "type":"number"
                            }
                        }
                    }
                },
                "priceRange":{
                    "description":"Whether the price is a range.",
                    "type":"boolean"
                }
            }
        },
        "If the returned type is a sku.":{
            "description":"List price and sale price information for the SKU.",
            "type":"object",
            "properties":{
                "sale":{
                    "description":"The sale price of the product (if type is selected as sale and sale price exists).",
                    "type":"number"
                },
                "list":{
                    "description":"The list price of the product (if type is selected as list).",
                    "type":"number"
                }
            }
        }
    }
}

Nested Schema : If the returned type is a product or default

Type: object

All prices information for the specified product

Show Source

• priceMax: number
  The maximum price of a sku in the product.
• priceMin: number
  The minimum price of a sku in the product.
• priceRange: boolean
  Whether the price is a range.
• skuPrices: array skuPrices
  The array of SKU data.

{
    "description":"All prices information for the specified product",
    "type":"object",
    "properties":{
        "priceMin":{
            "description":"The minimum price of a sku in the product.",
            "type":"number"
        },
        "priceMax":{
            "description":"The maximum price of a sku in the product.",
            "type":"number"
        },
        "skuPrices":{
            "description":"The array of SKU data.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "salePrice":{
                        "description":"The sale price of the SKU.",
                        "type":"number"
                    },
                    "skuId":{
                        "description":"SKU ID.",
                        "type":"string"
                    },
                    "listPrice":{
                        "description":"The list price of the SKU(.",
                        "type":"number"
                    }
                }
            }
        },
        "priceRange":{
            "description":"Whether the price is a range.",
            "type":"boolean"
        }
    }
}

Nested Schema : If the returned type is a sku.

Type: object

List price and sale price information for the SKU.

Show Source

• list: number
  The list price of the product (if type is selected as list).
• sale: number
  The sale price of the product (if type is selected as sale and sale price exists).

{
    "description":"List price and sale price information for the SKU.",
    "type":"object",
    "properties":{
        "sale":{
            "description":"The sale price of the product (if type is selected as sale and sale price exists).",
            "type":"number"
        },
        "list":{
            "description":"The list price of the product (if type is selected as list).",
            "type":"number"
        }
    }
}

Nested Schema : skuPrices

Type: array

The array of SKU data.

Show Source

• Array of: object items

{
    "description":"The array of SKU data.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "salePrice":{
                "description":"The sale price of the SKU.",
                "type":"number"
            },
            "skuId":{
                "description":"SKU ID.",
                "type":"string"
            },
            "listPrice":{
                "description":"The list price of the SKU(.",
                "type":"number"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• listPrice: number
  The list price of the SKU(.
• salePrice: number
  The sale price of the SKU.
• skuId: string
  SKU ID.

{
    "type":"object",
    "properties":{
        "salePrice":{
            "description":"The sale price of the SKU.",
            "type":"number"
        },
        "skuId":{
            "description":"SKU ID.",
            "type":"string"
        },
        "listPrice":{
            "description":"The list price of the SKU(.",
            "type":"number"
        }
    }
}

Example Response (application/json)

{
    "skuPrices":[
        {
            "salePrice":null,
            "bulkPrice":{
                "numLevels":4,
                "levels":[
                    {
                        "price":19.99,
                        "levelMinimum":1,
                        "levelMaximum":10
                    },
                    {
                        "price":16.25,
                        "levelMinimum":11,
                        "levelMaximum":20
                    },
                    {
                        "price":12.35,
                        "levelMinimum":21,
                        "levelMaximum":30
                    },
                    {
                        "price":10.25,
                        "levelMinimum":31
                    }
                ]
            },
            "skuId":"sku30081",
            "listPrice":19.99
        },
        {
            "tieredPrice":{
                "numLevels":4,
                "levels":[
                    {
                        "price":19.99,
                        "levelMinimum":1,
                        "levelMaximum":10
                    },
                    {
                        "price":16.25,
                        "levelMinimum":11,
                        "levelMaximum":20
                    },
                    {
                        "price":12.35,
                        "levelMinimum":21,
                        "levelMaximum":30
                    },
                    {
                        "price":10.25,
                        "levelMinimum":31
                    }
                ]
            },
            "salePrice":null,
            "skuId":"sku30083",
            "listPrice":19.99
        },
        {
            "salePrice":null,
            "bulkPrice":{
                "numLevels":4,
                "levels":[
                    {
                        "price":19.99,
                        "levelMinimum":1,
                        "levelMaximum":10
                    },
                    {
                        "price":16.25,
                        "levelMinimum":11,
                        "levelMaximum":20
                    },
                    {
                        "price":12.35,
                        "levelMinimum":21,
                        "levelMaximum":30
                    },
                    {
                        "price":10.25,
                        "levelMinimum":31
                    }
                ]
            },
            "skuId":"sku30085",
            "listPrice":19.99
        },
        {
            "salePrice":null,
            "skuId":"sku30087",
            "listPrice":19.99
        },
        {
            "salePrice":null,
            "skuId":"sku30089",
            "listPrice":19.99
        },
        {
            "salePrice":null,
            "skuId":"sku30091",
            "listPrice":19.99
        },
        {
            "salePrice":null,
            "skuId":"sku30093",
            "listPrice":19.99
        },
        {
            "salePrice":null,
            "skuId":"sku30095",
            "listPrice":19.99
        },
        {
            "salePrice":null,
            "skuId":"sku30097",
            "listPrice":19.99
        },
        {
            "salePrice":null,
            "skuId":"sku30099",
            "listPrice":19.99
        },
        {
            "salePrice":null,
            "skuId":"sku30101",
            "listPrice":19.99
        },
        {
            "salePrice":null,
            "skuId":"sku30103",
            "listPrice":19.99
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/prices/prod10007"
        }
    ],
    "list":19.99,
    "priceRange":false
}

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• 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: string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "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"
        },
        "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