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
}

Create operative container type

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.Creates a new operativeContainerType.

Authorizations

Body

OperativeContainerTypeForCreation

iconUrlstringOptional

priorityinteger · int32 · min: 1 · max: 10000Optional

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.

Example: 100

weightLimitInGnumber · min: 1Optional

Maximal weight in gramm(gr) the container can be loaded with.

Example: 2500

customAttributesobjectOptional

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.

Responses

201

Successfully created resource.

application/json

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

post

POST /api/operativecontainertypes HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer JWT
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:

Update operative container type

patch

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.Updates the operativeContainerType with the given ID.

Authorizations

Path parameters

operativeContainerTypeIdstringRequired

id of the operativeContainer you want to update

Body

OperativeContainerTypeForUpdate

iconUrlstringOptional

priorityinteger · int32 · min: 1 · max: 10000Optional

Example: 100

weightLimitInGnumber · min: 1Optional

Maximal weight in gramm(gr) the container can be loaded with.

Example: 2500

customAttributesobjectOptional

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.

versioninteger · min: 1Required

Responses

200

Found operativeContainerType by given ID

application/json

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

patch

PATCH /api/operativecontainertypes/{operativeContainerTypeId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer JWT
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:

Update operative container type icon

put

Authorizations

Path parameters

operativeContainerTypeIdstringRequired

Body

NamedFile

contentstringRequired

File content base64 encoded

Example:

JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==

namestringRequired

File name with extension

Example: example.pdf

Responses

200

Successfully updated operative container type icon.

application/json

201

Successfully created operative container type icon.

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

put

PUT /api/operativecontainertypes/{operativeContainerTypeId}/icon HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer JWT
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
}

PreviousHandover Configuration NextOrder Routing

Last updated 8 months ago

Was this helpful?