Purchase order

For a complete reference of all available endpoints and their parameters, see the Purchase Orders section in the REST API documentation.

Create a purchase order

A purchaseOrder is a sub-entity of an inboundProcess, which represents all processes related to incoming goods at a facility. When a new purchaseOrder is created, the system automatically creates a corresponding inboundProcess.

To create a purchaseOrder, send a POST request to the following endpoint with a JSON body.

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

{
  "facilityRef": "CGN-01",
  "orderDate": "2025-03-12T14:15:39.683Z",
  "requestedDate": {
    "type": "TIME_POINT",
    "value": "2025-03-16T14:15:39.683Z"
  },
  "requestedItems": [
    {
      "quantity": {
        "unit": "pieces",
        "value": 100
      },
      "tenantArticleId": "22222"
    }
  ],
  "status": "OPEN",
  "supplier": {
    "name": "fulfillmenttools"
  }
}

A successful request returns a 201 CREATED response with the newly created purchaseOrder object in the body:

{
    "status": "OPEN",
    "cancelled": false,
    "orderDate": "2025-03-12T14:15:39.683Z",
    "requestedDate": {
        "type": "TIME_POINT",
        "value": "2025-03-16T14:15:39.683Z"
    },
    "requestedItems": [
        {
            "tenantArticleId": "22222",
            "quantity": {
                "unit": "pieces",
                "value": 100
            }
        }
    ],
    "supplier": {
        "name": "fulfillmenttools"
    },
    "id": "38378d4e-585c-49e1-883f-1ac4faf289ad",
    "created": "2025-03-12T14:56:56.381Z",
    "lastModified": "2025-03-12T14:56:56.381Z",
    "version": 1,
    "facilityRef": "CGN-01",
    "inboundProcessRef": "2d965d89-0ef9-49a0-8380-53c2fde06134"
}

Alternative creation methods

A purchaseOrder can also be created in the following ways:

• Simultaneously with an inbound process: Include the purchaseOrder data when creating a new inboundProcess.

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

• Adding to an existing inbound process: Add a purchaseOrder to an inboundProcess that has already been created.

  PUT https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/inboundprocesses/{inboundProcessId}/purchaseorder