Apply discounts to a sale object

This will find the best possible promotion to a sale, apply it and return the sale and the discount.

  • Despite its POST method, this endpoint does not modify any server-side state.
  • It is the caller's responsibility to pass along the full details of the sale, including all customer information and product information (product type, tags, etc.).

🔒 Requires: promotions:read outlets:read scopes

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The channel where the sale is coming from

customer
object
required
boolean

Indication whether the sale is tax inclusive or tax exclusive

string
required

The outlet ID for this sale

string

The promo code to apply to this sale

sale
object
required
Response

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