The free shipping promotion object
A comprehensive list of the free shipping promotion resource's attributes and relationships
A free shipping promotion object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/free_shipping_promotions
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The free shipping promotion unique identifier |
links.self |
| The free shipping promotion endpoint URL |
attributes.name |
| The promotion's internal name. |
attributes.currency_code |
| The international 3-letter currency code as defined by the ISO 4217 standard. |
attributes.exclusive |
| Indicates if the promotion will be applied exclusively, based on its priority score. |
attributes.priority |
| The priority assigned to the promotion (lower means higher priority). |
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. When 'null' it means promotion can be applied infinite times. |
attributes.total_usage_count |
| The number of times this promotion has been applied. |
attributes.active |
| Indicates if the promotion is active (enabled and not expired). |
attributes.status |
| The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'. |
attributes._disable |
| Send this attribute if you want to mark this resource as disabled. |
attributes._enable |
| Send this attribute if you want to mark this resource as enabled. |
attributes.disabled_at |
| Time at which this resource was disabled. |
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. |
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.custom_promotion_rule |
| The associated custom promotion rule. |
relationships.sku_list |
| The associated SKU list. |
relationships.coupons |
| The associated coupons through coupon codes promotion rule. |
relationships.attachments |
| The associated attachments. |
relationships.events |
| The associated events. |
relationships.tags |
| The associated tags. Cannot be passed by sales channels. |
relationships.versions |
| The associated changes. |
meta.mode |
| The resource environment (can be one of |
Last updated