Inbound Process

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, returns or similar processes. As of now, inbound processes can only be triggered through a purchase order. > Is this correct? 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 API.

Purchase Order

A purchase order is issued when new stock is ordered for a store or warehouse. It includes the following information (only not self-explanatory information is listed below):

• orderDate: Date when the order was placed

• requestedDate: Date when the order is expected to arrive

• requestedItems: information on IDs and quantities of ordered products

• 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.

• supplier: information on supplier of delivery (name)

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 (only not self-explanatory information is listed below):

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

• receivedItems: For each product that was announced via purchaseOrder the following information can be provided:

  • acceptedQuantity: how much was accepted

  • rejectedQuantity: how much was rejected (due to being, e.g., broken). Attention: rejectedItems are not a subset of acceptedItems.

  • comments: information relevant for that specific lineItem

  • storageLocationRef: the storage location on which the product 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.

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

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

total*number

inboundProcesses*array of StrippedInboundProcess (object)

Request

JavaScriptCurl

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

Response

{
  "total": 0,
  "inboundProcesses": [
    {
      "id": "text",
      "version": 0,
      "created": "2024-04-28T11:45:30.185Z",
      "lastModified": "2024-04-28T11:45:30.185Z",
      "tenantInboundProcessId": "text",
      "facilityRef": "text",
      "status": "OPEN",
      "onHold": false,
      "inboundDate": [
        "2024-04-28T11:45:30.185Z"
      ],
      "origin": [
        {
          "name": "text"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "anonymized": false
    }
  ]
}

Create a new Inbound Process

POST/api/inboundprocesses

Body

application/json

tenantInboundProcessIdstring

facilityRef*string

receiptsarray of InboundReceiptForCreation (object)

onHoldboolean

purchaseOrderInboundProcessPurchaseOrderForCreation (object)

scannableCodesarray of string

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.

Response

200401403

Created Inbound Process entity

Body

application/json

id*string

version*number

created*string (date-time)

lastModified*string (date-time)

tenantInboundProcessIdstring

facilityRef*string

status*enum

OPENPARTIAL_DELIVERYON_HOLDCLOSED

onHold*boolean

inboundDate*array of string (date-time)

origin*array of InboundProcessOrigin (object)

scannableCodes*array of string

anonymized*boolean

purchaseOrderInboundProcessPurchaseOrder (object)

receipts*array of InboundReceipt (object)

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.

Request

JavaScriptCurl

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

Response

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

Get an Inbound Process by ID

GET/api/inboundprocesses/{inboundProcessId}

Path parameters

inboundProcessId*string

Response

200401403

Requested Inbound Process entity

Body

application/json

id*string

version*number

created*string (date-time)

lastModified*string (date-time)

tenantInboundProcessIdstring

facilityRef*string

status*enum

OPENPARTIAL_DELIVERYON_HOLDCLOSED

onHold*boolean

inboundDate*array of string (date-time)

origin*array of InboundProcessOrigin (object)

scannableCodes*array of string

anonymized*boolean

purchaseOrderInboundProcessPurchaseOrder (object)

receipts*array of InboundReceipt (object)

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.

Request

JavaScriptCurl

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

Response

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

Delete an Inbound Process by ID

DELETE/api/inboundprocesses/{inboundProcessId}

Path parameters

inboundProcessId*string

Response

200401403

Inbound Process successfully deleted

Request

JavaScriptCurl

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

Purchase Order

Provides metadata for currently available artifacts for a platform

GET/api/artifacts/{platform}

Path parameters

platform*enum

Platform for which to list artifacts

android

Response

200400401403

All available artifacts for the selected platform

Body

application/json

artifacts*array of ArtifactMetadataItem (object)

platform*string

Platform name for which the artifact list is generated

Request

JavaScriptCurl

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

Response

{
  "artifacts": [
    {
      "buildDate": "2020-02-03T08:45:50.525Z",
      "download": {
        "expiration": "2020-02-03T08:45:50.525Z",
        "url": "text"
      },
      "versionCode": 42,
      "versionName": "1.0.42"
    }
  ],
  "platform": "android"
}

Get a Purchase Order by ID

GET/api/purchaseorders/{purchaseOrderId}

Path parameters

purchaseOrderId*string

Response

200401403

Purchase Order entity

Body

application/json

id*string

created*string (date-time)

lastModified*string (date-time)

orderDate*string (date-time)

requestedDate*RequestedDate (object)

requestedItems*array of InboundLineItem (object)

status*enum

OPEN

cancelled*boolean

supplierInboundProcessPurchaseOrderSupplier (object)

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.

version*number

facilityRef*string

inboundProcessRef*string

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "created": "2024-04-28T11:45:30.185Z",
  "lastModified": "2024-04-28T11:45:30.185Z",
  "orderDate": "2024-04-28T11:45:30.185Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2024-04-28T11:45:30.185Z"
  },
  "requestedItems": [
    {
      "tenantArticleId": "text",
      "quantity": {
        "unit": "text"
      }
    }
  ],
  "status": "OPEN",
  "cancelled": false,
  "supplier": {
    "name": "text"
  },
  "version": 0,
  "facilityRef": "text",
  "inboundProcessRef": "text"
}

Update or create a Purchase Order

PUT/api/purchaseorders/{purchaseOrderId}

Path parameters

purchaseOrderId*string

Body

application/json

orderDate*string (date-time)

requestedDate*InputRequestedDate (object)

requestedItems*array of InboundLineItem (object)

statusenum

OPEN

cancelledboolean

supplierInboundProcessPurchaseOrderSupplier (object)

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.

version*number

Response

200401403

Updated/created Purchase Order entity

Body

application/json

id*string

created*string (date-time)

lastModified*string (date-time)

orderDate*string (date-time)

requestedDate*RequestedDate (object)

requestedItems*array of InboundLineItem (object)

status*enum

OPEN

cancelled*boolean

supplierInboundProcessPurchaseOrderSupplier (object)

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.

version*number

facilityRef*string

inboundProcessRef*string

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "created": "2024-04-28T11:45:30.185Z",
  "lastModified": "2024-04-28T11:45:30.185Z",
  "orderDate": "2024-04-28T11:45:30.185Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2024-04-28T11:45:30.185Z"
  },
  "requestedItems": [
    {
      "tenantArticleId": "text",
      "quantity": {
        "unit": "text"
      }
    }
  ],
  "status": "OPEN",
  "cancelled": false,
  "supplier": {
    "name": "text"
  },
  "version": 0,
  "facilityRef": "text",
  "inboundProcessRef": "text"
}

Partially updates a Purchase Order using a selection of fields

PATCH/api/purchaseorders/{purchaseOrderId}

Path parameters

purchaseOrderId*string

Body

application/json

version*number

orderDatestring (date-time)

requestedDateInputRequestedDate (object)

requestedItemsarray of InboundLineItem (object)

statusenum

OPEN

cancelledboolean

supplierInboundProcessPurchaseOrderSupplier (object)

Response

200401403

Updated Purchase Order entity

Body

application/json

id*string

created*string (date-time)

lastModified*string (date-time)

orderDate*string (date-time)

requestedDate*RequestedDate (object)

requestedItems*array of InboundLineItem (object)

status*enum

OPEN

cancelled*boolean

supplierInboundProcessPurchaseOrderSupplier (object)

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.

version*number

facilityRef*string

inboundProcessRef*string

Request

JavaScriptCurl

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

{
  "id": "text",
  "created": "2024-04-28T11:45:30.185Z",
  "lastModified": "2024-04-28T11:45:30.185Z",
  "orderDate": "2024-04-28T11:45:30.185Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2024-04-28T11:45:30.185Z"
  },
  "requestedItems": [
    {
      "tenantArticleId": "text",
      "quantity": {
        "unit": "text"
      }
    }
  ],
  "status": "OPEN",
  "cancelled": false,
  "supplier": {
    "name": "text"
  },
  "version": 0,
  "facilityRef": "text",
  "inboundProcessRef": "text"
}

Create a new Purchase Order

POST/api/purchaseorders

Body

application/json

orderDate*string (date-time)

requestedDate*InputRequestedDate (object)

requestedItems*array of InboundLineItem (object)

statusenum

OPEN

cancelledboolean

supplierInboundProcessPurchaseOrderSupplier (object)

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

Response

201401403

Created Purchase Order entity

Body

application/json

id*string

created*string (date-time)

lastModified*string (date-time)

orderDate*string (date-time)

requestedDate*RequestedDate (object)

requestedItems*array of InboundLineItem (object)

status*enum

OPEN

cancelled*boolean

supplierInboundProcessPurchaseOrderSupplier (object)

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.

version*number

facilityRef*string

inboundProcessRef*string

Request

JavaScriptCurl

const response = await fetch('/api/purchaseorders', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "orderDate": "2024-04-28T11:45:30.185Z",
      "requestedDate": {
        "type": "ASAP"
      },
      "requestedItems": [
        {
          "tenantArticleId": "text",
          "quantity": {}
        }
      ],
      "facilityRef": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "created": "2024-04-28T11:45:30.185Z",
  "lastModified": "2024-04-28T11:45:30.185Z",
  "orderDate": "2024-04-28T11:45:30.185Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2024-04-28T11:45:30.185Z"
  },
  "requestedItems": [
    {
      "tenantArticleId": "text",
      "quantity": {
        "unit": "text"
      }
    }
  ],
  "status": "OPEN",
  "cancelled": false,
  "supplier": {
    "name": "text"
  },
  "version": 0,
  "facilityRef": "text",
  "inboundProcessRef": "text"
}

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

PUT/api/inboundprocesses/{inboundProcessId}/purchaseorder

Path parameters

inboundProcessId*string

Body

application/json

orderDate*string (date-time)

requestedDate*InputRequestedDate (object)

requestedItems*array of InboundLineItem (object)

statusenum

OPEN

cancelledboolean

supplierInboundProcessPurchaseOrderSupplier (object)

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.

version*number

Response

200201401403

Purchase order successfully updated on inbound process

Body

application/json

id*string

created*string (date-time)

lastModified*string (date-time)

orderDate*string (date-time)

requestedDate*RequestedDate (object)

requestedItems*array of InboundLineItem (object)

status*enum

OPEN

cancelled*boolean

supplierInboundProcessPurchaseOrderSupplier (object)

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.

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "created": "2024-04-28T11:45:30.185Z",
  "lastModified": "2024-04-28T11:45:30.185Z",
  "orderDate": "2024-04-28T11:45:30.185Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2024-04-28T11:45:30.185Z"
  },
  "requestedItems": [
    {
      "tenantArticleId": "text",
      "quantity": {
        "unit": "text"
      }
    }
  ],
  "status": "OPEN",
  "cancelled": false,
  "supplier": {
    "name": "text"
  }
}

Receipt

Provides metadata for currently available artifacts for a platform

GET/api/artifacts/{platform}

Path parameters

platform*enum

Platform for which to list artifacts

android

Response

200400401403

All available artifacts for the selected platform

Body

application/json

artifacts*array of ArtifactMetadataItem (object)

platform*string

Platform name for which the artifact list is generated

Request

JavaScriptCurl

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

Response

{
  "artifacts": [
    {
      "buildDate": "2020-02-03T08:45:50.525Z",
      "download": {
        "expiration": "2020-02-03T08:45:50.525Z",
        "url": "text"
      },
      "versionCode": 42,
      "versionName": "1.0.42"
    }
  ],
  "platform": "android"
}

Adds a receipt to an inbound process.

POST/api/inboundprocesses/{inboundProcessId}/receipts

Path parameters

inboundProcessId*string

Body

application/json

asnRefstring

receivedDate*string (date-time)

receivedItems*array of InboundReceiptLineItem (object)

comments*array of InboundReceiptComment (object)

statusenum

IN_PROGRESSFINISHED

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.

Response

201401403

Receipt was added to the inbound process

Body

application/json

asnRefstring

receivedDate*string (date-time)

receivedItems*array of InboundReceiptLineItem (object)

comments*array of InboundReceiptComment (object)

statusenum

IN_PROGRESSFINISHED

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

Request

JavaScriptCurl

const response = await fetch('/api/inboundprocesses/{inboundProcessId}/receipts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "receivedDate": "2024-04-28T11:45:30.185Z",
      "receivedItems": [
        {
          "tenantArticleId": "text",
          "acceptedQuantity": {},
          "rejectedQuantity": {},
          "comments": [
            {
              "content": "text"
            }
          ]
        }
      ],
      "comments": [
        {
          "content": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "asnRef": "text",
  "receivedDate": "2024-04-28T11:45:30.185Z",
  "receivedItems": [
    {
      "tenantArticleId": "text",
      "acceptedQuantity": {
        "unit": "text"
      },
      "rejectedQuantity": {
        "unit": "text"
      },
      "comments": [
        {
          "userRef": "text",
          "content": "text",
          "attachments": [
            {
              "inboundAttachmentRef": "text"
            }
          ]
        }
      ],
      "storageLocationRef": "text",
      "stockProperties": {
        "expiry": "text",
        "receiptDate": "text"
      }
    }
  ],
  "comments": [
    {
      "userRef": "text",
      "content": "text",
      "attachments": [
        {
          "inboundAttachmentRef": "text"
        }
      ]
    }
  ],
  "status": "IN_PROGRESS",
  "id": "text"
}

Get InboundReceiptJobs

GET/api/inboundreceiptjobs

Query parameters

Response

200401403

Paginated Inbound Receipt Jobs

Body

application/json

total*number

inboundReceiptJobs*array of InboundReceiptJob (object)

Request

JavaScriptCurl

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

Response

{
  "total": 0,
  "inboundReceiptJobs": [
    {
      "id": "text",
      "facilityRef": "text",
      "inboundProcessRef": "text",
      "originReadableName": "text",
      "originReadableId": "text",
      "status": "OPEN",
      "expectedDate": {
        "type": "ASAP",
        "value": "2024-04-28T11:45:30.185Z"
      },
      "items": {
        "tenantArticleId": "text",
        "quantity": {
          "unit": "text"
        }
      },
      "origin": {
        "name": "text"
      }
    }
  ]
}

Get an Inbound Receipt Job by ID

GET/api/inboundreceiptjobs/{inboundEntryId}

Path parameters

inboundEntryId*string

Response

200401403

Body

application/json

id*string

facilityRef*string

inboundProcessRef*string

originReadableNamestring

originReadableIdstring

status*enum

OPENPARTIAL_DELIVERYON_HOLDCLOSED

expectedDate*RequestedDate (object)

items*InboundLineItem (object)

origin*InboundReceiptJobOrigin (object)

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "facilityRef": "text",
  "inboundProcessRef": "text",
  "originReadableName": "text",
  "originReadableId": "text",
  "status": "OPEN",
  "expectedDate": {
    "type": "ASAP",
    "value": "2024-04-28T11:45:30.185Z"
  },
  "items": {
    "tenantArticleId": "text",
    "quantity": {
      "unit": "text"
    }
  },
  "origin": {
    "name": "text"
  }
}

Creates a receipt

POST/api/receipts

Body

application/json

asnRefstring

receivedDate*string (date-time)

receivedItems*array of InboundReceiptLineItem (object)

comments*array of InboundReceiptComment (object)

statusenum

IN_PROGRESSFINISHED

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

Response

201401403

Created inbound receipt

Body

application/json

asnRefstring

receivedDate*string (date-time)

receivedItems*array of InboundReceiptLineItem (object)

comments*array of InboundReceiptComment (object)

statusenum

IN_PROGRESSFINISHED

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

version*number

created*string (date-time)

lastModified*string (date-time)

Request

JavaScriptCurl

const response = await fetch('/api/receipts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "receivedDate": "2024-04-28T11:45:30.185Z",
      "receivedItems": [
        {
          "tenantArticleId": "text",
          "acceptedQuantity": {},
          "rejectedQuantity": {},
          "comments": [
            {
              "content": "text"
            }
          ]
        }
      ],
      "comments": [
        {
          "content": "text"
        }
      ],
      "facilityRef": "text"
    }),
});
const data = await response.json();

Response

{
  "asnRef": "text",
  "receivedDate": "2024-04-28T11:45:30.185Z",
  "receivedItems": [
    {
      "tenantArticleId": "text",
      "acceptedQuantity": {
        "unit": "text"
      },
      "rejectedQuantity": {
        "unit": "text"
      },
      "comments": [
        {
          "userRef": "text",
          "content": "text",
          "attachments": [
            {
              "inboundAttachmentRef": "text"
            }
          ]
        }
      ],
      "storageLocationRef": "text",
      "stockProperties": {
        "expiry": "text",
        "receiptDate": "text"
      }
    }
  ],
  "comments": [
    {
      "userRef": "text",
      "content": "text",
      "attachments": [
        {
          "inboundAttachmentRef": "text"
        }
      ]
    }
  ],
  "status": "IN_PROGRESS",
  "id": "text",
  "inboundProcessRef": "text",
  "version": 0,
  "created": "2024-04-28T11:45:30.185Z",
  "lastModified": "2024-04-28T11:45:30.185Z"
}

Get receipt by id

GET/api/receipts/{receiptId}

Path parameters

receiptId*string

Response

200401403404

Body

application/json

asnRefstring

receivedDate*string (date-time)

receivedItems*array of InboundReceiptLineItem (object)

comments*array of InboundReceiptComment (object)

statusenum

IN_PROGRESSFINISHED

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

version*number

created*string (date-time)

lastModified*string (date-time)

Request

JavaScriptCurl

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

Response

{
  "asnRef": "text",
  "receivedDate": "2024-04-28T11:45:30.185Z",
  "receivedItems": [
    {
      "tenantArticleId": "text",
      "acceptedQuantity": {
        "unit": "text"
      },
      "rejectedQuantity": {
        "unit": "text"
      },
      "comments": [
        {
          "userRef": "text",
          "content": "text",
          "attachments": [
            {
              "inboundAttachmentRef": "text"
            }
          ]
        }
      ],
      "storageLocationRef": "text",
      "stockProperties": {
        "expiry": "text",
        "receiptDate": "text"
      }
    }
  ],
  "comments": [
    {
      "userRef": "text",
      "content": "text",
      "attachments": [
        {
          "inboundAttachmentRef": "text"
        }
      ]
    }
  ],
  "status": "IN_PROGRESS",
  "id": "text",
  "inboundProcessRef": "text",
  "version": 0,
  "created": "2024-04-28T11:45:30.185Z",
  "lastModified": "2024-04-28T11:45:30.185Z"
}