Jump to

• Request
• Response

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 ()

Root Schema : createPriceListGroupActivationRequest_request

Type: object

Show Source

• priceListGroupId: string
  ID of the PriceListGroup to activate.

{
    "properties":{
        "priceListGroupId":{
            "description":"ID of the PriceListGroup to activate.",
            "type":"string"
        }
    },
    "required":[
        "priceListGroupId"
    ],
    "example":{
        "priceListGroupId":"CanadianDollar"
    }
}

Example:

{
    "priceListGroupId":"CanadianDollar"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : createPriceListGroupActivationRequest_response

Type: object

Show Source

• activationSummary(optional): object activationSummary
  Activation summary.
• token(optional): string
  The token associated with this activation. Can be used to fetch a summary.

{
    "properties":{
        "activationSummary":{
            "description":"Activation summary.",
            "type":"object",
            "properties":{
                "valid":{
                    "description":"True if the price list group is valid, false if not.",
                    "type":"boolean"
                },
                "basePriceGroupValid":{
                    "description":"True if the base price list group is valid, false if not.",
                    "type":"boolean"
                },
                "active":{
                    "description":"True if the price list group is active, false if not.",
                    "type":"boolean"
                }
            }
        },
        "token":{
            "description":"The token associated with this activation. Can be used to fetch a summary.",
            "type":"string"
        }
    }
}

Nested Schema : activationSummary

Type: object

Activation summary.

Show Source

• active(optional): boolean
  True if the price list group is active, false if not.
• basePriceGroupValid(optional): boolean
  True if the base price list group is valid, false if not.
• valid(optional): boolean
  True if the price list group is valid, false if not.

{
    "description":"Activation summary.",
    "type":"object",
    "properties":{
        "valid":{
            "description":"True if the price list group is valid, false if not.",
            "type":"boolean"
        },
        "basePriceGroupValid":{
            "description":"True if the base price list group is valid, false if not.",
            "type":"boolean"
        },
        "active":{
            "description":"True if the price list group is active, false if not.",
            "type":"boolean"
        }
    }
}

Example Response (application/json)

{
    "links":[
        {
            "rel":"self",
            "href":"/priceListGroups/activationRequest"
        }
    ],
    "activationSummary":{
        "valid":"true",
        "basePriceGroupValid":"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

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top