Processes (Core)

A process groups all entities of an order.

List brands

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

all entities after given Id

sizeintegerOptional

number of entities to show

Default: 25
Responses
get
/api/brands

Get file

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
documentIdstringRequired
Responses
get
/api/documents/{documentId}/file
200

The document with given id

No content

Get process

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
tenantOrderIdstringOptional
orderRefstringOptional
pickJobRefstringOptional
shipmentRefstringOptional
handoverJobRefstringOptional
returnRefstringOptional
Responses
get
/api/process
Deprecated

List processes

get

This part of the API is deprecated. For details please check the api-release-life-cycle documentationarrow-up-right. No longer supported legacy processes endpoint. Please use /api/processes/search instead.

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

all entities after given Id

sizeintegerOptional

number of entities to show

Default: 25
statusstring[]Optional

Reference to the status you want to get the corresponding processes

operativeStatusstring[]Optional

Reference to the operativeStatus you want to get the corresponding processes

trackingStatusstring[]Optional

Reference to the trackingStatus you want to get the corresponding processes

tenantOrderIdstringOptional

Perform full text search based on the tenantOrderId

consumerIdstringOptional

Perform full text search based on the consumerId

startTargetTimestring · date-timeOptional

Return the Processes which have related pickjobs with a targettime on or after this date

Example: 2020-02-03T08:45:50.525Z
endTargetTimestring · date-timeOptional

Return the Processes which have related pickjobs with a targettime on or before this date

Example: 2020-02-03T08:45:50.525Z
startDatestring · date-timeOptional

Return the Processes created on or after this date. If no start date is specified, the default is last 30 days.

Example: 2020-02-03T08:45:50.525Z
endDatestring · date-timeOptional

Return the Processes created on or before this date

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

Id's of the facilities from which you want to get the processes

facilityRefsWithActiveOperationsstring[]Optional

Id's of the active facilities based on processes from which you want to get the processes

countriesstring[]Optional

Consumer country codes from which you want to get the processes

facilityCountriesstring[]Optional

Facility country codes from which you want to get the processes

brandRefsstring[]Optional

Brand ids for which you want to get the processes

orderDomainStatusstring[]Optional

Reference to the orderDomainStatus you want to get the corresponding processes

routingDomainStatusstring[]Optional

Reference to the routingDomainStatus you want to get the corresponding processes

pickingDomainStatusstring[]Optional

Reference to the pickingDomainStatus you want to get the corresponding processes

packingDomainStatusstring[]Optional

Reference to the packingDomainStatus you want to get the corresponding processes

shippingDomainStatusstring[]Optional

Reference to the shippingDomainStatus you want to get the corresponding processes

handoverDomainStatusstring[]Optional

Reference to the handoverDomainStatus you want to get the corresponding processes

returnDomainStatusstring[]Optional

Reference to the returnDomainStatus you want to get the corresponding processes

stickersstring[]Optional

Stickers attached to a order

searchTermstringOptional

Perform full text search over all searchable attributes

sortBystring · enumOptional

SortParameterName

Possible values:
sortByDirectionstring · enumOptional

SortDirection

Possible values:
lockedbooleanOptional

@deprecated Use orderStatus instead

orderStatusstring · enumOptional

The state of the order. Initially it is OPEN.

Possible values:
Responses
get
/api/processes

Get process

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
processIdstringRequired
Responses
get
/api/processes/{processId}

Update process

patch
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
patch
/api/processes/{processId}

Create process document

post

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
processIdstringRequired
Body

ExternalDocumentForCreation

prioritynumberOptional
sectionstring · enumRequired

Section

Possible values:
typestring · enumRequired

DocumentType

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

Get process document

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
processIdstringRequired
documentIdstringRequired
Responses
get
/api/processes/{processId}/documents/{documentId}
200

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

Download process file

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
processIdstringRequired
documentIdstringRequired
Responses
get
/api/processes/{processId}/documents/{documentId}/file
200

The document with given id attached to the selected process

Update process file

put

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
processIdstringRequired
documentIdstringRequired
Body

ExternalDocumentForUpdate

Responses
put
/api/processes/{processId}/documents/{documentId}/file

Get process history logs

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentationarrow-up-right. Return all logs for a given process.

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

all entities after given Id

sizeintegerOptional

number of entities to show

Default: 25
filterConsecutiveDuplicatesbooleanOptional

control whether you want to filter consecutive duplicate logs

Default: true
Responses
get
/api/processes/{processId}/historylogs

Create process reroute

post
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
post
/api/processes/{processId}/reroute

Create retry not routable

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
chevron-right
204

The retry for all not routable proceses has been succesfully triggered

No content

post
/api/processes/retrynotroutable

No content

List processes (search)

post

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentationarrow-up-right. 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.

startAfterIdstringOptionalDeprecated

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

Responses
post
/api/processes/search

Last updated