REST API for Oracle Commerce Cloud December 2017

updatePriceListGroup

put

/ccadmin/v1/priceListGroups/{id}

Update Price List Group. Updates an existing PriceListGroup based on PriceListGroup ID provided,specific properties have to be specified for getting them updated. 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

PriceListGroup ID corresponding to the PriceListGroup to be updated.

Header Parameters

X-CCAsset-Language: Type: string

Required: true

The asset language of the request

Body Parameter

Root Schema : updatePriceListGroup_request

Example


{
    "endDate":"2017-03-12T00:00:00.000+05:30",
    "displayName":"Canadian Dollar",
    "includeAllProducts":false,
    "startDate":"2016-03-11T00:00:00.000+05:30"
}

Properties

displayName: Type: string

The display name of the PriceListGroup.
endDate: Type: string

End date of the the associated list price list
includeAllProducts: Type: boolean

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

Start date of the the associated list price list

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : updatePriceListGroup_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
id: Type: string

The ID of the PriceListGroup item
includeAllProducts: Type: boolean

If true, indicates that all the products in the catalog should have prices for activation of the PLG
isPointsBased: Type: boolean

If true, indicates the PriceListGroup was created with a point based currency
isTaxIncluded: Type: boolean

Indicates whether prices are inclusive of tax.
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
taxCalculationType: Type: string

Indicates how tax calls are made based on the PriceListGroup setting. For a monetary PriceListGroup, the possible values are calculateTax and doNotCalculateTax.??For a point based PriceListGroup, the possible values are doNotCalculateTax, calculateTaxWithCurrencyConversion and calculateTaxWithoutCurrencyConversion.

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

The currency Code of the currency
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

Nested Schema : salePriceList

Type: object

The price list for sale prices

Properties

repositoryId: Type: string

Repository ID

Nested Schema : shippingSurchargePriceList

Type: object

The price list for shipping surcharge prices

Properties

repositoryId: Type: string

Repository ID

Example application/json


{
    "isTaxIncluded":false,
    "endDate":"2016-03-11T18:30:00.000Z",
    "displayName":"Canadian Dollar",
    "listPriceList":{
        "repositoryId":"CanadianDollar_listPrice"
    },
    "active":false,
    "locale":"en_US",
    "shippingSurchargePriceList":{
        "repositoryId":"CanadianDollar_shippingSurchargePrice"
    },
    "repositoryId":"CanadianDollar",
    "salePriceList":{
        "repositoryId":"CanadianDollar_salePrice"
    },
    "currency":{
        "symbol":"$",
        "displayName":"US Dollar",
        "repositoryId":"en_US",
        "fractionalDigits":2,
        "currencyCode":"USD",
        "numericCode":"840"
    },
    "links":[
        {
            "rel":"self",
            "href":"/priceListGroups/CanadianDollar"
        }
    ],
    "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| |------------------|------------------| |20187|No PriceListGroup found for the id : invalidId| |13036|Locale key is not valid| |20192|Attempt to change the value of a read only property id|

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

{
  "endDate": "2017-03-12T00:00:00.000+05:30",
  "displayName": "Canadian Dollar",
  "includeAllProducts": false,
  "startDate": "2016-03-11T00:00:00.000+05:30"
}

Sample Response Payload returned by endpoint:

{
  "isTaxIncluded": false,
  "endDate": "2016-03-11T18:30:00.000Z",
  "displayName": "Canadian Dollar",
  "listPriceList": {"repositoryId": "CanadianDollar_listPrice"},
  "active": false,
  "locale": "en_US",
  "shippingSurchargePriceList": {"repositoryId": "CanadianDollar_shippingSurchargePrice"},
  "repositoryId": "CanadianDollar",
  "salePriceList": {"repositoryId": "CanadianDollar_salePrice"},
  "currency": {
    "symbol": "$",
    "displayName": "US Dollar",
    "repositoryId": "en_US",
    "fractionalDigits": 2,
    "currencyCode": "USD",
    "numericCode": "840"
  },
  "links": [{
    "rel": "self",
    "href": "/priceListGroups/CanadianDollar"
  }],
  "id": "CanadianDollar",
  "includeAllProducts": false,
  "startDate": "2016-03-10T18:30:00.000Z"
}