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
200
All brands on listings for this tenant
application/json
StrippedBrands
totalintegerOptional
Total number of found entities for this query
Example: 42
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
get
/api/brands
Get file
get
Download a file by its id
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
documentIdstringRequired
Responses
200
The document with given id
No content
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this
application/json
404
The requested entity was not found
application/json
get
/api/documents/{documentId}/file
No content
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
Overall DOMS status of the process.
Default: CREATEDPossible 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
Overall inventory status of the process
Default: CREATEDPossible 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
Overall operative status of the process
Default: CREATEDPossible 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
Overall return status of the process
Default: NOT_AVAILABLEPossible 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
Overall status of the process.
Default: CREATEDPossible values:
tenantOrderIdstringOptional
The tenantOrderId referencing this process.
400
The given parameters are invalid
application/json
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
Entity not found
application/json
get
/api/process
Deprecated
List processes
get
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
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
200
Process are found.
application/json
Processes
totalintegerOptional
Total number of found entities for this query
Example: 42
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
get
/api/processes
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
Overall DOMS status of the process.
Default: CREATEDPossible 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
Overall inventory status of the process
Default: CREATEDPossible 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
Overall operative status of the process
Default: CREATEDPossible 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
Overall return status of the process
Default: NOT_AVAILABLEPossible 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
Overall status of the process.
Default: CREATEDPossible values:
tenantOrderIdstringOptional
The tenantOrderId referencing this process.
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
Entity not found
application/json
get
/api/processes/{processId}
Deprecated
Update process
patch
This part of the API is deprecated. For details please check the api-release-life-cycle 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
Overall DOMS status of the process.
Default: CREATEDPossible 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
Overall inventory status of the process
Default: CREATEDPossible 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
Overall operative status of the process
Default: CREATEDPossible 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
Overall return status of the process
Default: NOT_AVAILABLEPossible 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
Overall status of the process.
Default: CREATEDPossible values:
tenantOrderIdstringOptional
The tenantOrderId referencing this process.
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
Process not found
application/json
409
Process version conflict
application/json
patch
/api/processes/{processId}
Call process action
post
Update Process by calling an action. This can be used to trigger state transitions or other operations on the process.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
processIdstringRequired
ID of process you want to call the action for
Body
ProcessActionsParameter
or
or
or
Responses
200
Updated Process 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
Overall DOMS status of the process.
Default: CREATEDPossible 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
Overall inventory status of the process
Default: CREATEDPossible 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
Overall operative status of the process
Default: CREATEDPossible 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
Overall return status of the process
Default: NOT_AVAILABLEPossible 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
Overall status of the process.
Default: CREATEDPossible values:
tenantOrderIdstringOptional
The tenantOrderId referencing this process.
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
Process not found
application/json
409
Process version conflict
application/json
post
/api/processes/{processId}/actions
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
400
Invalid input. See response for details
application/json
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 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
Download process file
get
This part of the API is in Beta status. For details please check the api-release-life-cycle 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
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
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.
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this