Receipts

For detailed endpoint specifications, refer to the Receipts section in the REST API Reference.

Create a receipt

A receipt is a document that confirms goods have been received at a facility. It is created by sending a POST request to one of the receipt endpoints.

There are two primary ways to create a receipt:

• Create a new receipt and a corresponding inbound process.

  POST https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/receipts

• Create a receipt for a pre-existing inbound process.

  POST https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/inboundprocesses/{inboundProcessId}/receipts

Example payload

The request body must contain the details of the received goods. The facilityRef specifies the location, and the receivedItems array lists each item, including its tenantArticleId, acceptedQuantity, and any relevant stockProperties like a batch number.

{
    "facilityRef": "{YOUR_FACILITY_ID}",
    "receivedDate": "2023-06-16T07:44:14.944Z",
    "receivedItems": [
        {
            "tenantArticleId": "apples-01",
            "acceptedQuantity": {
                "value": 1,
                "unit": "kg"
            },
            "rejectedQuantity": {
                "value": 0,
                "unit": "kg"
            },
            "comments": [],
            "stockProperties": {
                "batch": "2023-08-14-a"
            }
        },
        {
            "tenantArticleId": "oranges-01",
            "acceptedQuantity": {
                "value": 16
            },
            "rejectedQuantity": {
                "value": 0
            },
            "comments": [],
            "stockProperties": {
                "batch": "123-abc"
            }
        }
    ],
    "comments": []
}