Receipt

More receipt API information can be found here: REST API documentation - Receipts

Create a receipt

The receipt is a sub-entity of the inboundProcess which maps all processes around incoming goods in a store or warehouse. Whenever a receipt is created, a corresponding inboundProcess is automatically created.

Create a receipt by executing the following POST call with the JSON body:

POST https://{YOUR-TENANT-NAME}.fulfillmenttools.com/api/receipts
{
  "facilityRef": "CGN-01",
  "comments": [],
  "receivedDate": "2025-03-16T14:15:39.683Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "value": 100
      },
      "comments": [],
      "rejectedQuantity": {
        "value": 0
      },
      "storageLocationRef": "2f45a441-6247-4b7d-babe-83fca0ff4bf7",
      "tenantArticleId": "22222"
    }
  ],
  "status": "OPEN"
}

If the request is successful, we receive a 201 CREATED response with a body like this:

{
    "comments": [],
    "receivedDate": "2025-03-16T14:15:39.683Z",
    "receivedItems": [
        {
            "acceptedQuantity": {
                "value": 100
            },
            "comments": [],
            "rejectedQuantity": {
                "value": 0
            },
            "storageLocationRef": "Inbound-01",
            "tenantArticleId": "22222",
            "stockProperties": {}
        }
    ],
    "status": "OPEN",
    "id": "6e963526-09af-45f1-9ac7-add78e3e2607",
    "inboundProcessRef": "7060a93e-e0d5-4dd4-8478-50acbd07189b",
    "created": "2025-03-12T16:16:28.543Z",
    "lastModified": "2025-03-12T16:16:28.543Z",
    "version": 1
}

Alternatively, a receipt can be created simultaneously when creating the respective inboundProcess via POST https://{YOUR-TENANT-NAME}.fulfillmenttools.com/api/inboundprocesses or can be added to an existing inboundProcess via PUT https://{YOUR-TENANT-NAME}.fulfillmenttools.com/api/inboundprocesses/{inboundProcessId}/receipts.

Last updated