Process endpoints
ID of process you want to reroute
Version of process you want to reroute
The id of the rerouteDescription
Process was found the corresponding reroute operations have been triggered.
Process
The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZThe version of the document to be used in optimistic locking mechanisms.
42The date that defines when the entities will be or have been deleted.
2020-02-03T08:45:50.525ZReferences to documents that are attached to this process.
Overall DOMS status of the process.
CREATEDPossible values: References to the external actions connected to this process (if any).
References of the Facilities connected to this process (if any).
This field references all IDs of any entity connected to this process.
The date that defines when the entities will be or have been anonymized.
2020-02-03T08:45:50.525ZReferences to Handoverjobs connected to this process (if present).
ID of this process
Overall inventory status of the process
CREATEDPossible values: Indicates if the entities have been anonymized.
References to the Item Return Job connected to this process (if present).
Overall operative status of the process
CREATEDPossible values: References to the Order connected to this process (if present).
References of the Packjobs connected to this process (if present).
References to the Pickjobs connected to this process (if present).
References to the Returns connected to this process (if present).
Overall return status of the process
NOT_AVAILABLEPossible values: References the RoutingPlans that were used during this process (if present).
References to the Service Jobs connected to this process (if present).
References to the Shipments connected to this process (if present).
Overall status of the process.
CREATEDPossible values: The tenantOrderId referencing this process.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Process not found
Process version conflict
ID of process you want to patch
ProcessPatchActions
The version of the document to be used in optimistic locking mechanisms.
42Process was found & patch-set has been applied. The patched process is in the body.
Process
The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZThe version of the document to be used in optimistic locking mechanisms.
42The date that defines when the entities will be or have been deleted.
2020-02-03T08:45:50.525ZReferences to documents that are attached to this process.
Overall DOMS status of the process.
CREATEDPossible values: References to the external actions connected to this process (if any).
References of the Facilities connected to this process (if any).
This field references all IDs of any entity connected to this process.
The date that defines when the entities will be or have been anonymized.
2020-02-03T08:45:50.525ZReferences to Handoverjobs connected to this process (if present).
ID of this process
Overall inventory status of the process
CREATEDPossible values: Indicates if the entities have been anonymized.
References to the Item Return Job connected to this process (if present).
Overall operative status of the process
CREATEDPossible values: References to the Order connected to this process (if present).
References of the Packjobs connected to this process (if present).
References to the Pickjobs connected to this process (if present).
References to the Returns connected to this process (if present).
Overall return status of the process
NOT_AVAILABLEPossible values: References the RoutingPlans that were used during this process (if present).
References to the Service Jobs connected to this process (if present).
References to the Shipments connected to this process (if present).
Overall status of the process.
CREATEDPossible values: The tenantOrderId referencing this process.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Process not found
Process version conflict
ProcessSearchPayload
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.
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).
Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.
Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.
The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.
Your search result
ProcessPaginatedResult
The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this
Process belonging to the given parameters
Process
The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZThe version of the document to be used in optimistic locking mechanisms.
42The date that defines when the entities will be or have been deleted.
2020-02-03T08:45:50.525ZReferences to documents that are attached to this process.
Overall DOMS status of the process.
CREATEDPossible values: References to the external actions connected to this process (if any).
References of the Facilities connected to this process (if any).
This field references all IDs of any entity connected to this process.
The date that defines when the entities will be or have been anonymized.
2020-02-03T08:45:50.525ZReferences to Handoverjobs connected to this process (if present).
ID of this process
Overall inventory status of the process
CREATEDPossible values: Indicates if the entities have been anonymized.
References to the Item Return Job connected to this process (if present).
Overall operative status of the process
CREATEDPossible values: References to the Order connected to this process (if present).
References of the Packjobs connected to this process (if present).
References to the Pickjobs connected to this process (if present).
References to the Returns connected to this process (if present).
Overall return status of the process
NOT_AVAILABLEPossible values: References the RoutingPlans that were used during this process (if present).
References to the Service Jobs connected to this process (if present).
References to the Shipments connected to this process (if present).
Overall status of the process.
CREATEDPossible values: The tenantOrderId referencing this process.
The given parameters are invalid
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Entity not found
The found process.
Process
The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZThe version of the document to be used in optimistic locking mechanisms.
42The date that defines when the entities will be or have been deleted.
2020-02-03T08:45:50.525ZReferences to documents that are attached to this process.
Overall DOMS status of the process.
CREATEDPossible values: References to the external actions connected to this process (if any).
References of the Facilities connected to this process (if any).
This field references all IDs of any entity connected to this process.
The date that defines when the entities will be or have been anonymized.
2020-02-03T08:45:50.525ZReferences to Handoverjobs connected to this process (if present).
ID of this process
Overall inventory status of the process
CREATEDPossible values: Indicates if the entities have been anonymized.
References to the Item Return Job connected to this process (if present).
Overall operative status of the process
CREATEDPossible values: References to the Order connected to this process (if present).
References of the Packjobs connected to this process (if present).
References to the Pickjobs connected to this process (if present).
References to the Returns connected to this process (if present).
Overall return status of the process
NOT_AVAILABLEPossible values: References the RoutingPlans that were used during this process (if present).
References to the Service Jobs connected to this process (if present).
References to the Shipments connected to this process (if present).
Overall status of the process.
CREATEDPossible values: The tenantOrderId referencing this process.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Entity not found
all entities after given Id
number of entities to show
25control whether you want to filter consecutive duplicate logs
trueThe process logs which were found in response body
ProcessHistoryLogs
Total number of found entities for this query
3Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
ExternalDocumentForCreation
Section
DocumentType
The document was successfully created
Invalid input. See response for details
InboundProcessSearchPayload
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.
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).
Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.
Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.
The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.
Your search result
InboundProcessPaginatedResult
The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this
InboundProcessForCreation
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.
Facility in which the inbound process takes place
Indicates if the inbound process is on hold and will not be processed further
scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note
Identifier of the process provided by the tenant system. It is recommended to be unique
Created Inbound Process entity
InboundProcess
Indicates the inbound process was anonymized acording to configured GDPR retention time.
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.
Aggregated dates from sources which advise incoming stock. Currently that is "purchaseOrder"
Indicates if the inbound process is on hold and will not be processed further
scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this
The document meta information with given id attached to the selected process
ExternalDocument
The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZThe version of the document to be used in optimistic locking mechanisms.
42Section
DocumentType
The document meta information with given id attached to the selected process
ExternalDocumentForUpdate
The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZThe version of the document to be used in optimistic locking mechanisms.
42The document was successfully updated
ExternalDocument
The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZThe version of the document to be used in optimistic locking mechanisms.
42Section
DocumentType
Invalid input. See response for details
The document with given id attached to the selected process
The document with given id attached to the selected process
InboundReceiptForCreation
enables mapping a receipt to one of the ASNs in this inbound process
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.
date-time of the arrival of the items in the facility
status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.
Receipt was added to the inbound process
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this
InboundProcessForPatch
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.
Indicates if the inbound process is on hold and will not be processed further
scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note
Inbound Process successfully patched
No content
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this
No content
Requested Inbound Process entity
InboundProcess
Indicates the inbound process was anonymized acording to configured GDPR retention time.
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.
Aggregated dates from sources which advise incoming stock. Currently that is "purchaseOrder"
Indicates if the inbound process is on hold and will not be processed further
scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this
25Matches 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
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
Paginated result containing the matching Inbound Process entities
InboundProcessPaginatedResult
The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this
Inbound Process successfully deleted
No content
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this
No content
The retry for all not routable proceses has been succesfully triggered
The retry task can not be triggered due to a conflicting operation
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
No content
InboundProcessPurchaseOrderForUpsert
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.
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.
Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.
Purchase order successfully updated on inbound process
InboundProcessPurchaseOrder
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.
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.
Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.
Purchase order successfully created on inbound process
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this
facility to filter the results
entity to start after
number of entities to show
25All operative processes matching the given parameters
OperativeProcessPaginatedResult
Invalid input. See response for details.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this
The requested entity was not found
Found operativeProcess by given ID
OperativeProcess
The timestamp when the operative process was created.
Reference to the facility this operative process is associated with.
Entities involved in this operative process represented as a flat list of entity references.
auto generated unique identifier
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.
The timestamp when the operative process was last modified.
Reference to the process this operative process is associated with.
Reference to the routing plan this operative process is associated with.
The version number of the operative process. This number is incremented each time the operative process is modified.
1Invalid input. See response for details.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this
The requested entity was not found
Last updated