REST API for Oracle Commerce Cloud December 2017

getPriceListGroup

get

/ccadmin/v1/priceListGroups/{id}

Get Price List Group. Get a single PriceListGroup item

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

The ID of the requested PriceListGroup.

Header Parameters

X-CCAsset-Language: Type: string

Required: true

The asset language of the request

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getPriceListGroup_response

Properties

active: Type: boolean

Indicates if the PriceListGroup is active.
currency: Type: object currency

Additional Properties Allowed:

The currency data.
deleted: Type: boolean

Indicates if the PriceListGroup is deleted.
displayName: Type: string

Display name of the PriceListGroup.
endDate: Type: string

End date of the the associated list price list.
listPriceList: Type: object listPriceList

Additional Properties Allowed:

The price list for list prices
locale: Type: string

Locale of the the associated list price list.
repositoryId: Type: string

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

Additional Properties Allowed:

The price list for sale prices.
shippingSurchargePriceList: Type: object shippingSurchargePriceList

Additional Properties Allowed:

The price list for shipping surcharge prices.
startDate: Type: string

Start date of the the associated list price list.

Nested Schema : currency

Type: object

The currency data.

Properties

currencyCode: Type: string

The currency Code of the currency.
displayName: Type: string

The display Name of the currency.
fractionalDigits: Type: string

Fractional digits that currency supports.
numericCode: Type: string

The numeric Code of the currency.
repositoryId: Type: string

The repository id of the currency.
symbol: Type: string

The symbol of the currency.

Nested Schema : listPriceList

Type: object

The price list for list prices

Properties

repositoryId: Type: string

Repository id of the list price list.

Nested Schema : salePriceList

Type: object

The price list for sale prices.

Properties

repositoryId: Type: string

Repository id of the sale price list.

Nested Schema : shippingSurchargePriceList

Type: object

The price list for shipping surcharge prices.

Properties

repositoryId: Type: string

Repository id of shipping surcharge price list.

Example application/json


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

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| |------------------|------------------| |20187|No PriceListGroup found for the id : invalidId|

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:

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