Get all Promotions

GET 
https://useast.api.elasticpath.com/v2/promotions

Returns all promotions.

note

You can use pagination with this resource. For more information, see pagination.

Filtering

The following operators and attributes are available when filtering on this endpoint. See Supported Filtering Characters.

Use code filter to search codes within promotions.

Attribute	Type	Operator	Example
code	string	eq	eq(code,some_code)

For filtering advanced promotion usages, pass the EP-Public-Search-Type=cm_search header. Advanced search filtering is only applicable when the promotion code is consumed and the promotion is not deleted.

Attribute	Type	Operator	Example
promo_id	string	eq	eq(promo_id, 69c63c9d-8ccf-44b1-8e98-1e7feebfb581)
promo_name	string	eq, like	eq(promo_name,cart percent discount)
promo_type	string	eq	eq(promo_type,fixed_discount)
promo_status	string	eq	eq(promo_status,Running)
promo_checkouts	string	eq,gt, ge, lt, le	eq(promo_checkouts,2)
promo_skus_prod_ids	string	eq, like	eq(promo_skus_prod_ids, sku1)
promo_start_date	string	eq, gt, gr, lt, le	eq(promo_start_date,2023-01-01)
promo_end_date	string	eq, gt, gr, lt, le	eq(promo_end_date,2050-06-15)
code_id	string	eq	eq(promo_id,2ea0cd1d-43a9-441b-b03f-3cab84aaee0c):eq(code_id,14b55e6c-3f80-436e-a90a-4de5f0e36240)
code_code	string	eq, like	eq(code_code,cart_fixed_10)
code_used	string	eq, gt, gr, lt, le	eq(code_used,2)
code_created_date	string	eq, gt, gr, lt, le	eq(code_created_date,2023-11-15)
order_id	string	eq, like	eq(order_id,ccb13673-627c-4976-88da-f77c542b528f)
order_customer_email	string	eq, like	like(order_customer_email,andy*)
order_created_date	string	eq, gt, gr,lt, le	le(order_created_date,2023-11-15)

Request

Query Parameters

page[offset] string

The number of records to offset the results by.

page[limit] string

The number of records per page.

Header Parameters

Authorization Bearerrequired

The Bearer token required to get access to the API.

Responses

200

Response Headers

application/json

Schema

Schema

data object[]
Array [
oneOf
Data.CartFixedDiscountPromotion
type stringrequired
Specifies the type of the resource. The type of resource for promotions is promotion.
id uuidrequired
name stringrequired
Specifies a name for the promotion.
description stringrequired
Specifies a description for the promotion.
promotion_type stringrequired
Possible values: [fixed_discount, percent_discount, item_fixed_discount, item_percent_discount, x_for_y, x_for_amount, bundle_fixed_discount, bundle_gift]
Specifies the type of the promotion.
enabled booleanrequired
Specifies whether the promotion is enabled. The options are true or false, and the default setting is false.
automatic booleanrequired
Specifies whether the promotion is applied automatically to the cart or a code is required to apply the promotion. The default setting is to false. When this value is set to true, a code is autogenerated. If this value is set to false, you must create the code manually. For more information about creating codes, see the Create Promotion Codes section.
start stringrequired
Specifies the start date and time of the promotion or the start date of the promotion. You can provide a specific time in the HH:MM format.
end stringrequired
Specifies the end date and time of the promotion or the end date of the promotion.
min_cart_value object
Specifies an array of currency-value objects, min_cart_value[].currency and min_cart_value[].amount, that provides the minimum cart value required for the promotion to apply. You can add one or several value specifications in different currencies. Do not use max_discount_value for Cart Fixed Discount promotion and Item Fixed Discount promotion. If max_discount_value is greater than the fixed_discount value, the fixed_discount value is applied; otherwise the max_discount value is applied.
max_applications_per_cart number
Specifies the maximum number of application of a promotion per cart.
schema objectrequired
target_catalogs string[]
Specifies the unique identifiers of the catalogs to be applied for this promotion. If you do not set this parameter, promotion will be applied to all catalogs.
currencies object[]required
Array [
amount integerrequired
Specifies the fixed discount amount to be applied to the cart. For example, $10 off the total amount in the cart.
currency stringrequired
Specifies a three-letter currency code. For example, USD.
]
conditions object
or object[]
Array [
and object[]
Array [
oneOf
Data.AttributeObject
attribute object
template string
Specifies the name of the template slug to be excluded from a promotion.
field string
Specifies the unique slug identifier for the field excluded from a promotion.
type string
Specifies the type of the field, such as string, integer, boolean, float, or date.
value string
Specifies the value of the field that was specified in the attributes.field. For example, you can specify any color in the value if you indicate color in the attributes.field.
Data.NodesObject
node object
values string[]
Specifies unique identifiers of the nodes to be excluded from the promotion.
]
]
Data.CartPercentDiscountPromotion
type stringrequired
Specifies the type of the resource. The type of resource for promotions is promotion.
id uuidrequired
name stringrequired
Specifies a name for the promotion.
description stringrequired
Specifies a description for the promotion.
promotion_type stringrequired
Possible values: [fixed_discount, percent_discount, item_fixed_discount, item_percent_discount, x_for_y, x_for_amount, bundle_fixed_discount, bundle_gift]
Specifies the type of the promotion.
enabled booleanrequired
Specifies whether the promotion is enabled. The options are true or false, and the default setting is false.
automatic booleanrequired
Specifies whether the promotion is applied automatically to the cart or a code is required to apply the promotion. The default setting is to false. When this value is set to true, a code is autogenerated. If this value is set to false, you must create the code manually. For more information about creating codes, see the Create Promotion Codes section.
start stringrequired
Specifies the start date and time of the promotion or the start date of the promotion. You can provide a specific time in the HH:MM format.
end stringrequired
Specifies the end date and time of the promotion or the end date of the promotion.
min_cart_value object
Specifies an array of currency-value objects, min_cart_value[].currency and min_cart_value[].amount, that provides the minimum cart value required for the promotion to apply. You can add one or several value specifications in different currencies. Do not use max_discount_value for Cart Fixed Discount promotion and Item Fixed Discount promotion. If max_discount_value is greater than the fixed_discount value, the fixed_discount value is applied; otherwise the max_discount value is applied.
max_applications_per_cart number
Specifies the maximum number of application of a promotion per cart.
schema objectrequired
target_catalogs string[]
Specifies the unique identifiers of the catalogs to be applied for this promotion. If you do not set this parameter, promotion will be applied to all catalogs.
currencies object[]required
Array [
percentage numberrequired
Specifies the discount percentage of the cart total value. For example, 10 represents 10% discount of the cart value of $100. You can add up to six decimal places for the discount percentage to be applied for the promotion.
currency stringrequired
Specifies a three-letter currency code. For example, USD.
]
conditions object
or object[]
Array [
and object[]
Array [
oneOf
Data.AttributeObject
attribute object
template string
Specifies the name of the template slug to be excluded from a promotion.
field string
Specifies the unique slug identifier for the field excluded from a promotion.
type string
Specifies the type of the field, such as string, integer, boolean, float, or date.
value string
Specifies the value of the field that was specified in the attributes.field. For example, you can specify any color in the value if you indicate color in the attributes.field.
Data.NodesObject
node object
values string[]
Specifies unique identifiers of the nodes to be excluded from the promotion.
]
]
Data.ItemFixedDiscountPromotion
type stringrequired
Specifies the type of the resource. The type of resource for promotions is promotion.
id uuidrequired
name stringrequired
Specifies a name for the promotion.
description stringrequired
Specifies a description for the promotion.
promotion_type stringrequired
Possible values: [fixed_discount, percent_discount, item_fixed_discount, item_percent_discount, x_for_y, x_for_amount, bundle_fixed_discount, bundle_gift]
Specifies the type of the promotion.
enabled booleanrequired
Specifies whether the promotion is enabled. The options are true or false, and the default setting is false.
automatic booleanrequired
Specifies whether the promotion is applied automatically to the cart or a code is required to apply the promotion. The default setting is to false. When this value is set to true, a code is autogenerated. If this value is set to false, you must create the code manually. For more information about creating codes, see the Create Promotion Codes section.
start stringrequired
Specifies the start date and time of the promotion or the start date of the promotion. You can provide a specific time in the HH:MM format.
end stringrequired
Specifies the end date and time of the promotion or the end date of the promotion.
min_cart_value object
Specifies an array of currency-value objects, min_cart_value[].currency and min_cart_value[].amount, that provides the minimum cart value required for the promotion to apply. You can add one or several value specifications in different currencies. Do not use max_discount_value for Cart Fixed Discount promotion and Item Fixed Discount promotion. If max_discount_value is greater than the fixed_discount value, the fixed_discount value is applied; otherwise the max_discount value is applied.
max_applications_per_cart number
Specifies the maximum number of application of a promotion per cart.
schema objectrequired
target_catalogs string[]
Specifies the unique identifiers of the catalogs to be applied for this promotion. If you do not set this parameter, promotion will be applied to all catalogs.
targets string[]
Specifies the product SKUs or unique identifiers of the products included in the promotion. Set "targets:all" if you want to apply the promotion to all SKUs. Leaving this field empty might cause errors. You need to define schema.targets, schema.target_nodes or schema.target_attributes, or all three of them to qualify for this promotion.
target_nodes string[]
Specifies the unique identifiers of the nodes to be applied for the promotion in addition to the product SKUs applied in targets. You can also define schema.target_nodes without defining the schema.targets if the promotion is intended for a certain node. You cannot define "targets":"all" and schema.target_nodes within the same schema. This will result in a validation error.
target_attributes object[]
Array [
template string
Specifies the name of the template slug to be included in a promotion.
field string
Specifies the unique slug identifier for the field to be included in a promotion.
type string
Specifies the type of the field, such as string, integer, boolean, float, or date.
value string
Specifies the value of the field that was specified in the attributes.type. For example, you can specify any color in the value if you indicate color in the attributes.field.
]
currencies object[]required
Array [
amount integerrequired
Specifies the fixed discount amount to be applied to the cart. For example, $10 off the total amount in the cart.
currency stringrequired
Specifies a three-letter currency code. For example, USD.
]
conditions object
or object[]
Array [
and object[]
Array [
oneOf
Data.AttributeObject
attribute object
template string
Specifies the name of the template slug to be excluded from a promotion.
field string
Specifies the unique slug identifier for the field excluded from a promotion.
type string
Specifies the type of the field, such as string, integer, boolean, float, or date.
value string
Specifies the value of the field that was specified in the attributes.field. For example, you can specify any color in the value if you indicate color in the attributes.field.
Data.NodesObject
node object
values string[]
Specifies unique identifiers of the nodes to be excluded from the promotion.
]
]
Data.ItemPercentDiscountPromotion
type stringrequired
Specifies the type of the resource. The type of resource for promotions is promotion.
id uuidrequired
name stringrequired
Specifies a name for the promotion.
description stringrequired
Specifies a description for the promotion.
promotion_type stringrequired
Possible values: [fixed_discount, percent_discount, item_fixed_discount, item_percent_discount, x_for_y, x_for_amount, bundle_fixed_discount, bundle_gift]
Specifies the type of the promotion.
enabled booleanrequired
Specifies whether the promotion is enabled. The options are true or false, and the default setting is false.
automatic booleanrequired
Specifies whether the promotion is applied automatically to the cart or a code is required to apply the promotion. The default setting is to false. When this value is set to true, a code is autogenerated. If this value is set to false, you must create the code manually. For more information about creating codes, see the Create Promotion Codes section.
start stringrequired
Specifies the start date and time of the promotion or the start date of the promotion. You can provide a specific time in the HH:MM format.
end stringrequired
Specifies the end date and time of the promotion or the end date of the promotion.
min_cart_value object
Specifies an array of currency-value objects, min_cart_value[].currency and min_cart_value[].amount, that provides the minimum cart value required for the promotion to apply. You can add one or several value specifications in different currencies. Do not use max_discount_value for Cart Fixed Discount promotion and Item Fixed Discount promotion. If max_discount_value is greater than the fixed_discount value, the fixed_discount value is applied; otherwise the max_discount value is applied.
max_applications_per_cart number
Specifies the maximum number of application of a promotion per cart.
schema objectrequired
target_catalogs string[]
Specifies the unique identifiers of the catalogs to be applied for this promotion. If you do not set this parameter, promotion will be applied to all catalogs.
targets string[]
Specifies the product SKUs or unique identifiers of the products included in the promotion. Set "targets:all" if you want to apply the promotion to all SKUs. Leaving this field empty might cause errors. You need to define schema.targets, schema.target_nodes or schema.target_attributes, or all three of them to qualify for this promotion.
target_nodes string[]
Specifies the unique identifiers of the nodes to be applied for the promotion in addition to the product SKUs applied in targets. You can also define schema.target_nodes without defining the schema.targets if the promotion is intended for a certain node. You cannot define "targets":"all" and schema.target_nodes within the same schema. This will result in a validation error.
target_attributes object[]
Array [
template string
Specifies the name of the template slug to be included in a promotion.
field string
Specifies the unique slug identifier for the field to be included in a promotion.
type string
Specifies the type of the field, such as string, integer, boolean, float, or date.
value string
Specifies the value of the field that was specified in the attributes.type. For example, you can specify any color in the value if you indicate color in the attributes.field.
]
conditions object
or object[]
Array [
and object[]
Array [
oneOf
Data.AttributeObject
attribute object
template string
Specifies the name of the template slug to be excluded from a promotion.
field string
Specifies the unique slug identifier for the field excluded from a promotion.
type string
Specifies the type of the field, such as string, integer, boolean, float, or date.
value string
Specifies the value of the field that was specified in the attributes.field. For example, you can specify any color in the value if you indicate color in the attributes.field.
Data.NodesObject
node object
values string[]
Specifies unique identifiers of the nodes to be excluded from the promotion.
]
]
percent integerrequired
Specifies the discount percentage to be applied to the targeted SKU price. For example, 10% discount on a product SKU priced at $100. You can specify the discount percentage with up to six decimal places.
Data.XForYDiscountPromotion
type stringrequired
Specifies the type of the resource. The type of resource for promotions is promotion.
id uuidrequired
name stringrequired
Specifies a name for the promotion.
description stringrequired
Specifies a description for the promotion.
promotion_type stringrequired
Possible values: [fixed_discount, percent_discount, item_fixed_discount, item_percent_discount, x_for_y, x_for_amount, bundle_fixed_discount, bundle_gift]
Specifies the type of the promotion.
enabled booleanrequired
Specifies whether the promotion is enabled. The options are true or false, and the default setting is false.
automatic booleanrequired
Specifies whether the promotion is applied automatically to the cart or a code is required to apply the promotion. The default setting is to false. When this value is set to true, a code is autogenerated. If this value is set to false, you must create the code manually. For more information about creating codes, see the Create Promotion Codes section.
start stringrequired
Specifies the start date and time of the promotion or the start date of the promotion. You can provide a specific time in the HH:MM format.
end stringrequired
Specifies the end date and time of the promotion or the end date of the promotion.
min_cart_value object
Specifies an array of currency-value objects, min_cart_value[].currency and min_cart_value[].amount, that provides the minimum cart value required for the promotion to apply. You can add one or several value specifications in different currencies. Do not use max_discount_value for Cart Fixed Discount promotion and Item Fixed Discount promotion. If max_discount_value is greater than the fixed_discount value, the fixed_discount value is applied; otherwise the max_discount value is applied.
max_applications_per_cart number
Specifies the maximum number of application of a promotion per cart.
schema objectrequired
target_catalogs string[]
Specifies the unique identifiers of the catalogs to be applied for this promotion. If you do not set this parameter, promotion will be applied to all catalogs.
targets string[]
Specifies the product SKUs or unique identifiers of the products included in the promotion. Set "targets:all" if you want to apply the promotion to all SKUs. Leaving this field empty might cause errors. You need to define schema.targets, schema.target_nodes or schema.target_attributes, or all three of them to qualify for this promotion.
target_nodes string[]
Specifies the unique identifiers of the nodes to be applied for the promotion in addition to the product SKUs applied in targets. You can also define schema.target_nodes without defining the schema.targets if the promotion is intended for a certain node. You cannot define "targets":"all" and schema.target_nodes within the same schema. This will result in a validation error.
target_attributes object[]
Array [
template string
Specifies the name of the template slug to be included in a promotion.
field string
Specifies the unique slug identifier for the field to be included in a promotion.
type string
Specifies the type of the field, such as string, integer, boolean, float, or date.
value string
Specifies the value of the field that was specified in the attributes.type. For example, you can specify any color in the value if you indicate color in the attributes.field.
]
conditions object
or object[]
Array [
and object[]
Array [
oneOf
Data.AttributeObject
attribute object
template string
Specifies the name of the template slug to be excluded from a promotion.
field string
Specifies the unique slug identifier for the field excluded from a promotion.
type string
Specifies the type of the field, such as string, integer, boolean, float, or date.
value string
Specifies the value of the field that was specified in the attributes.field. For example, you can specify any color in the value if you indicate color in the attributes.field.
Data.NodesObject
node object
values string[]
Specifies unique identifiers of the nodes to be excluded from the promotion.
]
]
x integerrequired
Specifies the X value for the promotion.
y integerrequired
Specifies the Y value for the promotion.
Data.XForAmountDiscountPromotion
type stringrequired
Specifies the type of the resource. The type of resource for promotions is promotion.
id uuidrequired
name stringrequired
Specifies a name for the promotion.
description stringrequired
Specifies a description for the promotion.
promotion_type stringrequired
Possible values: [fixed_discount, percent_discount, item_fixed_discount, item_percent_discount, x_for_y, x_for_amount, bundle_fixed_discount, bundle_gift]
Specifies the type of the promotion.
enabled booleanrequired
Specifies whether the promotion is enabled. The options are true or false, and the default setting is false.
automatic booleanrequired
Specifies whether the promotion is applied automatically to the cart or a code is required to apply the promotion. The default setting is to false. When this value is set to true, a code is autogenerated. If this value is set to false, you must create the code manually. For more information about creating codes, see the Create Promotion Codes section.
start stringrequired
Specifies the start date and time of the promotion or the start date of the promotion. You can provide a specific time in the HH:MM format.
end stringrequired
Specifies the end date and time of the promotion or the end date of the promotion.
min_cart_value object
Specifies an array of currency-value objects, min_cart_value[].currency and min_cart_value[].amount, that provides the minimum cart value required for the promotion to apply. You can add one or several value specifications in different currencies. Do not use max_discount_value for Cart Fixed Discount promotion and Item Fixed Discount promotion. If max_discount_value is greater than the fixed_discount value, the fixed_discount value is applied; otherwise the max_discount value is applied.
max_applications_per_cart number
Specifies the maximum number of application of a promotion per cart.
schema objectrequired
target_catalogs string[]
Specifies the unique identifiers of the catalogs to be applied for this promotion. If you do not set this parameter, promotion will be applied to all catalogs.
targets string[]
Specifies the product SKUs or unique identifiers of the products included in the promotion. Set "targets:all" if you want to apply the promotion to all SKUs. Leaving this field empty might cause errors. You need to define schema.targets, schema.target_nodes or schema.target_attributes, or all three of them to qualify for this promotion.
target_nodes string[]
Specifies the unique identifiers of the nodes to be applied for the promotion in addition to the product SKUs applied in targets. You can also define schema.target_nodes without defining the schema.targets if the promotion is intended for a certain node. You cannot define "targets":"all" and schema.target_nodes within the same schema. This will result in a validation error.
currencies object[]required
Array [
amount integerrequired
Specifies the fixed discount amount to be applied to the cart. For example, $10 off the total amount in the cart.
currency stringrequired
Specifies a three-letter currency code. For example, USD.
]
conditions object
or object[]
Array [
and object[]
Array [
oneOf
Data.AttributeObject
attribute object
template string
Specifies the name of the template slug to be excluded from a promotion.
field string
Specifies the unique slug identifier for the field excluded from a promotion.
type string
Specifies the type of the field, such as string, integer, boolean, float, or date.
value string
Specifies the value of the field that was specified in the attributes.field. For example, you can specify any color in the value if you indicate color in the attributes.field.
Data.NodesObject
node object
values string[]
Specifies unique identifiers of the nodes to be excluded from the promotion.
]
]
x integerrequired
Specifies the X value for the promotion.
Data.FixedBundleDiscountPromotion
type stringrequired
Specifies the type of the resource. The type of resource for promotions is promotion.
id uuidrequired
name stringrequired
Specifies a name for the promotion.
description stringrequired
Specifies a description for the promotion.
promotion_type stringrequired
Possible values: [fixed_discount, percent_discount, item_fixed_discount, item_percent_discount, x_for_y, x_for_amount, bundle_fixed_discount, bundle_gift]
Specifies the type of the promotion.
enabled booleanrequired
Specifies whether the promotion is enabled. The options are true or false, and the default setting is false.
automatic booleanrequired
Specifies whether the promotion is applied automatically to the cart or a code is required to apply the promotion. The default setting is to false. When this value is set to true, a code is autogenerated. If this value is set to false, you must create the code manually. For more information about creating codes, see the Create Promotion Codes section.
start stringrequired
Specifies the start date and time of the promotion or the start date of the promotion. You can provide a specific time in the HH:MM format.
end stringrequired
Specifies the end date and time of the promotion or the end date of the promotion.
min_cart_value object
Specifies an array of currency-value objects, min_cart_value[].currency and min_cart_value[].amount, that provides the minimum cart value required for the promotion to apply. You can add one or several value specifications in different currencies. Do not use max_discount_value for Cart Fixed Discount promotion and Item Fixed Discount promotion. If max_discount_value is greater than the fixed_discount value, the fixed_discount value is applied; otherwise the max_discount value is applied.
max_applications_per_cart number
Specifies the maximum number of application of a promotion per cart.
schema objectrequired
target_catalogs string[]
Specifies the unique identifiers of the catalogs to be applied for this promotion. If you do not set this parameter, promotion will be applied to all catalogs.
currencies object[]required
Array [
amount integerrequired
Specifies the fixed discount amount to be applied to the cart. For example, $10 off the total amount in the cart.
currency stringrequired
Specifies a three-letter currency code. For example, USD.
]
requirements object[]required
Array [
targets string[]required
Specifies an array of required product SKUs or IDs for the bundle discount promotion.
quantity integerrequired
Specifies the quantities of products to be applied for the promotion.
]
Data.FreeGiftPromotion
type stringrequired
Specifies the type of the resource. The type of resource for promotions is promotion.
id uuidrequired
name stringrequired
Specifies a name for the promotion.
description stringrequired
Specifies a description for the promotion.
promotion_type stringrequired
Possible values: [fixed_discount, percent_discount, item_fixed_discount, item_percent_discount, x_for_y, x_for_amount, bundle_fixed_discount, bundle_gift]
Specifies the type of the promotion.
enabled booleanrequired
Specifies whether the promotion is enabled. The options are true or false, and the default setting is false.
automatic booleanrequired
Specifies whether the promotion is applied automatically to the cart or a code is required to apply the promotion. The default setting is to false. When this value is set to true, a code is autogenerated. If this value is set to false, you must create the code manually. For more information about creating codes, see the Create Promotion Codes section.
start stringrequired
Specifies the start date and time of the promotion or the start date of the promotion. You can provide a specific time in the HH:MM format.
end stringrequired
Specifies the end date and time of the promotion or the end date of the promotion.
min_cart_value object
Specifies an array of currency-value objects, min_cart_value[].currency and min_cart_value[].amount, that provides the minimum cart value required for the promotion to apply. You can add one or several value specifications in different currencies. Do not use max_discount_value for Cart Fixed Discount promotion and Item Fixed Discount promotion. If max_discount_value is greater than the fixed_discount value, the fixed_discount value is applied; otherwise the max_discount value is applied.
max_applications_per_cart number
Specifies the maximum number of application of a promotion per cart.
schema objectrequired
target_catalogs string[]
Specifies the unique identifiers of the catalogs to be applied for this promotion. If you do not set this parameter, promotion will be applied to all catalogs.
requirements object[]required
Array [
targets string[]required
Specifies an array of required product SKUs or IDs for the bundle discount promotion.
quantity integerrequired
Specifies the quantities of products to be applied for the promotion.
]
gifts string[]required
Specifies all the gift items that a shopper can avail when they qualify for the promotion. The gift quantity applies to each specified item. For example, if the promotion includes giftA and giftB, shopper can avail both the gifts if the cart qualifies for the gift promotion. If the cart qualifies for two gift promotions, the shopper can use two giftA and two giftB.
auto_add_free_gift boolean
When set to true, free gift items are automatically added to the shopping cart for all the eligible products. Default is false.
]
links object

current string

Always the current page.

first string

Always the first page.

last string

If there is only one page, it returns null.

next string

If there is only one page, it returns null.

prev string

If the user is on the first page, it returns null.

meta object

page object

current integer

The current page.

limit integer

The maximum number of records per page for this response. You can set this value up to 100.

offset integer

The current offset by number of records, not pages. Offset is zero-based.

total integer

The total page count.

results object

total integer

The total number of results.

Example (from schema)

{
  "data": [
    {
      "type": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "promotion_type": "fixed_discount",
      "enabled": true,
      "automatic": true,
      "start": "string",
      "end": "string",
      "min_cart_value": {},
      "max_applications_per_cart": 0,
      "schema": {
        "target_catalogs": [
          "string"
        ],
        "currencies": [
          {
            "amount": 0,
            "currency": "string"
          }
        ],
        "conditions": {
          "or": [
            {
              "and": [
                {
                  "attribute": {
                    "template": "string",
                    "field": "string",
                    "type": "string",
                    "value": "string"
                  }
                },
                {
                  "node": {
                    "values": [
                      "string"
                    ]
                  }
                }
              ]
            }
          ]
        }
      }
    },
    {
      "type": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "promotion_type": "fixed_discount",
      "enabled": true,
      "automatic": true,
      "start": "string",
      "end": "string",
      "min_cart_value": {},
      "max_applications_per_cart": 0,
      "schema": {
        "target_catalogs": [
          "string"
        ],
        "currencies": [
          {
            "percentage": 0,
            "currency": "string"
          }
        ],
        "conditions": {
          "or": [
            {
              "and": [
                {
                  "attribute": {
                    "template": "string",
                    "field": "string",
                    "type": "string",
                    "value": "string"
                  }
                },
                {
                  "node": {
                    "values": [
                      "string"
                    ]
                  }
                }
              ]
            }
          ]
        }
      }
    },
    {
      "type": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "promotion_type": "fixed_discount",
      "enabled": true,
      "automatic": true,
      "start": "string",
      "end": "string",
      "min_cart_value": {},
      "max_applications_per_cart": 0,
      "schema": {
        "target_catalogs": [
          "string"
        ],
        "targets": [
          "string"
        ],
        "target_nodes": [
          "string"
        ],
        "target_attributes": [
          {
            "template": "string",
            "field": "string",
            "type": "string",
            "value": "string"
          }
        ],
        "currencies": [
          {
            "amount": 0,
            "currency": "string"
          }
        ],
        "conditions": {
          "or": [
            {
              "and": [
                {
                  "attribute": {
                    "template": "string",
                    "field": "string",
                    "type": "string",
                    "value": "string"
                  }
                },
                {
                  "node": {
                    "values": [
                      "string"
                    ]
                  }
                }
              ]
            }
          ]
        }
      }
    },
    {
      "type": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "promotion_type": "fixed_discount",
      "enabled": true,
      "automatic": true,
      "start": "string",
      "end": "string",
      "min_cart_value": {},
      "max_applications_per_cart": 0,
      "schema": {
        "target_catalogs": [
          "string"
        ],
        "targets": [
          "string"
        ],
        "target_nodes": [
          "string"
        ],
        "target_attributes": [
          {
            "template": "string",
            "field": "string",
            "type": "string",
            "value": "string"
          }
        ],
        "conditions": {
          "or": [
            {
              "and": [
                {
                  "attribute": {
                    "template": "string",
                    "field": "string",
                    "type": "string",
                    "value": "string"
                  }
                },
                {
                  "node": {
                    "values": [
                      "string"
                    ]
                  }
                }
              ]
            }
          ]
        },
        "percent": 0
      }
    },
    {
      "type": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "promotion_type": "fixed_discount",
      "enabled": true,
      "automatic": true,
      "start": "string",
      "end": "string",
      "min_cart_value": {},
      "max_applications_per_cart": 0,
      "schema": {
        "target_catalogs": [
          "string"
        ],
        "targets": [
          "string"
        ],
        "target_nodes": [
          "string"
        ],
        "target_attributes": [
          {
            "template": "string",
            "field": "string",
            "type": "string",
            "value": "string"
          }
        ],
        "conditions": {
          "or": [
            {
              "and": [
                {
                  "attribute": {
                    "template": "string",
                    "field": "string",
                    "type": "string",
                    "value": "string"
                  }
                },
                {
                  "node": {
                    "values": [
                      "string"
                    ]
                  }
                }
              ]
            }
          ]
        },
        "x": 0,
        "y": 0
      }
    },
    {
      "type": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "promotion_type": "fixed_discount",
      "enabled": true,
      "automatic": true,
      "start": "string",
      "end": "string",
      "min_cart_value": {},
      "max_applications_per_cart": 0,
      "schema": {
        "target_catalogs": [
          "string"
        ],
        "targets": [
          "string"
        ],
        "target_nodes": [
          "string"
        ],
        "currencies": [
          {
            "amount": 0,
            "currency": "string"
          }
        ],
        "conditions": {
          "or": [
            {
              "and": [
                {
                  "attribute": {
                    "template": "string",
                    "field": "string",
                    "type": "string",
                    "value": "string"
                  }
                },
                {
                  "node": {
                    "values": [
                      "string"
                    ]
                  }
                }
              ]
            }
          ]
        },
        "x": 0
      }
    },
    {
      "type": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "promotion_type": "fixed_discount",
      "enabled": true,
      "automatic": true,
      "start": "string",
      "end": "string",
      "min_cart_value": {},
      "max_applications_per_cart": 0,
      "schema": {
        "target_catalogs": [
          "string"
        ],
        "currencies": [
          {
            "amount": 0,
            "currency": "string"
          }
        ],
        "requirements": [
          {
            "targets": [
              "string"
            ],
            "quantity": 0
          }
        ]
      }
    },
    {
      "type": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "promotion_type": "fixed_discount",
      "enabled": true,
      "automatic": true,
      "start": "string",
      "end": "string",
      "min_cart_value": {},
      "max_applications_per_cart": 0,
      "schema": {
        "target_catalogs": [
          "string"
        ],
        "requirements": [
          {
            "targets": [
              "string"
            ],
            "quantity": 0
          }
        ],
        "gifts": [
          "string"
        ],
        "auto_add_free_gift": true
      }
    }
  ],
  "links": {
    "current": "string",
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string"
  },
  "meta": {
    "page": {
      "current": 0,
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "results": {
      "total": 0
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

detail string
status string
title string

Example (from schema)

[
  null
]

Example

{
  "errors": {
    "status": 401,
    "title": "Unauthorized"
  }
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://useast.api.elasticpath.com/v2/promotions' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

Parameters

Authorization — headerrequired

page[offset] — query

page[limit] — query

ResponseClear

Click the Send API Request button above and see the response here!