Operative Container (Operations)

Endpoints to manipulate operative containers.

List operative container types

get

Returns all operativeContainerTypes that match the given query parameters.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startAfterIdstringOptional

entity to start after

sizeinteger · min: 1 · max: 500Optional

number of entities to show

Default: 25

operativeTypestring · enumOptional

OperativeType you want to filter by

Possible values:

scannableIdentifierstringOptional

ScannableIdentifier you want to filter by

localestringOptional

Provide the localized names and descriptions for the operativeContainerTypes. If not provided the default locale is used. For example de_DE.

Responses

200

Found operativeContainerTypes matching the given parameters

application/json

OperativeContainerTypesResponse

totalintegerOptional

Total number of found entities for this query

Example: 42

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

application/json

404

The requested entity was not found

application/json

get

/api/operativecontainertypes

HTTPcURLJavaScriptPython

GET /api/operativecontainertypes HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "operativeContainerTypes": [
    {
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "allowedOperativeTypes": [
        "PICKING"
      ],
      "created": "2020-02-03T08:45:51.525Z",
      "customAttributes": {},
      "description": "text",
      "dimensions": {
        "heightInCm": 50,
        "lengthInCm": 100,
        "weightInG": 1700,
        "widthInCm": 25.5
      },
      "iconUrl": "text",
      "id": "text",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "priority": 100,
      "scannableIdentifiers": [
        {
          "identifiers": [
            "text"
          ],
          "searchType": "PREFIX"
        }
      ],
      "status": "INACTIVE",
      "version": 42,
      "weightLimitInG": 2500
    }
  ],
  "total": 42
}

Create operative container type

post

Creates a new operativeContainerType.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

OperativeContainerTypeForCreation

customAttributesobjectOptional

Attributes that can be added to the operativeContainerType. These attributes cannot be used within fulfillment processes.

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.

Example: 100

statusstring · enumOptionalPossible values:

weightLimitInGnumber · min: 1Optional

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

Example: 2500

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

application/json

post

/api/operativecontainertypes

HTTPcURLJavaScriptPython

POST /api/operativecontainertypes HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1477

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "allowedOperativeTypes": [
    "PICKING"
  ],
  "customAttributes": {},
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25.5
  },
  "icon": {
    "content": "JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==",
    "name": "example.pdf"
  },
  "iconUrl": "text",
  "priority": 100,
  "scannableIdentifiers": [
    {
      "identifiers": [
        "text"
      ],
      "searchType": "PREFIX"
    }
  ],
  "status": "INACTIVE",
  "weightLimitInG": 2500
}

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "allowedOperativeTypes": [
    "PICKING"
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "customAttributes": {},
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25.5
  },
  "iconUrl": "text",
  "id": "text",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "priority": 100,
  "scannableIdentifiers": [
    {
      "identifiers": [
        "text"
      ],
      "searchType": "PREFIX"
    }
  ],
  "status": "INACTIVE",
  "version": 42,
  "weightLimitInG": 2500
}

Get operative container type

get

Returns the operativeContainerType with the given ID.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

operativeContainerTypeIdstringRequired

Query parameters

localestringOptional

Provide the localized names and descriptions for the operativeContainerTypes. If not provided the default locale is used. For example de_DE.

Responses

200

Found operativeContainerType by given ID

application/json

OperativeContainerType

createdstring · date-timeOptional

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

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

customAttributesobjectOptional

Attributes that can be added to the operativeContainerType. These attributes cannot be used within fulfillment processes.

descriptionstringOptional

iconUrlstringOptional

idstringRequired

lastModifiedstring · date-timeOptional

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

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

namestringOptionalDeprecated

Deprecated: use nameLocalized instead

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.

Example: 100

statusstring · enumOptionalPossible values:

versioninteger · int64Required

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

Example: 42

weightLimitInGnumber · min: 1Optional

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

Example: 2500

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

application/json

404

The requested entity was not found

application/json

get

/api/operativecontainertypes/{operativeContainerTypeId}

HTTPcURLJavaScriptPython

GET /api/operativecontainertypes/{operativeContainerTypeId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "allowedOperativeTypes": [
    "PICKING"
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "customAttributes": {},
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25.5
  },
  "iconUrl": "text",
  "id": "text",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "priority": 100,
  "scannableIdentifiers": [
    {
      "identifiers": [
        "text"
      ],
      "searchType": "PREFIX"
    }
  ],
  "status": "INACTIVE",
  "version": 42,
  "weightLimitInG": 2500
}

Update operative container type

patch

Updates the operativeContainerType with the given ID.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

operativeContainerTypeIdstringRequired

Body

application/json

OperativeContainerTypeForUpdate

customAttributesobjectOptional

Attributes that can be added to the operativeContainerTypes. These attributes cannot be used within fulfillment processes.

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.

Example: 100

statusstring · enumOptionalPossible values:

versioninteger · min: 1Required

weightLimitInGnumber · min: 1Optional

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

Example: 2500

Responses

200

Successfully updated operativeContainerType by given ID

application/json

OperativeContainerType

createdstring · date-timeOptional

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

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

customAttributesobjectOptional

Attributes that can be added to the operativeContainerType. These attributes cannot be used within fulfillment processes.

descriptionstringOptional

iconUrlstringOptional

idstringRequired

lastModifiedstring · date-timeOptional

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

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

namestringOptionalDeprecated

Deprecated: use nameLocalized instead

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.

Example: 100

statusstring · enumOptionalPossible values:

versioninteger · int64Required

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

Example: 42

weightLimitInGnumber · min: 1Optional

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

Example: 2500

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

application/json

404

The requested entity was not found

application/json

patch

/api/operativecontainertypes/{operativeContainerTypeId}

HTTPcURLJavaScriptPython

PATCH /api/operativecontainertypes/{operativeContainerTypeId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 458

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "allowedOperativeTypes": [
    "PICKING"
  ],
  "customAttributes": {},
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25.5
  },
  "iconUrl": "text",
  "priority": 100,
  "scannableIdentifiers": [
    {
      "identifiers": [
        "text"
      ],
      "searchType": "PREFIX"
    }
  ],
  "status": "INACTIVE",
  "version": 1,
  "weightLimitInG": 2500
}

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "allowedOperativeTypes": [
    "PICKING"
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "customAttributes": {},
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25.5
  },
  "iconUrl": "text",
  "id": "text",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "priority": 100,
  "scannableIdentifiers": [
    {
      "identifiers": [
        "text"
      ],
      "searchType": "PREFIX"
    }
  ],
  "status": "INACTIVE",
  "version": 42,
  "weightLimitInG": 2500
}

Update operative container type icon

put

Uploads or replaces the icon for the given operative container type.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

operativeContainerTypeIdstringRequired

Query parameters

localestringOptional

Body

application/json

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

OperativeContainerType

createdstring · date-timeOptional

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

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

customAttributesobjectOptional

Attributes that can be added to the operativeContainerType. These attributes cannot be used within fulfillment processes.

descriptionstringOptional

iconUrlstringOptional

idstringRequired

lastModifiedstring · date-timeOptional

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

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

namestringOptionalDeprecated

Deprecated: use nameLocalized instead

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.

Example: 100

statusstring · enumOptionalPossible values:

versioninteger · int64Required

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

Example: 42

weightLimitInGnumber · min: 1Optional

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

Example: 2500

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

application/json

404

The requested entity was not found

application/json

put

/api/operativecontainertypes/{operativeContainerTypeId}/icon

HTTPcURLJavaScriptPython

PUT /api/operativecontainertypes/{operativeContainerTypeId}/icon HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1023

{
  "content": "JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==",
  "name": "example.pdf"
}

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "allowedOperativeTypes": [
    "PICKING"
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "customAttributes": {},
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25.5
  },
  "iconUrl": "text",
  "id": "text",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "priority": 100,
  "scannableIdentifiers": [
    {
      "identifiers": [
        "text"
      ],
      "searchType": "PREFIX"
    }
  ],
  "status": "INACTIVE",
  "version": 42,
  "weightLimitInG": 2500
}