Picking endpoints
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
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
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
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
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
ID of the pick job you want to get document handling information
Pick job document handling was found & you were allowed to access it. The result is in the body.
DocumentHandling
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
Reference to the pick job you want to get the corresponding loadunits
PickingLoadUnitForCreation
Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.
100List of codes
Attributes that can be added to the PickingLoadUnit. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
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 endpoint
Reference to the pick job you want to get the corresponding loadunits
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 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
pickjob tag config is in response body.
PickJobTagConfiguration
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.
42Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Entity not found
PickJobTagConfiguration
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 packing configuration was successfully updated.
PickJobTagConfiguration
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.
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 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
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
Last updated