v1

latestOpenAPI 3.0.32026-07-13149852.3 MB

shipments

Shipments - Get

Retrieve shipments for a specific order.

get/shipments/get

selectorobject required

Query selector object for filtering results

limitnumber

Max results to return

Example:50

skipnumber

Number of results to skip

sortobject

Sort fields object, e.g. { "name": 1 }

Array of shipments matching the query (flattened from orders)

_idstring

Shipment ID

user_idstring

User who created the shipment

timestring

Shipment creation time

voidedboolean

Whether the shipment is voided

return_labelboolean

Whether this is a return label

deductedboolean

Whether inventory was deducted

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "user_id": "507f1f77bcf86cd799439011",
    "time": "2025-01-15T12:00:00.000Z"
  }
]