v1

latestOpenAPI 3.0.32026-07-13149852.3 MB
order

Order - Undershipped Item Report

Retrieve a report of items that were shipped in quantities less than ordered.

get/order/undershipped_item_report

Query parameters

startstring date required

Start date

Example:2024-01-01
endstring date required

End date

Example:2024-12-31
store_idsstring[]

Filter by store IDs

Response

Undershipped item report

order_numberstring

Order number

store_idstring

Store ID

order_idstring

Order ID

orderobject

Full order object

undershippedboolean

Whether the order is undershipped

has_unlinked_line_itemboolean

Whether the order has unlinked line items

Example response

[
  {
    "store_id": "507f1f77bcf86cd799439011"
  }
]