REST API for Oracle Commerce Cloud December 2017

getPriceListGroupActivationSummary

get

/ccadmin/v1/priceListGroups/activationSummary/{token}

Get Price List Group Activation Summary. Get a PriceListGroup activation summary

Request

Supported Media Types

application/json

Path Parameters

token: Type: string

Required: true

Token associated with a PriceListGroup.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getPriceListGroupActivationSummary_response

Properties

active: Type: boolean

True if the price list group is active, false if not.
token: Type: string

The token associated with this activation. Can be used to fetch a summary.
valid: Type: boolean

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

Example application/json


{
    "links":[
        {
            "rel":"self",
            "href":"/priceListGroups/activationSummary/hcXGtYVfjpsKofHzEeUkCTVQSM_10000"
        }
    ],
    "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| |------------------|------------------| |20305|The price group activation token cannot be null or 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 Response Payload returned by endpoint:

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