Search…
API Reference
Resources
Order amount promotion rules
The order amount promotion rule object and its fields
Commerce Layer provides a promotional engine built on top of two main resources: promotions and promotion rules. Order amount promotions rules are used to trigger the associated promotion only when the amount of an order is over the specified one. Any other promotions already applied to the order are considered in the comparison.

The order amount promotion rule object

An order amount promotion rule object is returned as part of the response body of each successful list, retrieve, create or update API call.
Field
Type
Description
type
string
order_amount_promotion_rules
id
string
The order amount promotion rule unique identifier
links.self
string
The order amount 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.order_amount_cents
integer
Apply the promotion only when order is over this amount, in cents.
attributes.order_amount_float
float
Apply the promotion only when order is over this amount, float.
attributes.formatted_order_amount
string
Apply the promotion only when order is over this amount, formatted.
relationships.promotion
object
The associated promotion.
meta.mode
string
The resource environment (can be one of test or live)
Last modified 1mo ago