Sign in

v4

OpenAPI 3.0.02026-07-31811,0021.1 MB
Coupons

Retrieves the promotion rules and details associated with a specific coupon code.

This endpoint returns the promotion information linked to the provided coupon code, including type, value, requirements, and validity period.

How to use

Provide the desired coupon code in the URL. The response will contain the promotion details if available.

  • The type field indicates the type of discount (e.g., value, percentage, shipping).
  • The requirements field describes the conditions for using the coupon.
  • The value field contains the discount value.
  • The beginDate and endDate fields indicate the promotion's validity period.
  • The isActive and isCumulative fields indicate if the promotion is active and if it can be combined with others.
get/v1/pvt/Coupons/{couponCode}/rules

Path parameters

couponCodestring required

The coupon code to retrieve promotion rules for.

Response

Promotion details associated with the coupon.

ErrorMessagestring nullable

Error message returned when the request fails validation or processing. For warnings and successful responses, consumers should usually inspect Result, Code and Severity first.

ErrorCodeinteger nullable

Legacy numeric error code derived from internal API errors when available. This field is relevant only for error flows that use ApiResponseErrorDescription.

Codestring nullable

Endpoint-specific business code formatted as a two-digit string, such as 03 or 07. This field is available for success, warning and error outcomes.

CodeNamestring nullable

Symbolic enum name associated with Code, such as CheckoutNotFound.

Severity0 | 1 | 2

0 = Success 1 = Warning 2 = Error

HasWarningboolean

Convenience flag that is true when Severity is Warning. Warnings are valid 200 OK business outcomes and should not be handled as transport or validation errors.

HasErrorboolean

Indicates whether the request failed and should be handled as an error response. This flag is reserved for real API errors; warnings must keep this property as false.