Packing endpoints

List pack jobs

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

sizeintegerOptional

number of entities to show

Default: 25

startAfterIdstringOptional

all entities after given Id

anonymizedbooleanOptional

Parameter to filter anonymized pack jobs

assignedUserstringOptional

Reference the assigned user on this entity - id or username

statusstring[]Optional

Reference to the status you want to get the corresponding packJobs

facilityRefstringOptional

Reference to the facility you want to get the corresponding packJobs

searchTermstringOptional

Term by which to search through the fields

channelstring · enumOptional

Reference to the channel you want to get the corresponding packJobs

Possible values:

sourceContainerCodesstring[]Optional

filter by packingsourcecontainer containing codes

orderBystring · enumOptional

Attribute to order a packJobs by

Possible values:

startTargetTimestring · date-timeOptional

Start date range for pack jobs

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

endTargetTimestring · date-timeOptional

End date range for pack jobs

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

orderRefstringOptional

Reference to the order you want to get the corresponding packJobs

packJobIdsstring[]Optional

Reference to the packJobs you want to get

processIdstringOptional

Reference to the process you want to get the corresponding packJobs

pickJobRefstringOptional

Reference to the pickJobRef you want to get the corresponding packJobs

shortIdstringOptional

Reference to the shortId you want to get the corresponding packJobs

articleTitlestringOptional

Reference to the articleTitle you want to get the corresponding packJobs

startOrderDatestring · date-timeOptional

Start date range of the order for the corresponding pack jobs

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

endOrderDatestring · date-timeOptional

End date range of the order for the corresponding pack jobs

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

modifiedByUsernamestringOptional

Reference to the username you want to get the corresponding pack jobs

tenantOrderIdstringOptional

Reference to the tenantOrderId you want to get the corresponding packJobs

Responses

200

Pack jobs was loaded & you were allowed to access it. The result is in the body.

application/json

PackJobs

totalintegerOptional

Total number of found entities for this query

Example: 42

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

404

Entity not found

application/json

get

/api/packjobs

HTTPcURLJavaScriptPython

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

{
  "packJobs": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42,
      "anonymized": false,
      "assignedUsers": [
        {
          "userId": "text",
          "username": "text"
        }
      ],
      "customAttributes": {},
      "deliveryChannel": "COLLECT",
      "documentHandling": {
        "sendLabel": {
          "enabled": false
        }
      },
      "documentsRef": "text",
      "editor": {
        "userId": "text",
        "username": "text"
      },
      "facilityRef": "Esb50gpH7794X5NdMp3C",
      "id": "Esb20gpHBL94X5NdMp3C",
      "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."
      },
      "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": {},
          "globalLineItemId": "text",
          "id": "climk4dcQFiPdA5ULuhS",
          "quantity": 21,
          "recordableAttributes": [
            {
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "group": "general",
              "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
              "key": "country of origin",
              "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
              "recordingRule": "MANDATORY",
              "value": "Germany"
            }
          ],
          "scannableCodes": [
            "text"
          ],
          "measurementUnitKey": "liter",
          "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
          "packed": 20,
          "serviceJobRefs": [
            "text"
          ],
          "stickers": [],
          "tags": []
        }
      ],
      "operativeProcessRef": "text",
      "orderDate": "2020-02-03T09:45:51.525Z",
      "orderRef": "text",
      "packingSourceContainers": [
        {
          "codes": [
            "text"
          ],
          "id": "c7467ba8-c28a-4473-8748-a4e54e675e4c",
          "loadUnitRef": "2357914c-d965-421e-b6cf-330501bccaab"
        }
      ],
      "pickJobRef": "Pic50gpH7794X5NdMp3C",
      "processId": "text",
      "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."
      },
      "recipientName": "text",
      "shortId": "text",
      "status": "OPEN",
      "stickers": [],
      "targetTime": "2020-02-03T09:45:51.525Z",
      "tenantOrderId": "text",
      "transfers": [
        {
          "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
          "type": "RECEIVER"
        }
      ],
      "tags": []
    },
    null
  ],
  "total": 42
}

Get pack job

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

packJobIdstringRequired

ID of the pack job you want to get

Responses

200

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

application/json

PackJob

and

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

404

Entity not found

application/json

get

/api/packjobs/{packJobId}

HTTPcURLJavaScriptPython

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

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "anonymized": false,
  "assignedUsers": [
    {
      "userId": "text",
      "username": "text"
    }
  ],
  "customAttributes": {},
  "deliveryChannel": "COLLECT",
  "documentHandling": {
    "sendLabel": {
      "enabled": false
    }
  },
  "documentsRef": "text",
  "editor": {
    "userId": "text",
    "username": "text"
  },
  "facilityRef": "Esb50gpH7794X5NdMp3C",
  "id": "Esb20gpHBL94X5NdMp3C",
  "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."
  },
  "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": {},
      "globalLineItemId": "text",
      "id": "climk4dcQFiPdA5ULuhS",
      "quantity": 21,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "measurementUnitKey": "liter",
      "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
      "packed": 20,
      "serviceJobRefs": [
        "text"
      ],
      "stickers": [],
      "tags": []
    }
  ],
  "operativeProcessRef": "text",
  "orderDate": "2020-02-03T09:45:51.525Z",
  "orderRef": "text",
  "packingSourceContainers": [
    {
      "codes": [
        "text"
      ],
      "id": "c7467ba8-c28a-4473-8748-a4e54e675e4c",
      "loadUnitRef": "2357914c-d965-421e-b6cf-330501bccaab"
    }
  ],
  "pickJobRef": "Pic50gpH7794X5NdMp3C",
  "processId": "text",
  "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."
  },
  "recipientName": "text",
  "shortId": "text",
  "status": "OPEN",
  "stickers": [],
  "targetTime": "2020-02-03T09:45:51.525Z",
  "tenantOrderId": "text",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ],
  "tags": []
}

Update pack job

patch

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

packJobIdstringRequired

ID of the packjob you want to get

Body

application/json

PackJobPatchActions

versioninteger · int64Required

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

Example: 42

Responses

200

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

application/json

PackJob

and

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

404

PackJob not found

application/json

409

PackJob version conflict

application/json

patch

/api/packjobs/{packJobId}

HTTPcURLJavaScriptPython

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

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

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "anonymized": false,
  "assignedUsers": [
    {
      "userId": "text",
      "username": "text"
    }
  ],
  "customAttributes": {},
  "deliveryChannel": "COLLECT",
  "documentHandling": {
    "sendLabel": {
      "enabled": false
    }
  },
  "documentsRef": "text",
  "editor": {
    "userId": "text",
    "username": "text"
  },
  "facilityRef": "Esb50gpH7794X5NdMp3C",
  "id": "Esb20gpHBL94X5NdMp3C",
  "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."
  },
  "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": {},
      "globalLineItemId": "text",
      "id": "climk4dcQFiPdA5ULuhS",
      "quantity": 21,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "measurementUnitKey": "liter",
      "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
      "packed": 20,
      "serviceJobRefs": [
        "text"
      ],
      "stickers": [],
      "tags": []
    }
  ],
  "operativeProcessRef": "text",
  "orderDate": "2020-02-03T09:45:51.525Z",
  "orderRef": "text",
  "packingSourceContainers": [
    {
      "codes": [
        "text"
      ],
      "id": "c7467ba8-c28a-4473-8748-a4e54e675e4c",
      "loadUnitRef": "2357914c-d965-421e-b6cf-330501bccaab"
    }
  ],
  "pickJobRef": "Pic50gpH7794X5NdMp3C",
  "processId": "text",
  "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."
  },
  "recipientName": "text",
  "shortId": "text",
  "status": "OPEN",
  "stickers": [],
  "targetTime": "2020-02-03T09:45:51.525Z",
  "tenantOrderId": "text",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ],
  "tags": []
}

Call pack job action

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

packJobIdstringRequired

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

Body

application/json

PackJobActionsParameter

or

or

or

or

Responses

200

Updated PackJob in the body.

application/json

PackJob

and

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

404

Enitity not found

application/json

post

/api/packjobs/{packJobId}/actions

HTTPcURLJavaScriptPython

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

{
  "assignedUsers": [
    {
      "username": "text"
    }
  ],
  "name": "REPLACE_ASSIGNED_USERS",
  "version": 1
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "anonymized": false,
  "assignedUsers": [
    {
      "userId": "text",
      "username": "text"
    }
  ],
  "customAttributes": {},
  "deliveryChannel": "COLLECT",
  "documentHandling": {
    "sendLabel": {
      "enabled": false
    }
  },
  "documentsRef": "text",
  "editor": {
    "userId": "text",
    "username": "text"
  },
  "facilityRef": "Esb50gpH7794X5NdMp3C",
  "id": "Esb20gpHBL94X5NdMp3C",
  "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."
  },
  "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": {},
      "globalLineItemId": "text",
      "id": "climk4dcQFiPdA5ULuhS",
      "quantity": 21,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "measurementUnitKey": "liter",
      "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
      "packed": 20,
      "serviceJobRefs": [
        "text"
      ],
      "stickers": [],
      "tags": []
    }
  ],
  "operativeProcessRef": "text",
  "orderDate": "2020-02-03T09:45:51.525Z",
  "orderRef": "text",
  "packingSourceContainers": [
    {
      "codes": [
        "text"
      ],
      "id": "c7467ba8-c28a-4473-8748-a4e54e675e4c",
      "loadUnitRef": "2357914c-d965-421e-b6cf-330501bccaab"
    }
  ],
  "pickJobRef": "Pic50gpH7794X5NdMp3C",
  "processId": "text",
  "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."
  },
  "recipientName": "text",
  "shortId": "text",
  "status": "OPEN",
  "stickers": [],
  "targetTime": "2020-02-03T09:45:51.525Z",
  "tenantOrderId": "text",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ],
  "tags": []
}

Create pack job

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

PackJobForCreation

customAttributesobjectOptional

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

deliveryChannelstring · enumOptionalPossible values:

facilityRefstringRequired

Reference to the facility you want to get the corresponding packjob

Example: Esb50gpH7794X5NdMp3C

operativeProcessRefstringOptional

orderDatestring · date-timeOptional

Date when the order was placed.

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

orderRefstringOptional

The id of the order

pickJobRefstringOptional

Reference to a pick job

Example: Pic50gpH7794X5NdMp3C

processIdstringOptional

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

recipientNamestringOptional

The name of the recipient

shortIdstringOptional

The short identifier of the shipment.

statusstring · enumOptional

A pack job initially has the status OPEN and packing can start. When packing has started, the pack job changes its status to IN_PROGRESS. After a pack job has been completely packed its status becomes CLOSED.

Possible values:

targetTimestring · date-timeOptional

Until when the pack job must be finished.

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

tenantOrderIdstringOptional

Responses

201

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

application/json

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

post

/api/packjobs

HTTPcURLJavaScriptPython

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

{
  "assignedUsers": [
    {
      "username": "text"
    }
  ],
  "customAttributes": {},
  "deliveryChannel": "COLLECT",
  "facilityRef": "Esb50gpH7794X5NdMp3C",
  "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."
  },
  "lineItems": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "quantity": 1,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "operativeProcessRef": "text",
  "orderDate": "2020-02-03T09:45:51.525Z",
  "orderRef": "text",
  "pickJobRef": "Pic50gpH7794X5NdMp3C",
  "processId": "text",
  "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."
  },
  "recipientName": "text",
  "shortId": "text",
  "status": "OPEN",
  "targetTime": "2020-02-03T09:45:51.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,
  "assignedUsers": [
    {
      "userId": "text",
      "username": "text"
    }
  ],
  "customAttributes": {},
  "deliveryChannel": "COLLECT",
  "documentHandling": {
    "sendLabel": {
      "enabled": false
    }
  },
  "documentsRef": "text",
  "editor": {
    "userId": "text",
    "username": "text"
  },
  "facilityRef": "Esb50gpH7794X5NdMp3C",
  "id": "Esb20gpHBL94X5NdMp3C",
  "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."
  },
  "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": {},
      "globalLineItemId": "text",
      "id": "climk4dcQFiPdA5ULuhS",
      "quantity": 21,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "measurementUnitKey": "liter",
      "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
      "packed": 20,
      "serviceJobRefs": [
        "text"
      ],
      "stickers": [],
      "tags": []
    }
  ],
  "operativeProcessRef": "text",
  "orderDate": "2020-02-03T09:45:51.525Z",
  "orderRef": "text",
  "packingSourceContainers": [
    {
      "codes": [
        "text"
      ],
      "id": "c7467ba8-c28a-4473-8748-a4e54e675e4c",
      "loadUnitRef": "2357914c-d965-421e-b6cf-330501bccaab"
    }
  ],
  "pickJobRef": "Pic50gpH7794X5NdMp3C",
  "processId": "text",
  "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."
  },
  "recipientName": "text",
  "shortId": "text",
  "status": "OPEN",
  "stickers": [],
  "targetTime": "2020-02-03T09:45:51.525Z",
  "tenantOrderId": "text",
  "transfers": [
    {
      "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
      "type": "RECEIVER"
    }
  ],
  "tags": []
}

Get pack job delivery note

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

packJobIdstringRequired

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

Query parameters

localestringOptional

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

Responses

200

The deliverynote for the given packjob

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/packjobs/{packJobId}/deliverynote

HTTPcURLJavaScriptPython

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

Get pack job document handling

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

packJobIdstringRequired

ID of the pack job you want to get document handling information

Responses

200

Pack job document handling was found & you were allowed to access it. The result is in the body.

application/json

DocumentHandling

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/packjobs/{packJobId}/documenthandling

HTTPcURLJavaScriptPython

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

{
  "sendLabel": {
    "enabled": false
  }
}

Get pack job transfer label

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

packJobIdstringRequired

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

Responses

200

The transfer label for the given packjob

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/packjobs/{packJobId}/transferlabel

HTTPcURLJavaScriptPython

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

List pack jobs (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

PackJobSearchPayload

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

PackJobPaginatedResult

totalnumberOptional

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

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

post

/api/packjobs/search

HTTPcURLJavaScriptPython

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

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "facilityRef": {
              "eq": "text",
              "notEq": "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"
                ]
              }
            },
            "lastModified": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:02:32.107Z",
              "gt": "2026-03-02T18:02:32.107Z",
              "gte": "2026-03-02T18:02:32.107Z",
              "lt": "2026-03-02T18:02:32.107Z",
              "lte": "2026-03-02T18:02:32.107Z",
              "notEq": "2026-03-02T18:02:32.107Z"
            },
            "lineItems": {
              "contains": {
                "article": {
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            },
            "or": "[Circular Reference]",
            "orderDate": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:02:32.107Z",
              "gt": "2026-03-02T18:02:32.107Z",
              "gte": "2026-03-02T18:02:32.107Z",
              "lt": "2026-03-02T18:02:32.107Z",
              "lte": "2026-03-02T18:02:32.107Z",
              "notEq": "2026-03-02T18:02:32.107Z"
            },
            "packingSourceContainers": {
              "contains": {
                "codes": {
                  "contains": {
                    "eq": "text",
                    "notEq": "text"
                  }
                }
              }
            },
            "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"
                ]
              }
            },
            "shortId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:02:32.107Z",
              "gt": "2026-03-02T18:02:32.107Z",
              "gte": "2026-03-02T18:02:32.107Z",
              "lt": "2026-03-02T18:02:32.107Z",
              "lte": "2026-03-02T18:02:32.107Z",
              "notEq": "2026-03-02T18:02:32.107Z"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "facilityRef": {
          "eq": "text",
          "notEq": "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"
            ]
          }
        },
        "lastModified": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:02:32.107Z",
          "gt": "2026-03-02T18:02:32.107Z",
          "gte": "2026-03-02T18:02:32.107Z",
          "lt": "2026-03-02T18:02:32.107Z",
          "lte": "2026-03-02T18:02:32.107Z",
          "notEq": "2026-03-02T18:02:32.107Z"
        },
        "lineItems": {
          "contains": {
            "article": {
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "title": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          }
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "facilityRef": {
              "eq": "text",
              "notEq": "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"
                ]
              }
            },
            "lastModified": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:02:32.107Z",
              "gt": "2026-03-02T18:02:32.107Z",
              "gte": "2026-03-02T18:02:32.107Z",
              "lt": "2026-03-02T18:02:32.107Z",
              "lte": "2026-03-02T18:02:32.107Z",
              "notEq": "2026-03-02T18:02:32.107Z"
            },
            "lineItems": {
              "contains": {
                "article": {
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            },
            "or": "[Circular Reference]",
            "orderDate": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:02:32.107Z",
              "gt": "2026-03-02T18:02:32.107Z",
              "gte": "2026-03-02T18:02:32.107Z",
              "lt": "2026-03-02T18:02:32.107Z",
              "lte": "2026-03-02T18:02:32.107Z",
              "notEq": "2026-03-02T18:02:32.107Z"
            },
            "packingSourceContainers": {
              "contains": {
                "codes": {
                  "contains": {
                    "eq": "text",
                    "notEq": "text"
                  }
                }
              }
            },
            "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"
                ]
              }
            },
            "shortId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:02:32.107Z",
              "gt": "2026-03-02T18:02:32.107Z",
              "gte": "2026-03-02T18:02:32.107Z",
              "lt": "2026-03-02T18:02:32.107Z",
              "lte": "2026-03-02T18:02:32.107Z",
              "notEq": "2026-03-02T18:02:32.107Z"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "orderDate": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:02:32.107Z",
          "gt": "2026-03-02T18:02:32.107Z",
          "gte": "2026-03-02T18:02:32.107Z",
          "lt": "2026-03-02T18:02:32.107Z",
          "lte": "2026-03-02T18:02:32.107Z",
          "notEq": "2026-03-02T18:02:32.107Z"
        },
        "packingSourceContainers": {
          "contains": {
            "codes": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            }
          }
        },
        "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"
            ]
          }
        },
        "shortId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "status": {
          "eq": "OPEN",
          "in": [
            "OPEN"
          ],
          "notEq": "OPEN"
        },
        "targetTime": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:02:32.107Z",
          "gt": "2026-03-02T18:02:32.107Z",
          "gte": "2026-03-02T18:02:32.107Z",
          "lt": "2026-03-02T18:02:32.107Z",
          "lte": "2026-03-02T18:02:32.107Z",
          "notEq": "2026-03-02T18:02:32.107Z"
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "facilityRef": {
      "eq": "text",
      "notEq": "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"
        ]
      }
    },
    "lastModified": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T18:02:32.107Z",
      "gt": "2026-03-02T18:02:32.107Z",
      "gte": "2026-03-02T18:02:32.107Z",
      "lt": "2026-03-02T18:02:32.107Z",
      "lte": "2026-03-02T18:02:32.107Z",
      "notEq": "2026-03-02T18:02:32.107Z"
    },
    "lineItems": {
      "contains": {
        "article": {
          "tenantArticleId": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "title": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        }
      }
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "facilityRef": {
          "eq": "text",
          "notEq": "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"
            ]
          }
        },
        "lastModified": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:02:32.107Z",
          "gt": "2026-03-02T18:02:32.107Z",
          "gte": "2026-03-02T18:02:32.107Z",
          "lt": "2026-03-02T18:02:32.107Z",
          "lte": "2026-03-02T18:02:32.107Z",
          "notEq": "2026-03-02T18:02:32.107Z"
        },
        "lineItems": {
          "contains": {
            "article": {
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "title": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          }
        },
        "or": "[Circular Reference]",
        "orderDate": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:02:32.107Z",
          "gt": "2026-03-02T18:02:32.107Z",
          "gte": "2026-03-02T18:02:32.107Z",
          "lt": "2026-03-02T18:02:32.107Z",
          "lte": "2026-03-02T18:02:32.107Z",
          "notEq": "2026-03-02T18:02:32.107Z"
        },
        "packingSourceContainers": {
          "contains": {
            "codes": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            }
          }
        },
        "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"
            ]
          }
        },
        "shortId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "status": {
          "eq": "OPEN",
          "in": [
            "OPEN"
          ],
          "notEq": "OPEN"
        },
        "targetTime": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:02:32.107Z",
          "gt": "2026-03-02T18:02:32.107Z",
          "gte": "2026-03-02T18:02:32.107Z",
          "lt": "2026-03-02T18:02:32.107Z",
          "lte": "2026-03-02T18:02:32.107Z",
          "notEq": "2026-03-02T18:02:32.107Z"
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "orderDate": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T18:02:32.107Z",
      "gt": "2026-03-02T18:02:32.107Z",
      "gte": "2026-03-02T18:02:32.107Z",
      "lt": "2026-03-02T18:02:32.107Z",
      "lte": "2026-03-02T18:02:32.107Z",
      "notEq": "2026-03-02T18:02:32.107Z"
    },
    "packingSourceContainers": {
      "contains": {
        "codes": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        }
      }
    },
    "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"
        ]
      }
    },
    "shortId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "status": {
      "eq": "OPEN",
      "in": [
        "OPEN"
      ],
      "notEq": "OPEN"
    },
    "targetTime": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T18:02:32.107Z",
      "gt": "2026-03-02T18:02:32.107Z",
      "gte": "2026-03-02T18:02:32.107Z",
      "lt": "2026-03-02T18:02:32.107Z",
      "lte": "2026-03-02T18:02:32.107Z",
      "notEq": "2026-03-02T18:02:32.107Z"
    },
    "tenantOrderId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    }
  },
  "size": 1,
  "sort": [
    {
      "lastModified": "ASC",
      "orderDate": "ASC",
      "targetTime": "ASC"
    }
  ]
}

{
  "packJobs": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42,
      "anonymized": false,
      "assignedUsers": [
        {
          "userId": "text",
          "username": "text"
        }
      ],
      "customAttributes": {},
      "deliveryChannel": "COLLECT",
      "documentHandling": {
        "sendLabel": {
          "enabled": false
        }
      },
      "documentsRef": "text",
      "editor": {
        "userId": "text",
        "username": "text"
      },
      "facilityRef": "Esb50gpH7794X5NdMp3C",
      "id": "Esb20gpHBL94X5NdMp3C",
      "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."
      },
      "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": {},
          "globalLineItemId": "text",
          "id": "climk4dcQFiPdA5ULuhS",
          "quantity": 21,
          "recordableAttributes": [
            {
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "group": "general",
              "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
              "key": "country of origin",
              "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
              "recordingRule": "MANDATORY",
              "value": "Germany"
            }
          ],
          "scannableCodes": [
            "text"
          ],
          "measurementUnitKey": "liter",
          "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
          "packed": 20,
          "serviceJobRefs": [
            "text"
          ],
          "stickers": [],
          "tags": []
        }
      ],
      "operativeProcessRef": "text",
      "orderDate": "2020-02-03T09:45:51.525Z",
      "orderRef": "text",
      "packingSourceContainers": [
        {
          "codes": [
            "text"
          ],
          "id": "c7467ba8-c28a-4473-8748-a4e54e675e4c",
          "loadUnitRef": "2357914c-d965-421e-b6cf-330501bccaab"
        }
      ],
      "pickJobRef": "Pic50gpH7794X5NdMp3C",
      "processId": "text",
      "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."
      },
      "recipientName": "text",
      "shortId": "text",
      "status": "OPEN",
      "stickers": [],
      "targetTime": "2020-02-03T09:45:51.525Z",
      "tenantOrderId": "text",
      "transfers": [
        {
          "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
          "type": "RECEIVER"
        }
      ],
      "tags": []
    }
  ],
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1
}

Get target container transfer label

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

packJobIdstringRequired

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

targetcontainerIdstringRequired

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

Responses

200

The transfer label for the given packingTargetContainer

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/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/transferlabel

HTTPcURLJavaScriptPython

GET /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/transferlabel HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Delete pack job target container

delete

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

packJobIdstringRequired

ID of corresponding packJob you want to patch

targetcontainerIdstringRequired

ID of container you want to delete

Responses

200

Container was found & you were allowed to delete it.

No content

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

404

Entity not found

application/json

delete

/api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}

HTTPcURLJavaScriptPython

DELETE /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update packing config

patch

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

PackingConfigurations

Responses

200

The packing central configuration was successfully updated.

application/json

PackingConfigurations

201

The packing central configuration was successfully created.

application/json

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

patch

/api/configurations/packing

HTTPcURLJavaScriptPython

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

{
  "documentHandlingConfiguration": {
    "inheritedDocumentConfigurations": []
  },
  "packingContainerRequiredConfiguration": {
    "active": false
  },
  "packingItemConfirmationNeededConfiguration": {
    "active": true
  },
  "packingSourceContainerConfiguration": {
    "active": false
  },
  "scanningConfiguration": {
    "scanningType": "MUST_SCAN_EACH"
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

{
  "documentHandlingConfiguration": {
    "inheritedDocumentConfigurations": []
  },
  "packingContainerRequiredConfiguration": {
    "active": false
  },
  "packingItemConfirmationNeededConfiguration": {
    "active": true
  },
  "packingSourceContainerConfiguration": {
    "active": false
  },
  "scanningConfiguration": {
    "scanningType": "MUST_SCAN_EACH"
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get packing config

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Central Configuration of all packing related things

application/json

PackingConfigurations

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

404

Entity not found

application/json

get

/api/configurations/packing

HTTPcURLJavaScriptPython

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

{
  "documentHandlingConfiguration": {
    "inheritedDocumentConfigurations": []
  },
  "packingContainerRequiredConfiguration": {
    "active": false
  },
  "packingItemConfirmationNeededConfiguration": {
    "active": true
  },
  "packingSourceContainerConfiguration": {
    "active": false
  },
  "scanningConfiguration": {
    "scanningType": "MUST_SCAN_EACH"
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get pack jobs tag config

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Packjob tag config is in response body.

application/json

PackJobTagConfiguration

and

and

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

404

Entity not found

application/json

get

/api/configurations/tags/packjob

HTTPcURLJavaScriptPython

GET /api/configurations/tags/packjob 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,
  "offeredDocumentsByDefault": [
    {
      "documentCategory": "EXTERNAL"
    }
  ],
  "offeredDocumentsPerTag": [
    {
      "matchingValues": [
        "text"
      ],
      "offeredDocuments": [
        {
          "documentCategory": "EXTERNAL"
        }
      ],
      "tagRef": "text"
    }
  ],
  "lineItemStickerConfiguration": {
    "offeredStickersByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "stickers": [],
        "tagRef": "text"
      }
    ]
  },
  "packJobCreationPerTag": [
    {
      "matchingValues": [
        "text"
      ],
      "packJobCreationDisabled": true,
      "tagRef": "text"
    }
  ],
  "stickerConfiguration": {
    "offeredStickersByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "stickers": [],
        "tagRef": "text"
      }
    ]
  }
}

Update pack jobs tag config

put

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

PackJobTagConfiguration

and

and

Responses

200

The packing configuration was successfully updated.

application/json

PackJobTagConfiguration

and

and

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

put

/api/configurations/tags/packjob

HTTPcURLJavaScriptPython

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

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "offeredDocumentsByDefault": [
    {
      "documentCategory": "EXTERNAL"
    }
  ],
  "offeredDocumentsPerTag": [
    {
      "matchingValues": [
        "text"
      ],
      "offeredDocuments": [
        {
          "documentCategory": "EXTERNAL"
        }
      ],
      "tagRef": "text"
    }
  ],
  "lineItemStickerConfiguration": {
    "offeredStickersByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "stickers": [],
        "tagRef": "text"
      }
    ]
  },
  "packJobCreationPerTag": [
    {
      "matchingValues": [
        "text"
      ],
      "packJobCreationDisabled": true,
      "tagRef": "text"
    }
  ],
  "stickerConfiguration": {
    "offeredStickersByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "stickers": [],
        "tagRef": "text"
      }
    ]
  }
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "offeredDocumentsByDefault": [
    {
      "documentCategory": "EXTERNAL"
    }
  ],
  "offeredDocumentsPerTag": [
    {
      "matchingValues": [
        "text"
      ],
      "offeredDocuments": [
        {
          "documentCategory": "EXTERNAL"
        }
      ],
      "tagRef": "text"
    }
  ],
  "lineItemStickerConfiguration": {
    "offeredStickersByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "stickers": [],
        "tagRef": "text"
      }
    ]
  },
  "packJobCreationPerTag": [
    {
      "matchingValues": [
        "text"
      ],
      "packJobCreationDisabled": true,
      "tagRef": "text"
    }
  ],
  "stickerConfiguration": {
    "offeredStickersByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "stickers": [],
        "tagRef": "text"
      }
    ]
  }
}

Get pack job return note

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

packJobIdstringRequired

ID of the PackJob

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

Returns a return note for the packjob.

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/packjobs/{packJobId}/returnnote

HTTPcURLJavaScriptPython

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