REST API for Oracle Commerce Cloud December 2017

listPriceListGroups

get

/ccadmin/v1/priceListGroups

List Price List Groups. Get a list of PriceListGroups.

Request

Supported Media Types

application/json

Query Parameters

active: Type: boolean

If null, don't filter active/inactive items. If true or false, return only items where active has that value.
defaultFirst: Type: boolean

This for displaying default PriceListGroup first in the list
includeDeleted: Type: boolean

If true, include soft deleted items in results. If false or not present, exclude them.
limit: Type: integer

The number of items to return.
offset: Type: integer

Index of the first element to return.
q: Type: string

The search query string in SCIM format. Results will be filtered based on this query.
siteId: Type: string

Site ID of the site
sort: Type: string

Sorting criteria.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : listPriceListGroups_response

Properties

items: Type: array items

Additional Properties Allowed:

List of PriceListGroups
limit: Type: integer

The number of items to return.
offset: Type: integer

Index of the first element to return.
sort: Type: array sort

Additional Properties Allowed:

Sorting criteria.
total: Type: integer

The total number of items. Deprecated.
totalResults: Type: integer

The total number of items.

Nested Schema : items

Type: array

List of PriceListGroups

Items

Type: object items

Additional Properties Allowed:

Nested Schema : sort

Type: array

Sorting criteria.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

active: Type: boolean

indicates if the PriceListGroup is activ.e
displayName: Type: string

display name of the PriceListGroup.
includeAllProducts: Type: boolean

If true, and active flag is also set to true then list price is mandatory for all products.
listPriceList: Type: object listPriceList

Additional Properties Allowed:

Price List for list prices
repositoryId: Type: string

The ID of the PriceListGroup item.
salePriceList: Type: object salePriceList

Additional Properties Allowed:

Price List for sale prices.
shippingSurchargePriceList: Type: object shippingSurchargePriceList

Additional Properties Allowed:

Price List for shipping surcharge prices.

Nested Schema : listPriceList

Type: object

Price List for list prices

Properties

repositoryId: Type: string

Repository ID of the list prices.

Nested Schema : salePriceList

Type: object

Price List for sale prices.

Properties

repositoryId: Type: string

Repository ID of the sale prices.

Nested Schema : shippingSurchargePriceList

Type: object

Price List for shipping surcharge prices.

Properties

repositoryId: Type: string

Repository ID of the shipping surcharge prices.

Nested Schema : items

Type: object

Properties

order: Type: string

Sort order: asc or desc.
property: Type: string

The property the listing is sorted by.

Example application/json


{
    "total":2,
    "totalResults":2,
    "offset":0,
    "limit":250,
    "defaultPriceListGroup":{
        "isTaxIncluded":false,
        "endDate":"2016-03-11T18:30:00.000Z",
        "displayName":"UsDollar",
        "listPriceList":{
            "repositoryId":"listPrices"
        },
        "active":false,
        "isPointsBased":false,
        "locale":"en_US",
        "shippingSurchargePriceList":{
            "repositoryId":"shippingSurchargePrices"
        },
        "taxCalculationType":"calculateTax",
        "repositoryId":"UsDollar",
        "salePriceList":{
            "repositoryId":"salePrices"
        },
        "currency":{
            "symbol":"$",
            "displayName":"US Dollar",
            "repositoryId":"en_US",
            "fractionalDigits":2,
            "currencyCode":"USD",
            "numericCode":"840"
        },
        "id":"UsDollar",
        "includeAllProducts":true,
        "startDate":"2016-03-10T18:30:00.000Z"
    },
    "sort":[
        {
            "property":"displayName",
            "order":"asc"
        }
    ],
    "items":[
        {
            "endDate":"2016-03-11T18:30:00.000Z",
            "displayName":null,
            "listPriceList":{
                "repositoryId":"listPrices"
            },
            "active":false,
            "isPointsBased":false,
            "locale":"en_US",
            "shippingSurchargePriceList":null,
            "taxCalculationType":"calculateTax",
            "repositoryId":"UsDollar",
            "salePriceList":{
                "repositoryId":"salePrices"
            },
            "currency":{
                "symbol":"$",
                "displayName":"US Dollar",
                "repositoryId":"en_US",
                "fractionalDigits":2,
                "currencyCode":"USD",
                "numericCode":"840"
            },
            "id":"UsDollar",
            "includeAllProducts":true,
            "startDate":"2016-03-10T18:30:00.000Z"
        },
        {
            "isTaxIncluded":false,
            "endDate":"2016-03-11T18:30:00.000Z",
            "displayName":"CanadianDollar",
            "listPriceList":{
                "repositoryId":"CanadianDollar_listPrice"
            },
            "active":false,
            "isPointsBased":false,
            "locale":"en_CA",
            "shippingSurchargePriceList":{
                "repositoryId":"CanadianDollar_shippingSurchargePrice"
            },
            "taxCalculationType":"calculateTax",
            "repositoryId":"CanadianDollar",
            "salePriceList":{
                "repositoryId":"CanadianDollar_salePrice"
            },
            "id":"CanadianDollar",
            "includeAllProducts":false,
            "startDate":"2016-03-10T18:30:00.000Z"
        }
    ]
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |20185|There was an error fetching the PriceListGroup list.|

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:

{
  "total": 2,
  "totalResults": 2,
  "offset": 0,
  "limit": 250,
  "defaultPriceListGroup": {
    "isTaxIncluded": false,
    "endDate": "2016-03-11T18:30:00.000Z",
    "displayName": "UsDollar",
    "listPriceList": {"repositoryId": "listPrices"},
    "active": false,
    "isPointsBased": false,
    "locale": "en_US",
    "shippingSurchargePriceList": {"repositoryId": "shippingSurchargePrices"},
    "taxCalculationType": "calculateTax",
    "repositoryId": "UsDollar",
    "salePriceList": {"repositoryId": "salePrices"},
    "currency": {
      "symbol": "$",
      "displayName": "US Dollar",
      "repositoryId": "en_US",
      "fractionalDigits": 2,
      "currencyCode": "USD",
      "numericCode": "840"
    },
    "id": "UsDollar",
    "includeAllProducts": true,
    "startDate": "2016-03-10T18:30:00.000Z"
  },
  "sort": [{
    "property": "displayName",
    "order": "asc"
  }],
  "items": [
    {
      "endDate": "2016-03-11T18:30:00.000Z",
      "displayName": null,
      "listPriceList": {"repositoryId": "listPrices"},
      "active": false,
      "isPointsBased": false,
      "locale": "en_US",
      "shippingSurchargePriceList": null,
      "taxCalculationType": "calculateTax",
      "repositoryId": "UsDollar",
      "salePriceList": {"repositoryId": "salePrices"},
      "currency": {
        "symbol": "$",
        "displayName": "US Dollar",
        "repositoryId": "en_US",
        "fractionalDigits": 2,
        "currencyCode": "USD",
        "numericCode": "840"
      },
      "id": "UsDollar",
      "includeAllProducts": true,
      "startDate": "2016-03-10T18:30:00.000Z"
    },
    {
      "isTaxIncluded": false,
      "endDate": "2016-03-11T18:30:00.000Z",
      "displayName": "CanadianDollar",
      "listPriceList": {"repositoryId": "CanadianDollar_listPrice"},
      "active": false,
      "isPointsBased": false,
      "locale": "en_CA",
      "shippingSurchargePriceList": {"repositoryId": "CanadianDollar_shippingSurchargePrice"},
      "taxCalculationType": "calculateTax",
      "repositoryId": "CanadianDollar",
      "salePriceList": {"repositoryId": "CanadianDollar_salePrice"},
      "id": "CanadianDollar",
      "includeAllProducts": false,
      "startDate": "2016-03-10T18:30:00.000Z"
    }
  ]
}