Picking (Operations)

These endpoints support the management of the picking process.

List load units

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startAfterIdstringOptional

all entities after given Id

sizeintegerOptional

number of loadUnits to show

Default: 25

pickJobRefstringOptional

query load units with the given pickJobRef

localestringOptional

Provide the localized names and descriptions for the routing configuration. If not provided the default locale is used., for example de_DE

Responses

200

Load units are found.

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

get

/api/loadunits

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

{
  "loadUnits": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42
    }
  ],
  "total": 42
}

Create load units

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

LoadUnitsForCreation

Responses

201

Load units are successfully created.

application/json

LoadUnits

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 endpoint

application/json

post

/api/loadunits

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

{
  "loadUnits": [
    {
      "codes": [
        "text"
      ],
      "customAttributes": {},
      "loadUnitLineItems": [],
      "operativeContainerTypeRef": "text",
      "pickJobRefs": [
        "text"
      ],
      "stackRef": "text",
      "storageLocationRef": "text"
    }
  ]
}

{
  "loadUnits": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42
    }
  ],
  "total": 42
}

Delete load units

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pickJobRefstringOptional

Reference to the pickJob of which you want to delete the loadUnits

idstring[]Optional

Load unit ids

Responses

200

Load units are successfully deleted.

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

422

LoadUnits could not be removed due to failing conditions

application/json

delete

/api/loadunits

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

{
  "loadUnits": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42
    }
  ],
  "total": 42
}

Get load unit

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

loadUnitIdstringRequired

Query parameters

localestringOptional

Provide the localized names and descriptions for the routing configuration. If not provided the default locale is used., for example de_DE

Responses

200

The found load unit.

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

get

/api/loadunits/{loadUnitId}

GET /api/loadunits/{loadUnitId} 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": "значение"
  },
  "codes": [
    "text"
  ],
  "customAttributes": {},
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25
  },
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "iconUrl": "text",
  "id": "text",
  "loadUnitLineItems": [],
  "name": "text",
  "operativeContainerTypeRef": "text",
  "pickJobRefs": [
    "text"
  ],
  "stackRef": "text",
  "storageLocationRef": "text",
  "weightLimitInG": 1,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Delete load unit

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

loadUnitIdstringRequired

Responses

200

Successfully deleted load unit.

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

delete

/api/loadunits/{loadUnitId}

DELETE /api/loadunits/{loadUnitId} 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": "значение"
  },
  "codes": [
    "text"
  ],
  "customAttributes": {},
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25
  },
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "iconUrl": "text",
  "id": "text",
  "loadUnitLineItems": [],
  "name": "text",
  "operativeContainerTypeRef": "text",
  "pickJobRefs": [
    "text"
  ],
  "stackRef": "text",
  "storageLocationRef": "text",
  "weightLimitInG": 1,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update load unit

patch

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. LoadUnitPatchActions: Deprecated - For future usage please use the /actions endpoints mentioned in the corresponding PatchActions LoadUnit: Partial Patch on this entity.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

loadUnitIdstringRequired

Query parameters

localestringOptional

Provide the localized names and descriptions for the routing configuration. If not provided the default locale is used., for example de_DE

Body

Responses

200

The found load unit.

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

/api/loadunits/{loadUnitId}

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

{
  "actions": [
    {
      "action": "ReplaceLoadUnitLineItems",
      "loadUnitLineItems": []
    }
  ],
  "version": 42
}

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "codes": [
    "text"
  ],
  "customAttributes": {},
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25
  },
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "iconUrl": "text",
  "id": "text",
  "loadUnitLineItems": [],
  "name": "text",
  "operativeContainerTypeRef": "text",
  "pickJobRefs": [
    "text"
  ],
  "stackRef": "text",
  "storageLocationRef": "text",
  "weightLimitInG": 1,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Call load unit action

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Applies actions to a load unit. Check LoadUnitActionsParameter for available actions.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

loadUnitIdstringRequired

id of the load unit

Body

LoadUnitActionsParameter

Responses

200

Updated entity

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

post

/api/loadunits/{loadUnitId}/actions

POST /api/loadunits/{loadUnitId}/actions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 300

{
  "name": "UPDATE_LOAD_UNIT_LINE_ITEM_RECORDABLE_ATTRIBUTES",
  "recordableAttributes": [
    {
      "keyLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "group": "general",
      "recordableAttributeId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "recordingRule": "MANDATORY",
      "value": "Germany"
    }
  ],
  "version": 1
}

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "codes": [
    "text"
  ],
  "customAttributes": {},
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25
  },
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "iconUrl": "text",
  "id": "text",
  "loadUnitLineItems": [],
  "name": "text",
  "operativeContainerTypeRef": "text",
  "pickJobRefs": [
    "text"
  ],
  "stackRef": "text",
  "storageLocationRef": "text",
  "weightLimitInG": 1,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get load unit stack

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Return the stack of a given load unit if found

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

loadUnitIdstringRequired

Responses

200

The found stack for this load unit.

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/loadunits/{loadUnitId}/stack

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

{
  "created": "2020-02-03T08:45:51.525Z",
  "facilityRefs": [
    "text"
  ],
  "id": "text",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "processRefs": [
    "text"
  ],
  "version": 42
}

Deprecated

List load unit types

get

This part of the API is deprecated. For details please check the api-release-life-cycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startAfterIdstringOptional

all entities after given Id

sizeintegerOptional

number of entities to show

Default: 25

localestringOptional

Provide the localized names and descriptions for the routing configuration. If not provided the default locale is used., for example de_DE

Responses

200

All load unit types.

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

get

/api/loadunittypes

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

[
  {
    "created": "2020-02-03T08:45:51.525Z",
    "lastModified": "2020-02-03T09:45:51.525Z",
    "version": 42
  }
]

Deprecated

Create load unit type

post

This part of the API is deprecated. For details please check the api-release-life-cycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

LoadUnitTypeForCreation

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

This value gives the priority in the respective loadUnitType. 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 loadUnityTypes.

Example: 100

weightLimitInGnumber · min: 1Optional

Maximal weight in gramm(gr) the loadunit can handle.

Responses

201

Successfully created resource.

application/json

LoadUnitType

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

/api/loadunittypes

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

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25
  },
  "icon": {
    "content": "JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==",
    "name": "example.pdf"
  },
  "priority": 100,
  "weightLimitInG": 1
}

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25
  },
  "iconUrl": "text",
  "id": "text",
  "name": "text",
  "priority": 100,
  "weightLimitInG": 1,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Deprecated

Get load unit type

get

This part of the API is deprecated. For details please check the api-release-life-cycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

loadUnitTypeIdstringRequired

Query parameters

localestringOptional

Provide the localized names and descriptions for the routing configuration. If not provided the default locale is used., for example de_DE

Responses

200

The found load unit type.

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

get

/api/loadunittypes/{loadUnitTypeId}

GET /api/loadunittypes/{loadUnitTypeId} 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": "значение"
  },
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25
  },
  "iconUrl": "text",
  "id": "text",
  "name": "text",
  "priority": 100,
  "weightLimitInG": 1,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Deprecated

Update load unit type

patch

This part of the API is deprecated. For details please check the api-release-life-cycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

loadUnitTypeIdstringRequired

Body

LoadUnitTypePatchActions

versioninteger · int64Required

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

Example: 42

Responses

200

Successfully updated load unit type.

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

/api/loadunittypes/{loadUnitTypeId}

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

{
  "actions": [
    {
      "action": "ModifyLoadUnitType",
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "dimensions": {
        "heightInCm": 50,
        "lengthInCm": 100,
        "weightInG": 1700,
        "widthInCm": 25
      },
      "priority": 100,
      "weightLimitInG": 1
    }
  ],
  "version": 42
}

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25
  },
  "iconUrl": "text",
  "id": "text",
  "name": "text",
  "priority": 100,
  "weightLimitInG": 1,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Deprecated

Update load unit type icon

put

This part of the API is deprecated. For details please check the api-release-life-cycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

loadUnitTypeIdstringRequired

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 load unit type icon.

application/json

201

Successfully created load unit type icon.

application/json

LoadUnitType

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

/api/loadunittypes/{loadUnitTypeId}/icon

PUT /api/loadunittypes/{loadUnitTypeId}/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": "значение"
  },
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25
  },
  "iconUrl": "text",
  "id": "text",
  "name": "text",
  "priority": 100,
  "weightLimitInG": 1,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

List pick jobs

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

searchTermstringOptional

Search term you want to get the corresponding pickjobs. Search will be performed on multiple fields, like tenantOrderId, consumerName, tenantArticleId and more

carrierKeysstring[]Optional

Reference to the carrier you want to get the corresponding pickjobs

startOrderDatestringOptional

Reference to the orderDate you want to get the corresponding pickjobs

endOrderDatestringOptional

Reference to the orderDate you want to get the corresponding pickjobs

orderRefstringOptional

Reference to the order you want to get the corresponding pickjobs

facilityRefstringOptional

Reference to the facility you want to get the corresponding pickjobs

assignedUserstringOptional

Reference the assigned user on this entity - id or username

statusstring[]Optional

Reference to the status you want to get the corresponding pickjobs

zoneRefsstring[]Optional

Reference to the zones you want to get the corresponding pickjobs

tenantOrderIdstringOptional

Reference to the tenantOrderId you want to get the corresponding pickjobs

channelstring · enumOptional

The channel of the pickJob you want to filter by

Possible values:

consumerNamestringOptional

Reference to the consumer name you want to get the corresponding pickjobs

shortIdstringOptional

Reference to the shortId you want to get the corresponding pickjobs

articleTitlestringOptional

Reference to the articleTitle you want to get the corresponding pickjobs

anonymizedbooleanOptional

Reference to the anonymized you want to get the corresponding pickjobs

startAfterIdstringOptional

all entities after given Id

sizeintegerOptional

number of entities to show

Default: 25

orderBystringOptional

query pickjobs orderBy

startTargetTimestring · date-timeOptional

Start date range for pick jobs

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

endTargetTimestring · date-timeOptional

End date range for pick jobs

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

pickJobRefsstring[]Optional

Reference to pickjobs

modifiedByUsernamestringOptional

Reference to the user ID you want to get the corresponding pickjobs

Responses

200

PickJobs were found. The results are in the body.

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

get

/api/pickjobs

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

{
  "pickjobs": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42,
      "carrierKey": "DPD",
      "facilityRef": "Esb20gpHBL94X5NdMp3C",
      "id": "text",
      "orderRef": "LGMl2DuvPnfPoSHhYFOm",
      "searchPaths": [
        "text"
      ],
      "status": "ABORTED",
      "targetTime": "2020-02-03T09:45:51.525Z"
    }
  ],
  "total": 42
}

Create pick job

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

PickJobForCreation

customAttributesobjectOptional

Attributes that can be added to the pickjob. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.

facilityRefstringRequired

The id of the facility reference. The given ID has to be present in the system.

Example: Esb20gpHBL94X5NdMp3C

operativeProcessRefstringOptional

orderDatestring · date-timeRequired

The date this order was created at the supplying system.

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

orderRefstringOptional

The id of the order reference. The given ID has to be present in the system.

Example: LGMl2DuvPnfPoSHhYFOm

processIdstringOptional

Id of the global process related to this entity. For example used for starting the GDPR process and others.

routingPlanRefstringOptional

Reference to the routingplan which created this pickjob

shortIdstringOptional

A short identifier that helps assigning a pick job to a customer.

Example: AS12

statusstring · enumOptional

The status of a pickjob.

Possible values:

tenantOrderIdstringOptional

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.

Example: R456728546

workflowInformationone ofOptional

Responses

201

The pick job was successfully created. The Location header contains the URL of the pickjob.

application/json

PickJob

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

/api/pickjobs

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

{
  "assignedUsers": [
    {
      "username": "text"
    }
  ],
  "customAttributes": {},
  "deliveryinformation": {
    "channel": "COLLECT",
    "details": {
      "collect": {
        "identifier": "text",
        "paid": false
      },
      "shipping": {
        "carrierKey": "text",
        "carrierProduct": "EXPRESS",
        "carrierProductCategory": "STANDARD",
        "carrierServices": [
          "SIGNATURE"
        ],
        "identifier": "text",
        "invoiceAddress": {
          "addressType": "POSTAL_ADDRESS",
          "companyName": "Speedy Boxales Ltd.",
          "coordinates": {
            "lat": 50.937531,
            "lon": 6.960279
          },
          "email": "[email protected]",
          "firstName": "Maxine",
          "lastName": "Muller",
          "personalTitle": "Dr.",
          "salutation": "Frau",
          "additionalAddressInfo": "to care of: Mrs. Müller",
          "city": "Langenfeld",
          "country": "DE",
          "customAttributes": {},
          "houseNumber": "42a",
          "phoneNumbers": [
            {
              "customAttributes": {},
              "label": "text",
              "type": "MOBILE",
              "value": "text"
            }
          ],
          "postalCode": "40764",
          "province": "NRW",
          "street": "Hauptstr."
        },
        "postalAddress": {
          "addressType": "POSTAL_ADDRESS",
          "companyName": "Speedy Boxales Ltd.",
          "coordinates": {
            "lat": 50.937531,
            "lon": 6.960279
          },
          "email": "[email protected]",
          "firstName": "Maxine",
          "lastName": "Muller",
          "personalTitle": "Dr.",
          "salutation": "Frau",
          "additionalAddressInfo": "to care of: Mrs. Müller",
          "city": "Langenfeld",
          "country": "DE",
          "customAttributes": {},
          "houseNumber": "42a",
          "phoneNumbers": [
            {
              "customAttributes": {},
              "label": "text",
              "type": "MOBILE",
              "value": "text"
            }
          ],
          "postalCode": "40764",
          "province": "NRW",
          "street": "Hauptstr."
        },
        "recipientaddress": {
          "addressType": "POSTAL_ADDRESS",
          "companyName": "Speedy Boxales Ltd.",
          "coordinates": {
            "lat": 50.937531,
            "lon": 6.960279
          },
          "email": "[email protected]",
          "firstName": "Maxine",
          "lastName": "Muller",
          "personalTitle": "Dr.",
          "salutation": "Frau",
          "additionalAddressInfo": "to care of: Mrs. Müller",
          "city": "Langenfeld",
          "country": "DE",
          "customAttributes": {},
          "houseNumber": "42a",
          "phoneNumbers": [
            {
              "customAttributes": {},
              "label": "text",
              "type": "MOBILE",
              "value": "text"
            }
          ],
          "postalCode": "40764",
          "province": "NRW",
          "street": "Hauptstr."
        },
        "serviceLevel": "DELIVERY"
      }
    },
    "targetTime": "2020-02-03T09:45:51.525Z",
    "targetTimeBaseDate": "2020-02-03T08:45:50.525Z"
  },
  "expectedPickLineItems": [],
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "operativeProcessRef": "text",
  "orderDate": "2020-02-03T08:45:50.525Z",
  "orderRef": "LGMl2DuvPnfPoSHhYFOm",
  "paymentInformation": {
    "currency": "EUR"
  },
  "pickingTimes": {
    "startLatestAt": "2024-02-03T09:45:51.525Z"
  },
  "pickLineItems": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "quantity": 1,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "preferredPickingMethods": [
    "SINGLE_ORDER"
  ],
  "processId": "text",
  "routingPlanRef": "text",
  "shortId": "AS12",
  "status": "ABORTED",
  "stickers": [],
  "tenantOrderId": "R456728546",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ],
  "workflowInformation": {
    "instanceRef": "64c13ab08edf48a008793cac",
    "isAvailable": true,
    "nodeRef": "text"
  },
  "tags": []
}

{
  "assignedUsers": [
    {
      "userId": "text",
      "username": "text"
    }
  ],
  "customAttributes": {},
  "deliveryinformation": {
    "channel": "COLLECT",
    "details": {
      "collect": {
        "identifier": "text",
        "paid": false
      },
      "shipping": {
        "carrierKey": "text",
        "carrierProduct": "EXPRESS",
        "carrierProductCategory": "STANDARD",
        "carrierServices": [
          "SIGNATURE"
        ],
        "identifier": "text",
        "invoiceAddress": {
          "addressType": "POSTAL_ADDRESS",
          "companyName": "Speedy Boxales Ltd.",
          "coordinates": {
            "lat": 50.937531,
            "lon": 6.960279
          },
          "email": "[email protected]",
          "firstName": "Maxine",
          "lastName": "Muller",
          "personalTitle": "Dr.",
          "salutation": "Frau",
          "additionalAddressInfo": "to care of: Mrs. Müller",
          "city": "Langenfeld",
          "country": "DE",
          "customAttributes": {},
          "houseNumber": "42a",
          "phoneNumbers": [
            {
              "customAttributes": {},
              "label": "text",
              "type": "MOBILE",
              "value": "text"
            }
          ],
          "postalCode": "40764",
          "province": "NRW",
          "street": "Hauptstr."
        },
        "postalAddress": {
          "addressType": "POSTAL_ADDRESS",
          "companyName": "Speedy Boxales Ltd.",
          "coordinates": {
            "lat": 50.937531,
            "lon": 6.960279
          },
          "email": "[email protected]",
          "firstName": "Maxine",
          "lastName": "Muller",
          "personalTitle": "Dr.",
          "salutation": "Frau",
          "additionalAddressInfo": "to care of: Mrs. Müller",
          "city": "Langenfeld",
          "country": "DE",
          "customAttributes": {},
          "houseNumber": "42a",
          "phoneNumbers": [
            {
              "customAttributes": {},
              "label": "text",
              "type": "MOBILE",
              "value": "text"
            }
          ],
          "postalCode": "40764",
          "province": "NRW",
          "street": "Hauptstr."
        },
        "recipientaddress": {
          "addressType": "POSTAL_ADDRESS",
          "companyName": "Speedy Boxales Ltd.",
          "coordinates": {
            "lat": 50.937531,
            "lon": 6.960279
          },
          "email": "[email protected]",
          "firstName": "Maxine",
          "lastName": "Muller",
          "personalTitle": "Dr.",
          "salutation": "Frau",
          "additionalAddressInfo": "to care of: Mrs. Müller",
          "city": "Langenfeld",
          "country": "DE",
          "customAttributes": {},
          "houseNumber": "42a",
          "phoneNumbers": [
            {
              "customAttributes": {},
              "label": "text",
              "type": "MOBILE",
              "value": "text"
            }
          ],
          "postalCode": "40764",
          "province": "NRW",
          "street": "Hauptstr."
        },
        "serviceLevel": "DELIVERY"
      }
    },
    "targetTime": "2020-02-03T09:45:51.525Z",
    "targetTimeBaseDate": "2020-02-03T08:45:50.525Z"
  },
  "expectedPickLineItems": [
    {
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold"
            }
          ],
          "imageUrl": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "tenantArticleId": "text",
          "title": "text"
        }
      ],
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "partialStockLocations": [
        {
          "available": 21,
          "location": {
            "locationRef": "text",
            "scannableCodes": [
              "text"
            ]
          },
          "quantity": 21,
          "ratingScore": 1,
          "sequenceScore": 1,
          "stockProperties": {
            "expiry": "text"
          },
          "stockRef": "text",
          "tenantPartialStockId": "text"
        }
      ],
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "secondaryMeasurementUnitKey": "liter",
      "secondaryQuantity": 21,
      "stickers": [],
      "transferId": "text",
      "tags": []
    },
    {
      "id": "climk4dcQFiPdA5ULuhS"
    }
  ],
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "operativeProcessRef": "text",
  "orderDate": "2020-02-03T08:45:50.525Z",
  "orderRef": "LGMl2DuvPnfPoSHhYFOm",
  "paymentInformation": {
    "currency": "EUR"
  },
  "pickingTimes": {
    "startLatestAt": "2024-02-03T09:45:51.525Z"
  },
  "pickLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "globalLineItemId": "a81f818e-2405-4570-8cde-b0c80fd3de31",
      "id": "climk4dcQFiPdA5ULuhS",
      "quantity": 21,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold"
            }
          ],
          "imageUrl": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "tenantArticleId": "text",
          "title": "text"
        }
      ],
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
      "partialStockLocations": [
        {
          "available": 21,
          "location": {
            "locationRef": "text",
            "scannableCodes": [
              "text"
            ]
          },
          "quantity": 21,
          "ratingScore": 1,
          "sequenceScore": 1,
          "stockProperties": {
            "expiry": "text"
          },
          "stockRef": "text",
          "tenantPartialStockId": "text"
        }
      ],
      "picked": 20,
      "pickedAt": "2024-02-03T08:45:51.525Z",
      "pickJobLineItemRef": "12345",
      "scannedCodes": [
        {
          "code": 1245678,
          "quantity": 7
        }
      ],
      "scanningRules": {
        "scanningMode": "MUST_SCAN_FIRST",
        "scanningType": []
      },
      "secondaryMeasurementUnitKey": "liter",
      "secondaryPicked": 20,
      "secondaryQuantity": 21,
      "shortPickReason": {
        "reasonLocalized": "{ en_US: 'SomeName' }",
        "reason": "text"
      },
      "status": "OPEN",
      "stickers": [],
      "stockEmptied": true,
      "substituteLineItems": [
        {
          "article": {
            "titleLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "customAttributes": {},
            "imageUrl": "text",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "weight": 1,
            "attributes": [
              {
                "valueLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "keyLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "category": "descriptive",
                "context": {
                  "type": "FACILITY_GROUP",
                  "value": "text"
                },
                "key": "%%subtitle%%",
                "priority": 100,
                "type": "STRING",
                "value": "585er Gold"
              }
            ]
          },
          "globalLineItemId": "text",
          "id": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "partialStockLocations": [
            {
              "location": {
                "locationRef": "text",
                "scannableCodes": [
                  "text"
                ]
              },
              "picked": 21,
              "quantity": 21,
              "ratingScore": 1,
              "sequenceScore": 1,
              "stockProperties": {
                "expiry": "text"
              },
              "stockRef": "text",
              "tenantPartialStockId": "text",
              "zoneName": "text"
            }
          ],
          "picked": 20,
          "pickedAt": "2024-02-03T08:45:51.525Z",
          "priority": 1,
          "quantity": 21,
          "refused": [],
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "secondaryPicked": 20,
          "secondaryQuantity": 200
        }
      ],
      "tags": []
    }
  ],
  "preferredPickingMethods": [
    "SINGLE_ORDER"
  ],
  "processId": "text",
  "routingPlanRef": "text",
  "shortId": "AS12",
  "status": "ABORTED",
  "stickers": [],
  "tenantOrderId": "R456728546",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ],
  "workflowInformation": {
    "instanceRef": "64c13ab08edf48a008793cac",
    "isAvailable": true,
    "nodeRef": "text"
  },
  "tags": [],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "anonymized": false,
  "documentHandling": {
    "sendLabel": {
      "enabled": false
    }
  },
  "documentsRef": "text",
  "editor": {
    "userId": "text",
    "username": "text"
  },
  "id": "Esb20gpHBL94X5NdMp3C",
  "pickingZones": [],
  "pickRunRef": "text",
  "resetBlocked": false,
  "subStatus": "SHORT_PICKED",
  "usersModificationHistory": [
    {
      "modificationDate": "2026-03-13T13:47:33.519Z",
      "userId": "text",
      "username": "text"
    }
  ]
}

Get pick job

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pickJobIdstringRequired

ID of the pickjob you want to get

Responses

200

PickJob was found & you were allowed to access it. The result is in the body.

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

get

/api/pickjobs/{pickJobId}

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

{
  "assignedUsers": [
    {
      "userId": "text",
      "username": "text"
    }
  ],
  "customAttributes": {},
  "deliveryinformation": {
    "channel": "COLLECT",
    "details": {
      "collect": {
        "identifier": "text",
        "paid": false
      },
      "shipping": {
        "carrierKey": "text",
        "carrierProduct": "EXPRESS",
        "carrierProductCategory": "STANDARD",
        "carrierServices": [
          "SIGNATURE"
        ],
        "identifier": "text",
        "invoiceAddress": {
          "addressType": "POSTAL_ADDRESS",
          "companyName": "Speedy Boxales Ltd.",
          "coordinates": {
            "lat": 50.937531,
            "lon": 6.960279
          },
          "email": "[email protected]",
          "firstName": "Maxine",
          "lastName": "Muller",
          "personalTitle": "Dr.",
          "salutation": "Frau",
          "additionalAddressInfo": "to care of: Mrs. Müller",
          "city": "Langenfeld",
          "country": "DE",
          "customAttributes": {},
          "houseNumber": "42a",
          "phoneNumbers": [
            {
              "customAttributes": {},
              "label": "text",
              "type": "MOBILE",
              "value": "text"
            }
          ],
          "postalCode": "40764",
          "province": "NRW",
          "street": "Hauptstr."
        },
        "postalAddress": {
          "addressType": "POSTAL_ADDRESS",
          "companyName": "Speedy Boxales Ltd.",
          "coordinates": {
            "lat": 50.937531,
            "lon": 6.960279
          },
          "email": "[email protected]",
          "firstName": "Maxine",
          "lastName": "Muller",
          "personalTitle": "Dr.",
          "salutation": "Frau",
          "additionalAddressInfo": "to care of: Mrs. Müller",
          "city": "Langenfeld",
          "country": "DE",
          "customAttributes": {},
          "houseNumber": "42a",
          "phoneNumbers": [
            {
              "customAttributes": {},
              "label": "text",
              "type": "MOBILE",
              "value": "text"
            }
          ],
          "postalCode": "40764",
          "province": "NRW",
          "street": "Hauptstr."
        },
        "recipientaddress": {
          "addressType": "POSTAL_ADDRESS",
          "companyName": "Speedy Boxales Ltd.",
          "coordinates": {
            "lat": 50.937531,
            "lon": 6.960279
          },
          "email": "[email protected]",
          "firstName": "Maxine",
          "lastName": "Muller",
          "personalTitle": "Dr.",
          "salutation": "Frau",
          "additionalAddressInfo": "to care of: Mrs. Müller",
          "city": "Langenfeld",
          "country": "DE",
          "customAttributes": {},
          "houseNumber": "42a",
          "phoneNumbers": [
            {
              "customAttributes": {},
              "label": "text",
              "type": "MOBILE",
              "value": "text"
            }
          ],
          "postalCode": "40764",
          "province": "NRW",
          "street": "Hauptstr."
        },
        "serviceLevel": "DELIVERY"
      }
    },
    "targetTime": "2020-02-03T09:45:51.525Z",
    "targetTimeBaseDate": "2020-02-03T08:45:50.525Z"
  },
  "expectedPickLineItems": [
    {
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold"
            }
          ],
          "imageUrl": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "tenantArticleId": "text",
          "title": "text"
        }
      ],
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "partialStockLocations": [
        {
          "available": 21,
          "location": {
            "locationRef": "text",
            "scannableCodes": [
              "text"
            ]
          },
          "quantity": 21,
          "ratingScore": 1,
          "sequenceScore": 1,
          "stockProperties": {
            "expiry": "text"
          },
          "stockRef": "text",
          "tenantPartialStockId": "text"
        }
      ],
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "secondaryMeasurementUnitKey": "liter",
      "secondaryQuantity": 21,
      "stickers": [],
      "transferId": "text",
      "tags": []
    },
    {
      "id": "climk4dcQFiPdA5ULuhS"
    }
  ],
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "operativeProcessRef": "text",
  "orderDate": "2020-02-03T08:45:50.525Z",
  "orderRef": "LGMl2DuvPnfPoSHhYFOm",
  "paymentInformation": {
    "currency": "EUR"
  },
  "pickingTimes": {
    "startLatestAt": "2024-02-03T09:45:51.525Z"
  },
  "pickLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "globalLineItemId": "a81f818e-2405-4570-8cde-b0c80fd3de31",
      "id": "climk4dcQFiPdA5ULuhS",
      "quantity": 21,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold"
            }
          ],
          "imageUrl": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "tenantArticleId": "text",
          "title": "text"
        }
      ],
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
      "partialStockLocations": [
        {
          "available": 21,
          "location": {
            "locationRef": "text",
            "scannableCodes": [
              "text"
            ]
          },
          "quantity": 21,
          "ratingScore": 1,
          "sequenceScore": 1,
          "stockProperties": {
            "expiry": "text"
          },
          "stockRef": "text",
          "tenantPartialStockId": "text"
        }
      ],
      "picked": 20,
      "pickedAt": "2024-02-03T08:45:51.525Z",
      "pickJobLineItemRef": "12345",
      "scannedCodes": [
        {
          "code": 1245678,
          "quantity": 7
        }
      ],
      "scanningRules": {
        "scanningMode": "MUST_SCAN_FIRST",
        "scanningType": []
      },
      "secondaryMeasurementUnitKey": "liter",
      "secondaryPicked": 20,
      "secondaryQuantity": 21,
      "shortPickReason": {
        "reasonLocalized": "{ en_US: 'SomeName' }",
        "reason": "text"
      },
      "status": "OPEN",
      "stickers": [],
      "stockEmptied": true,
      "substituteLineItems": [
        {
          "article": {
            "titleLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "customAttributes": {},
            "imageUrl": "text",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "weight": 1,
            "attributes": [
              {
                "valueLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "keyLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "category": "descriptive",
                "context": {
                  "type": "FACILITY_GROUP",
                  "value": "text"
                },
                "key": "%%subtitle%%",
                "priority": 100,
                "type": "STRING",
                "value": "585er Gold"
              }
            ]
          },
          "globalLineItemId": "text",
          "id": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "partialStockLocations": [
            {
              "location": {
                "locationRef": "text",
                "scannableCodes": [
                  "text"
                ]
              },
              "picked": 21,
              "quantity": 21,
              "ratingScore": 1,
              "sequenceScore": 1,
              "stockProperties": {
                "expiry": "text"
              },
              "stockRef": "text",
              "tenantPartialStockId": "text",
              "zoneName": "text"
            }
          ],
          "picked": 20,
          "pickedAt": "2024-02-03T08:45:51.525Z",
          "priority": 1,
          "quantity": 21,
          "refused": [],
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "secondaryPicked": 20,
          "secondaryQuantity": 200
        }
      ],
      "tags": []
    }
  ],
  "preferredPickingMethods": [
    "SINGLE_ORDER"
  ],
  "processId": "text",
  "routingPlanRef": "text",
  "shortId": "AS12",
  "status": "ABORTED",
  "stickers": [],
  "tenantOrderId": "R456728546",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ],
  "workflowInformation": {
    "instanceRef": "64c13ab08edf48a008793cac",
    "isAvailable": true,
    "nodeRef": "text"
  },
  "tags": [],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "anonymized": false,
  "documentHandling": {
    "sendLabel": {
      "enabled": false
    }
  },
  "documentsRef": "text",
  "editor": {
    "userId": "text",
    "username": "text"
  },
  "id": "Esb20gpHBL94X5NdMp3C",
  "pickingZones": [],
  "pickRunRef": "text",
  "resetBlocked": false,
  "subStatus": "SHORT_PICKED",
  "usersModificationHistory": [
    {
      "modificationDate": "2026-03-13T13:47:33.519Z",
      "userId": "text",
      "username": "text"
    }
  ]
}

Deprecated

Update pick job

patch

This part of the API is deprecated. For details please check the api-release-life-cycle documentation. @deprecated Use POST /api/pickjobs/{pickJobId}/actions instead.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pickJobIdstringRequired

ID of the pickjob you want to get

Body

PickingPatchActions

versioninteger · int64Required

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

Example: 42

Responses

200

PickJob was found & patch-set has been applied. The patched pick job is in the body.

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

PickJob not found

application/json

409

PickJob version conflict

application/json

patch

/api/pickjobs/{pickJobId}

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

{
  "actions": [
    {
      "action": "ModifyPickLineItem",
      "shortPickReasonLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "customAttributes": {},
      "id": "climk4dcQFiPdA5ULuhS",
      "partialStockLocations": [
        {
          "picked": 21,
          "stockEmptied": true,
          "stockRef": "text",
          "tenantPartialStockId": "text"
        }
      ],
      "picked": 20,
      "pickedAt": "2024-02-03T08:45:51.525Z",
      "scannedCodes": [
        {
          "code": 1245678,
          "quantity": 7
        }
      ],
      "secondaryPicked": 1,
      "status": "OPEN",
      "stickers": [],
      "stockEmptied": true,
      "substituteLineItems": [
        {
          "id": "text",
          "picked": 20,
          "pickedAt": "2024-02-03T08:45:51.525Z",
          "quantity": 21,
          "secondaryPicked": 20,
          "secondaryQuantity": 21,
          "tenantArticleId": "text"
        }
      ]
    }
  ],
  "version": 42
}

{
  "assignedUsers": [
    {
      "userId": "text",
      "username": "text"
    }
  ],
  "customAttributes": {},
  "deliveryinformation": {
    "channel": "COLLECT",
    "details": {
      "collect": {
        "identifier": "text",
        "paid": false
      },
      "shipping": {
        "carrierKey": "text",
        "carrierProduct": "EXPRESS",
        "carrierProductCategory": "STANDARD",
        "carrierServices": [
          "SIGNATURE"
        ],
        "identifier": "text",
        "invoiceAddress": {
          "addressType": "POSTAL_ADDRESS",
          "companyName": "Speedy Boxales Ltd.",
          "coordinates": {
            "lat": 50.937531,
            "lon": 6.960279
          },
          "email": "[email protected]",
          "firstName": "Maxine",
          "lastName": "Muller",
          "personalTitle": "Dr.",
          "salutation": "Frau",
          "additionalAddressInfo": "to care of: Mrs. Müller",
          "city": "Langenfeld",
          "country": "DE",
          "customAttributes": {},
          "houseNumber": "42a",
          "phoneNumbers": [
            {
              "customAttributes": {},
              "label": "text",
              "type": "MOBILE",
              "value": "text"
            }
          ],
          "postalCode": "40764",
          "province": "NRW",
          "street": "Hauptstr."
        },
        "postalAddress": {
          "addressType": "POSTAL_ADDRESS",
          "companyName": "Speedy Boxales Ltd.",
          "coordinates": {
            "lat": 50.937531,
            "lon": 6.960279
          },
          "email": "[email protected]",
          "firstName": "Maxine",
          "lastName": "Muller",
          "personalTitle": "Dr.",
          "salutation": "Frau",
          "additionalAddressInfo": "to care of: Mrs. Müller",
          "city": "Langenfeld",
          "country": "DE",
          "customAttributes": {},
          "houseNumber": "42a",
          "phoneNumbers": [
            {
              "customAttributes": {},
              "label": "text",
              "type": "MOBILE",
              "value": "text"
            }
          ],
          "postalCode": "40764",
          "province": "NRW",
          "street": "Hauptstr."
        },
        "recipientaddress": {
          "addressType": "POSTAL_ADDRESS",
          "companyName": "Speedy Boxales Ltd.",
          "coordinates": {
            "lat": 50.937531,
            "lon": 6.960279
          },
          "email": "[email protected]",
          "firstName": "Maxine",
          "lastName": "Muller",
          "personalTitle": "Dr.",
          "salutation": "Frau",
          "additionalAddressInfo": "to care of: Mrs. Müller",
          "city": "Langenfeld",
          "country": "DE",
          "customAttributes": {},
          "houseNumber": "42a",
          "phoneNumbers": [
            {
              "customAttributes": {},
              "label": "text",
              "type": "MOBILE",
              "value": "text"
            }
          ],
          "postalCode": "40764",
          "province": "NRW",
          "street": "Hauptstr."
        },
        "serviceLevel": "DELIVERY"
      }
    },
    "targetTime": "2020-02-03T09:45:51.525Z",
    "targetTimeBaseDate": "2020-02-03T08:45:50.525Z"
  },
  "expectedPickLineItems": [
    {
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold"
            }
          ],
          "imageUrl": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "tenantArticleId": "text",
          "title": "text"
        }
      ],
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "partialStockLocations": [
        {
          "available": 21,
          "location": {
            "locationRef": "text",
            "scannableCodes": [
              "text"
            ]
          },
          "quantity": 21,
          "ratingScore": 1,
          "sequenceScore": 1,
          "stockProperties": {
            "expiry": "text"
          },
          "stockRef": "text",
          "tenantPartialStockId": "text"
        }
      ],
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "secondaryMeasurementUnitKey": "liter",
      "secondaryQuantity": 21,
      "stickers": [],
      "transferId": "text",
      "tags": []
    },
    {
      "id": "climk4dcQFiPdA5ULuhS"
    }
  ],
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "operativeProcessRef": "text",
  "orderDate": "2020-02-03T08:45:50.525Z",
  "orderRef": "LGMl2DuvPnfPoSHhYFOm",
  "paymentInformation": {
    "currency": "EUR"
  },
  "pickingTimes": {
    "startLatestAt": "2024-02-03T09:45:51.525Z"
  },
  "pickLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "globalLineItemId": "a81f818e-2405-4570-8cde-b0c80fd3de31",
      "id": "climk4dcQFiPdA5ULuhS",
      "quantity": 21,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold"
            }
          ],
          "imageUrl": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "tenantArticleId": "text",
          "title": "text"
        }
      ],
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
      "partialStockLocations": [
        {
          "available": 21,
          "location": {
            "locationRef": "text",
            "scannableCodes": [
              "text"
            ]
          },
          "quantity": 21,
          "ratingScore": 1,
          "sequenceScore": 1,
          "stockProperties": {
            "expiry": "text"
          },
          "stockRef": "text",
          "tenantPartialStockId": "text"
        }
      ],
      "picked": 20,
      "pickedAt": "2024-02-03T08:45:51.525Z",
      "pickJobLineItemRef": "12345",
      "scannedCodes": [
        {
          "code": 1245678,
          "quantity": 7
        }
      ],
      "scanningRules": {
        "scanningMode": "MUST_SCAN_FIRST",
        "scanningType": []
      },
      "secondaryMeasurementUnitKey": "liter",
      "secondaryPicked": 20,
      "secondaryQuantity": 21,
      "shortPickReason": {
        "reasonLocalized": "{ en_US: 'SomeName' }",
        "reason": "text"
      },
      "status": "OPEN",
      "stickers": [],
      "stockEmptied": true,
      "substituteLineItems": [
        {
          "article": {
            "titleLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "customAttributes": {},
            "imageUrl": "text",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "weight": 1,
            "attributes": [
              {
                "valueLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "keyLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "category": "descriptive",
                "context": {
                  "type": "FACILITY_GROUP",
                  "value": "text"
                },
                "key": "%%subtitle%%",
                "priority": 100,
                "type": "STRING",
                "value": "585er Gold"
              }
            ]
          },
          "globalLineItemId": "text",
          "id": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "partialStockLocations": [
            {
              "location": {
                "locationRef": "text",
                "scannableCodes": [
                  "text"
                ]
              },
              "picked": 21,
              "quantity": 21,
              "ratingScore": 1,
              "sequenceScore": 1,
              "stockProperties": {
                "expiry": "text"
              },
              "stockRef": "text",
              "tenantPartialStockId": "text",
              "zoneName": "text"
            }
          ],
          "picked": 20,
          "pickedAt": "2024-02-03T08:45:51.525Z",
          "priority": 1,
          "quantity": 21,
          "refused": [],
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "secondaryPicked": 20,
          "secondaryQuantity": 200
        }
      ],
      "tags": []
    }
  ],
  "preferredPickingMethods": [
    "SINGLE_ORDER"
  ],
  "processId": "text",
  "routingPlanRef": "text",
  "shortId": "AS12",
  "status": "ABORTED",
  "stickers": [],
  "tenantOrderId": "R456728546",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ],
  "workflowInformation": {
    "instanceRef": "64c13ab08edf48a008793cac",
    "isAvailable": true,
    "nodeRef": "text"
  },
  "tags": [],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "anonymized": false,
  "documentHandling": {
    "sendLabel": {
      "enabled": false
    }
  },
  "documentsRef": "text",
  "editor": {
    "userId": "text",
    "username": "text"
  },
  "id": "Esb20gpHBL94X5NdMp3C",
  "pickingZones": [],
  "pickRunRef": "text",
  "resetBlocked": false,
  "subStatus": "SHORT_PICKED",
  "usersModificationHistory": [
    {
      "modificationDate": "2026-03-13T13:47:33.519Z",
      "userId": "text",
      "username": "text"
    }
  ]
}

Call pick job action

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pickJobIdstringRequired

Reference to the pick job you want to call an action for

Body

PickJobActionsParameter

Responses

200

Updated PickJob in the body.

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

/api/pickjobs/{pickJobId}/actions

POST /api/pickjobs/{pickJobId}/actions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "name": "ABORT",
  "version": 1
}

{
  "assignedUsers": [
    {
      "userId": "text",
      "username": "text"
    }
  ],
  "customAttributes": {},
  "deliveryinformation": {
    "channel": "COLLECT",
    "details": {
      "collect": {
        "identifier": "text",
        "paid": false
      },
      "shipping": {
        "carrierKey": "text",
        "carrierProduct": "EXPRESS",
        "carrierProductCategory": "STANDARD",
        "carrierServices": [
          "SIGNATURE"
        ],
        "identifier": "text",
        "invoiceAddress": {
          "addressType": "POSTAL_ADDRESS",
          "companyName": "Speedy Boxales Ltd.",
          "coordinates": {
            "lat": 50.937531,
            "lon": 6.960279
          },
          "email": "[email protected]",
          "firstName": "Maxine",
          "lastName": "Muller",
          "personalTitle": "Dr.",
          "salutation": "Frau",
          "additionalAddressInfo": "to care of: Mrs. Müller",
          "city": "Langenfeld",
          "country": "DE",
          "customAttributes": {},
          "houseNumber": "42a",
          "phoneNumbers": [
            {
              "customAttributes": {},
              "label": "text",
              "type": "MOBILE",
              "value": "text"
            }
          ],
          "postalCode": "40764",
          "province": "NRW",
          "street": "Hauptstr."
        },
        "postalAddress": {
          "addressType": "POSTAL_ADDRESS",
          "companyName": "Speedy Boxales Ltd.",
          "coordinates": {
            "lat": 50.937531,
            "lon": 6.960279
          },
          "email": "[email protected]",
          "firstName": "Maxine",
          "lastName": "Muller",
          "personalTitle": "Dr.",
          "salutation": "Frau",
          "additionalAddressInfo": "to care of: Mrs. Müller",
          "city": "Langenfeld",
          "country": "DE",
          "customAttributes": {},
          "houseNumber": "42a",
          "phoneNumbers": [
            {
              "customAttributes": {},
              "label": "text",
              "type": "MOBILE",
              "value": "text"
            }
          ],
          "postalCode": "40764",
          "province": "NRW",
          "street": "Hauptstr."
        },
        "recipientaddress": {
          "addressType": "POSTAL_ADDRESS",
          "companyName": "Speedy Boxales Ltd.",
          "coordinates": {
            "lat": 50.937531,
            "lon": 6.960279
          },
          "email": "[email protected]",
          "firstName": "Maxine",
          "lastName": "Muller",
          "personalTitle": "Dr.",
          "salutation": "Frau",
          "additionalAddressInfo": "to care of: Mrs. Müller",
          "city": "Langenfeld",
          "country": "DE",
          "customAttributes": {},
          "houseNumber": "42a",
          "phoneNumbers": [
            {
              "customAttributes": {},
              "label": "text",
              "type": "MOBILE",
              "value": "text"
            }
          ],
          "postalCode": "40764",
          "province": "NRW",
          "street": "Hauptstr."
        },
        "serviceLevel": "DELIVERY"
      }
    },
    "targetTime": "2020-02-03T09:45:51.525Z",
    "targetTimeBaseDate": "2020-02-03T08:45:50.525Z"
  },
  "expectedPickLineItems": [
    {
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold"
            }
          ],
          "imageUrl": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "tenantArticleId": "text",
          "title": "text"
        }
      ],
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "partialStockLocations": [
        {
          "available": 21,
          "location": {
            "locationRef": "text",
            "scannableCodes": [
              "text"
            ]
          },
          "quantity": 21,
          "ratingScore": 1,
          "sequenceScore": 1,
          "stockProperties": {
            "expiry": "text"
          },
          "stockRef": "text",
          "tenantPartialStockId": "text"
        }
      ],
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "secondaryMeasurementUnitKey": "liter",
      "secondaryQuantity": 21,
      "stickers": [],
      "transferId": "text",
      "tags": []
    },
    {
      "id": "climk4dcQFiPdA5ULuhS"
    }
  ],
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "operativeProcessRef": "text",
  "orderDate": "2020-02-03T08:45:50.525Z",
  "orderRef": "LGMl2DuvPnfPoSHhYFOm",
  "paymentInformation": {
    "currency": "EUR"
  },
  "pickingTimes": {
    "startLatestAt": "2024-02-03T09:45:51.525Z"
  },
  "pickLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "globalLineItemId": "a81f818e-2405-4570-8cde-b0c80fd3de31",
      "id": "climk4dcQFiPdA5ULuhS",
      "quantity": 21,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold"
            }
          ],
          "imageUrl": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "tenantArticleId": "text",
          "title": "text"
        }
      ],
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
      "partialStockLocations": [
        {
          "available": 21,
          "location": {
            "locationRef": "text",
            "scannableCodes": [
              "text"
            ]
          },
          "quantity": 21,
          "ratingScore": 1,
          "sequenceScore": 1,
          "stockProperties": {
            "expiry": "text"
          },
          "stockRef": "text",
          "tenantPartialStockId": "text"
        }
      ],
      "picked": 20,
      "pickedAt": "2024-02-03T08:45:51.525Z",
      "pickJobLineItemRef": "12345",
      "scannedCodes": [
        {
          "code": 1245678,
          "quantity": 7
        }
      ],
      "scanningRules": {
        "scanningMode": "MUST_SCAN_FIRST",
        "scanningType": []
      },
      "secondaryMeasurementUnitKey": "liter",
      "secondaryPicked": 20,
      "secondaryQuantity": 21,
      "shortPickReason": {
        "reasonLocalized": "{ en_US: 'SomeName' }",
        "reason": "text"
      },
      "status": "OPEN",
      "stickers": [],
      "stockEmptied": true,
      "substituteLineItems": [
        {
          "article": {
            "titleLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "customAttributes": {},
            "imageUrl": "text",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "weight": 1,
            "attributes": [
              {
                "valueLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "keyLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "category": "descriptive",
                "context": {
                  "type": "FACILITY_GROUP",
                  "value": "text"
                },
                "key": "%%subtitle%%",
                "priority": 100,
                "type": "STRING",
                "value": "585er Gold"
              }
            ]
          },
          "globalLineItemId": "text",
          "id": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "partialStockLocations": [
            {
              "location": {
                "locationRef": "text",
                "scannableCodes": [
                  "text"
                ]
              },
              "picked": 21,
              "quantity": 21,
              "ratingScore": 1,
              "sequenceScore": 1,
              "stockProperties": {
                "expiry": "text"
              },
              "stockRef": "text",
              "tenantPartialStockId": "text",
              "zoneName": "text"
            }
          ],
          "picked": 20,
          "pickedAt": "2024-02-03T08:45:51.525Z",
          "priority": 1,
          "quantity": 21,
          "refused": [],
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "secondaryPicked": 20,
          "secondaryQuantity": 200
        }
      ],
      "tags": []
    }
  ],
  "preferredPickingMethods": [
    "SINGLE_ORDER"
  ],
  "processId": "text",
  "routingPlanRef": "text",
  "shortId": "AS12",
  "status": "ABORTED",
  "stickers": [],
  "tenantOrderId": "R456728546",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ],
  "workflowInformation": {
    "instanceRef": "64c13ab08edf48a008793cac",
    "isAvailable": true,
    "nodeRef": "text"
  },
  "tags": [],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "anonymized": false,
  "documentHandling": {
    "sendLabel": {
      "enabled": false
    }
  },
  "documentsRef": "text",
  "editor": {
    "userId": "text",
    "username": "text"
  },
  "id": "Esb20gpHBL94X5NdMp3C",
  "pickingZones": [],
  "pickRunRef": "text",
  "resetBlocked": false,
  "subStatus": "SHORT_PICKED",
  "usersModificationHistory": [
    {
      "modificationDate": "2026-03-13T13:47:33.519Z",
      "userId": "text",
      "username": "text"
    }
  ]
}

Get pick job delivery note

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pickJobIdstringRequired

ID of the pick job for which you want to get a deliverynote

Query parameters

localestringOptional

Provide the localized values for the delivery note. If not provided the default locale is used. For example de_DE

Responses

200

The deliverynote for the given pickjob

application/pdf

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

get

/api/pickjobs/{pickJobId}/deliverynote

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

List pick job load units

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pickJobIdstringRequired

Reference to the pick job you want to get the corresponding loadunits

Responses

200

Loadunits were found. The results are in the body.

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

get

/api/pickjobs/{pickJobId}/loadunits

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

{
  "loadUnits": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42
    }
  ],
  "total": 42
}

Create pick job load unit

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pickJobIdstringRequired

Reference to the pick job you want to get the corresponding loadunits

Body

PickingLoadUnitForCreation

codesstring[] · min: 1Required

List of codes

customAttributesobjectOptional

Attributes that can be added to the PickingLoadUnit. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.

loadUnitTypeRefstringOptional

operativeContainerTypeRefstringOptional

the reference to the operativeContainerType

stackRefstringOptional

the reference to the stackRef this loadUnit is part of

storageLocationRefstringOptional

the reference to the storage location this load unit as been placed into

Responses

201

The load units was successfully created.

application/json

PickingLoadUnit

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

/api/pickjobs/{pickJobId}/loadunits

POST /api/pickjobs/{pickJobId}/loadunits HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 169

{
  "codes": [
    "text"
  ],
  "customAttributes": {},
  "loadUnitLineItems": [],
  "loadUnitTypeRef": "text",
  "operativeContainerTypeRef": "text",
  "stackRef": "text",
  "storageLocationRef": "text"
}

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "description": "text",
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "iconUrl": "text",
  "id": "text",
  "loadUnitLineItems": [],
  "name": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "codes": [
    "text"
  ],
  "customAttributes": {},
  "loadUnitTypeRef": "text",
  "operativeContainerTypeRef": "text",
  "stackRef": "text",
  "storageLocationRef": "text"
}

List available line item substitutes

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Returns all available substitutes for a given pickLineItem.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pickJobIdstringRequired

Reference to the pick job you to get the available substitutes for

pickLineItemIdstringRequired

Reference to the pickLineItem you to get the available substitutes for

Responses

200

Available substitutes for given pickLineItem

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

get

/api/pickjobs/{pickJobId}/picklineitems/{pickLineItemId}/availablesubstitutes

GET /api/pickjobs/{pickJobId}/picklineitems/{pickLineItemId}/availablesubstitutes HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "substitutes": [
    {
      "attributes": [
        {
          "valueLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "category": "descriptive",
          "context": {
            "type": "FACILITY_GROUP",
            "value": "text"
          },
          "key": "%%subtitle%%",
          "priority": 100,
          "type": "STRING",
          "value": "585er Gold"
        }
      ],
      "imageUrl": "text",
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "priority": 1,
      "scannableCodes": [
        "text"
      ],
      "secondaryMeasurementUnitKey": "gram",
      "tenantArticleId": "text",
      "title": "text"
    }
  ],
  "tenantArticleId": "text"
}

Get pick job return note

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pickjobIdstringRequired

ID of the Pickjob

Responses

200

Returns a return note for the pickjob.

application/pdf

401

Your user is not allowed to operate against this API instance

application/pdf

403

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

application/pdf

404

Entity not found

application/pdf

get

/api/pickjobs/{pickjobId}/returnnote

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

Get pick job transfer label

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pickJobIdstringRequired

ID of the pick job for which you want to get a transfer label

Responses

200

The transfer label for the given pickjob

application/pdf

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

get

/api/pickjobs/{pickJobId}/transferlabel

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

List pick jobs (search)

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Search for PickJob

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

PickJobSearchPayload

afterstringOptional

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.

beforestringOptional

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).

lastnumber · min: 1 · max: 250Optional

Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.

sizenumber · min: 1 · max: 250Optional

Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.

startAfterIdstringOptionalDeprecated

The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.

Responses

200

Your search result

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/pickjobs/search

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

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "consumerName": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "facilityRef": {
              "eq": "text",
              "notEq": "text"
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "status": {
              "eq": "ABORTED",
              "in": [
                "ABORTED"
              ],
              "notEq": "ABORTED"
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-13T13:47:33.519Z",
              "gt": "2026-03-13T13:47:33.519Z",
              "gte": "2026-03-13T13:47:33.519Z",
              "lt": "2026-03-13T13:47:33.519Z",
              "lte": "2026-03-13T13:47:33.519Z",
              "notEq": "2026-03-13T13:47:33.519Z"
            },
            "tenantArticleIds": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "transfers": {
              "contains": {
                "id": {
                  "eq": "text",
                  "notEq": "text"
                }
              }
            }
          }
        ],
        "consumerName": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "facilityRef": {
          "eq": "text",
          "notEq": "text"
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "consumerName": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "facilityRef": {
              "eq": "text",
              "notEq": "text"
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "status": {
              "eq": "ABORTED",
              "in": [
                "ABORTED"
              ],
              "notEq": "ABORTED"
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-13T13:47:33.519Z",
              "gt": "2026-03-13T13:47:33.519Z",
              "gte": "2026-03-13T13:47:33.519Z",
              "lt": "2026-03-13T13:47:33.519Z",
              "lte": "2026-03-13T13:47:33.519Z",
              "notEq": "2026-03-13T13:47:33.519Z"
            },
            "tenantArticleIds": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "transfers": {
              "contains": {
                "id": {
                  "eq": "text",
                  "notEq": "text"
                }
              }
            }
          }
        ],
        "status": {
          "eq": "ABORTED",
          "in": [
            "ABORTED"
          ],
          "notEq": "ABORTED"
        },
        "targetTime": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-13T13:47:33.519Z",
          "gt": "2026-03-13T13:47:33.519Z",
          "gte": "2026-03-13T13:47:33.519Z",
          "lt": "2026-03-13T13:47:33.519Z",
          "lte": "2026-03-13T13:47:33.519Z",
          "notEq": "2026-03-13T13:47:33.519Z"
        },
        "tenantArticleIds": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "transfers": {
          "contains": {
            "id": {
              "eq": "text",
              "notEq": "text"
            }
          }
        }
      }
    ],
    "consumerName": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "facilityRef": {
      "eq": "text",
      "notEq": "text"
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "consumerName": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "facilityRef": {
          "eq": "text",
          "notEq": "text"
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "status": {
          "eq": "ABORTED",
          "in": [
            "ABORTED"
          ],
          "notEq": "ABORTED"
        },
        "targetTime": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-13T13:47:33.519Z",
          "gt": "2026-03-13T13:47:33.519Z",
          "gte": "2026-03-13T13:47:33.519Z",
          "lt": "2026-03-13T13:47:33.519Z",
          "lte": "2026-03-13T13:47:33.519Z",
          "notEq": "2026-03-13T13:47:33.519Z"
        },
        "tenantArticleIds": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "transfers": {
          "contains": {
            "id": {
              "eq": "text",
              "notEq": "text"
            }
          }
        }
      }
    ],
    "status": {
      "eq": "ABORTED",
      "in": [
        "ABORTED"
      ],
      "notEq": "ABORTED"
    },
    "targetTime": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-13T13:47:33.519Z",
      "gt": "2026-03-13T13:47:33.519Z",
      "gte": "2026-03-13T13:47:33.519Z",
      "lt": "2026-03-13T13:47:33.519Z",
      "lte": "2026-03-13T13:47:33.519Z",
      "notEq": "2026-03-13T13:47:33.519Z"
    },
    "tenantArticleIds": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "tenantOrderId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "transfers": {
      "contains": {
        "id": {
          "eq": "text",
          "notEq": "text"
        }
      }
    }
  },
  "size": 1,
  "sort": [
    {
      "targetTime": "ASC",
      "tenantOrderId": "ASC"
    }
  ]
}

{
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "pickJobs": [
    {
      "assignedUsers": [
        {
          "userId": "text",
          "username": "text"
        }
      ],
      "customAttributes": {},
      "deliveryinformation": {
        "channel": "COLLECT",
        "details": {
          "collect": {
            "identifier": "text",
            "paid": false
          },
          "shipping": {
            "carrierKey": "text",
            "carrierProduct": "EXPRESS",
            "carrierProductCategory": "STANDARD",
            "carrierServices": [
              "SIGNATURE"
            ],
            "identifier": "text",
            "invoiceAddress": {
              "addressType": "POSTAL_ADDRESS",
              "companyName": "Speedy Boxales Ltd.",
              "coordinates": {
                "lat": 50.937531,
                "lon": 6.960279
              },
              "email": "[email protected]",
              "firstName": "Maxine",
              "lastName": "Muller",
              "personalTitle": "Dr.",
              "salutation": "Frau",
              "additionalAddressInfo": "to care of: Mrs. Müller",
              "city": "Langenfeld",
              "country": "DE",
              "customAttributes": {},
              "houseNumber": "42a",
              "phoneNumbers": [
                {
                  "customAttributes": {},
                  "label": "text",
                  "type": "MOBILE",
                  "value": "text"
                }
              ],
              "postalCode": "40764",
              "province": "NRW",
              "street": "Hauptstr."
            },
            "postalAddress": {
              "addressType": "POSTAL_ADDRESS",
              "companyName": "Speedy Boxales Ltd.",
              "coordinates": {
                "lat": 50.937531,
                "lon": 6.960279
              },
              "email": "[email protected]",
              "firstName": "Maxine",
              "lastName": "Muller",
              "personalTitle": "Dr.",
              "salutation": "Frau",
              "additionalAddressInfo": "to care of: Mrs. Müller",
              "city": "Langenfeld",
              "country": "DE",
              "customAttributes": {},
              "houseNumber": "42a",
              "phoneNumbers": [
                {
                  "customAttributes": {},
                  "label": "text",
                  "type": "MOBILE",
                  "value": "text"
                }
              ],
              "postalCode": "40764",
              "province": "NRW",
              "street": "Hauptstr."
            },
            "recipientaddress": {
              "addressType": "POSTAL_ADDRESS",
              "companyName": "Speedy Boxales Ltd.",
              "coordinates": {
                "lat": 50.937531,
                "lon": 6.960279
              },
              "email": "[email protected]",
              "firstName": "Maxine",
              "lastName": "Muller",
              "personalTitle": "Dr.",
              "salutation": "Frau",
              "additionalAddressInfo": "to care of: Mrs. Müller",
              "city": "Langenfeld",
              "country": "DE",
              "customAttributes": {},
              "houseNumber": "42a",
              "phoneNumbers": [
                {
                  "customAttributes": {},
                  "label": "text",
                  "type": "MOBILE",
                  "value": "text"
                }
              ],
              "postalCode": "40764",
              "province": "NRW",
              "street": "Hauptstr."
            },
            "serviceLevel": "DELIVERY"
          }
        },
        "targetTime": "2020-02-03T09:45:51.525Z",
        "targetTimeBaseDate": "2020-02-03T08:45:50.525Z"
      },
      "expectedPickLineItems": [
        {
          "allowedSubstitutes": [
            {
              "attributes": [
                {
                  "valueLocalized": {
                    "de_DE": "Wert",
                    "en_US": "Value",
                    "ru_RU": "значение"
                  },
                  "keyLocalized": {
                    "de_DE": "Wert",
                    "en_US": "Value",
                    "ru_RU": "значение"
                  },
                  "category": "descriptive",
                  "context": {
                    "type": "FACILITY_GROUP",
                    "value": "text"
                  },
                  "key": "%%subtitle%%",
                  "priority": 100,
                  "type": "STRING",
                  "value": "585er Gold"
                }
              ],
              "imageUrl": "text",
              "measurementUnitKey": "liter",
              "measurementValidation": {
                "overPickHardTolerancePercentage": 20,
                "overPickSoftTolerancePercentage": 15,
                "shortPickHardTolerancePercentage": 15,
                "shortPickSoftTolerancePercentage": 10
              },
              "priority": 1,
              "scannableCodes": [
                "text"
              ],
              "secondaryMeasurementUnitKey": "gram",
              "tenantArticleId": "text",
              "title": "text"
            }
          ],
          "article": {
            "titleLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "attributes": [
              {
                "valueLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "keyLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "category": "descriptive",
                "context": {
                  "type": "FACILITY_GROUP",
                  "value": "text"
                },
                "key": "%%subtitle%%",
                "priority": 100,
                "type": "STRING",
                "value": "585er Gold"
              }
            ],
            "imageUrl": "text",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "weight": 1
          },
          "customAttributes": {},
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "partialStockLocations": [
            {
              "available": 21,
              "location": {
                "locationRef": "text",
                "scannableCodes": [
                  "text"
                ]
              },
              "quantity": 21,
              "ratingScore": 1,
              "sequenceScore": 1,
              "stockProperties": {
                "expiry": "text"
              },
              "stockRef": "text",
              "tenantPartialStockId": "text"
            }
          ],
          "quantity": 21,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "liter",
          "secondaryQuantity": 21,
          "stickers": [],
          "transferId": "text",
          "tags": []
        },
        {
          "id": "climk4dcQFiPdA5ULuhS"
        }
      ],
      "facilityRef": "Esb20gpHBL94X5NdMp3C",
      "operativeProcessRef": "text",
      "orderDate": "2020-02-03T08:45:50.525Z",
      "orderRef": "LGMl2DuvPnfPoSHhYFOm",
      "paymentInformation": {
        "currency": "EUR"
      },
      "pickingTimes": {
        "startLatestAt": "2024-02-03T09:45:51.525Z"
      },
      "pickLineItems": [
        {
          "article": {
            "titleLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "attributes": [
              {
                "valueLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "keyLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "category": "descriptive",
                "context": {
                  "type": "FACILITY_GROUP",
                  "value": "text"
                },
                "key": "%%subtitle%%",
                "priority": 100,
                "type": "STRING",
                "value": "585er Gold"
              }
            ],
            "imageUrl": "text",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "weight": 1
          },
          "customAttributes": {},
          "globalLineItemId": "a81f818e-2405-4570-8cde-b0c80fd3de31",
          "id": "climk4dcQFiPdA5ULuhS",
          "quantity": 21,
          "recordableAttributes": [
            {
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "group": "general",
              "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
              "key": "country of origin",
              "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
              "recordingRule": "MANDATORY",
              "value": "Germany"
            }
          ],
          "scannableCodes": [
            "text"
          ],
          "allowedSubstitutes": [
            {
              "attributes": [
                {
                  "valueLocalized": {
                    "de_DE": "Wert",
                    "en_US": "Value",
                    "ru_RU": "значение"
                  },
                  "keyLocalized": {
                    "de_DE": "Wert",
                    "en_US": "Value",
                    "ru_RU": "значение"
                  },
                  "category": "descriptive",
                  "context": {
                    "type": "FACILITY_GROUP",
                    "value": "text"
                  },
                  "key": "%%subtitle%%",
                  "priority": 100,
                  "type": "STRING",
                  "value": "585er Gold"
                }
              ],
              "imageUrl": "text",
              "measurementUnitKey": "liter",
              "measurementValidation": {
                "overPickHardTolerancePercentage": 20,
                "overPickSoftTolerancePercentage": 15,
                "shortPickHardTolerancePercentage": 15,
                "shortPickSoftTolerancePercentage": 10
              },
              "priority": 1,
              "scannableCodes": [
                "text"
              ],
              "secondaryMeasurementUnitKey": "gram",
              "tenantArticleId": "text",
              "title": "text"
            }
          ],
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
          "partialStockLocations": [
            {
              "available": 21,
              "location": {
                "locationRef": "text",
                "scannableCodes": [
                  "text"
                ]
              },
              "quantity": 21,
              "ratingScore": 1,
              "sequenceScore": 1,
              "stockProperties": {
                "expiry": "text"
              },
              "stockRef": "text",
              "tenantPartialStockId": "text"
            }
          ],
          "picked": 20,
          "pickedAt": "2024-02-03T08:45:51.525Z",
          "pickJobLineItemRef": "12345",
          "scannedCodes": [
            {
              "code": 1245678,
              "quantity": 7
            }
          ],
          "scanningRules": {
            "scanningMode": "MUST_SCAN_FIRST",
            "scanningType": []
          },
          "secondaryMeasurementUnitKey": "liter",
          "secondaryPicked": 20,
          "secondaryQuantity": 21,
          "shortPickReason": {
            "reasonLocalized": "{ en_US: 'SomeName' }",
            "reason": "text"
          },
          "status": "OPEN",
          "stickers": [],
          "stockEmptied": true,
          "substituteLineItems": [
            {
              "article": {
                "titleLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "customAttributes": {},
                "imageUrl": "text",
                "tenantArticleId": "4711",
                "title": "Cologne Water",
                "weight": 1,
                "attributes": [
                  {
                    "valueLocalized": {
                      "de_DE": "Wert",
                      "en_US": "Value",
                      "ru_RU": "значение"
                    },
                    "keyLocalized": {
                      "de_DE": "Wert",
                      "en_US": "Value",
                      "ru_RU": "значение"
                    },
                    "category": "descriptive",
                    "context": {
                      "type": "FACILITY_GROUP",
                      "value": "text"
                    },
                    "key": "%%subtitle%%",
                    "priority": 100,
                    "type": "STRING",
                    "value": "585er Gold"
                  }
                ]
              },
              "globalLineItemId": "text",
              "id": "text",
              "measurementUnitKey": "liter",
              "measurementValidation": {
                "overPickHardTolerancePercentage": 20,
                "overPickSoftTolerancePercentage": 15,
                "shortPickHardTolerancePercentage": 15,
                "shortPickSoftTolerancePercentage": 10
              },
              "partialStockLocations": [
                {
                  "location": {
                    "locationRef": "text",
                    "scannableCodes": [
                      "text"
                    ]
                  },
                  "picked": 21,
                  "quantity": 21,
                  "ratingScore": 1,
                  "sequenceScore": 1,
                  "stockProperties": {
                    "expiry": "text"
                  },
                  "stockRef": "text",
                  "tenantPartialStockId": "text",
                  "zoneName": "text"
                }
              ],
              "picked": 20,
              "pickedAt": "2024-02-03T08:45:51.525Z",
              "priority": 1,
              "quantity": 21,
              "refused": [],
              "scannableCodes": [
                "text"
              ],
              "secondaryMeasurementUnitKey": "gram",
              "secondaryPicked": 20,
              "secondaryQuantity": 200
            }
          ],
          "tags": []
        }
      ],
      "preferredPickingMethods": [
        "SINGLE_ORDER"
      ],
      "processId": "text",
      "routingPlanRef": "text",
      "shortId": "AS12",
      "status": "ABORTED",
      "stickers": [],
      "tenantOrderId": "R456728546",
      "transfers": [
        {
          "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
          "type": "RECEIVER"
        }
      ],
      "workflowInformation": {
        "instanceRef": "64c13ab08edf48a008793cac",
        "isAvailable": true,
        "nodeRef": "text"
      },
      "tags": [],
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42,
      "anonymized": false,
      "documentHandling": {
        "sendLabel": {
          "enabled": false
        }
      },
      "documentsRef": "text",
      "editor": {
        "userId": "text",
        "username": "text"
      },
      "id": "Esb20gpHBL94X5NdMp3C",
      "pickingZones": [],
      "pickRunRef": "text",
      "resetBlocked": false,
      "subStatus": "SHORT_PICKED",
      "usersModificationHistory": [
        {
          "modificationDate": "2026-03-13T13:47:33.519Z",
          "userId": "text",
          "username": "text"
        }
      ]
    }
  ],
  "total": 1
}

Create pick run

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

PickRunForCreation

facilityRefstringRequired

pickJobRefsstring[] · min: 1Required

pickRunTypestring · enumOptional

Deprecated: batchPick, use batch instead Deprecated: multiOrderPick, use multiOrder instead

Default: batchPickPossible values:

statusstring · enumOptional

The state of the PickRun

Possible values:

Responses

201

The PickRun was successfully created. The Location header contains the URL of it.

application/json

PickRun

and

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

post

/api/pickruns

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

{
  "facilityRef": "text",
  "pickJobRefs": [
    "text"
  ],
  "pickRunType": "batchPick",
  "status": "OPEN"
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "editor": {
    "userId": "text",
    "username": "text"
  },
  "facilityRef": "text",
  "id": "text",
  "pickJobRefs": [
    "text"
  ],
  "pickLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "climk4dcQFiPdA5ULuhS",
      "quantity": 21,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold"
            }
          ],
          "imageUrl": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "tenantArticleId": "text",
          "title": "text"
        }
      ],
      "globalLineItemIds": [
        "text"
      ],
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
      "partialStockLocations": [
        {
          "available": 21,
          "location": {
            "locationRef": "text",
            "scannableCodes": [
              "text"
            ]
          },
          "quantity": 21,
          "ratingScore": 1,
          "sequenceScore": 1,
          "stockProperties": {
            "expiry": "text"
          },
          "stockRef": "text",
          "tenantPartialStockId": "text"
        }
      ],
      "picked": 20,
      "pickedAt": "2024-02-03T08:45:51.525Z",
      "pickJobLineItemRef": "12345",
      "pickJobRef": "text",
      "scannedCodes": [
        {
          "code": 1245678,
          "quantity": 7
        }
      ],
      "scanningRules": {
        "scanningMode": "MUST_SCAN_FIRST",
        "scanningType": []
      },
      "secondaryMeasurementUnitKey": "liter",
      "secondaryPicked": 20,
      "secondaryQuantity": 21,
      "shortPickReason": {
        "reasonLocalized": "{ en_US: 'SomeName' }",
        "reason": "text"
      },
      "status": "OPEN",
      "stickers": [],
      "stockEmptied": true,
      "substituteLineItems": [
        {
          "article": {
            "titleLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "customAttributes": {},
            "imageUrl": "text",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "weight": 1,
            "attributes": [
              {
                "valueLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "keyLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "category": "descriptive",
                "context": {
                  "type": "FACILITY_GROUP",
                  "value": "text"
                },
                "key": "%%subtitle%%",
                "priority": 100,
                "type": "STRING",
                "value": "585er Gold"
              }
            ]
          },
          "globalLineItemId": "text",
          "id": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "partialStockLocations": [
            {
              "location": {
                "locationRef": "text",
                "scannableCodes": [
                  "text"
                ]
              },
              "picked": 21,
              "quantity": 21,
              "ratingScore": 1,
              "sequenceScore": 1,
              "stockProperties": {
                "expiry": "text"
              },
              "stockRef": "text",
              "tenantPartialStockId": "text",
              "zoneName": "text"
            }
          ],
          "picked": 20,
          "pickedAt": "2024-02-03T08:45:51.525Z",
          "priority": 1,
          "quantity": 21,
          "refused": [],
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "secondaryPicked": 20,
          "secondaryQuantity": 200
        }
      ],
      "tags": []
    }
  ],
  "pickRunType": "batchPick",
  "status": "OPEN"
}

Get pick run

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pickRunIdstringRequired

id of pickRun

Responses

200

PickRun is found.

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

get

/api/pickruns/{pickRunId}

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

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "editor": {
    "userId": "text",
    "username": "text"
  },
  "facilityRef": "text",
  "id": "text",
  "pickJobRefs": [
    "text"
  ],
  "pickLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "climk4dcQFiPdA5ULuhS",
      "quantity": 21,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold"
            }
          ],
          "imageUrl": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "tenantArticleId": "text",
          "title": "text"
        }
      ],
      "globalLineItemIds": [
        "text"
      ],
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
      "partialStockLocations": [
        {
          "available": 21,
          "location": {
            "locationRef": "text",
            "scannableCodes": [
              "text"
            ]
          },
          "quantity": 21,
          "ratingScore": 1,
          "sequenceScore": 1,
          "stockProperties": {
            "expiry": "text"
          },
          "stockRef": "text",
          "tenantPartialStockId": "text"
        }
      ],
      "picked": 20,
      "pickedAt": "2024-02-03T08:45:51.525Z",
      "pickJobLineItemRef": "12345",
      "pickJobRef": "text",
      "scannedCodes": [
        {
          "code": 1245678,
          "quantity": 7
        }
      ],
      "scanningRules": {
        "scanningMode": "MUST_SCAN_FIRST",
        "scanningType": []
      },
      "secondaryMeasurementUnitKey": "liter",
      "secondaryPicked": 20,
      "secondaryQuantity": 21,
      "shortPickReason": {
        "reasonLocalized": "{ en_US: 'SomeName' }",
        "reason": "text"
      },
      "status": "OPEN",
      "stickers": [],
      "stockEmptied": true,
      "substituteLineItems": [
        {
          "article": {
            "titleLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "customAttributes": {},
            "imageUrl": "text",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "weight": 1,
            "attributes": [
              {
                "valueLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "keyLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "category": "descriptive",
                "context": {
                  "type": "FACILITY_GROUP",
                  "value": "text"
                },
                "key": "%%subtitle%%",
                "priority": 100,
                "type": "STRING",
                "value": "585er Gold"
              }
            ]
          },
          "globalLineItemId": "text",
          "id": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "partialStockLocations": [
            {
              "location": {
                "locationRef": "text",
                "scannableCodes": [
                  "text"
                ]
              },
              "picked": 21,
              "quantity": 21,
              "ratingScore": 1,
              "sequenceScore": 1,
              "stockProperties": {
                "expiry": "text"
              },
              "stockRef": "text",
              "tenantPartialStockId": "text",
              "zoneName": "text"
            }
          ],
          "picked": 20,
          "pickedAt": "2024-02-03T08:45:51.525Z",
          "priority": 1,
          "quantity": 21,
          "refused": [],
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "secondaryPicked": 20,
          "secondaryQuantity": 200
        }
      ],
      "tags": []
    }
  ],
  "pickRunType": "batchPick",
  "status": "OPEN"
}

Update pick run

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pickRunIdstringRequired

id of pickRun

Body

PickRunPatchAction

versioninteger · int64Required

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

Example: 42

Responses

200

The updated PickRun.

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

409

Version conflict

application/json

patch

/api/pickruns/{pickRunId}

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

{
  "actions": [
    {
      "action": "ModifyPickRunLineItem",
      "id": "climk4dcQFiPdA5ULuhS",
      "partialStockLocations": [
        {
          "picked": 21,
          "stockEmptied": true,
          "stockRef": "text",
          "tenantPartialStockId": "text"
        }
      ],
      "picked": 20,
      "secondaryPicked": 20,
      "shortPickReason": {
        "reasonLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        }
      },
      "status": "OPEN"
    }
  ],
  "version": 42
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "editor": {
    "userId": "text",
    "username": "text"
  },
  "facilityRef": "text",
  "id": "text",
  "pickJobRefs": [
    "text"
  ],
  "pickLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "climk4dcQFiPdA5ULuhS",
      "quantity": 21,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold"
            }
          ],
          "imageUrl": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "tenantArticleId": "text",
          "title": "text"
        }
      ],
      "globalLineItemIds": [
        "text"
      ],
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
      "partialStockLocations": [
        {
          "available": 21,
          "location": {
            "locationRef": "text",
            "scannableCodes": [
              "text"
            ]
          },
          "quantity": 21,
          "ratingScore": 1,
          "sequenceScore": 1,
          "stockProperties": {
            "expiry": "text"
          },
          "stockRef": "text",
          "tenantPartialStockId": "text"
        }
      ],
      "picked": 20,
      "pickedAt": "2024-02-03T08:45:51.525Z",
      "pickJobLineItemRef": "12345",
      "pickJobRef": "text",
      "scannedCodes": [
        {
          "code": 1245678,
          "quantity": 7
        }
      ],
      "scanningRules": {
        "scanningMode": "MUST_SCAN_FIRST",
        "scanningType": []
      },
      "secondaryMeasurementUnitKey": "liter",
      "secondaryPicked": 20,
      "secondaryQuantity": 21,
      "shortPickReason": {
        "reasonLocalized": "{ en_US: 'SomeName' }",
        "reason": "text"
      },
      "status": "OPEN",
      "stickers": [],
      "stockEmptied": true,
      "substituteLineItems": [
        {
          "article": {
            "titleLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "customAttributes": {},
            "imageUrl": "text",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "weight": 1,
            "attributes": [
              {
                "valueLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "keyLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "category": "descriptive",
                "context": {
                  "type": "FACILITY_GROUP",
                  "value": "text"
                },
                "key": "%%subtitle%%",
                "priority": 100,
                "type": "STRING",
                "value": "585er Gold"
              }
            ]
          },
          "globalLineItemId": "text",
          "id": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "partialStockLocations": [
            {
              "location": {
                "locationRef": "text",
                "scannableCodes": [
                  "text"
                ]
              },
              "picked": 21,
              "quantity": 21,
              "ratingScore": 1,
              "sequenceScore": 1,
              "stockProperties": {
                "expiry": "text"
              },
              "stockRef": "text",
              "tenantPartialStockId": "text",
              "zoneName": "text"
            }
          ],
          "picked": 20,
          "pickedAt": "2024-02-03T08:45:51.525Z",
          "priority": 1,
          "quantity": 21,
          "refused": [],
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "secondaryPicked": 20,
          "secondaryQuantity": 200
        }
      ],
      "tags": []
    }
  ],
  "pickRunType": "batchPick",
  "status": "OPEN"
}

Call pick run action

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pickRunIdstringRequired

Reference to the pick run you want to call the action for

Body

PickRunActionsParameter

Responses

200

Updated Pick Run in the body.

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

/api/pickruns/{pickRunId}/actions

POST /api/pickruns/{pickRunId}/actions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "name": "START",
  "version": 1
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "editor": {
    "userId": "text",
    "username": "text"
  },
  "facilityRef": "text",
  "id": "text",
  "pickJobRefs": [
    "text"
  ],
  "pickLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ],
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "climk4dcQFiPdA5ULuhS",
      "quantity": 21,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold"
            }
          ],
          "imageUrl": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "tenantArticleId": "text",
          "title": "text"
        }
      ],
      "globalLineItemIds": [
        "text"
      ],
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
      "partialStockLocations": [
        {
          "available": 21,
          "location": {
            "locationRef": "text",
            "scannableCodes": [
              "text"
            ]
          },
          "quantity": 21,
          "ratingScore": 1,
          "sequenceScore": 1,
          "stockProperties": {
            "expiry": "text"
          },
          "stockRef": "text",
          "tenantPartialStockId": "text"
        }
      ],
      "picked": 20,
      "pickedAt": "2024-02-03T08:45:51.525Z",
      "pickJobLineItemRef": "12345",
      "pickJobRef": "text",
      "scannedCodes": [
        {
          "code": 1245678,
          "quantity": 7
        }
      ],
      "scanningRules": {
        "scanningMode": "MUST_SCAN_FIRST",
        "scanningType": []
      },
      "secondaryMeasurementUnitKey": "liter",
      "secondaryPicked": 20,
      "secondaryQuantity": 21,
      "shortPickReason": {
        "reasonLocalized": "{ en_US: 'SomeName' }",
        "reason": "text"
      },
      "status": "OPEN",
      "stickers": [],
      "stockEmptied": true,
      "substituteLineItems": [
        {
          "article": {
            "titleLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "customAttributes": {},
            "imageUrl": "text",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "weight": 1,
            "attributes": [
              {
                "valueLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "keyLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "category": "descriptive",
                "context": {
                  "type": "FACILITY_GROUP",
                  "value": "text"
                },
                "key": "%%subtitle%%",
                "priority": 100,
                "type": "STRING",
                "value": "585er Gold"
              }
            ]
          },
          "globalLineItemId": "text",
          "id": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "partialStockLocations": [
            {
              "location": {
                "locationRef": "text",
                "scannableCodes": [
                  "text"
                ]
              },
              "picked": 21,
              "quantity": 21,
              "ratingScore": 1,
              "sequenceScore": 1,
              "stockProperties": {
                "expiry": "text"
              },
              "stockRef": "text",
              "tenantPartialStockId": "text",
              "zoneName": "text"
            }
          ],
          "picked": 20,
          "pickedAt": "2024-02-03T08:45:51.525Z",
          "priority": 1,
          "quantity": 21,
          "refused": [],
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "secondaryPicked": 20,
          "secondaryQuantity": 200
        }
      ],
      "tags": []
    }
  ],
  "pickRunType": "batchPick",
  "status": "OPEN"
}

Update pick run pick jobs

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pickRunIdstringRequired

id of pickRun

Body

PickRunPickJobsPatchAction

versioninteger · int64Required

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

Example: 42

Responses

200

Pick job was successfully from pick run removed.

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

patch

/api/pickruns/{pickRunId}/pickjobs

PATCH /api/pickruns/{pickRunId}/pickjobs HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "actions": [],
  "version": 42
}

No content

List substitutes

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

tenantArticleIdstringRequired

the tenantArticleId substitutes are requested for

Responses

200

There are substitutes for the given tenantArticleId. The result can be found in the body.

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

Facility not found

application/json

get

/api/substitutes

GET /api/substitutes?tenantArticleId=text HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 1,
  "substitutes": [
    {
      "attributes": [
        {
          "valueLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "category": "descriptive",
          "context": {
            "type": "FACILITY_GROUP",
            "value": "text"
          },
          "key": "%%subtitle%%",
          "priority": 100,
          "type": "STRING",
          "value": "585er Gold"
        }
      ],
      "imageUrl": "text",
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "priority": 1,
      "scannableCodes": [
        "text"
      ],
      "secondaryMeasurementUnitKey": "gram",
      "tenantArticleId": "text",
      "title": "text"
    }
  ],
  "tenantArticleId": "text"
}

Get substitutes

get

Get the substitutes for a given tenant article id

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tenantArticleIdstringRequired

Responses

200

The substitutes for the given tenantArticleId can be found in the body.

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

Facility not found

application/json

get

/api/substitutes/{tenantArticleId}

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

{
  "id": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 1,
  "substitutes": [
    {
      "attributes": [
        {
          "valueLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "category": "descriptive",
          "context": {
            "type": "FACILITY_GROUP",
            "value": "text"
          },
          "key": "%%subtitle%%",
          "priority": 100,
          "type": "STRING",
          "value": "585er Gold"
        }
      ],
      "imageUrl": "text",
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "priority": 1,
      "scannableCodes": [
        "text"
      ],
      "secondaryMeasurementUnitKey": "gram",
      "tenantArticleId": "text",
      "title": "text"
    }
  ],
  "tenantArticleId": "text"
}

Set substitutes

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tenantArticleIdstringRequired

Tenant article ID of the article the substitutes should be set for

Body

SubstitutesForUpsert

tenantArticleIdstringRequired

versionnumberRequired

Version field is used in the optimistic locking process. If the Substitute is for the tenantArticleId is not set yet, this field is ignored.

Example: 1

Responses

200

The substitutes for tenantArticleId were successfully updated

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

Facility listing not found

application/json

put

/api/substitutes/{tenantArticleId}

PUT /api/substitutes/{tenantArticleId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 713

{
  "substitutes": [
    {
      "attributes": [
        {
          "valueLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "category": "descriptive",
          "context": {
            "type": "FACILITY_GROUP",
            "value": "text"
          },
          "key": "%%subtitle%%",
          "priority": 100,
          "type": "STRING",
          "value": "585er Gold"
        }
      ],
      "imageUrl": "text",
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "priority": 1,
      "scannableCodes": [
        "text"
      ],
      "secondaryMeasurementUnitKey": "gram",
      "tenantArticleId": "text",
      "title": "text"
    }
  ],
  "tenantArticleId": "text",
  "version": 1
}

{
  "id": "text",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 1,
  "substitutes": [
    {
      "attributes": [
        {
          "valueLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "category": "descriptive",
          "context": {
            "type": "FACILITY_GROUP",
            "value": "text"
          },
          "key": "%%subtitle%%",
          "priority": 100,
          "type": "STRING",
          "value": "585er Gold"
        }
      ],
      "imageUrl": "text",
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "priority": 1,
      "scannableCodes": [
        "text"
      ],
      "secondaryMeasurementUnitKey": "gram",
      "tenantArticleId": "text",
      "title": "text"
    }
  ],
  "tenantArticleId": "text"
}

Delete substitutes

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tenantArticleIdstringRequired

the tenant article ID the subsitutes should be deleted for

Responses

200

The substitutes for the given tenantArticleId were successfully deleted

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

Facility listing not found

application/json

delete

/api/substitutes/{tenantArticleId}

DELETE /api/substitutes/{tenantArticleId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Last updated 26 minutes ago

hashtagList load units

hashtagCreate load units

hashtagDelete load units

hashtagGet load unit

hashtagDelete load unit

hashtagUpdate load unit

hashtagCall load unit action

hashtagGet load unit stack

hashtagList load unit types

hashtagCreate load unit type

hashtagGet load unit type

hashtagUpdate load unit type

hashtagUpdate load unit type icon

hashtagList pick jobs

hashtagCreate pick job

hashtagGet pick job

hashtagUpdate pick job

hashtagCall pick job action

hashtagGet pick job delivery note

hashtagList pick job load units

hashtagCreate pick job load unit

hashtagList available line item substitutes

hashtagGet pick job return note

hashtagGet pick job transfer label

hashtagList pick jobs (search)

hashtagCreate pick run

hashtagGet pick run

hashtagUpdate pick run

hashtagCall pick run action

hashtagUpdate pick run pick jobs

hashtagList substitutes

hashtagGet substitutes

hashtagSet substitutes

hashtagDelete substitutes

List load units

Create load units

Delete load units

Get load unit

Delete load unit

Update load unit

Call load unit action

Get load unit stack

List load unit types

Create load unit type

Get load unit type

Update load unit type

Update load unit type icon

List pick jobs

Create pick job

Get pick job

Update pick job

Call pick job action

Get pick job delivery note

List pick job load units

Create pick job load unit

List available line item substitutes

Get pick job return note

Get pick job transfer label

List pick jobs (search)

Create pick run

Get pick run

Update pick run

Call pick run action

Update pick run pick jobs

List substitutes

Get substitutes

Set substitutes

Delete substitutes