Picking (Operations)
all entities after given Id
number of loadUnits to show
25query load units with the given pickJobRef
Provide the localized names and descriptions if found. If not provided the default locale is used. Example de_DE
de_DELoad units are found
LoadUnits
Total number of found entities for this query
42Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this
LoadUnitsForCreation
Load units are successfully created.
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
Reference to the pickJob of which you want to delete the loadUnits
Load unit ids
Load units are successfully deleted.
LoadUnits
Total number of found entities for this query
42Invalid 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
The syntax of the request content was correct, but it was unable to process the contained instructions, possibly due to semantic errors.
Provide the localized names and descriptions if found. If not provided the default locale is used. Example de_DE
LoadUnit
List of codes
Creation timestamp
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.
The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request
Esb20gpHBL94X5NdMp3CUnique identifier for the load unit
Last modification timestamp
Use operativeContainerTypeRef instead.
the reference to the operativeContainerType
List of corresponding pickjob Ids
the reference to the stackRef this loadUnit is part of
the reference to the storage location this load unit as been placed into
Version number for optimistic locking
Maximal weight in gramm(gr) the loadunit can handle.
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
Successfully deleted load unit.
LoadUnit
List of codes
Creation timestamp
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.
The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request
Esb20gpHBL94X5NdMp3CUnique identifier for the load unit
Last modification timestamp
Use operativeContainerTypeRef instead.
the reference to the operativeContainerType
List of corresponding pickjob Ids
the reference to the stackRef this loadUnit is part of
the reference to the storage location this load unit as been placed into
Version number for optimistic locking
Maximal weight in gramm(gr) the loadunit can handle.
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
The updated load unit
LoadUnit
List of codes
Creation timestamp
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.
The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request
Esb20gpHBL94X5NdMp3CUnique identifier for the load unit
Last modification timestamp
Use operativeContainerTypeRef instead.
the reference to the operativeContainerType
List of corresponding pickjob Ids
the reference to the stackRef this loadUnit is part of
the reference to the storage location this load unit as been placed into
Version number for optimistic locking
Maximal weight in gramm(gr) the loadunit can handle.
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
Updated Load Unit via actions
LoadUnit
List of codes
Creation timestamp
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.
The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request
Esb20gpHBL94X5NdMp3CUnique identifier for the load unit
Last modification timestamp
Use operativeContainerTypeRef instead.
the reference to the operativeContainerType
List of corresponding pickjob Ids
the reference to the stackRef this loadUnit is part of
the reference to the storage location this load unit as been placed into
Version number for optimistic locking
Maximal weight in gramm(gr) the loadunit can handle.
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
The found stack for this load unit.
Stack
The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZLinked Facilities through reference
Unique identifier of the Stack
The date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZLinked Processes through reference
The version of the document to be used in optimistic locking mechanisms.
42Your 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
Provide the localized names and descriptions if found. If not provided the default locale is used. Example de_DE
all entities after given Id
number of entities to show
All load unit types
LoadUnitType
Creation timestamp
Creation timestamp
This value gives the priority in the respective loadUnitType. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order loadUnityTypes
100Maximal weight in gramm(gr) the loadunit can handle.
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
Provide the localized names and descriptions if found. If not provided the default locale is used. Example de_DE
LoadUnitTypeForCreation
This value gives the priority in the respective loadUnitType. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order loadUnityTypes
100Maximal weight in gramm(gr) the loadunit can handle.
Successfully created resource.
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
Provide the localized names and descriptions if found. If not provided the default locale is used. Example de_DE
The found load unit type.
LoadUnitType
Creation timestamp
Creation timestamp
This value gives the priority in the respective loadUnitType. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order loadUnityTypes
100Maximal weight in gramm(gr) the loadunit can handle.
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
Provide the localized names and descriptions if found. If not provided the default locale is used. Example de_DE
LoadUnitTypePatchActions
The version of the document to be used in optimistic locking mechanisms.
42Load Unit Type updated successfully.
LoadUnitType
Creation timestamp
Creation timestamp
This value gives the priority in the respective loadUnitType. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order loadUnityTypes
100Maximal weight in gramm(gr) the loadunit can handle.
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
Provide the localized names and descriptions if found. If not provided the default locale is used. Example de_DE
NamedFile
File content base64 encoded
JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==File name with extension
example.pdfSuccessfully updated load unit type icon
LoadUnitType
Creation timestamp
Creation timestamp
This value gives the priority in the respective loadUnitType. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order loadUnityTypes
100Maximal weight in gramm(gr) the loadunit can handle.
Successfully created load unit type icon.
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
Search term you want to get the corresponding pickjobs. Search will be performed on multiple fields, like tenantOrderId, consumerName, tenantArticleId and more
Reference to the carrier you want to get the corresponding pickjobs
Reference to the orderDate you want to get the corresponding pickjobs
Reference to the orderDate you want to get the corresponding pickjobs
Reference to the order you want to get the corresponding pickjobs
Reference to the facility you want to get the corresponding pickjobs
Reference the assigned user on this entity - id or username
Reference to the status you want to get the corresponding pickjobs
Reference to the zones you want to get the corresponding pickjobs
Reference to the tenantOrderId you want to get the corresponding pickjobs
The channel of the pickJob you want to filter by
Reference to the consumer name you want to get the corresponding pickjobs
Reference to the shortId you want to get the corresponding pickjobs
Reference to the articleTitle you want to get the corresponding pickjobs
Reference to the anonymized you want to get the corresponding pickjobs
all entities after given Id
number of entities to show
25query pickjobs orderBy
Start date range for pick jobs
2020-02-03T08:45:50.525ZEnd date range for pick jobs
2020-02-03T08:45:50.525ZReference to pickjobs
Reference to the user ID you want to get the corresponding pickjobs
PickJobs were found. The results are in the body.
StrippedPickJobs
Total number of found entities for this query
42Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
PickJobForCreation
Attributes that can be added to the pickjob. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
The id of the facility reference. The given ID has to be present in the system.
Esb20gpHBL94X5NdMp3CThe date this order was created at the supplying system.
2020-02-03T08:45:50.525ZThe id of the order reference. The given ID has to be present in the system.
LGMl2DuvPnfPoSHhYFOmId of the global process related to this entity. For example used for starting the GDPR process and others.
Reference to the routingplan which created this pickjob
A short identifier that helps assigning a pick job to a customer.
AS12The status of a pickjob.
Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
R456728546The pick job was successfully created. The Location header contains the URL of the pickjob.
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 endpoint
ID of the pickjob you want to get
PickJob was found & you were allowed to access it. The result is in the body.
VersionedResource
Attributes that can be added to the pickjob. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
The id of the facility reference. The given ID has to be present in the system.
Esb20gpHBL94X5NdMp3CThe date this order was created at the supplying system.
2020-02-03T08:45:50.525ZThe id of the order reference. The given ID has to be present in the system.
LGMl2DuvPnfPoSHhYFOmId of the global process related to this entity. For example used for starting the GDPR process and others.
Reference to the routingplan which created this pickjob
A short identifier that helps assigning a pickJob to a customer. This is automatically created during creation.
AS12The status of a pickjob.
Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
R456728546The 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.
42Indicates if gdpr related data was anonymized
falseReference to the documents collection from this entity
The id of this pickjob. It is generated during creation automatically and suits as the primary identifier of the described entity.
Esb20gpHBL94X5NdMp3CPick run id to which the pick job belongs
Indicates if pickJob can still be resetted or restarted
falsedeprecated: Use subStatus instead. Maintained for backward compatibility.
The reason for the current status.
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
ID of the pickjob you want to get
PickingPatchActions
The version of the document to be used in optimistic locking mechanisms.
42PickJob was found & patch-set has been applied. The patched pick job is in the body.
VersionedResource
Attributes that can be added to the pickjob. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
The id of the facility reference. The given ID has to be present in the system.
Esb20gpHBL94X5NdMp3CThe date this order was created at the supplying system.
2020-02-03T08:45:50.525ZThe id of the order reference. The given ID has to be present in the system.
LGMl2DuvPnfPoSHhYFOmId of the global process related to this entity. For example used for starting the GDPR process and others.
Reference to the routingplan which created this pickjob
A short identifier that helps assigning a pickJob to a customer. This is automatically created during creation.
AS12The status of a pickjob.
Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
R456728546The 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.
42Indicates if gdpr related data was anonymized
falseReference to the documents collection from this entity
The id of this pickjob. It is generated during creation automatically and suits as the primary identifier of the described entity.
Esb20gpHBL94X5NdMp3CPick run id to which the pick job belongs
Indicates if pickJob can still be resetted or restarted
falsedeprecated: Use subStatus instead. Maintained for backward compatibility.
The reason for the current status.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
PickJob not found
PickJob version conflict
Reference to the pick job you want to call an action for
PickJobActionsParameter
Updated PickJob in the body.
VersionedResource
Attributes that can be added to the pickjob. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
The id of the facility reference. The given ID has to be present in the system.
Esb20gpHBL94X5NdMp3CThe date this order was created at the supplying system.
2020-02-03T08:45:50.525ZThe id of the order reference. The given ID has to be present in the system.
LGMl2DuvPnfPoSHhYFOmId of the global process related to this entity. For example used for starting the GDPR process and others.
Reference to the routingplan which created this pickjob
A short identifier that helps assigning a pickJob to a customer. This is automatically created during creation.
AS12The status of a pickjob.
Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
R456728546The 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.
42Indicates if gdpr related data was anonymized
falseReference to the documents collection from this entity
The id of this pickjob. It is generated during creation automatically and suits as the primary identifier of the described entity.
Esb20gpHBL94X5NdMp3CPick run id to which the pick job belongs
Indicates if pickJob can still be resetted or restarted
falsedeprecated: Use subStatus instead. Maintained for backward compatibility.
The reason for the current status.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
ID of the pick job for which you want to get a deliverynote
Provide the localized values for the delivery note. If not provided the default locale is used. For example de_DE
The deliverynote for the given pickjob
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
Loadunits were found. The results are in the body.
LoadUnits
Total number of found entities for this query
42Your 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
PickingLoadUnitForCreation
List of codes
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.
Use operativeContainerTypeRef instead.
the reference to the operativeContainerType
the reference to the stackRef this loadUnit is part of
the reference to the storage location this load unit as been placed into
The load units was successfully created.
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
Reference to the pick job you to get the available substitutes for
Reference to the pickLineItem you to get the available substitutes for
Available substitutes for given pickLineItem
ResolvedSubstitutes
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
ID of the Pickjob
Returns a return note for the pickjob.
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
ID of the pick job for which you want to get a transfer label
The transfer label for the given pickjob
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
PickJobSearchPayload
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
PickJobPaginatedResult
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
PickRunForCreation
Deprecated: batchPick, use batch instead Deprecated: multiOrderPick, use multiOrder instead
batchPickPossible values: The state of the PickRun
The PickRun was successfully created. The Location header contains the URL of it.
Invalid input. See response for details
Your user is not allowed to operate against this API instance
id of pickRun
PickRun is found.
PickRun
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.
42Deprecated: batchPick, use batch instead Deprecated: multiOrderPick, use multiOrder instead
batchPickPossible values: The state of the PickRun
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
id of pickRun
PickRunPatchAction
The version of the document to be used in optimistic locking mechanisms.
42The updated PickRun.
PickRun
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.
42Deprecated: batchPick, use batch instead Deprecated: multiOrderPick, use multiOrder instead
batchPickPossible values: The state of the PickRun
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Version conflict
Reference to the pick run you want to call the action for
PickRunActionsParameter
Updated Pick Run in the body.
PickRun
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.
42Deprecated: batchPick, use batch instead Deprecated: multiOrderPick, use multiOrder instead
batchPickPossible values: The state of the PickRun
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
id of pickRun
PickRunPickJobsPatchAction
The version of the document to be used in optimistic locking mechanisms.
42Pick job was successfully from pick run removed.
No content
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
No content
the tenantArticleId substitutes are requested for
There are substitutes for the given tenantArticleId. The result can be found in the body.
Substitutes
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Facility not found
The substitutes for the given tenantArticleId can be found in the body.
Substitutes
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Facility not found
Tenant article ID of the article the substitutes should be set for
SubstitutesForUpsert
Version field is used in the optimistic locking process. If the Substitute is for the tenantArticleId is not set yet, this field is ignored.
1The substitutes for tenantArticleId were successfully updated
Substitutes
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Facility listing not found
the tenant article ID the subsitutes should be deleted for
The substitutes for the given tenantArticleId were 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 endpoint
Facility listing not found
No content
Last updated