Jump to

• Request
• Response

getPromotionTemplate

get

/ccadmin/v1/promotionTemplates/{id}

Get Promotion Template. Get a promotion template by path (type) and name.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  The promotion template name.

Query Parameters

• format: boolean
  Flag indicating that the response should follow standard formatting rules including an items and links array.
• path: string
  The promotion template type (path).

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getPromotionTemplate_response

Type: object

Show Source

• items: array items
  Array of templateValues placeholders which correspond to the templateValues input needed when creating a promotion using this template.
• links: object links
  The links referring to this response, and any applicable next or previous parts of the response. This is based on the total results, limit, and offset.

{
    "properties":{
        "links":{
            "description":"The links referring to this response, and any applicable next or previous parts of the response. This is based on the total results, limit, and offset.",
            "type":"object"
        },
        "items":{
            "description":"Array of templateValues placeholders which correspond to the templateValues input needed when creating a promotion using this template.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: array

Array of templateValues placeholders which correspond to the templateValues input needed when creating a promotion using this template.

Show Source

• Array of: string

{
    "description":"Array of templateValues placeholders which correspond to the templateValues input needed when creating a promotion using this template.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: object

The links referring to this response, and any applicable next or previous parts of the response. This is based on the total results, limit, and offset.

Example Response (application/json)

{
    "links":[
        {
            "rel":"self",
            "href":"/promotionTemplates/getItemDiscount?path=item"
        }
    ],
    "items":[
        "discount_type_value",
        "discount_value",
        "no_of_items_to_discount",
        "sort_order",
        "PSC_Value"
    ]
}

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| |------------------|------------------| |21103|The promotion template is not supported for path {0} and name {1}.| |21100|Promotion template path must be provided.| |21009|Internal Error.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: 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: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: 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