Shipments (Operations)

Endpoints to create, update and read shipments and parcels.

Create delivery note

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

localestringOptional

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

Body

DeliveryNote

Responses

201

Successfully created the delivery note.

application/pdf

DeliveryNote

401

Your user is not allowed to operate against this API instance

application/pdf

403

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

application/pdf

post

/api/deliverynotes

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

{
  "companyAddress": {
    "city": "Langenfeld",
    "country": "Germany",
    "houseNumber": "42a",
    "name": "OC fulfillment GmbH",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddress": {
    "city": "Langenfeld",
    "companyName": "OC Fulfillment GmbH",
    "firstName": "Maxine",
    "houseNumber": "42a",
    "lastName": "Muller",
    "personalTitle": "Prof.",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddresses": [
    {
      "city": "Langenfeld",
      "companyName": "OC Fulfillment GmbH",
      "firstName": "Maxine",
      "houseNumber": "42a",
      "lastName": "Muller",
      "personalTitle": "Prof.",
      "postalCode": "40764",
      "street": "Hauptstr."
    }
  ],
  "items": [
    {
      "id": "text",
      "quantity": "text",
      "substitutes": "text",
      "title": "text"
    }
  ],
  "orderInformation": {
    "orderDate": "2020-02-03T08:45:50.525Z",
    "orderNumber": "R456728546"
  }
}

{
  "companyAddress": {
    "city": "Langenfeld",
    "country": "Germany",
    "houseNumber": "42a",
    "name": "OC fulfillment GmbH",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddress": {
    "city": "Langenfeld",
    "companyName": "OC Fulfillment GmbH",
    "firstName": "Maxine",
    "houseNumber": "42a",
    "lastName": "Muller",
    "personalTitle": "Prof.",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddresses": [
    {
      "city": "Langenfeld",
      "companyName": "OC Fulfillment GmbH",
      "firstName": "Maxine",
      "houseNumber": "42a",
      "lastName": "Muller",
      "personalTitle": "Prof.",
      "postalCode": "40764",
      "street": "Hauptstr."
    }
  ],
  "items": [
    {
      "id": "text",
      "quantity": "text",
      "substitutes": "text",
      "title": "text"
    }
  ],
  "orderInformation": {
    "orderDate": "2020-02-03T08:45:50.525Z",
    "orderNumber": "R456728546"
  }
}

List parcels

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

Responses

200

Parcels are found.

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

get

/api/parcels

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

{
  "parcels": [
    {
      "carrierRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
      "carrierTrackingNumber": "84168117830018",
      "parcelRef": "15EZrieW09OmeriXIUbc",
      "status": "OPEN"
    }
  ],
  "total": 42
}

Get parcel

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

parcelIdstringRequired

ID of the parcel you want to get

Responses

200

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

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

404

Entity not found

application/json

get

/api/parcels/{parcelId}

GET /api/parcels/{parcelId} 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,
  "carrierInformation": {
    "shippingContainerNumber": "123456-ABC"
  },
  "carrierProduct": "EXPRESS",
  "carrierRef": "cf00e102-34f2-45c1-a846-6a21f384321e",
  "customAttributes": {},
  "customProductValue": 12.5,
  "dimensions": {
    "customWeight": 1700,
    "height": 50,
    "length": 100,
    "weight": 1700,
    "width": 25
  },
  "documentsRef": "text",
  "facilityRef": "text",
  "id": "95EWrieX09OmeriXIUbb",
  "invoice": {
    "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."
  },
  "items": [
    {
      "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"
      ]
    }
  ],
  "loadUnitRefs": [
    "text"
  ],
  "operativeProcessRef": "text",
  "paymentInformation": {
    "currency": "EUR"
  },
  "pickUpInformation": {
    "endTime": "2026-03-15T00:57:49.688Z",
    "startTime": "2026-03-15T00:57:49.688Z"
  },
  "postalCharges": {
    "currency": "EUR",
    "value": 15.5
  },
  "processRef": "text",
  "productValue": 1250,
  "productValueCurrency": {
    "currency": "EUR",
    "decimalPlaces": 2
  },
  "productValueType": "INSURANCE",
  "recipient": {
    "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."
  },
  "result": {
    "carrierParcelRef": "84168117830018",
    "carrierTrackingNumber": "84168117830018",
    "carrierTrackingStatus": "registered",
    "customsDocumentId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "customsDocumentUrl": "someCepProvider.com/pathToReturnLabel.pdf",
    "errors": {
      "labelError": "text",
      "returnLabelError": "text"
    },
    "labelUrl": "%%HOST%%/api/parcels/{parcelId}/labels/84168117830018.pdf",
    "proxyId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "returnLabelId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "returnLabelUrl": "someCepProvider.com/pathToReturnLabel.pdf",
    "returnTrackingUrl": "http://track.io/3a186c51d4",
    "sendLabelUrl": "someCepProvider.com/pathToSendLabel.pdf",
    "summary": "Package label was successfully requested at DHL.",
    "trackingStatus": "registered",
    "trackingUrl": "http://track.io/3a186c51d4"
  },
  "returnAddress": {
    "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.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "sender": {
    "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.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "services": {
    "additionalTransportInsurance": true,
    "adultSignature": true,
    "bulkyGoods": true,
    "customerSignature": true,
    "identityCheckCompany": true,
    "identityCheckPrivate": true,
    "saturdayDelivery": true,
    "signature": true
  },
  "shipmentRef": "95EWrieX09OmeriXIUbb",
  "shortId": "AA12-1",
  "status": "OPEN",
  "tenantOrderId": "R456728546",
  "tenantParcelId": "MY-PARCEL-12345",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ]
}

Update parcel

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

parcelIdstringRequired

ID of the parcel you want to get

Body

ParcelPatchActions

versioninteger · int64Required

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

Example: 42

Responses

200

Successfully updated the parcel.

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

404

Entity not found

application/json

patch

/api/parcels/{parcelId}

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

{
  "actions": [
    {
      "action": "ModifyParcel",
      "carrierInformation": {
        "shippingContainerNumber": "123456-ABC"
      },
      "carrierProduct": "text",
      "customAttributes": {},
      "customProductValue": 12.5,
      "dimensions": {
        "customWeight": 1700,
        "height": 50,
        "length": 100,
        "weight": 1700,
        "width": 25
      },
      "pickUpInformation": {
        "endTime": "2026-03-15T00:57:49.688Z",
        "startTime": "2026-03-15T00:57:49.688Z"
      },
      "productValue": 12.5,
      "result": {
        "carrierParcelRef": "84168117830018",
        "carrierTrackingNumber": "84168117830018",
        "carrierTrackingStatus": "registered",
        "customsDocumentId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
        "customsDocumentUrl": "someCepProvider.com/pathToReturnLabel.pdf",
        "errors": {
          "labelError": "text",
          "returnLabelError": "text"
        },
        "labelUrl": "%%HOST%%/api/parcels/{parcelId}/labels/84168117830018.pdf",
        "proxyId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
        "returnLabelId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
        "returnLabelUrl": "someCepProvider.com/pathToReturnLabel.pdf",
        "returnTrackingUrl": "http://track.io/3a186c51d4",
        "sendLabelUrl": "someCepProvider.com/pathToSendLabel.pdf",
        "summary": "Package label was successfully requested at DHL.",
        "trackingStatus": "registered",
        "trackingUrl": "http://track.io/3a186c51d4"
      },
      "services": {
        "additionalTransportInsurance": true,
        "adultSignature": true,
        "bulkyGoods": true,
        "customerSignature": true,
        "identityCheckCompany": true,
        "identityCheckPrivate": true,
        "saturdayDelivery": true,
        "signature": true
      },
      "status": "OPEN",
      "tenantParcelId": "text"
    }
  ],
  "version": 42
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "anonymized": false,
  "carrierInformation": {
    "shippingContainerNumber": "123456-ABC"
  },
  "carrierProduct": "EXPRESS",
  "carrierRef": "cf00e102-34f2-45c1-a846-6a21f384321e",
  "customAttributes": {},
  "customProductValue": 12.5,
  "dimensions": {
    "customWeight": 1700,
    "height": 50,
    "length": 100,
    "weight": 1700,
    "width": 25
  },
  "documentsRef": "text",
  "facilityRef": "text",
  "id": "95EWrieX09OmeriXIUbb",
  "invoice": {
    "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."
  },
  "items": [
    {
      "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"
      ]
    }
  ],
  "loadUnitRefs": [
    "text"
  ],
  "operativeProcessRef": "text",
  "paymentInformation": {
    "currency": "EUR"
  },
  "pickUpInformation": {
    "endTime": "2026-03-15T00:57:49.688Z",
    "startTime": "2026-03-15T00:57:49.688Z"
  },
  "postalCharges": {
    "currency": "EUR",
    "value": 15.5
  },
  "processRef": "text",
  "productValue": 1250,
  "productValueCurrency": {
    "currency": "EUR",
    "decimalPlaces": 2
  },
  "productValueType": "INSURANCE",
  "recipient": {
    "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."
  },
  "result": {
    "carrierParcelRef": "84168117830018",
    "carrierTrackingNumber": "84168117830018",
    "carrierTrackingStatus": "registered",
    "customsDocumentId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "customsDocumentUrl": "someCepProvider.com/pathToReturnLabel.pdf",
    "errors": {
      "labelError": "text",
      "returnLabelError": "text"
    },
    "labelUrl": "%%HOST%%/api/parcels/{parcelId}/labels/84168117830018.pdf",
    "proxyId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "returnLabelId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "returnLabelUrl": "someCepProvider.com/pathToReturnLabel.pdf",
    "returnTrackingUrl": "http://track.io/3a186c51d4",
    "sendLabelUrl": "someCepProvider.com/pathToSendLabel.pdf",
    "summary": "Package label was successfully requested at DHL.",
    "trackingStatus": "registered",
    "trackingUrl": "http://track.io/3a186c51d4"
  },
  "returnAddress": {
    "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.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "sender": {
    "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.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "services": {
    "additionalTransportInsurance": true,
    "adultSignature": true,
    "bulkyGoods": true,
    "customerSignature": true,
    "identityCheckCompany": true,
    "identityCheckPrivate": true,
    "saturdayDelivery": true,
    "signature": true
  },
  "shipmentRef": "95EWrieX09OmeriXIUbb",
  "shortId": "AA12-1",
  "status": "OPEN",
  "tenantOrderId": "R456728546",
  "tenantParcelId": "MY-PARCEL-12345",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ]
}

Call parcel action

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

parcelIdstringRequired

Reference to the parcel you want to call an action for

Body

ParcelActionsParameter

Responses

200

Updated Parcel in the body.

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

post

/api/parcels/{parcelId}/actions

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

{
  "name": "SPLIT_LINES_PARCEL",
  "splitItemsInfo": [
    {
      "itemId": "text",
      "quantity": 21
    }
  ],
  "version": 42
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "anonymized": false,
  "carrierInformation": {
    "shippingContainerNumber": "123456-ABC"
  },
  "carrierProduct": "EXPRESS",
  "carrierRef": "cf00e102-34f2-45c1-a846-6a21f384321e",
  "customAttributes": {},
  "customProductValue": 12.5,
  "dimensions": {
    "customWeight": 1700,
    "height": 50,
    "length": 100,
    "weight": 1700,
    "width": 25
  },
  "documentsRef": "text",
  "facilityRef": "text",
  "id": "95EWrieX09OmeriXIUbb",
  "invoice": {
    "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."
  },
  "items": [
    {
      "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"
      ]
    }
  ],
  "loadUnitRefs": [
    "text"
  ],
  "operativeProcessRef": "text",
  "paymentInformation": {
    "currency": "EUR"
  },
  "pickUpInformation": {
    "endTime": "2026-03-15T00:57:49.688Z",
    "startTime": "2026-03-15T00:57:49.688Z"
  },
  "postalCharges": {
    "currency": "EUR",
    "value": 15.5
  },
  "processRef": "text",
  "productValue": 1250,
  "productValueCurrency": {
    "currency": "EUR",
    "decimalPlaces": 2
  },
  "productValueType": "INSURANCE",
  "recipient": {
    "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."
  },
  "result": {
    "carrierParcelRef": "84168117830018",
    "carrierTrackingNumber": "84168117830018",
    "carrierTrackingStatus": "registered",
    "customsDocumentId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "customsDocumentUrl": "someCepProvider.com/pathToReturnLabel.pdf",
    "errors": {
      "labelError": "text",
      "returnLabelError": "text"
    },
    "labelUrl": "%%HOST%%/api/parcels/{parcelId}/labels/84168117830018.pdf",
    "proxyId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "returnLabelId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "returnLabelUrl": "someCepProvider.com/pathToReturnLabel.pdf",
    "returnTrackingUrl": "http://track.io/3a186c51d4",
    "sendLabelUrl": "someCepProvider.com/pathToSendLabel.pdf",
    "summary": "Package label was successfully requested at DHL.",
    "trackingStatus": "registered",
    "trackingUrl": "http://track.io/3a186c51d4"
  },
  "returnAddress": {
    "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.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "sender": {
    "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.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "services": {
    "additionalTransportInsurance": true,
    "adultSignature": true,
    "bulkyGoods": true,
    "customerSignature": true,
    "identityCheckCompany": true,
    "identityCheckPrivate": true,
    "saturdayDelivery": true,
    "signature": true
  },
  "shipmentRef": "95EWrieX09OmeriXIUbb",
  "shortId": "AA12-1",
  "status": "OPEN",
  "tenantOrderId": "R456728546",
  "tenantParcelId": "MY-PARCEL-12345",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ]
}

Get parcel delivery note

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

parcelIdstringRequired

ID of parcel you want to retrieve deliveryNote for

Query parameters

localestringOptional

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

Responses

200

Get delivery note as pdf.

application/pdf

401

Your user is not allowed to operate against this API instance

application/pdf

403

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

application/pdf

404

Parcel not found

application/pdf

get

/api/parcels/{parcelId}/deliverynote

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

{
  "companyAddress": {
    "city": "Langenfeld",
    "country": "Germany",
    "houseNumber": "42a",
    "name": "OC fulfillment GmbH",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddress": {
    "city": "Langenfeld",
    "companyName": "OC Fulfillment GmbH",
    "firstName": "Maxine",
    "houseNumber": "42a",
    "lastName": "Muller",
    "personalTitle": "Prof.",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddresses": [
    {
      "city": "Langenfeld",
      "companyName": "OC Fulfillment GmbH",
      "firstName": "Maxine",
      "houseNumber": "42a",
      "lastName": "Muller",
      "personalTitle": "Prof.",
      "postalCode": "40764",
      "street": "Hauptstr."
    }
  ],
  "items": [
    {
      "id": "text",
      "quantity": "text",
      "substitutes": "text",
      "title": "text"
    }
  ],
  "orderInformation": {
    "orderDate": "2020-02-03T08:45:50.525Z",
    "orderNumber": "R456728546"
  }
}

Get parcel label

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

parcelIdstringRequired

ID of the parcel you want to get a label for

labelDocumentstring · enumRequired

The type of possible Parcel Labels

Possible values:

Responses

200

Parcel was found & you were allowed to access it. The label is in the body.

application/pdf

401

Your user is not allowed to operate against this API instance

application/pdf

403

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

application/pdf

404

Entity not found

application/pdf

get

/api/parcels/{parcelId}/labels/{labelDocument}

GET /api/parcels/{parcelId}/labels/{labelDocument} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Get parcel return note

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

parcelIdstringRequired

ID of parcel you want to retrieve returnNote for

Query parameters

localestringOptional

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

Responses

200

Get delivery note as pdf.

application/pdf

401

Your user is not allowed to operate against this API instance

application/pdf

403

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

application/pdf

404

Parcel not found

application/pdf

get

/api/parcels/{parcelId}/returnnote

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

{
  "companyAddress": {
    "city": "Langenfeld",
    "country": "Germany",
    "houseNumber": "42a",
    "name": "OC fulfillment GmbH",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddress": {
    "city": "Langenfeld",
    "companyName": "OC Fulfillment GmbH",
    "firstName": "Maxine",
    "houseNumber": "42a",
    "lastName": "Muller",
    "personalTitle": "Prof.",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddresses": [
    {
      "city": "Langenfeld",
      "companyName": "OC Fulfillment GmbH",
      "firstName": "Maxine",
      "houseNumber": "42a",
      "lastName": "Muller",
      "personalTitle": "Prof.",
      "postalCode": "40764",
      "street": "Hauptstr."
    }
  ],
  "items": [
    {
      "id": "text",
      "quantity": 1,
      "substitutes": "text",
      "title": "text"
    }
  ],
  "orderInformation": {
    "orderDate": "2020-02-03T08:45:50.525Z",
    "orderNumber": "R456728546"
  },
  "qrCodeContent": "text"
}

Get parcel transfer label

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

parcelIdstringRequired

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

Responses

200

The transfer label for the given parcel

application/pdf

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

404

Entity not found

application/json

get

/api/parcels/{parcelId}/transferlabel

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

List parcels (search)

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ParcelSearchPayload

afterstringOptional

The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.

beforestringOptional

The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).

lastnumber · min: 1 · max: 250Optional

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

sizenumber · min: 1 · max: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

post

/api/parcels/search

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

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "carrierRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-15T00:57:49.688Z",
              "gt": "2026-03-15T00:57:49.688Z",
              "gte": "2026-03-15T00:57:49.688Z",
              "lt": "2026-03-15T00:57:49.688Z",
              "lte": "2026-03-15T00:57:49.688Z",
              "notEq": "2026-03-15T00:57:49.688Z"
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "invoice": {
              "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"
                ]
              }
            },
            "items": {
              "contains": {
                "article": {
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            },
            "lastModified": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-15T00:57:49.688Z",
              "gt": "2026-03-15T00:57:49.688Z",
              "gte": "2026-03-15T00:57:49.688Z",
              "lt": "2026-03-15T00:57:49.688Z",
              "lte": "2026-03-15T00:57:49.688Z",
              "notEq": "2026-03-15T00:57:49.688Z"
            },
            "or": "[Circular Reference]",
            "recipient": {
              "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"
                ]
              }
            },
            "shipmentRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "shortId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            }
          }
        ],
        "carrierRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-15T00:57:49.688Z",
          "gt": "2026-03-15T00:57:49.688Z",
          "gte": "2026-03-15T00:57:49.688Z",
          "lt": "2026-03-15T00:57:49.688Z",
          "lte": "2026-03-15T00:57:49.688Z",
          "notEq": "2026-03-15T00:57:49.688Z"
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "invoice": {
          "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"
            ]
          }
        },
        "items": {
          "contains": {
            "article": {
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "title": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          }
        },
        "lastModified": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-15T00:57:49.688Z",
          "gt": "2026-03-15T00:57:49.688Z",
          "gte": "2026-03-15T00:57:49.688Z",
          "lt": "2026-03-15T00:57:49.688Z",
          "lte": "2026-03-15T00:57:49.688Z",
          "notEq": "2026-03-15T00:57:49.688Z"
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "carrierRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-15T00:57:49.688Z",
              "gt": "2026-03-15T00:57:49.688Z",
              "gte": "2026-03-15T00:57:49.688Z",
              "lt": "2026-03-15T00:57:49.688Z",
              "lte": "2026-03-15T00:57:49.688Z",
              "notEq": "2026-03-15T00:57:49.688Z"
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "invoice": {
              "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"
                ]
              }
            },
            "items": {
              "contains": {
                "article": {
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            },
            "lastModified": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-15T00:57:49.688Z",
              "gt": "2026-03-15T00:57:49.688Z",
              "gte": "2026-03-15T00:57:49.688Z",
              "lt": "2026-03-15T00:57:49.688Z",
              "lte": "2026-03-15T00:57:49.688Z",
              "notEq": "2026-03-15T00:57:49.688Z"
            },
            "or": "[Circular Reference]",
            "recipient": {
              "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"
                ]
              }
            },
            "shipmentRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "shortId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            }
          }
        ],
        "recipient": {
          "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"
            ]
          }
        },
        "shipmentRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "shortId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "status": {
          "eq": "OPEN",
          "in": [
            "OPEN"
          ],
          "notEq": "OPEN"
        }
      }
    ],
    "carrierRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "created": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-15T00:57:49.688Z",
      "gt": "2026-03-15T00:57:49.688Z",
      "gte": "2026-03-15T00:57:49.688Z",
      "lt": "2026-03-15T00:57:49.688Z",
      "lte": "2026-03-15T00:57:49.688Z",
      "notEq": "2026-03-15T00:57:49.688Z"
    },
    "facilityRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "invoice": {
      "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"
        ]
      }
    },
    "items": {
      "contains": {
        "article": {
          "tenantArticleId": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "title": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        }
      }
    },
    "lastModified": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-15T00:57:49.688Z",
      "gt": "2026-03-15T00:57:49.688Z",
      "gte": "2026-03-15T00:57:49.688Z",
      "lt": "2026-03-15T00:57:49.688Z",
      "lte": "2026-03-15T00:57:49.688Z",
      "notEq": "2026-03-15T00:57:49.688Z"
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "carrierRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-15T00:57:49.688Z",
          "gt": "2026-03-15T00:57:49.688Z",
          "gte": "2026-03-15T00:57:49.688Z",
          "lt": "2026-03-15T00:57:49.688Z",
          "lte": "2026-03-15T00:57:49.688Z",
          "notEq": "2026-03-15T00:57:49.688Z"
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "invoice": {
          "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"
            ]
          }
        },
        "items": {
          "contains": {
            "article": {
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "title": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          }
        },
        "lastModified": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-15T00:57:49.688Z",
          "gt": "2026-03-15T00:57:49.688Z",
          "gte": "2026-03-15T00:57:49.688Z",
          "lt": "2026-03-15T00:57:49.688Z",
          "lte": "2026-03-15T00:57:49.688Z",
          "notEq": "2026-03-15T00:57:49.688Z"
        },
        "or": "[Circular Reference]",
        "recipient": {
          "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"
            ]
          }
        },
        "shipmentRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "shortId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "status": {
          "eq": "OPEN",
          "in": [
            "OPEN"
          ],
          "notEq": "OPEN"
        }
      }
    ],
    "recipient": {
      "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"
        ]
      }
    },
    "shipmentRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "shortId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "status": {
      "eq": "OPEN",
      "in": [
        "OPEN"
      ],
      "notEq": "OPEN"
    }
  },
  "size": 1,
  "sort": [
    {
      "created": "ASC",
      "lastModified": "ASC"
    }
  ]
}

{
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "parcels": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42,
      "anonymized": false,
      "carrierInformation": {
        "shippingContainerNumber": "123456-ABC"
      },
      "carrierProduct": "EXPRESS",
      "carrierRef": "cf00e102-34f2-45c1-a846-6a21f384321e",
      "customAttributes": {},
      "customProductValue": 12.5,
      "dimensions": {
        "customWeight": 1700,
        "height": 50,
        "length": 100,
        "weight": 1700,
        "width": 25
      },
      "documentsRef": "text",
      "facilityRef": "text",
      "id": "95EWrieX09OmeriXIUbb",
      "invoice": {
        "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."
      },
      "items": [
        {
          "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"
          ]
        }
      ],
      "loadUnitRefs": [
        "text"
      ],
      "operativeProcessRef": "text",
      "paymentInformation": {
        "currency": "EUR"
      },
      "pickUpInformation": {
        "endTime": "2026-03-15T00:57:49.688Z",
        "startTime": "2026-03-15T00:57:49.688Z"
      },
      "postalCharges": {
        "currency": "EUR",
        "value": 15.5
      },
      "processRef": "text",
      "productValue": 1250,
      "productValueCurrency": {
        "currency": "EUR",
        "decimalPlaces": 2
      },
      "productValueType": "INSURANCE",
      "recipient": {
        "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."
      },
      "result": {
        "carrierParcelRef": "84168117830018",
        "carrierTrackingNumber": "84168117830018",
        "carrierTrackingStatus": "registered",
        "customsDocumentId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
        "customsDocumentUrl": "someCepProvider.com/pathToReturnLabel.pdf",
        "errors": {
          "labelError": "text",
          "returnLabelError": "text"
        },
        "labelUrl": "%%HOST%%/api/parcels/{parcelId}/labels/84168117830018.pdf",
        "proxyId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
        "returnLabelId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
        "returnLabelUrl": "someCepProvider.com/pathToReturnLabel.pdf",
        "returnTrackingUrl": "http://track.io/3a186c51d4",
        "sendLabelUrl": "someCepProvider.com/pathToSendLabel.pdf",
        "summary": "Package label was successfully requested at DHL.",
        "trackingStatus": "registered",
        "trackingUrl": "http://track.io/3a186c51d4"
      },
      "returnAddress": {
        "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.",
        "companyName": "Speedy Boxales Ltd.",
        "emailAddresses": [
          {
            "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
            "value": "text"
          }
        ],
        "resolvedCoordinates": {
          "lat": 50.937531,
          "lon": 6.960279
        },
        "resolvedTimeZone": {
          "offsetInSeconds": 28800,
          "source": "Google Maps API",
          "timeZoneId": "America/Los_Angeles",
          "timeZoneName": "Pacific Standard Time"
        }
      },
      "sender": {
        "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.",
        "companyName": "Speedy Boxales Ltd.",
        "emailAddresses": [
          {
            "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
            "value": "text"
          }
        ],
        "resolvedCoordinates": {
          "lat": 50.937531,
          "lon": 6.960279
        },
        "resolvedTimeZone": {
          "offsetInSeconds": 28800,
          "source": "Google Maps API",
          "timeZoneId": "America/Los_Angeles",
          "timeZoneName": "Pacific Standard Time"
        }
      },
      "services": {
        "additionalTransportInsurance": true,
        "adultSignature": true,
        "bulkyGoods": true,
        "customerSignature": true,
        "identityCheckCompany": true,
        "identityCheckPrivate": true,
        "saturdayDelivery": true,
        "signature": true
      },
      "shipmentRef": "95EWrieX09OmeriXIUbb",
      "shortId": "AA12-1",
      "status": "OPEN",
      "tenantOrderId": "R456728546",
      "tenantParcelId": "MY-PARCEL-12345",
      "transfers": [
        {
          "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
          "type": "RECEIVER"
        }
      ]
    }
  ],
  "total": 1
}

Create return note

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

localestringOptional

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

Body

ReturnNote

qrCodeContentstringOptional

Responses

201

Successfully created the return note.

application/pdf

ReturnNote

qrCodeContentstringOptional

401

Your user is not allowed to operate against this API instance

application/pdf

403

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

application/pdf

post

/api/returnnotes

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

{
  "companyAddress": {
    "city": "Langenfeld",
    "country": "Germany",
    "houseNumber": "42a",
    "name": "OC fulfillment GmbH",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddress": {
    "city": "Langenfeld",
    "companyName": "OC Fulfillment GmbH",
    "firstName": "Maxine",
    "houseNumber": "42a",
    "lastName": "Muller",
    "personalTitle": "Prof.",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddresses": [
    {
      "city": "Langenfeld",
      "companyName": "OC Fulfillment GmbH",
      "firstName": "Maxine",
      "houseNumber": "42a",
      "lastName": "Muller",
      "personalTitle": "Prof.",
      "postalCode": "40764",
      "street": "Hauptstr."
    }
  ],
  "items": [
    {
      "id": "text",
      "quantity": 1,
      "substitutes": "text",
      "title": "text"
    }
  ],
  "orderInformation": {
    "orderDate": "2020-02-03T08:45:50.525Z",
    "orderNumber": "R456728546"
  },
  "qrCodeContent": "text"
}

{
  "companyAddress": {
    "city": "Langenfeld",
    "country": "Germany",
    "houseNumber": "42a",
    "name": "OC fulfillment GmbH",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddress": {
    "city": "Langenfeld",
    "companyName": "OC Fulfillment GmbH",
    "firstName": "Maxine",
    "houseNumber": "42a",
    "lastName": "Muller",
    "personalTitle": "Prof.",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddresses": [
    {
      "city": "Langenfeld",
      "companyName": "OC Fulfillment GmbH",
      "firstName": "Maxine",
      "houseNumber": "42a",
      "lastName": "Muller",
      "personalTitle": "Prof.",
      "postalCode": "40764",
      "street": "Hauptstr."
    }
  ],
  "items": [
    {
      "id": "text",
      "quantity": 1,
      "substitutes": "text",
      "title": "text"
    }
  ],
  "orderInformation": {
    "orderDate": "2020-02-03T08:45:50.525Z",
    "orderNumber": "R456728546"
  },
  "qrCodeContent": "text"
}

List shipments

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 shipments for a referenced pickjob

facilityRefstringOptional

This query can be used to find shipments belonging to the referenced facility

carrierRefstringOptional

This query can be used to find shipments for a referenced carrier

tenantOrderIdstringOptional

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

carrierKeysstring[]Optional

Find shipments with one the the given carriers

statusstring[]Optional

Find shipments in one of the given status

parcelStatusstring[]Optional

Find shipments with parcels in one of the given status

startTargetTimestring · date-timeOptional

Start date range for shipments

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

endTargetTimestring · date-timeOptional

End date range for shipments

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

anonymizedbooleanOptional

Parameter to filter anonymized shipments

searchTermstringOptional

Fulltext search in shipment's tenantOrderId, shortId, parcels.carrierTrackingNumber, lineItems.article.tenantArticleId, lineItems.article.title, invoiceAddress, targetAddress and customerName

Responses

200

Shipments are found.

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

get

/api/shipments

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

{
  "shipments": [
    {
      "carrierLogoUrl": "text",
      "carrierProduct": "EXPRESS",
      "carrierRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
      "carrierServices": [
        "SIGNATURE"
      ],
      "customAttributes": {},
      "facilityRef": "text",
      "invoiceAddress": {
        "addressType": "POSTAL_ADDRESS",
        "companyName": "Speedy Boxales Ltd.",
        "coordinates": {
          "lat": 50.937531,
          "lon": 6.960279
        },
        "email": "[email protected]",
        "firstName": "Maxine",
        "lastName": "Muller",
        "personalTitle": "Dr.",
        "salutation": "Frau",
        "additionalAddressInfo": "to care of: Mrs. Müller",
        "city": "Langenfeld",
        "country": "DE",
        "customAttributes": {},
        "houseNumber": "42a",
        "phoneNumbers": [
          {
            "customAttributes": {},
            "label": "text",
            "type": "MOBILE",
            "value": "text"
          }
        ],
        "postalCode": "40764",
        "province": "NRW",
        "street": "Hauptstr."
      },
      "lineItems": [
        {
          "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": {},
          "measurementUnitKey": "liter",
          "quantity": 21,
          "recordableAttributes": [
            {
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "group": "general",
              "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
              "key": "country of origin",
              "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
              "recordingRule": "MANDATORY",
              "value": "Germany"
            }
          ],
          "scannableCodes": [
            "text"
          ],
          "tags": [],
          "id": "climk4dcQFiPdA5ULuhS"
        }
      ],
      "operativeProcessRef": "text",
      "orderDate": "2026-03-15T00:57:49.688Z",
      "paymentInformation": {
        "currency": "EUR"
      },
      "pickJobRef": "Esb20gpHBL94X5NdMp3C",
      "postalAddress": {
        "addressType": "POSTAL_ADDRESS",
        "companyName": "Speedy Boxales Ltd.",
        "coordinates": {
          "lat": 50.937531,
          "lon": 6.960279
        },
        "email": "[email protected]",
        "firstName": "Maxine",
        "lastName": "Muller",
        "personalTitle": "Dr.",
        "salutation": "Frau",
        "additionalAddressInfo": "to care of: Mrs. Müller",
        "city": "Langenfeld",
        "country": "DE",
        "customAttributes": {},
        "houseNumber": "42a",
        "phoneNumbers": [
          {
            "customAttributes": {},
            "label": "text",
            "type": "MOBILE",
            "value": "text"
          }
        ],
        "postalCode": "40764",
        "province": "NRW",
        "street": "Hauptstr."
      },
      "processId": "text",
      "shortId": "text",
      "sourceAddress": {
        "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.",
        "companyName": "Speedy Boxales Ltd.",
        "emailAddresses": [
          {
            "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
            "value": "text"
          }
        ],
        "resolvedCoordinates": {
          "lat": 50.937531,
          "lon": 6.960279
        },
        "resolvedTimeZone": {
          "offsetInSeconds": 28800,
          "source": "Google Maps API",
          "timeZoneId": "America/Los_Angeles",
          "timeZoneName": "Pacific Standard Time"
        }
      },
      "targetAddress": {
        "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."
      },
      "targetTime": "2020-02-03T09:45:51.525Z",
      "targetTimeBaseDate": "2020-02-03T08:45:50.525Z",
      "tenantOrderId": "text",
      "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,
      "carrierKey": "DPD",
      "hasActiveCarrier": false,
      "id": "95EWrieX09OmeriXIUbb",
      "parcels": [
        {
          "carrierRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
          "carrierTrackingNumber": "84168117830018",
          "parcelRef": "15EZrieW09OmeriXIUbc",
          "status": "OPEN"
        }
      ],
      "status": "INITIAL"
    },
    {
      "searchPaths": [
        "text"
      ]
    }
  ],
  "total": 42
}

Create shipment

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ShipmentForCreation

carrierLogoUrlstringOptional

The URL to the carrier logo

carrierProductstringOptional

Desired product of given carrier to choose when ordering a label

Example: EXPRESS

carrierRefstringOptional

The reference to the carrier for which the shipment is assigned to

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

customAttributesobjectOptional

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

facilityRefstringRequired

The reference to the facility which the shipment is assigned to.

operativeProcessRefstringOptional

orderDatestring · date-timeRequired

The date this order was created at the supplying system.

pickJobRefstringOptional

The id of the facility reference.

Example: Esb20gpHBL94X5NdMp3C

processIdstringOptional

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

shortIdstringOptional

The short identifier of the shipment.

targetTimestring · date-timeRequired

At which time the result is expected.

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

targetTimeBaseDatestring · date-timeOptional

The start date for the targetTime calculation.

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

tenantOrderIdstringOptional

Reference to the order in the tenant system.

Responses

201

The Shipment was successfully created. The Location header contains the URL of the Shipment.

application/json

Shipment

303

The Shipment already exists. The Location header contains the URL of the Shipment.

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

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

{
  "carrierLogoUrl": "text",
  "carrierProduct": "EXPRESS",
  "carrierRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
  "carrierServices": [
    "SIGNATURE"
  ],
  "customAttributes": {},
  "facilityRef": "text",
  "invoiceAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "lineItems": [
    {
      "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": {},
      "measurementUnitKey": "liter",
      "quantity": 21,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "tags": []
    }
  ],
  "operativeProcessRef": "text",
  "orderDate": "2026-03-15T00:57:49.688Z",
  "paymentInformation": {
    "currency": "EUR"
  },
  "pickJobRef": "Esb20gpHBL94X5NdMp3C",
  "postalAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "processId": "text",
  "shortId": "text",
  "sourceAddress": {
    "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.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "targetAddress": {
    "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."
  },
  "targetTime": "2020-02-03T09:45:51.525Z",
  "targetTimeBaseDate": "2020-02-03T08:45:50.525Z",
  "tenantOrderId": "text",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ],
  "tags": []
}

{
  "carrierLogoUrl": "text",
  "carrierProduct": "EXPRESS",
  "carrierRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
  "carrierServices": [
    "SIGNATURE"
  ],
  "customAttributes": {},
  "facilityRef": "text",
  "invoiceAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "lineItems": [
    {
      "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": {},
      "measurementUnitKey": "liter",
      "quantity": 21,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "tags": [],
      "id": "climk4dcQFiPdA5ULuhS"
    }
  ],
  "operativeProcessRef": "text",
  "orderDate": "2026-03-15T00:57:49.688Z",
  "paymentInformation": {
    "currency": "EUR"
  },
  "pickJobRef": "Esb20gpHBL94X5NdMp3C",
  "postalAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "processId": "text",
  "shortId": "text",
  "sourceAddress": {
    "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.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "targetAddress": {
    "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."
  },
  "targetTime": "2020-02-03T09:45:51.525Z",
  "targetTimeBaseDate": "2020-02-03T08:45:50.525Z",
  "tenantOrderId": "text",
  "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,
  "carrierKey": "DPD",
  "hasActiveCarrier": false,
  "id": "95EWrieX09OmeriXIUbb",
  "parcels": [
    {
      "carrierRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
      "carrierTrackingNumber": "84168117830018",
      "parcelRef": "15EZrieW09OmeriXIUbc",
      "status": "OPEN"
    }
  ],
  "status": "INITIAL"
}

Get shipment

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

shipmentIdstringRequired

ID of Shipment you want to get

Responses

200

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

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

404

Shipment not found

application/json

get

/api/shipments/{shipmentId}

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

{
  "carrierLogoUrl": "text",
  "carrierProduct": "EXPRESS",
  "carrierRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
  "carrierServices": [
    "SIGNATURE"
  ],
  "customAttributes": {},
  "facilityRef": "text",
  "invoiceAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "lineItems": [
    {
      "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": {},
      "measurementUnitKey": "liter",
      "quantity": 21,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "tags": [],
      "id": "climk4dcQFiPdA5ULuhS"
    }
  ],
  "operativeProcessRef": "text",
  "orderDate": "2026-03-15T00:57:49.688Z",
  "paymentInformation": {
    "currency": "EUR"
  },
  "pickJobRef": "Esb20gpHBL94X5NdMp3C",
  "postalAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "processId": "text",
  "shortId": "text",
  "sourceAddress": {
    "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.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "targetAddress": {
    "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."
  },
  "targetTime": "2020-02-03T09:45:51.525Z",
  "targetTimeBaseDate": "2020-02-03T08:45:50.525Z",
  "tenantOrderId": "text",
  "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,
  "carrierKey": "DPD",
  "hasActiveCarrier": false,
  "id": "95EWrieX09OmeriXIUbb",
  "parcels": [
    {
      "carrierRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
      "carrierTrackingNumber": "84168117830018",
      "parcelRef": "15EZrieW09OmeriXIUbc",
      "status": "OPEN"
    }
  ],
  "status": "INITIAL"
}

Update shipment

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

shipmentIdstringRequired

ID of shipment you want to patch

Body

ShipmentPatchActions

versioninteger · int64Required

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

Example: 42

Responses

200

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

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

404

Entity not found

application/json

409

Entity version conflict

application/json

patch

/api/shipments/{shipmentId}

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

{
  "actions": [
    {
      "action": "ModifyShipment",
      "carrierProduct": "EXPRESS",
      "carrierRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
      "paymentInformation": {
        "currency": "EUR"
      },
      "pickJobRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
      "status": "INITIAL",
      "targetAddress": {
        "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."
      }
    }
  ],
  "version": 42
}

{
  "carrierLogoUrl": "text",
  "carrierProduct": "EXPRESS",
  "carrierRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
  "carrierServices": [
    "SIGNATURE"
  ],
  "customAttributes": {},
  "facilityRef": "text",
  "invoiceAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "lineItems": [
    {
      "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": {},
      "measurementUnitKey": "liter",
      "quantity": 21,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "tags": [],
      "id": "climk4dcQFiPdA5ULuhS"
    }
  ],
  "operativeProcessRef": "text",
  "orderDate": "2026-03-15T00:57:49.688Z",
  "paymentInformation": {
    "currency": "EUR"
  },
  "pickJobRef": "Esb20gpHBL94X5NdMp3C",
  "postalAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "processId": "text",
  "shortId": "text",
  "sourceAddress": {
    "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.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "targetAddress": {
    "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."
  },
  "targetTime": "2020-02-03T09:45:51.525Z",
  "targetTimeBaseDate": "2020-02-03T08:45:50.525Z",
  "tenantOrderId": "text",
  "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,
  "carrierKey": "DPD",
  "hasActiveCarrier": false,
  "id": "95EWrieX09OmeriXIUbb",
  "parcels": [
    {
      "carrierRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
      "carrierTrackingNumber": "84168117830018",
      "parcelRef": "15EZrieW09OmeriXIUbc",
      "status": "OPEN"
    }
  ],
  "status": "INITIAL"
}

Call shipment action

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

shipmentIdstringRequired

Reference to the shipment you want to call an action for

Body

ShipmentActionsParameter

Responses

200

Updated Shipment in the body.

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

post

/api/shipments/{shipmentId}/actions

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

{
  "name": "SPLIT_LINE_LINES_SHIPMENT",
  "splitLineItemsInfo": [
    {
      "lineItemId": "text",
      "quantity": 21
    }
  ],
  "version": 42
}

{
  "carrierLogoUrl": "text",
  "carrierProduct": "EXPRESS",
  "carrierRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
  "carrierServices": [
    "SIGNATURE"
  ],
  "customAttributes": {},
  "facilityRef": "text",
  "invoiceAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "lineItems": [
    {
      "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": {},
      "measurementUnitKey": "liter",
      "quantity": 21,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "tags": [],
      "id": "climk4dcQFiPdA5ULuhS"
    }
  ],
  "operativeProcessRef": "text",
  "orderDate": "2026-03-15T00:57:49.688Z",
  "paymentInformation": {
    "currency": "EUR"
  },
  "pickJobRef": "Esb20gpHBL94X5NdMp3C",
  "postalAddress": {
    "addressType": "POSTAL_ADDRESS",
    "companyName": "Speedy Boxales Ltd.",
    "coordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "email": "[email protected]",
    "firstName": "Maxine",
    "lastName": "Muller",
    "personalTitle": "Dr.",
    "salutation": "Frau",
    "additionalAddressInfo": "to care of: Mrs. Müller",
    "city": "Langenfeld",
    "country": "DE",
    "customAttributes": {},
    "houseNumber": "42a",
    "phoneNumbers": [
      {
        "customAttributes": {},
        "label": "text",
        "type": "MOBILE",
        "value": "text"
      }
    ],
    "postalCode": "40764",
    "province": "NRW",
    "street": "Hauptstr."
  },
  "processId": "text",
  "shortId": "text",
  "sourceAddress": {
    "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.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "targetAddress": {
    "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."
  },
  "targetTime": "2020-02-03T09:45:51.525Z",
  "targetTimeBaseDate": "2020-02-03T08:45:50.525Z",
  "tenantOrderId": "text",
  "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,
  "carrierKey": "DPD",
  "hasActiveCarrier": false,
  "id": "95EWrieX09OmeriXIUbb",
  "parcels": [
    {
      "carrierRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
      "carrierTrackingNumber": "84168117830018",
      "parcelRef": "15EZrieW09OmeriXIUbc",
      "status": "OPEN"
    }
  ],
  "status": "INITIAL"
}

Get shipment delivery note

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

shipmentIdstringRequired

ID of shipment you want to retrieve delivery note for

Query parameters

localestringOptional

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

Responses

200

Get delivery note as pdf.

application/pdf

401

Your user is not allowed to operate against this API instance

application/pdf

403

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

application/pdf

404

Shipment not found

application/pdf

get

/api/shipments/{shipmentId}/deliverynote

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

{
  "companyAddress": {
    "city": "Langenfeld",
    "country": "Germany",
    "houseNumber": "42a",
    "name": "OC fulfillment GmbH",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddress": {
    "city": "Langenfeld",
    "companyName": "OC Fulfillment GmbH",
    "firstName": "Maxine",
    "houseNumber": "42a",
    "lastName": "Muller",
    "personalTitle": "Prof.",
    "postalCode": "40764",
    "street": "Hauptstr."
  },
  "deliveryAddresses": [
    {
      "city": "Langenfeld",
      "companyName": "OC Fulfillment GmbH",
      "firstName": "Maxine",
      "houseNumber": "42a",
      "lastName": "Muller",
      "personalTitle": "Prof.",
      "postalCode": "40764",
      "street": "Hauptstr."
    }
  ],
  "items": [
    {
      "id": "text",
      "quantity": "text",
      "substitutes": "text",
      "title": "text"
    }
  ],
  "orderInformation": {
    "orderDate": "2020-02-03T08:45:50.525Z",
    "orderNumber": "R456728546"
  }
}

Create shipment parcel

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

shipmentIdstringRequired

ID of shipment you want to create parcel for

Body

ParcelForCreation

carrierProductstringOptional

Desired product of given carrier to choose when ordering a label

Example: EXPRESS

carrierRefstringOptional

references the carrier to be used for sending. Can not be set when creating a parcel for an existing shipment.

customAttributesobjectOptional

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

customProductValuenumberOptional

Set this value if you want to overwrite the calculated product value of the parcel.

Example: 12.5

loadUnitRefsstring[]Optional

Reference to array of load unit Refs

productValuenumberOptional

Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency. This value is calculated from the items in the parcel.

Example: 12.5

productValueTypestring · enumOptional

ProductValueType

Example: INSURANCEPossible values:

shortIdstringOptionalExample: AA12-1

statusstring · enumOptional

ParcelStatus

Possible values:

tenantOrderIdstringOptional

Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.

Example: R456728546

tenantParcelIdstringOptional

Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel

Example: MY-PARCEL-12345

Responses

201

The Parcel was successfully created. The Location header contains the URL of the Shipment.

application/json

Parcel

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

422

Parcel could not be processed due to failing conditions

application/json

post

/api/shipments/{shipmentId}/parcels

POST /api/shipments/{shipmentId}/parcels HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 4281

{
  "carrierInformation": {
    "shippingContainerNumber": "123456-ABC"
  },
  "carrierProduct": "EXPRESS",
  "carrierRef": "text",
  "customAttributes": {},
  "customProductValue": 12.5,
  "dimensions": {
    "customWeight": 1700,
    "height": 50,
    "length": 100,
    "weight": 1700,
    "width": 25
  },
  "invoice": {
    "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."
  },
  "items": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "quantity": 1,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "loadUnitRefs": [
    "text"
  ],
  "paymentInformation": {
    "currency": "EUR"
  },
  "pickUpInformation": {
    "endTime": "2026-03-15T00:57:49.688Z",
    "startTime": "2026-03-15T00:57:49.688Z"
  },
  "productValue": 12.5,
  "productValueCurrency": {
    "currency": "EUR",
    "decimalPlaces": 2
  },
  "productValueType": "INSURANCE",
  "recipient": {
    "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."
  },
  "result": {
    "carrierParcelRef": "84168117830018",
    "carrierTrackingNumber": "84168117830018",
    "carrierTrackingStatus": "registered",
    "customsDocumentId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "customsDocumentUrl": "someCepProvider.com/pathToReturnLabel.pdf",
    "errors": {
      "labelError": "text",
      "returnLabelError": "text"
    },
    "labelUrl": "%%HOST%%/api/parcels/{parcelId}/labels/84168117830018.pdf",
    "proxyId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "returnLabelId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "returnLabelUrl": "someCepProvider.com/pathToReturnLabel.pdf",
    "returnTrackingUrl": "http://track.io/3a186c51d4",
    "sendLabelUrl": "someCepProvider.com/pathToSendLabel.pdf",
    "summary": "Package label was successfully requested at DHL.",
    "trackingStatus": "registered",
    "trackingUrl": "http://track.io/3a186c51d4"
  },
  "returnAddress": {
    "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.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "sender": {
    "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.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "services": {
    "additionalTransportInsurance": true,
    "adultSignature": true,
    "bulkyGoods": true,
    "customerSignature": true,
    "identityCheckCompany": true,
    "identityCheckPrivate": true,
    "saturdayDelivery": true,
    "signature": true
  },
  "shortId": "AA12-1",
  "status": "OPEN",
  "tenantOrderId": "R456728546",
  "tenantParcelId": "MY-PARCEL-12345",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ]
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "anonymized": false,
  "carrierInformation": {
    "shippingContainerNumber": "123456-ABC"
  },
  "carrierProduct": "EXPRESS",
  "carrierRef": "cf00e102-34f2-45c1-a846-6a21f384321e",
  "customAttributes": {},
  "customProductValue": 12.5,
  "dimensions": {
    "customWeight": 1700,
    "height": 50,
    "length": 100,
    "weight": 1700,
    "width": 25
  },
  "documentsRef": "text",
  "facilityRef": "text",
  "id": "95EWrieX09OmeriXIUbb",
  "invoice": {
    "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."
  },
  "items": [
    {
      "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"
      ]
    }
  ],
  "loadUnitRefs": [
    "text"
  ],
  "operativeProcessRef": "text",
  "paymentInformation": {
    "currency": "EUR"
  },
  "pickUpInformation": {
    "endTime": "2026-03-15T00:57:49.688Z",
    "startTime": "2026-03-15T00:57:49.688Z"
  },
  "postalCharges": {
    "currency": "EUR",
    "value": 15.5
  },
  "processRef": "text",
  "productValue": 1250,
  "productValueCurrency": {
    "currency": "EUR",
    "decimalPlaces": 2
  },
  "productValueType": "INSURANCE",
  "recipient": {
    "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."
  },
  "result": {
    "carrierParcelRef": "84168117830018",
    "carrierTrackingNumber": "84168117830018",
    "carrierTrackingStatus": "registered",
    "customsDocumentId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "customsDocumentUrl": "someCepProvider.com/pathToReturnLabel.pdf",
    "errors": {
      "labelError": "text",
      "returnLabelError": "text"
    },
    "labelUrl": "%%HOST%%/api/parcels/{parcelId}/labels/84168117830018.pdf",
    "proxyId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "returnLabelId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "returnLabelUrl": "someCepProvider.com/pathToReturnLabel.pdf",
    "returnTrackingUrl": "http://track.io/3a186c51d4",
    "sendLabelUrl": "someCepProvider.com/pathToSendLabel.pdf",
    "summary": "Package label was successfully requested at DHL.",
    "trackingStatus": "registered",
    "trackingUrl": "http://track.io/3a186c51d4"
  },
  "returnAddress": {
    "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.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "sender": {
    "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.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "services": {
    "additionalTransportInsurance": true,
    "adultSignature": true,
    "bulkyGoods": true,
    "customerSignature": true,
    "identityCheckCompany": true,
    "identityCheckPrivate": true,
    "saturdayDelivery": true,
    "signature": true
  },
  "shipmentRef": "95EWrieX09OmeriXIUbb",
  "shortId": "AA12-1",
  "status": "OPEN",
  "tenantOrderId": "R456728546",
  "tenantParcelId": "MY-PARCEL-12345",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ]
}

Create parcel

post

This endpoints directly creates a parcel. If no ShipmentRef was provided, a shipment will be created and linked to this parcel

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ParcelForDirectCreation

carrierProductstringOptional

Desired product of given carrier to choose when ordering a label

Example: EXPRESS

carrierRefstringRequired

references the carrier to be used for sending. Can not be set when creating a parcel for an existing shipment.

customAttributesobjectOptional

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

customProductValuenumberOptional

Set this value if you want to overwrite the calculated product value of the parcel.

Example: 12.5

facilityRefstringRequired

Reference to the facility this parcel is created for

Example: 95EWrieX09OmeriXIUbb

loadUnitRefsstring[]Optional

Reference to array of load unit Refs

operativeProcessRefstringOptional

Reference to the operative process this parcel is created for

Example: 95EWrieX09OmeriXIUbb

orderDatestring · date-timeOptional

Date when the order for the given parcel has been placed Mandatory when no shipmentRef was provided

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

processRefstringOptional

Reference to the process this parcel is created for

Example: 95EWrieX09OmeriXIUbb

productValuenumberOptional

Example: 12.5

productValueTypestring · enumOptional

ProductValueType

Example: INSURANCEPossible values:

shipmentRefstringOptional

Reference to the shipment this parcel is created for. If non provided, a shipment will be created automatically.

Example: 95EWrieX09OmeriXIUbb

shortIdstringOptionalExample: AA12-1

statusstring · enumOptional

ParcelStatus

Possible values:

targetTimestring · date-timeOptional

The target time for the parcel to be delivered. If not provided, the current time will be used.

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

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

tenantParcelIdstringOptional

Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel

Example: MY-PARCEL-12345

Responses

201

Parcel was successfully created

application/json

Parcel

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/shipments/parcels

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

{
  "carrierProduct": "EXPRESS",
  "carrierRef": "text",
  "customAttributes": {},
  "customProductValue": 12.5,
  "dimensions": {
    "customWeight": 1700,
    "height": 50,
    "length": 100,
    "weight": 1700,
    "width": 25
  },
  "facilityRef": "95EWrieX09OmeriXIUbb",
  "invoice": {
    "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."
  },
  "items": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "quantity": 1,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "loadUnitRefs": [
    "text"
  ],
  "operativeProcessRef": "95EWrieX09OmeriXIUbb",
  "orderDate": "2020-02-03T08:45:50.525Z",
  "paymentInformation": {
    "currency": "EUR"
  },
  "pickUpInformation": {
    "endTime": "2026-03-15T00:57:49.688Z",
    "startTime": "2026-03-15T00:57:49.688Z"
  },
  "processRef": "95EWrieX09OmeriXIUbb",
  "productValue": 12.5,
  "productValueCurrency": {
    "currency": "EUR",
    "decimalPlaces": 2
  },
  "productValueType": "INSURANCE",
  "recipient": {
    "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."
  },
  "result": {
    "carrierParcelRef": "84168117830018",
    "carrierTrackingNumber": "84168117830018",
    "carrierTrackingStatus": "registered",
    "customsDocumentId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "customsDocumentUrl": "someCepProvider.com/pathToReturnLabel.pdf",
    "errors": {
      "labelError": "text",
      "returnLabelError": "text"
    },
    "labelUrl": "%%HOST%%/api/parcels/{parcelId}/labels/84168117830018.pdf",
    "proxyId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "returnLabelId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "returnLabelUrl": "someCepProvider.com/pathToReturnLabel.pdf",
    "returnTrackingUrl": "http://track.io/3a186c51d4",
    "sendLabelUrl": "someCepProvider.com/pathToSendLabel.pdf",
    "summary": "Package label was successfully requested at DHL.",
    "trackingStatus": "registered",
    "trackingUrl": "http://track.io/3a186c51d4"
  },
  "returnAddress": {
    "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.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "sender": {
    "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.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "services": {
    "additionalTransportInsurance": true,
    "adultSignature": true,
    "bulkyGoods": true,
    "customerSignature": true,
    "identityCheckCompany": true,
    "identityCheckPrivate": true,
    "saturdayDelivery": true,
    "signature": true
  },
  "shipmentRef": "95EWrieX09OmeriXIUbb",
  "shortId": "AA12-1",
  "status": "OPEN",
  "targetTime": "2020-02-03T08:45:50.525Z",
  "tenantOrderId": "R456728546",
  "tenantParcelId": "MY-PARCEL-12345"
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "anonymized": false,
  "carrierInformation": {
    "shippingContainerNumber": "123456-ABC"
  },
  "carrierProduct": "EXPRESS",
  "carrierRef": "cf00e102-34f2-45c1-a846-6a21f384321e",
  "customAttributes": {},
  "customProductValue": 12.5,
  "dimensions": {
    "customWeight": 1700,
    "height": 50,
    "length": 100,
    "weight": 1700,
    "width": 25
  },
  "documentsRef": "text",
  "facilityRef": "text",
  "id": "95EWrieX09OmeriXIUbb",
  "invoice": {
    "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."
  },
  "items": [
    {
      "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"
      ]
    }
  ],
  "loadUnitRefs": [
    "text"
  ],
  "operativeProcessRef": "text",
  "paymentInformation": {
    "currency": "EUR"
  },
  "pickUpInformation": {
    "endTime": "2026-03-15T00:57:49.688Z",
    "startTime": "2026-03-15T00:57:49.688Z"
  },
  "postalCharges": {
    "currency": "EUR",
    "value": 15.5
  },
  "processRef": "text",
  "productValue": 1250,
  "productValueCurrency": {
    "currency": "EUR",
    "decimalPlaces": 2
  },
  "productValueType": "INSURANCE",
  "recipient": {
    "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."
  },
  "result": {
    "carrierParcelRef": "84168117830018",
    "carrierTrackingNumber": "84168117830018",
    "carrierTrackingStatus": "registered",
    "customsDocumentId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "customsDocumentUrl": "someCepProvider.com/pathToReturnLabel.pdf",
    "errors": {
      "labelError": "text",
      "returnLabelError": "text"
    },
    "labelUrl": "%%HOST%%/api/parcels/{parcelId}/labels/84168117830018.pdf",
    "proxyId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "returnLabelId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
    "returnLabelUrl": "someCepProvider.com/pathToReturnLabel.pdf",
    "returnTrackingUrl": "http://track.io/3a186c51d4",
    "sendLabelUrl": "someCepProvider.com/pathToSendLabel.pdf",
    "summary": "Package label was successfully requested at DHL.",
    "trackingStatus": "registered",
    "trackingUrl": "http://track.io/3a186c51d4"
  },
  "returnAddress": {
    "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.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "sender": {
    "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.",
    "companyName": "Speedy Boxales Ltd.",
    "emailAddresses": [
      {
        "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
        "value": "text"
      }
    ],
    "resolvedCoordinates": {
      "lat": 50.937531,
      "lon": 6.960279
    },
    "resolvedTimeZone": {
      "offsetInSeconds": 28800,
      "source": "Google Maps API",
      "timeZoneId": "America/Los_Angeles",
      "timeZoneName": "Pacific Standard Time"
    }
  },
  "services": {
    "additionalTransportInsurance": true,
    "adultSignature": true,
    "bulkyGoods": true,
    "customerSignature": true,
    "identityCheckCompany": true,
    "identityCheckPrivate": true,
    "saturdayDelivery": true,
    "signature": true
  },
  "shipmentRef": "95EWrieX09OmeriXIUbb",
  "shortId": "AA12-1",
  "status": "OPEN",
  "tenantOrderId": "R456728546",
  "tenantParcelId": "MY-PARCEL-12345",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ]
}

List shipments (search)

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ShipmentSearchPayload

afterstringOptional

The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.

beforestringOptional

The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).

lastnumber · min: 1 · max: 250Optional

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

sizenumber · min: 1 · max: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

post

/api/shipments/search

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

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "anonymized": {
              "eq": true,
              "notEq": true
            },
            "carrierKey": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "carrierRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-15T00:57:49.688Z",
              "gt": "2026-03-15T00:57:49.688Z",
              "gte": "2026-03-15T00:57:49.688Z",
              "lt": "2026-03-15T00:57:49.688Z",
              "lte": "2026-03-15T00:57:49.688Z",
              "notEq": "2026-03-15T00:57:49.688Z"
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "parcels": {
              "contains": {
                "status": {
                  "eq": "OPEN",
                  "in": [
                    "OPEN"
                  ],
                  "notEq": "OPEN"
                }
              }
            },
            "pickJobRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "INITIAL",
              "in": [
                "INITIAL"
              ],
              "notEq": "INITIAL"
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-15T00:57:49.688Z",
              "gt": "2026-03-15T00:57:49.688Z",
              "gte": "2026-03-15T00:57:49.688Z",
              "lt": "2026-03-15T00:57:49.688Z",
              "lte": "2026-03-15T00:57:49.688Z",
              "notEq": "2026-03-15T00:57:49.688Z"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "anonymized": {
          "eq": true,
          "notEq": true
        },
        "carrierKey": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "carrierRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-15T00:57:49.688Z",
          "gt": "2026-03-15T00:57:49.688Z",
          "gte": "2026-03-15T00:57:49.688Z",
          "lt": "2026-03-15T00:57:49.688Z",
          "lte": "2026-03-15T00:57:49.688Z",
          "notEq": "2026-03-15T00:57:49.688Z"
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "anonymized": {
              "eq": true,
              "notEq": true
            },
            "carrierKey": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "carrierRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-15T00:57:49.688Z",
              "gt": "2026-03-15T00:57:49.688Z",
              "gte": "2026-03-15T00:57:49.688Z",
              "lt": "2026-03-15T00:57:49.688Z",
              "lte": "2026-03-15T00:57:49.688Z",
              "notEq": "2026-03-15T00:57:49.688Z"
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "parcels": {
              "contains": {
                "status": {
                  "eq": "OPEN",
                  "in": [
                    "OPEN"
                  ],
                  "notEq": "OPEN"
                }
              }
            },
            "pickJobRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "INITIAL",
              "in": [
                "INITIAL"
              ],
              "notEq": "INITIAL"
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-15T00:57:49.688Z",
              "gt": "2026-03-15T00:57:49.688Z",
              "gte": "2026-03-15T00:57:49.688Z",
              "lt": "2026-03-15T00:57:49.688Z",
              "lte": "2026-03-15T00:57:49.688Z",
              "notEq": "2026-03-15T00:57:49.688Z"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "parcels": {
          "contains": {
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            }
          }
        },
        "pickJobRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "status": {
          "eq": "INITIAL",
          "in": [
            "INITIAL"
          ],
          "notEq": "INITIAL"
        },
        "targetTime": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-15T00:57:49.688Z",
          "gt": "2026-03-15T00:57:49.688Z",
          "gte": "2026-03-15T00:57:49.688Z",
          "lt": "2026-03-15T00:57:49.688Z",
          "lte": "2026-03-15T00:57:49.688Z",
          "notEq": "2026-03-15T00:57:49.688Z"
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "anonymized": {
      "eq": true,
      "notEq": true
    },
    "carrierKey": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "carrierRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "created": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-15T00:57:49.688Z",
      "gt": "2026-03-15T00:57:49.688Z",
      "gte": "2026-03-15T00:57:49.688Z",
      "lt": "2026-03-15T00:57:49.688Z",
      "lte": "2026-03-15T00:57:49.688Z",
      "notEq": "2026-03-15T00:57:49.688Z"
    },
    "facilityRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "anonymized": {
              "eq": true,
              "notEq": true
            },
            "carrierKey": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "carrierRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-15T00:57:49.688Z",
              "gt": "2026-03-15T00:57:49.688Z",
              "gte": "2026-03-15T00:57:49.688Z",
              "lt": "2026-03-15T00:57:49.688Z",
              "lte": "2026-03-15T00:57:49.688Z",
              "notEq": "2026-03-15T00:57:49.688Z"
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "parcels": {
              "contains": {
                "status": {
                  "eq": "OPEN",
                  "in": [
                    "OPEN"
                  ],
                  "notEq": "OPEN"
                }
              }
            },
            "pickJobRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "INITIAL",
              "in": [
                "INITIAL"
              ],
              "notEq": "INITIAL"
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-15T00:57:49.688Z",
              "gt": "2026-03-15T00:57:49.688Z",
              "gte": "2026-03-15T00:57:49.688Z",
              "lt": "2026-03-15T00:57:49.688Z",
              "lte": "2026-03-15T00:57:49.688Z",
              "notEq": "2026-03-15T00:57:49.688Z"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "anonymized": {
          "eq": true,
          "notEq": true
        },
        "carrierKey": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "carrierRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-15T00:57:49.688Z",
          "gt": "2026-03-15T00:57:49.688Z",
          "gte": "2026-03-15T00:57:49.688Z",
          "lt": "2026-03-15T00:57:49.688Z",
          "lte": "2026-03-15T00:57:49.688Z",
          "notEq": "2026-03-15T00:57:49.688Z"
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "anonymized": {
              "eq": true,
              "notEq": true
            },
            "carrierKey": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "carrierRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-15T00:57:49.688Z",
              "gt": "2026-03-15T00:57:49.688Z",
              "gte": "2026-03-15T00:57:49.688Z",
              "lt": "2026-03-15T00:57:49.688Z",
              "lte": "2026-03-15T00:57:49.688Z",
              "notEq": "2026-03-15T00:57:49.688Z"
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "parcels": {
              "contains": {
                "status": {
                  "eq": "OPEN",
                  "in": [
                    "OPEN"
                  ],
                  "notEq": "OPEN"
                }
              }
            },
            "pickJobRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "INITIAL",
              "in": [
                "INITIAL"
              ],
              "notEq": "INITIAL"
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-15T00:57:49.688Z",
              "gt": "2026-03-15T00:57:49.688Z",
              "gte": "2026-03-15T00:57:49.688Z",
              "lt": "2026-03-15T00:57:49.688Z",
              "lte": "2026-03-15T00:57:49.688Z",
              "notEq": "2026-03-15T00:57:49.688Z"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "parcels": {
          "contains": {
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            }
          }
        },
        "pickJobRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "status": {
          "eq": "INITIAL",
          "in": [
            "INITIAL"
          ],
          "notEq": "INITIAL"
        },
        "targetTime": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-15T00:57:49.688Z",
          "gt": "2026-03-15T00:57:49.688Z",
          "gte": "2026-03-15T00:57:49.688Z",
          "lt": "2026-03-15T00:57:49.688Z",
          "lte": "2026-03-15T00:57:49.688Z",
          "notEq": "2026-03-15T00:57:49.688Z"
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "parcels": {
      "contains": {
        "status": {
          "eq": "OPEN",
          "in": [
            "OPEN"
          ],
          "notEq": "OPEN"
        }
      }
    },
    "pickJobRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "status": {
      "eq": "INITIAL",
      "in": [
        "INITIAL"
      ],
      "notEq": "INITIAL"
    },
    "targetTime": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-15T00:57:49.688Z",
      "gt": "2026-03-15T00:57:49.688Z",
      "gte": "2026-03-15T00:57:49.688Z",
      "lt": "2026-03-15T00:57:49.688Z",
      "lte": "2026-03-15T00:57:49.688Z",
      "notEq": "2026-03-15T00:57:49.688Z"
    },
    "tenantOrderId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    }
  },
  "size": 1,
  "sort": [
    {
      "created": "ASC",
      "targetTime": "ASC"
    }
  ]
}

{
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "shipments": [
    {
      "carrierLogoUrl": "text",
      "carrierProduct": "EXPRESS",
      "carrierRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
      "carrierServices": [
        "SIGNATURE"
      ],
      "customAttributes": {},
      "facilityRef": "text",
      "invoiceAddress": {
        "addressType": "POSTAL_ADDRESS",
        "companyName": "Speedy Boxales Ltd.",
        "coordinates": {
          "lat": 50.937531,
          "lon": 6.960279
        },
        "email": "[email protected]",
        "firstName": "Maxine",
        "lastName": "Muller",
        "personalTitle": "Dr.",
        "salutation": "Frau",
        "additionalAddressInfo": "to care of: Mrs. Müller",
        "city": "Langenfeld",
        "country": "DE",
        "customAttributes": {},
        "houseNumber": "42a",
        "phoneNumbers": [
          {
            "customAttributes": {},
            "label": "text",
            "type": "MOBILE",
            "value": "text"
          }
        ],
        "postalCode": "40764",
        "province": "NRW",
        "street": "Hauptstr."
      },
      "lineItems": [
        {
          "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": {},
          "measurementUnitKey": "liter",
          "quantity": 21,
          "recordableAttributes": [
            {
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "group": "general",
              "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
              "key": "country of origin",
              "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
              "recordingRule": "MANDATORY",
              "value": "Germany"
            }
          ],
          "scannableCodes": [
            "text"
          ],
          "tags": [],
          "id": "climk4dcQFiPdA5ULuhS"
        }
      ],
      "operativeProcessRef": "text",
      "orderDate": "2026-03-15T00:57:49.688Z",
      "paymentInformation": {
        "currency": "EUR"
      },
      "pickJobRef": "Esb20gpHBL94X5NdMp3C",
      "postalAddress": {
        "addressType": "POSTAL_ADDRESS",
        "companyName": "Speedy Boxales Ltd.",
        "coordinates": {
          "lat": 50.937531,
          "lon": 6.960279
        },
        "email": "[email protected]",
        "firstName": "Maxine",
        "lastName": "Muller",
        "personalTitle": "Dr.",
        "salutation": "Frau",
        "additionalAddressInfo": "to care of: Mrs. Müller",
        "city": "Langenfeld",
        "country": "DE",
        "customAttributes": {},
        "houseNumber": "42a",
        "phoneNumbers": [
          {
            "customAttributes": {},
            "label": "text",
            "type": "MOBILE",
            "value": "text"
          }
        ],
        "postalCode": "40764",
        "province": "NRW",
        "street": "Hauptstr."
      },
      "processId": "text",
      "shortId": "text",
      "sourceAddress": {
        "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.",
        "companyName": "Speedy Boxales Ltd.",
        "emailAddresses": [
          {
            "recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
            "value": "text"
          }
        ],
        "resolvedCoordinates": {
          "lat": 50.937531,
          "lon": 6.960279
        },
        "resolvedTimeZone": {
          "offsetInSeconds": 28800,
          "source": "Google Maps API",
          "timeZoneId": "America/Los_Angeles",
          "timeZoneName": "Pacific Standard Time"
        }
      },
      "targetAddress": {
        "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."
      },
      "targetTime": "2020-02-03T09:45:51.525Z",
      "targetTimeBaseDate": "2020-02-03T08:45:50.525Z",
      "tenantOrderId": "text",
      "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,
      "carrierKey": "DPD",
      "hasActiveCarrier": false,
      "id": "95EWrieX09OmeriXIUbb",
      "parcels": [
        {
          "carrierRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
          "carrierTrackingNumber": "84168117830018",
          "parcelRef": "15EZrieW09OmeriXIUbc",
          "status": "OPEN"
        }
      ],
      "status": "INITIAL"
    }
  ],
  "total": 1
}

Last updated 1 day ago

hashtagCreate delivery note

hashtagList parcels

hashtagGet parcel

hashtagUpdate parcel

hashtagCall parcel action

hashtagGet parcel delivery note

hashtagGet parcel label

hashtagGet parcel return note

hashtagGet parcel transfer label

hashtagList parcels (search)

hashtagCreate return note

hashtagList shipments

hashtagCreate shipment

hashtagGet shipment

hashtagUpdate shipment

hashtagCall shipment action

hashtagGet shipment delivery note

hashtagCreate shipment parcel

hashtagCreate parcel

hashtagList shipments (search)

Create delivery note

List parcels

Get parcel

Update parcel

Call parcel action

Get parcel delivery note

Get parcel label

Get parcel return note

Get parcel transfer label

List parcels (search)

Create return note

List shipments

Create shipment

Get shipment

Update shipment

Call shipment action

Get shipment delivery note

Create shipment parcel

Create parcel

List shipments (search)