Operative Container Types
Creating
Example:
{
"allowedOperativeTypes": [
"HANDOVER",
"PACKING_SOURCE",
"PACKING_TARGET",
"PICKING"
],
"customAttributes": {
"someKey": "someValue"
},
"descriptionLocalized": {
"en_US": "Description",
"de_DE": "Beschreibung"
},
"dimensions": {
"heightInCm": 10,
"lengthInCm": 10,
"weightInG": 100,
"widthInCm": 10
},
"iconUrl": "http://some.image",
"nameLocalized": {
"de_DE": "Tüte",
"en_US": "Bag"
},
"priority": 1,
"scannableIdentifiers": [
{
"identifiers": [
"Container"
],
"searchType": "PREFIX"
}
],
"weightLimitInG": 200
}
This value gives the priority of the respective operativeContainerType. 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.
100
Maximal weight in gramm(gr) the container can be loaded with.
2500
Attributes that can be added to the operativeContainerType. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
POST /api/operativecontainertypes HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1457
{
"descriptionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"iconUrl": "text",
"nameLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"priority": 100,
"dimensions": {
"heightInCm": 50,
"lengthInCm": 100,
"weightInG": 1700,
"widthInCm": 25.5
},
"weightLimitInG": 2500,
"customAttributes": {},
"allowedOperativeTypes": [
"PICKING"
],
"scannableIdentifiers": [
{
"searchType": "PREFIX",
"identifiers": [
"text"
]
}
],
"icon": {
"content": "JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==",
"name": "example.pdf"
}
}
{
"description": "text",
"descriptionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"iconUrl": "text",
"id": "text",
"name": "text",
"nameLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"priority": 100,
"dimensions": {
"heightInCm": 50,
"lengthInCm": 100,
"weightInG": 1700,
"widthInCm": 25.5
},
"weightLimitInG": 2500,
"customAttributes": {},
"allowedOperativeTypes": [
"PICKING"
],
"scannableIdentifiers": [
{
"searchType": "PREFIX",
"identifiers": [
"text"
]
}
],
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z",
"version": 42
}
Updating
To update/modify an existing operative container type, use the corresponding PATCH
call:
id of the operativeContainer you want to update
This value gives the priority of the respective operativeContainerType. 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.
100
Maximal weight in gramm(gr) the container can be loaded with.
2500
Attributes that can be added to the operativeContainerTypes. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
PATCH /api/operativecontainertypes/{operativeContainerTypeId} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 438
{
"descriptionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"iconUrl": "text",
"nameLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"priority": 100,
"dimensions": {
"heightInCm": 50,
"lengthInCm": 100,
"weightInG": 1700,
"widthInCm": 25.5
},
"weightLimitInG": 2500,
"customAttributes": {},
"allowedOperativeTypes": [
"PICKING"
],
"scannableIdentifiers": [
{
"searchType": "PREFIX",
"identifiers": [
"text"
]
}
],
"version": 1
}
{
"description": "text",
"descriptionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"iconUrl": "text",
"id": "text",
"name": "text",
"nameLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"priority": 100,
"dimensions": {
"heightInCm": 50,
"lengthInCm": 100,
"weightInG": 1700,
"widthInCm": 25.5
},
"weightLimitInG": 2500,
"customAttributes": {},
"allowedOperativeTypes": [
"PICKING"
],
"scannableIdentifiers": [
{
"searchType": "PREFIX",
"identifiers": [
"text"
]
}
],
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z",
"version": 42
}
Adding an Icon
You can (and should) add an icon to the operative container type definition so that is displayed nicely in the Android app and the picker knows which bag, box, etc. to choose. The image file needs to be base64 encoded in the HTTP request:
File content base64 encoded
JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==
File name with extension
example.pdf
PUT /api/operativecontainertypes/{operativeContainerTypeId}/icon HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1023
{
"content": "JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==",
"name": "example.pdf"
}
{
"description": "text",
"descriptionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"iconUrl": "text",
"id": "text",
"name": "text",
"nameLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"priority": 100,
"dimensions": {
"heightInCm": 50,
"lengthInCm": 100,
"weightInG": 1700,
"widthInCm": 25.5
},
"weightLimitInG": 2500,
"customAttributes": {},
"allowedOperativeTypes": [
"PICKING"
],
"scannableIdentifiers": [
{
"searchType": "PREFIX",
"identifiers": [
"text"
]
}
],
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z",
"version": 42
}
Last updated
Was this helpful?