Get a promotion
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/promotions/1?status=DRAFT&mode=DISCOUNT_CODE&type=PRODUCT_DISCOUNT&code=SALE20&search=summer&start_at_from=2024-01-01T00%3A00%3A00Z&start_at_to=2024-12-31T23%3A59%3A59Z&end_at_from=2024-01-01T00%3A00%3A00Z&end_at_to=2024-12-31T23%3A59%3A59Z';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://apibase.ecomweb.app/api/v1/stores/example/promotions/1?status=DRAFT&mode=DISCOUNT_CODE&type=PRODUCT_DISCOUNT&code=SALE20&search=summer&start_at_from=2024-01-01T00%3A00%3A00Z&start_at_to=2024-12-31T23%3A59%3A59Z&end_at_from=2024-01-01T00%3A00%3A00Z&end_at_to=2024-12-31T23%3A59%3A59Z' \ --header 'x-api-key: <x-api-key>'Returns one promotion by ID. The optional status, mode, type and code query parameters must also match, otherwise the promotion counts as not found.
Required scopes: read:promotions
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The promotion ID.
The store’s ref, as returned by GET /stores.
Query Parameters
Section titled “Query Parameters”Promotion status: DRAFT, ACTIVE, EXPIRED or DISABLED.
Filter by mode.
What the promotion does: PRODUCT_DISCOUNT, CART_DISCOUNT, FREE_SHIPPING, FIXED_PRICE or GIFT.
Example
SALE20Filter by exact discount code.
Example
summerSearch promotion names and descriptions.
Example
2024-01-01T00:00:00ZOnly promotions that start on or after this ISO 8601 timestamp.
Example
2024-12-31T23:59:59ZOnly promotions that start on or before this ISO 8601 timestamp.
Example
2024-01-01T00:00:00ZOnly promotions that end on or after this ISO 8601 timestamp. Promotions without an end date are always included.
Example
2024-12-31T23:59:59ZOnly promotions that end on or before this ISO 8601 timestamp. Promotions without an end date are always included.
Responses
Section titled “Responses”object
DISCOUNT_CODE when shoppers enter a code, AUTOMATIC when it applies on its own.
The discount code, stored upper-case. Null for an automatic promotion.
Description, or null.
When the promotion ends, as an ISO 8601 timestamp. Null when it has no end date.
DRAFT, ACTIVE, EXPIRED or DISABLED. A new promotion is ACTIVE.
What the promotion does: PRODUCT_DISCOUNT, CART_DISCOUNT, FREE_SHIPPING, FIXED_PRICE or GIFT.
What target_ids refers to: PRODUCT, VARIANT or NONE.
IDs of the products or variants the promotion applies to, as strings. Empty when condition_type is NONE.
Minimum order amount the promotion needs. Null when there is none.
Minimum number of items the promotion needs. Null when there is none.
PERCENTAGE or FIXED_AMOUNT. Null for promotions without a discount value.
The discount: a percentage or an amount, depending on discount_method. Null when not set.
Cap on the discount for a percentage promotion. Null when there is none.
Fixed price for a FIXED_PRICE promotion. Null for other types.
IDs of the gift products, as strings. Empty unless the type is GIFT.
Quantity of gift given. Null for other types.
Total number of times the promotion can be used. Null means unlimited.
Number of times one customer can use the promotion. Null means unlimited.
Whether the promotion is suggested to shoppers at checkout.
When the promotion was deleted. Always null on promotions you can read.
ID of the user who created the promotion, or null.
ID of the user who last updated the promotion, or null.
Promotion ID.
Promotion name.
When the promotion starts, as an ISO 8601 timestamp.
When the promotion was created, as an ISO 8601 timestamp.
When the promotion was last updated, as an ISO 8601 timestamp.
Example
{ "mode": "DISCOUNT_CODE", "status": "DRAFT", "type": "PRODUCT_DISCOUNT", "condition_type": "PRODUCT", "discount_method": "PERCENTAGE"}The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The resource does not exist in this store.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}