Inbound process

For a complete reference of inbound process endpoints, see the API documentation.

Create an inbound process

An inboundProcess represents the procedures for incoming goods at a facility, such as a store or warehouse. It contains the sub-entities purchaseOrder and receipt. These sub-entities can be created and modified as part of the inboundProcess or through their own dedicated endpoints. The system automatically creates a corresponding inboundProcess whenever a purchaseOrder or receipt is created.

To create an inboundProcess, execute the following POST request with a JSON body:

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

{
  "facilityRef": "CGN-01",
  "scannableCodes": ["12345"],
  "tenantInboundProcessId": "AB-01"
}

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

{
    "created": "2025-03-12T14:15:39.683Z",
    "facilityRef": "CGN-01",
    "id": "d9f76e9f-6105-4286-b054-1bfbf8eebe77",
    "lastModified": "2025-03-12T14:15:39.683Z",
    "receipts": [],
    "status": "OPEN",
    "version": 1,
    "tenantInboundProcessId": "AB-01",
    "onHold": false,
    "inboundDate": [],
    "origin": [],
    "scannableCodes": [
        "12345"
    ],
    "anonymized": false
}