Inbound (Inventory)

Endpoints to create, update and read inbound processes and receipts.

List inbound processes

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
sizenumber · min: 1 · max: 100OptionalDefault: 25
startAfterIdstringOptional
sortstring · enumOptionalPossible values:
facilityRefstring[]Optional
scannableCodestringOptional
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
Responses
chevron-right
200

Paginated result containing the matching Inbound Process entities

application/json

InboundProcessPaginatedResult

totalnumberOptional

The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.

get
/api/inboundprocesses

Create inbound process

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

InboundProcessForCreation

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

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
chevron-right
200

Created Inbound Process entity

application/json

InboundProcess

anonymizedbooleanRequired

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

createdstring · date-timeRequired
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
idstringRequired
inboundDatestring · date-time[]Required

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

lastModifiedstring · date-timeRequired
onHoldbooleanRequired

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

scannableCodesstring[]Required

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

statusstring · enumRequiredPossible values:
tenantInboundProcessIdstringOptional
versionnumberRequired
post
/api/inboundprocesses

Get inbound process

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
inboundProcessIdstringRequired
Responses
chevron-right
200

Requested Inbound Process entity

application/json

InboundProcess

anonymizedbooleanRequired

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

createdstring · date-timeRequired
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
idstringRequired
inboundDatestring · date-time[]Required

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

lastModifiedstring · date-timeRequired
onHoldbooleanRequired

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

scannableCodesstring[]Required

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

statusstring · enumRequiredPossible values:
tenantInboundProcessIdstringOptional
versionnumberRequired
get
/api/inboundprocesses/{inboundProcessId}

Delete inbound process

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
inboundProcessIdstringRequired
Responses
chevron-right
200

Inbound Process successfully deleted

No content

delete
/api/inboundprocesses/{inboundProcessId}

No content

Update inbound process

patch

This part of the API is in Beta status. For details please check the api-release-life-cycle documentationarrow-up-right.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
inboundProcessIdstringRequired
Body

InboundProcessForPatch

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.

onHoldbooleanOptional

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

scannableCodesstring[]Optional

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

versionnumberRequired
Responses
chevron-right
200

Inbound Process successfully patched

No content

patch
/api/inboundprocesses/{inboundProcessId}

No content

Update purchase order

put

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
inboundProcessIdstringRequired
Body

InboundProcessPurchaseOrderForUpsert

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.

statusstring · enumOptionalPossible values:
versionnumberRequired
Responses
chevron-right
200

Purchase order successfully updated on inbound process

application/json

InboundProcessPurchaseOrder

cancelledbooleanRequiredDeprecated

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.

createdstring · date-timeRequired
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.

idstringRequired
lastModifiedstring · date-timeRequired
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.

statusstring · enumRequiredPossible values:
put
/api/inboundprocesses/{inboundProcessId}/purchaseorder

Create inbound process receipt

post

Adds a receipt to an inbound process.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
inboundProcessIdstringRequired
Body

InboundReceiptForCreation

asnRefstringOptional

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

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

statusstring · enumOptional

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

Possible values:
Responses
post
/api/inboundprocesses/{inboundProcessId}/receipts

Create attachment

post

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentationarrow-up-right.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

InboundAttachmentForCreation

contentstringRequired

Base64 encoded attachment file

fileNamestringRequired

File name of attachment

Responses
post
/api/inboundprocesses/attachments

Get signed attachment url

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentationarrow-up-right.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
attachmentIdstringRequired
Responses
chevron-right
200

Signed url

application/json
stringOptional
get
/api/inboundprocesses/attachments/{attachmentId}/signedurl

List inbound processes (search)

post

Search for InboundProcess

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

InboundProcessSearchPayload

afterstringOptional

The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.

beforestringOptional

The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).

lastnumber · min: 1 · max: 250Optional

Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.

sizenumber · min: 1 · max: 250Optional

Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.

startAfterIdstringOptionalDeprecated

The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.

Responses
chevron-right
200

Your search result

application/json

InboundProcessPaginatedResult

totalnumberOptional

The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.

post
/api/inboundprocesses/search

List inbound receipt jobs

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentationarrow-up-right.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
sizenumber · min: 1 · max: 100OptionalDefault: 25
startAfterIdstringOptional
facilityRefstring[]Optional
searchTermstring · min: 1Optional
searchTermExactstring · min: 1Optional
fromDatestring · date-timeOptional
toDatestring · date-timeOptional
Responses
chevron-right
200

Paginated Inbound Receipt Jobs

application/json

InboundReceiptJobPaginatedResult

totalnumberRequired
get
/api/inboundreceiptjobs

Get inbound receipt job

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentationarrow-up-right.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
inboundEntryIdstringRequired
Responses
chevron-right
200Success
application/json

InboundReceiptJob

facilityRefstringRequired
idstringRequired
inboundProcessRefstringRequired
originReadableIdstringOptional
originReadableNamestringOptional
statusstring · enumRequiredPossible values:
get
/api/inboundreceiptjobs/{inboundEntryId}

Create purchase order

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

PurchaseOrderForCreation

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.

statusstring · enumOptionalPossible values:
Responses
post
/api/purchaseorders

Get purchase order

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
purchaseOrderIdstringRequired
Responses
chevron-right
200

Purchase Order entity

application/json

PurchaseOrder

cancelledbooleanRequiredDeprecated

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.

createdstring · date-timeRequired
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
idstringRequired
inboundProcessRefstringRequired
lastModifiedstring · date-timeRequired
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.

statusstring · enumRequiredPossible values:
versionnumberRequired
get
/api/purchaseorders/{purchaseOrderId}

Update purchase order

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
purchaseOrderIdstringRequired
Body

PurchaseOrderForUpdate

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.

statusstring · enumOptionalPossible values:
versionnumberRequired
Responses
chevron-right
200

Updated/created Purchase Order entity

application/json

PurchaseOrder

cancelledbooleanRequiredDeprecated

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.

createdstring · date-timeRequired
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
idstringRequired
inboundProcessRefstringRequired
lastModifiedstring · date-timeRequired
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.

statusstring · enumRequiredPossible values:
versionnumberRequired
put
/api/purchaseorders/{purchaseOrderId}

Updates purchase order

patch

Partially updates a Purchase Order using a selection of fields

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
purchaseOrderIdstringRequired
Body

PurchaseOrderForPartialUpdate

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
statusstring · enumOptionalPossible values:
versionnumberRequired
Responses
chevron-right
200

Updated Purchase Order entity

application/json

PurchaseOrder

cancelledbooleanRequiredDeprecated

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.

createdstring · date-timeRequired
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
idstringRequired
inboundProcessRefstringRequired
lastModifiedstring · date-timeRequired
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.

statusstring · enumRequiredPossible values:
versionnumberRequired
patch
/api/purchaseorders/{purchaseOrderId}

Create receipt

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

ReceiptForCreation

asnRefstringOptional

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

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

statusstring · enumOptional

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

Possible values:
Responses
post
/api/receipts

Get receipt

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
receiptIdstringRequired
Responses
chevron-right
200Success
application/json

Receipt

asnRefstringOptional

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

createdstring · date-timeRequired
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.

idstringRequired
inboundProcessRefstringRequired
lastModifiedstring · date-timeRequired
receivedDatestring · date-timeRequired

date-time of the arrival of the items 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.

Possible values:
versionnumberRequired
get
/api/receipts/{receiptId}

Update receipt

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
receiptIdstringRequired
Body

InboundReceiptForUpdate

asnRefstringOptional

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

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

statusstring · enumOptional

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

Possible values:
versionnumberRequired
Responses
chevron-right
200Success
application/json

Receipt

asnRefstringOptional

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

createdstring · date-timeRequired
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.

idstringRequired
inboundProcessRefstringRequired
lastModifiedstring · date-timeRequired
receivedDatestring · date-timeRequired

date-time of the arrival of the items 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.

Possible values:
versionnumberRequired
put
/api/receipts/{receiptId}

Delete receipt

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
receiptIdstringRequired
Query parameters
versionnumberRequired
Responses
chevron-right
200Success
application/json

Receipt

asnRefstringOptional

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

createdstring · date-timeRequired
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.

idstringRequired
inboundProcessRefstringRequired
lastModifiedstring · date-timeRequired
receivedDatestring · date-timeRequired

date-time of the arrival of the items 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.

Possible values:
versionnumberRequired
delete
/api/receipts/{receiptId}

Update receipt

patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
receiptIdstringRequired
Body

InboundReceiptForPatch

asnRefstringOptional

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

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-timeOptional

date-time of the arrival of the items 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.

Possible values:
versionnumberRequired
Responses
chevron-right
200Success
application/json

Receipt

asnRefstringOptional

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

createdstring · date-timeRequired
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.

idstringRequired
inboundProcessRefstringRequired
lastModifiedstring · date-timeRequired
receivedDatestring · date-timeRequired

date-time of the arrival of the items 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.

Possible values:
versionnumberRequired
patch
/api/receipts/{receiptId}

Last updated