PRproject44
Order Visibility

Retrieve an order by project44 id.

Use the id returned from createOrder to retrieve the InventoryOrder.

get/api/v4/inventory/orders/{id}

Request

Path parameters

idstring required

The project44-generated id of the order you wish to query.

Response

OK

createdDatestring

The date that order created in project44 system. (format: yyyy-MM-dd, example: 2025-01-01).

deletedDateTimestring

The date that the order is deleted. (format: yyyy-MM-dd'T'HH:mm:ssZ, example: 2019-11-14T12:30:00-0500).

idstring

Unique identifier to retrieve exactly one order. This identifier should be treated as an opaque string and should be used to associate the InventoryOrder to other orders and items.

launchDateTimestring

The date when a particular launch related to the overall order is expected. (format: yyyy-MM-dd'T'HH:mm:ssZ, example: 2019-11-14T12:30:00-0500).

orderIdentifierstring

Customer provided identifier. Always required.

orderIdentifierAuthoritystring

Optional customer provided field. The authority is the party responsible for managing creation of the order identifier.

orderSubmissionDateTimestring

The date that the order is submitted. (format: yyyy-MM-dd'T'HH:mm:ssZ, example: 2019-11-14T12:30:00-0500).

orderType'PURCHASE_ORDER' | 'SALES_ORDER' | 'WAREHOUSE_MOVEMENT_ORDER' | 'ADVANCED_SHIPMENT_NOTICE' | 'INVOICE' | 'DELIVERY' | 'STOCK_TRANSFER_ORDER'

The type of the InventoryOrder. Required if relying on order identifier to be unique.

relatedOrderIdsstring[]

Additional orders that can be related to this order. These ids must bethe project44-generated id from another order in the system.

shipmentIdsstring[]

Project44-generated Ids of the associated shipments for the order. This field is deprecated. Shipment Loads should be used to link an order to shipments.

statusCode'SUBMITTED' | 'RECEIVED' | 'PROCESSING' | 'ACCEPTED' | 'FULFILLED' | 'REJECTED' | 'CANCELED'

The stage of the order lifecycle that it is currently in

statusCodeDateTimestring

The date at which the status was generated or changed. This will bedefaulted to null unless provided. (format: yyyy-MM-dd'T'HH:mm:ssZ, example: 2019-11-14T12:30:00-0500).

subjectstring

Descriptive name for a particular order such as 'Holiday Candles'

Changes

No recorded changes to this operation across all 1 revision of this API.