API Reference

Identifies errors associated with individual items in orders.

Log in to see full request history

Item-Level Errors API

The Item-Level Errors API identifies and provides details about errors associated with individual items in orders. This API is crucial for monitoring and addressing product-level issues that may impact order fulfillment, customer satisfaction, or operational efficiency.

Example Response

[ { "location_id": 232586, "ordering_source": "Ordering Source Name", "order_number": "f48d224e", "item_name": "Item Name", "quantity": 1.0, "subtotal": 8.75, "item_order_date": "2024-06-30", "error_datetime": null, "error_category": null, "created_at": "2024-06-30T00:00:00.000Z", "external_store_id": null } ]

Field Descriptions

Field NameDescription
location_idIdentifier for the location where the error occurred.
ordering_sourceName of the platform or source where the order was placed.
order_numberUnique identifier for the order containing the item.
item_nameName of the item associated with the error.
quantityQuantity of the item in the order.
subtotalTotal cost of the item, based on unit price and quantity.
item_order_dateDate when the item was ordered.
error_datetimeTimestamp when the error occurred (if applicable).
error_categoryDescription of the error category (if applicable).
created_atTimestamp when the record was created.
external_store_idIdentifier for the external store associated with the item.

This API facilitates detailed error tracking at the item level, enabling businesses to quickly address and rectify issues to maintain high levels of customer satisfaction and operational efficiency.

Query Params
array of int32s
required
Defaults to 1012,860

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

location_ids*
string
required
Defaults to 2024-06-30 00:00:00

Start Date time for the range of 24 hours

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

End Date time for the range of 24 hours

Headers
string
required
Defaults to b7e9f1ca-62c9-4a44-9d2d-2185e03b0895

Brand token

Responses

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