The external promotion object

A comprehensive list of the external promotion resource's attributes and relationships

An external promotion object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/external_promotions endpoint.

Fields

Field	Type	Description
type	string	external_promotions
id	string	The external promotion unique identifier
links.self	string	The external promotion endpoint URL
attributes.name	string	The promotion's internal name.
attributes.currency_code	string	The international 3-letter currency code as defined by the ISO 4217 standard.
attributes.exclusive	boolean	Indicates if the promotion will be applied exclusively, based on its priority score.
attributes.priority	integer	The priority assigned to the promotion (lower means higher priority).
attributes.starts_at	datetime	The activation date/time of this promotion.
attributes.expires_at	datetime	The expiration date/time of this promotion (must be after starts_at).
attributes.total_usage_limit	integer	The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.
attributes.total_usage_count	integer	The number of times this promotion has been applied.
attributes.active	boolean	Indicates if the promotion is active (enabled and not expired).
attributes.status	string	The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.
attributes._disable	boolean	Send this attribute if you want to mark this resource as disabled.
attributes._enable	boolean	Send this attribute if you want to mark this resource as enabled.
attributes.disabled_at	datetime	Time at which this resource was disabled.
attributes.created_at	datetime	Time at which the resource was created.
attributes.updated_at	datetime	Time at which the resource was last updated.
attributes.reference	string	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	string	Any identifier of the third party system that defines the reference code.
attributes.metadata	object	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.promotion_url	string	The URL to the service that will compute the discount.
attributes.circuit_state	string	The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.
attributes.circuit_failure_count	integer	The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback.
attributes._reset_circuit	boolean	Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.
attributes.shared_secret	string	The shared secret used to sign the external request payload.
relationships.market	object	The associated market.
relationships.promotion_rules	array	The associated promotion rules.
relationships.order_amount_promotion_rule	object	The associated order amount promotion rule.
relationships.sku_list_promotion_rule	object	The associated SKU list promotion rule.
relationships.coupon_codes_promotion_rule	object	The associated coupon codes promotion rule.
relationships.custom_promotion_rule	object	The associated custom promotion rule.
relationships.sku_list	object	The associated SKU list.
relationships.coupons	array	The associated coupons through coupon codes promotion rule.
relationships.attachments	array	The associated attachments.
relationships.events	array	The associated events.
relationships.tags	array	The associated tags. Cannot be passed by sales channels.
relationships.versions	array	The associated changes.
relationships.skus	array	The associated SKUs.
meta.mode	string	The resource environment (can be one of test or live)