PromotionListResponse
Type: object.
| Name | Type | Description |
|---|---|---|
evaluatedAt required | PromotionClock | |
generatedAt required | string (date-time) | When the store agent read the data from the POS. |
nextCursor required | string | Pass as cursor to read the next page; empty on the last page. |
promotions required | array of Promotion | One page: first the deals kept on products (by product code, then sale, package, package sale, case sale, mix and match), then the scheduled prices (by scope, code, price field). Inactive and not-for-sale products are never listed. At most 200 items. |
requestId required | string | |
source required | string | Always live: read from the store at request time. One of: live. |
billing | BillingMeta | |
discountsOnByDefault | boolean | The store's registers give deal prices on every ticket unless a cashier turns discounts off (true), or only on tickets where a cashier turns them on (false). Absent when the store's registers are not all set the same way. |
Other fields can appear later. Ignore the ones you do not know.
Used by
- GET
/v1/promotions