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 operativeContainerType

POST/api/operativecontainertypes

Body

descriptionLocalizedLocaleString (object)

Provides Localized values. The key is the locale, the value is the translation. See https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/localization#fallback-language-mechanism

iconUrlstring

nameLocalized*LocaleString (object)

priorityinteger (int32)

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

dimensionsContainerDimensions (object)

weightLimitInGnumber

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

Example: 2500

customAttributesobject

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.

allowedOperativeTypes*array of OperativeType (enum)

scannableIdentifiersarray of ScannableIdentifier (object)

iconNamedFile (object)

Response

Successfully created resource.

Body

createdstring (date-time)

The date this entity was created at the platform. This value is generated by the service.

Example: "2020-02-03T08:45:51.525Z"

lastModifiedstring (date-time)

The date this entity was modified last. This value is generated by the service.

Example: "2020-02-03T09:45:51.525Z"

version*integer (int64)

The version of the document to be used in optimistic locking mechanisms.

Example: 42

Request

const response = await fetch('/api/operativecontainertypes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "allowedOperativeTypes": [
        "PICKING"
      ]
    }),
});
const data = await response.json();

Response

{
  "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,
  "allowedOperativeTypes": [
    "PICKING"
  ],
  "scannableIdentifiers": [
    {
      "searchType": "PREFIX",
      "identifiers": [
        "text"
      ]
    }
  ]
}

Updating

To update/modify an existing operative container type, use the corresponding PATCH call:

Update operativeContainerType by ID

PATCH/api/operativecontainertypes/{operativeContainerTypeId}

Path parameters

operativeContainerTypeId*string

id of the operativeContainer you want to update

Body

descriptionLocalizedLocaleString (object)

iconUrlstring

nameLocalizedLocaleString (object)

priorityinteger (int32)

Example: 100

dimensionsContainerDimensions (object)

weightLimitInGnumber

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

Example: 2500

customAttributesobject

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.

allowedOperativeTypesarray of OperativeType (enum)

scannableIdentifiersarray of ScannableIdentifier (object)

version*integer

Response

Found operativeContainerType by given ID

Body

createdstring (date-time)

The date this entity was created at the platform. This value is generated by the service.

Example: "2020-02-03T08:45:51.525Z"

lastModifiedstring (date-time)

The date this entity was modified last. This value is generated by the service.

Example: "2020-02-03T09:45:51.525Z"

version*integer (int64)

The version of the document to be used in optimistic locking mechanisms.

Example: 42

Request

const response = await fetch('/api/operativecontainertypes/{operativeContainerTypeId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "version": 0
    }),
});
const data = await response.json();

Response

{
  "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,
  "allowedOperativeTypes": [
    "PICKING"
  ],
  "scannableIdentifiers": [
    {
      "searchType": "PREFIX",
      "identifiers": [
        "text"
      ]
    }
  ]
}

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:

Upload icon for operative container types

PUT/api/operativecontainertypes/{operativeContainerTypeId}/icon

Path parameters

operativeContainerTypeId*string

Body

Base64 encoded icon to upload

content*string

File content base64 encoded

Example:

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

name*string

File name with extension

Example: "example.pdf"

Response

Successfully updated operative container type icon.

Body

createdstring (date-time)

The date this entity was created at the platform. This value is generated by the service.

Example: "2020-02-03T08:45:51.525Z"

lastModifiedstring (date-time)

The date this entity was modified last. This value is generated by the service.

Example: "2020-02-03T09:45:51.525Z"

version*integer (int64)

The version of the document to be used in optimistic locking mechanisms.

Example: 42

Request

const response = await fetch('/api/operativecontainertypes/{operativeContainerTypeId}/icon', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "example.pdf",
      "content": "JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg=="
    }),
});
const data = await response.json();

Response

{
  "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,
  "allowedOperativeTypes": [
    "PICKING"
  ],
  "scannableIdentifiers": [
    {
      "searchType": "PREFIX",
      "identifiers": [
        "text"
      ]
    }
  ]
}

PreviousHandover Configuration NextOrder Routing

Last updated 19 days ago

const response = await fetch('/api/operativecontainertypes', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "nameLocalized": { "de_DE": "Wert", "en_US": "Value", "ru_RU": "значение" }, "allowedOperativeTypes": [ "PICKING" ] }), }); const data = await response.json();

{ "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, "allowedOperativeTypes": [ "PICKING" ], "scannableIdentifiers": [ { "searchType": "PREFIX", "identifiers": [ "text" ] } ] }

const response = await fetch('/api/operativecontainertypes/{operativeContainerTypeId}/icon', { method: 'PUT', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "name": "example.pdf", "content": "JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==" }), }); const data = await response.json();

const response = await fetch('/api/operativecontainertypes/{operativeContainerTypeId}', { method: 'PATCH', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "version": 0 }), }); const data = await response.json();