Cart Discounts

Cart Discounts are used to change the Prices of different elements within a Cart.

Cart Discounts are recalculated every time LineItems or CustomLineItems are added or removed from the Cart or an Order is created from the Cart.

The number of active CartDiscounts that do not require a Discount Code (isActive=true and requiresDiscountCode=false) is limited to 100. Learn more about this limit.

Cart Discounts can be defined globally for the Project or specific to one or more (up to 500) Stores. In the latter case the Cart Discount is only applied to Carts that belong to one of the Stores referenced in the CartDiscount's stores array. In case the array is empty or unspecified the Discount is applied to all Carts.

CartDiscount

`id` String	Unique identifier of the CartDiscount.
`version` Int	Current version of the CartDiscount.
`key` String	User-defined unique identifier of the CartDiscount. MinLength: `2`MaxLength: `256`Pattern: `^[A-Za-z0-9_-]+$`
`name` LocalizedString	Name of the CartDiscount.
`description` LocalizedString	Description of the CartDiscount.
`value` CartDiscountValue	Effect of the CartDiscount on the `target`.
`cartPredicate` String	Valid Cart Predicate.
`target` CartDiscountTarget	Segment of the Cart that is discounted. Empty, if the `value` is `giftLineItem`.
`sortOrder` String	Value between `0` and `1`. All matching CartDiscounts are applied to a Cart in the order defined by this field. A Discount with a higher sortOrder is prioritized. The sort order is unambiguous among all CartDiscounts.
`stores` Array of StoreKeyReference	If a value exists, the Cart Discount applies on Carts having a Store matching any Store defined for this field. If empty, the Cart Discount applies on all Carts, irrespective of a Store. MaxItems: `500`
`isActive` Boolean	Indicates if the CartDiscount is active and can be applied to the Cart.
`validFrom` DateTime	Date and time (UTC) from which the Discount is effective.
`validUntil` DateTime	Date and time (UTC) until which the Discount is effective.
`requiresDiscountCode` Boolean	Indicates if the Discount is used in connection with a DiscountCode. Default: `false`
`references` Array of Reference	References of all resources that are addressed in the predicate. The API generates this array from the predicate.
`stackingMode` StackingMode	Indicates whether the application of the CartDiscount causes other discounts to be ignored. Default: `Stacking`
`custom` CustomFields	Custom Fields of the CartDiscount.
`createdAt` DateTime	Date and time (UTC) the CartDiscount was initially created.
`createdBy`BETA CreatedBy	IDs and references that created the CartDiscount.
`lastModifiedAt` DateTime	Date and time (UTC) the CartDiscount was last updated.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the CartDiscount.

CartDiscountDraft

`key` String	User-defined unique identifier for the CartDiscount. MinLength: `2`MaxLength: `256`Pattern: `^[A-Za-z0-9_-]+$`
`name` LocalizedString	Name of the CartDiscount.
`description` LocalizedString	Description of the CartDiscount.
`value` CartDiscountValueDraft	Effect of the CartDiscount on the `target`.
`cartPredicate` String	Valid Cart Predicate.
`target` CartDiscountTarget	Segment of the Cart that will be discounted. Must not be set if the `value` is `giftLineItem`.
`sortOrder` String	Value between `0` and `1`. A Discount with a higher sortOrder is prioritized. The sort order must be unambiguous among all CartDiscounts.
`stores` Array of StoreResourceIdentifier	If defined, the Cart Discount applies on Carts having a Store matching any Store defined for this field. If not defined, the Cart Discount applies on all Carts, irrespective of a Store. If the referenced Stores exceed the limit, a MaxStoreReferencesReached error is returned. If the referenced Stores exceed the limit for Cart Discounts that do not require a Discount Code, a StoreCartDiscountsLimitReached error is returned. MaxItems: `500`
`isActive` Boolean	Only active Discounts can be applied to the Cart. If the limit for active Cart Discounts is reached, a MaxCartDiscountsReached error is returned. Default: `true`
`validFrom` DateTime	Date and time (UTC) from which the Discount is effective.
`validUntil` DateTime	Date and time (UTC) until which the Discount is effective.
`requiresDiscountCode` Boolean	States whether the Discount can only be used in a connection with a DiscountCode. Default: `false`
`stackingMode` StackingMode	Specifies whether the application of this discount causes the following discounts to be ignored. Default: `Stacking`
`custom` CustomFieldsDraft	Custom Fields of the CartDiscount.

CartDiscountPagedQueryResponse

PagedQueryResult with results containing an array of CartDiscount.

`limit` Int	Number of results requested.
`offset` Int	Number of elements skipped.
`count` Int	Actual number of results returned.
`total` Int	Total number of results matching the query. This number is an estimation that is not strongly consistent. This field is returned by default. For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`. When the results are filtered with a Query Predicate, `total` is subject to a limit.
`results` Array of CartDiscount	CartDiscounts matching the query.

CartDiscountReference

Reference to a CartDiscount.

`id` String	Unique identifier of the referenced CartDiscount.
`typeId` String	`"cart-discount"` References a CartDiscount.
`obj` CartDiscount	Contains the representation of the expanded CartDiscount. Only present in responses to requests with Reference Expansion for CartDiscounts.

CartDiscountResourceIdentifier

ResourceIdentifier to a CartDiscount. Either id or key is required. If both are set, an InvalidJsonInput error is returned.

`id` String	Unique identifier of the referenced CartDiscount. Required if `key` is absent.
`key` String	User-defined unique identifier of the referenced CartDiscount. Required if `id` is absent.
`typeId` String	`"cart-discount"` References a CartDiscount.

CartDiscountValue

The effect of the Discount on the specified target. The discount can be a relative or absolute Price value, a fixed item Price, or a Gift Line Item added to a Cart.

CartDiscountValueRelative

Discounts the CartDiscountTarget relative to its price.

`type` String	`"relative"`
`permyriad` Int	Fraction (per ten thousand) the price is reduced by. For example, `1000` will result in a 10% price reduction.

With previous Discounts already applied, the target may already have a discounted Price. The Discount is then calculated based on the already discounted Price.

CartDiscountValueAbsolute

Discounts the CartDiscountTarget by an absolute amount (not allowed for MultiBuyLineItemsTarget and MultiBuyCustomLineItemsTarget).

`type` String	`"absolute"`
`money` Array of CentPrecisionMoney	Cent precision money values in different currencies.

CartDiscountValueFixed

Sets the DiscountedLineItemPrice of the CartDiscountLineItemsTarget or CartDiscountCustomLineItemsTarget to the value specified in the money field, if it is lower than the current Line Item price for the same currency. If the Line Item price is already discounted to a price equal to or lower than the respective price in the money field, this Discount is not applied. If the quantity of the Line Item eligible for the Discount is greater than 1, the fixed price discount is only applied to the Line Item portion for which the money value is lesser than their current price.

`type` String	`"fixed"`
`money` Array of TypedMoney	Money values in cent precision or high precision of different currencies.

CartDiscountValueGiftLineItem

A Gift Line Item is automatically added to the Cart when a Discount Predicate evaluates as true.

The Gift Line Item has the following characteristics:

LineItemMode GiftLineItem and a quantity of 1.
Like all other Line Items, it has the price field set (it is, therefore, necessary that the Product Variant has a Price defined that can be selected for each Cart the Discount should be applied to).
The totalPrice has a centAmount of 0.
The discountedPricePerQuantity shows a discountedPrice with a centAmount of 0 and includedDiscounts references the Cart Discount that was evaluated to add the Gift Line Item.

If the gift Line Item becomes invalid (for example when the referenced Product, Product Variant, or Channel has been deleted) since creation, or if a Price cannot be selected for a Cart, the Discount does not apply to the Cart.

`type` String	`"giftLineItem"`
`product` ProductReference	Reference to a Product. A Gift Line Item can be present on a Cart even if the referenced Product is unpublished.
`variantId` Int	ProductVariant of the Product.
`supplyChannel` ChannelReference	Channel must have the ChannelRoleEnum `InventorySupply`.
`distributionChannel` ChannelReference	Channel must have the ChannelRoleEnum `ProductDistribution`.

Cannot be combined with MultiBuyLineItemsTarget.

CartDiscountValueDraft

Defines the effect the Discount will have on the specified target. You can define a relative or absolute Discount value, a fixed item Price value, or a Gift Line Item.

CartDiscountValueRelativeDraft

`type` String	`"relative"`
`permyriad` Int	Fraction (per ten thousand) the price is reduced by. For example, `1000` will result in a 10% price reduction.

CartDiscountValueAbsoluteDraft

type

String

"absolute"

money

Array of Money

Money values in different currencies. An absolute Cart Discount will match a price only if the array contains a value with the same currency. For example, if it contains 10€ and 15$, the matching € price will be decreased by 10€ and the matching $ price will be decreased by 15$. If the array has multiple values of the same currency, the API returns an InvalidOperation error.

If the array is empty, the discount does not apply.

CartDiscountValueFixedDraft

type

String

"fixed"

money

Array of TypedMoneyDraft

Money values provided either in cent precision or high precision for different currencies. A fixed Cart Discount will match a price only if the array contains a value with the same currency. For example, if it contains 10€ and 15$, the matching € price will be discounted by 10€ and the matching $ price will be discounted to 15$. If the array has multiple values of the same currency, the API returns an InvalidOperation error.

If the array is empty, the discount does not apply.

CartDiscountValueGiftLineItemDraft

Adds one free Line Item to the Cart as a gift.

Can only be used in a CartDiscountDraft with no target specified. Hence, this type can not be used in the Change Value update action.

`type` String	`"giftLineItem"`
`product` ProductResourceIdentifier	ResourceIdentifier of a Product. A Gift Line Item is added to a Cart even if the referenced Product is unpublished.
`variantId` Int	ProductVariant of the Product.
`supplyChannel` ChannelResourceIdentifier	Channel must have the role `InventorySupply`.
`distributionChannel` ChannelResourceIdentifier	Channel must have the role `ProductDistribution`.

CartDiscountTarget

Defines what segment of the Cart will be discounted.
Discounts can be applied on LineItems, CustomLineItems, ShippingInfo, or Cart totalPrice.

CartDiscountLineItemsTarget

Discount is applied to LineItems matching the predicate.

`type` String	`"lineItems"`
`predicate` String	Valid LineItem target predicate.

CartDiscountCustomLineItemsTarget

Discount is applied to CustomLineItems matching the predicate.

`type` String	`"customLineItems"`
`predicate` String	Valid CustomLineItem target predicate.

CartDiscountShippingCostTarget

Discount is applied to the shipping costs of the Cart.

type

String

"shipping"

CartDiscountTotalPriceTarget

Discount is applied to the total price of the Cart.

type

String

"totalPrice"

When other Cart Discounts with different targets apply on a Cart, the Cart Total Price discount applies last, regardless of its sort order and ignoring the StopAfterThisDiscount StackingMode of the other Cart Discounts, if any. The sort order for a Cart Total Price discount only determines its ranking among other Cart Discounts targeting the Total Price. As a result, the stackingMode = StopAfterThisDiscount takes effect for a Cart Total Price discount only when there are other Cart Discounts targeting the Total Price with a lower sort order.

MultiBuyLineItemsTarget BETA

Multi-buy Discounts represent a "Buy X items, get Y of them at a discounted rate" type of discount. Multi-buy Line Items can only be discounted relatively.

To select the items relevant for the Discount, a LineItem Predicate is applied. Unlike LineItems Target, a multi-buy Discount is not applied on each LineItem as a whole, but on individual items that are contained in all matching Line Items and subsumed under their quantity fields.

`type` String	`"multiBuyLineItems"`
`predicate` String	Valid LineItem target predicate. The Discount will be applied to Line Items that are matched by the predicate.
`triggerQuantity` Int	Number of Line Items to be present in order to trigger an application of this Discount. Minimum: `2`
`discountedQuantity` Int	Number of Line Items that are discounted per application of this Discount. It must be less than or equal to the `triggerQuantity`. Minimum: `1`
`maxOccurrence` Int	Maximum number of times this Discount can be applied. Do not set if the Discount should be applied an unlimited number of times.
`selectionMode` SelectionMode	Discounts particular Line Items only according to the SelectionMode.

A multi-buy Discount can occur multiple times in a Cart, but any item will only be considered once per multi-buy Discount. A single application of a multi-buy Discount is defined by the triggerQuantity and discountedQuantity. For example, if the triggerQuantity is 6, and the discountedQuantity is 2, then the following cases apply:

On a Cart with 6 items, 2 items are discounted and 4 items are undiscounted while participating in the Discount. As a result, the Discount is applied only once.
On a Cart with 8 items, 2 items are discounted, 4 items are undiscounted while participating in the Discount, and the 2 remaining items are disregarded by the Discount. As a result, the Discount is still applied only once.
On a Cart with 12 items, 2*2 items are discounted and 2*4 are undiscounted while participating in the Discount. As a result, the Discount is applied twice.

A participation is represented by a DiscountedLineItemPortion with discountedAmount.centAmount = 0.

To recap, the matching items of a Discount application are sliced into maxOccurence groups of size triggerQuantity. The remaining items (for example, the ninth item in a "buy 8, get 2 free" discount) do not participate in the Discount. In any such group, only discountedQuantity items are actually discounted (for example, the second item of a "buy 8, get 2 free" discount); the other items are part of this occurrence and thus, cannot participate in another group and the Price remains unchanged.

MultiBuyCustomLineItemsTarget BETA

Multi-buy Custom Line Items can only be discounted relatively.

To select the items relevant for the Discount, a CustomLineItem Predicate is applied. Unlike CustomLineItems Target, a multi-buy Discount is not applied on each CustomLineItem as a whole, but on individual items that are contained in all matching Custom Line Items and subsumed under their quantity fields.

This Discount target is similar to MultiBuyLineItems, but is applied on Custom Line Items instead of Line Items.

`type` String	`"multiBuyCustomLineItems"`
`predicate` String	Valid CustomLineItems target predicate. The Discount will be applied to Custom Line Items that are matched by the predicate.
`triggerQuantity` Int	Number of Custom Line Items to be present in order to trigger an application of this Discount. Minimum: `2`
`discountedQuantity` Int	Number of Custom Line Items that are discounted per application of this Discount. It must be less than or equal to the `triggerQuantity`. Minimum: `1`
`maxOccurrence` Int	Maximum number of times this Discount can be applied. Do not set if the Discount should be applied an unlimited number of times.
`selectionMode` SelectionMode	Discounts particular Line Items only according to the SelectionMode.

SelectionMode

Defines which matching items are to be discounted.

Cheapest: Select the cheapest items.
MostExpensive: Select the most expensive items.

If the Discount occurs multiple times, it is guaranteed that, out of all matching items, the cheapest or most expensive ones will be discounted, depending on this setting.

If two or more items have the same Price, it is not predictable which of the items are participating in the Discount and which are not. What we guarantee is that the total Discount over all participating items is correct.

Discount always refers to the current Price including already applied Discounts.

StackingMode

Describes how the Cart Discount interacts with other Discounts.

Stacking: Applies other matching Discounts after applying this one.
StopAfterThisDiscount: Doesn't apply any more matching Discounts after this one if it's successfully applied.

The stacking mode does not control free shipping as defined via freeAbove on a ShippingRate. To avoid unwanted scenarios, we highly recommend not using Cart Discounts on shipping target and freeAbove together.

Get CartDiscount

Get CartDiscount by ID

GET

https://api.{region}.commercetools.com/{projectKey}/cart-discounts/{id}

OAuth 2.0 Scopes:

view_orders:{projectKey} , view_cart_discounts:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`id` String	`id` of the CartDiscount.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Response:

200CartDiscountasapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/cart-discounts/{id} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

200 Response Example: CartDiscountjson

{
  "id": "c2f93298-c967-44af-8c2a-d2220bf39eb2",
  "version": 1,
  "createdAt": "1970-01-01T00:00:00.001Z",
  "lastModifiedAt": "1970-01-01T00:00:00.001Z",
  "name": {
    "en": "Summer Sale"
  },
  "value": {
    "type": "relative",
    "permyriad": 1000
  },
  "cartPredicate": "1=1",
  "target": {
    "type": "lineItems",
    "predicate": "1=1"
  },
  "sortOrder": "0.1",
  "stores": [
    {
      "key": "{{store-key}}",
      "typeId": "store"
    }
  ],
  "isActive": true,
  "requiresDiscountCode": false,
  "references": [],
  "stackingMode": "Stacking"
}

Get CartDiscount by Key

GET

https://api.{region}.commercetools.com/{projectKey}/cart-discounts/key={key}

OAuth 2.0 Scopes:

view_orders:{projectKey} , view_cart_discounts:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`key` String	`key` of the CartDiscount.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Response:

200CartDiscountasapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/cart-discounts/key={key} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

200 Response Example: CartDiscountjson

{
  "id": "c2f93298-c967-44af-8c2a-d2220bf39eb2",
  "version": 1,
  "createdAt": "1970-01-01T00:00:00.001Z",
  "lastModifiedAt": "1970-01-01T00:00:00.001Z",
  "name": {
    "en": "Summer Sale"
  },
  "value": {
    "type": "relative",
    "permyriad": 1000
  },
  "cartPredicate": "1=1",
  "target": {
    "type": "lineItems",
    "predicate": "1=1"
  },
  "sortOrder": "0.1",
  "stores": [
    {
      "key": "{{store-key}}",
      "typeId": "store"
    }
  ],
  "isActive": true,
  "requiresDiscountCode": false,
  "references": [],
  "stackingMode": "Stacking"
}

Get CartDiscount in Store

Get CartDiscount by ID

GET

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts/{id}

OAuth 2.0 Scopes:

view_orders:{projectKey} , view_orders:{projectKey}:{storeKey} , view_cart_discounts:{projectKey} , view_cart_discounts:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.
`id` String	`id` of the CartDiscount.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Response:

200CartDiscountasapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts/{id} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

200 Response Example: CartDiscountjson

{
  "id": "c2f93298-c967-44af-8c2a-d2220bf39eb2",
  "version": 1,
  "createdAt": "1970-01-01T00:00:00.001Z",
  "lastModifiedAt": "1970-01-01T00:00:00.001Z",
  "name": {
    "en": "Summer Sale"
  },
  "value": {
    "type": "relative",
    "permyriad": 1000
  },
  "cartPredicate": "1=1",
  "target": {
    "type": "lineItems",
    "predicate": "1=1"
  },
  "sortOrder": "0.1",
  "stores": [
    {
      "key": "{{store-key}}",
      "typeId": "store"
    }
  ],
  "isActive": true,
  "requiresDiscountCode": false,
  "references": [],
  "stackingMode": "Stacking"
}

Get CartDiscount by Key

GET

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts/key={key}

OAuth 2.0 Scopes:

view_orders:{projectKey} , view_orders:{projectKey}:{storeKey} , view_cart_discounts:{projectKey} , view_cart_discounts:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.
`key` String	`key` of the CartDiscount.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Response:

200CartDiscountasapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts/key={key} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

200 Response Example: CartDiscountjson

{
  "id": "c2f93298-c967-44af-8c2a-d2220bf39eb2",
  "version": 1,
  "createdAt": "1970-01-01T00:00:00.001Z",
  "lastModifiedAt": "1970-01-01T00:00:00.001Z",
  "name": {
    "en": "Summer Sale"
  },
  "value": {
    "type": "relative",
    "permyriad": 1000
  },
  "cartPredicate": "1=1",
  "target": {
    "type": "lineItems",
    "predicate": "1=1"
  },
  "sortOrder": "0.1",
  "stores": [
    {
      "key": "{{store-key}}",
      "typeId": "store"
    }
  ],
  "isActive": true,
  "requiresDiscountCode": false,
  "references": [],
  "stackingMode": "Stacking"
}

Query CartDiscounts

GET

https://api.{region}.commercetools.com/{projectKey}/cart-discounts

OAuth 2.0 Scopes:

view_orders:{projectKey} , view_cart_discounts:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.

Query parameters:

`where` QueryPredicate	The parameter can be passed multiple times.
`/^var[.][a-zA-Z0-9]+$/` Any string parameter matching this regular expression	Predicate parameter values. The parameter can be passed multiple times.
`sort` Sort	The parameter can be passed multiple times.
`expand` Expansion	The parameter can be passed multiple times.
`limit` Int	Number of results requested.
`offset` Int	Number of elements skipped.
`withTotal` Boolean	Controls the calculation of the total number of query results. Set to `false` to improve query performance when the `total` is not needed.

Response:

200CartDiscountPagedQueryResponseasapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/cart-discounts -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

200 Response Example: CartDiscountPagedQueryResponsejson

{
  "limit": 20,
  "offset": 0,
  "count": 1,
  "total": 1,
  "results": [
    {
      "id": "c2f93298-c967-44af-8c2a-d2220bf39eb2",
      "version": 1,
      "createdAt": "1970-01-01T00:00:00.001Z",
      "lastModifiedAt": "1970-01-01T00:00:00.001Z",
      "name": {
        "en": "Summer Sale"
      },
      "value": {
        "type": "relative",
        "permyriad": 1000
      },
      "cartPredicate": "1=1",
      "target": {
        "type": "lineItems",
        "predicate": "1=1"
      },
      "sortOrder": "0.1",
      "stores": [
        {
          "key": "{{store-key}}",
          "typeId": "store"
        }
      ],
      "isActive": true,
      "requiresDiscountCode": false,
      "references": [],
      "stackingMode": "Stacking"
    }
  ]
}

Query CartDiscounts in Store

GET

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts

OAuth 2.0 Scopes:

view_orders:{projectKey} , view_orders:{projectKey}:{storeKey} , view_cart_discounts:{projectKey} , view_cart_discounts:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.

Query parameters:

`where` QueryPredicate	The parameter can be passed multiple times.
`/^var[.][a-zA-Z0-9]+$/` Any string parameter matching this regular expression	Predicate parameter values. The parameter can be passed multiple times.
`sort` Sort	The parameter can be passed multiple times.
`expand` Expansion	The parameter can be passed multiple times.
`limit` Int	Number of results requested.
`offset` Int	Number of elements skipped.
`withTotal` Boolean	Controls the calculation of the total number of query results. Set to `false` to improve query performance when the `total` is not needed.

Response:

200CartDiscountPagedQueryResponseasapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

200 Response Example: CartDiscountPagedQueryResponsejson

{
  "limit": 20,
  "offset": 0,
  "count": 1,
  "total": 1,
  "results": [
    {
      "id": "c2f93298-c967-44af-8c2a-d2220bf39eb2",
      "version": 1,
      "createdAt": "1970-01-01T00:00:00.001Z",
      "lastModifiedAt": "1970-01-01T00:00:00.001Z",
      "name": {
        "en": "Summer Sale"
      },
      "value": {
        "type": "relative",
        "permyriad": 1000
      },
      "cartPredicate": "1=1",
      "target": {
        "type": "lineItems",
        "predicate": "1=1"
      },
      "sortOrder": "0.1",
      "stores": [
        {
          "key": "{{store-key}}",
          "typeId": "store"
        }
      ],
      "isActive": true,
      "requiresDiscountCode": false,
      "references": [],
      "stackingMode": "Stacking"
    }
  ]
}

Check if CartDiscount exists

Check if CartDiscount exists by ID

HEAD

https://api.{region}.commercetools.com/{projectKey}/cart-discounts/{id}

Checks if a CartDiscount exists for a given id. Returns a 200 OK status if the CartDiscount exists or a 404 Not Found otherwise.

OAuth 2.0 Scopes:

view_orders:{projectKey} , view_cart_discounts:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`id` String	`id` of the CartDiscount.

Response:

200

Request Example:cURL

curl --head https://api.{region}.commercetools.com/{projectKey}/cart-discounts/{id} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

Check if CartDiscount exists by Key

HEAD

https://api.{region}.commercetools.com/{projectKey}/cart-discounts/key={key}

Checks if a CartDiscount exists for a given key. Returns a 200 OK status if the CartDiscount exists or a 404 Not Found otherwise.

OAuth 2.0 Scopes:

view_orders:{projectKey} , view_cart_discounts:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`key` String	`key` of the CartDiscount.

Response:

200

Request Example:cURL

curl --head https://api.{region}.commercetools.com/{projectKey}/cart-discounts/key={key} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

Check if CartDiscount exists by Query Predicate

HEAD

https://api.{region}.commercetools.com/{projectKey}/cart-discounts

Checks if a CartDiscount exists for a given Query Predicate. Returns a 200 OK status if any CartDiscounts match the Query Predicate, or a 404 Not Found otherwise.

OAuth 2.0 Scopes:

view_orders:{projectKey} , view_cart_discounts:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.

Query parameters:

where

QueryPredicate

The parameter can be passed multiple times.

Response:

200

Request Example:cURL

curl --head https://api.{region}.commercetools.com/{projectKey}/cart-discounts -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

Check if CartDiscount exists in Store

Check if CartDiscount exists by ID

HEAD

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts/{id}

Checks if a CartDiscount exists for a given id. Returns a 200 OK status if the CartDiscount exists or a 404 Not Found otherwise.

OAuth 2.0 Scopes:

view_orders:{projectKey} , view_orders:{projectKey}:{storeKey} , view_cart_discounts:{projectKey} , view_cart_discounts:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.
`id` String	`id` of the CartDiscount.

Response:

200

Request Example:cURL

curl --head https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts/{id} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

Check if CartDiscount exists by Key

HEAD

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts/key={key}

Checks if a CartDiscount exists for a given key. Returns a 200 OK status if the CartDiscount exists or a 404 Not Found otherwise.

OAuth 2.0 Scopes:

view_orders:{projectKey} , view_orders:{projectKey}:{storeKey} , view_cart_discounts:{projectKey} , view_cart_discounts:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.
`key` String	`key` of the CartDiscount.

Response:

200

Request Example:cURL

curl --head https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts/key={key} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

Check if CartDiscount exists by Query Predicate

HEAD

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts

Checks if a CartDiscount exists for a given Query Predicate. Returns a 200 OK status if any CartDiscounts match the Query Predicate or a 404 Not Found otherwise.

OAuth 2.0 Scopes:

view_orders:{projectKey} , view_orders:{projectKey}:{storeKey} , view_cart_discounts:{projectKey} , view_cart_discounts:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.

Query parameters:

where

QueryPredicate

The parameter can be passed multiple times.

Response:

200

Request Example:cURL

curl --head https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

Create CartDiscount

POST

https://api.{region}.commercetools.com/{projectKey}/cart-discounts

Creating a Cart Discount produces the CartDiscountCreated Message.

OAuth 2.0 Scopes:

manage_orders:{projectKey} , manage_cart_discounts:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Request Body:CartDiscountDraftasapplication/json

Response:

201CartDiscountasapplication/json

Request Example:cURL

curl https://api.{region}.commercetools.com/{projectKey}/cart-discounts -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}' \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "name" : {
    "en" : "Summer Sale"
  },
  "value" : {
    "type" : "relative",
    "permyriad" : 1000
  },
  "cartPredicate" : "1=1",
  "target" : {
    "type" : "lineItems",
    "predicate" : "1=1"
  },
  "sortOrder" : "0.1",
  "stores" : [ {
    "key" : "{{store-key}}"
  } ],
  "isActive" : true,
  "requiresDiscountCode" : false
}
DATA

201 Response Example: CartDiscountjson

{
  "id": "c2f93298-c967-44af-8c2a-d2220bf39eb2",
  "version": 1,
  "createdAt": "1970-01-01T00:00:00.001Z",
  "lastModifiedAt": "1970-01-01T00:00:00.001Z",
  "name": {
    "en": "Summer Sale"
  },
  "value": {
    "type": "relative",
    "permyriad": 1000
  },
  "cartPredicate": "1=1",
  "target": {
    "type": "lineItems",
    "predicate": "1=1"
  },
  "sortOrder": "0.1",
  "stores": [
    {
      "key": "{{store-key}}",
      "typeId": "store"
    }
  ],
  "isActive": true,
  "requiresDiscountCode": false,
  "references": [],
  "stackingMode": "Stacking"
}

Create CartDiscount in Store

POST

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts

When using the endpoint, the Store specified in the path and the Stores specified in the payload's stores field are added to the CartDiscount.

Creating a Cart Discount produces the CartDiscountCreated Message.

OAuth 2.0 Scopes:

manage_orders:{projectKey} , manage_orders:{projectKey}:{storeKey} , manage_cart_discounts:{projectKey} , manage_cart_discounts:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Request Body:CartDiscountDraftasapplication/json

Response:

201CartDiscountasapplication/json

Request Example:cURL

curl https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}' \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "name" : {
    "en" : "Summer Sale"
  },
  "value" : {
    "type" : "relative",
    "permyriad" : 1000
  },
  "cartPredicate" : "1=1",
  "target" : {
    "type" : "lineItems",
    "predicate" : "1=1"
  },
  "sortOrder" : "0.1",
  "stores" : [ {
    "key" : "{{store-key}}"
  } ],
  "isActive" : true,
  "requiresDiscountCode" : false
}
DATA

201 Response Example: CartDiscountjson

{
  "id": "c2f93298-c967-44af-8c2a-d2220bf39eb2",
  "version": 1,
  "createdAt": "1970-01-01T00:00:00.001Z",
  "lastModifiedAt": "1970-01-01T00:00:00.001Z",
  "name": {
    "en": "Summer Sale"
  },
  "value": {
    "type": "relative",
    "permyriad": 1000
  },
  "cartPredicate": "1=1",
  "target": {
    "type": "lineItems",
    "predicate": "1=1"
  },
  "sortOrder": "0.1",
  "stores": [
    {
      "key": "{{store-key}}",
      "typeId": "store"
    }
  ],
  "isActive": true,
  "requiresDiscountCode": false,
  "references": [],
  "stackingMode": "Stacking"
}

Update CartDiscount

Update CartDiscount by ID

POST

https://api.{region}.commercetools.com/{projectKey}/cart-discounts/{id}

OAuth 2.0 Scopes:

manage_orders:{projectKey} , manage_cart_discounts:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`id` String	`id` of the CartDiscount.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Request Body:

application/json

`version` Int	Expected version of the CartDiscount on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.
`actions` Array of CartDiscountUpdateAction	Update actions to be performed on the CartDiscount.

Response:

200CartDiscountasapplication/json

Request Example:cURL

curl https://api.{region}.commercetools.com/{projectKey}/cart-discounts/{id} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}' \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "version" : 1,
  "actions" : [ {
    "action" : "changeValue",
    "value" : {
      "type" : "relative",
      "permyriad" : 1000
    }
  } ]
}
DATA

200 Response Example: CartDiscountjson

{
  "id": "c2f93298-c967-44af-8c2a-d2220bf39eb2",
  "version": 1,
  "createdAt": "1970-01-01T00:00:00.001Z",
  "lastModifiedAt": "1970-01-01T00:00:00.001Z",
  "name": {
    "en": "Summer Sale"
  },
  "value": {
    "type": "relative",
    "permyriad": 1000
  },
  "cartPredicate": "1=1",
  "target": {
    "type": "lineItems",
    "predicate": "1=1"
  },
  "sortOrder": "0.1",
  "stores": [
    {
      "key": "{{store-key}}",
      "typeId": "store"
    }
  ],
  "isActive": true,
  "requiresDiscountCode": false,
  "references": [],
  "stackingMode": "Stacking"
}

Update CartDiscount by Key

POST

https://api.{region}.commercetools.com/{projectKey}/cart-discounts/key={key}

OAuth 2.0 Scopes:

manage_orders:{projectKey} , manage_cart_discounts:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`key` String	`key` of the CartDiscount.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Request Body:

application/json

`version` Int	Expected version of the CartDiscount on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.
`actions` Array of CartDiscountUpdateAction	Update actions to be performed on the CartDiscount.

Response:

200CartDiscountasapplication/json

Request Example:cURL

curl https://api.{region}.commercetools.com/{projectKey}/cart-discounts/key={key} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}' \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "version" : 1,
  "actions" : [ {
    "action" : "changeValue",
    "value" : {
      "type" : "relative",
      "permyriad" : 1000
    }
  } ]
}
DATA

200 Response Example: CartDiscountjson

{
  "id": "c2f93298-c967-44af-8c2a-d2220bf39eb2",
  "version": 1,
  "createdAt": "1970-01-01T00:00:00.001Z",
  "lastModifiedAt": "1970-01-01T00:00:00.001Z",
  "name": {
    "en": "Summer Sale"
  },
  "value": {
    "type": "relative",
    "permyriad": 1000
  },
  "cartPredicate": "1=1",
  "target": {
    "type": "lineItems",
    "predicate": "1=1"
  },
  "sortOrder": "0.1",
  "stores": [
    {
      "key": "{{store-key}}",
      "typeId": "store"
    }
  ],
  "isActive": true,
  "requiresDiscountCode": false,
  "references": [],
  "stackingMode": "Stacking"
}

Update CartDiscount in Store

Update CartDiscount by ID

POST

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts/{id}

To update a CartDiscount, you must have permissions for all Stores the CartDiscount is associated with, except when removing a Store.

OAuth 2.0 Scopes:

manage_orders:{projectKey} , manage_orders:{projectKey}:{storeKey} , manage_cart_discounts:{projectKey} , manage_cart_discounts:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.
`id` String	`id` of the CartDiscount.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Request Body:

application/json

`version` Int	Expected version of the CartDiscount on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.
`actions` Array of CartDiscountUpdateAction	Update actions to be performed on the CartDiscount.

Response:

200CartDiscountasapplication/json

Request Example:cURL

curl https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts/{id} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}' \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "version" : 1,
  "actions" : [ {
    "action" : "changeValue",
    "value" : {
      "type" : "relative",
      "permyriad" : 1000
    }
  } ]
}
DATA

200 Response Example: CartDiscountjson

{
  "id": "c2f93298-c967-44af-8c2a-d2220bf39eb2",
  "version": 1,
  "createdAt": "1970-01-01T00:00:00.001Z",
  "lastModifiedAt": "1970-01-01T00:00:00.001Z",
  "name": {
    "en": "Summer Sale"
  },
  "value": {
    "type": "relative",
    "permyriad": 1000
  },
  "cartPredicate": "1=1",
  "target": {
    "type": "lineItems",
    "predicate": "1=1"
  },
  "sortOrder": "0.1",
  "stores": [
    {
      "key": "{{store-key}}",
      "typeId": "store"
    }
  ],
  "isActive": true,
  "requiresDiscountCode": false,
  "references": [],
  "stackingMode": "Stacking"
}

Update CartDiscount by Key

POST

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts/key={key}

To update a CartDiscount, you must have permissions for all Stores the CartDiscount is associated with, except when removing a Store.

OAuth 2.0 Scopes:

manage_orders:{projectKey} , manage_orders:{projectKey}:{storeKey} , manage_cart_discounts:{projectKey} , manage_cart_discounts:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.
`key` String	`key` of the CartDiscount.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Request Body:

application/json

`version` Int	Expected version of the CartDiscount on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.
`actions` Array of CartDiscountUpdateAction	Update actions to be performed on the CartDiscount.

Response:

200CartDiscountasapplication/json

Request Example:cURL

curl https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts/key={key} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}' \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "version" : 1,
  "actions" : [ {
    "action" : "changeValue",
    "value" : {
      "type" : "relative",
      "permyriad" : 1000
    }
  } ]
}
DATA

200 Response Example: CartDiscountjson

{
  "id": "c2f93298-c967-44af-8c2a-d2220bf39eb2",
  "version": 1,
  "createdAt": "1970-01-01T00:00:00.001Z",
  "lastModifiedAt": "1970-01-01T00:00:00.001Z",
  "name": {
    "en": "Summer Sale"
  },
  "value": {
    "type": "relative",
    "permyriad": 1000
  },
  "cartPredicate": "1=1",
  "target": {
    "type": "lineItems",
    "predicate": "1=1"
  },
  "sortOrder": "0.1",
  "stores": [
    {
      "key": "{{store-key}}",
      "typeId": "store"
    }
  ],
  "isActive": true,
  "requiresDiscountCode": false,
  "references": [],
  "stackingMode": "Stacking"
}

Update actions

Set Key

Change Value

Change Cart Predicate

Change Requires DiscountCode

Set Valid From

Set Valid Until

Set Valid From and Until

Set Key

`action` String	`"setKey"`
`key` String	Value to set. If empty, any existing value will be removed. MinLength: `2`MaxLength: `256`Pattern: `^[A-Za-z0-9_-]+$`

Example: json

{
  "action": "setKey",
  "key": "new-key"
}

Change Value

Changes the CartDiscountValue for relative, absolute and fixed price CartDiscounts. Changing to Gift Line Item is not supported.

`action` String	`"changeValue"`
`value` CartDiscountValueDraft	New value to set. When trying to set a CartDiscountValueGiftLineItemDraft an InvalidInput error is returned.

Example: json

{
  "action": "changeValue",
  "value": {
    "type": "absolute",
    "money": [
      {
        "currencyCode": "EUR",
        "centAmount": 40099
      }
    ]
  }
}

Change Cart Predicate

`action` String	`"changeCartPredicate"`
`cartPredicate` String	New value to set.

Example: json

{
  "action": "changeCartPredicate",
  "cartPredicate": "cartPredicateString"
}

Change Target

`action` String	`"changeTarget"`
`target` CartDiscountTarget	New value to set.

Example: json

{
  "action": "changeTarget",
  "target": {
    "type": "lineItems",
    "predicate": "sku = \"myOtherSKU\""
  }
}

Change IsActive

`action` String	`"changeIsActive"`
`isActive` Boolean	New value to set. If set to `true`, the Discount will be applied to the Cart. If the limit for active Cart Discounts is reached, a MaxCartDiscountsReached error is returned.

Example: json

{
  "action": "changeIsActive",
  "isActive": false
}

Change Name

`action` String	`"changeName"`
`name` LocalizedString	New value to set.

Example: json

{
  "action": "changeName",
  "name": {
    "en": "NewNameEN",
    "de": "NewNameDE"
  }
}

Set Description

`action` String	`"setDescription"`
`description` LocalizedString	Value to set. If empty, any existing value will be removed.

Example: json

{
  "action": "setDescription",
  "description": {
    "en": "New Description EN",
    "de": "New Description DE"
  }
}

Change Sort Order

`action` String	`"changeSortOrder"`
`sortOrder` String	New value to set (between `0` and `1`). A Discount with a higher sortOrder is prioritized.

Example: json

{
  "action": "changeSortOrder",
  "sortOrder": "0.2"
}

Change Requires DiscountCode

`action` String	`"changeRequiresDiscountCode"`
`requiresDiscountCode` Boolean	New value to set. If set to `true`, the Discount can only be used in connection with a DiscountCode.

Example: json

{
  "action": "changeRequiresDiscountCode",
  "requiresDiscountCode": true
}

Set Valid From

`action` String	`"setValidFrom"`
`validFrom` DateTime	Value to set. If empty, any existing value will be removed.

Example: json

{
  "action": "setValidFrom",
  "validFrom": "2017-10-15T15:00:00.000Z"
}

Set Valid Until

`action` String	`"setValidUntil"`
`validUntil` DateTime	Value to set. If empty, any existing value will be removed.

Example: json

{
  "action": "setValidUntil",
  "validUntil": "2017-10-15T20:00:00.000Z"
}

Set Valid From and Until

`action` String	`"setValidFromAndUntil"`
`validFrom` DateTime	Value to set. If empty, any existing value will be removed.
`validUntil` DateTime	Value to set. If empty, any existing value will be removed.

Example: json

{
  "action": "setValidFromAndUntil",
  "validFrom": "2017-10-15T15:00:00.000Z",
  "validUntil": "2017-10-15T15:05:00.000Z"
}

Change Stacking Mode

`action` String	`"changeStackingMode"`
`stackingMode` StackingMode	New value to set.

Example: json

{
  "action": "changeStackingMode",
  "stackingMode": "Stacking"
}

Add Store

If a referenced Store does not exist, a ReferencedResourceNotFound error is returned.

This action generates a CartDiscountStoreAdded Message.

`action` String	`"addStore"`
`store` StoreResourceIdentifier	Store to add. A failed update can return the following errors: If the referenced Stores exceed the limit, a MaxStoreReferencesReached error is returned. If the referenced Stores exceed the limit for Cart Discounts that do not require a Discount Code, a StoreCartDiscountsLimitReached error is returned.

Example: json

{
  "action": "addStore",
  "store": {
    "key": "{{store-key}}"
  }
}

Remove Store

If a referenced Store does not exist, a ReferencedResourceNotFound error is returned.

This action generates a CartDiscountStoreRemoved Message.

`action` String	`"removeStore"`
`store` StoreResourceIdentifier	Store to remove.

Example: json

{
  "action": "removeStore",
  "store": {
    "key": "{{store-key}}"
  }
}

Set Stores

If a referenced Store does not exist, a ReferencedResourceNotFound error is returned.

This action generates a CartDiscountStoresSet Message.

action

String

"setStores"

stores

Array of StoreResourceIdentifier

Stores to set. Overrides the current list of Stores. If empty, any existing values will be removed.

A failed update can return the following errors:

If the referenced Stores exceed the limit, a MaxStoreReferencesReached error is returned.
If the referenced Stores exceed the limit for Cart Discounts that do not require a Discount Code, a StoreCartDiscountsLimitReached error is returned.

MaxItems: 500

Example: json

{
  "action": "setStores",
  "stores": [
    {
      "key": "store-one"
    },
    {
      "key": "store-two"
    },
    {
      "key": "store-three"
    }
  ]
}

Set Custom Type

`action` String	`"setCustomType"`
`type` TypeResourceIdentifier	Defines the Type that extends the CartDiscount with Custom Fields. If absent, any existing Type and Custom Fields are removed from the CartDiscount.
`fields` FieldContainer	Sets the Custom Fields fields for the CartDiscount.

Example: json

{
  "action": "setCustomType",
  "type": {
    "id": "{{type-id}}",
    "typeId": "type"
  },
  "fields": {
    "exampleStringTypeField": "TextString"
  }
}

Set CustomField

`action` String	`"setCustomField"`
`name` String	Name of the Custom Field.
`value` CustomFieldValue	If `value` is absent or `null`, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If `value` is provided, it is set for the field defined by `name`.

Example: json

{
  "action": "setCustomField",
  "name": "ExampleStringTypeField",
  "value": "TextString"
}

Delete CartDiscount

Delete CartDiscount by ID

DELETE

https://api.{region}.commercetools.com/{projectKey}/cart-discounts/{id}

Deleting a Cart Discount produces the CartDiscountDeleted Message.

OAuth 2.0 Scopes:

manage_orders:{projectKey} , manage_cart_discounts:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`id` String	`id` of the CartDiscount.

Query parameters:

`version` Int	Last seen version of the resource.
`expand` Expansion	The parameter can be passed multiple times.

Response:

200CartDiscountasapplication/json

Request Example:cURL

curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/cart-discounts/{id}?version={version} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

200 Response Example: CartDiscountjson

{
  "id": "c2f93298-c967-44af-8c2a-d2220bf39eb2",
  "version": 1,
  "createdAt": "1970-01-01T00:00:00.001Z",
  "lastModifiedAt": "1970-01-01T00:00:00.001Z",
  "name": {
    "en": "Summer Sale"
  },
  "value": {
    "type": "relative",
    "permyriad": 1000
  },
  "cartPredicate": "1=1",
  "target": {
    "type": "lineItems",
    "predicate": "1=1"
  },
  "sortOrder": "0.1",
  "stores": [
    {
      "key": "{{store-key}}",
      "typeId": "store"
    }
  ],
  "isActive": true,
  "requiresDiscountCode": false,
  "references": [],
  "stackingMode": "Stacking"
}

Delete CartDiscount by Key

DELETE

https://api.{region}.commercetools.com/{projectKey}/cart-discounts/key={key}

Deleting a Cart Discount produces the CartDiscountDeleted Message.

OAuth 2.0 Scopes:

manage_orders:{projectKey} , manage_cart_discounts:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`key` String	`key` of the CartDiscount.

Query parameters:

`version` Int	Last seen version of the resource.
`expand` Expansion	The parameter can be passed multiple times.

Response:

200CartDiscountasapplication/json

Request Example:cURL

curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/cart-discounts/key={key}?version={version} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

200 Response Example: CartDiscountjson

{
  "id": "c2f93298-c967-44af-8c2a-d2220bf39eb2",
  "version": 1,
  "createdAt": "1970-01-01T00:00:00.001Z",
  "lastModifiedAt": "1970-01-01T00:00:00.001Z",
  "name": {
    "en": "Summer Sale"
  },
  "value": {
    "type": "relative",
    "permyriad": 1000
  },
  "cartPredicate": "1=1",
  "target": {
    "type": "lineItems",
    "predicate": "1=1"
  },
  "sortOrder": "0.1",
  "stores": [
    {
      "key": "{{store-key}}",
      "typeId": "store"
    }
  ],
  "isActive": true,
  "requiresDiscountCode": false,
  "references": [],
  "stackingMode": "Stacking"
}

Delete CartDiscount in Store

Delete CartDiscount by ID

DELETE

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts/{id}

To delete a CartDiscount, specify the manage_cart_discounts:{projectKey}:{storeKey} scope for all Stores associated with the CartDiscount.

Deleting a Cart Discount produces the CartDiscountDeleted Message.

OAuth 2.0 Scopes:

manage_orders:{projectKey} , manage_orders:{projectKey}:{storeKey} , manage_cart_discounts:{projectKey} , manage_cart_discounts:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.
`id` String	`id` of the CartDiscount.

Query parameters:

`version` Int	Last seen version of the resource.
`expand` Expansion	The parameter can be passed multiple times.

Response:

200CartDiscountasapplication/json

Request Example:cURL

curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts/{id}?version={version} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

200 Response Example: CartDiscountjson

{
  "id": "c2f93298-c967-44af-8c2a-d2220bf39eb2",
  "version": 1,
  "createdAt": "1970-01-01T00:00:00.001Z",
  "lastModifiedAt": "1970-01-01T00:00:00.001Z",
  "name": {
    "en": "Summer Sale"
  },
  "value": {
    "type": "relative",
    "permyriad": 1000
  },
  "cartPredicate": "1=1",
  "target": {
    "type": "lineItems",
    "predicate": "1=1"
  },
  "sortOrder": "0.1",
  "stores": [
    {
      "key": "{{store-key}}",
      "typeId": "store"
    }
  ],
  "isActive": true,
  "requiresDiscountCode": false,
  "references": [],
  "stackingMode": "Stacking"
}

Delete CartDiscount by Key

DELETE

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts/key={key}

To delete a CartDiscount, specify the manage_cart_discounts:{projectKey}:{storeKey} scope for all Stores associated with the CartDiscount.

Deleting a Cart Discount produces the CartDiscountDeleted Message.

OAuth 2.0 Scopes:

manage_orders:{projectKey} , manage_orders:{projectKey}:{storeKey} , manage_cart_discounts:{projectKey} , manage_cart_discounts:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.
`key` String	`key` of the CartDiscount.

Query parameters:

`version` Int	Last seen version of the resource.
`expand` Expansion	The parameter can be passed multiple times.

Response:

200CartDiscountasapplication/json

Request Example:cURL

curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/cart-discounts/key={key}?version={version} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

200 Response Example: CartDiscountjson

{
  "id": "c2f93298-c967-44af-8c2a-d2220bf39eb2",
  "version": 1,
  "createdAt": "1970-01-01T00:00:00.001Z",
  "lastModifiedAt": "1970-01-01T00:00:00.001Z",
  "name": {
    "en": "Summer Sale"
  },
  "value": {
    "type": "relative",
    "permyriad": 1000
  },
  "cartPredicate": "1=1",
  "target": {
    "type": "lineItems",
    "predicate": "1=1"
  },
  "sortOrder": "0.1",
  "stores": [
    {
      "key": "{{store-key}}",
      "typeId": "store"
    }
  ],
  "isActive": true,
  "requiresDiscountCode": false,
  "references": [],
  "stackingMode": "Stacking"
}

Cart Discounts

Representations

CartDiscount

CartDiscountDraft

CartDiscountPagedQueryResponse

CartDiscountReference

CartDiscountResourceIdentifier

CartDiscountValue

CartDiscountValueRelative

CartDiscountValueAbsolute

CartDiscountValueFixed

CartDiscountValueGiftLineItem

CartDiscountValueDraft

CartDiscountValueRelativeDraft

CartDiscountValueAbsoluteDraft

CartDiscountValueFixedDraft

CartDiscountValueGiftLineItemDraft

CartDiscountTarget

CartDiscountLineItemsTarget

CartDiscountCustomLineItemsTarget

CartDiscountShippingCostTarget

CartDiscountTotalPriceTarget

MultiBuyLineItemsTarget BETA

MultiBuyCustomLineItemsTarget BETA

SelectionMode

StackingMode

Get CartDiscount

Get CartDiscount by ID

Get CartDiscount by Key

Get CartDiscount in Store

Get CartDiscount by ID

Get CartDiscount by Key

Query CartDiscounts

Query CartDiscounts in Store

Check if CartDiscount exists

Check if CartDiscount exists by ID

Check if CartDiscount exists by Key

Check if CartDiscount exists by Query Predicate

Check if CartDiscount exists in Store

Check if CartDiscount exists by ID

Check if CartDiscount exists by Key

Check if CartDiscount exists by Query Predicate

Create CartDiscount

Create CartDiscount in Store

Update CartDiscount

Update CartDiscount by ID

Update CartDiscount by Key

Update CartDiscount in Store

Update CartDiscount by ID

Update CartDiscount by Key

Update actions

Set Key

Change Value

Change Cart Predicate

Change Target

Change IsActive

Change Name

Set Description

Change Sort Order

Change Requires DiscountCode

Set Valid From

Set Valid Until

Set Valid From and Until

Change Stacking Mode

Add Store

Remove Store

Set Stores

Set Custom Type

Set CustomField

Delete CartDiscount

Delete CartDiscount by ID

Delete CartDiscount by Key

Delete CartDiscount in Store

Delete CartDiscount by ID

Delete CartDiscount by Key