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/api/inboundprocesses

Query parameters

Response

200401403

Paginated result containing the matching Inbound Process entities

Body

application/json

inboundProcesses*array of StrippedInboundProcess (object)

total*number

Request

JavaScriptCurlPython

const response = await fetch('/api/inboundprocesses', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401403

{
  "inboundProcesses": [
    {
      "anonymized": false,
      "created": "2024-12-21T12:11:49.426Z",
      "facilityRef": "text",
      "id": "text",
      "inboundDate": [
        "2024-12-21T12:11:49.426Z"
      ],
      "lastModified": "2024-12-21T12:11:49.426Z",
      "onHold": false,
      "origin": [
        {
          "name": "text"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "status": "OPEN",
      "tenantInboundProcessId": "text",
      "version": 0
    }
  ],
  "total": 0
}

Create a new Inbound Process

POST/api/inboundprocesses

Body

application/json

customAttributesnullable object

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.

facilityRef*string

Facility in which the inbound process takes place

onHoldboolean

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

purchaseOrderInboundProcessPurchaseOrderForCreation (object)

receiptsarray of InboundReceiptForCreation (object)

scannableCodesarray of string

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

tenantInboundProcessIdstring

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

Response

200401403

Created Inbound Process entity

Body

application/json

anonymized*boolean

Indicates the inbound process was anonymized acording to configured GDPR retention time.

created*string (date-time)

customAttributesnullable object

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.

facilityRef*string

id*string

inboundDate*array of string (date-time)

Aggregated dates from sources which advise incoming stock. Currently that is "purchaseOrder"

lastModified*string (date-time)

onHold*boolean

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

origin*array of InboundProcessOrigin (object)

Aggregated origin data from sources which advise incoming stock. Currently that is just "purchaseOrder"

purchaseOrderInboundProcessPurchaseOrder (object)

receipts*array of InboundReceipt (object)

scannableCodes*array of string

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

status*enum

OPENPARTIAL_DELIVERYON_HOLDCLOSED

tenantInboundProcessIdstring

version*number

Request

JavaScriptCurlPython

const response = await fetch('/api/inboundprocesses', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "facilityRef": "text"
    }),
});
const data = await response.json();

Response

200401403

{
  "anonymized": false,
  "created": "2024-12-21T12:11:49.426Z",
  "facilityRef": "text",
  "id": "text",
  "inboundDate": [
    "2024-12-21T12:11:49.426Z"
  ],
  "lastModified": "2024-12-21T12:11:49.426Z",
  "onHold": false,
  "origin": [
    {
      "name": "text"
    }
  ],
  "purchaseOrder": {
    "cancelled": false,
    "created": "2024-12-21T12:11:49.426Z",
    "id": "text",
    "lastModified": "2024-12-21T12:11:49.426Z",
    "orderDate": "2024-12-21T12:11:49.426Z",
    "requestedDate": {
      "type": "ASAP",
      "value": "2024-12-21T12:11:49.426Z"
    },
    "requestedItems": [
      {
        "quantity": {
          "unit": "text",
          "value": 0
        },
        "stockProperties": {
          "expiry": "text"
        },
        "tenantArticleId": "text"
      }
    ],
    "status": "OPEN",
    "supplier": {
      "name": "text"
    },
    "transfer": {
      "id": "text"
    }
  },
  "receipts": [
    {
      "asnRef": "text",
      "comments": [
        {
          "attachments": [
            {
              "inboundAttachmentRef": "text"
            }
          ],
          "content": "text",
          "userRef": "text"
        }
      ],
      "id": "text",
      "receivedDate": "2024-12-21T12:11:49.426Z",
      "receivedItems": [
        {
          "acceptedQuantity": {
            "unit": "text",
            "value": 0
          },
          "comments": [
            {
              "attachments": [
                {
                  "inboundAttachmentRef": "text"
                }
              ],
              "content": "text",
              "userRef": "text"
            }
          ],
          "rejectedQuantity": {
            "unit": "text",
            "value": 0
          },
          "stockProperties": {
            "expiry": "text"
          },
          "storageLocationRef": "text",
          "tenantArticleId": "text"
        }
      ],
      "status": "IN_PROGRESS"
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "status": "OPEN",
  "tenantInboundProcessId": "text",
  "version": 0
}

Get an Inbound Process by ID

GET/api/inboundprocesses/{inboundProcessId}

Path parameters

inboundProcessId*string

Response

200401403

Requested Inbound Process entity

Body

application/json

anonymized*boolean

Indicates the inbound process was anonymized acording to configured GDPR retention time.

created*string (date-time)

customAttributesnullable object

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.

facilityRef*string

id*string

inboundDate*array of string (date-time)

Aggregated dates from sources which advise incoming stock. Currently that is "purchaseOrder"

lastModified*string (date-time)

onHold*boolean

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

origin*array of InboundProcessOrigin (object)

Aggregated origin data from sources which advise incoming stock. Currently that is just "purchaseOrder"

purchaseOrderInboundProcessPurchaseOrder (object)

receipts*array of InboundReceipt (object)

scannableCodes*array of string

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

status*enum

OPENPARTIAL_DELIVERYON_HOLDCLOSED

tenantInboundProcessIdstring

version*number

Request

JavaScriptCurlPython

const response = await fetch('/api/inboundprocesses/{inboundProcessId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401403

{
  "anonymized": false,
  "created": "2024-12-21T12:11:49.426Z",
  "facilityRef": "text",
  "id": "text",
  "inboundDate": [
    "2024-12-21T12:11:49.426Z"
  ],
  "lastModified": "2024-12-21T12:11:49.426Z",
  "onHold": false,
  "origin": [
    {
      "name": "text"
    }
  ],
  "purchaseOrder": {
    "cancelled": false,
    "created": "2024-12-21T12:11:49.426Z",
    "id": "text",
    "lastModified": "2024-12-21T12:11:49.426Z",
    "orderDate": "2024-12-21T12:11:49.426Z",
    "requestedDate": {
      "type": "ASAP",
      "value": "2024-12-21T12:11:49.426Z"
    },
    "requestedItems": [
      {
        "quantity": {
          "unit": "text",
          "value": 0
        },
        "stockProperties": {
          "expiry": "text"
        },
        "tenantArticleId": "text"
      }
    ],
    "status": "OPEN",
    "supplier": {
      "name": "text"
    },
    "transfer": {
      "id": "text"
    }
  },
  "receipts": [
    {
      "asnRef": "text",
      "comments": [
        {
          "attachments": [
            {
              "inboundAttachmentRef": "text"
            }
          ],
          "content": "text",
          "userRef": "text"
        }
      ],
      "id": "text",
      "receivedDate": "2024-12-21T12:11:49.426Z",
      "receivedItems": [
        {
          "acceptedQuantity": {
            "unit": "text",
            "value": 0
          },
          "comments": [
            {
              "attachments": [
                {
                  "inboundAttachmentRef": "text"
                }
              ],
              "content": "text",
              "userRef": "text"
            }
          ],
          "rejectedQuantity": {
            "unit": "text",
            "value": 0
          },
          "stockProperties": {
            "expiry": "text"
          },
          "storageLocationRef": "text",
          "tenantArticleId": "text"
        }
      ],
      "status": "IN_PROGRESS"
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "status": "OPEN",
  "tenantInboundProcessId": "text",
  "version": 0
}

Delete an Inbound Process by ID

DELETE/api/inboundprocesses/{inboundProcessId}

Path parameters

inboundProcessId*string

Response

200401403

Inbound Process successfully deleted

Request

JavaScriptCurlPython

const response = await fetch('/api/inboundprocesses/{inboundProcessId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401403

[
  {
    "description": "Missing attributes were name, address, items",
    "requestVersion": 41,
    "summary": "One or more mandatory attributes were not provided.",
    "version": 42
  }
]

Purchase Order

Get a Purchase Order by ID

GET/api/purchaseorders/{purchaseOrderId}

Path parameters

purchaseOrderId*string

Response

200401403

Purchase Order entity

Body

application/json

cancelled*boolean

Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.

created*string (date-time)

customAttributesnullable object

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.

facilityRef*string

id*string

inboundProcessRef*string

lastModified*string (date-time)

orderDate*string (date-time)

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

requestedDate*all of

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.

requestedItems*array of InboundLineItem (object)

Line items which are expected to be delivered.

status*enum

OPEN

supplierInboundProcessPurchaseOrderSupplier (object)

transferall of

Includes data about transfer between different facilities in the tenant's network.

version*number

Request

JavaScriptCurlPython

const response = await fetch('/api/purchaseorders/{purchaseOrderId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401403

{
  "cancelled": false,
  "created": "2024-12-21T12:11:49.426Z",
  "facilityRef": "text",
  "id": "text",
  "inboundProcessRef": "text",
  "lastModified": "2024-12-21T12:11:49.426Z",
  "orderDate": "2024-12-21T12:11:49.426Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2024-12-21T12:11:49.426Z"
  },
  "requestedItems": [
    {
      "quantity": {
        "unit": "text",
        "value": 0
      },
      "stockProperties": {
        "expiry": "text"
      },
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN",
  "supplier": {
    "name": "text"
  },
  "transfer": {
    "id": "text"
  },
  "version": 0
}

Update or create a Purchase Order

PUT/api/purchaseorders/{purchaseOrderId}

Path parameters

purchaseOrderId*string

Body

application/json

cancelledboolean

Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.

customAttributesnullable object

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.

orderDate*string (date-time)

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

requestedDate*all of

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.

requestedItems*array of InboundLineItem (object)

Line items which are expected to be delivered.

statusenum

OPEN

supplierInboundProcessPurchaseOrderSupplier (object)

version*number

Response

200401403

Updated/created Purchase Order entity

Body

application/json

cancelled*boolean

Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.

created*string (date-time)

customAttributesnullable object

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.

facilityRef*string

id*string

inboundProcessRef*string

lastModified*string (date-time)

orderDate*string (date-time)

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

requestedDate*all of

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.

requestedItems*array of InboundLineItem (object)

Line items which are expected to be delivered.

status*enum

OPEN

supplierInboundProcessPurchaseOrderSupplier (object)

transferall of

Includes data about transfer between different facilities in the tenant's network.

version*number

Request

JavaScriptCurlPython

const response = await fetch('/api/purchaseorders/{purchaseOrderId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "orderDate": "2024-12-21T12:11:49.426Z",
      "requestedDate": {
        "type": "ASAP"
      },
      "requestedItems": [
        {
          "tenantArticleId": "text",
          "quantity": {
            "value": 0
          }
        }
      ],
      "version": 0
    }),
});
const data = await response.json();

Response

200401403

{
  "cancelled": false,
  "created": "2024-12-21T12:11:49.426Z",
  "facilityRef": "text",
  "id": "text",
  "inboundProcessRef": "text",
  "lastModified": "2024-12-21T12:11:49.426Z",
  "orderDate": "2024-12-21T12:11:49.426Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2024-12-21T12:11:49.426Z"
  },
  "requestedItems": [
    {
      "quantity": {
        "unit": "text",
        "value": 0
      },
      "stockProperties": {
        "expiry": "text"
      },
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN",
  "supplier": {
    "name": "text"
  },
  "transfer": {
    "id": "text"
  },
  "version": 0
}

Partially updates a Purchase Order using a selection of fields

PATCH/api/purchaseorders/{purchaseOrderId}

Path parameters

purchaseOrderId*string

Body

application/json

cancelledboolean

orderDatestring (date-time)

requestedDateInputRequestedDate (object)

requestedItemsarray of InboundLineItem (object)

statusenum

OPEN

supplierInboundProcessPurchaseOrderSupplier (object)

version*number

Response

200401403

Updated Purchase Order entity

Body

application/json

cancelled*boolean

Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.

created*string (date-time)

customAttributesnullable object

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.

facilityRef*string

id*string

inboundProcessRef*string

lastModified*string (date-time)

orderDate*string (date-time)

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

requestedDate*all of

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.

requestedItems*array of InboundLineItem (object)

Line items which are expected to be delivered.

status*enum

OPEN

supplierInboundProcessPurchaseOrderSupplier (object)

transferall of

Includes data about transfer between different facilities in the tenant's network.

version*number

Request

JavaScriptCurlPython

const response = await fetch('/api/purchaseorders/{purchaseOrderId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "version": 0
    }),
});
const data = await response.json();

Response

200401403

{
  "cancelled": false,
  "created": "2024-12-21T12:11:49.426Z",
  "facilityRef": "text",
  "id": "text",
  "inboundProcessRef": "text",
  "lastModified": "2024-12-21T12:11:49.426Z",
  "orderDate": "2024-12-21T12:11:49.426Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2024-12-21T12:11:49.426Z"
  },
  "requestedItems": [
    {
      "quantity": {
        "unit": "text",
        "value": 0
      },
      "stockProperties": {
        "expiry": "text"
      },
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN",
  "supplier": {
    "name": "text"
  },
  "transfer": {
    "id": "text"
  },
  "version": 0
}

Create a new Purchase Order

POST/api/purchaseorders

Body

application/json

cancelledboolean

Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.

customAttributesnullable object

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.

facilityRef*string

orderDate*string (date-time)

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

requestedDate*all of

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.

requestedItems*array of InboundLineItem (object)

Line items which are expected to be delivered.

statusenum

OPEN

supplierInboundProcessPurchaseOrderSupplier (object)

Response

201401403

Created Purchase Order entity

Body

application/json

cancelled*boolean

Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.

created*string (date-time)

customAttributesnullable object

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.

facilityRef*string

id*string

inboundProcessRef*string

lastModified*string (date-time)

orderDate*string (date-time)

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

requestedDate*all of

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.

requestedItems*array of InboundLineItem (object)

Line items which are expected to be delivered.

status*enum

OPEN

supplierInboundProcessPurchaseOrderSupplier (object)

transferall of

Includes data about transfer between different facilities in the tenant's network.

version*number

Request

JavaScriptCurlPython

const response = await fetch('/api/purchaseorders', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "orderDate": "2024-12-21T12:11:49.426Z",
      "requestedDate": {
        "type": "ASAP"
      },
      "requestedItems": [
        {
          "tenantArticleId": "text",
          "quantity": {
            "value": 0
          }
        }
      ],
      "facilityRef": "text"
    }),
});
const data = await response.json();

Response

201401403

{
  "cancelled": false,
  "created": "2024-12-21T12:11:49.426Z",
  "facilityRef": "text",
  "id": "text",
  "inboundProcessRef": "text",
  "lastModified": "2024-12-21T12:11:49.426Z",
  "orderDate": "2024-12-21T12:11:49.426Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2024-12-21T12:11:49.426Z"
  },
  "requestedItems": [
    {
      "quantity": {
        "unit": "text",
        "value": 0
      },
      "stockProperties": {
        "expiry": "text"
      },
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN",
  "supplier": {
    "name": "text"
  },
  "transfer": {
    "id": "text"
  },
  "version": 0
}

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

PUT/api/inboundprocesses/{inboundProcessId}/purchaseorder

Path parameters

inboundProcessId*string

Body

application/json

cancelledboolean

Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.

customAttributesnullable object

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.

orderDate*string (date-time)

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

requestedDate*all of

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.

requestedItems*array of InboundLineItem (object)

Line items which are expected to be delivered.

statusenum

OPEN

supplierInboundProcessPurchaseOrderSupplier (object)

version*number

Response

200201401403

Purchase order successfully updated on inbound process

Body

application/json

cancelled*boolean

Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.

created*string (date-time)

customAttributesnullable object

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.

id*string

lastModified*string (date-time)

orderDate*string (date-time)

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

requestedDate*all of

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.

requestedItems*array of InboundLineItem (object)

Line items which are expected to be delivered.

status*enum

OPEN

supplierInboundProcessPurchaseOrderSupplier (object)

transferall of

Includes data about transfer between different facilities in the tenant's network.

Request

JavaScriptCurlPython

const response = await fetch('/api/inboundprocesses/{inboundProcessId}/purchaseorder', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "orderDate": "2024-12-21T12:11:49.426Z",
      "requestedDate": {
        "type": "ASAP"
      },
      "requestedItems": [
        {
          "tenantArticleId": "text",
          "quantity": {
            "value": 0
          }
        }
      ],
      "version": 0
    }),
});
const data = await response.json();

Response

200201401403

{
  "cancelled": false,
  "created": "2024-12-21T12:11:49.426Z",
  "id": "text",
  "lastModified": "2024-12-21T12:11:49.426Z",
  "orderDate": "2024-12-21T12:11:49.426Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2024-12-21T12:11:49.426Z"
  },
  "requestedItems": [
    {
      "quantity": {
        "unit": "text",
        "value": 0
      },
      "stockProperties": {
        "expiry": "text"
      },
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN",
  "supplier": {
    "name": "text"
  },
  "transfer": {
    "id": "text"
  }
}

Receipt

Adds a receipt to an inbound process.

POST/api/inboundprocesses/{inboundProcessId}/receipts

Path parameters

inboundProcessId*string

Body

application/json

asnRefstring

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

comments*array of InboundReceiptComment (object)

comments regarding the receipt itself

customAttributesnullable object

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.

receivedDate*string (date-time)

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

receivedItems*array of InboundReceiptLineItem (object)

list of item that arrived in the facility

statusenum

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

IN_PROGRESSFINISHED

Response

201401403

Receipt was added to the inbound process

Body

application/json

asnRefstring

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

comments*array of InboundReceiptComment (object)

comments regarding the receipt itself

customAttributesnullable object

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.

id*string

receivedDate*string (date-time)

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

receivedItems*array of InboundReceiptLineItem (object)

list of item that arrived in the facility

statusenum

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

IN_PROGRESSFINISHED

Request

JavaScriptCurlPython

const response = await fetch('/api/inboundprocesses/{inboundProcessId}/receipts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "receivedDate": "2024-12-21T12:11:49.426Z",
      "receivedItems": [
        {
          "tenantArticleId": "text",
          "acceptedQuantity": {
            "value": 0
          },
          "rejectedQuantity": {
            "value": 0
          },
          "comments": [
            {
              "content": "text"
            }
          ]
        }
      ],
      "comments": [
        {
          "content": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

201401403

{
  "asnRef": "text",
  "comments": [
    {
      "attachments": [
        {
          "inboundAttachmentRef": "text"
        }
      ],
      "content": "text",
      "userRef": "text"
    }
  ],
  "id": "text",
  "receivedDate": "2024-12-21T12:11:49.426Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "unit": "text",
        "value": 0
      },
      "comments": [
        {
          "attachments": [
            {
              "inboundAttachmentRef": "text"
            }
          ],
          "content": "text",
          "userRef": "text"
        }
      ],
      "rejectedQuantity": {
        "unit": "text",
        "value": 0
      },
      "stockProperties": {
        "expiry": "text"
      },
      "storageLocationRef": "text",
      "tenantArticleId": "text"
    }
  ],
  "status": "IN_PROGRESS"
}

Get InboundReceiptJobs

GET/api/inboundreceiptjobs

Query parameters

Response

200401403

Paginated Inbound Receipt Jobs

Body

application/json

inboundReceiptJobs*array of InboundReceiptJob (object)

total*number

Request

JavaScriptCurlPython

const response = await fetch('/api/inboundreceiptjobs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401403

{
  "inboundReceiptJobs": [
    {
      "expectedDate": {
        "type": "ASAP",
        "value": "2024-12-21T12:11:49.426Z"
      },
      "facilityRef": "text",
      "id": "text",
      "inboundProcessRef": "text",
      "items": {
        "quantity": {
          "unit": "text",
          "value": 0
        },
        "stockProperties": {
          "expiry": "text"
        },
        "tenantArticleId": "text"
      },
      "origin": {
        "name": "text"
      },
      "originReadableId": "text",
      "originReadableName": "text",
      "status": "OPEN"
    }
  ],
  "total": 0
}

Get an Inbound Receipt Job by ID

GET/api/inboundreceiptjobs/{inboundEntryId}

Path parameters

inboundEntryId*string

Response

200401403

Body

application/json

expectedDate*RequestedDate (object)

facilityRef*string

id*string

inboundProcessRef*string

items*InboundLineItem (object)

origin*InboundReceiptJobOrigin (object)

originReadableIdstring

originReadableNamestring

status*enum

OPENPARTIAL_DELIVERYON_HOLDCLOSED

Request

JavaScriptCurlPython

const response = await fetch('/api/inboundreceiptjobs/{inboundEntryId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401403

{
  "expectedDate": {
    "type": "ASAP",
    "value": "2024-12-21T12:11:49.426Z"
  },
  "facilityRef": "text",
  "id": "text",
  "inboundProcessRef": "text",
  "items": {
    "quantity": {
      "unit": "text",
      "value": 0
    },
    "stockProperties": {
      "expiry": "text"
    },
    "tenantArticleId": "text"
  },
  "origin": {
    "name": "text"
  },
  "originReadableId": "text",
  "originReadableName": "text",
  "status": "OPEN"
}

Creates a receipt

POST/api/receipts

Body

application/json

asnRefstring

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

comments*array of InboundReceiptComment (object)

comments regarding the receipt itself

customAttributesnullable object

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.

facilityRef*string

receivedDate*string (date-time)

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

receivedItems*array of InboundReceiptLineItem (object)

list of item that arrived in the facility

statusenum

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

IN_PROGRESSFINISHED

Response

201401403

Created inbound receipt

Body

application/json

asnRefstring

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

comments*array of InboundReceiptComment (object)

comments regarding the receipt itself

created*string (date-time)

customAttributesnullable object

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.

id*string

inboundProcessRef*string

lastModified*string (date-time)

receivedDate*string (date-time)

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

receivedItems*array of InboundReceiptLineItem (object)

list of item that arrived in the facility

statusenum

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

IN_PROGRESSFINISHED

version*number

Request

JavaScriptCurlPython

const response = await fetch('/api/receipts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "receivedDate": "2024-12-21T12:11:49.426Z",
      "receivedItems": [
        {
          "tenantArticleId": "text",
          "acceptedQuantity": {
            "value": 0
          },
          "rejectedQuantity": {
            "value": 0
          },
          "comments": [
            {
              "content": "text"
            }
          ]
        }
      ],
      "comments": [
        {
          "content": "text"
        }
      ],
      "facilityRef": "text"
    }),
});
const data = await response.json();

Response

201401403

{
  "asnRef": "text",
  "comments": [
    {
      "attachments": [
        {
          "inboundAttachmentRef": "text"
        }
      ],
      "content": "text",
      "userRef": "text"
    }
  ],
  "created": "2024-12-21T12:11:49.426Z",
  "id": "text",
  "inboundProcessRef": "text",
  "lastModified": "2024-12-21T12:11:49.426Z",
  "receivedDate": "2024-12-21T12:11:49.426Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "unit": "text",
        "value": 0
      },
      "comments": [
        {
          "attachments": [
            {
              "inboundAttachmentRef": "text"
            }
          ],
          "content": "text",
          "userRef": "text"
        }
      ],
      "rejectedQuantity": {
        "unit": "text",
        "value": 0
      },
      "stockProperties": {
        "expiry": "text"
      },
      "storageLocationRef": "text",
      "tenantArticleId": "text"
    }
  ],
  "status": "IN_PROGRESS",
  "version": 0
}

Get receipt by id

GET/api/receipts/{receiptId}

Path parameters

receiptId*string

Response

200401403404

Body

application/json

asnRefstring

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

comments*array of InboundReceiptComment (object)

comments regarding the receipt itself

created*string (date-time)

customAttributesnullable object

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.

id*string

inboundProcessRef*string

lastModified*string (date-time)

receivedDate*string (date-time)

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

receivedItems*array of InboundReceiptLineItem (object)

list of item that arrived in the facility

statusenum

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

IN_PROGRESSFINISHED

version*number

Request

JavaScriptCurlPython

const response = await fetch('/api/receipts/{receiptId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401403404

{
  "asnRef": "text",
  "comments": [
    {
      "attachments": [
        {
          "inboundAttachmentRef": "text"
        }
      ],
      "content": "text",
      "userRef": "text"
    }
  ],
  "created": "2024-12-21T12:11:49.426Z",
  "id": "text",
  "inboundProcessRef": "text",
  "lastModified": "2024-12-21T12:11:49.426Z",
  "receivedDate": "2024-12-21T12:11:49.426Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "unit": "text",
        "value": 0
      },
      "comments": [
        {
          "attachments": [
            {
              "inboundAttachmentRef": "text"
            }
          ],
          "content": "text",
          "userRef": "text"
        }
      ],
      "rejectedQuantity": {
        "unit": "text",
        "value": 0
      },
      "stockProperties": {
        "expiry": "text"
      },
      "storageLocationRef": "text",
      "tenantArticleId": "text"
    }
  ],
  "status": "IN_PROGRESS",
  "version": 0
}