Handover endpoints

Create handover job

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

HandoverjobForCreation

cancelReasonstring · enumOptional

HandoverJobCancelReason

Possible values:

carrierLogoUrlstringOptionalDeprecated

This part of the API is deprecated. For details please check the api-release-life-cycle documentation.@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.

carrierRefstringOptionalDeprecated

This part of the API is deprecated. For details please check the api-release-life-cycle documentation.@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.

carrierTrackingNumberstringOptionalDeprecated

This part of the API is deprecated. For details please check the api-release-life-cycle documentation.@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.

channelstring · enumRequiredPossible 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[]Optional

Reference to array of load unit Refs

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

This part of the API is deprecated. For details please check the api-release-life-cycle documentation.@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.

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

This part of the API is deprecated. For details please check the api-release-life-cycle documentation.@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.

Example: Esb20gpHBL94X5NdMp3C

shortIdentifierstringOptional

The short identifier of the shipment.

statusstring · enumOptional

HandoverjobStatus

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

Responses

201

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

application/json

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

post

/api/handoverjobs

HTTPcURLJavaScriptPython

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: 2926

{
  "assignedUsers": [
    {
      "username": "text"
    }
  ],
  "cancelReason": "CONSUMER_NO_SHOW",
  "channel": "DELIVERY",
  "customAttributes": {},
  "expectedHandoverJobLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ]
      },
      "customAttributes": {},
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "status": "OPEN",
      "stickers": [],
      "transferId": "text",
      "tags": []
    }
  ],
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "fullIdentifier": "text",
  "handoverJobLineItems": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "quantity": 1,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "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"
  },
  "invoiceAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "loadUnitRefs": [
    "text"
  ],
  "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": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "routingPlanRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
  "shortIdentifier": "text",
  "status": "OPEN",
  "stickers": [],
  "targetTime": "2026-03-02T23:19:28.268Z",
  "tenantOrderId": "R456728546",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ],
  "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": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ]
      },
      "customAttributes": {},
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "status": "OPEN",
      "stickers": [],
      "transferId": "text",
      "tags": []
    }
  ],
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "fullIdentifier": "text",
  "handoverJobLineItems": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "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"
      ]
    }
  ],
  "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": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "loadUnitRefs": [
    "text"
  ],
  "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": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "shortIdentifier": "text",
  "status": "OPEN",
  "stickers": [],
  "targetTime": "2026-03-02T23:19:28.268Z",
  "tenantOrderId": "R456728546",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ],
  "tags": []
}

Get handover job

get

Authorizations

BearerToken

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

and

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}

HTTPcURLJavaScriptPython

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": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ]
      },
      "customAttributes": {},
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "status": "OPEN",
      "stickers": [],
      "transferId": "text",
      "tags": []
    }
  ],
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "fullIdentifier": "text",
  "handoverJobLineItems": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "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"
      ]
    }
  ],
  "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": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "loadUnitRefs": [
    "text"
  ],
  "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": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "shortIdentifier": "text",
  "status": "OPEN",
  "stickers": [],
  "targetTime": "2026-03-02T23:19:28.268Z",
  "tenantOrderId": "R456728546",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ],
  "tags": []
}

Call handover job action

post

Authorizations

BearerToken

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

application/json

HandoverJobActionsParameter

or

or

or

or

or

or

Responses

200

Updated Handover job in the body.

application/json

Handoverjob

and

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

HTTPcURLJavaScriptPython

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": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ]
      },
      "customAttributes": {},
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "status": "OPEN",
      "stickers": [],
      "transferId": "text",
      "tags": []
    }
  ],
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "fullIdentifier": "text",
  "handoverJobLineItems": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "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"
      ]
    }
  ],
  "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": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "loadUnitRefs": [
    "text"
  ],
  "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": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "shortIdentifier": "text",
  "status": "OPEN",
  "stickers": [],
  "targetTime": "2026-03-02T23:19:28.268Z",
  "tenantOrderId": "R456728546",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ],
  "tags": []
}

Update handover job

patch

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

handoverjobIdstringRequired

ID of handoverjob you want to patch

Body

application/json

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

and

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}

HTTPcURLJavaScriptPython

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": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ]
      },
      "customAttributes": {},
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "status": "OPEN",
      "stickers": [],
      "transferId": "text",
      "tags": []
    }
  ],
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "fullIdentifier": "text",
  "handoverJobLineItems": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "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"
      ]
    }
  ],
  "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": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "loadUnitRefs": [
    "text"
  ],
  "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": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "shortIdentifier": "text",
  "status": "OPEN",
  "stickers": [],
  "targetTime": "2026-03-02T23:19:28.268Z",
  "tenantOrderId": "R456728546",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ],
  "tags": []
}

List handover jobs

get

Authorizations

BearerToken

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

HTTPcURLJavaScriptPython

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": "[email protected]",
        "firstName": "Maxine",
        "lastName": "Muller",
        "personalTitle": "Dr.",
        "salutation": "Frau",
        "additionalAddressInfo": "to care of: Mrs. Müller",
        "city": "Langenfeld",
        "country": "DE",
        "customAttributes": {},
        "houseNumber": "42a",
        "phoneNumbers": [
          {
            "customAttributes": {},
            "label": "text",
            "type": "MOBILE",
            "value": "text"
          }
        ],
        "postalCode": "40764",
        "province": "NRW",
        "street": "Hauptstr."
      },
      "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": "[email protected]",
        "firstName": "Maxine",
        "lastName": "Muller",
        "personalTitle": "Dr.",
        "salutation": "Frau",
        "additionalAddressInfo": "to care of: Mrs. Müller",
        "city": "Langenfeld",
        "country": "DE",
        "customAttributes": {},
        "houseNumber": "42a",
        "phoneNumbers": [
          {
            "customAttributes": {},
            "label": "text",
            "type": "MOBILE",
            "value": "text"
          }
        ],
        "postalCode": "40764",
        "province": "NRW",
        "street": "Hauptstr."
      },
      "searchPaths": "R456728546",
      "status": "OPEN",
      "tenantOrderId": "R456728546"
    }
  ],
  "total": 42
}

List handover job (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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.

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

application/json

post

/api/handoverjobs/search

HTTPcURLJavaScriptPython

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: 13008

{
  "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": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "fullIdentifier": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "handoverJobLineItems": {
              "contains": {
                "article": {
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                },
                "substituteLineItems": {
                  "contains": {
                    "article": {
                      "tenantArticleId": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "like": "text",
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      },
                      "title": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "like": "text",
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      }
                    }
                  }
                }
              }
            },
            "handoverJobParcelInfo": {
              "carrierKey": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "carrierRef": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "carrierTrackingNumber": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "shipmentRef": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "invoiceAddress": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "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": {
              "eq": "text",
              "notEq": "text"
            },
            "recipientAddress": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "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": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T23:19:28.268Z",
              "gt": "2026-03-02T23:19:28.268Z",
              "gte": "2026-03-02T23:19:28.268Z",
              "lt": "2026-03-02T23:19:28.268Z",
              "lte": "2026-03-02T23:19:28.268Z",
              "notEq": "2026-03-02T23:19:28.268Z"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "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": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "fullIdentifier": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "handoverJobLineItems": {
          "contains": {
            "article": {
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "title": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "substituteLineItems": {
              "contains": {
                "article": {
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            }
          }
        },
        "handoverJobParcelInfo": {
          "carrierKey": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "carrierRef": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "carrierTrackingNumber": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "shipmentRef": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "invoiceAddress": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "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": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "fullIdentifier": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "handoverJobLineItems": {
              "contains": {
                "article": {
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                },
                "substituteLineItems": {
                  "contains": {
                    "article": {
                      "tenantArticleId": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "like": "text",
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      },
                      "title": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "like": "text",
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      }
                    }
                  }
                }
              }
            },
            "handoverJobParcelInfo": {
              "carrierKey": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "carrierRef": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "carrierTrackingNumber": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "shipmentRef": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "invoiceAddress": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "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": {
              "eq": "text",
              "notEq": "text"
            },
            "recipientAddress": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "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": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T23:19:28.268Z",
              "gt": "2026-03-02T23:19:28.268Z",
              "gte": "2026-03-02T23:19:28.268Z",
              "lt": "2026-03-02T23:19:28.268Z",
              "lte": "2026-03-02T23:19:28.268Z",
              "notEq": "2026-03-02T23:19:28.268Z"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "pickJobRef": {
          "eq": "text",
          "notEq": "text"
        },
        "recipientAddress": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "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": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T23:19:28.268Z",
          "gt": "2026-03-02T23:19:28.268Z",
          "gte": "2026-03-02T23:19:28.268Z",
          "lt": "2026-03-02T23:19:28.268Z",
          "lte": "2026-03-02T23:19:28.268Z",
          "notEq": "2026-03-02T23:19:28.268Z"
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "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": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "fullIdentifier": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "handoverJobLineItems": {
      "contains": {
        "article": {
          "tenantArticleId": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "title": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "substituteLineItems": {
          "contains": {
            "article": {
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "title": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          }
        }
      }
    },
    "handoverJobParcelInfo": {
      "carrierKey": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "carrierRef": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "carrierTrackingNumber": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "shipmentRef": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      }
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "invoiceAddress": {
      "companyName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "email": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "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": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "fullIdentifier": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "handoverJobLineItems": {
          "contains": {
            "article": {
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "title": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "substituteLineItems": {
              "contains": {
                "article": {
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            }
          }
        },
        "handoverJobParcelInfo": {
          "carrierKey": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "carrierRef": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "carrierTrackingNumber": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "shipmentRef": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "invoiceAddress": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "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": {
          "eq": "text",
          "notEq": "text"
        },
        "recipientAddress": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "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": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T23:19:28.268Z",
          "gt": "2026-03-02T23:19:28.268Z",
          "gte": "2026-03-02T23:19:28.268Z",
          "lt": "2026-03-02T23:19:28.268Z",
          "lte": "2026-03-02T23:19:28.268Z",
          "notEq": "2026-03-02T23:19:28.268Z"
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "pickJobRef": {
      "eq": "text",
      "notEq": "text"
    },
    "recipientAddress": {
      "companyName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "email": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "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": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T23:19:28.268Z",
      "gt": "2026-03-02T23:19:28.268Z",
      "gte": "2026-03-02T23:19:28.268Z",
      "lt": "2026-03-02T23:19:28.268Z",
      "lte": "2026-03-02T23:19:28.268Z",
      "notEq": "2026-03-02T23:19:28.268Z"
    },
    "tenantOrderId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    }
  },
  "size": 1,
  "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": "text",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "weight": 1,
            "attributes": [
              {
                "valueLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "keyLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "category": "descriptive",
                "context": {
                  "type": "FACILITY_GROUP",
                  "value": "text"
                },
                "key": "%%subtitle%%",
                "priority": 100,
                "type": "STRING",
                "value": "585er Gold"
              }
            ]
          },
          "customAttributes": {},
          "quantity": 21,
          "scannableCodes": [
            "text"
          ],
          "status": "OPEN",
          "stickers": [],
          "transferId": "text",
          "tags": []
        }
      ],
      "facilityRef": "Esb20gpHBL94X5NdMp3C",
      "fullIdentifier": "text",
      "handoverJobLineItems": [
        {
          "article": {},
          "customAttributes": {},
          "globalLineItemId": "text",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "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"
          ]
        }
      ],
      "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": "[email protected]",
        "firstName": "Maxine",
        "lastName": "Muller",
        "personalTitle": "Dr.",
        "salutation": "Frau",
        "additionalAddressInfo": "to care of: Mrs. Müller",
        "city": "Langenfeld",
        "country": "DE",
        "customAttributes": {},
        "houseNumber": "42a",
        "phoneNumbers": [
          {
            "customAttributes": {},
            "label": "text",
            "type": "MOBILE",
            "value": "text"
          }
        ],
        "postalCode": "40764",
        "province": "NRW",
        "street": "Hauptstr."
      },
      "loadUnitRefs": [
        "text"
      ],
      "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": "[email protected]",
        "firstName": "Maxine",
        "lastName": "Muller",
        "personalTitle": "Dr.",
        "salutation": "Frau",
        "additionalAddressInfo": "to care of: Mrs. Müller",
        "city": "Langenfeld",
        "country": "DE",
        "customAttributes": {},
        "houseNumber": "42a",
        "phoneNumbers": [
          {
            "customAttributes": {},
            "label": "text",
            "type": "MOBILE",
            "value": "text"
          }
        ],
        "postalCode": "40764",
        "province": "NRW",
        "street": "Hauptstr."
      },
      "shortIdentifier": "text",
      "status": "OPEN",
      "stickers": [],
      "targetTime": "2026-03-02T23:19:28.268Z",
      "tenantOrderId": "R456728546",
      "transfers": [
        {
          "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
          "type": "RECEIVER"
        }
      ],
      "tags": []
    }
  ],
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1
}

Get handover config

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Returns the handover configuration for the tenant

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

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

application/json

HandoverConfiguration

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/configurations/handover

HTTPcURLJavaScriptPython

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

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

Update handover configuration

put

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Updates the handover configuration for the tenant. If the configuration does not exist, it will be created.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

HandoverConfigurationForCreate

availableRefusedReasonsanyOptional

AvailableRefuseReasonForCreation

createStandaloneHandoverJobsbooleanOptionalDeprecated

This part of the API is deprecated. For details please check the api-release-life-cycle documentation.If true, a handover job will be created out of a valid routing plan. It is only possible, if no pickjob nor packjobs are used for this tenant. This is a alpha feature and might be completly replaced in the future. Please only use in communication with the FFT team.

Example: true

versionnumberRequired

Responses

200

The handover configuration was successfully updated.

application/json

HandoverConfiguration

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

put

/api/configurations/handover

HTTPcURLJavaScriptPython

PUT /api/configurations/handover HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "availableRefusedReasons": [],
  "version": 1
}

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

List refuse reasons

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Existing refuse reasons

application/json

AvailableRefusedReason

activebooleanRequired

refusedReasonstringOptional

translated refusedReason selected from refusedReasonLocalized

Example: Broken Item

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

get

/api/configurations/handover/refusereasons

HTTPcURLJavaScriptPython

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

[]