Handovers (Operations)

These endpoints manage the handover process.

List handover container

get

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Get all Handover Container respecting the given filter

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startAfterstringOptional

entity to start after

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

sizeintegerOptional

number of entities to show

Default: 25Example: 25

facilityRefsstring[] · max: 50Optional

facilities to filter the results

Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]

handoverJobRefstringOptional

handover job to filter the containers for by reference

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

Responses

200

All HandoverContainer matching the given parameters.

application/json

StrippedHandoverContainer

totalintegerRequired

total number for the given filter

Example: 42

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/handovercontainers

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

{
  "handoverContainer": [
    {
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "codes": [
        "text"
      ],
      "created": "2020-02-03T08:45:51.525Z",
      "customAttributes": {},
      "description": "text",
      "dimensions": {
        "heightInCm": 50,
        "lengthInCm": 100,
        "weightInG": 1700,
        "widthInCm": 25.5
      },
      "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "handoverJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "iconUrl": "https://example.com/resource",
      "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "lineItems": [
        {
          "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"
              }
            ],
            "customAttributes": {},
            "imageUrl": "https://example.com/resource",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "weight": 1
          },
          "customAttributes": {},
          "globalLineItemId": "text",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "measurementUnitKey": "pcs",
          "quantity": 42,
          "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"
          ],
          "secondaryMeasurementUnitKey": "g",
          "secondaryQuantity": 42
        }
      ],
      "name": "text",
      "operativeContainerTypeRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "previousModuleContainerInfo": {
        "containerRef": "019df7f0-0507-7002-a9ef-6285caa2e785",
        "type": "LOAD_UNIT"
      },
      "processRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "sequenceNumber": 42,
      "stackRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "type": "PHYSICAL",
      "version": 42,
      "weightLimitInG": 42
    }
  ],
  "total": 42
}

Create handover container

post

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Create new Handover Container

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

HandoverContainerForCreation

codesstring[] · max: 50Optional

customAttributesobjectOptional

handoverJobRefstringRequired

Linked HandoverJob through reference

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

iconUrlstringOptional

URL to icon

Example: https://example.com/resource

operativeContainerTypeRefstringOptional

Linked Operative Container Type through reference

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

sequenceNumberinteger · int32 · max: 10000OptionalExample: 42

stackRefstringOptional

Linked Stack through reference

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

storageLocationRefstringOptional

Linked StorageLocation through reference

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

weightLimitInGintegerOptional

Weight limit in gram for this Container

Example: 42

Responses

201

Created Handover Container.

application/json

HandoverContainer

codesstring[]Optional

createdstring · date-timeRequired

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

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

customAttributesobjectOptional

descriptionstringOptional

Translated Description from descriptionLocalized

facilityRefstringRequired

Linked Facility through reference

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

handoverJobRefstringRequired

Linked HandoverJob through reference

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

iconUrlstringOptional

URL to icon

Example: https://example.com/resource

idstringRequired

Unique identifier of the handover container

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

lastModifiedstring · date-timeRequired

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

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

namestringOptional

Translated name from nameLocalized

operativeContainerTypeRefstringOptional

Linked Operative Container Type through reference

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

processRefstringRequired

Linked Process through reference

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

sequenceNumberinteger · int32 · max: 10000OptionalExample: 42

stackRefstringRequired

Linked stack through reference

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

storageLocationRefstringOptional

Linked StorageLocation through reference

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

typestring · enumRequired

Type of the container. Can either be PHYSICAL or VIRTUAL.

Possible values:

versioninteger · int64Required

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

Example: 42

weightLimitInGintegerOptional

Weight limit in gram for this Container

Example: 42

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

The requested entity was not found

application/json

post/api/handovercontainers

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

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "codes": [
    "text"
  ],
  "customAttributes": {},
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25.5
  },
  "handoverJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "iconUrl": "https://example.com/resource",
  "lineItems": [
    {
      "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"
          }
        ],
        "customAttributes": {},
        "imageUrl": "https://example.com/resource",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "globalLineItemId": "text",
      "measurementUnitKey": "pcs",
      "quantity": 42,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "secondaryMeasurementUnitKey": "g",
      "secondaryQuantity": 42
    }
  ],
  "operativeContainerTypeRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "previousModuleContainerInfo": {
    "containerRef": "019df7f0-0507-7002-a9ef-6285caa2e785",
    "type": "LOAD_UNIT"
  },
  "sequenceNumber": 42,
  "stackRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "weightLimitInG": 42
}

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "codes": [
    "text"
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "customAttributes": {},
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25.5
  },
  "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "handoverJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "iconUrl": "https://example.com/resource",
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "lineItems": [
    {
      "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"
          }
        ],
        "customAttributes": {},
        "imageUrl": "https://example.com/resource",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "measurementUnitKey": "pcs",
      "quantity": 42,
      "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"
      ],
      "secondaryMeasurementUnitKey": "g",
      "secondaryQuantity": 42
    }
  ],
  "name": "text",
  "operativeContainerTypeRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "previousModuleContainerInfo": {
    "containerRef": "019df7f0-0507-7002-a9ef-6285caa2e785",
    "type": "LOAD_UNIT"
  },
  "processRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "sequenceNumber": 42,
  "stackRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "type": "PHYSICAL",
  "version": 42,
  "weightLimitInG": 42
}

Get handover container

get

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Get handover container

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

handoverContainerIdstringRequired

id of the handover container

Responses

200

HandoverContainer matching the given id.

application/json

HandoverContainer

codesstring[]Optional

createdstring · date-timeRequired

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

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

customAttributesobjectOptional

descriptionstringOptional

Translated Description from descriptionLocalized

facilityRefstringRequired

Linked Facility through reference

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

handoverJobRefstringRequired

Linked HandoverJob through reference

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

iconUrlstringOptional

URL to icon

Example: https://example.com/resource

idstringRequired

Unique identifier of the handover container

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

lastModifiedstring · date-timeRequired

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

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

namestringOptional

Translated name from nameLocalized

operativeContainerTypeRefstringOptional

Linked Operative Container Type through reference

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

processRefstringRequired

Linked Process through reference

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

sequenceNumberinteger · int32 · max: 10000OptionalExample: 42

stackRefstringRequired

Linked stack through reference

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

storageLocationRefstringOptional

Linked StorageLocation through reference

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

typestring · enumRequired

Type of the container. Can either be PHYSICAL or VIRTUAL.

Possible values:

versioninteger · int64Required

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

Example: 42

weightLimitInGintegerOptional

Weight limit in gram for this Container

Example: 42

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

The requested entity was not found

application/json

get/api/handovercontainers/{handoverContainerId}

GET /api/handovercontainers/{handoverContainerId} 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"
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "customAttributes": {},
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25.5
  },
  "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "handoverJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "iconUrl": "https://example.com/resource",
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "lineItems": [
    {
      "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"
          }
        ],
        "customAttributes": {},
        "imageUrl": "https://example.com/resource",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "measurementUnitKey": "pcs",
      "quantity": 42,
      "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"
      ],
      "secondaryMeasurementUnitKey": "g",
      "secondaryQuantity": 42
    }
  ],
  "name": "text",
  "operativeContainerTypeRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "previousModuleContainerInfo": {
    "containerRef": "019df7f0-0507-7002-a9ef-6285caa2e785",
    "type": "LOAD_UNIT"
  },
  "processRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "sequenceNumber": 42,
  "stackRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "type": "PHYSICAL",
  "version": 42,
  "weightLimitInG": 42
}

Delete handover container

delete

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Delete handover container

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

handoverContainerIdstringRequired

id of the handover container

Responses

200

HandoverContainer successfully deleted.

No content

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

The requested entity was not found

application/json

delete/api/handovercontainers/{handoverContainerId}

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

No content

Get handover container stack

get

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Return the stack of a given handover container if found

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

handoverContainerIdstringRequired

id of the handover container

Responses

200

Stack for the given handoverContainer matching the given id.

application/json

Stack

createdstring · date-timeRequired

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

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

facilityRefsstring[] · max: 50Required

Linked Facilities through reference

Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]

idstringRequired

Unique identifier of the Stack

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

lastModifiedstring · date-timeRequired

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

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

processRefsstring[] · max: 50Required

Linked Processes through reference

Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]

versioninteger · int64Required

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

Example: 42

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

The requested entity was not found

application/json

get/api/handovercontainers/{handoverContainerId}/stack

GET /api/handovercontainers/{handoverContainerId}/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": [
    "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
  ],
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "processRefs": [
    "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
  ],
  "version": 42
}

List handover jobs

get

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

pickJobRefstringOptional

This query can be used to find handoverjobs for a referenced pickjob

shipmentRefstringOptional

This query can be used to find handoverjobs for a referenced shipment

assignedUserstringOptional

Reference the assigned user on this entity - id or username

facilityRefstringOptional

Reference to the facility you want to get the corresponding handoverJobs

statusstring[]Optional

Reference to the status you want to get the corresponding handoverJobs

carrierRefsstring[]Optional

Reference to the carriers you want to get the corresponding handoverJobs

channelstringOptional

Reference to the channel you want to get the corresponding handoverJobs

anonymizedbooleanOptional

Parameter to filter anonymized handover jobs

tenantOrderIdstringOptional

This query can be used to find handoverjobs with the given tenantOrderId

searchTermstringOptional

Perform full text search over all searchable attributes

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

Responses

200

Handoverjobs are found.

application/json

StrippedHandoverjobs

totalintegerOptional

Total number of found entities for this query

Example: 42

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/handoverjobs

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

{
  "handoverjobs": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42,
      "channel": "DELIVERY",
      "facilityRef": "Esb20gpHBL94X5NdMp3C",
      "fullIdentifier": "text",
      "handoverJobParcelInfo": {
        "carrierLogoUrl": "https://www.example.com/carrierlogo.png",
        "carrierParcelRef": "84168117830018",
        "carrierRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
        "carrierTrackingNumber": "84168117830018",
        "parcelRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
        "shipmentRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
        "carrierKey": "DHL"
      },
      "id": "95EWrieX09OmeriXIUbb",
      "invoiceAddress": {
        "addressType": "POSTAL_ADDRESS",
        "companyName": "Speedy Boxales Ltd.",
        "coordinates": {
          "lat": 50.937531,
          "lon": 6.960279
        },
        "email": "test@try.de",
        "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."
      },
      "loadUnitRefs": [
        "text"
      ],
      "orderDate": "2020-02-03T08:45:50.525Z",
      "pickJobRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
      "recipientAddress": {
        "addressType": "POSTAL_ADDRESS",
        "companyName": "Speedy Boxales Ltd.",
        "coordinates": {
          "lat": 50.937531,
          "lon": 6.960279
        },
        "email": "test@try.de",
        "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."
      },
      "searchPaths": "R456728546",
      "status": "OPEN",
      "tenantOrderId": "R456728546"
    }
  ],
  "total": 42
}

Create handover job

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

HandoverjobForCreation

cancelReasonstring · enumOptional

HandoverJobCancelReason

Possible values:

carrierLogoUrlstringOptionalDeprecated

This part of the API is deprecated. For details, see the API release lifecycle documentation.

@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.

carrierRefstringOptionalDeprecated

carrierTrackingNumberstringOptionalDeprecated

channelstring · enumRequired

HandoverjobChannel

Possible values:

customAttributesobjectOptional

Attributes that can be added to the handover job. 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.

Example: Esb20gpHBL94X5NdMp3C

fullIdentifierstringOptional

An information to identify the recipient

loadUnitRefsstring[]OptionalDeprecated

This part of the API is deprecated. For details, see the API release lifecycle documentation.

This field is deprecated since 30 April 2026. HandoverJobs should not be aware of load units. The relation to load units are via handover container, if there ist a relation.

operativeProcessRefstringOptional

orderDatestring · date-timeRequired

The date this order was created at the supplying system.

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

paidbooleanOptional

Indicates if the order is already paid

Example: false

parcelRefstringOptionalDeprecated

Example: 2fOge2ZGW54K4TgvDTQw

pickJobRefstringOptional

The reference to the pickjob for which the handoverjob is assigned to

Example: ca525716-7208-4a63-a2a6-11274eb37f67-0

processIdstringOptional

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

routingPlanRefstringOptional

The reference to the routing plan for which the handoverjob is assigned to

Example: ca525716-7208-4a63-a2a6-11274eb37f67-0

shipmentRefstringOptionalDeprecated

Example: Esb20gpHBL94X5NdMp3C

shortIdentifierstringOptional

The short identifier of the shipment.

statusstring · enumOptional

Status of a Handover Job.

OPEN: Active and ready for processing (default initial state)
WAITING_FOR_INPUT: Waiting for line items to be populated
HANDED_OVER: Items have been handed over (completion state)
CANCELED: Handover job was canceled
OBSOLETE: No longer relevant (terminal state, cannot transition out)

Possible values:

targetTimestring · date-timeRequired

The time the handoverjob is expected to be picked up at the facility.

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 handoverjob was successfully created. The Location header contains the URL of it.

application/json

Handoverjob

createdstring · date-timeOptional

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

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

lastModifiedstring · date-timeOptional

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

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

versioninteger · int64Required

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

Example: 42

anonymizedbooleanOptional

Indicates if gdpr related data was anonymized

Example: false

cancelReasonstring · enumOptional

HandoverJobCancelReason

Possible values:

carrierKeystringOptionalDeprecated

carrierLogoUrlstringOptionalDeprecated

carrierRefstringOptionalDeprecated

carrierTrackingNumberstringOptionalDeprecated

channelstring · enumRequired

HandoverjobChannel

Possible values:

customAttributesobjectOptional

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

documentsRefstringOptional

Reference to the documents collection from this entity

facilityRefstringRequired

The id of the facility reference.

Example: Esb20gpHBL94X5NdMp3C

fullIdentifierstringOptional

An information to identify the recipient

idstringRequired

The id of this handoverjob. It is generated during creation automatically and suits as the primary identifier of the described entity.

Example: 95EWrieX09OmeriXIUbb

loadUnitRefsstring[]OptionalDeprecated

operativeProcessRefstringOptional

orderDatestring · date-timeRequired

The date this order was created at the supplying system.

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

paidbooleanOptional

Indicates if the order is already paid

Example: false

parcelRefstringOptionalDeprecated

Example: 2fOge2ZGW54K4TgvDTQw

pickJobRefstringOptional

The reference to the pickjob for which the handoverjob is assigned to

Example: ca525716-7208-4a63-a2a6-11274eb37f67-0

processIdstringOptional

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

shipmentRefstringOptionalDeprecated

Example: Esb20gpHBL94X5NdMp3C

shortIdentifierstringOptional

The short identifier of the shipment.

statusstring · enumRequired

Status of a Handover Job.

OPEN: Active and ready for processing (default initial state)
WAITING_FOR_INPUT: Waiting for line items to be populated
HANDED_OVER: Items have been handed over (completion state)
CANCELED: Handover job was canceled
OBSOLETE: No longer relevant (terminal state, cannot transition out)

Possible values:

targetTimestring · date-timeRequired

The time the handoverjob is expected to be picked up at the facility.

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 ofRequired

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/handoverjobs

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

{
  "assignedUsers": [
    {
      "username": "text"
    }
  ],
  "cancelReason": "CONSUMER_NO_SHOW",
  "channel": "DELIVERY",
  "customAttributes": {},
  "expectedHandoverJobLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "https://example.com/resource",
        "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"
          }
        ]
      },
      "customAttributes": {},
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "stickers": [],
      "transferId": "text",
      "tags": []
    }
  ],
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "fullIdentifier": "text",
  "handoverJobLineItems": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "measurementUnitKey": "pcs",
      "quantity": 1,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "secondaryMeasurementUnitKey": "g",
      "secondaryQuantity": 42
    }
  ],
  "handoverJobParcelInfo": {
    "carrierLogoUrl": "https://www.example.com/carrierlogo.png",
    "carrierParcelRef": "84168117830018",
    "carrierRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
    "carrierTrackingNumber": "84168117830018",
    "parcelRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
    "shipmentRef": "9ddb3c80-30ec-42c3-a750-9612296402ca"
  },
  "invoiceAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "test@try.de",
    "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."
  },
  "missingHandoverJobLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "https://example.com/resource",
        "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"
          }
        ]
      },
      "customAttributes": {},
      "quantity": 1,
      "scannableCodes": [
        "text"
      ],
      "stickers": [],
      "tags": []
    }
  ],
  "operativeProcessRef": "text",
  "orderDate": "2020-02-03T08:45:50.525Z",
  "paid": false,
  "pickJobRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
  "processId": "text",
  "recipientAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "test@try.de",
    "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."
  },
  "routingPlanRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
  "shortIdentifier": "text",
  "status": "OPEN",
  "stickers": [],
  "targetTime": "2026-07-22T15:57:50.059Z",
  "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,
  "assignedUsers": [
    {
      "userId": "text",
      "username": "text"
    }
  ],
  "cancelReason": "CONSUMER_NO_SHOW",
  "channel": "DELIVERY",
  "customAttributes": {},
  "documents": [
    {
      "customAttributes": {},
      "documentCategory": "EXTERNAL",
      "documentType": "PDF",
      "id": "text",
      "name": "text",
      "operations": [
        "PRINT"
      ],
      "path": "text",
      "priority": 1,
      "status": "AVAILABLE"
    }
  ],
  "documentsRef": "text",
  "expectedHandoverJobLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "https://example.com/resource",
        "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"
          }
        ]
      },
      "customAttributes": {},
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "stickers": [],
      "transferId": "text",
      "tags": []
    }
  ],
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "fullIdentifier": "text",
  "handoverJobLineItems": [
    {
      "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": "https://example.com/resource",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "measurementUnitKey": "pcs",
      "quantity": 1,
      "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"
      ],
      "secondaryMeasurementUnitKey": "g",
      "secondaryQuantity": 42
    }
  ],
  "handoverJobParcelInfo": {
    "carrierLogoUrl": "https://www.example.com/carrierlogo.png",
    "carrierParcelRef": "84168117830018",
    "carrierRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
    "carrierTrackingNumber": "84168117830018",
    "parcelRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
    "shipmentRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
    "carrierKey": "DHL"
  },
  "id": "95EWrieX09OmeriXIUbb",
  "invoiceAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "test@try.de",
    "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."
  },
  "missingHandoverJobLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "https://example.com/resource",
        "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"
          }
        ]
      },
      "customAttributes": {},
      "quantity": 1,
      "scannableCodes": [
        "text"
      ],
      "stickers": [],
      "tags": []
    }
  ],
  "operativeProcessRef": "text",
  "orderDate": "2020-02-03T08:45:50.525Z",
  "paid": false,
  "pickJobRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
  "processId": "text",
  "recipientAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "test@try.de",
    "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."
  },
  "shortIdentifier": "text",
  "status": "OPEN",
  "stickers": [],
  "targetTime": "2026-07-22T15:57:50.059Z",
  "tenantOrderId": "R456728546",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ],
  "workflowInformation": {
    "instanceRef": "64c13ab08edf48a008793cac",
    "isAvailable": true,
    "nodeRef": "text"
  },
  "tags": []
}

Get handover job

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

handoverjobIdstringRequired

ID of the handoverjob you want to get

Responses

200

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

application/json

Handoverjob

createdstring · date-timeOptional

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

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

lastModifiedstring · date-timeOptional

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

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

versioninteger · int64Required

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

Example: 42

anonymizedbooleanOptional

Indicates if gdpr related data was anonymized

Example: false

cancelReasonstring · enumOptional

HandoverJobCancelReason

Possible values:

carrierKeystringOptionalDeprecated

carrierLogoUrlstringOptionalDeprecated

carrierRefstringOptionalDeprecated

carrierTrackingNumberstringOptionalDeprecated

channelstring · enumRequired

HandoverjobChannel

Possible values:

customAttributesobjectOptional

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

documentsRefstringOptional

Reference to the documents collection from this entity

facilityRefstringRequired

The id of the facility reference.

Example: Esb20gpHBL94X5NdMp3C

fullIdentifierstringOptional

An information to identify the recipient

idstringRequired

The id of this handoverjob. It is generated during creation automatically and suits as the primary identifier of the described entity.

Example: 95EWrieX09OmeriXIUbb

loadUnitRefsstring[]OptionalDeprecated

operativeProcessRefstringOptional

orderDatestring · date-timeRequired

The date this order was created at the supplying system.

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

paidbooleanOptional

Indicates if the order is already paid

Example: false

parcelRefstringOptionalDeprecated

Example: 2fOge2ZGW54K4TgvDTQw

pickJobRefstringOptional

The reference to the pickjob for which the handoverjob is assigned to

Example: ca525716-7208-4a63-a2a6-11274eb37f67-0

processIdstringOptional

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

shipmentRefstringOptionalDeprecated

Example: Esb20gpHBL94X5NdMp3C

shortIdentifierstringOptional

The short identifier of the shipment.

statusstring · enumRequired

Status of a Handover Job.

OPEN: Active and ready for processing (default initial state)
WAITING_FOR_INPUT: Waiting for line items to be populated
HANDED_OVER: Items have been handed over (completion state)
CANCELED: Handover job was canceled
OBSOLETE: No longer relevant (terminal state, cannot transition out)

Possible values:

targetTimestring · date-timeRequired

The time the handoverjob is expected to be picked up at the facility.

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 ofRequired

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/handoverjobs/{handoverjobId}

GET /api/handoverjobs/{handoverjobId} 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,
  "anonymized": false,
  "assignedUsers": [
    {
      "userId": "text",
      "username": "text"
    }
  ],
  "cancelReason": "CONSUMER_NO_SHOW",
  "channel": "DELIVERY",
  "customAttributes": {},
  "documents": [
    {
      "customAttributes": {},
      "documentCategory": "EXTERNAL",
      "documentType": "PDF",
      "id": "text",
      "name": "text",
      "operations": [
        "PRINT"
      ],
      "path": "text",
      "priority": 1,
      "status": "AVAILABLE"
    }
  ],
  "documentsRef": "text",
  "expectedHandoverJobLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "https://example.com/resource",
        "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"
          }
        ]
      },
      "customAttributes": {},
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "stickers": [],
      "transferId": "text",
      "tags": []
    }
  ],
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "fullIdentifier": "text",
  "handoverJobLineItems": [
    {
      "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": "https://example.com/resource",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "measurementUnitKey": "pcs",
      "quantity": 1,
      "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"
      ],
      "secondaryMeasurementUnitKey": "g",
      "secondaryQuantity": 42
    }
  ],
  "handoverJobParcelInfo": {
    "carrierLogoUrl": "https://www.example.com/carrierlogo.png",
    "carrierParcelRef": "84168117830018",
    "carrierRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
    "carrierTrackingNumber": "84168117830018",
    "parcelRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
    "shipmentRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
    "carrierKey": "DHL"
  },
  "id": "95EWrieX09OmeriXIUbb",
  "invoiceAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "test@try.de",
    "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."
  },
  "missingHandoverJobLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "https://example.com/resource",
        "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"
          }
        ]
      },
      "customAttributes": {},
      "quantity": 1,
      "scannableCodes": [
        "text"
      ],
      "stickers": [],
      "tags": []
    }
  ],
  "operativeProcessRef": "text",
  "orderDate": "2020-02-03T08:45:50.525Z",
  "paid": false,
  "pickJobRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
  "processId": "text",
  "recipientAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "test@try.de",
    "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."
  },
  "shortIdentifier": "text",
  "status": "OPEN",
  "stickers": [],
  "targetTime": "2026-07-22T15:57:50.059Z",
  "tenantOrderId": "R456728546",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ],
  "workflowInformation": {
    "instanceRef": "64c13ab08edf48a008793cac",
    "isAvailable": true,
    "nodeRef": "text"
  },
  "tags": []
}

Update handover job

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

handoverjobIdstringRequired

ID of handoverjob you want to patch

Body

HandoverjobPatchActions

versioninteger · int64Required

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

Example: 42

Responses

200

Handoverjob was found & patch-set has been applied. The patched entity is in the body.

application/json

Handoverjob

createdstring · date-timeOptional

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

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

lastModifiedstring · date-timeOptional

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

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

versioninteger · int64Required

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

Example: 42

anonymizedbooleanOptional

Indicates if gdpr related data was anonymized

Example: false

cancelReasonstring · enumOptional

HandoverJobCancelReason

Possible values:

carrierKeystringOptionalDeprecated

carrierLogoUrlstringOptionalDeprecated

carrierRefstringOptionalDeprecated

carrierTrackingNumberstringOptionalDeprecated

channelstring · enumRequired

HandoverjobChannel

Possible values:

customAttributesobjectOptional

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

documentsRefstringOptional

Reference to the documents collection from this entity

facilityRefstringRequired

The id of the facility reference.

Example: Esb20gpHBL94X5NdMp3C

fullIdentifierstringOptional

An information to identify the recipient

idstringRequired

The id of this handoverjob. It is generated during creation automatically and suits as the primary identifier of the described entity.

Example: 95EWrieX09OmeriXIUbb

loadUnitRefsstring[]OptionalDeprecated

operativeProcessRefstringOptional

orderDatestring · date-timeRequired

The date this order was created at the supplying system.

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

paidbooleanOptional

Indicates if the order is already paid

Example: false

parcelRefstringOptionalDeprecated

Example: 2fOge2ZGW54K4TgvDTQw

pickJobRefstringOptional

The reference to the pickjob for which the handoverjob is assigned to

Example: ca525716-7208-4a63-a2a6-11274eb37f67-0

processIdstringOptional

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

shipmentRefstringOptionalDeprecated

Example: Esb20gpHBL94X5NdMp3C

shortIdentifierstringOptional

The short identifier of the shipment.

statusstring · enumRequired

Status of a Handover Job.

OPEN: Active and ready for processing (default initial state)
WAITING_FOR_INPUT: Waiting for line items to be populated
HANDED_OVER: Items have been handed over (completion state)
CANCELED: Handover job was canceled
OBSOLETE: No longer relevant (terminal state, cannot transition out)

Possible values:

targetTimestring · date-timeRequired

The time the handoverjob is expected to be picked up at the facility.

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 ofRequired

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

409

Entity version conflict

application/json

patch/api/handoverjobs/{handoverjobId}

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

{
  "actions": [
    {
      "action": "ModifyHandoverjob",
      "customAttributes": {},
      "status": "OPEN"
    }
  ],
  "version": 42
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "anonymized": false,
  "assignedUsers": [
    {
      "userId": "text",
      "username": "text"
    }
  ],
  "cancelReason": "CONSUMER_NO_SHOW",
  "channel": "DELIVERY",
  "customAttributes": {},
  "documents": [
    {
      "customAttributes": {},
      "documentCategory": "EXTERNAL",
      "documentType": "PDF",
      "id": "text",
      "name": "text",
      "operations": [
        "PRINT"
      ],
      "path": "text",
      "priority": 1,
      "status": "AVAILABLE"
    }
  ],
  "documentsRef": "text",
  "expectedHandoverJobLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "https://example.com/resource",
        "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"
          }
        ]
      },
      "customAttributes": {},
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "stickers": [],
      "transferId": "text",
      "tags": []
    }
  ],
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "fullIdentifier": "text",
  "handoverJobLineItems": [
    {
      "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": "https://example.com/resource",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "measurementUnitKey": "pcs",
      "quantity": 1,
      "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"
      ],
      "secondaryMeasurementUnitKey": "g",
      "secondaryQuantity": 42
    }
  ],
  "handoverJobParcelInfo": {
    "carrierLogoUrl": "https://www.example.com/carrierlogo.png",
    "carrierParcelRef": "84168117830018",
    "carrierRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
    "carrierTrackingNumber": "84168117830018",
    "parcelRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
    "shipmentRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
    "carrierKey": "DHL"
  },
  "id": "95EWrieX09OmeriXIUbb",
  "invoiceAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "test@try.de",
    "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."
  },
  "missingHandoverJobLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "https://example.com/resource",
        "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"
          }
        ]
      },
      "customAttributes": {},
      "quantity": 1,
      "scannableCodes": [
        "text"
      ],
      "stickers": [],
      "tags": []
    }
  ],
  "operativeProcessRef": "text",
  "orderDate": "2020-02-03T08:45:50.525Z",
  "paid": false,
  "pickJobRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
  "processId": "text",
  "recipientAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "test@try.de",
    "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."
  },
  "shortIdentifier": "text",
  "status": "OPEN",
  "stickers": [],
  "targetTime": "2026-07-22T15:57:50.059Z",
  "tenantOrderId": "R456728546",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ],
  "workflowInformation": {
    "instanceRef": "64c13ab08edf48a008793cac",
    "isAvailable": true,
    "nodeRef": "text"
  },
  "tags": []
}

Call handover job action

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

handoverJobIdstringRequired

Reference to the handover job you want to call the action for

Body

HandoverJobActionsParameter

Responses

200

Updated Handover job in the body.

application/json

Handoverjob

createdstring · date-timeOptional

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

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

lastModifiedstring · date-timeOptional

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

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

versioninteger · int64Required

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

Example: 42

anonymizedbooleanOptional

Indicates if gdpr related data was anonymized

Example: false

cancelReasonstring · enumOptional

HandoverJobCancelReason

Possible values:

carrierKeystringOptionalDeprecated

carrierLogoUrlstringOptionalDeprecated

carrierRefstringOptionalDeprecated

carrierTrackingNumberstringOptionalDeprecated

channelstring · enumRequired

HandoverjobChannel

Possible values:

customAttributesobjectOptional

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

documentsRefstringOptional

Reference to the documents collection from this entity

facilityRefstringRequired

The id of the facility reference.

Example: Esb20gpHBL94X5NdMp3C

fullIdentifierstringOptional

An information to identify the recipient

idstringRequired

The id of this handoverjob. It is generated during creation automatically and suits as the primary identifier of the described entity.

Example: 95EWrieX09OmeriXIUbb

loadUnitRefsstring[]OptionalDeprecated

operativeProcessRefstringOptional

orderDatestring · date-timeRequired

The date this order was created at the supplying system.

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

paidbooleanOptional

Indicates if the order is already paid

Example: false

parcelRefstringOptionalDeprecated

Example: 2fOge2ZGW54K4TgvDTQw

pickJobRefstringOptional

The reference to the pickjob for which the handoverjob is assigned to

Example: ca525716-7208-4a63-a2a6-11274eb37f67-0

processIdstringOptional

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

shipmentRefstringOptionalDeprecated

Example: Esb20gpHBL94X5NdMp3C

shortIdentifierstringOptional

The short identifier of the shipment.

statusstring · enumRequired

Status of a Handover Job.

OPEN: Active and ready for processing (default initial state)
WAITING_FOR_INPUT: Waiting for line items to be populated
HANDED_OVER: Items have been handed over (completion state)
CANCELED: Handover job was canceled
OBSOLETE: No longer relevant (terminal state, cannot transition out)

Possible values:

targetTimestring · date-timeRequired

The time the handoverjob is expected to be picked up at the facility.

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 ofRequired

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/handoverjobs/{handoverJobId}/actions

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

{
  "name": "CANCEL",
  "payload": {
    "handoverJobCancelReason": "CONSUMER_NO_SHOW"
  },
  "version": 1
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "anonymized": false,
  "assignedUsers": [
    {
      "userId": "text",
      "username": "text"
    }
  ],
  "cancelReason": "CONSUMER_NO_SHOW",
  "channel": "DELIVERY",
  "customAttributes": {},
  "documents": [
    {
      "customAttributes": {},
      "documentCategory": "EXTERNAL",
      "documentType": "PDF",
      "id": "text",
      "name": "text",
      "operations": [
        "PRINT"
      ],
      "path": "text",
      "priority": 1,
      "status": "AVAILABLE"
    }
  ],
  "documentsRef": "text",
  "expectedHandoverJobLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "https://example.com/resource",
        "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"
          }
        ]
      },
      "customAttributes": {},
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "stickers": [],
      "transferId": "text",
      "tags": []
    }
  ],
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "fullIdentifier": "text",
  "handoverJobLineItems": [
    {
      "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": "https://example.com/resource",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1
      },
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "measurementUnitKey": "pcs",
      "quantity": 1,
      "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"
      ],
      "secondaryMeasurementUnitKey": "g",
      "secondaryQuantity": 42
    }
  ],
  "handoverJobParcelInfo": {
    "carrierLogoUrl": "https://www.example.com/carrierlogo.png",
    "carrierParcelRef": "84168117830018",
    "carrierRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
    "carrierTrackingNumber": "84168117830018",
    "parcelRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
    "shipmentRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
    "carrierKey": "DHL"
  },
  "id": "95EWrieX09OmeriXIUbb",
  "invoiceAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "test@try.de",
    "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."
  },
  "missingHandoverJobLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "https://example.com/resource",
        "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"
          }
        ]
      },
      "customAttributes": {},
      "quantity": 1,
      "scannableCodes": [
        "text"
      ],
      "stickers": [],
      "tags": []
    }
  ],
  "operativeProcessRef": "text",
  "orderDate": "2020-02-03T08:45:50.525Z",
  "paid": false,
  "pickJobRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
  "processId": "text",
  "recipientAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "test@try.de",
    "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."
  },
  "shortIdentifier": "text",
  "status": "OPEN",
  "stickers": [],
  "targetTime": "2026-07-22T15:57:50.059Z",
  "tenantOrderId": "R456728546",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ],
  "workflowInformation": {
    "instanceRef": "64c13ab08edf48a008793cac",
    "isAvailable": true,
    "nodeRef": "text"
  },
  "tags": []
}

List handover job (search)

post

Search for HandoverJob

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

HandoverJobSearchPayload

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.

Example: 10

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

HandoverJobPaginatedResult

totalnumberOptional

The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.

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

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

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "anonymized": {
              "eq": true,
              "notEq": true
            },
            "assignedUsers": {
              "contains": {
                "userId": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "username": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "channel": {
              "eq": "DELIVERY",
              "in": [
                "DELIVERY"
              ],
              "notEq": "DELIVERY"
            },
            "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "fullIdentifier": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "handoverJobLineItems": {
              "contains": {
                "article": {
                  "tenantArticleId": "MY_ARTICLE_ID",
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                },
                "substituteLineItems": {
                  "contains": {
                    "article": {
                      "tenantArticleId": "MY_ARTICLE_ID",
                      "title": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "like": "text",
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      }
                    }
                  }
                }
              }
            },
            "handoverJobParcelInfo": {
              "carrierKey": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
              "carrierTrackingNumber": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "shipmentRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
            },
            "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "invoiceAddress": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": "phil.bison@fulfillmenttools.com",
              "firstName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "lastName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "or": "[Circular Reference]",
            "pickJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "recipientAddress": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": "phil.bison@fulfillmenttools.com",
              "firstName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "lastName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "shortIdentifier": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            },
            "targetTime": "2026-06-17T12:00:00.000Z",
            "tenantOrderId": "MY_ORDER_ID"
          }
        ],
        "anonymized": {
          "eq": true,
          "notEq": true
        },
        "assignedUsers": {
          "contains": {
            "userId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "username": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        },
        "channel": {
          "eq": "DELIVERY",
          "in": [
            "DELIVERY"
          ],
          "notEq": "DELIVERY"
        },
        "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "fullIdentifier": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "handoverJobLineItems": {
          "contains": {
            "article": {
              "tenantArticleId": "MY_ARTICLE_ID",
              "title": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "substituteLineItems": {
              "contains": {
                "article": {
                  "tenantArticleId": "MY_ARTICLE_ID",
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            }
          }
        },
        "handoverJobParcelInfo": {
          "carrierKey": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
          "carrierTrackingNumber": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "shipmentRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
        },
        "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "invoiceAddress": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": "phil.bison@fulfillmenttools.com",
          "firstName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "lastName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "anonymized": {
              "eq": true,
              "notEq": true
            },
            "assignedUsers": {
              "contains": {
                "userId": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "username": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "channel": {
              "eq": "DELIVERY",
              "in": [
                "DELIVERY"
              ],
              "notEq": "DELIVERY"
            },
            "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "fullIdentifier": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "handoverJobLineItems": {
              "contains": {
                "article": {
                  "tenantArticleId": "MY_ARTICLE_ID",
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                },
                "substituteLineItems": {
                  "contains": {
                    "article": {
                      "tenantArticleId": "MY_ARTICLE_ID",
                      "title": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "like": "text",
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      }
                    }
                  }
                }
              }
            },
            "handoverJobParcelInfo": {
              "carrierKey": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
              "carrierTrackingNumber": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "shipmentRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
            },
            "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "invoiceAddress": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": "phil.bison@fulfillmenttools.com",
              "firstName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "lastName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "or": "[Circular Reference]",
            "pickJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "recipientAddress": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": "phil.bison@fulfillmenttools.com",
              "firstName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "lastName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "shortIdentifier": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            },
            "targetTime": "2026-06-17T12:00:00.000Z",
            "tenantOrderId": "MY_ORDER_ID"
          }
        ],
        "pickJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "recipientAddress": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": "phil.bison@fulfillmenttools.com",
          "firstName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "lastName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "shortIdentifier": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "status": {
          "eq": "OPEN",
          "in": [
            "OPEN"
          ],
          "notEq": "OPEN"
        },
        "targetTime": "2026-06-17T12:00:00.000Z",
        "tenantOrderId": "MY_ORDER_ID"
      }
    ],
    "anonymized": {
      "eq": true,
      "notEq": true
    },
    "assignedUsers": {
      "contains": {
        "userId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "username": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    },
    "channel": {
      "eq": "DELIVERY",
      "in": [
        "DELIVERY"
      ],
      "notEq": "DELIVERY"
    },
    "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "fullIdentifier": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "handoverJobLineItems": {
      "contains": {
        "article": {
          "tenantArticleId": "MY_ARTICLE_ID",
          "title": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "substituteLineItems": {
          "contains": {
            "article": {
              "tenantArticleId": "MY_ARTICLE_ID",
              "title": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          }
        }
      }
    },
    "handoverJobParcelInfo": {
      "carrierKey": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "carrierTrackingNumber": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "shipmentRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
    },
    "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "invoiceAddress": {
      "companyName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "email": "phil.bison@fulfillmenttools.com",
      "firstName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "lastName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      }
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "anonymized": {
          "eq": true,
          "notEq": true
        },
        "assignedUsers": {
          "contains": {
            "userId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "username": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        },
        "channel": {
          "eq": "DELIVERY",
          "in": [
            "DELIVERY"
          ],
          "notEq": "DELIVERY"
        },
        "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "fullIdentifier": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "handoverJobLineItems": {
          "contains": {
            "article": {
              "tenantArticleId": "MY_ARTICLE_ID",
              "title": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "substituteLineItems": {
              "contains": {
                "article": {
                  "tenantArticleId": "MY_ARTICLE_ID",
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            }
          }
        },
        "handoverJobParcelInfo": {
          "carrierKey": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
          "carrierTrackingNumber": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "shipmentRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
        },
        "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "invoiceAddress": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": "phil.bison@fulfillmenttools.com",
          "firstName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "lastName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "or": "[Circular Reference]",
        "pickJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "recipientAddress": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": "phil.bison@fulfillmenttools.com",
          "firstName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "lastName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "shortIdentifier": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "status": {
          "eq": "OPEN",
          "in": [
            "OPEN"
          ],
          "notEq": "OPEN"
        },
        "targetTime": "2026-06-17T12:00:00.000Z",
        "tenantOrderId": "MY_ORDER_ID"
      }
    ],
    "pickJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "recipientAddress": {
      "companyName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "email": "phil.bison@fulfillmenttools.com",
      "firstName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "lastName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      }
    },
    "shortIdentifier": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "status": {
      "eq": "OPEN",
      "in": [
        "OPEN"
      ],
      "notEq": "OPEN"
    },
    "targetTime": "2026-06-17T12:00:00.000Z",
    "tenantOrderId": "MY_ORDER_ID"
  },
  "size": 10,
  "sort": [
    {
      "targetTime": "ASC"
    }
  ]
}

{
  "handoverJobs": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42,
      "anonymized": false,
      "assignedUsers": [
        {
          "userId": "text",
          "username": "text"
        }
      ],
      "cancelReason": "CONSUMER_NO_SHOW",
      "channel": "DELIVERY",
      "customAttributes": {},
      "documents": [
        {
          "customAttributes": {},
          "documentCategory": "EXTERNAL",
          "documentType": "PDF",
          "id": "text",
          "name": "text",
          "operations": [
            "PRINT"
          ],
          "path": "text",
          "priority": 1,
          "status": "AVAILABLE"
        }
      ],
      "documentsRef": "text",
      "expectedHandoverJobLineItems": [
        {
          "article": {
            "titleLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "customAttributes": {},
            "imageUrl": "https://example.com/resource",
            "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"
              }
            ]
          },
          "customAttributes": {},
          "quantity": 21,
          "scannableCodes": [
            "text"
          ],
          "stickers": [],
          "transferId": "text",
          "tags": []
        }
      ],
      "facilityRef": "Esb20gpHBL94X5NdMp3C",
      "fullIdentifier": "text",
      "handoverJobLineItems": [
        {
          "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": "https://example.com/resource",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "weight": 1
          },
          "customAttributes": {},
          "globalLineItemId": "text",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "measurementUnitKey": "pcs",
          "quantity": 1,
          "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"
          ],
          "secondaryMeasurementUnitKey": "g",
          "secondaryQuantity": 42
        }
      ],
      "handoverJobParcelInfo": {
        "carrierLogoUrl": "https://www.example.com/carrierlogo.png",
        "carrierParcelRef": "84168117830018",
        "carrierRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
        "carrierTrackingNumber": "84168117830018",
        "parcelRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
        "shipmentRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
        "carrierKey": "DHL"
      },
      "id": "95EWrieX09OmeriXIUbb",
      "invoiceAddress": {
        "addressType": "POSTAL_ADDRESS",
        "companyName": "Speedy Boxales Ltd.",
        "coordinates": {
          "lat": 50.937531,
          "lon": 6.960279
        },
        "email": "test@try.de",
        "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."
      },
      "missingHandoverJobLineItems": [
        {
          "article": {
            "titleLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "customAttributes": {},
            "imageUrl": "https://example.com/resource",
            "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"
              }
            ]
          },
          "customAttributes": {},
          "quantity": 1,
          "scannableCodes": [
            "text"
          ],
          "stickers": [],
          "tags": []
        }
      ],
      "operativeProcessRef": "text",
      "orderDate": "2020-02-03T08:45:50.525Z",
      "paid": false,
      "pickJobRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
      "processId": "text",
      "recipientAddress": {
        "addressType": "POSTAL_ADDRESS",
        "companyName": "Speedy Boxales Ltd.",
        "coordinates": {
          "lat": 50.937531,
          "lon": 6.960279
        },
        "email": "test@try.de",
        "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."
      },
      "shortIdentifier": "text",
      "status": "OPEN",
      "stickers": [],
      "targetTime": "2026-07-22T15:57:50.059Z",
      "tenantOrderId": "R456728546",
      "transfers": [
        {
          "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
          "type": "RECEIVER"
        }
      ],
      "workflowInformation": {
        "instanceRef": "64c13ab08edf48a008793cac",
        "isAvailable": true,
        "nodeRef": "text"
      },
      "tags": []
    }
  ],
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1
}

Last updated 3 hours ago