REST API for Oracle Commerce Cloud December 2017

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: Type: string

Required: true

The product ID.

Query Parameters

skuId: Type: string

The sku ID. If null, price for the product is returned.
type: Type: string

The type of price. Should be either of list or sale.

Header Parameters

X-CCAsset-Language: Type: string

The asset language of the request

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getAllPrices_response

Properties

If the returned type is a product or default: Type: object If the returned type is a product or default

Additional Properties Allowed:

Result object having product related information.
If the returned type is a sku.: Type: object If the returned type is a sku.

Additional Properties Allowed:

Result object having SKU related information.

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

Type: object

Result object having product related information.

Properties

list: Type: number

The list price of the product.
priceRange: Type: boolean

Whether the price is a range.
skuPrices: Type: array skuPrices

Additional Properties Allowed:

The array of SKU data.

Nested Schema : If the returned type is a sku.

Type: object

Result object having SKU related information.

Properties

list: Type: number

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

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

Nested Schema : skuPrices

Type: array

The array of SKU data.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

complexPrice: Type: object complexPrice

Additional Properties Allowed:

The complex price of the SKU.
listPrice: Type: number

The list price of the SKU.
salePrice: Type: number

The sale price of the SKU.
skuId: Type: string

SKU ID.

Nested Schema : complexPrice

Type: object

The complex price of the SKU.

Properties

levels: Type: array levels

Additional Properties Allowed:

Price levels of the Complex price.

Nested Schema : levels

Type: array

Price levels of the Complex price.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

levelMaximum: Type: number

The maximum quantity associated with this level.
levelMinimum: Type: number

The minimum quantity associated with this level.
price: Type: number

The price associated with this level.

Example 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

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "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
}