/commercetools-discounts | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
commercetools_discounts_create_cart_discounts | Creating a Cart Discount produces the CartDiscountCreated Message. |
commercetools_discounts_create_discount_codes | Creating a Discount Code produces the DiscountCodeCreated Message. Deprecated OAuth 2.0 Scope: manage_orders:{projectKey} |
commercetools_discounts_create_discount_groups | Creates a DiscountGroup in the Project. This request generates the DiscountGroupCreated Message. If the limit for active Discount Groups has been reached, a MaxDiscountGroupsReached error is returned. |
commercetools_discounts_create_product_discounts | POST /product-discounts |
commercetools_discounts_create_product_discounts_matching | This endpoint can be used to simulate which Product Discounts would be applied if a specified Product Variant had a specified Price. Given Product and Product Variant IDs and a Price, this endpoint will return the ProductDiscount that would have been applied to that Price. If a Product Discount could not be found that could be applied to the Price of a Product Variant, a NoMatchingProductDiscountFound error is returned. |
commercetools_discounts_create_standalone_prices | Creating a Standalone Price produces the StandalonePriceCreated Message. - If the Standalone Price has the same price scope as an existing Standalone Price, a DuplicateStandalonePriceScope error is returned. - If the Standalone Price has overlapping validity periods within the same price scope, a OverlappingStandalonePriceValidity error is returned. A Price without validity period does not conflict with a Price defined for a time period. - If a modification is already in progress for the exact combination of SKU and price scope fields, an ExactLockConflict or ValidityLockConflict error is returned. |
commercetools_discounts_delete_cart_discounts_by_id | Deleting a Cart Discount produces the CartDiscountDeleted Message. |
commercetools_discounts_delete_cart_discounts_by_key | Deleting a Cart Discount produces the CartDiscountDeleted Message. |
commercetools_discounts_delete_discount_codes_by_id | Deleting a Discount Code produces the DiscountCodeDeleted Message. Deprecated OAuth 2.0 Scope: manage_orders:{projectKey} |
commercetools_discounts_delete_discount_codes_by_key | Deleting a Discount Code produces the DiscountCodeDeleted Message. Deprecated OAuth 2.0 Scope: manage_orders:{projectKey} |
commercetools_discounts_delete_discount_groups_by_id | Deletes a DiscountGroup in the Project. This request generates the DiscountGroupDeleted Message. If the DiscountGroup is referenced by a CartDiscount, a ReferenceExists error is returned. |
commercetools_discounts_delete_discount_groups_by_key | Deletes a DiscountGroup in the Project. This request generates the DiscountGroupDeleted Message. If the DiscountGroup is referenced by a CartDiscount, a ReferenceExists error is returned. |
commercetools_discounts_delete_product_discounts_by_id | DELETE /product-discounts/{ID} |
commercetools_discounts_delete_product_discounts_by_key | DELETE /product-discounts/key={key} |
commercetools_discounts_delete_standalone_prices_by_id | Produces the StandalonePriceDeleted Message. |
commercetools_discounts_delete_standalone_prices_by_key | Produces the StandalonePriceDeleted Message. |
commercetools_discounts_get_cart_discounts_by_id | GET /cart-discounts/{ID} |
commercetools_discounts_get_cart_discounts_by_key | GET /cart-discounts/key={key} |
commercetools_discounts_get_discount_codes_by_id | Deprecated OAuth 2.0 Scope: view_orders:{projectKey} |
commercetools_discounts_get_discount_codes_by_key | Deprecated OAuth 2.0 Scope: view_orders:{projectKey} |
commercetools_discounts_get_discount_groups_by_id | Retrieves a DiscountGroup with the provided id. |
commercetools_discounts_get_discount_groups_by_key | Retrieves a DiscountGroup with the provided key. |
commercetools_discounts_get_product_discounts_by_id | GET /product-discounts/{ID} |
commercetools_discounts_get_product_discounts_by_key | GET /product-discounts/key={key} |
commercetools_discounts_get_standalone_prices_by_id | GET /standalone-prices/{ID} |
commercetools_discounts_get_standalone_prices_by_key | GET /standalone-prices/key={key} |
commercetools_discounts_list_cart_discounts | GET /cart-discounts |
commercetools_discounts_list_discount_codes | Deprecated OAuth 2.0 Scope: view_orders:{projectKey} |
commercetools_discounts_list_discount_groups | Retrieves all DiscountGroups in the Project. |
commercetools_discounts_list_product_discounts | GET /product-discounts |
commercetools_discounts_list_standalone_prices | GET /standalone-prices |
commercetools_discounts_update_cart_discounts_by_id | POST /cart-discounts/{ID} |
commercetools_discounts_update_cart_discounts_by_key | POST /cart-discounts/key={key} |
commercetools_discounts_update_discount_codes_by_id | Deprecated OAuth 2.0 Scope: manage_orders:{projectKey} |
commercetools_discounts_update_discount_codes_by_key | Deprecated OAuth 2.0 Scope: manage_orders:{projectKey} |
commercetools_discounts_update_discount_groups_by_id | Updates a DiscountGroup in the Project using one or more update actions. |
commercetools_discounts_update_discount_groups_by_key | Updates a DiscountGroup in the Project using one or more update actions. |
commercetools_discounts_update_product_discounts_by_id | POST /product-discounts/{ID} |
commercetools_discounts_update_product_discounts_by_key | POST /product-discounts/key={key} |
commercetools_discounts_update_standalone_prices_by_id | If a modification is already in progress for the exact combination of SKU and price scope fields, an ExactLockConflict or ValidityLockConflict error is returned. |
commercetools_discounts_update_standalone_prices_by_key | If a modification is already in progress for the exact combination of SKU and price scope fields, an ExactLockConflict or ValidityLockConflict error is returned. |
commercetools_discounts_create_cart_discounts
Creating a Cart Discount produces the CartDiscountCreated Message. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
cartPredicate | string | Yes | — | Cart Predicate |
custom | object | No | — | The custom value |
description | object | No | — | The description value |
discountGroup | object | No | — | Discount Group |
isActive | boolean | No | — | Is Active |
key | string | No | — | The key value |
name | object | Yes | — | The name value |
recurringOrderScope | object | No | — | Recurring Order Scope |
requiresDiscountCode | boolean | No | — | Requires Discount Code |
sortOrder | string | No | — | Sort Order |
stackingMode | string | No | — | Stacking Mode |
stores | any[] | No | — | The stores value |
target | object | No | — | The target value |
validFrom | string | No | — | Valid From |
validUntil | string | No | — | Valid Until |
value | object | Yes | — | The value value |
commercetools_discounts_create_discount_codes
Creating a Discount Code produces the DiscountCodeCreated Message. Deprecated OAuth 2.0 Scope:manage_orders:{projectKey}
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
cartDiscounts | any[] | Yes | — | Cart Discounts |
cartPredicate | string | No | — | Cart Predicate |
code | string | Yes | — | The code value |
custom | object | No | — | The custom value |
description | object | No | — | The description value |
groups | string[] | No | — | The groups value |
isActive | boolean | No | — | Is Active |
key | string | No | — | The key value |
maxApplications | integer | No | — | Max Applications |
maxApplicationsPerCustomer | integer | No | — | Max Applications Per Customer |
name | object | No | — | The name value |
validFrom | string | No | — | Valid From |
validUntil | string | No | — | Valid Until |
commercetools_discounts_create_discount_groups
Creates a DiscountGroup in the Project. This request generates the DiscountGroupCreated Message. If the limit for active Discount Groups has been reached, a MaxDiscountGroupsReached error is returned. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
description | object | No | — | The description value |
isActive | boolean | No | — | Is Active |
key | string | Yes | — | The key value |
name | object | No | — | The name value |
sortOrder | string | Yes | — | Sort Order |
commercetools_discounts_create_product_discounts
POST /product-discounts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
description | object | No | — | The description value |
isActive | boolean | Yes | — | Is Active |
key | string | No | — | The key value |
name | object | Yes | — | The name value |
predicate | string | Yes | — | The predicate value |
sortOrder | string | Yes | — | Sort Order |
validFrom | string | No | — | Valid From |
validUntil | string | No | — | Valid Until |
value | object | Yes | — | The value value |
commercetools_discounts_create_product_discounts_matching
This endpoint can be used to simulate which Product Discounts would be applied if a specified Product Variant had a specified Price. Given Product and Product Variant IDs and a Price, this endpoint will return the ProductDiscount that would have been applied to that Price. If a Product Discount could not be found that could be applied to the Price of a Product Variant, a NoMatchingProductDiscountFound error is returned. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
price | object | Yes | — | The price value |
productId | string | Yes | — | Product Id |
staged | boolean | Yes | — | The staged value |
variantId | integer | Yes | — | Variant Id |
commercetools_discounts_create_standalone_prices
Creating a Standalone Price produces the StandalonePriceCreated Message. - If the Standalone Price has the same price scope as an existing Standalone Price, a DuplicateStandalonePriceScope error is returned. - If the Standalone Price has overlapping validity periods within the same price scope, a OverlappingStandalonePriceValidity error is returned. A Price without validity period does not conflict with a Price defined for a time period. - If a modification is already in progress for the exact combination of SKU and price scope fields, an ExactLockConflict or ValidityLockConflict error is returned. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
active | boolean | No | — | The active value |
channel | object | No | — | The channel value |
country | string | No | — | The country value |
custom | object | No | — | The custom value |
customerGroup | object | No | — | Customer Group |
discounted | object | No | — | The discounted value |
key | string | No | — | The key value |
recurrencePolicy | object | No | — | Recurrence Policy |
sku | string | Yes | — | The sku value |
staged | object | No | — | The staged value |
tiers | object[] | No | — | The tiers value |
validFrom | string | No | — | Valid From |
validUntil | string | No | — | Valid Until |
value | object | Yes | — | The value value |
commercetools_discounts_delete_cart_discounts_by_id
Deleting a Cart Discount produces the CartDiscountDeleted Message. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_delete_cart_discounts_by_key
Deleting a Cart Discount produces the CartDiscountDeleted Message. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_delete_discount_codes_by_id
Deleting a Discount Code produces the DiscountCodeDeleted Message. Deprecated OAuth 2.0 Scope:manage_orders:{projectKey}
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
dataErasure | boolean | No | — | Data Erasure |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_delete_discount_codes_by_key
Deleting a Discount Code produces the DiscountCodeDeleted Message. Deprecated OAuth 2.0 Scope:manage_orders:{projectKey}
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
dataErasure | boolean | No | — | Data Erasure |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_delete_discount_groups_by_id
Deletes a DiscountGroup in the Project. This request generates the DiscountGroupDeleted Message. If the DiscountGroup is referenced by a CartDiscount, a ReferenceExists error is returned. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_delete_discount_groups_by_key
Deletes a DiscountGroup in the Project. This request generates the DiscountGroupDeleted Message. If the DiscountGroup is referenced by a CartDiscount, a ReferenceExists error is returned. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_delete_product_discounts_by_id
DELETE /product-discounts/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_delete_product_discounts_by_key
DELETE /product-discounts/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_delete_standalone_prices_by_id
Produces the StandalonePriceDeleted Message. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_delete_standalone_prices_by_key
Produces the StandalonePriceDeleted Message. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_get_cart_discounts_by_id
GET /cart-discounts/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_get_cart_discounts_by_key
GET /cart-discounts/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_get_discount_codes_by_id
Deprecated OAuth 2.0 Scope:view_orders:{projectKey}
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_get_discount_codes_by_key
Deprecated OAuth 2.0 Scope:view_orders:{projectKey}
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_get_discount_groups_by_id
Retrieves a DiscountGroup with the providedid.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_get_discount_groups_by_key
Retrieves a DiscountGroup with the providedkey.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_get_product_discounts_by_id
GET /product-discounts/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_get_product_discounts_by_key
GET /product-discounts/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_get_standalone_prices_by_id
GET /standalone-prices/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_get_standalone_prices_by_key
GET /standalone-prices/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_discounts_list_cart_discounts
GET /cart-discounts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_discounts_list_discount_codes
Deprecated OAuth 2.0 Scope:view_orders:{projectKey}
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_discounts_list_discount_groups
Retrieves all DiscountGroups in the Project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_discounts_list_product_discounts
GET /product-discounts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_discounts_list_standalone_prices
GET /standalone-prices Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_discounts_update_cart_discounts_by_id
POST /cart-discounts/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_discounts_update_cart_discounts_by_key
POST /cart-discounts/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_discounts_update_discount_codes_by_id
Deprecated OAuth 2.0 Scope:manage_orders:{projectKey}
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_discounts_update_discount_codes_by_key
Deprecated OAuth 2.0 Scope:manage_orders:{projectKey}
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_discounts_update_discount_groups_by_id
Updates a DiscountGroup in the Project using one or more update actions. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_discounts_update_discount_groups_by_key
Updates a DiscountGroup in the Project using one or more update actions. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_discounts_update_product_discounts_by_id
POST /product-discounts/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_discounts_update_product_discounts_by_key
POST /product-discounts/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_discounts_update_standalone_prices_by_id
If a modification is already in progress for the exact combination of SKU and price scope fields, an ExactLockConflict or ValidityLockConflict error is returned. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_discounts_update_standalone_prices_by_key
If a modification is already in progress for the exact combination of SKU and price scope fields, an ExactLockConflict or ValidityLockConflict error is returned. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |

