Jump to

• Request
• Response

listPromotionTemplates

get

/ccadmin/v1/promotionTemplates

List Promotion Templates. Get a list of promotions promotion templates. The list of results will be paginated based on query parameters.

Request

Supported Media Types

• application/json

Query Parameters

• limit(optional): integer
  The number of promotion templates to return from this request.
• offset(optional): integer
  The starting index/offset to be returned from this request.
• totalResults(optional): integer
  The total number of promotion templates.
• type(optional): string
  One of three types of promotion templates to return: item, order, shipping.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listPromotionTemplates_response

Type: object

Show Source

• items(optional): array items
  The promotion templates returned by the listing.
• limit(optional): integer
  The number of promotion templates intended to be returned in the response.
• links(optional): 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.
• offset(optional): integer
  The starting index/offset within the complete list of of promotion templates.
• total(optional): integer
  The total number of promotion templates. DEPRECATED.
• totalResults(optional): integer
  The total number of promotion templates.

{
    "properties":{
        "total":{
            "description":"The total number of promotion templates.  DEPRECATED.",
            "type":"integer"
        },
        "totalResults":{
            "description":"The total number of promotion templates.",
            "type":"integer"
        },
        "offset":{
            "description":"The starting index/offset within the complete list of of promotion templates.",
            "type":"integer"
        },
        "limit":{
            "description":"The number of promotion templates intended to be returned in the response.",
            "type":"integer"
        },
        "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":"The promotion templates returned by the listing.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayName":{
                        "description":"The localized display name of the promotion template.",
                        "type":"string"
                    },
                    "name":{
                        "description":"The system name of the promotion template.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The promotion template ID.",
                        "type":"string"
                    },
                    "type":{
                        "description":"The system type of the promotion template.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The promotion templates returned by the listing.

Show Source

• Array of: object items

{
    "description":"The promotion templates returned by the listing.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "displayName":{
                "description":"The localized display name of the promotion template.",
                "type":"string"
            },
            "name":{
                "description":"The system name of the promotion template.",
                "type":"string"
            },
            "id":{
                "description":"The promotion template ID.",
                "type":"string"
            },
            "type":{
                "description":"The system type of the promotion template.",
                "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.

Nested Schema : items

Type: object

Show Source

• displayName(optional): string
  The localized display name of the promotion template.
• id(optional): string
  The promotion template ID.
• name(optional): string
  The system name of the promotion template.
• type(optional): string
  The system type of the promotion template.

{
    "type":"object",
    "properties":{
        "displayName":{
            "description":"The localized display name of the promotion template.",
            "type":"string"
        },
        "name":{
            "description":"The system name of the promotion template.",
            "type":"string"
        },
        "id":{
            "description":"The promotion template ID.",
            "type":"string"
        },
        "type":{
            "description":"The system type of the promotion template.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "total":7,
    "totalResults":7,
    "offset":0,
    "limit":3,
    "links":[
        {
            "rel":"self",
            "href":"/ccadminui/v1/promotionTemplates?limit=3"
        },
        {
            "rel":"next",
            "href":"/ccadminui/v1/promotionTemplates?limit=3&offset=3"
        }
    ],
    "items":[
        {
            "displayName":"Get Item Discount",
            "name":"getItemDiscount",
            "id":"item.getItemDiscount",
            "type":"item"
        },
        {
            "displayName":"Buy One Get One",
            "name":"bogo",
            "id":"item.bogo",
            "type":"item"
        },
        {
            "displayName":"Gift with Item Purchase",
            "name":"getGiftWithPurchase",
            "id":"item.getGiftWithPurchase",
            "type":"item"
        }
    ]
}

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| |------------------|------------------| |10002|The value {0} for parameter {1} is invalid.| |21019|Internal Error.|

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