v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Promotions

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

post/discount

Request body

channelstring required

The channel where the sale is coming from

is_tax_inclusiveboolean

Indication whether the sale is tax inclusive or tax exclusive

outlet_idstring required

The outlet ID for this sale

promo_codestring

The promo code to apply to this sale

Response