Purchase Order Receives

Frequency:

Purchase order receive data can be requested at any time. status shows the progress of the receive process, and the receives that are already registered are returned while receiving is still in progress.

Expected data:

Returns receive data for a given Purchase Order (PO).

Technical:

A purchase order line that is received in several parts, for example with different shelf lives or excise stamp ranges, is returned as several lines. The first keeps the original purchase_order_line_number; the others get generated line numbers above the highest line number of the document and reference the original line in source_purchase_order_line_number.

Empties and country of origin are reported the same way, as additional lines with generated line numbers.

---

GET https://{url}/v1/orders/purchase/{purchaseOrderExternalId}/receives

Retrieve receive data for a purchase order.

Response Body

The response contains purchase order header fields and a receives array. Each receive contains a details array with the received line items.

Top-level response fields:

Name	Type	Required	Description
success	boolean	Yes	Whether the operation succeeded
message	string	No	Error message, if applicable
purchase_order_id	string	Yes	PO unique identifier in ERP
status	integer	Yes	PO reception status: 1 - Not started, 2 - In progress, 3 - Completed
received_date	string	No	Date when PO receiving is completed (in format '2025-04-15T12:51:34'). Empty until the purchase order is completed (status 3)
receives	array	Yes	Array of receive document objects

Receive object (inside receives array):

Name	Type	Required	Description
receive_document_id	string	Yes	Receive document unique identifier in WMS
receive_date	string	Yes	Receive document date (in format '2025-04-15T12:51:34')
details	array	Yes	Array of detail line objects for the receive document

Detail object (inside details array):

Name	Type	Required	Description
purchase_order_line_number	integer	Yes	PO detail line number
source_purchase_order_line_number	integer	Conditional	Source PO detail line number. Set on country-of-origin lines and on lines that split an original PO line. Empties are reported as separate lines without a source reference.
article_id	string	Conditional	Article unique identifier in ERP. Not present on country-of-origin lines.
quantity	number	Yes	Received quantity
quantity_unit_id	string	Yes	Received quantity unit of measure
shelf_life	string	No	Received shelf life (in format '2025-04-15T12:51:34')
excise	object	Conditional	Excise stamp data object (contains serial, range_from, range_to). Present for tobacco or alcohol articles.
local_excise	string	No	Local excise stamp information
country_of_origin	string	No	Country of origin from received stock

Response

200: OK — Success

{
    "success": true,
    "message": null,
    "purchase_order_id": "3000437294",
    "status": 2,
    "received_date": "2025-04-15T12:51:34",
    "receives": [
        {
            "receive_document_id": "WMS191083",
            "receive_date": "2025-04-15T12:51:34",
            "details": [
                {
                    "purchase_order_line_number": 1000,
                    "article_id": "0001",
                    "quantity": 12,
                    "quantity_unit_id": "PCS",
                    "shelf_life": "2025-04-15T12:51:34"
                },
                {
                    "purchase_order_line_number": 1100,
                    "source_purchase_order_line_number": 1000,
                    "country_of_origin": "FR",
                    "quantity": 12,
                    "quantity_unit_id": "PCS"
                },
                {
                    "purchase_order_line_number": 2000,
                    "article_id": "0001",
                    "quantity": 36,
                    "quantity_unit_id": "PCS",
                    "shelf_life": "2025-04-18T00:00:00"
                }
            ]
        },
        {
            "receive_document_id": "WMS191393",
            "receive_date": "2025-04-15T12:51:34",
            "details": [
                {
                    "purchase_order_line_number": 100,
                    "article_id": "0001",
                    "quantity": 24,
                    "quantity_unit_id": "PCS",
                    "shelf_life": "2025-04-15T12:51:34"
                },
                {
                    "purchase_order_line_number": 200,
                    "article_id": "0047",
                    "quantity": 144,
                    "quantity_unit_id": "PCS",
                    "shelf_life": "2025-05-02T00:00:00",
                    "excise": {
                        "serial": "KF",
                        "range_from": 493000,
                        "range_to": 654000
                    }
                }
            ]
        }
    ]
}

400: Bad Request — Error

{
    "success": false,
    "message": "Purchase Order not found by ID 3000437294"
}