List Sales Order Shipments

GET /accounting/sales-order-shipments

Group: Accounting › Sales Order Shipments · Operation ID: listSalesOrderShipments

Returns a list of sales order shipments. To match on carrier, tracking id, shipment number, incoterm or the shipping contact email, or by several statuses at once, use POST accounting/sales-order-shipments/search.

This endpoint takes only filters that are safe in a URL: ids, the status value and the date bounds. To match on carrier, tracking id, shipment number, incoterm or the shipping contact email, to filter by several statuses at once, or to filter by the customer's requested date or a shipped sales order product item, use POST accounting/sales-order-shipments/search.

The date and instant bounds are inclusive, so a row exactly on a boundary is returned again. Deduplicate on id when you page an incremental sync with modifiedFrom.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
salesOrderId query string no Limits results to shipments that fulfill this sales order. See id on GET accounting/sales-orders/:id.
inventoryShipmentId query number no Limits results to the shipment mirroring this inventory shipment, given as its numeric inventory shipment id. At most one shipment matches.
warehouseId query string no Limits results to shipments dispatched from this warehouse location. See id on GET inventory/warehouses/:id.
status query string no Limits results to shipments in this state. Accepted values: 'pendingShipment', 'shipped', 'cancelled'. Any other value matches no shipment. Use search to match several states at once.
shipDateFrom query string no Limits results to shipments dispatched on or after this date, inclusive. Format YYYY-MM-DD. Shipments with no ship date are excluded once this bound is given.
shipDateTo query string no Limits results to shipments dispatched on or before this date, inclusive. Format YYYY-MM-DD.
deliveryDateFrom query string no Limits results to shipments delivered, or expected to be delivered, on or after this date, inclusive. Format YYYY-MM-DD.
deliveryDateTo query string no Limits results to shipments delivered, or expected to be delivered, on or before this date, inclusive. Format YYYY-MM-DD.
modifiedFrom query string no Limits results to shipments changed at or after this time, inclusive. Format YYYY-MM-DDTHH:mm:ss.sssZ in UTC.
modifiedTo query string no Limits results to shipments changed at or before this time, inclusive. Format YYYY-MM-DDTHH:mm:ss.sssZ in UTC.
cursor query string no The cursor from the previous response's pagination.nextCursor. Omit for the first page.
pageSize query number no The number of shipments per page. Defaults to 50. A value above 200 is treated as 200, not rejected.

Response

200 Success

Under data (listSalesOrderShipmentsOutput):

Field Type Required Description
items array of object yes The shipments on this page, ordered by ship date with the most recent first. An empty array when nothing matches.
items[].id string yes The unique identifier for the sales order shipment.
items[].salesOrderId string yes The sales order this shipment fulfills. See id on GET accounting/sales-orders/:id.
items[].inventoryShipmentId number no The numeric identifier of the shipment document in inventory, which owns the shipment. Absent only on legacy rows written before the mirroring existed.
items[].shipmentNumber string no The shipment document number, assigned by inventory. Absent until inventory has issued one.
items[].status string no The lifecycle status of the shipment. Possible values: 'pendingShipment', 'shipped', 'cancelled'. 'pendingShipment' is drafted in inventory but not yet dispatched, 'shipped' is dispatched, and 'cancelled' means the inventory shipment was deleted and this mirror was soft-cancelled.
items[].trackingId string no The carrier tracking number or tracking URL, when one has been recorded.
items[].carrier string no The name of the carrier handling the shipment.
items[].incoterm string no The incoterm governing shipping responsibility for this shipment. For example 'DAP' or 'EXW'.
items[].warehouseId string no The warehouse location the shipment is dispatched from. See id on GET inventory/warehouses/:id.
items[].shipToContactEmail string no The email of the contact who receives this shipment.
items[].customerRequestDate string (date) no The date the customer asked for delivery. Format YYYY-MM-DD.
items[].shipDate string (date) no The date the shipment was dispatched. Format YYYY-MM-DD. Absent while the shipment is still pending.
items[].deliveryDate string (date) no The date the shipment was, or is expected to be, delivered. Format YYYY-MM-DD.
items[].lastModifiedDate string (date-time) yes The date and time the shipment last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
items[].items array of object yes The shipped lines, oldest first. An empty array when the shipment has no lines.
items[].items[].id string yes The unique identifier for the shipment line. PATCH matches updateItems and deleteItems on it.
items[].items[].salesOrderProductItemId string yes The sales order product item this line ships. There is no endpoint for it.
items[].items[].shippedQty string (decimal) yes The quantity shipped on this line, as a count of units.
items[].items[].orderedQty string (decimal) yes The total quantity ordered for the underlying sales order product item, as a count of units.
items[].items[].unshippedQty string (decimal) yes The quantity still outstanding on this line, as a count of units: orderedQty minus shippedQty.
pagination object yes The pagination cursor for this page.
pagination.nextCursor string no The cursor for the next page. Pass it as the cursor query parameter. Absent on the last page.
pagination.hasMore boolean yes True when more shipments remain beyond this page.

Errors

Code Status
INVALID_FILTER 400

Statuses