API Reference

Summarizes items sold across orders, including quantities and totals.

Log in to see full request history

Sold Items Details API

The Sold Items Details API provides detailed information about items sold across orders. It tracks item names, types, quantities, and subtotal amounts, offering insights into product performance and customer preferences. This API is invaluable for inventory management and sales trend analysis.

Example Response

After a successful call, the API will return a response similar to the below structure.

[ { "date_picker": "2024-11-07", "location_id": 235216, "order_source": "Ordering Source Name", "item_name": "Large Natural-Cut Fries", "item_type": "modifier_item", "quantity": 5, "subtotal": "0.0", "external_store_id": null } ]

Field Descriptions

Field NameDescription
created_dateThe date when the item was added to the menu.
location_idIdentifier for the restaurant location where the items were sold.
order_sourceName of the platform or source where the order originated.
item_nameName of the sold item.
item_typeType of the item (e.g., modifier_item).
quantityTotal quantity of the item sold.
subtotalSubtotal amount for the sold item, excluding taxes.
external_store_idIdentifier for the external store, if applicable.

This API enables comprehensive tracking of sales data, aiding businesses in understanding which products are performing well and adjusting inventory and marketing strategies accordingly.

Query Params
string
required
Defaults to 2729

External store identifier IDs should be separated by commas (e.g., 2729, 2739), with a maximum of 200 IDs

string
required
Defaults to 2024-11-06 00:00:00

Start Date time for the range of 24 hours

string
required
Defaults to 2024-11-07 00:00:00

End Date time for the range of 24 hours

Headers
string
required
Defaults to 6dcbf7cc-92a8-497f-8319-45c45202334c78a1

Brand token

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json