A percentage discount promotion object is returned as part of the response body of each successful create, list, retrieve, or update API call.
Field | Type | Description |
type |
|
|
id |
| The percentage discount promotion unique identifier |
links.self |
| The percentage discount promotion endpoint URL |
attributes.name |
| The promotion's internal name. |
attributes.starts_at |
| The activation date/time of this promotion. |
attributes.expires_at |
| The expiration date/time of this promotion (must be after starts_at). |
attributes.total_usage_limit |
| The total number of times this promotion can be applied. |
attributes.total_usage_count |
| The number of times this promotion has been applied. |
attributes.active |
| Indicates if the promotion is active. |
attributes.created_at |
| Time at which the resource was created. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.reference |
| A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
attributes.reference_origin |
| Any identifier of the third party system that defines the reference code |
attributes.metadata |
| Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. |
attributes.percentage |
| The discount percentage to be applied. |
relationships.market |
| The associated market. |
relationships.promotion_rules |
| The associated promotion rules. |
relationships.order_amount_promotion_rule |
| The associated order amount promotion rule. |
relationships.sku_list_promotion_rule |
| The associated sku list promotion rule. |
relationships.coupon_codes_promotion_rule |
| The associated coupon codes promotion rule. |
relationships.sku_list |
| The associated sku list. |
relationships.skus |
| The associated skus. |
meta.mode |
| The resource environment (can be one of |