# Packing (Operations)
These endpoints facilitate the packing process.
## List packing container types
> This part of the API is deprecated. For details please check the \api-release-life-cycle documentation\.\
\
Get all packing container types, use operative container types
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackingContainerType":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"iconUrl":{"description":"","type":"string"},"id":{"description":"","type":"string"},"name":{"type":"string"},"priority":{"description":"This 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.","format":"int32","maximum":10000,"minimum":1,"type":"integer"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with. ","minimum":1,"type":"number"}},"required":["id","version","nameLocalized"],"type":"object","title":"PackingContainerType","description":"PackingContainerType"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packingcontainertypes":{"get":{"deprecated":true,"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
Get all packing container types, use operative container types","operationId":"getPackingContainerTypes","parameters":[{"description":"Provide the localized values for the entity. If not provided the default locale is used. For example de_DE.","in":"query","name":"locale","schema":{"type":"string"}},{"description":"all entities after given id","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"number of entities to show","in":"query","name":"size","required":false,"schema":{"default":25,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PackingContainerType"},"type":"array"}}},"description":"Found PackingContainerTypes"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List packing container types","tags":["Packing (Operations)"]}}}}
```
## Create packing container type
> This part of the API is deprecated. For details please check the \api-release-life-cycle documentation\.\
\
Add a new packing container type, use operative container types.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackingContainerTypeForCreation":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"icon":{"$ref":"#/components/schemas/NamedFile"},"priority":{"description":"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.","format":"int32","maximum":10000,"minimum":1,"type":"integer"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with. ","minimum":1,"type":"number"}},"required":["nameLocalized"],"type":"object","title":"PackingContainerTypeForCreation","description":"PackingContainerTypeForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"NamedFile":{"additionalProperties":false,"properties":{"content":{"description":"File content base64 encoded","type":"string"},"name":{"description":"File name with extension","type":"string"}},"required":["name","content"],"type":"object","xml":{"name":"NamedFile"},"title":"NamedFile","description":"NamedFile"},"PackingContainerType":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"iconUrl":{"description":"","type":"string"},"id":{"description":"","type":"string"},"name":{"type":"string"},"priority":{"description":"This 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.","format":"int32","maximum":10000,"minimum":1,"type":"integer"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with. ","minimum":1,"type":"number"}},"required":["id","version","nameLocalized"],"type":"object","title":"PackingContainerType","description":"PackingContainerType"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packingcontainertypes":{"post":{"deprecated":true,"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
Add a new packing container type, use operative container types.","operationId":"addPackingContainerType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackingContainerTypeForCreation"}}},"description":"Packing type object","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackingContainerType"}}},"description":"The packing container type was successfully created. The Location header contains the URL of the packing container type."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create packing container type","tags":["Packing (Operations)"]}}}}
```
## Get packing container type
> This part of the API is deprecated. For details please check the \api-release-life-cycle documentation\.\
\
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackingContainerType":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"iconUrl":{"description":"","type":"string"},"id":{"description":"","type":"string"},"name":{"type":"string"},"priority":{"description":"This 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.","format":"int32","maximum":10000,"minimum":1,"type":"integer"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with. ","minimum":1,"type":"number"}},"required":["id","version","nameLocalized"],"type":"object","title":"PackingContainerType","description":"PackingContainerType"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packingcontainertypes/{packingContainerTypeId}":{"get":{"deprecated":true,"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
","operationId":"getPackingContainerType","parameters":[{"description":"Provide the localized values for the entity. If not provided the default locale is used. For example de_DE.","in":"query","name":"locale","schema":{"type":"string"}},{"description":"id of entity","in":"path","name":"packingContainerTypeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackingContainerType"}}},"description":"Found PackingContainerType"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Get packing container type","tags":["Packing (Operations)"]}}}}
```
## Update packing container type
> This part of the API is deprecated. For details please check the \api-release-life-cycle documentation\.\
\
Patches a PackingContainerType with the given ID, use operative container types
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackingContainerTypePatchActions":{"properties":{"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/ModifyPackingContainerType"},{"$ref":"#/components/schemas/ModifyPackingContainerTypeIcon"}]},"minItems":1,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","actions"],"type":"object","xml":{"name":"PackingContainerTypePatchActions"},"title":"PackingContainerTypePatchActions","description":"PackingContainerTypePatchActions"},"ModifyPackingContainerType":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"action":{"description":"Use value 'ModifyPackingContainerType', because you want to modify a PackingContainerType","enum":["ModifyPackingContainerType"],"type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"priority":{"description":"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.","format":"int32","maximum":10000,"minimum":1,"type":"integer"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with. ","minimum":1,"type":"number"}},"required":["action"],"type":"object"}],"description":"Action to a modify the type of a packing container.","title":"ModifyPackingContainerType","xml":{"name":"ModifyPackingContainerType"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyPickJob","ModifyPickJobLastEditor","RestartPickJob","ResetPickJob","CancelPickRun","CancelHandoverjob","AbortPickJob","FinishPickRun","StartPickRun","ModifyPickLineItem","ModifyPickRunLineItem","ModifyPackJob","PausePackJob","ModifyPackLineItem","SplitLineItemsPackJob","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyShipment","ModifyHandoverjob","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyLoadUnitType","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyRestowItem","RemovePickJobFromPickRun","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","ModifyPackingContainerType","ModifyPackingContainerTypeIcon","ReplaceCodesInPackingTargetContainer","ReplaceLoadUnitLineItems","AddLineItemToPackingTargetContainer","RemoveLineItemFromPackingTargetContainer","UpdateLineItemOnPackingTargetContainer","UpdatePackingTargetContainerLineItemRecordableAttributes","ModifyCustomService","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"ModifyPackingContainerTypeIcon":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyPackingContainerTypeIcon', because you want to modify a PackingContainerTypes icon","enum":["ModifyPackingContainerTypeIcon"],"type":"string"},"content":{"description":"Content of the icon as base64 string","type":"string"},"name":{"description":"icons filename","type":"string"}},"required":["action","name","content"],"type":"object"}],"description":"Action to a modify the type icon of a packing container.","title":"ModifyPackingContainerTypeIcon","xml":{"name":"ModifyPackingContainerTypeIcon"}},"PackingContainerType":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"iconUrl":{"description":"","type":"string"},"id":{"description":"","type":"string"},"name":{"type":"string"},"priority":{"description":"This 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.","format":"int32","maximum":10000,"minimum":1,"type":"integer"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with. ","minimum":1,"type":"number"}},"required":["id","version","nameLocalized"],"type":"object","title":"PackingContainerType","description":"PackingContainerType"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packingcontainertypes/{packingContainerTypeId}":{"patch":{"deprecated":true,"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
Patches a PackingContainerType with the given ID, use operative container types","operationId":"updatePackingContainerType","parameters":[{"description":"ID of the packingcontainertype you want to change","in":"path","name":"packingContainerTypeId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackingContainerTypePatchActions"}}},"description":"Patch set","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackingContainerType"}}},"description":"PackingContainerType was found & patch-set has been applied. The patched PackingContainerType is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"PackingContainerType not found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"PackingContainerType version conflict"}},"summary":"Update packing container type","tags":["Packing (Operations)"]}}}}
```
## List packing source containers
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Listing packingSourceContainer.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PaginatedPackingSourceContainers":{"properties":{"packingSourceContainers":{"items":{"$ref":"#/components/schemas/PackingSourceContainer"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"PaginatedPackingSourceContainers","description":"PaginatedPackingSourceContainers"},"PackingSourceContainer":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"minItems":1,"type":"array"},"customAttributes":{"description":"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.","type":"object"},"description":{"description":"Description of the packing source container in the locale the client requests.","type":"string"},"facilityRef":{"description":"Reference to the facility the packing source container is related to.","type":"string"},"iconUrl":{"description":"Url to the icon of the packing source container","type":"string"},"id":{"description":"The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingSourceContainerLineItem"},"type":"array"},"loadUnitRef":{"description":"Reference to the load unit this packing source container is related to.","type":"string"},"name":{"description":"Name of the packing source container in the locale the client requests.","type":"string"},"operativeContainerTypeRef":{"description":"Reference to the assigned operativeContainerType","type":"string"},"packJobRefs":{"description":"List of references to packJobs this packing source container is related to.","items":{"type":"string"},"minItems":1,"type":"array"},"storageLocationRef":{"description":"Reference to the location where the packing source container is located.","type":"string"},"type":{"$ref":"#/components/schemas/PackingSourceContainerType"}},"required":["packJobRefs","nameLocalized","facilityRef","id","version","lastModified","created","lineItems","type"],"type":"object","title":"PackingSourceContainer","description":"PackingSourceContainer"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"PackingSourceContainerLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"description":"item that is inside the packingSourceContainer","properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryQuantity is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","quantity","article"],"type":"object","xml":{"name":"PackingSourceContainerLineItem"},"title":"PackingSourceContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in the fulfillmenttools platform in order to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients. Details about usage can be found here","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"type":"array"},"customAttributes":{"deprecated":true,"description":"deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PackingSourceContainerType":{"description":"Type of the packing source container","enum":["VIRTUAL","PHYSICAL"],"type":"string","title":"PackingSourceContainerType"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packingsourcecontainers":{"get":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Listing packingSourceContainer.","operationId":"getPackingSourceContainers","parameters":[{"description":"Provide the localized values for the entity. If not provided the default locale is used. For example de_DE.","in":"query","name":"locale","schema":{"type":"string"}},{"description":"all entities after given id","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"number of entities to show","in":"query","name":"size","required":false,"schema":{"default":25,"maximum":500,"type":"integer"}},{"description":"filter by packJobRef","in":"query","name":"packJobRef","required":false,"schema":{"type":"string"}},{"description":"filter by facilityRef","in":"query","name":"facilityRef","required":true,"schema":{"type":"string"}},{"description":"filter by scannablecodes","in":"query","name":"codes","required":false,"schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PaginatedPackingSourceContainers"},"type":"array"}}},"description":"Found Packing Source Container"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List packing source containers","tags":["Packing (Operations)"]}}}}
```
## Create packing source container
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Creating new packingSourceContainer.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackingSourceContainerForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"codes":{"items":{"description":"Codes, that identify the article","type":"string"},"minItems":1,"type":"array"},"customAttributes":{"description":"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.","type":"object"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system. But it is not updatable.","type":"string"},"icon":{"$ref":"#/components/schemas/NamedFile"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingSourceContainerLineItemForCreation"},"type":"array"},"operativeContainerTypeRef":{"description":"Reference to the operativeContainerType, available values will be taken from the container type while creating the container","type":"string"},"packJobRefs":{"description":"List of references to packJobs","items":{"type":"string"},"minItems":1,"type":"array"},"storageLocationRef":{"description":"Reference to the location where the packing source container is located.","type":"string"}},"required":["packJobRefs","nameLocalized","facilityRef","lineItems"],"type":"object","title":"PackingSourceContainerForCreation","description":"PackingSourceContainerForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"NamedFile":{"additionalProperties":false,"properties":{"content":{"description":"File content base64 encoded","type":"string"},"name":{"description":"File name with extension","type":"string"}},"required":["name","content"],"type":"object","xml":{"name":"NamedFile"},"title":"NamedFile","description":"NamedFile"},"PackingSourceContainerLineItemForCreation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"}],"description":"items that are inside the packingSourceContainer","properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryQuantity is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","xml":{"name":"PackingSourceContainerLineItemForCreation"},"title":"PackingSourceContainerLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in the fulfillmenttools platform in order to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients. Details about usage can be found here","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"type":"array"},"customAttributes":{"deprecated":true,"description":"deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PackingSourceContainer":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"minItems":1,"type":"array"},"customAttributes":{"description":"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.","type":"object"},"description":{"description":"Description of the packing source container in the locale the client requests.","type":"string"},"facilityRef":{"description":"Reference to the facility the packing source container is related to.","type":"string"},"iconUrl":{"description":"Url to the icon of the packing source container","type":"string"},"id":{"description":"The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingSourceContainerLineItem"},"type":"array"},"loadUnitRef":{"description":"Reference to the load unit this packing source container is related to.","type":"string"},"name":{"description":"Name of the packing source container in the locale the client requests.","type":"string"},"operativeContainerTypeRef":{"description":"Reference to the assigned operativeContainerType","type":"string"},"packJobRefs":{"description":"List of references to packJobs this packing source container is related to.","items":{"type":"string"},"minItems":1,"type":"array"},"storageLocationRef":{"description":"Reference to the location where the packing source container is located.","type":"string"},"type":{"$ref":"#/components/schemas/PackingSourceContainerType"}},"required":["packJobRefs","nameLocalized","facilityRef","id","version","lastModified","created","lineItems","type"],"type":"object","title":"PackingSourceContainer","description":"PackingSourceContainer"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"PackingSourceContainerLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"description":"item that is inside the packingSourceContainer","properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryQuantity is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","quantity","article"],"type":"object","xml":{"name":"PackingSourceContainerLineItem"},"title":"PackingSourceContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"PackingSourceContainerType":{"description":"Type of the packing source container","enum":["VIRTUAL","PHYSICAL"],"type":"string","title":"PackingSourceContainerType"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packingsourcecontainers":{"post":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Creating new packingSourceContainer.","operationId":"addPackingSourceContainer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackingSourceContainerForCreation"}}},"description":"Packing type object","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackingSourceContainer"}}},"description":"The packing source container was successfully created. The Location header contains the URL of the packing source container."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create packing source container","tags":["Packing (Operations)"]}}}}
```
## Get packing source container
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Get PackingSourceContainer by ID.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackingSourceContainer":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"minItems":1,"type":"array"},"customAttributes":{"description":"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.","type":"object"},"description":{"description":"Description of the packing source container in the locale the client requests.","type":"string"},"facilityRef":{"description":"Reference to the facility the packing source container is related to.","type":"string"},"iconUrl":{"description":"Url to the icon of the packing source container","type":"string"},"id":{"description":"The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingSourceContainerLineItem"},"type":"array"},"loadUnitRef":{"description":"Reference to the load unit this packing source container is related to.","type":"string"},"name":{"description":"Name of the packing source container in the locale the client requests.","type":"string"},"operativeContainerTypeRef":{"description":"Reference to the assigned operativeContainerType","type":"string"},"packJobRefs":{"description":"List of references to packJobs this packing source container is related to.","items":{"type":"string"},"minItems":1,"type":"array"},"storageLocationRef":{"description":"Reference to the location where the packing source container is located.","type":"string"},"type":{"$ref":"#/components/schemas/PackingSourceContainerType"}},"required":["packJobRefs","nameLocalized","facilityRef","id","version","lastModified","created","lineItems","type"],"type":"object","title":"PackingSourceContainer","description":"PackingSourceContainer"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"PackingSourceContainerLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"description":"item that is inside the packingSourceContainer","properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryQuantity is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","quantity","article"],"type":"object","xml":{"name":"PackingSourceContainerLineItem"},"title":"PackingSourceContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in the fulfillmenttools platform in order to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients. Details about usage can be found here","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"type":"array"},"customAttributes":{"deprecated":true,"description":"deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PackingSourceContainerType":{"description":"Type of the packing source container","enum":["VIRTUAL","PHYSICAL"],"type":"string","title":"PackingSourceContainerType"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packingsourcecontainers/{packingSourceContainerId}":{"get":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Get PackingSourceContainer by ID.","operationId":"getPackingSourceContainerById","parameters":[{"description":"ID of the packingSourceContainer","in":"path","name":"packingSourceContainerId","required":true,"schema":{"type":"string"}},{"description":"Provide the localized values for the entity. If not provided the default locale is used. For example de_DE.","in":"query","name":"locale","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PackingSourceContainer"},"type":"array"}}},"description":"Found packingSourceContainer"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get packing source container","tags":["Packing (Operations)"]}}}}
```
## GET /api/packjobs
> List pack jobs
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackJobOrderBy":{"description":"Attribute to order a packJobs by","enum":["TARGET_TIME_DESC","TARGET_TIME_ASC","LAST_MODIFIED_DESC","LAST_MODIFIED_ASC","ORDER_DATE_DESC","ORDER_DATE_ASC"],"type":"string","xml":{"name":"PackJobOrderBy"},"title":"PackJobOrderBy"},"PackJobs":{"properties":{"packJobs":{"items":{"$ref":"#/components/schemas/PackJobWithSearchPath"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"PackJobs","description":"PackJobs"},"PackJobWithSearchPath":{"allOf":[{"$ref":"#/components/schemas/PackJob"},{"additionalProperties":false}],"properties":{"searchPaths":{"items":{"type":"string"},"minItems":0,"type":"array"}},"xml":{"name":"PackJobWithPath"},"title":"PackJobWithSearchPath","description":"PackJobWithSearchPath"},"PackJob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"type":"array"},"customAttributes":{"description":"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.","type":"object"},"deliveryChannel":{"enum":["COLLECT","SHIPPING"],"type":"string"},"documentHandling":{"$ref":"#/components/schemas/DocumentHandling"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"facilityRef":{"description":"Reference to the facility you want to get the corresponding packjob","type":"string"},"id":{"description":"The id of this pack job. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/PackLineItem"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"Date when the order was placed.","format":"date-time","type":"string"},"orderRef":{"description":"The id of the order","type":"string"},"packingSourceContainers":{"items":{"$ref":"#/components/schemas/StrippedPackingSourceContainer"}},"pickJobRef":{"description":"Reference to a pick job","type":"string"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientName":{"description":"The name of the recipient","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/PackJobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"targetTime":{"description":"Until when the pack job must be finished.","format":"date-time","type":"string"},"tenantOrderId":{"type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["id","facilityRef","documentsRef","status","lineItems","processId","workflowInformation"],"type":"object","xml":{"name":"PackJob"}}],"title":"PackJob","description":"PackJob"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"DocumentHandling":{"properties":{"sendLabel":{"properties":{"enabled":{"default":false,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["sendLabel"],"type":"object","title":"DocumentHandling","description":"DocumentHandling"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"PackLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"packed":{"description":"The amount of articles that were packed for this packline.","format":"int32","minimum":0,"type":"integer"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"serviceJobRefs":{"description":"Reference to the service job that has altered this line item","items":{"type":"string"},"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","quantity","article"]}],"type":"object","xml":{"name":"PackLineItem"},"title":"PackLineItem","description":"PackLineItem"},"MandatoryLineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"PackLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackLineItemArticle"},"title":"PackLineItemArticle","description":"PackLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"StrippedPackingSourceContainer":{"additionalProperties":false,"properties":{"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"},"loadUnitRef":{"type":"string"}},"type":"object","title":"StrippedPackingSourceContainer","description":"StrippedPackingSourceContainer"},"PackJobStatus":{"description":"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.","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string","xml":{"name":"PackJobStatus"},"title":"PackJobStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The id of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The id identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The id identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs":{"get":{"description":"","operationId":"getPackJobs","parameters":[{"description":"number of entities to show","in":"query","name":"size","required":false,"schema":{"default":25,"type":"integer"}},{"description":"all entities after given Id","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"Parameter to filter anonymized pack jobs","in":"query","name":"anonymized","required":false,"schema":{"type":"boolean"}},{"description":"Reference the assigned user on this entity - id or username","in":"query","name":"assignedUser","required":false,"schema":{"type":"string"}},{"description":"Reference to the status you want to get the corresponding packJobs","explode":false,"in":"query","name":"status","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"Reference to the facility you want to get the corresponding packJobs","in":"query","name":"facilityRef","required":false,"schema":{"type":"string"}},{"description":"Term by which to search through the fields","in":"query","name":"searchTerm","required":false,"schema":{"type":"string"}},{"description":"Reference to the channel you want to get the corresponding packJobs","in":"query","name":"channel","required":false,"schema":{"enum":["COLLECT","SHIPPING"],"type":"string"}},{"description":"filter by packingsourcecontainer containing codes","in":"query","name":"sourceContainerCodes","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"query packjobs orderBy","in":"query","name":"orderBy","required":false,"schema":{"$ref":"#/components/schemas/PackJobOrderBy"}},{"description":"Start date range for pack jobs","in":"query","name":"startTargetTime","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"End date range for pack jobs","in":"query","name":"endTargetTime","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Reference to the order you want to get the corresponding packJobs","in":"query","name":"orderRef","required":false,"schema":{"type":"string"}},{"description":"Reference to the packJobs you want to get","in":"query","name":"packJobIds","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"Reference to the process you want to get the corresponding packJobs","in":"query","name":"processId","required":false,"schema":{"type":"string"}},{"description":"Reference to the pickJobRef you want to get the corresponding packJobs","in":"query","name":"pickJobRef","required":false,"schema":{"type":"string"}},{"description":"Reference to the shortId you want to get the corresponding packJobs","in":"query","name":"shortId","required":false,"schema":{"type":"string"}},{"description":"Reference to the articleTitle you want to get the corresponding packJobs","in":"query","name":"articleTitle","required":false,"schema":{"type":"string"}},{"description":"Start date range of the order for the corresponding pack jobs","in":"query","name":"startOrderDate","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"End date range of the order for the corresponding pack jobs","in":"query","name":"endOrderDate","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Reference to the username you want to get the corresponding pack jobs","in":"query","name":"modifiedByUsername","required":false,"schema":{"type":"string"}},{"description":"Reference to the tenantOrderId you want to get the corresponding packJobs","in":"query","name":"tenantOrderId","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackJobs"}}},"description":"Pack jobs was loaded & you were allowed to access it. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"List pack jobs","tags":["Packing (Operations)"]}}}}
```
## POST /api/packjobs
> Create pack job
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackJobForCreation":{"additionalProperties":false,"properties":{"assignedUsers":{"description":"Assigned users for this entity","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUserForCreationById"}]},"type":"array"},"customAttributes":{"description":"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.","type":"object"},"deliveryChannel":{"enum":["COLLECT","SHIPPING"],"type":"string"},"facilityRef":{"description":"Reference to the facility you want to get the corresponding packjob","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/PackLineItemForCreation"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"Date when the order was placed.","format":"date-time","type":"string"},"orderRef":{"description":"The id of the order","type":"string"},"pickJobRef":{"description":"Reference to a pick job","type":"string"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientName":{"description":"The name of the recipient","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/PackJobStatus"},"targetTime":{"description":"Until when the pack job must be finished.","format":"date-time","type":"string"},"tenantOrderId":{"type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"description":"Tags can only be set when there is no process related with this packJob. Setting processId and tags will lead to an validationError.","items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["facilityRef","lineItems","workflowInformation"],"type":"object","xml":{"name":"PackJobForCreation"},"title":"PackJobForCreation","description":"PackJobForCreation"},"AssignedUserForCreationByName":{"description":"Create a assigned user by giving a valid name","properties":{"username":{"description":"username of the user should be assigned","type":"string"}},"required":["username"],"title":"AssignedUserForCreationByName","type":"object"},"AssignedUserForCreationById":{"description":"Create a assigned user by giving a valid id","properties":{"userId":{"description":"userId of the user should be assigned","type":"string"}},"required":["userId"],"title":"AssignedUserForCreationById","type":"object"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"PackLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"}],"properties":{"article":{"$ref":"#/components/schemas/PackLineItemArticle"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"serviceJobRefs":{"description":"Reference to the service job that has altered this line item","items":{"type":"string"},"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","xml":{"name":"PackLineItemForCreation"},"title":"PackLineItemForCreation","description":"PackLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"PackLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackLineItemArticle"},"title":"PackLineItemArticle","description":"PackLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PackJobStatus":{"description":"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.","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string","xml":{"name":"PackJobStatus"},"title":"PackJobStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The id of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The id identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The id identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"PackJob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"type":"array"},"customAttributes":{"description":"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.","type":"object"},"deliveryChannel":{"enum":["COLLECT","SHIPPING"],"type":"string"},"documentHandling":{"$ref":"#/components/schemas/DocumentHandling"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"facilityRef":{"description":"Reference to the facility you want to get the corresponding packjob","type":"string"},"id":{"description":"The id of this pack job. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/PackLineItem"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"Date when the order was placed.","format":"date-time","type":"string"},"orderRef":{"description":"The id of the order","type":"string"},"packingSourceContainers":{"items":{"$ref":"#/components/schemas/StrippedPackingSourceContainer"}},"pickJobRef":{"description":"Reference to a pick job","type":"string"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientName":{"description":"The name of the recipient","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/PackJobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"targetTime":{"description":"Until when the pack job must be finished.","format":"date-time","type":"string"},"tenantOrderId":{"type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["id","facilityRef","documentsRef","status","lineItems","processId","workflowInformation"],"type":"object","xml":{"name":"PackJob"}}],"title":"PackJob","description":"PackJob"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"DocumentHandling":{"properties":{"sendLabel":{"properties":{"enabled":{"default":false,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["sendLabel"],"type":"object","title":"DocumentHandling","description":"DocumentHandling"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"PackLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"packed":{"description":"The amount of articles that were packed for this packline.","format":"int32","minimum":0,"type":"integer"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"serviceJobRefs":{"description":"Reference to the service job that has altered this line item","items":{"type":"string"},"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","quantity","article"]}],"type":"object","xml":{"name":"PackLineItem"},"title":"PackLineItem","description":"PackLineItem"},"MandatoryLineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"StrippedPackingSourceContainer":{"additionalProperties":false,"properties":{"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"},"loadUnitRef":{"type":"string"}},"type":"object","title":"StrippedPackingSourceContainer","description":"StrippedPackingSourceContainer"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs":{"post":{"description":"","operationId":"addPackJob","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackJobForCreation"}}},"description":"Pack job object","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackJob"}}},"description":"The pack job was successfully created. The Location header contains the URL of the pack job."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create pack job","tags":["Packing (Operations)"]}}}}
```
## GET /api/packjobs/{packJobId}
> Get pack job
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackJob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"type":"array"},"customAttributes":{"description":"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.","type":"object"},"deliveryChannel":{"enum":["COLLECT","SHIPPING"],"type":"string"},"documentHandling":{"$ref":"#/components/schemas/DocumentHandling"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"facilityRef":{"description":"Reference to the facility you want to get the corresponding packjob","type":"string"},"id":{"description":"The id of this pack job. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/PackLineItem"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"Date when the order was placed.","format":"date-time","type":"string"},"orderRef":{"description":"The id of the order","type":"string"},"packingSourceContainers":{"items":{"$ref":"#/components/schemas/StrippedPackingSourceContainer"}},"pickJobRef":{"description":"Reference to a pick job","type":"string"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientName":{"description":"The name of the recipient","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/PackJobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"targetTime":{"description":"Until when the pack job must be finished.","format":"date-time","type":"string"},"tenantOrderId":{"type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["id","facilityRef","documentsRef","status","lineItems","processId","workflowInformation"],"type":"object","xml":{"name":"PackJob"}}],"title":"PackJob","description":"PackJob"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"DocumentHandling":{"properties":{"sendLabel":{"properties":{"enabled":{"default":false,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["sendLabel"],"type":"object","title":"DocumentHandling","description":"DocumentHandling"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"PackLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"packed":{"description":"The amount of articles that were packed for this packline.","format":"int32","minimum":0,"type":"integer"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"serviceJobRefs":{"description":"Reference to the service job that has altered this line item","items":{"type":"string"},"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","quantity","article"]}],"type":"object","xml":{"name":"PackLineItem"},"title":"PackLineItem","description":"PackLineItem"},"MandatoryLineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"PackLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackLineItemArticle"},"title":"PackLineItemArticle","description":"PackLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"StrippedPackingSourceContainer":{"additionalProperties":false,"properties":{"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"},"loadUnitRef":{"type":"string"}},"type":"object","title":"StrippedPackingSourceContainer","description":"StrippedPackingSourceContainer"},"PackJobStatus":{"description":"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.","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string","xml":{"name":"PackJobStatus"},"title":"PackJobStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The id of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The id identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The id identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/{packJobId}":{"get":{"description":"","operationId":"getPackJob","parameters":[{"description":"ID of the pack job you want to get","in":"path","name":"packJobId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackJob"}}},"description":"Pack job was found & you were allowed to access it. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get pack job","tags":["Packing (Operations)"]}}}}
```
## PATCH /api/packjobs/{packJobId}
> Update pack job
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackJobPatchActions":{"properties":{"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/ModifyPackJob"},{"$ref":"#/components/schemas/ModifyPackLineItem"},{"$ref":"#/components/schemas/PausePackJob"}]},"minItems":1,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","actions"],"type":"object","xml":{"name":"PackJobPatchActions"},"title":"PackJobPatchActions","description":"PackJobPatchActions"},"ModifyPackJob":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyPackJob', because you want to modify a packjob","enum":["ModifyPackJob"],"type":"string"},"customAttributes":{"description":"Attributes that can be added to the line item. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"status":{"$ref":"#/components/schemas/PackJobStatus"}},"required":["action"],"type":"object"}],"description":"Action to modify a PackJob","title":"ModifyPackJob","xml":{"name":"ModifyPackJob"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyPickJob","ModifyPickJobLastEditor","RestartPickJob","ResetPickJob","CancelPickRun","CancelHandoverjob","AbortPickJob","FinishPickRun","StartPickRun","ModifyPickLineItem","ModifyPickRunLineItem","ModifyPackJob","PausePackJob","ModifyPackLineItem","SplitLineItemsPackJob","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyShipment","ModifyHandoverjob","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyLoadUnitType","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyRestowItem","RemovePickJobFromPickRun","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","ModifyPackingContainerType","ModifyPackingContainerTypeIcon","ReplaceCodesInPackingTargetContainer","ReplaceLoadUnitLineItems","AddLineItemToPackingTargetContainer","RemoveLineItemFromPackingTargetContainer","UpdateLineItemOnPackingTargetContainer","UpdatePackingTargetContainerLineItemRecordableAttributes","ModifyCustomService","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"PackJobStatus":{"description":"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.","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string","xml":{"name":"PackJobStatus"},"title":"PackJobStatus"},"ModifyPackLineItem":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyPackLineItem', because you want to modify a packjobs lineItem","enum":["ModifyPackLineItem"],"type":"string"},"id":{"description":"references the id of the packLineItem of a packJob","type":"string"},"packed":{"description":"The amount of articles that were packed for this packline. Can't be more than picked before.","format":"int64","minimum":0,"type":"integer"}},"required":["action","id"],"type":"object"}],"description":"Action to modify a PackLineItem of a PackJob","title":"ModifyPackLineItem","xml":{"name":"ModifyPackLineItem"}},"PausePackJob":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'PausePackJob', because you want to pause a packjob","enum":["PausePackJob"],"type":"string"},"packLineItemsUpdate":{"items":{"$ref":"#/components/schemas/PackLineItemForUpdate"},"type":"array"}},"required":["action"],"type":"object"}],"description":"Action to pause a PackJob","title":"PausePackJob","xml":{"name":"PausePackJob"}},"PackLineItemForUpdate":{"properties":{"id":{"description":"references the id of the packLineItem of a packJob","type":"string"},"packed":{"description":"The amount of articles that were packed for this packline. Can't be more than picked before.","format":"int64","minimum":0,"type":"integer"}},"required":["id","packed"],"type":"object","xml":{"name":"PackLineItemForUpdate"},"title":"PackLineItemForUpdate","description":"PackLineItemForUpdate"},"PackJob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"type":"array"},"customAttributes":{"description":"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.","type":"object"},"deliveryChannel":{"enum":["COLLECT","SHIPPING"],"type":"string"},"documentHandling":{"$ref":"#/components/schemas/DocumentHandling"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"facilityRef":{"description":"Reference to the facility you want to get the corresponding packjob","type":"string"},"id":{"description":"The id of this pack job. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/PackLineItem"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"Date when the order was placed.","format":"date-time","type":"string"},"orderRef":{"description":"The id of the order","type":"string"},"packingSourceContainers":{"items":{"$ref":"#/components/schemas/StrippedPackingSourceContainer"}},"pickJobRef":{"description":"Reference to a pick job","type":"string"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientName":{"description":"The name of the recipient","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/PackJobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"targetTime":{"description":"Until when the pack job must be finished.","format":"date-time","type":"string"},"tenantOrderId":{"type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["id","facilityRef","documentsRef","status","lineItems","processId","workflowInformation"],"type":"object","xml":{"name":"PackJob"}}],"title":"PackJob","description":"PackJob"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"DocumentHandling":{"properties":{"sendLabel":{"properties":{"enabled":{"default":false,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["sendLabel"],"type":"object","title":"DocumentHandling","description":"DocumentHandling"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"PackLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"packed":{"description":"The amount of articles that were packed for this packline.","format":"int32","minimum":0,"type":"integer"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"serviceJobRefs":{"description":"Reference to the service job that has altered this line item","items":{"type":"string"},"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","quantity","article"]}],"type":"object","xml":{"name":"PackLineItem"},"title":"PackLineItem","description":"PackLineItem"},"MandatoryLineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"PackLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackLineItemArticle"},"title":"PackLineItemArticle","description":"PackLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"StrippedPackingSourceContainer":{"additionalProperties":false,"properties":{"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"},"loadUnitRef":{"type":"string"}},"type":"object","title":"StrippedPackingSourceContainer","description":"StrippedPackingSourceContainer"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The id of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The id identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The id identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/{packJobId}":{"patch":{"description":"","operationId":"patchPackJob","parameters":[{"description":"ID of the packjob you want to get","in":"path","name":"packJobId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackJobPatchActions"}}},"description":"Patch set","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackJob"}}},"description":"PackJob was found & patch-set has been applied. The patched pack job is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"PackJob not found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"PackJob version conflict"}},"summary":"Update pack job","tags":["Packing (Operations)"]}}}}
```
## POST /api/packjobs/{packJobId}/actions
> Call pack job action
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackJobActionsParameter":{"anyOf":[{"$ref":"#/components/schemas/PackJobReplaceAssignedUsersActionParameter"},{"$ref":"#/components/schemas/PackJobSplitLineItemsActionParameter"},{"$ref":"#/components/schemas/UpdatePackLineItemRecordableAttributesActionParameter"},{"$ref":"#/components/schemas/PackJobMoveEachesToSourceContainerActionParameter"},{"$ref":"#/components/schemas/PackJobMoveEachesToTargetContainerActionParameter"}],"title":"PackJobActionsParameter","description":"PackJobActionsParameter"},"PackJobReplaceAssignedUsersActionParameter":{"additionalProperties":false,"description":"Action to replace the assigned users.","properties":{"assignedUsers":{"description":"Assigned users for this entity","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUserForCreationById"}]},"type":"array"},"name":{"$ref":"#/components/schemas/PackJobReplaceAssignedUsersActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","assignedUsers"],"title":"PackJobReplaceAssignedUsersActionParameter"},"AssignedUserForCreationByName":{"description":"Create a assigned user by giving a valid name","properties":{"username":{"description":"username of the user should be assigned","type":"string"}},"required":["username"],"title":"AssignedUserForCreationByName","type":"object"},"AssignedUserForCreationById":{"description":"Create a assigned user by giving a valid id","properties":{"userId":{"description":"userId of the user should be assigned","type":"string"}},"required":["userId"],"title":"AssignedUserForCreationById","type":"object"},"PackJobReplaceAssignedUsersActionEnum":{"enum":["REPLACE_ASSIGNED_USERS"],"type":"string","title":"PackJobReplaceAssignedUsersActionEnum","description":"PackJobReplaceAssignedUsersActionEnum"},"PackJobSplitLineItemsActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/PackJobSplitLineItemsActionEnum"},"splitLineItemsInfo":{"items":{"$ref":"#/components/schemas/PackJobSplitLineItemsInfo"},"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","splitLineItemsInfo"],"title":"PackJobSplitLineItemsActionParameter","type":"object","description":"PackJobSplitLineItemsActionParameter"},"PackJobSplitLineItemsActionEnum":{"enum":["SPLIT_LINES_PACK_JOB"],"type":"string","title":"PackJobSplitLineItemsActionEnum","description":"PackJobSplitLineItemsActionEnum"},"PackJobSplitLineItemsInfo":{"additionalProperties":false,"properties":{"lineItemId":{"description":"references the id of the packLineItem of a packJob","type":"string"},"packed":{"description":"The amount of articles that were packed for this line item.","format":"int64","minimum":0,"type":"integer"},"quantity":{"description":"quantity of the specific item that has been ordered","minimum":1,"type":"integer"}},"required":["lineItemId","quantity"],"type":"object","title":"PackJobSplitLineItemsInfo","description":"PackJobSplitLineItemsInfo"},"UpdatePackLineItemRecordableAttributesActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/UpdatePackLineItemRecordableAttributesActionEnum"},"recordableAttributeUpdates":{"items":{"$ref":"#/components/schemas/RecordableAttributeForUpdate"},"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","recordableAttributeUpdates"],"title":"UpdatePackLineItemRecordableAttributesActionParameter","type":"object","description":"UpdatePackLineItemRecordableAttributesActionParameter"},"UpdatePackLineItemRecordableAttributesActionEnum":{"enum":["UPDATE_PACK_LINE_ITEM_RECORDABLE_ATTRIBUTES"],"type":"string","title":"UpdatePackLineItemRecordableAttributesActionEnum","description":"UpdatePackLineItemRecordableAttributesActionEnum"},"RecordableAttributeForUpdate":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute to set","minLength":1,"nullable":true,"type":"string"},"recordableAttributeId":{"description":"id of the recordable attribute to update","type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute to set","nullable":true,"type":"string"}},"required":["recordableAttributeId"],"title":"RecordableAttributeForUpdate","type":"object","description":"RecordableAttributeForUpdate"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"PackJobMoveEachesToSourceContainerActionParameter":{"additionalProperties":false,"description":"Action to replace the assigned users.","properties":{"move":{"$ref":"#/components/schemas/PackJobMoveEachesToContainerActionParameterMove"},"name":{"$ref":"#/components/schemas/PackJobMoveEachesToSourceContainerActionEnum"}},"required":["name","move"],"title":"PackJobReplaceAssignedUsersActionParameter"},"PackJobMoveEachesToContainerActionParameterMove":{"additionalProperties":false,"description":"Assigned users for this entity","properties":{"from":{"items":{"$ref":"#/components/schemas/PackJobMoveEachesToContainerFrom"},"minItems":1,"type":"array"},"to":{"oneOf":[{"$ref":"#/components/schemas/PackJobMoveEachesToContainerTo"},{"$ref":"#/components/schemas/PackJobMoveEachesToNewContainerTo"}]}},"required":["from","to"],"type":"object","title":"PackJobMoveEachesToContainerActionParameterMove"},"PackJobMoveEachesToContainerFrom":{"additionalProperties":false,"description":"Where to take the eaches from","properties":{"containerId":{"description":"id of the container to move the eaches from","type":"string"},"containerVersion":{"description":"version of the container to move the eaches from","minimum":0,"type":"integer"},"globalLineItemId":{"description":"global line item id of the line item to move eaches from","type":"string"},"quantity":{"description":"amount of items to move","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary amount of items to move","minimum":0,"type":"integer"}},"required":["containerId","containerVersion","globalLineItemId","quantity"],"title":"PackJobMoveEachesToContainerFrom"},"PackJobMoveEachesToContainerTo":{"additionalProperties":false,"description":"Where to move the eaches to.","properties":{"containerId":{"description":"id of the container to move the eaches to","type":"string"},"containerVersion":{"description":"version of the container to move the eaches to","minimum":0,"type":"integer"}},"required":["containerId","containerVersion"],"title":"PackJobMoveEachesToContainerTo"},"PackJobMoveEachesToNewContainerTo":{"additionalProperties":false,"description":"Additional information for the new created container during a move","properties":{"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"type":"array"},"operativeContainerTypeRef":{"description":"the reference to the operativeContainerType","type":"string"}},"required":["operativeContainerTypeRef"],"title":"PackJobMoveEachesToContainerTo"},"PackJobMoveEachesToSourceContainerActionEnum":{"enum":["MOVE_EACHES_TO_PACKING_SOURCE_CONTAINER"],"type":"string","title":"PackJobMoveEachesToSourceContainerActionEnum","description":"PackJobMoveEachesToSourceContainerActionEnum"},"PackJobMoveEachesToTargetContainerActionParameter":{"additionalProperties":false,"description":"Action to replace the assigned users.","properties":{"move":{"$ref":"#/components/schemas/PackJobMoveEachesToContainerActionParameterMove"},"name":{"$ref":"#/components/schemas/PackJobMoveEachesToTargetContainerActionEnum"}},"required":["name","move"],"title":"PackJobReplaceAssignedUsersActionParameter"},"PackJobMoveEachesToTargetContainerActionEnum":{"enum":["MOVE_EACHES_TO_PACKING_TARGET_CONTAINER"],"type":"string","title":"PackJobMoveEachesToTargetContainerActionEnum","description":"PackJobMoveEachesToTargetContainerActionEnum"},"PackJob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"type":"array"},"customAttributes":{"description":"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.","type":"object"},"deliveryChannel":{"enum":["COLLECT","SHIPPING"],"type":"string"},"documentHandling":{"$ref":"#/components/schemas/DocumentHandling"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"facilityRef":{"description":"Reference to the facility you want to get the corresponding packjob","type":"string"},"id":{"description":"The id of this pack job. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/PackLineItem"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"Date when the order was placed.","format":"date-time","type":"string"},"orderRef":{"description":"The id of the order","type":"string"},"packingSourceContainers":{"items":{"$ref":"#/components/schemas/StrippedPackingSourceContainer"}},"pickJobRef":{"description":"Reference to a pick job","type":"string"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientName":{"description":"The name of the recipient","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/PackJobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"targetTime":{"description":"Until when the pack job must be finished.","format":"date-time","type":"string"},"tenantOrderId":{"type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["id","facilityRef","documentsRef","status","lineItems","processId","workflowInformation"],"type":"object","xml":{"name":"PackJob"}}],"title":"PackJob","description":"PackJob"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"DocumentHandling":{"properties":{"sendLabel":{"properties":{"enabled":{"default":false,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["sendLabel"],"type":"object","title":"DocumentHandling","description":"DocumentHandling"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"PackLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"packed":{"description":"The amount of articles that were packed for this packline.","format":"int32","minimum":0,"type":"integer"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"serviceJobRefs":{"description":"Reference to the service job that has altered this line item","items":{"type":"string"},"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","quantity","article"]}],"type":"object","xml":{"name":"PackLineItem"},"title":"PackLineItem","description":"PackLineItem"},"MandatoryLineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"PackLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackLineItemArticle"},"title":"PackLineItemArticle","description":"PackLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"StrippedPackingSourceContainer":{"additionalProperties":false,"properties":{"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"},"loadUnitRef":{"type":"string"}},"type":"object","title":"StrippedPackingSourceContainer","description":"StrippedPackingSourceContainer"},"PackJobStatus":{"description":"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.","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string","xml":{"name":"PackJobStatus"},"title":"PackJobStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The id of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The id identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The id identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/{packJobId}/actions":{"post":{"operationId":"packJobAction","parameters":[{"description":"Reference to the pack job you want to call an action for","in":"path","name":"packJobId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackJobActionsParameter"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackJob"}}},"description":"Updated PackJob in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Enitity not found"}},"summary":"Call pack job action","tags":["Packing (Operations)"]}}}}
```
## GET /api/packjobs/{packJobId}/deliverynote
> Get pack job delivery note
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/{packJobId}/deliverynote":{"get":{"description":"","operationId":"getPackJobDeliveryNote","parameters":[{"description":"ID of the pack job for which you want to get a deliverynote","in":"path","name":"packJobId","required":true,"schema":{"type":"string"}},{"description":"Provide the localized values for the delivery note. If not provided the default locale is used. For example de_DE.","in":"query","name":"locale","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/pdf":{}},"description":"The deliverynote for the given packjob"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get pack job delivery note","tags":["Packing (Operations)"]}}}}
```
## GET /api/packjobs/{packJobId}/documenthandling
> Get pack job document handling
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"DocumentHandling":{"properties":{"sendLabel":{"properties":{"enabled":{"default":false,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["sendLabel"],"type":"object","title":"DocumentHandling","description":"DocumentHandling"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/{packJobId}/documenthandling":{"get":{"description":"","operationId":"getPackJobDocumentHandling","parameters":[{"description":"ID of the pack job you want to get document handling information","in":"path","name":"packJobId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentHandling"}}},"description":"Pack job document handling was found & you were allowed to access it. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get pack job document handling","tags":["Packing (Operations)"]}}}}
```
## GET /api/packjobs/{packJobId}/returnnote
> Get pack job return note
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/{packJobId}/returnnote":{"get":{"description":"","operationId":"getReturnNotesForPackJob","parameters":[{"description":"ID of the PackJob","in":"path","name":"packJobId","required":true,"schema":{"type":"string"}},{"description":"Provide the localized values for the delivery note. If not provided the default locale is used. For example de_DE.","in":"query","name":"locale","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/pdf":{}},"description":"Returns a return note for the packjob."},"401":{"content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get pack job return note","tags":["Packing (Operations)"]}}}}
```
## List pack job target containers
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Returns all packing containers on given packJob
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackingTargetContainer":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/PackingTargetContainerForCreation"}],"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Description of the packing source container in the locale the client requests. Automatically filled upon request.","type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request","type":"string"},"iconUrl":{"description":"Url to the icon of the packing source container (inherited from operative container type).","type":"string"},"id":{"description":"The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingTargetContainerLineItem"},"type":"array"},"name":{"description":"Name of the packing source container in the locale the client requests. Automatically filled upon request.","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this packing target container is related to.","type":"string"},"packJobRef":{"description":"Reference to the packJob this packing source container is related to.","type":"string"},"parcels":{"items":{"$ref":"#/components/schemas/Parcel"},"type":"array"},"shortId":{"description":"Short identifier for the container","type":"string"},"type":{"$ref":"#/components/schemas/PackingTargetContainerType"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with. ","minimum":1,"type":"number"}},"required":["id","nameLocalized","version","facilityRef","packJobRef","lineItems","type"],"type":"object","title":"PackingTargetContainer","description":"PackingTargetContainer"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"PackingTargetContainerForCreation":{"properties":{"codes":{"items":{"description":"List of codes","minItems":1,"type":"string"},"type":"array"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingTargetContainerLineItemForCreation"},"type":"array"},"operativeContainerTypeRef":{"type":"string"},"packingContainerTypeRef":{"description":"deprecated - use operativeContainerTypeRef instead","type":"string"},"storageLocationRef":{"description":"Reference to the location where the packing target container is located.","type":"string"}},"required":["codes"],"type":"object","title":"PackingTargetContainerForCreation","description":"PackingTargetContainerForCreation"},"PackingTargetContainerLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"}],"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"quantity":{"description":"quantity of the item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryQuantity is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["article","quantity"],"title":"PackingTargetContainerLineItemForCreation","description":"PackingTargetContainerLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"PackingTargetContainerLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/PackingTargetContainerAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackingTargetContainerLineItemArticle"},"title":"PackingTargetContainerLineItemArticle","description":"PackingTargetContainerLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"PackingTargetContainerAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"PackingTargetContainerAttributeItem","description":"PackingTargetContainerAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"PackingTargetContainerLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"quantity":{"description":"quantity of the item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryQuantity is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","article","quantity"],"title":"PackingTargetContainerLineItem","description":"PackingTargetContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"Parcel":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierInformation":{"$ref":"#/components/schemas/ParcelCarrierInformation"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"Reference to the carrier this parcel should be send by","type":"string"},"customAttributes":{"description":"Attributes that can be added to the parcel. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"customProductValue":{"description":"Set this value if you want to overwrite the calculated product value of the parcel. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"dimensions":{"$ref":"#/components/schemas/ParcelDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"type":"string"},"id":{"description":"The id of this parcel. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"items":{"items":{"$ref":"#/components/schemas/ParcelItem"},"type":"array"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickUpInformation":{"$ref":"#/components/schemas/ParcelPickUpInformation"},"postalCharges":{"$ref":"#/components/schemas/ParcelPostalCharge"},"processRef":{"type":"string"},"productValue":{"description":"Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"productValueCurrency":{"$ref":"#/components/schemas/ProductValueCurrency"},"productValueType":{"$ref":"#/components/schemas/ProductValueType"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"result":{"$ref":"#/components/schemas/ParcelResult"},"returnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"sender":{"$ref":"#/components/schemas/FacilityAddress"},"services":{"$ref":"#/components/schemas/ParcelServices"},"shipmentRef":{"description":"The id of this shipment this parcel has been created for.","type":"string"},"shortId":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"},"tenantOrderId":{"description":"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.","type":"string"},"tenantParcelId":{"description":"Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"}},"required":["id","status","carrierRef","processRef","sender","recipient","loadUnitRefs"],"type":"object"}],"title":"Parcel","description":"Parcel"},"ParcelCarrierInformation":{"additionalProperties":false,"description":"Carrier specific information about the parcel for the label creation","properties":{"shippingContainerNumber":{"description":"Specific shipping container number for the parcel","type":"string"}},"type":"object","title":"ParcelCarrierInformation"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"description":"Set this value if you want to overwrite the calculated weight of the parcel (in g).","type":"number"},"height":{"description":"The height of the package (in cm)","type":"number"},"length":{"description":"The length of the package (in cm)","type":"number"},"weight":{"description":"The weight of the package (in g)","type":"number"},"width":{"description":"The width of the package (in cm)","type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ParcelItem":{"allOf":[{"$ref":"#/components/schemas/LineItem"}],"properties":{"article":{"$ref":"#/components/schemas/ParcelItemArticle"},"countryOfManufacture":{"deprecated":true,"description":"Deprecated - use article.attribute.countryOfManufacture instead","type":"string"},"description":{"deprecated":true,"description":"Description - article.title will be used instead - of the given item/items","type":"string"},"hsCode":{"deprecated":true,"description":"Deprecated - use article.attribute.hsCode instead","maxLength":50,"type":"string"},"id":{"description":"The id of this parcelItem.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"parcelItemValue":{"$ref":"#/components/schemas/ParcelItemValue","deprecated":true,"description":"Deprecated - use article.attribute.pricePerUnit and article.attribute.currency instead"},"quantity":{"description":"amount of the given items","minimum":1,"type":"integer"},"weightInGram":{"deprecated":true,"description":"Deprecated - use article.attribute.weightPerUnit instead - Weight of a single item in gram","type":"integer"}},"required":["id","quantity"],"type":"object","xml":{"name":"ParcelItem"},"title":"ParcelItem","description":"ParcelItem"},"LineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id"],"title":"LineItem","type":"object","description":"LineItem"},"ParcelItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ParcelItemArticle"},"title":"ParcelItemArticle","description":"ParcelItemArticle"},"ParcelItemValue":{"description":"deprecated, use MandatoryShippingArticleAttribute.attributes.pricePerUnit instead","nullable":true,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"},"type":{"$ref":"#/components/schemas/ProductValueType"},"value":{"description":"Monetary Value of a single item in the given currency","type":"number"}},"required":["value","currency"],"type":"object","title":"ParcelItemValue"},"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"ParcelPickUpInformation":{"additionalProperties":false,"nullable":true,"properties":{"endTime":{"description":"needs to be after start time","format":"date-time","type":"string"},"startTime":{"description":"needs to be before end time","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelPickUpInformation","description":"ParcelPickUpInformation"},"ParcelPostalCharge":{"properties":{"currency":{"description":"Currency of the given value","type":"string"},"value":{"description":"Monetary Value in the given currency","type":"number"}},"required":["currency","value"],"title":"ParcelPostalCharge","description":"ParcelPostalCharge"},"ProductValueCurrency":{"additionalProperties":false,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"}},"required":["currency"],"type":"object","title":"ProductValueCurrency","description":"ProductValueCurrency"},"ParcelResult":{"description":"Within this object you can find the result of the request after it has been processed (status = DONE or FAILED)","properties":{"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierTrackingNumber":{"type":"string"},"carrierTrackingStatus":{"oneOf":[{"$ref":"#/components/schemas/TrackingStatus"},{"$ref":"#/components/schemas/DhlTrackingStatus"}]},"customsDocumentId":{"description":"The customs document id","type":"string"},"customsDocumentUrl":{"description":"The original customs document URL","type":"string"},"errors":{"additionalProperties":false,"description":"temporary field to show errors during parcel creation, will be removed in the future. used to create summary in error case","properties":{"labelError":{"type":"string"},"returnLabelError":{"type":"string"}},"type":"object"},"labelUrl":{"description":"The URL where you can download the label relative to the path of this resource","type":"string"},"proxyId":{"description":"The ID of the corresponding job at the CEP proxy (if used)","type":"string"},"returnLabelId":{"description":"The original return label id","type":"string"},"returnLabelUrl":{"description":"The original return label URL","type":"string"},"returnTrackingUrl":{"description":"The URL to track the return of this parcel","type":"string"},"sendLabelUrl":{"description":"The original send label URL","type":"string"},"summary":{"description":"Summary of the result of the request in a human readable form.","type":"string"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["summary"],"type":"object","title":"ParcelResult"},"TrackingStatus":{"description":"The state of the KEP","enum":["registered","picked_up","delivered","not_delivered","transit","exception","out_for_delivery","destroyed","unknown","canceled","awaits_pickup_by_receiver","delayed","notification"],"title":"TrackingStatus","type":"string"},"DhlTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"location":{"$ref":"#/components/schemas/DhlTrackingLocation"},"remark":{"description":"Remark of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"statusCode":{"description":"Status code of the parcel as provided by carrier","type":"string"},"statusDetailed":{"description":"Second status description","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"title":"DhlTrackingStatus","type":"object"},"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"title":"DhlTrackingLocation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ParcelServices":{"additionalProperties":false,"nullable":true,"properties":{"additionalTransportInsurance":{"description":"Additional insurance for the parcel by the carrier","type":"boolean"},"adultSignature":{"description":"Signature from some adult","type":"boolean"},"bulkyGoods":{"type":"boolean"},"customerSignature":{"description":"Signature from the ordering customer needed","type":"boolean"},"identityCheckCompany":{"description":"Identity check that can be done by a person of receiving company","type":"boolean"},"identityCheckPrivate":{"description":"Identity check that can be done by the receiving person","type":"boolean"},"saturdayDelivery":{"description":"Saturday Delivery","type":"boolean"},"signature":{"description":"Signature from anyone needed","type":"boolean"}},"type":"object","title":"ParcelServices","description":"ParcelServices"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The id of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"PackingTargetContainerType":{"description":"Type of the packing taret container","enum":["VIRTUAL","PHYSICAL"],"type":"string","title":"PackingTargetContainerType"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/{packJobId}/targetcontainers":{"get":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns all packing containers on given packJob","operationId":"getAllTargetcontainers","parameters":[{"description":"ID of the pack job you want to get","in":"path","name":"packJobId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PackingTargetContainer"}}}},"description":"Entity was found & you were allowed to access it. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"List pack job target containers","tags":["Packing (Operations)"]}}}}
```
## Create pack job target container
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Creates a new packing target container on given packJob
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackingTargetContainerForCreation":{"properties":{"codes":{"items":{"description":"List of codes","minItems":1,"type":"string"},"type":"array"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingTargetContainerLineItemForCreation"},"type":"array"},"operativeContainerTypeRef":{"type":"string"},"packingContainerTypeRef":{"description":"deprecated - use operativeContainerTypeRef instead","type":"string"},"storageLocationRef":{"description":"Reference to the location where the packing target container is located.","type":"string"}},"required":["codes"],"type":"object","title":"PackingTargetContainerForCreation","description":"PackingTargetContainerForCreation"},"PackingTargetContainerLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"}],"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"quantity":{"description":"quantity of the item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryQuantity is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["article","quantity"],"title":"PackingTargetContainerLineItemForCreation","description":"PackingTargetContainerLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"PackingTargetContainerLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/PackingTargetContainerAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackingTargetContainerLineItemArticle"},"title":"PackingTargetContainerLineItemArticle","description":"PackingTargetContainerLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"PackingTargetContainerAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"PackingTargetContainerAttributeItem","description":"PackingTargetContainerAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PackingTargetContainer":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/PackingTargetContainerForCreation"}],"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Description of the packing source container in the locale the client requests. Automatically filled upon request.","type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request","type":"string"},"iconUrl":{"description":"Url to the icon of the packing source container (inherited from operative container type).","type":"string"},"id":{"description":"The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingTargetContainerLineItem"},"type":"array"},"name":{"description":"Name of the packing source container in the locale the client requests. Automatically filled upon request.","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this packing target container is related to.","type":"string"},"packJobRef":{"description":"Reference to the packJob this packing source container is related to.","type":"string"},"parcels":{"items":{"$ref":"#/components/schemas/Parcel"},"type":"array"},"shortId":{"description":"Short identifier for the container","type":"string"},"type":{"$ref":"#/components/schemas/PackingTargetContainerType"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with. ","minimum":1,"type":"number"}},"required":["id","nameLocalized","version","facilityRef","packJobRef","lineItems","type"],"type":"object","title":"PackingTargetContainer","description":"PackingTargetContainer"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"PackingTargetContainerLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"quantity":{"description":"quantity of the item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryQuantity is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","article","quantity"],"title":"PackingTargetContainerLineItem","description":"PackingTargetContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"Parcel":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierInformation":{"$ref":"#/components/schemas/ParcelCarrierInformation"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"Reference to the carrier this parcel should be send by","type":"string"},"customAttributes":{"description":"Attributes that can be added to the parcel. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"customProductValue":{"description":"Set this value if you want to overwrite the calculated product value of the parcel. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"dimensions":{"$ref":"#/components/schemas/ParcelDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"type":"string"},"id":{"description":"The id of this parcel. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"items":{"items":{"$ref":"#/components/schemas/ParcelItem"},"type":"array"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickUpInformation":{"$ref":"#/components/schemas/ParcelPickUpInformation"},"postalCharges":{"$ref":"#/components/schemas/ParcelPostalCharge"},"processRef":{"type":"string"},"productValue":{"description":"Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"productValueCurrency":{"$ref":"#/components/schemas/ProductValueCurrency"},"productValueType":{"$ref":"#/components/schemas/ProductValueType"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"result":{"$ref":"#/components/schemas/ParcelResult"},"returnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"sender":{"$ref":"#/components/schemas/FacilityAddress"},"services":{"$ref":"#/components/schemas/ParcelServices"},"shipmentRef":{"description":"The id of this shipment this parcel has been created for.","type":"string"},"shortId":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"},"tenantOrderId":{"description":"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.","type":"string"},"tenantParcelId":{"description":"Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"}},"required":["id","status","carrierRef","processRef","sender","recipient","loadUnitRefs"],"type":"object"}],"title":"Parcel","description":"Parcel"},"ParcelCarrierInformation":{"additionalProperties":false,"description":"Carrier specific information about the parcel for the label creation","properties":{"shippingContainerNumber":{"description":"Specific shipping container number for the parcel","type":"string"}},"type":"object","title":"ParcelCarrierInformation"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"description":"Set this value if you want to overwrite the calculated weight of the parcel (in g).","type":"number"},"height":{"description":"The height of the package (in cm)","type":"number"},"length":{"description":"The length of the package (in cm)","type":"number"},"weight":{"description":"The weight of the package (in g)","type":"number"},"width":{"description":"The width of the package (in cm)","type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ParcelItem":{"allOf":[{"$ref":"#/components/schemas/LineItem"}],"properties":{"article":{"$ref":"#/components/schemas/ParcelItemArticle"},"countryOfManufacture":{"deprecated":true,"description":"Deprecated - use article.attribute.countryOfManufacture instead","type":"string"},"description":{"deprecated":true,"description":"Description - article.title will be used instead - of the given item/items","type":"string"},"hsCode":{"deprecated":true,"description":"Deprecated - use article.attribute.hsCode instead","maxLength":50,"type":"string"},"id":{"description":"The id of this parcelItem.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"parcelItemValue":{"$ref":"#/components/schemas/ParcelItemValue","deprecated":true,"description":"Deprecated - use article.attribute.pricePerUnit and article.attribute.currency instead"},"quantity":{"description":"amount of the given items","minimum":1,"type":"integer"},"weightInGram":{"deprecated":true,"description":"Deprecated - use article.attribute.weightPerUnit instead - Weight of a single item in gram","type":"integer"}},"required":["id","quantity"],"type":"object","xml":{"name":"ParcelItem"},"title":"ParcelItem","description":"ParcelItem"},"LineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id"],"title":"LineItem","type":"object","description":"LineItem"},"ParcelItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ParcelItemArticle"},"title":"ParcelItemArticle","description":"ParcelItemArticle"},"ParcelItemValue":{"description":"deprecated, use MandatoryShippingArticleAttribute.attributes.pricePerUnit instead","nullable":true,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"},"type":{"$ref":"#/components/schemas/ProductValueType"},"value":{"description":"Monetary Value of a single item in the given currency","type":"number"}},"required":["value","currency"],"type":"object","title":"ParcelItemValue"},"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"ParcelPickUpInformation":{"additionalProperties":false,"nullable":true,"properties":{"endTime":{"description":"needs to be after start time","format":"date-time","type":"string"},"startTime":{"description":"needs to be before end time","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelPickUpInformation","description":"ParcelPickUpInformation"},"ParcelPostalCharge":{"properties":{"currency":{"description":"Currency of the given value","type":"string"},"value":{"description":"Monetary Value in the given currency","type":"number"}},"required":["currency","value"],"title":"ParcelPostalCharge","description":"ParcelPostalCharge"},"ProductValueCurrency":{"additionalProperties":false,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"}},"required":["currency"],"type":"object","title":"ProductValueCurrency","description":"ProductValueCurrency"},"ParcelResult":{"description":"Within this object you can find the result of the request after it has been processed (status = DONE or FAILED)","properties":{"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierTrackingNumber":{"type":"string"},"carrierTrackingStatus":{"oneOf":[{"$ref":"#/components/schemas/TrackingStatus"},{"$ref":"#/components/schemas/DhlTrackingStatus"}]},"customsDocumentId":{"description":"The customs document id","type":"string"},"customsDocumentUrl":{"description":"The original customs document URL","type":"string"},"errors":{"additionalProperties":false,"description":"temporary field to show errors during parcel creation, will be removed in the future. used to create summary in error case","properties":{"labelError":{"type":"string"},"returnLabelError":{"type":"string"}},"type":"object"},"labelUrl":{"description":"The URL where you can download the label relative to the path of this resource","type":"string"},"proxyId":{"description":"The ID of the corresponding job at the CEP proxy (if used)","type":"string"},"returnLabelId":{"description":"The original return label id","type":"string"},"returnLabelUrl":{"description":"The original return label URL","type":"string"},"returnTrackingUrl":{"description":"The URL to track the return of this parcel","type":"string"},"sendLabelUrl":{"description":"The original send label URL","type":"string"},"summary":{"description":"Summary of the result of the request in a human readable form.","type":"string"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["summary"],"type":"object","title":"ParcelResult"},"TrackingStatus":{"description":"The state of the KEP","enum":["registered","picked_up","delivered","not_delivered","transit","exception","out_for_delivery","destroyed","unknown","canceled","awaits_pickup_by_receiver","delayed","notification"],"title":"TrackingStatus","type":"string"},"DhlTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"location":{"$ref":"#/components/schemas/DhlTrackingLocation"},"remark":{"description":"Remark of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"statusCode":{"description":"Status code of the parcel as provided by carrier","type":"string"},"statusDetailed":{"description":"Second status description","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"title":"DhlTrackingStatus","type":"object"},"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"title":"DhlTrackingLocation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ParcelServices":{"additionalProperties":false,"nullable":true,"properties":{"additionalTransportInsurance":{"description":"Additional insurance for the parcel by the carrier","type":"boolean"},"adultSignature":{"description":"Signature from some adult","type":"boolean"},"bulkyGoods":{"type":"boolean"},"customerSignature":{"description":"Signature from the ordering customer needed","type":"boolean"},"identityCheckCompany":{"description":"Identity check that can be done by a person of receiving company","type":"boolean"},"identityCheckPrivate":{"description":"Identity check that can be done by the receiving person","type":"boolean"},"saturdayDelivery":{"description":"Saturday Delivery","type":"boolean"},"signature":{"description":"Signature from anyone needed","type":"boolean"}},"type":"object","title":"ParcelServices","description":"ParcelServices"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The id of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"PackingTargetContainerType":{"description":"Type of the packing taret container","enum":["VIRTUAL","PHYSICAL"],"type":"string","title":"PackingTargetContainerType"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/{packJobId}/targetcontainers":{"post":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Creates a new packing target container on given packJob","operationId":"addTargetContainers","parameters":[{"description":"ID of the pack job you want to get","in":"path","name":"packJobId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackingTargetContainerForCreation"}}},"description":"Packing Container object","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackingTargetContainer"}}},"description":"The packing container was successfully created."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create pack job target container","tags":["Packing (Operations)"]}}}}
```
## Get pack job target container
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Returns a packing target container with the given ID on given packJob
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackingTargetContainer":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/PackingTargetContainerForCreation"}],"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Description of the packing source container in the locale the client requests. Automatically filled upon request.","type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request","type":"string"},"iconUrl":{"description":"Url to the icon of the packing source container (inherited from operative container type).","type":"string"},"id":{"description":"The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingTargetContainerLineItem"},"type":"array"},"name":{"description":"Name of the packing source container in the locale the client requests. Automatically filled upon request.","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this packing target container is related to.","type":"string"},"packJobRef":{"description":"Reference to the packJob this packing source container is related to.","type":"string"},"parcels":{"items":{"$ref":"#/components/schemas/Parcel"},"type":"array"},"shortId":{"description":"Short identifier for the container","type":"string"},"type":{"$ref":"#/components/schemas/PackingTargetContainerType"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with. ","minimum":1,"type":"number"}},"required":["id","nameLocalized","version","facilityRef","packJobRef","lineItems","type"],"type":"object","title":"PackingTargetContainer","description":"PackingTargetContainer"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"PackingTargetContainerForCreation":{"properties":{"codes":{"items":{"description":"List of codes","minItems":1,"type":"string"},"type":"array"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingTargetContainerLineItemForCreation"},"type":"array"},"operativeContainerTypeRef":{"type":"string"},"packingContainerTypeRef":{"description":"deprecated - use operativeContainerTypeRef instead","type":"string"},"storageLocationRef":{"description":"Reference to the location where the packing target container is located.","type":"string"}},"required":["codes"],"type":"object","title":"PackingTargetContainerForCreation","description":"PackingTargetContainerForCreation"},"PackingTargetContainerLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"}],"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"quantity":{"description":"quantity of the item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryQuantity is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["article","quantity"],"title":"PackingTargetContainerLineItemForCreation","description":"PackingTargetContainerLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"PackingTargetContainerLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/PackingTargetContainerAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackingTargetContainerLineItemArticle"},"title":"PackingTargetContainerLineItemArticle","description":"PackingTargetContainerLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"PackingTargetContainerAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"PackingTargetContainerAttributeItem","description":"PackingTargetContainerAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"PackingTargetContainerLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"quantity":{"description":"quantity of the item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryQuantity is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","article","quantity"],"title":"PackingTargetContainerLineItem","description":"PackingTargetContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"Parcel":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierInformation":{"$ref":"#/components/schemas/ParcelCarrierInformation"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"Reference to the carrier this parcel should be send by","type":"string"},"customAttributes":{"description":"Attributes that can be added to the parcel. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"customProductValue":{"description":"Set this value if you want to overwrite the calculated product value of the parcel. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"dimensions":{"$ref":"#/components/schemas/ParcelDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"type":"string"},"id":{"description":"The id of this parcel. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"items":{"items":{"$ref":"#/components/schemas/ParcelItem"},"type":"array"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickUpInformation":{"$ref":"#/components/schemas/ParcelPickUpInformation"},"postalCharges":{"$ref":"#/components/schemas/ParcelPostalCharge"},"processRef":{"type":"string"},"productValue":{"description":"Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"productValueCurrency":{"$ref":"#/components/schemas/ProductValueCurrency"},"productValueType":{"$ref":"#/components/schemas/ProductValueType"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"result":{"$ref":"#/components/schemas/ParcelResult"},"returnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"sender":{"$ref":"#/components/schemas/FacilityAddress"},"services":{"$ref":"#/components/schemas/ParcelServices"},"shipmentRef":{"description":"The id of this shipment this parcel has been created for.","type":"string"},"shortId":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"},"tenantOrderId":{"description":"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.","type":"string"},"tenantParcelId":{"description":"Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"}},"required":["id","status","carrierRef","processRef","sender","recipient","loadUnitRefs"],"type":"object"}],"title":"Parcel","description":"Parcel"},"ParcelCarrierInformation":{"additionalProperties":false,"description":"Carrier specific information about the parcel for the label creation","properties":{"shippingContainerNumber":{"description":"Specific shipping container number for the parcel","type":"string"}},"type":"object","title":"ParcelCarrierInformation"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"description":"Set this value if you want to overwrite the calculated weight of the parcel (in g).","type":"number"},"height":{"description":"The height of the package (in cm)","type":"number"},"length":{"description":"The length of the package (in cm)","type":"number"},"weight":{"description":"The weight of the package (in g)","type":"number"},"width":{"description":"The width of the package (in cm)","type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ParcelItem":{"allOf":[{"$ref":"#/components/schemas/LineItem"}],"properties":{"article":{"$ref":"#/components/schemas/ParcelItemArticle"},"countryOfManufacture":{"deprecated":true,"description":"Deprecated - use article.attribute.countryOfManufacture instead","type":"string"},"description":{"deprecated":true,"description":"Description - article.title will be used instead - of the given item/items","type":"string"},"hsCode":{"deprecated":true,"description":"Deprecated - use article.attribute.hsCode instead","maxLength":50,"type":"string"},"id":{"description":"The id of this parcelItem.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"parcelItemValue":{"$ref":"#/components/schemas/ParcelItemValue","deprecated":true,"description":"Deprecated - use article.attribute.pricePerUnit and article.attribute.currency instead"},"quantity":{"description":"amount of the given items","minimum":1,"type":"integer"},"weightInGram":{"deprecated":true,"description":"Deprecated - use article.attribute.weightPerUnit instead - Weight of a single item in gram","type":"integer"}},"required":["id","quantity"],"type":"object","xml":{"name":"ParcelItem"},"title":"ParcelItem","description":"ParcelItem"},"LineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id"],"title":"LineItem","type":"object","description":"LineItem"},"ParcelItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ParcelItemArticle"},"title":"ParcelItemArticle","description":"ParcelItemArticle"},"ParcelItemValue":{"description":"deprecated, use MandatoryShippingArticleAttribute.attributes.pricePerUnit instead","nullable":true,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"},"type":{"$ref":"#/components/schemas/ProductValueType"},"value":{"description":"Monetary Value of a single item in the given currency","type":"number"}},"required":["value","currency"],"type":"object","title":"ParcelItemValue"},"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"ParcelPickUpInformation":{"additionalProperties":false,"nullable":true,"properties":{"endTime":{"description":"needs to be after start time","format":"date-time","type":"string"},"startTime":{"description":"needs to be before end time","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelPickUpInformation","description":"ParcelPickUpInformation"},"ParcelPostalCharge":{"properties":{"currency":{"description":"Currency of the given value","type":"string"},"value":{"description":"Monetary Value in the given currency","type":"number"}},"required":["currency","value"],"title":"ParcelPostalCharge","description":"ParcelPostalCharge"},"ProductValueCurrency":{"additionalProperties":false,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"}},"required":["currency"],"type":"object","title":"ProductValueCurrency","description":"ProductValueCurrency"},"ParcelResult":{"description":"Within this object you can find the result of the request after it has been processed (status = DONE or FAILED)","properties":{"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierTrackingNumber":{"type":"string"},"carrierTrackingStatus":{"oneOf":[{"$ref":"#/components/schemas/TrackingStatus"},{"$ref":"#/components/schemas/DhlTrackingStatus"}]},"customsDocumentId":{"description":"The customs document id","type":"string"},"customsDocumentUrl":{"description":"The original customs document URL","type":"string"},"errors":{"additionalProperties":false,"description":"temporary field to show errors during parcel creation, will be removed in the future. used to create summary in error case","properties":{"labelError":{"type":"string"},"returnLabelError":{"type":"string"}},"type":"object"},"labelUrl":{"description":"The URL where you can download the label relative to the path of this resource","type":"string"},"proxyId":{"description":"The ID of the corresponding job at the CEP proxy (if used)","type":"string"},"returnLabelId":{"description":"The original return label id","type":"string"},"returnLabelUrl":{"description":"The original return label URL","type":"string"},"returnTrackingUrl":{"description":"The URL to track the return of this parcel","type":"string"},"sendLabelUrl":{"description":"The original send label URL","type":"string"},"summary":{"description":"Summary of the result of the request in a human readable form.","type":"string"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["summary"],"type":"object","title":"ParcelResult"},"TrackingStatus":{"description":"The state of the KEP","enum":["registered","picked_up","delivered","not_delivered","transit","exception","out_for_delivery","destroyed","unknown","canceled","awaits_pickup_by_receiver","delayed","notification"],"title":"TrackingStatus","type":"string"},"DhlTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"location":{"$ref":"#/components/schemas/DhlTrackingLocation"},"remark":{"description":"Remark of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"statusCode":{"description":"Status code of the parcel as provided by carrier","type":"string"},"statusDetailed":{"description":"Second status description","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"title":"DhlTrackingStatus","type":"object"},"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"title":"DhlTrackingLocation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ParcelServices":{"additionalProperties":false,"nullable":true,"properties":{"additionalTransportInsurance":{"description":"Additional insurance for the parcel by the carrier","type":"boolean"},"adultSignature":{"description":"Signature from some adult","type":"boolean"},"bulkyGoods":{"type":"boolean"},"customerSignature":{"description":"Signature from the ordering customer needed","type":"boolean"},"identityCheckCompany":{"description":"Identity check that can be done by a person of receiving company","type":"boolean"},"identityCheckPrivate":{"description":"Identity check that can be done by the receiving person","type":"boolean"},"saturdayDelivery":{"description":"Saturday Delivery","type":"boolean"},"signature":{"description":"Signature from anyone needed","type":"boolean"}},"type":"object","title":"ParcelServices","description":"ParcelServices"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The id of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"PackingTargetContainerType":{"description":"Type of the packing taret container","enum":["VIRTUAL","PHYSICAL"],"type":"string","title":"PackingTargetContainerType"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}":{"get":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns a packing target container with the given ID on given packJob","operationId":"getTargetcontainer","parameters":[{"description":"Provide the localized values for the entity. If not provided the default locale is used. For example de_DE.","in":"query","name":"locale","schema":{"type":"string"}},{"description":"ID of the pack job you want to get","in":"path","name":"packJobId","required":true,"schema":{"type":"string"}},{"description":"ID of the target container you want to get","in":"path","name":"targetcontainerId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackingTargetContainer"}}},"description":"Entity was found & you were allowed to access it. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get pack job target container","tags":["Packing (Operations)"]}}}}
```
## Add pack job target container line item
> This part of the API is deprecated. For details please check the \api-release-life-cycle documentation\.\
\
Deprecated. Use /api/packjobs/{packJobId}/actions with MOVE\_EACHES\_TO\_PACKING\_TARGET\_CONTAINER or MOVE\_EACHES\_TO\_PACKING\_SOURCE\_CONTAINER instead
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackingTargetContainerLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"}],"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"quantity":{"description":"quantity of the item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryQuantity is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["article","quantity"],"title":"PackingTargetContainerLineItemForCreation","description":"PackingTargetContainerLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"PackingTargetContainerLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/PackingTargetContainerAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackingTargetContainerLineItemArticle"},"title":"PackingTargetContainerLineItemArticle","description":"PackingTargetContainerLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"PackingTargetContainerAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"PackingTargetContainerAttributeItem","description":"PackingTargetContainerAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PackingTargetContainer":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/PackingTargetContainerForCreation"}],"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Description of the packing source container in the locale the client requests. Automatically filled upon request.","type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request","type":"string"},"iconUrl":{"description":"Url to the icon of the packing source container (inherited from operative container type).","type":"string"},"id":{"description":"The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingTargetContainerLineItem"},"type":"array"},"name":{"description":"Name of the packing source container in the locale the client requests. Automatically filled upon request.","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this packing target container is related to.","type":"string"},"packJobRef":{"description":"Reference to the packJob this packing source container is related to.","type":"string"},"parcels":{"items":{"$ref":"#/components/schemas/Parcel"},"type":"array"},"shortId":{"description":"Short identifier for the container","type":"string"},"type":{"$ref":"#/components/schemas/PackingTargetContainerType"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with. ","minimum":1,"type":"number"}},"required":["id","nameLocalized","version","facilityRef","packJobRef","lineItems","type"],"type":"object","title":"PackingTargetContainer","description":"PackingTargetContainer"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"PackingTargetContainerForCreation":{"properties":{"codes":{"items":{"description":"List of codes","minItems":1,"type":"string"},"type":"array"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingTargetContainerLineItemForCreation"},"type":"array"},"operativeContainerTypeRef":{"type":"string"},"packingContainerTypeRef":{"description":"deprecated - use operativeContainerTypeRef instead","type":"string"},"storageLocationRef":{"description":"Reference to the location where the packing target container is located.","type":"string"}},"required":["codes"],"type":"object","title":"PackingTargetContainerForCreation","description":"PackingTargetContainerForCreation"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"PackingTargetContainerLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"quantity":{"description":"quantity of the item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryQuantity is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","article","quantity"],"title":"PackingTargetContainerLineItem","description":"PackingTargetContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"Parcel":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierInformation":{"$ref":"#/components/schemas/ParcelCarrierInformation"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"Reference to the carrier this parcel should be send by","type":"string"},"customAttributes":{"description":"Attributes that can be added to the parcel. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"customProductValue":{"description":"Set this value if you want to overwrite the calculated product value of the parcel. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"dimensions":{"$ref":"#/components/schemas/ParcelDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"type":"string"},"id":{"description":"The id of this parcel. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"items":{"items":{"$ref":"#/components/schemas/ParcelItem"},"type":"array"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickUpInformation":{"$ref":"#/components/schemas/ParcelPickUpInformation"},"postalCharges":{"$ref":"#/components/schemas/ParcelPostalCharge"},"processRef":{"type":"string"},"productValue":{"description":"Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"productValueCurrency":{"$ref":"#/components/schemas/ProductValueCurrency"},"productValueType":{"$ref":"#/components/schemas/ProductValueType"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"result":{"$ref":"#/components/schemas/ParcelResult"},"returnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"sender":{"$ref":"#/components/schemas/FacilityAddress"},"services":{"$ref":"#/components/schemas/ParcelServices"},"shipmentRef":{"description":"The id of this shipment this parcel has been created for.","type":"string"},"shortId":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"},"tenantOrderId":{"description":"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.","type":"string"},"tenantParcelId":{"description":"Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"}},"required":["id","status","carrierRef","processRef","sender","recipient","loadUnitRefs"],"type":"object"}],"title":"Parcel","description":"Parcel"},"ParcelCarrierInformation":{"additionalProperties":false,"description":"Carrier specific information about the parcel for the label creation","properties":{"shippingContainerNumber":{"description":"Specific shipping container number for the parcel","type":"string"}},"type":"object","title":"ParcelCarrierInformation"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"description":"Set this value if you want to overwrite the calculated weight of the parcel (in g).","type":"number"},"height":{"description":"The height of the package (in cm)","type":"number"},"length":{"description":"The length of the package (in cm)","type":"number"},"weight":{"description":"The weight of the package (in g)","type":"number"},"width":{"description":"The width of the package (in cm)","type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ParcelItem":{"allOf":[{"$ref":"#/components/schemas/LineItem"}],"properties":{"article":{"$ref":"#/components/schemas/ParcelItemArticle"},"countryOfManufacture":{"deprecated":true,"description":"Deprecated - use article.attribute.countryOfManufacture instead","type":"string"},"description":{"deprecated":true,"description":"Description - article.title will be used instead - of the given item/items","type":"string"},"hsCode":{"deprecated":true,"description":"Deprecated - use article.attribute.hsCode instead","maxLength":50,"type":"string"},"id":{"description":"The id of this parcelItem.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"parcelItemValue":{"$ref":"#/components/schemas/ParcelItemValue","deprecated":true,"description":"Deprecated - use article.attribute.pricePerUnit and article.attribute.currency instead"},"quantity":{"description":"amount of the given items","minimum":1,"type":"integer"},"weightInGram":{"deprecated":true,"description":"Deprecated - use article.attribute.weightPerUnit instead - Weight of a single item in gram","type":"integer"}},"required":["id","quantity"],"type":"object","xml":{"name":"ParcelItem"},"title":"ParcelItem","description":"ParcelItem"},"LineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id"],"title":"LineItem","type":"object","description":"LineItem"},"ParcelItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ParcelItemArticle"},"title":"ParcelItemArticle","description":"ParcelItemArticle"},"ParcelItemValue":{"description":"deprecated, use MandatoryShippingArticleAttribute.attributes.pricePerUnit instead","nullable":true,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"},"type":{"$ref":"#/components/schemas/ProductValueType"},"value":{"description":"Monetary Value of a single item in the given currency","type":"number"}},"required":["value","currency"],"type":"object","title":"ParcelItemValue"},"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"ParcelPickUpInformation":{"additionalProperties":false,"nullable":true,"properties":{"endTime":{"description":"needs to be after start time","format":"date-time","type":"string"},"startTime":{"description":"needs to be before end time","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelPickUpInformation","description":"ParcelPickUpInformation"},"ParcelPostalCharge":{"properties":{"currency":{"description":"Currency of the given value","type":"string"},"value":{"description":"Monetary Value in the given currency","type":"number"}},"required":["currency","value"],"title":"ParcelPostalCharge","description":"ParcelPostalCharge"},"ProductValueCurrency":{"additionalProperties":false,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"}},"required":["currency"],"type":"object","title":"ProductValueCurrency","description":"ProductValueCurrency"},"ParcelResult":{"description":"Within this object you can find the result of the request after it has been processed (status = DONE or FAILED)","properties":{"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierTrackingNumber":{"type":"string"},"carrierTrackingStatus":{"oneOf":[{"$ref":"#/components/schemas/TrackingStatus"},{"$ref":"#/components/schemas/DhlTrackingStatus"}]},"customsDocumentId":{"description":"The customs document id","type":"string"},"customsDocumentUrl":{"description":"The original customs document URL","type":"string"},"errors":{"additionalProperties":false,"description":"temporary field to show errors during parcel creation, will be removed in the future. used to create summary in error case","properties":{"labelError":{"type":"string"},"returnLabelError":{"type":"string"}},"type":"object"},"labelUrl":{"description":"The URL where you can download the label relative to the path of this resource","type":"string"},"proxyId":{"description":"The ID of the corresponding job at the CEP proxy (if used)","type":"string"},"returnLabelId":{"description":"The original return label id","type":"string"},"returnLabelUrl":{"description":"The original return label URL","type":"string"},"returnTrackingUrl":{"description":"The URL to track the return of this parcel","type":"string"},"sendLabelUrl":{"description":"The original send label URL","type":"string"},"summary":{"description":"Summary of the result of the request in a human readable form.","type":"string"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["summary"],"type":"object","title":"ParcelResult"},"TrackingStatus":{"description":"The state of the KEP","enum":["registered","picked_up","delivered","not_delivered","transit","exception","out_for_delivery","destroyed","unknown","canceled","awaits_pickup_by_receiver","delayed","notification"],"title":"TrackingStatus","type":"string"},"DhlTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"location":{"$ref":"#/components/schemas/DhlTrackingLocation"},"remark":{"description":"Remark of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"statusCode":{"description":"Status code of the parcel as provided by carrier","type":"string"},"statusDetailed":{"description":"Second status description","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"title":"DhlTrackingStatus","type":"object"},"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"title":"DhlTrackingLocation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ParcelServices":{"additionalProperties":false,"nullable":true,"properties":{"additionalTransportInsurance":{"description":"Additional insurance for the parcel by the carrier","type":"boolean"},"adultSignature":{"description":"Signature from some adult","type":"boolean"},"bulkyGoods":{"type":"boolean"},"customerSignature":{"description":"Signature from the ordering customer needed","type":"boolean"},"identityCheckCompany":{"description":"Identity check that can be done by a person of receiving company","type":"boolean"},"identityCheckPrivate":{"description":"Identity check that can be done by the receiving person","type":"boolean"},"saturdayDelivery":{"description":"Saturday Delivery","type":"boolean"},"signature":{"description":"Signature from anyone needed","type":"boolean"}},"type":"object","title":"ParcelServices","description":"ParcelServices"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The id of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"PackingTargetContainerType":{"description":"Type of the packing taret container","enum":["VIRTUAL","PHYSICAL"],"type":"string","title":"PackingTargetContainerType"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}":{"post":{"deprecated":true,"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
Deprecated. Use /api/packjobs/{packJobId}/actions with MOVE_EACHES_TO_PACKING_TARGET_CONTAINER or MOVE_EACHES_TO_PACKING_SOURCE_CONTAINER instead","operationId":"addTargetcontainer","parameters":[{"description":"ID of the pack job you want to get","in":"path","name":"packJobId","required":true,"schema":{"type":"string"}},{"description":"ID of the container you want to add new line item to it","in":"path","name":"targetcontainerId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackingTargetContainerLineItemForCreation"}}},"description":"Packing Container line item object","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackingTargetContainer"}}},"description":"The packing container was successfully created."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Add pack job target container line item","tags":["Packing (Operations)"]}}}}
```
## Delete pack job target container
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Deletes a packing target container
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}":{"delete":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Deletes a packing target container","operationId":"deletePackingTargetContainer","parameters":[{"description":"ID of corresponding packJob you want to patch","in":"path","name":"packJobId","required":true,"schema":{"type":"string"}},{"description":"ID of container you want to delete","in":"path","name":"targetcontainerId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Container was found & you were allowed to delete it."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Delete pack job target container","tags":["Packing (Operations)"]}}}}
```
## Update pack job target container
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Patches a packing target container
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackingTargetContainerPatchActions":{"properties":{"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/ReplaceCodesInPackingTargetContainer"},{"$ref":"#/components/schemas/AddLineItemToPackingTargetContainer"},{"$ref":"#/components/schemas/RemoveLineItemFromPackingTargetContainer"},{"$ref":"#/components/schemas/UpdateLineItemOnPackingTargetContainer"},{"$ref":"#/components/schemas/UpdatePackingTargetContainerLineItemRecordableAttributes"}]},"minItems":1,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","actions"],"type":"object","xml":{"name":"PackingTargetContainerPatchActions"},"title":"PackingTargetContainerPatchActions","description":"PackingTargetContainerPatchActions"},"ReplaceCodesInPackingTargetContainer":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use ReplaceCodesInPackingTargetContainer to add a code to an existing packing container","enum":["ReplaceCodesInPackingTargetContainer"],"type":"string"},"codes":{"items":{"description":"List of codes","minItems":1,"type":"string"},"type":"array"}},"required":["action"],"type":"object"}],"description":"Action to replace codes in packing target container.","title":"ReplaceCodesInPackingTargetContainer","xml":{"name":"ReplaceCodesInPackingTargetContainer"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyPickJob","ModifyPickJobLastEditor","RestartPickJob","ResetPickJob","CancelPickRun","CancelHandoverjob","AbortPickJob","FinishPickRun","StartPickRun","ModifyPickLineItem","ModifyPickRunLineItem","ModifyPackJob","PausePackJob","ModifyPackLineItem","SplitLineItemsPackJob","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyShipment","ModifyHandoverjob","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyLoadUnitType","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyRestowItem","RemovePickJobFromPickRun","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","ModifyPackingContainerType","ModifyPackingContainerTypeIcon","ReplaceCodesInPackingTargetContainer","ReplaceLoadUnitLineItems","AddLineItemToPackingTargetContainer","RemoveLineItemFromPackingTargetContainer","UpdateLineItemOnPackingTargetContainer","UpdatePackingTargetContainerLineItemRecordableAttributes","ModifyCustomService","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"AddLineItemToPackingTargetContainer":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"'Deprecated. Use /api/packjobs/{packJobId}/actions with MOVE_EACHES_TO_PACKING_TARGET_CONTAINER or MOVE_EACHES_TO_PACKING_SOURCE_CONTAINER instead'","enum":["AddLineItemToPackingTargetContainer"],"type":"string"},"lineItem":{"$ref":"#/components/schemas/PackingTargetContainerLineItemForCreation"}},"required":["action","lineItem"],"type":"object"}],"description":"Action to a line item to a packing target container.","title":"AddLineItemToPackingTargetContainer","xml":{"name":"AddLineItemToPackingTargetContainer"}},"PackingTargetContainerLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"}],"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"quantity":{"description":"quantity of the item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryQuantity is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["article","quantity"],"title":"PackingTargetContainerLineItemForCreation","description":"PackingTargetContainerLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"PackingTargetContainerLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/PackingTargetContainerAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackingTargetContainerLineItemArticle"},"title":"PackingTargetContainerLineItemArticle","description":"PackingTargetContainerLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"PackingTargetContainerAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"PackingTargetContainerAttributeItem","description":"PackingTargetContainerAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"RemoveLineItemFromPackingTargetContainer":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"'Deprecated. Use /api/packjobs/{packJobId}/actions with MOVE_EACHES_TO_PACKING_TARGET_CONTAINER or MOVE_EACHES_TO_PACKING_SOURCE_CONTAINER instead'","enum":["RemoveLineItemFromPackingTargetContainer"],"type":"string"},"lineItemRef":{"description":"Id of the PackLineItem you want to remove.","type":"string"}},"required":["action","lineItemRef"],"type":"object"}],"description":"Action to a remove a line item from a packing target container.","title":"RemoveLineItemFromPackingTargetContainer","xml":{"name":"RemoveLineItemFromPackingTargetContainer"}},"UpdateLineItemOnPackingTargetContainer":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use UpdateLineItemOnPackingTargetContainer to change a line item on an existing packing container","enum":["UpdateLineItemOnPackingTargetContainer"],"type":"string"},"lineItem":{"$ref":"#/components/schemas/PackingTargetContainerLineItem"}},"required":["action","lineItem"],"type":"object"}],"description":"Action to a update a line item of a packing target container.","title":"UpdateLineItemOnPackingTargetContainer","xml":{"name":"UpdateLineItemOnPackingTargetContainer"}},"PackingTargetContainerLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"quantity":{"description":"quantity of the item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryQuantity is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","article","quantity"],"title":"PackingTargetContainerLineItem","description":"PackingTargetContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"UpdatePackingTargetContainerLineItemRecordableAttributes":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use this action to update the recordable attributes of the line items of a packing target container","enum":["UpdatePackingTargetContainerLineItemRecordableAttributes"],"type":"string"},"recordableAttributeUpdates":{"items":{"$ref":"#/components/schemas/RecordableAttributeForUpdate"},"type":"array"}},"required":["action","recordableAttributeUpdates"],"type":"object"}],"description":"Action to a update the recordable attributes of the line items of a packing target container.","title":"UpdatePackingTargetContainerLineItemRecordableAttributes","xml":{"name":"UpdatePackingTargetContainerLineItemRecordableAttributes"}},"RecordableAttributeForUpdate":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute to set","minLength":1,"nullable":true,"type":"string"},"recordableAttributeId":{"description":"id of the recordable attribute to update","type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute to set","nullable":true,"type":"string"}},"required":["recordableAttributeId"],"title":"RecordableAttributeForUpdate","type":"object","description":"RecordableAttributeForUpdate"},"PackingTargetContainer":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/PackingTargetContainerForCreation"}],"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Description of the packing source container in the locale the client requests. Automatically filled upon request.","type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request","type":"string"},"iconUrl":{"description":"Url to the icon of the packing source container (inherited from operative container type).","type":"string"},"id":{"description":"The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingTargetContainerLineItem"},"type":"array"},"name":{"description":"Name of the packing source container in the locale the client requests. Automatically filled upon request.","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this packing target container is related to.","type":"string"},"packJobRef":{"description":"Reference to the packJob this packing source container is related to.","type":"string"},"parcels":{"items":{"$ref":"#/components/schemas/Parcel"},"type":"array"},"shortId":{"description":"Short identifier for the container","type":"string"},"type":{"$ref":"#/components/schemas/PackingTargetContainerType"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with. ","minimum":1,"type":"number"}},"required":["id","nameLocalized","version","facilityRef","packJobRef","lineItems","type"],"type":"object","title":"PackingTargetContainer","description":"PackingTargetContainer"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"PackingTargetContainerForCreation":{"properties":{"codes":{"items":{"description":"List of codes","minItems":1,"type":"string"},"type":"array"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingTargetContainerLineItemForCreation"},"type":"array"},"operativeContainerTypeRef":{"type":"string"},"packingContainerTypeRef":{"description":"deprecated - use operativeContainerTypeRef instead","type":"string"},"storageLocationRef":{"description":"Reference to the location where the packing target container is located.","type":"string"}},"required":["codes"],"type":"object","title":"PackingTargetContainerForCreation","description":"PackingTargetContainerForCreation"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"Parcel":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierInformation":{"$ref":"#/components/schemas/ParcelCarrierInformation"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"Reference to the carrier this parcel should be send by","type":"string"},"customAttributes":{"description":"Attributes that can be added to the parcel. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"customProductValue":{"description":"Set this value if you want to overwrite the calculated product value of the parcel. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"dimensions":{"$ref":"#/components/schemas/ParcelDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"type":"string"},"id":{"description":"The id of this parcel. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"items":{"items":{"$ref":"#/components/schemas/ParcelItem"},"type":"array"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickUpInformation":{"$ref":"#/components/schemas/ParcelPickUpInformation"},"postalCharges":{"$ref":"#/components/schemas/ParcelPostalCharge"},"processRef":{"type":"string"},"productValue":{"description":"Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"productValueCurrency":{"$ref":"#/components/schemas/ProductValueCurrency"},"productValueType":{"$ref":"#/components/schemas/ProductValueType"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"result":{"$ref":"#/components/schemas/ParcelResult"},"returnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"sender":{"$ref":"#/components/schemas/FacilityAddress"},"services":{"$ref":"#/components/schemas/ParcelServices"},"shipmentRef":{"description":"The id of this shipment this parcel has been created for.","type":"string"},"shortId":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"},"tenantOrderId":{"description":"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.","type":"string"},"tenantParcelId":{"description":"Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"}},"required":["id","status","carrierRef","processRef","sender","recipient","loadUnitRefs"],"type":"object"}],"title":"Parcel","description":"Parcel"},"ParcelCarrierInformation":{"additionalProperties":false,"description":"Carrier specific information about the parcel for the label creation","properties":{"shippingContainerNumber":{"description":"Specific shipping container number for the parcel","type":"string"}},"type":"object","title":"ParcelCarrierInformation"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"description":"Set this value if you want to overwrite the calculated weight of the parcel (in g).","type":"number"},"height":{"description":"The height of the package (in cm)","type":"number"},"length":{"description":"The length of the package (in cm)","type":"number"},"weight":{"description":"The weight of the package (in g)","type":"number"},"width":{"description":"The width of the package (in cm)","type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ParcelItem":{"allOf":[{"$ref":"#/components/schemas/LineItem"}],"properties":{"article":{"$ref":"#/components/schemas/ParcelItemArticle"},"countryOfManufacture":{"deprecated":true,"description":"Deprecated - use article.attribute.countryOfManufacture instead","type":"string"},"description":{"deprecated":true,"description":"Description - article.title will be used instead - of the given item/items","type":"string"},"hsCode":{"deprecated":true,"description":"Deprecated - use article.attribute.hsCode instead","maxLength":50,"type":"string"},"id":{"description":"The id of this parcelItem.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"parcelItemValue":{"$ref":"#/components/schemas/ParcelItemValue","deprecated":true,"description":"Deprecated - use article.attribute.pricePerUnit and article.attribute.currency instead"},"quantity":{"description":"amount of the given items","minimum":1,"type":"integer"},"weightInGram":{"deprecated":true,"description":"Deprecated - use article.attribute.weightPerUnit instead - Weight of a single item in gram","type":"integer"}},"required":["id","quantity"],"type":"object","xml":{"name":"ParcelItem"},"title":"ParcelItem","description":"ParcelItem"},"LineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id"],"title":"LineItem","type":"object","description":"LineItem"},"ParcelItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ParcelItemArticle"},"title":"ParcelItemArticle","description":"ParcelItemArticle"},"ParcelItemValue":{"description":"deprecated, use MandatoryShippingArticleAttribute.attributes.pricePerUnit instead","nullable":true,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"},"type":{"$ref":"#/components/schemas/ProductValueType"},"value":{"description":"Monetary Value of a single item in the given currency","type":"number"}},"required":["value","currency"],"type":"object","title":"ParcelItemValue"},"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"ParcelPickUpInformation":{"additionalProperties":false,"nullable":true,"properties":{"endTime":{"description":"needs to be after start time","format":"date-time","type":"string"},"startTime":{"description":"needs to be before end time","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelPickUpInformation","description":"ParcelPickUpInformation"},"ParcelPostalCharge":{"properties":{"currency":{"description":"Currency of the given value","type":"string"},"value":{"description":"Monetary Value in the given currency","type":"number"}},"required":["currency","value"],"title":"ParcelPostalCharge","description":"ParcelPostalCharge"},"ProductValueCurrency":{"additionalProperties":false,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"}},"required":["currency"],"type":"object","title":"ProductValueCurrency","description":"ProductValueCurrency"},"ParcelResult":{"description":"Within this object you can find the result of the request after it has been processed (status = DONE or FAILED)","properties":{"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierTrackingNumber":{"type":"string"},"carrierTrackingStatus":{"oneOf":[{"$ref":"#/components/schemas/TrackingStatus"},{"$ref":"#/components/schemas/DhlTrackingStatus"}]},"customsDocumentId":{"description":"The customs document id","type":"string"},"customsDocumentUrl":{"description":"The original customs document URL","type":"string"},"errors":{"additionalProperties":false,"description":"temporary field to show errors during parcel creation, will be removed in the future. used to create summary in error case","properties":{"labelError":{"type":"string"},"returnLabelError":{"type":"string"}},"type":"object"},"labelUrl":{"description":"The URL where you can download the label relative to the path of this resource","type":"string"},"proxyId":{"description":"The ID of the corresponding job at the CEP proxy (if used)","type":"string"},"returnLabelId":{"description":"The original return label id","type":"string"},"returnLabelUrl":{"description":"The original return label URL","type":"string"},"returnTrackingUrl":{"description":"The URL to track the return of this parcel","type":"string"},"sendLabelUrl":{"description":"The original send label URL","type":"string"},"summary":{"description":"Summary of the result of the request in a human readable form.","type":"string"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["summary"],"type":"object","title":"ParcelResult"},"TrackingStatus":{"description":"The state of the KEP","enum":["registered","picked_up","delivered","not_delivered","transit","exception","out_for_delivery","destroyed","unknown","canceled","awaits_pickup_by_receiver","delayed","notification"],"title":"TrackingStatus","type":"string"},"DhlTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"location":{"$ref":"#/components/schemas/DhlTrackingLocation"},"remark":{"description":"Remark of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"statusCode":{"description":"Status code of the parcel as provided by carrier","type":"string"},"statusDetailed":{"description":"Second status description","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"title":"DhlTrackingStatus","type":"object"},"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"title":"DhlTrackingLocation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ParcelServices":{"additionalProperties":false,"nullable":true,"properties":{"additionalTransportInsurance":{"description":"Additional insurance for the parcel by the carrier","type":"boolean"},"adultSignature":{"description":"Signature from some adult","type":"boolean"},"bulkyGoods":{"type":"boolean"},"customerSignature":{"description":"Signature from the ordering customer needed","type":"boolean"},"identityCheckCompany":{"description":"Identity check that can be done by a person of receiving company","type":"boolean"},"identityCheckPrivate":{"description":"Identity check that can be done by the receiving person","type":"boolean"},"saturdayDelivery":{"description":"Saturday Delivery","type":"boolean"},"signature":{"description":"Signature from anyone needed","type":"boolean"}},"type":"object","title":"ParcelServices","description":"ParcelServices"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The id of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"PackingTargetContainerType":{"description":"Type of the packing taret container","enum":["VIRTUAL","PHYSICAL"],"type":"string","title":"PackingTargetContainerType"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}":{"patch":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Patches a packing target container","operationId":"patchTargetcontainer","parameters":[{"description":"ID of corresponding packJob you want to patch","in":"path","name":"packJobId","required":true,"schema":{"type":"string"}},{"description":"ID of container you want to patch","in":"path","name":"targetcontainerId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackingTargetContainerPatchActions"}}},"description":"Patch set","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackingTargetContainer"}}},"description":"Container was found & patch-set has been applied. The patched entity is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity version conflict"}},"summary":"Update pack job target container","tags":["Packing (Operations)"]}}}}
```
## GET /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/deliverynote
> Get target container delivery note
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/deliverynote":{"get":{"description":"","operationId":"getPackingTargetContainerDeliveryNote","parameters":[{"description":"ID of the pack job for which you want to get a deliverynote","in":"path","name":"packJobId","required":true,"schema":{"type":"string"}},{"description":"ID of the packingTargetContainer for which you want to get a deliverynote","in":"path","name":"targetcontainerId","required":true,"schema":{"type":"string"}},{"description":"Provide the localized values for the delivery note. If not provided the default locale is used. For example de_DE.","in":"query","name":"locale","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/pdf":{}},"description":"The deliverynote for the given packingTargetContainer"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get target container delivery note","tags":["Packing (Operations)"]}}}}
```
## Delete target container line item
> This part of the API is deprecated. For details please check the \api-release-life-cycle documentation\.\
\
Deprecated. Use /api/packjobs/{packJobId}/actions with MOVE\_EACHES\_TO\_PACKING\_TARGET\_CONTAINER or MOVE\_EACHES\_TO\_PACKING\_SOURCE\_CONTAINER instead
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/lineitems/{lineItemId}":{"delete":{"deprecated":true,"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
Deprecated. Use /api/packjobs/{packJobId}/actions with MOVE_EACHES_TO_PACKING_TARGET_CONTAINER or MOVE_EACHES_TO_PACKING_SOURCE_CONTAINER instead","operationId":"deleteLineItemTargetContainers","parameters":[{"description":"ID of corresponding packJob you want to patch","in":"path","name":"packJobId","required":true,"schema":{"type":"string"}},{"description":"ID of container you want to patch","in":"path","name":"targetcontainerId","required":true,"schema":{"type":"string"}},{"description":"ID of line item you want to patch","in":"path","name":"lineItemId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"LineItem was found & you were allowed to delete it."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility not found"}},"summary":"Delete target container line item","tags":["Packing (Operations)"]}}}}
```
## Update target container line item
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Patch line item of a packing container
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackingTargetContainerActionsParameter":{"anyOf":[{"$ref":"#/components/schemas/UpdatePackingTargetContainerLineItemAction"},{"$ref":"#/components/schemas/ReplacePackingTargetContainerLineItemCodesAction"}],"title":"PackingTargetContainerActionsParameter","description":"PackingTargetContainerActionsParameter"},"UpdatePackingTargetContainerLineItemAction":{"additionalProperties":false,"description":"Action to update a packing target container of a line item.","properties":{"name":{"$ref":"#/components/schemas/UpdatePackingTargetContainerLineItemEnum"},"payload":{"additionalProperties":false,"properties":{"lineItem":{"$ref":"#/components/schemas/PackingTargetContainerLineItem"}},"required":["lineItem"]},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["version","payload","name"],"title":"UpdatePackingTargetContainerLineItemAction"},"UpdatePackingTargetContainerLineItemEnum":{"enum":["UpdateLineItem"],"type":"string","title":"UpdatePackingTargetContainerLineItemEnum","description":"UpdatePackingTargetContainerLineItemEnum"},"PackingTargetContainerLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"quantity":{"description":"quantity of the item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryQuantity is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","article","quantity"],"title":"PackingTargetContainerLineItem","description":"PackingTargetContainerLineItem"},"MandatoryLineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"PackingTargetContainerLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/PackingTargetContainerAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackingTargetContainerLineItemArticle"},"title":"PackingTargetContainerLineItemArticle","description":"PackingTargetContainerLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"PackingTargetContainerAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"PackingTargetContainerAttributeItem","description":"PackingTargetContainerAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"ReplacePackingTargetContainerLineItemCodesAction":{"additionalProperties":false,"description":"Action to replace packing target container codes of a line item.","properties":{"name":{"$ref":"#/components/schemas/ReplacePackingTargetContainerLineItemCodesEnum"},"payload":{"additionalProperties":false,"properties":{"codes":{"items":{"description":"List of codes","minItems":1,"type":"string"},"type":"array"}},"required":["codes"]},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["payload","version","name"],"title":"ReplacePackingTargetContainerLineItemCodesAction"},"ReplacePackingTargetContainerLineItemCodesEnum":{"enum":["ReplaceLineItemCodes"],"type":"string","title":"ReplacePackingTargetContainerLineItemCodesEnum","description":"ReplacePackingTargetContainerLineItemCodesEnum"},"PackingTargetContainer":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/PackingTargetContainerForCreation"}],"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Description of the packing source container in the locale the client requests. Automatically filled upon request.","type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request","type":"string"},"iconUrl":{"description":"Url to the icon of the packing source container (inherited from operative container type).","type":"string"},"id":{"description":"The id of this packing source container. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingTargetContainerLineItem"},"type":"array"},"name":{"description":"Name of the packing source container in the locale the client requests. Automatically filled upon request.","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this packing target container is related to.","type":"string"},"packJobRef":{"description":"Reference to the packJob this packing source container is related to.","type":"string"},"parcels":{"items":{"$ref":"#/components/schemas/Parcel"},"type":"array"},"shortId":{"description":"Short identifier for the container","type":"string"},"type":{"$ref":"#/components/schemas/PackingTargetContainerType"},"weightLimitInG":{"description":"Maximal weight in gramm(gr) the container can be loaded with. ","minimum":1,"type":"number"}},"required":["id","nameLocalized","version","facilityRef","packJobRef","lineItems","type"],"type":"object","title":"PackingTargetContainer","description":"PackingTargetContainer"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"PackingTargetContainerForCreation":{"properties":{"codes":{"items":{"description":"List of codes","minItems":1,"type":"string"},"type":"array"},"lineItems":{"items":{"$ref":"#/components/schemas/PackingTargetContainerLineItemForCreation"},"type":"array"},"operativeContainerTypeRef":{"type":"string"},"packingContainerTypeRef":{"description":"deprecated - use operativeContainerTypeRef instead","type":"string"},"storageLocationRef":{"description":"Reference to the location where the packing target container is located.","type":"string"}},"required":["codes"],"type":"object","title":"PackingTargetContainerForCreation","description":"PackingTargetContainerForCreation"},"PackingTargetContainerLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"}],"properties":{"article":{"$ref":"#/components/schemas/PackingTargetContainerLineItemArticle"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"quantity":{"description":"quantity of the item","format":"int64","minimum":1,"type":"integer"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryQuantity is gram","type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["article","quantity"],"title":"PackingTargetContainerLineItemForCreation","description":"PackingTargetContainerLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"Parcel":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierInformation":{"$ref":"#/components/schemas/ParcelCarrierInformation"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"Reference to the carrier this parcel should be send by","type":"string"},"customAttributes":{"description":"Attributes that can be added to the parcel. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"customProductValue":{"description":"Set this value if you want to overwrite the calculated product value of the parcel. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"dimensions":{"$ref":"#/components/schemas/ParcelDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"type":"string"},"id":{"description":"The id of this parcel. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"items":{"items":{"$ref":"#/components/schemas/ParcelItem"},"type":"array"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickUpInformation":{"$ref":"#/components/schemas/ParcelPickUpInformation"},"postalCharges":{"$ref":"#/components/schemas/ParcelPostalCharge"},"processRef":{"type":"string"},"productValue":{"description":"Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"productValueCurrency":{"$ref":"#/components/schemas/ProductValueCurrency"},"productValueType":{"$ref":"#/components/schemas/ProductValueType"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"result":{"$ref":"#/components/schemas/ParcelResult"},"returnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"sender":{"$ref":"#/components/schemas/FacilityAddress"},"services":{"$ref":"#/components/schemas/ParcelServices"},"shipmentRef":{"description":"The id of this shipment this parcel has been created for.","type":"string"},"shortId":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"},"tenantOrderId":{"description":"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.","type":"string"},"tenantParcelId":{"description":"Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"}},"required":["id","status","carrierRef","processRef","sender","recipient","loadUnitRefs"],"type":"object"}],"title":"Parcel","description":"Parcel"},"ParcelCarrierInformation":{"additionalProperties":false,"description":"Carrier specific information about the parcel for the label creation","properties":{"shippingContainerNumber":{"description":"Specific shipping container number for the parcel","type":"string"}},"type":"object","title":"ParcelCarrierInformation"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"description":"Set this value if you want to overwrite the calculated weight of the parcel (in g).","type":"number"},"height":{"description":"The height of the package (in cm)","type":"number"},"length":{"description":"The length of the package (in cm)","type":"number"},"weight":{"description":"The weight of the package (in g)","type":"number"},"width":{"description":"The width of the package (in cm)","type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ParcelItem":{"allOf":[{"$ref":"#/components/schemas/LineItem"}],"properties":{"article":{"$ref":"#/components/schemas/ParcelItemArticle"},"countryOfManufacture":{"deprecated":true,"description":"Deprecated - use article.attribute.countryOfManufacture instead","type":"string"},"description":{"deprecated":true,"description":"Description - article.title will be used instead - of the given item/items","type":"string"},"hsCode":{"deprecated":true,"description":"Deprecated - use article.attribute.hsCode instead","maxLength":50,"type":"string"},"id":{"description":"The id of this parcelItem.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"parcelItemValue":{"$ref":"#/components/schemas/ParcelItemValue","deprecated":true,"description":"Deprecated - use article.attribute.pricePerUnit and article.attribute.currency instead"},"quantity":{"description":"amount of the given items","minimum":1,"type":"integer"},"weightInGram":{"deprecated":true,"description":"Deprecated - use article.attribute.weightPerUnit instead - Weight of a single item in gram","type":"integer"}},"required":["id","quantity"],"type":"object","xml":{"name":"ParcelItem"},"title":"ParcelItem","description":"ParcelItem"},"LineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id"],"title":"LineItem","type":"object","description":"LineItem"},"ParcelItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ParcelItemArticle"},"title":"ParcelItemArticle","description":"ParcelItemArticle"},"ParcelItemValue":{"description":"deprecated, use MandatoryShippingArticleAttribute.attributes.pricePerUnit instead","nullable":true,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"},"type":{"$ref":"#/components/schemas/ProductValueType"},"value":{"description":"Monetary Value of a single item in the given currency","type":"number"}},"required":["value","currency"],"type":"object","title":"ParcelItemValue"},"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"ParcelPickUpInformation":{"additionalProperties":false,"nullable":true,"properties":{"endTime":{"description":"needs to be after start time","format":"date-time","type":"string"},"startTime":{"description":"needs to be before end time","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelPickUpInformation","description":"ParcelPickUpInformation"},"ParcelPostalCharge":{"properties":{"currency":{"description":"Currency of the given value","type":"string"},"value":{"description":"Monetary Value in the given currency","type":"number"}},"required":["currency","value"],"title":"ParcelPostalCharge","description":"ParcelPostalCharge"},"ProductValueCurrency":{"additionalProperties":false,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"}},"required":["currency"],"type":"object","title":"ProductValueCurrency","description":"ProductValueCurrency"},"ParcelResult":{"description":"Within this object you can find the result of the request after it has been processed (status = DONE or FAILED)","properties":{"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierTrackingNumber":{"type":"string"},"carrierTrackingStatus":{"oneOf":[{"$ref":"#/components/schemas/TrackingStatus"},{"$ref":"#/components/schemas/DhlTrackingStatus"}]},"customsDocumentId":{"description":"The customs document id","type":"string"},"customsDocumentUrl":{"description":"The original customs document URL","type":"string"},"errors":{"additionalProperties":false,"description":"temporary field to show errors during parcel creation, will be removed in the future. used to create summary in error case","properties":{"labelError":{"type":"string"},"returnLabelError":{"type":"string"}},"type":"object"},"labelUrl":{"description":"The URL where you can download the label relative to the path of this resource","type":"string"},"proxyId":{"description":"The ID of the corresponding job at the CEP proxy (if used)","type":"string"},"returnLabelId":{"description":"The original return label id","type":"string"},"returnLabelUrl":{"description":"The original return label URL","type":"string"},"returnTrackingUrl":{"description":"The URL to track the return of this parcel","type":"string"},"sendLabelUrl":{"description":"The original send label URL","type":"string"},"summary":{"description":"Summary of the result of the request in a human readable form.","type":"string"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["summary"],"type":"object","title":"ParcelResult"},"TrackingStatus":{"description":"The state of the KEP","enum":["registered","picked_up","delivered","not_delivered","transit","exception","out_for_delivery","destroyed","unknown","canceled","awaits_pickup_by_receiver","delayed","notification"],"title":"TrackingStatus","type":"string"},"DhlTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"location":{"$ref":"#/components/schemas/DhlTrackingLocation"},"remark":{"description":"Remark of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"statusCode":{"description":"Status code of the parcel as provided by carrier","type":"string"},"statusDetailed":{"description":"Second status description","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"title":"DhlTrackingStatus","type":"object"},"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"title":"DhlTrackingLocation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ParcelServices":{"additionalProperties":false,"nullable":true,"properties":{"additionalTransportInsurance":{"description":"Additional insurance for the parcel by the carrier","type":"boolean"},"adultSignature":{"description":"Signature from some adult","type":"boolean"},"bulkyGoods":{"type":"boolean"},"customerSignature":{"description":"Signature from the ordering customer needed","type":"boolean"},"identityCheckCompany":{"description":"Identity check that can be done by a person of receiving company","type":"boolean"},"identityCheckPrivate":{"description":"Identity check that can be done by the receiving person","type":"boolean"},"saturdayDelivery":{"description":"Saturday Delivery","type":"boolean"},"signature":{"description":"Signature from anyone needed","type":"boolean"}},"type":"object","title":"ParcelServices","description":"ParcelServices"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The id of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"PackingTargetContainerType":{"description":"Type of the packing taret container","enum":["VIRTUAL","PHYSICAL"],"type":"string","title":"PackingTargetContainerType"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/lineitems/{lineItemId}":{"patch":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Patch line item of a packing container","operationId":"patchTargetContainerLineItem","parameters":[{"description":"ID of corresponding packJob you want to patch","in":"path","name":"packJobId","required":true,"schema":{"type":"string"}},{"description":"ID of container you want to patch","in":"path","name":"targetcontainerId","required":true,"schema":{"type":"string"}},{"description":"ID of line item you want to patch","in":"path","name":"lineItemId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackingTargetContainerActionsParameter"}}},"description":"Patch set","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackingTargetContainer"}}},"description":"Container was found & patch-set has been applied. The patched entity is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity version conflict"}},"summary":"Update target container line item","tags":["Packing (Operations)"]}}}}
```
## GET /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/returnnote
> Get target container return note
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/returnnote":{"get":{"description":"","operationId":"getReturnNotesForPackingTargetContainer","parameters":[{"description":"ID of the pack job for which you want to get a deliverynote","in":"path","name":"packJobId","required":true,"schema":{"type":"string"}},{"description":"ID of the PackingTargetContainer","in":"path","name":"targetcontainerId","required":true,"schema":{"type":"string"}},{"description":"Provide the localized values for the return note. If not provided the default locale is used. For example de_DE.","in":"query","name":"locale","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/pdf":{}},"description":"Returns a return note for the PackingTargetContainer."},"401":{"content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get target container return note","tags":["Packing (Operations)"]}}}}
```
## GET /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/transferlabel
> Get target container transfer label
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/transferlabel":{"get":{"description":"","operationId":"getPackingTargetContainerTransferLabel","parameters":[{"description":"ID of the pack job for which you want to get a transfer label","in":"path","name":"packJobId","required":true,"schema":{"type":"string"}},{"description":"ID of the packingTargetContainer for which you want to get a transfer label","in":"path","name":"targetcontainerId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/pdf":{}},"description":"The transfer label for the given packingTargetContainer"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get target container transfer label","tags":["Packing (Operations)"]}}}}
```
## GET /api/packjobs/{packJobId}/transferlabel
> Get pack job transfer label
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/{packJobId}/transferlabel":{"get":{"description":"","operationId":"getPackJobTransferLabel","parameters":[{"description":"ID of the pack job for which you want to get a transfer label","in":"path","name":"packJobId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/pdf":{}},"description":"The transfer label for the given packjob"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get pack job transfer label","tags":["Packing (Operations)"]}}}}
```
## List pack jobs (search)
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Search for PackJob
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints facilitate the packing process.","name":"Packing (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackJobSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"$ref":"#/components/schemas/SearchOptions"},"query":{"$ref":"#/components/schemas/PackJobSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/PackJobSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"PackJobSearchPayload","type":"object","description":"PackJobSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"PackJobSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/PackJobSearchQuery"},"maxItems":500,"type":"array"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"invoice":{"allOf":[{"$ref":"#/components/schemas/PackJobInvoiceFilter"}],"description":"Nested search by invoice"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"lineItems":{"allOf":[{"$ref":"#/components/schemas/PackJobLineItemsListFilter"}],"description":"Nested list search by lineItems"},"or":{"items":{"$ref":"#/components/schemas/PackJobSearchQuery"},"maxItems":500,"type":"array"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"packingSourceContainers":{"allOf":[{"$ref":"#/components/schemas/PackJobPackingSourceContainersListFilter"}],"description":"Nested list search by packingSourceContainers"},"recipient":{"allOf":[{"$ref":"#/components/schemas/PackJobRecipientFilter"}],"description":"Nested search by recipient"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by shortId"},"status":{"allOf":[{"$ref":"#/components/schemas/PackJobStatusEnumFilter"}],"description":"Search by status"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantOrderId"}},"title":"PackJobSearchQuery","type":"object","description":"PackJobSearchQuery"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"maxLength":256,"type":"string"},"notIn":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"PackJobInvoiceFilter":{"properties":{"companyName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by companyName"},"email":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by firstName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by lastName"}},"title":"PackJobInvoiceFilter","type":"object","description":"PackJobInvoiceFilter"},"StringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"},"notIn":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringSearchFilter","type":"object","description":"StringSearchFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"PackJobLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/PackJobLineItemsFilter"}],"description":"Contains returns if at least one entry matches"}},"title":"PackJobLineItemsListFilter","type":"object","description":"PackJobLineItemsListFilter"},"PackJobLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/PackJobLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"PackJobLineItemsFilter","type":"object","description":"PackJobLineItemsFilter"},"PackJobLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"PackJobLineItemsArticleFilter","type":"object","description":"PackJobLineItemsArticleFilter"},"PackJobPackingSourceContainersListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/PackJobPackingSourceContainersFilter"}],"description":"Contains returns if at least one entry matches"}},"title":"PackJobPackingSourceContainersListFilter","type":"object","description":"PackJobPackingSourceContainersListFilter"},"PackJobPackingSourceContainersFilter":{"properties":{"codes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by codes"}},"title":"PackJobPackingSourceContainersFilter","type":"object","description":"PackJobPackingSourceContainersFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"PackJobRecipientFilter":{"properties":{"companyName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by companyName"},"email":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by firstName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by lastName"}},"title":"PackJobRecipientFilter","type":"object","description":"PackJobRecipientFilter"},"PackJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"}},"title":"PackJobStatusEnumFilter","type":"object","description":"PackJobStatusEnumFilter"},"PackJobSort":{"properties":{"lastModified":{"enum":["ASC","DESC"],"type":"string"},"orderDate":{"enum":["ASC","DESC"],"type":"string"},"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"PackJobSort","type":"object","description":"PackJobSort"},"PackJobPaginatedResult":{"properties":{"packJobs":{"items":{"$ref":"#/components/schemas/PackJob"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","packJobs"],"title":"PackJobPaginatedResult","type":"object","description":"PackJobPaginatedResult"},"PackJob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"type":"array"},"customAttributes":{"description":"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.","type":"object"},"deliveryChannel":{"enum":["COLLECT","SHIPPING"],"type":"string"},"documentHandling":{"$ref":"#/components/schemas/DocumentHandling"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"facilityRef":{"description":"Reference to the facility you want to get the corresponding packjob","type":"string"},"id":{"description":"The id of this pack job. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/PackLineItem"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"Date when the order was placed.","format":"date-time","type":"string"},"orderRef":{"description":"The id of the order","type":"string"},"packingSourceContainers":{"items":{"$ref":"#/components/schemas/StrippedPackingSourceContainer"}},"pickJobRef":{"description":"Reference to a pick job","type":"string"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientName":{"description":"The name of the recipient","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/PackJobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"targetTime":{"description":"Until when the pack job must be finished.","format":"date-time","type":"string"},"tenantOrderId":{"type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["id","facilityRef","documentsRef","status","lineItems","processId","workflowInformation"],"type":"object","xml":{"name":"PackJob"}}],"title":"PackJob","description":"PackJob"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"DocumentHandling":{"properties":{"sendLabel":{"properties":{"enabled":{"default":false,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["sendLabel"],"type":"object","title":"DocumentHandling","description":"DocumentHandling"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"PackLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The 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.","nullable":true,"type":"string"},"packed":{"description":"The amount of articles that were packed for this packline.","format":"int32","minimum":0,"type":"integer"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"serviceJobRefs":{"description":"Reference to the service job that has altered this line item","items":{"type":"string"},"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","quantity","article"]}],"type":"object","xml":{"name":"PackLineItem"},"title":"PackLineItem","description":"PackLineItem"},"MandatoryLineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"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.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"PackLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"PackLineItemArticle"},"title":"PackLineItemArticle","description":"PackLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"StrippedPackingSourceContainer":{"additionalProperties":false,"properties":{"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"},"loadUnitRef":{"type":"string"}},"type":"object","title":"StrippedPackingSourceContainer","description":"StrippedPackingSourceContainer"},"PackJobStatus":{"description":"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.","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string","xml":{"name":"PackJobStatus"},"title":"PackJobStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The id of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The id identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The id identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/search":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for PackJob","operationId":"searchPackJob","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackJobSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackJobPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this"}},"summary":"List pack jobs (search)","tags":["Packing (Operations)"]}}}}
```