REST API for Oracle Commerce Cloud December 2017

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

the list of product IDs

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getAllProductsPrices_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.

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


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

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:

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