Jump to

• Request
• Response

getAllProductsPrices

get

/ccstore/v1/prices/products

Get All Products Prices. Return the the list, sale and complex prices for the list of products. Optionally takes the -ccasset-language header to get translated content in another language.

Request

Supported Media Types

• application/json

Query Parameters

• ids(optional): string
  the list of product IDs

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getAllProductsPrices_response

Type: object

Show Source

• If the returned type is a product or default(optional): object If the returned type is a product or default
  Result object having product related information.

{
    "properties":{
        "If the returned type is a product or default":{
            "description":"Result object having product related information.",
            "type":"object",
            "properties":{
                "skuPrices":{
                    "description":"The array of SKU data.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "complexPrice":{
                                "description":"The complex price of the sku.",
                                "type":"object",
                                "properties":{
                                    "levels":{
                                        "description":"Price levels of the Complex price.",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "price":{
                                                    "description":"The price associated with this level.",
                                                    "type":"number"
                                                },
                                                "levelMinimum":{
                                                    "description":"The minimum quantity associated with this level.",
                                                    "type":"number"
                                                },
                                                "levelMaximum":{
                                                    "description":"The maximum quantity associated with this level.",
                                                    "type":"number"
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "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"
                            }
                        }
                    }
                },
                "list":{
                    "description":"The list price of the product.",
                    "type":"number"
                },
                "priceRange":{
                    "description":"Whether the price is a range.",
                    "type":"boolean"
                }
            }
        }
    }
}

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

Type: object

Result object having product related information.

Show Source

• list(optional): number
  The list price of the product.
• priceRange(optional): boolean
  Whether the price is a range.
• skuPrices(optional): array skuPrices
  The array of SKU data.

{
    "description":"Result object having product related information.",
    "type":"object",
    "properties":{
        "skuPrices":{
            "description":"The array of SKU data.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "complexPrice":{
                        "description":"The complex price of the sku.",
                        "type":"object",
                        "properties":{
                            "levels":{
                                "description":"Price levels of the Complex price.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "price":{
                                            "description":"The price associated with this level.",
                                            "type":"number"
                                        },
                                        "levelMinimum":{
                                            "description":"The minimum quantity associated with this level.",
                                            "type":"number"
                                        },
                                        "levelMaximum":{
                                            "description":"The maximum quantity associated with this level.",
                                            "type":"number"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "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"
                    }
                }
            }
        },
        "list":{
            "description":"The list price of the product.",
            "type":"number"
        },
        "priceRange":{
            "description":"Whether the price is a range.",
            "type":"boolean"
        }
    }
}

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":{
            "complexPrice":{
                "description":"The complex price of the sku.",
                "type":"object",
                "properties":{
                    "levels":{
                        "description":"Price levels of the Complex price.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "price":{
                                    "description":"The price associated with this level.",
                                    "type":"number"
                                },
                                "levelMinimum":{
                                    "description":"The minimum quantity associated with this level.",
                                    "type":"number"
                                },
                                "levelMaximum":{
                                    "description":"The maximum quantity associated with this level.",
                                    "type":"number"
                                }
                            }
                        }
                    }
                }
            },
            "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

• complexPrice(optional): object complexPrice
  The complex price of the sku.
• listPrice(optional): number
  The list price of the SKU.
• salePrice(optional): number
  The sale price of the SKU.
• skuId(optional): string
  SKU ID.

{
    "type":"object",
    "properties":{
        "complexPrice":{
            "description":"The complex price of the sku.",
            "type":"object",
            "properties":{
                "levels":{
                    "description":"Price levels of the Complex price.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "price":{
                                "description":"The price associated with this level.",
                                "type":"number"
                            },
                            "levelMinimum":{
                                "description":"The minimum quantity associated with this level.",
                                "type":"number"
                            },
                            "levelMaximum":{
                                "description":"The maximum quantity associated with this level.",
                                "type":"number"
                            }
                        }
                    }
                }
            }
        },
        "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 : complexPrice

Type: object

The complex price of the sku.

Show Source

• levels(optional): array levels
  Price levels of the Complex price.

{
    "description":"The complex price of the sku.",
    "type":"object",
    "properties":{
        "levels":{
            "description":"Price levels of the Complex price.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "price":{
                        "description":"The price associated with this level.",
                        "type":"number"
                    },
                    "levelMinimum":{
                        "description":"The minimum quantity associated with this level.",
                        "type":"number"
                    },
                    "levelMaximum":{
                        "description":"The maximum quantity associated with this level.",
                        "type":"number"
                    }
                }
            }
        }
    }
}

Nested Schema : levels

Type: array

Price levels of the Complex price.

Show Source

• Array of: object items

{
    "description":"Price levels of the Complex price.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "price":{
                "description":"The price associated with this level.",
                "type":"number"
            },
            "levelMinimum":{
                "description":"The minimum quantity associated with this level.",
                "type":"number"
            },
            "levelMaximum":{
                "description":"The maximum quantity associated with this level.",
                "type":"number"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• levelMaximum(optional): number
  The maximum quantity associated with this level.
• levelMinimum(optional): number
  The minimum quantity associated with this level.
• price(optional): number
  The price associated with this level.

{
    "type":"object",
    "properties":{
        "price":{
            "description":"The price associated with this level.",
            "type":"number"
        },
        "levelMinimum":{
            "description":"The minimum quantity associated with this level.",
            "type":"number"
        },
        "levelMaximum":{
            "description":"The maximum quantity associated with this level.",
            "type":"number"
        }
    }
}

Example Response (application/json)

[
    {
        "prod10007":{
            "sale":null,
            "skuPrices":[
                {
                    "salePrice":null,
                    "skuId":"sku30081",
                    "listPrice":19.99
                },
                {
                    "salePrice":null,
                    "skuId":"sku30083",
                    "listPrice":19.99
                },
                {
                    "salePrice":null,
                    "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
                }
            ],
            "list":19.99,
            "priceRange":false
        }
    },
    {
        "prod10001":{
            "sale":null,
            "skuPrices":[
                {
                    "salePrice":null,
                    "skuId":"sku30003",
                    "listPrice":49
                },
                {
                    "salePrice":null,
                    "skuId":"sku30005",
                    "listPrice":49
                },
                {
                    "salePrice":null,
                    "skuId":"sku30007",
                    "listPrice":49
                },
                {
                    "salePrice":null,
                    "skuId":"sku30009",
                    "listPrice":49
                }
            ],
            "list":49,
            "priceRange":false
        }
    }
]

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): 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(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): 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