Links

The custom promotion rule object

A comprehensive list of the custom promotion rule resource's attributes and relationships
A custom promotion rule object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/custom_promotion_rules endpoint.

Fields

Field
Type
Description
type
string
custom_promotion_rules
id
string
The custom promotion rule unique identifier
links.self
string
The custom promotion rule endpoint URL
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.filters
object
The filters used to trigger promotion on the matching order and its relationships attributes.
relationships.promotion
object
The associated promotion.
relationships.versions
array
The associated changes.
meta.mode
string
The resource environment (can be one of test or live)