Inbound Process

This page is outdated. Please go to our new documentation under https://docs.fulfillmenttools.com/documentation.

Summary

An inbound process maps all processes around incoming goods in a store or warehouse. This can include delivery of goods but also interfacility transfers or similar processes. Whenever a purchaseOrder or a receipt is created, a corresponding inboundProcess is automatically created as well.

An overview of all inbound process can be found in the inbound view or in the inventory app. Incoming goods can be accepted via the inbound section of our inventory app. The event of checking and accepting incoming goods is represented via Receipts.

Sub-Entities

The inbound process has sub-entities, which can be created and modified as part of the inbound process, or alternatively via their own endpoints.

Purchase Order

A purchase order is issued when new stock is ordered for a store or warehouse. It includes the following information:

Creating an inbound process with a purchaseOrder

Mandatory values:

• facilityRef: facility for which the order is destined

• purchaseOrder:

  • orderDate: time and date on which order was placed

  • requestedDate: time and date on which order is expected to arrive

  • requestedItems:

    • tenantArticleId: unique identifier for item

    • quantity: quantities and units of ordered items (maximum of 200 items can be processed)

Optional values:

• tenantInboundProcessId:unique identifier for inbound used in the customer systems

• onHold: Setting an inbound process on hold means that it should be paused for now. Can be set manually via Backoffice or via API. By setting the flag to true, the inboundProcess status is set to onHold.

• scannableCodes: scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note

• customAttributes: can be used to carry custom information that might be of interest to connectors or services outside of fulfillmenttools. For more information see custom attributes.
• purchaseOrder:

  • requestedItems:

    • stockProperties: information on stock properties of requested items such as expiry date
  • cancelled: If no further deliveries are expected, a purchaseOrder can be cancelled by an admin via Backoffice or via API. This is also possible, if several items have already been accepted. By setting the flag to true, the inboundProcess status is set to closed.

  • supplier: information on supplier of delivery (name)

  • customAttributes

Receipt

After a goods receipt was performed and goods have been accepted, a receipt is issued that adds the stock to the facility. It includes the following information:

Adding a receipt to an inboundProcess

Mandatory values:

• receivedDate: date when the order was accepted in the facility

• receivedItems: for each item that was announced via purchaseOrder the following information can be provided:

  • tenantArticleId:unique identifier for item

  • acceptedQuantity: quantity that was accepted in the goods receipt

  • rejectedQuantity: Quantity that was rejected in the goods receipt (due to being, e.g., broken).

  • comments: information relevant for that specific lineItem such as comments, photos, or other attachments

• comments: information relevant for that specific delivery such as comments, photos, or other attachments

Rejected items are not a subset of accepted items and are not booked to the facility as stock.

Optional values:

• asnRef: can be used to store the reference to an internal advanced shipping note

• receivedItems: for each item that was announced via purchaseOrder the following information can be provided:

  • storageLocationRef: the storage location on which the item was placed

  • stockProperties: information specific to that lineItem such as expiry date or batch number
• comments: information relevant for that specific delivery

• status: If a goods receipt has been started via inventory app, the status of the receipt changes to IN_PROGRESS and then to FINISHEDafter the process was completed in the app.

• customAttributes: Attributes that can be added to the receipt. These attributes cannot be used within fulfillmenttools' processes, but can be used to carry custom information on receipt.

Status

The inboundProcess itself as well as its sub-entities can have different status. Our clients show the status that are most relevant to the user in the inbound view and in the inventory app.

Status	Meaning	Entity
OPEN	Delivery has not arrived yet	inboundProcess
PARTIAL_DELIVERY	Items in the delivery were missing	inboundProcess
CLOSED	All items that were announced via purchase order have arrived (either as accepted or rejected quantity) or purchase order was cancelled.	inboundProcess
ON_HOLD	Inbound process should be paused for now. Can be set manually via Backoffice or via API.	inboundProcess
CANCELLED	No further deliveries are expected. No real status, can be either true or false. Can be set manually via Backoffice or via API.	purchaseOrder
OPEN	No functional meaning	purchaseOrder
IN_PROGRESS	Goods receipt for (one part of the) delivery has been started (via inventory app)	receipt
FINISHED	Goods receipt for (one part of the) delivery has been finished (via inventory app)	receipt

Validation in inbound process

Unit validation in inbound processes

If there is a measurementUnitKey defined for a listing that is part of the inboundProcess, each new line item in inboundProcess.purchaseOrder.requestedItems and inboundProcess.receipts.receivedItems is validated against it: All quantities MUST match the unit of the Listing.

Attention: When creating an inboundProcess with a purchaseOrder with unit "xyz" and changing the listing.measurementUnitKey to something else ("qwe") the inboundProcess.purchaseOrder must now be patched/replaced to reflect the correct unit again before a receipt can created in the inventory app. This is intentional and ensures the consistency of new stock levels in the facility. In general it is not advised to change the unit of a product in a facility without careful consideration, but in some cases it might be desired to start with no unit on the listing (= no validation) and transition to stricter rules later.

For more information on measurementUnits, click here.

Stock property validation in inbound processes

If there are stockProperties defined for a listing that is part of the inboundProcess, each new line item in inboundProcess.purchaseOrder.requestedItems and inboundProcess.receipts.receivedItems is validated against it. The validation for requested and received items behaves slightly different as we do not expect systems to know the exact properties of all items before they have arrived.

Validation for requestedItems

• All stockProperties that are part of the requestedItems must also be defined in the stockProperties of the listing.

• Not all stockProperties that are part of the listing must also be present in the requestedItems.

• This means, it is allowed to create a purchaseOrder without stockProperties in the requestedItems even though the included listing has stockProperties defined.

Validation for receivedItems

• All stockProperties that are part of the receivedItems must also be defined in the stockProperties of the listing.

• Not all stockProperties that are part of the listing must also be present in the requestedItems. Only stockProperties where required is true need to be present in both listing and receivedItems. This is because creating a stock without providing a value for a required property is forbidden and will fail.

For more information on stockProperties on listing, click here.

Api Documentation

Inbound Process

Get multiple Inbound Processes

get

Query parameters

sizenumber · min: 1 · max: 100OptionalDefault: 25

startAfterIdstringOptional

sortstring · enumOptionalAvailable options:

facilityRefstring[]Optional

scannableCodestringOptional

statusstring · enum[]Optional

searchTermstringOptional

Matches partial values; The queries terms and therefore the result set of the query can change in the future:

• tenantInboundProcessId
• scannableCodes
• receipts.receivedItems.tenantArticleId
• purchaseOrder.requestedItems.tenantArticleId
• purchaseOrder.supplier.name
• values of related listings
  • listing.title
  • listing.scannableCodes

searchTermExactstringOptional

Only matches complete values; The queries terms and therefore the result set of the query can change in the future:

• tenantInboundProcessId
• scannableCodes
• receipts.receivedItems.tenantArticleId
• purchaseOrder.requestedItems.tenantArticleId
• purchaseOrder.supplier.name
• values of related listings
  • listing.title
  • listing.scannableCodes

purchaseOrder_cancelledbooleanOptional

receipt_statusstring · enum[]Optional

Responses

application/json

objectOptional

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /api/inboundprocesses HTTP/1.1
Host: 
Accept: */*

{
  "inboundProcesses": [
    {
      "anonymized": true,
      "created": "2025-04-21T11:36:28.547Z",
      "customAttributes": {},
      "facilityRef": "text",
      "id": "text",
      "inboundDate": [
        "2025-04-21T11:36:28.547Z"
      ],
      "lastModified": "2025-04-21T11:36:28.547Z",
      "onHold": true,
      "origin": [
        {
          "name": "text"
        }
      ],
      "purchaseOrder": {
        "created": "2025-04-21T11:36:28.547Z",
        "customAttributes": {},
        "id": "text",
        "lastModified": "2025-04-21T11:36:28.547Z",
        "orderDate": "2025-04-21T11:36:28.547Z",
        "requestedDate": {
          "type": "ASAP",
          "value": "2025-04-21T11:36:28.547Z"
        },
        "requestedItems": [
          {
            "customAttributes": {},
            "quantity": {
              "unit": "text",
              "value": 1
            },
            "stockProperties": {
              "expiry": "text"
            },
            "tenantArticleId": "text"
          }
        ],
        "status": "OPEN",
        "supplier": {
          "name": "text"
        },
        "transfer": {
          "id": "text"
        }
      },
      "receipts": [
        {
          "asnRef": "text",
          "comments": [
            {
              "content": "text",
              "documentSetRef": "text",
              "id": "text",
              "userRef": "text"
            }
          ],
          "customAttributes": {},
          "id": "text",
          "receivedDate": "2025-04-21T11:36:28.547Z",
          "receivedItems": [
            {
              "acceptedQuantity": {
                "unit": "text",
                "value": 1
              },
              "comments": [
                {
                  "content": "text",
                  "documentSetRef": "text",
                  "id": "text",
                  "userRef": "text"
                }
              ],
              "customAttributes": {},
              "id": "text",
              "rejectedQuantity": {
                "unit": "text",
                "value": 1
              },
              "stockProperties": {
                "expiry": "text"
              },
              "storageLocationRef": "text",
              "tenantArticleId": "text"
            }
          ],
          "status": "OPEN"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "status": "OPEN",
      "tenantInboundProcessId": "text",
      "version": 1
    }
  ],
  "total": 1
}

Create a new Inbound Process

post

Body

customAttributesobject | nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

facilityRefstringRequired

Facility in which the inbound process takes place

onHoldbooleanOptional

Indicates if the inbound process is on hold and will not be processed further

purchaseOrderobjectOptional

receiptsobject[] · max: 200Optional

scannableCodesstring[]Optional

scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note

tenantInboundProcessIdstringOptional

Identifier of the process provided by the tenant system. It is recommended to be unique

Responses

application/json

objectOptional

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /api/inboundprocesses HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 876

{
  "customAttributes": {},
  "facilityRef": "text",
  "onHold": true,
  "purchaseOrder": {
    "customAttributes": {},
    "orderDate": "2025-04-21T11:36:28.547Z",
    "requestedDate": {
      "type": "ASAP",
      "value": "2025-04-21T11:36:28.547Z"
    },
    "requestedItems": [
      {
        "customAttributes": {},
        "quantity": {
          "unit": "text",
          "value": 1
        },
        "stockProperties": {
          "expiry": "text"
        },
        "tenantArticleId": "text"
      }
    ],
    "status": "OPEN",
    "supplier": {
      "name": "text"
    }
  },
  "receipts": [
    {
      "asnRef": "text",
      "comments": [
        {
          "content": "text",
          "userRef": "text"
        }
      ],
      "customAttributes": {},
      "receivedDate": "2025-04-21T11:36:28.547Z",
      "receivedItems": [
        {
          "acceptedQuantity": {
            "unit": "text",
            "value": 1
          },
          "comments": [
            {
              "content": "text",
              "userRef": "text"
            }
          ],
          "customAttributes": {},
          "rejectedQuantity": {
            "unit": "text",
            "value": 1
          },
          "stockProperties": {
            "expiry": "text"
          },
          "storageLocationRef": "text",
          "tenantArticleId": "text"
        }
      ],
      "status": "OPEN"
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "tenantInboundProcessId": "text"
}

{
  "anonymized": true,
  "created": "2025-04-21T11:36:28.547Z",
  "customAttributes": {},
  "facilityRef": "text",
  "id": "text",
  "inboundDate": [
    "2025-04-21T11:36:28.547Z"
  ],
  "lastModified": "2025-04-21T11:36:28.547Z",
  "onHold": true,
  "origin": [
    {
      "name": "text"
    }
  ],
  "purchaseOrder": {
    "created": "2025-04-21T11:36:28.547Z",
    "customAttributes": {},
    "id": "text",
    "lastModified": "2025-04-21T11:36:28.547Z",
    "orderDate": "2025-04-21T11:36:28.547Z",
    "requestedDate": {
      "type": "ASAP",
      "value": "2025-04-21T11:36:28.547Z"
    },
    "requestedItems": [
      {
        "customAttributes": {},
        "quantity": {
          "unit": "text",
          "value": 1
        },
        "stockProperties": {
          "expiry": "text"
        },
        "tenantArticleId": "text"
      }
    ],
    "status": "OPEN",
    "supplier": {
      "name": "text"
    },
    "transfer": {
      "id": "text"
    }
  },
  "receipts": [
    {
      "asnRef": "text",
      "comments": [
        {
          "content": "text",
          "documentSetRef": "text",
          "id": "text",
          "userRef": "text"
        }
      ],
      "customAttributes": {},
      "id": "text",
      "receivedDate": "2025-04-21T11:36:28.547Z",
      "receivedItems": [
        {
          "acceptedQuantity": {
            "unit": "text",
            "value": 1
          },
          "comments": [
            {
              "content": "text",
              "documentSetRef": "text",
              "id": "text",
              "userRef": "text"
            }
          ],
          "customAttributes": {},
          "id": "text",
          "rejectedQuantity": {
            "unit": "text",
            "value": 1
          },
          "stockProperties": {
            "expiry": "text"
          },
          "storageLocationRef": "text",
          "tenantArticleId": "text"
        }
      ],
      "status": "OPEN"
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "status": "OPEN",
  "tenantInboundProcessId": "text",
  "version": 1
}

Get an Inbound Process by ID

get

Path parameters

inboundProcessIdstringRequired

Responses

application/json

objectOptional

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /api/inboundprocesses/{inboundProcessId} HTTP/1.1
Host: 
Accept: */*

{
  "anonymized": true,
  "created": "2025-04-21T11:36:28.547Z",
  "customAttributes": {},
  "facilityRef": "text",
  "id": "text",
  "inboundDate": [
    "2025-04-21T11:36:28.547Z"
  ],
  "lastModified": "2025-04-21T11:36:28.547Z",
  "onHold": true,
  "origin": [
    {
      "name": "text"
    }
  ],
  "purchaseOrder": {
    "created": "2025-04-21T11:36:28.547Z",
    "customAttributes": {},
    "id": "text",
    "lastModified": "2025-04-21T11:36:28.547Z",
    "orderDate": "2025-04-21T11:36:28.547Z",
    "requestedDate": {
      "type": "ASAP",
      "value": "2025-04-21T11:36:28.547Z"
    },
    "requestedItems": [
      {
        "customAttributes": {},
        "quantity": {
          "unit": "text",
          "value": 1
        },
        "stockProperties": {
          "expiry": "text"
        },
        "tenantArticleId": "text"
      }
    ],
    "status": "OPEN",
    "supplier": {
      "name": "text"
    },
    "transfer": {
      "id": "text"
    }
  },
  "receipts": [
    {
      "asnRef": "text",
      "comments": [
        {
          "content": "text",
          "documentSetRef": "text",
          "id": "text",
          "userRef": "text"
        }
      ],
      "customAttributes": {},
      "id": "text",
      "receivedDate": "2025-04-21T11:36:28.547Z",
      "receivedItems": [
        {
          "acceptedQuantity": {
            "unit": "text",
            "value": 1
          },
          "comments": [
            {
              "content": "text",
              "documentSetRef": "text",
              "id": "text",
              "userRef": "text"
            }
          ],
          "customAttributes": {},
          "id": "text",
          "rejectedQuantity": {
            "unit": "text",
            "value": 1
          },
          "stockProperties": {
            "expiry": "text"
          },
          "storageLocationRef": "text",
          "tenantArticleId": "text"
        }
      ],
      "status": "OPEN"
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "status": "OPEN",
  "tenantInboundProcessId": "text",
  "version": 1
}

Delete an Inbound Process by ID

delete

Path parameters

inboundProcessIdstringRequired

Responses

application/json

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/inboundprocesses/{inboundProcessId} HTTP/1.1
Host: 
Accept: */*

No content

Purchase Order

Get a Purchase Order by ID

get

Path parameters

purchaseOrderIdstringRequired

Responses

application/json

objectOptional

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /api/purchaseorders/{purchaseOrderId} HTTP/1.1
Host: 
Accept: */*

{
  "created": "2025-04-21T11:36:28.547Z",
  "customAttributes": {},
  "facilityRef": "text",
  "id": "text",
  "inboundProcessRef": "text",
  "lastModified": "2025-04-21T11:36:28.547Z",
  "orderDate": "2025-04-21T11:36:28.547Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2025-04-21T11:36:28.547Z"
  },
  "requestedItems": [
    {
      "customAttributes": {},
      "quantity": {
        "unit": "text",
        "value": 1
      },
      "stockProperties": {
        "expiry": "text"
      },
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN",
  "supplier": {
    "name": "text"
  },
  "transfer": {
    "id": "text"
  },
  "version": 1
}

Update or create a Purchase Order

put

Path parameters

purchaseOrderIdstringRequired

Body

cancelledbooleanOptionalDeprecated

This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.

customAttributesobject | nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

orderDatestring · date-timeRequired

Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.

requestedDateall ofRequired

Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders.

requestedItemsobject[] · max: 200Required

Line items which are expected to be delivered.

statusstring · enumOptionalAvailable options:

supplierobjectOptional

versionnumberRequired

Responses

application/json

objectOptional

application/json

application/json

put

HTTPcURLJavaScriptPython

PUT /api/purchaseorders/{purchaseOrderId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 325

{
  "customAttributes": {},
  "orderDate": "2025-04-21T11:36:28.547Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2025-04-21T11:36:28.547Z"
  },
  "requestedItems": [
    {
      "customAttributes": {},
      "quantity": {
        "unit": "text",
        "value": 1
      },
      "stockProperties": {
        "expiry": "text"
      },
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN",
  "supplier": {
    "name": "text"
  },
  "version": 1
}

{
  "created": "2025-04-21T11:36:28.547Z",
  "customAttributes": {},
  "facilityRef": "text",
  "id": "text",
  "inboundProcessRef": "text",
  "lastModified": "2025-04-21T11:36:28.547Z",
  "orderDate": "2025-04-21T11:36:28.547Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2025-04-21T11:36:28.547Z"
  },
  "requestedItems": [
    {
      "customAttributes": {},
      "quantity": {
        "unit": "text",
        "value": 1
      },
      "stockProperties": {
        "expiry": "text"
      },
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN",
  "supplier": {
    "name": "text"
  },
  "transfer": {
    "id": "text"
  },
  "version": 1
}

Partially updates a Purchase Order using a selection of fields

patch

Path parameters

purchaseOrderIdstringRequired

Body

cancelledbooleanOptionalDeprecated

This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.

customAttributesobject | nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

orderDatestring · date-timeOptional

requestedDateobjectOptional

requestedItemsobject[]Optional

statusstring · enumOptionalAvailable options:

supplierobjectOptional

versionnumberRequired

Responses

application/json

objectOptional

application/json

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/purchaseorders/{purchaseOrderId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 325

{
  "customAttributes": {},
  "orderDate": "2025-04-21T11:36:28.547Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2025-04-21T11:36:28.547Z"
  },
  "requestedItems": [
    {
      "customAttributes": {},
      "quantity": {
        "unit": "text",
        "value": 1
      },
      "stockProperties": {
        "expiry": "text"
      },
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN",
  "supplier": {
    "name": "text"
  },
  "version": 1
}

{
  "created": "2025-04-21T11:36:28.547Z",
  "customAttributes": {},
  "facilityRef": "text",
  "id": "text",
  "inboundProcessRef": "text",
  "lastModified": "2025-04-21T11:36:28.547Z",
  "orderDate": "2025-04-21T11:36:28.547Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2025-04-21T11:36:28.547Z"
  },
  "requestedItems": [
    {
      "customAttributes": {},
      "quantity": {
        "unit": "text",
        "value": 1
      },
      "stockProperties": {
        "expiry": "text"
      },
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN",
  "supplier": {
    "name": "text"
  },
  "transfer": {
    "id": "text"
  },
  "version": 1
}

Create a new Purchase Order

post

Body

cancelledbooleanOptionalDeprecated

This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.

customAttributesobject | nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

facilityRefstring · min: 1Required

orderDatestring · date-timeRequired

Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.

requestedDateall ofRequired

Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders.

requestedItemsobject[] · max: 200Required

Line items which are expected to be delivered.

statusstring · enumOptionalAvailable options:

supplierobjectOptional

Responses

application/json

objectOptional

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /api/purchaseorders HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 334

{
  "customAttributes": {},
  "facilityRef": "text",
  "orderDate": "2025-04-21T11:36:28.547Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2025-04-21T11:36:28.547Z"
  },
  "requestedItems": [
    {
      "customAttributes": {},
      "quantity": {
        "unit": "text",
        "value": 1
      },
      "stockProperties": {
        "expiry": "text"
      },
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN",
  "supplier": {
    "name": "text"
  }
}

{
  "created": "2025-04-21T11:36:28.547Z",
  "customAttributes": {},
  "facilityRef": "text",
  "id": "text",
  "inboundProcessRef": "text",
  "lastModified": "2025-04-21T11:36:28.547Z",
  "orderDate": "2025-04-21T11:36:28.547Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2025-04-21T11:36:28.547Z"
  },
  "requestedItems": [
    {
      "customAttributes": {},
      "quantity": {
        "unit": "text",
        "value": 1
      },
      "stockProperties": {
        "expiry": "text"
      },
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN",
  "supplier": {
    "name": "text"
  },
  "transfer": {
    "id": "text"
  },
  "version": 1
}

Creates or updates the specific purchase order of an existing inbound process.

put

Path parameters

inboundProcessIdstringRequired

Body

cancelledbooleanOptionalDeprecated

This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.

customAttributesobject | nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

orderDatestring · date-timeRequired

Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.

requestedDateall ofRequired

Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders.

requestedItemsobject[] · max: 200Required

Line items which are expected to be delivered.

statusstring · enumOptionalAvailable options:

supplierobjectOptional

versionnumberRequired

Responses

application/json

objectOptional

application/json

application/json

application/json

put

HTTPcURLJavaScriptPython

PUT /api/inboundprocesses/{inboundProcessId}/purchaseorder HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 325

{
  "customAttributes": {},
  "orderDate": "2025-04-21T11:36:28.547Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2025-04-21T11:36:28.547Z"
  },
  "requestedItems": [
    {
      "customAttributes": {},
      "quantity": {
        "unit": "text",
        "value": 1
      },
      "stockProperties": {
        "expiry": "text"
      },
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN",
  "supplier": {
    "name": "text"
  },
  "version": 1
}

{
  "created": "2025-04-21T11:36:28.547Z",
  "customAttributes": {},
  "id": "text",
  "lastModified": "2025-04-21T11:36:28.547Z",
  "orderDate": "2025-04-21T11:36:28.547Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2025-04-21T11:36:28.547Z"
  },
  "requestedItems": [
    {
      "customAttributes": {},
      "quantity": {
        "unit": "text",
        "value": 1
      },
      "stockProperties": {
        "expiry": "text"
      },
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN",
  "supplier": {
    "name": "text"
  },
  "transfer": {
    "id": "text"
  }
}

Receipt

Adds a receipt to an inbound process.

post

Path parameters

inboundProcessIdstringRequired

Body

asnRefstringOptional

enables mapping a receipt to one of the ASNs in this inbound process

commentsobject[] · max: 20Required

comments regarding the receipt itself

customAttributesobject | nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

receivedDatestring · date-timeRequired

date-time of the arrival of the items in the facility

receivedItemsobject[] · max: 200Required

list of item that arrived in the facility

statusstring · enumOptional

status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.

Available options:

Responses

application/json

objectOptional

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /api/inboundprocesses/{inboundProcessId}/receipts HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 416

{
  "asnRef": "text",
  "comments": [
    {
      "content": "text",
      "userRef": "text"
    }
  ],
  "customAttributes": {},
  "receivedDate": "2025-04-21T11:36:28.547Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "unit": "text",
        "value": 1
      },
      "comments": [
        {
          "content": "text",
          "userRef": "text"
        }
      ],
      "customAttributes": {},
      "rejectedQuantity": {
        "unit": "text",
        "value": 1
      },
      "stockProperties": {
        "expiry": "text"
      },
      "storageLocationRef": "text",
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN"
}

{
  "asnRef": "text",
  "comments": [
    {
      "content": "text",
      "documentSetRef": "text",
      "id": "text",
      "userRef": "text"
    }
  ],
  "customAttributes": {},
  "id": "text",
  "receivedDate": "2025-04-21T11:36:28.547Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "unit": "text",
        "value": 1
      },
      "comments": [
        {
          "content": "text",
          "documentSetRef": "text",
          "id": "text",
          "userRef": "text"
        }
      ],
      "customAttributes": {},
      "id": "text",
      "rejectedQuantity": {
        "unit": "text",
        "value": 1
      },
      "stockProperties": {
        "expiry": "text"
      },
      "storageLocationRef": "text",
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN"
}

Get InboundReceiptJobs

get

Query parameters

sizenumber · min: 1 · max: 100OptionalDefault: 25

startAfterIdstringOptional

facilityRefstring[]Optional

statusstring · enum[]Optional

searchTermstring · min: 1Optional

searchTermExactstring · min: 1Optional

fromDatestring · date-timeOptional

toDatestring · date-timeOptional

Responses

application/json

objectOptional

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /api/inboundreceiptjobs HTTP/1.1
Host: 
Accept: */*

{
  "inboundReceiptJobs": [
    {
      "expectedDate": {
        "type": "ASAP",
        "value": "2025-04-21T11:36:28.547Z"
      },
      "facilityRef": "text",
      "id": "text",
      "inboundProcessRef": "text",
      "items": {
        "customAttributes": {},
        "quantity": {
          "unit": "text",
          "value": 1
        },
        "stockProperties": {
          "expiry": "text"
        },
        "tenantArticleId": "text"
      },
      "origin": {
        "name": "text"
      },
      "originReadableId": "text",
      "originReadableName": "text",
      "status": "OPEN"
    }
  ],
  "total": 1
}

Get an Inbound Receipt Job by ID

get

Path parameters

inboundEntryIdstringRequired

Responses

application/json

objectOptional

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /api/inboundreceiptjobs/{inboundEntryId} HTTP/1.1
Host: 
Accept: */*

{
  "expectedDate": {
    "type": "ASAP",
    "value": "2025-04-21T11:36:28.547Z"
  },
  "facilityRef": "text",
  "id": "text",
  "inboundProcessRef": "text",
  "items": {
    "customAttributes": {},
    "quantity": {
      "unit": "text",
      "value": 1
    },
    "stockProperties": {
      "expiry": "text"
    },
    "tenantArticleId": "text"
  },
  "origin": {
    "name": "text"
  },
  "originReadableId": "text",
  "originReadableName": "text",
  "status": "OPEN"
}

Creates a receipt

post

Body

asnRefstringOptional

enables mapping a receipt to one of the ASNs in this inbound process

commentsobject[] · max: 20Required

comments regarding the receipt itself

customAttributesobject | nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

facilityRefstringRequired

receivedDatestring · date-timeRequired

date-time of the arrival of the items in the facility

receivedItemsobject[] · max: 200Required

list of item that arrived in the facility

statusstring · enumOptional

status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.

Available options:

Responses

application/json

objectOptional

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /api/receipts HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 437

{
  "asnRef": "text",
  "comments": [
    {
      "content": "text",
      "userRef": "text"
    }
  ],
  "customAttributes": {},
  "facilityRef": "text",
  "receivedDate": "2025-04-21T11:36:28.547Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "unit": "text",
        "value": 1
      },
      "comments": [
        {
          "content": "text",
          "userRef": "text"
        }
      ],
      "customAttributes": {},
      "rejectedQuantity": {
        "unit": "text",
        "value": 1
      },
      "stockProperties": {
        "expiry": "text"
      },
      "storageLocationRef": "text",
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN"
}

{
  "asnRef": "text",
  "comments": [
    {
      "content": "text",
      "documentSetRef": "text",
      "id": "text",
      "userRef": "text"
    }
  ],
  "created": "2025-04-21T11:36:28.547Z",
  "customAttributes": {},
  "id": "text",
  "inboundProcessRef": "text",
  "lastModified": "2025-04-21T11:36:28.547Z",
  "receivedDate": "2025-04-21T11:36:28.547Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "unit": "text",
        "value": 1
      },
      "comments": [
        {
          "content": "text",
          "documentSetRef": "text",
          "id": "text",
          "userRef": "text"
        }
      ],
      "customAttributes": {},
      "id": "text",
      "rejectedQuantity": {
        "unit": "text",
        "value": 1
      },
      "stockProperties": {
        "expiry": "text"
      },
      "storageLocationRef": "text",
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN",
  "version": 1
}

Get receipt by id

get

Path parameters

receiptIdstringRequired

Responses

application/json

objectOptional

application/json

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /api/receipts/{receiptId} HTTP/1.1
Host: 
Accept: */*

{
  "asnRef": "text",
  "comments": [
    {
      "content": "text",
      "documentSetRef": "text",
      "id": "text",
      "userRef": "text"
    }
  ],
  "created": "2025-04-21T11:36:28.547Z",
  "customAttributes": {},
  "id": "text",
  "inboundProcessRef": "text",
  "lastModified": "2025-04-21T11:36:28.547Z",
  "receivedDate": "2025-04-21T11:36:28.547Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "unit": "text",
        "value": 1
      },
      "comments": [
        {
          "content": "text",
          "documentSetRef": "text",
          "id": "text",
          "userRef": "text"
        }
      ],
      "customAttributes": {},
      "id": "text",
      "rejectedQuantity": {
        "unit": "text",
        "value": 1
      },
      "stockProperties": {
        "expiry": "text"
      },
      "storageLocationRef": "text",
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN",
  "version": 1
}