Packing (Operations)
Provide the localized values for the entity. If not provided the default locale is used. For example de_DE.
all entities after given id
number of entities to show
25Found PackingContainerTypes
PackingContainerType
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.
42This value gives the priority of the respective packingContainerType. 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 packingContainerTypes in the UI.
100Maximal weight in gramm(gr) the container can be loaded with.
2500Invalid 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
PackingContainerTypeForCreation
This value gives the priority in the respective packingContainerType. 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 packingContainerTypes.
100Maximal weight in gramm(gr) the container can be loaded with.
2500The packing container type was successfully created. The Location header contains the URL of the packing container type.
PackingContainerType
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.
42This value gives the priority of the respective packingContainerType. 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 packingContainerTypes in the UI.
100Maximal weight in gramm(gr) the container can be loaded with.
2500Invalid 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 entity
Provide the localized values for the entity. If not provided the default locale is used. For example de_DE.
Found PackingContainerType
PackingContainerType
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.
42This value gives the priority of the respective packingContainerType. 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 packingContainerTypes in the UI.
100Maximal weight in gramm(gr) the container can be loaded with.
2500Invalid 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 packingcontainertype you want to change
PackingContainerTypePatchActions
The version of the document to be used in optimistic locking mechanisms.
42PackingContainerType was found & patch-set has been applied. The patched PackingContainerType is in the body.
PackingContainerType
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.
42This value gives the priority of the respective packingContainerType. 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 packingContainerTypes in the UI.
100Maximal weight in gramm(gr) the container can be loaded with.
2500Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
PackingContainerType not found
PackingContainerType version conflict
Provide the localized values for the entity. If not provided the default locale is used. For example de_DE.
all entities after given id
number of entities to show
25filter by packJobRef
filter by facilityRef
filter by scannablecodes
Found Packing Source Container
PaginatedPackingSourceContainers
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 endpoint
PackingSourceContainerForCreation
Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.
100Codes, that identify the article
Attributes that can be added to the packing source container. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.
The id of the facility reference. The given ID has to be present in the system. But it is not updatable.
Esb20gpHBL94X5NdMp3CReference to the operativeContainerType, available values will be taken from the container type while creating the container
List of references to packJobs
0857914c-d965-421e-b6cf-330501bcca58Reference to the location where the packing source container is located.
The packing source container was successfully created. The Location header contains the URL of the packing source container.
PackingSourceContainer
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.
42Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.
100Codes, that identify the container
Attributes that can be added to the packing source container. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.
Description of the packing source container in the locale the client requests.
Reference to the facility the packing source container is related to.
Esb20gpHBL94X5NdMp3CUrl to the icon of the packing source container
The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.
c7467ba8-c28a-4473-8748-a4e54e675e4cThis part of the API is deprecated. For details, see the API release lifecycle documentation.
Deprecated: Use previousModuleContainerInfo instead. For load units ref see: type: LOAD_UNIT.
2357914c-d965-421e-b6cf-330501bccaabName of the packing source container in the locale the client requests.
Reference to the assigned operativeContainerType
List of references to packJobs this packing source container is related to.
0857914c-d965-421e-b6cf-330501bcca58Reference to the location where the packing source container is located.
Type of the packing source container
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 packingSourceContainer
Provide the localized values for the entity. If not provided the default locale is used. For example de_DE.
Found packingSourceContainer
PackingSourceContainer
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.
42Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.
100Codes, that identify the container
Attributes that can be added to the packing source container. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.
Description of the packing source container in the locale the client requests.
Reference to the facility the packing source container is related to.
Esb20gpHBL94X5NdMp3CUrl to the icon of the packing source container
The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.
c7467ba8-c28a-4473-8748-a4e54e675e4cThis part of the API is deprecated. For details, see the API release lifecycle documentation.
Deprecated: Use previousModuleContainerInfo instead. For load units ref see: type: LOAD_UNIT.
2357914c-d965-421e-b6cf-330501bccaabName of the packing source container in the locale the client requests.
Reference to the assigned operativeContainerType
List of references to packJobs this packing source container is related to.
0857914c-d965-421e-b6cf-330501bcca58Reference to the location where the packing source container is located.
Type of the packing source container
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
Entity not found
number of entities to show
25all entities after given Id
Parameter to filter anonymized pack jobs
Reference the assigned user on this entity - id or username
Reference to the status you want to get the corresponding packJobs
Reference to the facility you want to get the corresponding packJobs
Term by which to search through the fields
Reference to the channel you want to get the corresponding packJobs
filter by packingsourcecontainer containing codes
Attribute to order a packJobs by
Start date range for pack jobs
2020-02-03T08:45:50.525ZEnd date range for pack jobs
2020-02-03T08:45:50.525ZReference to the order you want to get the corresponding packJobs
Reference to the packJobs you want to get
Reference to the process you want to get the corresponding packJobs
Reference to the pickJobRef you want to get the corresponding packJobs
Reference to the shortId you want to get the corresponding packJobs
Reference to the articleTitle you want to get the corresponding packJobs
Start date range of the order for the corresponding pack jobs
2020-02-03T08:45:50.525ZEnd date range of the order for the corresponding pack jobs
2020-02-03T08:45:50.525ZReference to the username you want to get the corresponding pack jobs
Reference to the tenantOrderId you want to get the corresponding packJobs
Pack jobs was loaded & you were allowed to access it. The result is in the body.
PackJobs
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
Entity not found
PackJobForCreation
Attributes that can be added to the pack job. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
Reference to the facility you want to get the corresponding packjob
Esb50gpH7794X5NdMp3CDate when the order was placed.
2020-02-03T09:45:51.525ZThe id of the order
Reference to a pick job
Pic50gpH7794X5NdMp3CId of the global process related to this entity. For example used for starting the GDPR process and others.
The name of the recipient
The short identifier of the shipment.
A pack job initially has the status OPEN and packing can start. When packing has started, the pack job changes its status to IN_PROGRESS. After a pack job has been completely packed its status becomes CLOSED.
Until when the pack job must be finished.
2020-02-03T09:45:51.525ZThe pack job was successfully created. The Location header contains the URL of the pack job.
PackJob
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 pack job you want to get
Pack job was found & you were allowed to access it. The result is in the body.
PackJob
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 packjob you want to get
PackJobPatchActions
The version of the document to be used in optimistic locking mechanisms.
42PackJob was found & patch-set has been applied. The patched pack job is in the body.
PackJob
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
PackJob not found
PackJob version conflict
Reference to the pack job you want to call an action for
PackJobActionsParameter
Updated PackJob in the body.
PackJob
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Enitity not found
ID of the pack 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 packjob
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 pack job you want to get document handling information
Pack 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 PackJob
Provide the localized values for the delivery note. If not provided the default locale is used. For example de_DE.
Returns a return note for the packjob.
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 pack job you want to get
Entity was found & you were allowed to access it. The result is in the body.
PackingTargetContainer
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.
42Incremental 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
deprecated - use operativeContainerTypeRef instead
Reference to the location where the packing target container is located.
Description of the packing source container in the locale the client requests. Automatically filled upon request.
Reference to the documents collection from this entity
The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request
Esb20gpHBL94X5NdMp3CUrl to the icon of the packing source container (inherited from operative container type).
The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.
Name of the packing source container in the locale the client requests. Automatically filled upon request.
Reference to the operative process this packing target container is related to.
Reference to the packJob this packing source container is related to.
Short identifier for the container
Type of the packing taret container
Maximal weight in gramm(gr) the container can be loaded with.
2500Your 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 pack job you want to get
PackingTargetContainerForCreation
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
deprecated - use operativeContainerTypeRef instead
Reference to the location where the packing target container is located.
The packing container was successfully created.
PackingTargetContainer
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.
42Incremental 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
deprecated - use operativeContainerTypeRef instead
Reference to the location where the packing target container is located.
Description of the packing source container in the locale the client requests. Automatically filled upon request.
Reference to the documents collection from this entity
The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request
Esb20gpHBL94X5NdMp3CUrl to the icon of the packing source container (inherited from operative container type).
The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.
Name of the packing source container in the locale the client requests. Automatically filled upon request.
Reference to the operative process this packing target container is related to.
Reference to the packJob this packing source container is related to.
Short identifier for the container
Type of the packing taret container
Maximal weight in gramm(gr) the container can be loaded with.
2500Invalid 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 pack job you want to get
ID of the target container you want to get
Provide the localized values for the entity. If not provided the default locale is used. For example de_DE.
Entity was found & you were allowed to access it. The result is in the body.
PackingTargetContainer
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.
42Incremental 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
deprecated - use operativeContainerTypeRef instead
Reference to the location where the packing target container is located.
Description of the packing source container in the locale the client requests. Automatically filled upon request.
Reference to the documents collection from this entity
The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request
Esb20gpHBL94X5NdMp3CUrl to the icon of the packing source container (inherited from operative container type).
The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.
Name of the packing source container in the locale the client requests. Automatically filled upon request.
Reference to the operative process this packing target container is related to.
Reference to the packJob this packing source container is related to.
Short identifier for the container
Type of the packing taret container
Maximal weight in gramm(gr) the container can be loaded with.
2500Your 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 pack job you want to get
ID of the container you want to add new line item to it
PackingTargetContainerLineItemForCreation
Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.
This ID is used to identify if this line item is related to the line item of other operational entities.
Identifier for items unit of measurement.
literquantity of the item
21Codes that can be used for scanning this lineItem
Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram
gramsecondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight
200The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.
df671041-10dd-4600-a2ff-e9ffe2556bbaThe packing container was successfully created.
PackingTargetContainer
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.
42Incremental 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
deprecated - use operativeContainerTypeRef instead
Reference to the location where the packing target container is located.
Description of the packing source container in the locale the client requests. Automatically filled upon request.
Reference to the documents collection from this entity
The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request
Esb20gpHBL94X5NdMp3CUrl to the icon of the packing source container (inherited from operative container type).
The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.
Name of the packing source container in the locale the client requests. Automatically filled upon request.
Reference to the operative process this packing target container is related to.
Reference to the packJob this packing source container is related to.
Short identifier for the container
Type of the packing taret container
Maximal weight in gramm(gr) the container can be loaded with.
2500Invalid 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 corresponding packJob you want to patch
ID of container you want to delete
Container was found & you were allowed to delete it.
No content
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
No content
ID of corresponding packJob you want to patch
ID of container you want to patch
PackingTargetContainerPatchActions
The version of the document to be used in optimistic locking mechanisms.
42Container was found & patch-set has been applied. The patched entity is in the body.
PackingTargetContainer
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.
42Incremental 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
deprecated - use operativeContainerTypeRef instead
Reference to the location where the packing target container is located.
Description of the packing source container in the locale the client requests. Automatically filled upon request.
Reference to the documents collection from this entity
The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request
Esb20gpHBL94X5NdMp3CUrl to the icon of the packing source container (inherited from operative container type).
The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.
Name of the packing source container in the locale the client requests. Automatically filled upon request.
Reference to the operative process this packing target container is related to.
Reference to the packJob this packing source container is related to.
Short identifier for the container
Type of the packing taret container
Maximal weight in gramm(gr) the container can be loaded with.
2500Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Entity not found
Entity version conflict
ID of the pack job for which you want to get a deliverynote
ID of the packingTargetContainer 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 packingTargetContainer
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 corresponding packJob you want to patch
ID of container you want to patch
ID of line item you want to patch
LineItem was found & you were allowed to delete it.
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 not found
No content
ID of corresponding packJob you want to patch
ID of container you want to patch
ID of line item you want to patch
PackingTargetContainerActionsParameter
Container was found & patch-set has been applied. The patched entity is in the body.
PackingTargetContainer
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.
42Incremental 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
deprecated - use operativeContainerTypeRef instead
Reference to the location where the packing target container is located.
Description of the packing source container in the locale the client requests. Automatically filled upon request.
Reference to the documents collection from this entity
The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request
Esb20gpHBL94X5NdMp3CUrl to the icon of the packing source container (inherited from operative container type).
The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.
Name of the packing source container in the locale the client requests. Automatically filled upon request.
Reference to the operative process this packing target container is related to.
Reference to the packJob this packing source container is related to.
Short identifier for the container
Type of the packing taret container
Maximal weight in gramm(gr) the container can be loaded with.
2500Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Entity not found
Entity version conflict
ID of the pack job for which you want to get a deliverynote
ID of the PackingTargetContainer
Provide the localized values for the return note. If not provided the default locale is used. For example de_DE.
Returns a return note for the PackingTargetContainer.
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 pack job for which you want to get a transfer label
ID of the packingTargetContainer for which you want to get a transfer label
The transfer label for the given packingTargetContainer
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 pack job for which you want to get a transfer label
The transfer label for the given packjob
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
PackJobSearchPayload
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.
10The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.
Your search result
PackJobPaginatedResult
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 endpoint
Last updated