API Reference
Privacy policy

List customer-specific offers

post
https://api.staging.antavo.com/offers/

This API endpoint is used to submit the contents of a cart and receive any available offers on the products within.
The Offers API request body consists of 4 components:

  • cart: The intended purchase items, recorded in the same format as an Antavo checkout event.
  • customer: The Antavo ID of the customer.
  • store: The Antavo ID of the store. This may result in store-specific offers if configured.
  • eligible_only: Restricts the returned offers to those available to the customer.
Body Params
cart
object
required

Cart content to check against available offers.

string
required

An Antavo-recognized unique customer identifier. This is used to determine customer eligibility. Providing a valid attribute will result in the return of possible loyalty and non-loyalty offers.

string

An Antavo identifier of the store where the purchase is made. Used to determine if there are any applicable offers.

boolean
Defaults to true

Filters out non-eligible offers based on the current context (cart, customer, date, etc.)

Responses

Updated over 1 year ago

Did this page help you?
Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago

Did this page help you?