Receipt

For detailed endpoint information, refer to the REST API documentation for Receipts.

The receipt is a sub-entity of the inboundProcess, which maps all processes for incoming goods at a store or warehouse. Creating a receipt automatically creates a corresponding inboundProcess.

Create a receipt

To create a receipt, execute a POST request to the following endpoint with the JSON body.

POST https://{YOUR-TENANT-NAME}.api.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"
}

A successful request returns a 201 CREATED response with a body similar to the following example:

{
    "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
}

Alternative methods

A receipt can also be managed through the inboundprocesses endpoint in one of two ways:

• Create a receipt and its inboundProcess simultaneously via POST /api/inboundprocesses.

• Add a receipt to an existing inboundProcess via PUT /api/inboundprocesses/{inboundProcessId}/receipts.