REST API for Oracle Commerce Cloud December 2017

getDefaultPriceListGroup

get

/ccadmin/v1/merchant/defaultPriceListGroup

Get Default Price List Group. Get default PriceListGroup

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getDefaultPriceListGroup_response

Properties

active: Type: boolean

indicates if the PriceListGroup is active
displayName: Type: string

display name of the PriceListGroup
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 for the sale prices

Nested Schema : shippingSurchargePriceList

Type: object

Price List for shipping surcharge prices

Properties

repositoryId: Type: string

Repository ID for the shipping surcharge prices

Example application/json


{
    "displayName":"UsDollar",
    "listPriceList":{
        "repositoryId":"listPrices"
    },
    "repositoryId":"UsDollar",
    "active":false,
    "salePriceList":{
        "repositoryId":"salePrices"
    },
    "currency":{
        "symbol":"$",
        "displayName":"US Dollar",
        "repositoryId":"en_US",
        "fractionalDigits":2,
        "currencyCode":"USD",
        "numericCode":"840"
    },
    "id":"UsDollar",
    "locale":"en_US",
    "shippingSurchargePriceList":{
        "repositoryId":"shippingSurchargePrices"
    }
}

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| |------------------|------------------| |80021|There was an error retrieving the selected timezone.|

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:

{
  "displayName": "UsDollar",
  "listPriceList": {"repositoryId": "listPrices"},
  "repositoryId": "UsDollar",
  "active": false,
  "salePriceList": {"repositoryId": "salePrices"},
  "currency": {
    "symbol": "$",
    "displayName": "US Dollar",
    "repositoryId": "en_US",
    "fractionalDigits": 2,
    "currencyCode": "USD",
    "numericCode": "840"
  },
  "id": "UsDollar",
  "locale": "en_US",
  "shippingSurchargePriceList": {"repositoryId": "shippingSurchargePrices"}
}