REST API for Oracle Commerce Cloud December 2017

createPriceListGroupActivationRequest

post

/ccadmin/v1/priceListGroups/activationRequest

Create Price List Group Activation Request. Create a new PriceListGroup activation request

Request

Supported Media Types

application/json

Body Parameter

Root Schema : createPriceListGroupActivationRequest_request

Example


{
    "priceListGroupId":"CanadianDollar"
}

Properties

priceListGroupId: Type: string

Required: true

ID of the PriceListGroup to activate.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : createPriceListGroupActivationRequest_response

Properties

activationSummary: Type: object activationSummary

Additional Properties Allowed:

Activation summary.
token: Type: string

The token associated with this activation. Can be used to fetch a summary.

Nested Schema : activationSummary

Type: object

Activation summary.

Properties

active: Type: boolean

True if the price list group is active, false if not.
valid: Type: boolean

True if the price list group is valid, false if not.

Example application/json


{
    "links":[
        {
            "rel":"self",
            "href":"/priceListGroups/activationRequest"
        }
    ],
    "activationSummary":{
        "valid":"true",
        "active":"true"
    },
    "token":"hcXGtYVfjpsKofHzEeUkCTVQSM_10000"
}

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| |------------------|------------------| |20302|The price group ID must be a string| |20401|There was an error validating the price group| |20301|The price group ID cannot be null| |20187|The price group could not be found| |20304|There was an error activating the price group| |20303|The price group ID cannot be blank|

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:

{"priceListGroupId": "CanadianDollar"}

Sample Response Payload returned by endpoint:

{
  "links": [{
    "rel": "self",
    "href": "/priceListGroups/activationRequest"
  }],
  "activationSummary": {
    "valid": "true",
    "active": "true"
  },
  "token": "hcXGtYVfjpsKofHzEeUkCTVQSM_10000"
}