Get applicable promotions

Get a list of automatic promotions that can be applied to a customer's order.

This operation will return a list of active automatic promotions whose qualification rules are met by a customer's order.

Only the first 10 active automatic promotions in the order of priority will be checked and those that can be applied are returned. Note only automatic promotions are evaluated and returned - coupon promotions are excluded.

Body Params
order
object

A representation of a customer order

customer
object
string | null

This parameter could be based on your different e-commerce applications, brands, regions or a combination of both. Important for segmenting your promotions and accounts or enforcing qualification rules.

string | null

An identifier for the customer journey for linking a customer's checkout session to the promotion engine events. This is also required for preventing a unique code from being used in multiple simultaneous checkout sessions. See more on Validation Locking.

You can use your own value, such as the checkout session identifier, for this parameter or let let Uniqodo generate one for you. If this parameter is not present in the request then a new one will be generated and returned in the response. You should store the journey ID value (typically with the customer's checkout session) and pass it back with subsequent requests until the checkout session ends.

string

A two-letter ISO 639-1 language code. This is required for error message translations. See https://iso639-3.sil.org/code_tables/639/data?title=&field_iso639_cd_st_mmbrshp_639_1_tid=255291.

metadata
object

This field allows storing any related metadata. The keys of the object can be strings and the values can be any type.

Responses

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json