Openapi
Return outbound deliveries, inbound receipts, and returns, filtered by order or purchase order.
sb-auth-token<token>Supabase browser session cookie. Supabase may split larger session values into chunked cookies like sb-auth-token.0.
organizationId*stringuuiddirection?string"outbound""inbound""return"limit*integer1 <= value <= 10050offset*integer0 <= value <= 90071992547409910orderId?stringuuidpurchaseOrderId?stringuuidq?stringlength <= 200status?string"draft""packed""ready_for_pickup""in_transit""delivered""picked_up""exception""canceled"Returns shipments.
application/jsondata*array<>pagination*curl -X GET 'https://app.localhost/api/v1/organizations/123/shipments?direction=example&limit=1&offset=1&orderId=123e4567-e89b-12d3-a456-426614174000&purchaseOrderId=123e4567-e89b-12d3-a456-426614174000&q=example&status=example'{ "data": [ { "carrier": "string", "createdAt": "string", "deliveredAt": "string", "deliveryMethod": "pickup", "direction": "outbound", "formattedNumber": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "number": 0, "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5", "orderNumber": "string", "packageCount": 0, "partyName": "string", "purchaseOrderId": "84a099d9-2935-4997-a6ac-0d3ee9bbef72", "purchaseOrderNumber": "string", "shippedAt": "string", "status": "draft", "trackingNumber": "string", "trackingUrl": "string", "updatedAt": "string" } ], "pagination": { "hasMore": true, "limit": 1, "offset": 0, "total": 0, "totalIsEstimate": true }}