One permission, two calls. Page the permission list (GET /permissionlist) for the itemCode values this API key may query, then page sale records (GET /salerecords) for one code in a date range.
Permission list — items this API key may query for sale records.
Page this list, pick an itemCode, then call sale records (GET /salerecords) with that code.
A key whose permission list is empty gets 403. total is present on the first page only.
query Parameters
takePage size (1–100). Default 20.
cursorOpaque token from the previous page. Omit on the first page.
Headers
x-api-keyThe x-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Permission list — items this API key may query for sale records. › Responses
OK
Gets the array of results.
hasMoreGets a value indicating whether there are more results available.
cursorOpaque pagination cursor from the previous page. Omit on the first request.
totalGets or sets the total number of results available. Only included on the first page (when no cursor is provided).
Sale records — invoice lines for one item code in a date range.
Use an itemCode from the permission list (GET /permissionlist).
The date window is inclusive, at most 31 days, and cannot be in the future.
itemDiscount is the per-unit markdown on this line.
allocatedSaleDiscount is this line's share of the sale-level discount, per unit — not the ticket total.
There is no total on this route. Reuse cursor with the same item code and dates.
query Parameters
itemCodeItem code from the permission list (primary UPC/SKU or an alias of that item).
startDateInclusive start of the date window. Required. Not in the future.
endDateInclusive end of the date window. Required. On or after startDate; at most 31 days; not in the future.
takePage size (1–100). Default 20.
cursorOpaque token from the previous page. Omit on the first page.
Headers
x-api-keyThe x-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Sale records — invoice lines for one item code in a date range. › Responses
OK
Gets the array of results.
hasMoreGets a value indicating whether there are more results available.
cursorOpaque pagination cursor from the previous page. Omit on the first request.
totalGets or sets the total number of results available. Only included on the first page (when no cursor is provided).