EndpointsOrdersOrdersOrderid
Retrieve one shared order with all lines
The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.
GET
bearerAuthheader
AuthorizationBearer <inv_ token>orderId*stringFormat
uuidX-Organization-ID?stringOrganization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.
Format
uuidOrder
application/json- response
order*curl -X GET 'https://inventory.example.com/api/v1/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
{ "order": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "purchase", "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d", "contactName": "string", "reference": "string", "status": "draft", "orderedAt": "2019-08-24T14:15:22Z", "expectedAt": "2019-08-24T14:15:22Z", "note": "string", "lines": [ { "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6", "quantity": 1, "expectedAt": "2019-08-24T14:15:22Z", "note": "string", "unitPriceCents": 0, "priceCurrency": "str", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5", "resourceName": "string", "resourceSku": "string", "fulfilledQuantity": 0, "returnedQuantity": 0, "openQuantity": 0, "reservedQuantity": 0, "openReservationQuantity": 0, "openReturnQuantity": 0, "totalPriceCents": 0, "trackingMode": "bulk", "unitName": "string", "units": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "stockUnitId": "3cafe366-b9d7-41dd-af7d-7a8bbda07cad", "code": "string", "status": "reserved", "stockStatus": "available", "reservedAt": "2019-08-24T14:15:22Z", "fulfilledAt": "2019-08-24T14:15:22Z", "returnedAt": "2019-08-24T14:15:22Z" } ] } ], "shipments": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5", "carrierCode": "string", "service": "string", "trackingNumber": "string", "trackingUrl": "http://example.com", "status": "draft", "shippedAt": "2019-08-24T14:15:22Z", "deliveredAt": "2019-08-24T14:15:22Z", "note": "string", "createdBy": "string", "updatedBy": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "lines": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "orderLineId": "3bba51e3-a0c1-4b14-a700-b2d3b8ed156d", "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6", "resourceName": "string", "quantity": 1, "units": [ { "orderLineUnitId": "ea2f710c-94e4-4b93-b1a8-ec335095a12f", "stockUnitId": "3cafe366-b9d7-41dd-af7d-7a8bbda07cad", "code": "string" } ] } ], "events": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "fromStatus": "draft", "toStatus": "draft", "note": "string", "actor": "string", "occurredAt": "2019-08-24T14:15:22Z" } ], "totalQuantity": 1 } ], "totalQuantity": 0, "totalFulfilled": 0, "totalReturned": 0, "totalReserved": 0 }}