Ctrlk
API documentationIncident managementFeedback
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Process endpoints

Create process reroute

post

Reroute a process to a different facility.

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

ID of process you want to reroute

Query parameters
versionnumberRequired

Version of process you want to reroute

rerouteDescriptionIdstringOptional

The id of the rerouteDescription

Responses
200

Process was found the corresponding reroute operations have been triggered.

application/json

Process

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z
lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z
versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42
deletionDatestring · date-timeOptional

The date that defines when the entities will be or have been deleted.

Example: 2020-02-03T08:45:50.525Z
documentRefsstring[]Optional

References to documents that are attached to this process.

domsStatusstring · enumOptional

ProcessStatus

Possible values:
externalActionRefsstring[]Optional

References to the external actions connected to this process (if any).

facilityRefsstring[]Optional

References of the Facilities connected to this process (if any).

flatRefsstring[]Optional

This field references all IDs of any entity connected to this process.

gdprCleanupDatestring · date-timeRequired

The date that defines when the entities will be or have been anonymized.

Example: 2020-02-03T08:45:50.525Z
handoverJobRefsstring[]Optional

References to Handoverjobs connected to this process (if present).

idstringRequired

ID of this process

inventoryStatusstring · enumOptional

ProcessStatus

Possible values:
isAnonymizedbooleanOptional

Indicates if the entities have been anonymized.

itemReturnJobsRefstring[]Optional

References to the Item Return Job connected to this process (if present).

operativeStatusstring · enumOptional

ProcessStatus

Possible values:
orderRefstringOptional

References to the Order connected to this process (if present).

packJobRefsstring[]Optional

References of the Packjobs connected to this process (if present).

pickJobRefsstring[]Optional

References to the Pickjobs connected to this process (if present).

returnRefsstring[]Optional

References to the Returns connected to this process (if present).

returnStatusstring · enumOptional

ProcessStatus

Possible values:
routingPlanRefsstring[]Optional

References the RoutingPlans that were used during this process (if present).

serviceJobRefsstring[]Optional

References to the Service Jobs connected to this process (if present).

shipmentRefsstring[]Optional

References to the Shipments connected to this process (if present).

statusstring · enumOptional

ProcessStatus

Possible values:
tenantOrderIdstringOptional

The tenantOrderId referencing this process.

post/api/processes/{processId}/reroute
Deprecated

Update process

patch

This part of the API is deprecated. For details, see the API release lifecycle documentation. Deprecated, replaced with /api/processes/{processId}/actions

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

ID of process you want to patch

Body

ProcessPatchActions

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42
Responses
200

Process was found & patch-set has been applied. The patched process is in the body.

application/json

Process

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z
lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z
versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42
deletionDatestring · date-timeOptional

The date that defines when the entities will be or have been deleted.

Example: 2020-02-03T08:45:50.525Z
documentRefsstring[]Optional

References to documents that are attached to this process.

domsStatusstring · enumOptional

ProcessStatus

Possible values:
externalActionRefsstring[]Optional

References to the external actions connected to this process (if any).

facilityRefsstring[]Optional

References of the Facilities connected to this process (if any).

flatRefsstring[]Optional

This field references all IDs of any entity connected to this process.

gdprCleanupDatestring · date-timeRequired

The date that defines when the entities will be or have been anonymized.

Example: 2020-02-03T08:45:50.525Z
handoverJobRefsstring[]Optional

References to Handoverjobs connected to this process (if present).

idstringRequired

ID of this process

inventoryStatusstring · enumOptional

ProcessStatus

Possible values:
isAnonymizedbooleanOptional

Indicates if the entities have been anonymized.

itemReturnJobsRefstring[]Optional

References to the Item Return Job connected to this process (if present).

operativeStatusstring · enumOptional

ProcessStatus

Possible values:
orderRefstringOptional

References to the Order connected to this process (if present).

packJobRefsstring[]Optional

References of the Packjobs connected to this process (if present).

pickJobRefsstring[]Optional

References to the Pickjobs connected to this process (if present).

returnRefsstring[]Optional

References to the Returns connected to this process (if present).

returnStatusstring · enumOptional

ProcessStatus

Possible values:
routingPlanRefsstring[]Optional

References the RoutingPlans that were used during this process (if present).

serviceJobRefsstring[]Optional

References to the Service Jobs connected to this process (if present).

shipmentRefsstring[]Optional

References to the Shipments connected to this process (if present).

statusstring · enumOptional

ProcessStatus

Possible values:
tenantOrderIdstringOptional

The tenantOrderId referencing this process.

patch/api/processes/{processId}

List processes (search)

post

This part of the API is in Alpha status. For details, see the API release lifecycle documentation. Search for Process

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

ProcessSearchPayload

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.

Example: 10
startAfterIdstringOptionalDeprecated

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

Responses
200

Your search result

application/json

ProcessPaginatedResult

totalnumberOptional

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

post/api/processes/search

Get process

get

Get a process by query parameters such as order or pickJob reference

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
tenantOrderIdstringOptional
orderRefstringOptional
pickJobRefstringOptional
shipmentRefstringOptional
handoverJobRefstringOptional
returnRefstringOptional
Responses
200

Process belonging to the given parameters

application/json

Process

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z
lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z
versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42
deletionDatestring · date-timeOptional

The date that defines when the entities will be or have been deleted.

Example: 2020-02-03T08:45:50.525Z
documentRefsstring[]Optional

References to documents that are attached to this process.

domsStatusstring · enumOptional

ProcessStatus

Possible values:
externalActionRefsstring[]Optional

References to the external actions connected to this process (if any).

facilityRefsstring[]Optional

References of the Facilities connected to this process (if any).

flatRefsstring[]Optional

This field references all IDs of any entity connected to this process.

gdprCleanupDatestring · date-timeRequired

The date that defines when the entities will be or have been anonymized.

Example: 2020-02-03T08:45:50.525Z
handoverJobRefsstring[]Optional

References to Handoverjobs connected to this process (if present).

idstringRequired

ID of this process

inventoryStatusstring · enumOptional

ProcessStatus

Possible values:
isAnonymizedbooleanOptional

Indicates if the entities have been anonymized.

itemReturnJobsRefstring[]Optional

References to the Item Return Job connected to this process (if present).

operativeStatusstring · enumOptional

ProcessStatus

Possible values:
orderRefstringOptional

References to the Order connected to this process (if present).

packJobRefsstring[]Optional

References of the Packjobs connected to this process (if present).

pickJobRefsstring[]Optional

References to the Pickjobs connected to this process (if present).

returnRefsstring[]Optional

References to the Returns connected to this process (if present).

returnStatusstring · enumOptional

ProcessStatus

Possible values:
routingPlanRefsstring[]Optional

References the RoutingPlans that were used during this process (if present).

serviceJobRefsstring[]Optional

References to the Service Jobs connected to this process (if present).

shipmentRefsstring[]Optional

References to the Shipments connected to this process (if present).

statusstring · enumOptional

ProcessStatus

Possible values:
tenantOrderIdstringOptional

The tenantOrderId referencing this process.

get/api/process

Get process

get

Get a specific process by ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
processIdstringRequired
Responses
200

The found process.

application/json

Process

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z
lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z
versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42
deletionDatestring · date-timeOptional

The date that defines when the entities will be or have been deleted.

Example: 2020-02-03T08:45:50.525Z
documentRefsstring[]Optional

References to documents that are attached to this process.

domsStatusstring · enumOptional

ProcessStatus

Possible values:
externalActionRefsstring[]Optional

References to the external actions connected to this process (if any).

facilityRefsstring[]Optional

References of the Facilities connected to this process (if any).

flatRefsstring[]Optional

This field references all IDs of any entity connected to this process.

gdprCleanupDatestring · date-timeRequired

The date that defines when the entities will be or have been anonymized.

Example: 2020-02-03T08:45:50.525Z
handoverJobRefsstring[]Optional

References to Handoverjobs connected to this process (if present).

idstringRequired

ID of this process

inventoryStatusstring · enumOptional

ProcessStatus

Possible values:
isAnonymizedbooleanOptional

Indicates if the entities have been anonymized.

itemReturnJobsRefstring[]Optional

References to the Item Return Job connected to this process (if present).

operativeStatusstring · enumOptional

ProcessStatus

Possible values:
orderRefstringOptional

References to the Order connected to this process (if present).

packJobRefsstring[]Optional

References of the Packjobs connected to this process (if present).

pickJobRefsstring[]Optional

References to the Pickjobs connected to this process (if present).

returnRefsstring[]Optional

References to the Returns connected to this process (if present).

returnStatusstring · enumOptional

ProcessStatus

Possible values:
routingPlanRefsstring[]Optional

References the RoutingPlans that were used during this process (if present).

serviceJobRefsstring[]Optional

References to the Service Jobs connected to this process (if present).

shipmentRefsstring[]Optional

References to the Shipments connected to this process (if present).

statusstring · enumOptional

ProcessStatus

Possible values:
tenantOrderIdstringOptional

The tenantOrderId referencing this process.

get/api/processes/{processId}

Get process history logs

get

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Return all logs for a given process.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
processIdstringRequired
Query parameters
typestringOptional

A type parameter for filtering history logs

usernamestringOptional

Reference to the username you want to get the corresponding history logs

facilityNamestringOptional

Reference to the facility name you want to get the corresponding history logs

startAfterIdstringOptional

all entities after given Id

sizeintegerOptional

number of entities to show

Default: 25
orderBystring · enumOptional

Attribute to order a process history log by

Possible values:
filterConsecutiveDuplicatesbooleanOptional

control whether you want to filter consecutive duplicate logs

Default: true
Responses
200

The process logs which were found in response body

application/json

ProcessHistoryLogs

totalintegerOptional

Total number of found entities for this query

Example: 3
get/api/processes/{processId}/historylogs

Create process document

post

Add a document to a process.

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

ExternalDocumentForCreation

prioritynumberOptional
sectionstring · enumRequired

Section

Possible values:
typestring · enumRequired

DocumentType

Possible values:
Responses
201

The document was successfully created

application/json

ExternalDocument

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z
lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z
versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42
idstringRequired
namestringOptional
pathstringOptional
prioritynumberOptional
sectionstring · enumRequired

Section

Possible values:
typestring · enumRequired

DocumentType

Possible values:
post/api/processes/{processId}/documents

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.

Example: 10
startAfterIdstringOptionalDeprecated

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

Responses
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

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

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
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

Example: MY_INBOUNDPROCESS_ID
Responses
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"

Example: 2026-06-17T12:00:00.000Z
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 process document

get

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Get document metadata from a process.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
processIdstringRequired
documentIdstringRequired
Responses
200

The document meta information with given id attached to the selected process

application/json

ExternalDocument

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z
lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z
versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42
idstringRequired
namestringOptional
pathstringOptional
prioritynumberOptional
sectionstring · enumRequired

Section

Possible values:
typestring · enumRequired

DocumentType

Possible values:
get/api/processes/{processId}/documents/{documentId}
200

The document meta information with given id attached to the selected process

Update process file

put

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Update a document file in a process.

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

ExternalDocumentForUpdate

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z
lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z
versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42
Responses
200

The document was successfully updated

application/json

ExternalDocument

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z
lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z
versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42
idstringRequired
namestringOptional
pathstringOptional
prioritynumberOptional
sectionstring · enumRequired

Section

Possible values:
typestring · enumRequired

DocumentType

Possible values:
put/api/processes/{processId}/documents/{documentId}/file

Download process file

get

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Download a document file from a process.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
processIdstringRequired
documentIdstringRequired
Responses
200

The document with given id attached to the selected process

application/pdf
get/api/processes/{processId}/documents/{documentId}/file
200

The document with given id attached to the selected process

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

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
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

Example: 2026-06-17T12:00:00.000Z
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
201

Receipt was added to the inbound process

application/json

InboundReceipt

asnRefstringOptional

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

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
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
receivedDatestring · date-timeRequired

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

Example: 2026-06-17T12:00:00.000Z
statusstring · enumOptional

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

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

Update inbound process

patch

This part of the API is in Beta status. For details, see the API release lifecycle documentation.

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
200

Inbound Process successfully patched

No content
patch/api/inboundprocesses/{inboundProcessId}
No content

Get inbound process

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
inboundProcessIdstringRequired
Responses
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"

Example: 2026-06-17T12:00:00.000Z
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}

List inbound processes

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
sizenumber · min: 1 · max: 100OptionalDefault: 25Example: 25
startAfterIdstringOptional
sortstring · enumOptionalPossible values:
facilityRefstring[]OptionalExample: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
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
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

Delete inbound process

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

Inbound Process successfully deleted

No content
delete/api/inboundprocesses/{inboundProcessId}
No content

Create retry not routable

post

Retry routing for all not-routable processes.

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

The retry for all not routable proceses has been succesfully triggered

No content
post/api/processes/retrynotroutable
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.

Example: 2026-06-17T12:00:00.000Z
statusstring · enumOptionalPossible values:
versionnumberRequired
Responses
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.

Example: 2026-06-17T12:00:00.000Z
statusstring · enumRequiredPossible values:
put/api/inboundprocesses/{inboundProcessId}/purchaseorder

List operative processes

get

Get all operative processes

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
facilityIdstringRequired

facility to filter the results

startAfterIdstringOptional

entity to start after

sizeinteger · min: 1 · max: 500Optional

number of entities to show

Default: 25Example: 25
Responses
200

All operative processes matching the given parameters

application/json

OperativeProcessPaginatedResult

totalnumberRequired
get/api/operativeprocesses

Get operative process

get

Get the operative processes for a specific id

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
operativeProcessIdstringRequired
Responses
200

Found operativeProcess by given ID

application/json

OperativeProcess

createdstring · date-timeOptional

The timestamp when the operative process was created.

facilityRefstringRequired

Reference to the facility this operative process is associated with.

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
flatEntityRefsstring[]Required

Entities involved in this operative process represented as a flat list of entity references.

Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]
idstringRequired

auto generated unique identifier

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
isEditablebooleanOptional

This field indicates if the operative process is editable based on if any of the related pick jobs, service jobs, pack jobs or handover jobs are in progress or have been finished successfully. This field is calculated dynamically on each request.

lastModifiedstring · date-timeOptional

The timestamp when the operative process was last modified.

processRefstringRequired

Reference to the process this operative process is associated with.

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
routingPlanRefstringOptional

Reference to the routing plan this operative process is associated with.

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
versionnumberRequired

The version number of the operative process. This number is incremented each time the operative process is modified.

Example: 1
get/api/operativeprocesses/{operativeProcessId}

Last updated