Packing (Operations)

These endpoints facilitate the packing process.

Deprecated

List packing container types

get

This part of the API is deprecated. For details please check the api-release-life-cycle documentation. Get all packing container types, use operative container types

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

localestringOptional

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

startAfterIdstringOptional

all entities after given id

sizeintegerOptional

number of entities to show

Default: 25

Responses

200

Found PackingContainerTypes

application/json

PackingContainerType

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

get

/api/packingcontainertypes

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

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

Deprecated

Create packing container type

post

This part of the API is deprecated. For details please check the api-release-life-cycle documentation. Add a new packing container type, use operative container types.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

PackingContainerTypeForCreation

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

This value gives the priority in the respective packingContainerType. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order packingContainerTypes.

Example: 100

weightLimitInGnumber · min: 1Optional

Maximal weight in gramm(gr) the container can be loaded with.

Example: 2500

Responses

201

The packing container type was successfully created. The Location header contains the URL of the packing container type.

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

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

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

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

Deprecated

Get packing container type

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

packingContainerTypeIdstringRequired

id of entity

Query parameters

localestringOptional

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

Responses

200

Found PackingContainerType

application/json

PackingContainerType

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

get

/api/packingcontainertypes/{packingContainerTypeId}

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

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

Deprecated

Update packing container type

patch

This part of the API is deprecated. For details please check the api-release-life-cycle documentation. Patches a PackingContainerType with the given ID, use operative container types

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

packingContainerTypeIdstringRequired

ID of the packingcontainertype you want to change

Body

PackingContainerTypePatchActions

versioninteger · int64Required

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

Example: 42

Responses

200

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

application/json

PackingContainerType

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

PackingContainerType not found

application/json

409

PackingContainerType version conflict

application/json

patch

/api/packingcontainertypes/{packingContainerTypeId}

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

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

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

List packing source containers

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

localestringOptional

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

startAfterIdstringOptional

all entities after given id

sizeinteger · max: 500Optional

number of entities to show

Default: 25

packJobRefstringOptional

filter by packJobRef

facilityRefstringRequired

filter by facilityRef

codesstring[]Optional

filter by scannablecodes

Responses

200

Found Packing Source Container

application/json

PaginatedPackingSourceContainers

totalintegerOptional

Total number of found entities for this query

Example: 42

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

get

/api/packingsourcecontainers

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

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

Create packing source container

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

PackingSourceContainerForCreation

codesstring[] · min: 1Optional

Codes, that identify the article

customAttributesobjectOptional

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

facilityRefstringRequired

The id of the facility reference. The given ID has to be present in the system. But it is not updatable.

Example: Esb20gpHBL94X5NdMp3C

operativeContainerTypeRefstringOptional

Reference to the operativeContainerType, available values will be taken from the container type while creating the container

packJobRefsstring[] · min: 1Required

List of references to packJobs

Example: 0857914c-d965-421e-b6cf-330501bcca58

storageLocationRefstringOptional

Reference to the location where the packing source container is located.

Responses

201

The packing source container was successfully created. The Location header contains the URL of the packing source container.

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

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

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "codes": [
    "text"
  ],
  "customAttributes": {},
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "icon": {
    "content": "JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==",
    "name": "example.pdf"
  },
  "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"
      ]
    }
  ],
  "operativeContainerTypeRef": "text",
  "packJobRefs": [
    "0857914c-d965-421e-b6cf-330501bcca58"
  ],
  "storageLocationRef": "text"
}

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "codes": [
    "text"
  ],
  "customAttributes": {},
  "description": "text",
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "iconUrl": "text",
  "id": "c7467ba8-c28a-4473-8748-a4e54e675e4c",
  "lineItems": [
    {
      "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"
      ]
    }
  ],
  "loadUnitRef": "2357914c-d965-421e-b6cf-330501bccaab",
  "name": "text",
  "operativeContainerTypeRef": "text",
  "packJobRefs": [
    "0857914c-d965-421e-b6cf-330501bcca58"
  ],
  "storageLocationRef": "text",
  "type": "VIRTUAL",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get packing source container

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

packingSourceContainerIdstringRequired

ID of the packingSourceContainer

Query parameters

localestringOptional

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

Responses

200

Found packingSourceContainer

application/json

PackingSourceContainer

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

404

Entity not found

application/json

get

/api/packingsourcecontainers/{packingSourceContainerId}

GET /api/packingsourcecontainers/{packingSourceContainerId} 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
  }
]

List pack jobs

get

Authorizations

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

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
}

Create pack job

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

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

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

get

Authorizations

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}

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

packJobIdstringRequired

ID of the packjob you want to get

Body

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}

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

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

PackJobActionsParameter

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

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": []
}

Get pack job delivery note

get

Authorizations

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

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

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

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 return note

get

Authorizations

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

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

List pack job target containers

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Returns all packing containers on given packJob

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

packJobIdstringRequired

ID of the pack job you want to get

Responses

200

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

application/json

PackingTargetContainer

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

GET /api/packjobs/{packJobId}/targetcontainers 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,
    "codes": [
      "text"
    ],
    "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"
        ]
      }
    ],
    "operativeContainerTypeRef": "text",
    "packingContainerTypeRef": "text",
    "storageLocationRef": "text"
  }
]

Create pack job target container

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

packJobIdstringRequired

ID of the pack job you want to get

Body

PackingTargetContainerForCreation

codesstring[]Required

List of codes

lineItemsanyOptional

PackingTargetContainerLineItemForCreation

operativeContainerTypeRefstringOptional

packingContainerTypeRefstringOptional

deprecated - use operativeContainerTypeRef instead

storageLocationRefstringOptional

Reference to the location where the packing target container is located.

Responses

201

The packing container 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

post

/api/packjobs/{packJobId}/targetcontainers

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

{
  "codes": [
    "text"
  ],
  "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"
      ]
    }
  ],
  "operativeContainerTypeRef": "text",
  "packingContainerTypeRef": "text",
  "storageLocationRef": "text"
}

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25.5
  },
  "documentsRef": "text",
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "iconUrl": "text",
  "id": "text",
  "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"
      ]
    }
  ],
  "name": "text",
  "operativeProcessRef": "text",
  "packJobRef": "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-13T15:09:38.974Z",
        "startTime": "2026-03-13T15:09:38.974Z"
      },
      "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"
        }
      ]
    }
  ],
  "shortId": "text",
  "type": "VIRTUAL",
  "weightLimitInG": 2500,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "codes": [
    "text"
  ],
  "operativeContainerTypeRef": "text",
  "packingContainerTypeRef": "text",
  "storageLocationRef": "text"
}

Get pack job target container

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Returns a packing target container with the given ID on given packJob

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

packJobIdstringRequired

ID of the pack job you want to get

targetcontainerIdstringRequired

ID of the target container you want to get

Query parameters

localestringOptional

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

Responses

200

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

application/json

PackingTargetContainer

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}

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

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25.5
  },
  "documentsRef": "text",
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "iconUrl": "text",
  "id": "text",
  "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"
      ]
    }
  ],
  "name": "text",
  "operativeProcessRef": "text",
  "packJobRef": "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-13T15:09:38.974Z",
        "startTime": "2026-03-13T15:09:38.974Z"
      },
      "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"
        }
      ]
    }
  ],
  "shortId": "text",
  "type": "VIRTUAL",
  "weightLimitInG": 2500,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "codes": [
    "text"
  ],
  "operativeContainerTypeRef": "text",
  "packingContainerTypeRef": "text",
  "storageLocationRef": "text"
}

Add pack job target container line item

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

packJobIdstringRequired

ID of the pack job you want to get

targetcontainerIdstringRequired

ID of the container you want to add new line item to it

Body

PackingTargetContainerLineItemForCreation

Responses

201

The packing container 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

post

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

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

{
  "article": {},
  "measurementUnitKey": "liter",
  "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
  "quantity": 1,
  "secondaryMeasurementUnitKey": "gram",
  "secondaryQuantity": 200,
  "stickers": [],
  "tags": [],
  "customAttributes": {},
  "globalLineItemId": "text",
  "recordableAttributes": [
    {
      "keyLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "group": "general",
      "recordingRule": "MANDATORY",
      "value": "Germany"
    }
  ],
  "scannableCodes": [
    "text"
  ]
}

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25.5
  },
  "documentsRef": "text",
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "iconUrl": "text",
  "id": "text",
  "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"
      ]
    }
  ],
  "name": "text",
  "operativeProcessRef": "text",
  "packJobRef": "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-13T15:09:38.974Z",
        "startTime": "2026-03-13T15:09:38.974Z"
      },
      "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"
        }
      ]
    }
  ],
  "shortId": "text",
  "type": "VIRTUAL",
  "weightLimitInG": 2500,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "codes": [
    "text"
  ],
  "operativeContainerTypeRef": "text",
  "packingContainerTypeRef": "text",
  "storageLocationRef": "text"
}

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

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}

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 pack job target container

patch

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

Authorizations

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 patch

Body

PackingTargetContainerPatchActions

versioninteger · int64Required

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

Example: 42

Responses

200

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

application/json

PackingTargetContainer

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

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

{
  "actions": [
    {
      "action": "ReplaceCodesInPackingTargetContainer",
      "codes": [
        "text"
      ]
    }
  ],
  "version": 42
}

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25.5
  },
  "documentsRef": "text",
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "iconUrl": "text",
  "id": "text",
  "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"
      ]
    }
  ],
  "name": "text",
  "operativeProcessRef": "text",
  "packJobRef": "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-13T15:09:38.974Z",
        "startTime": "2026-03-13T15:09:38.974Z"
      },
      "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"
        }
      ]
    }
  ],
  "shortId": "text",
  "type": "VIRTUAL",
  "weightLimitInG": 2500,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "codes": [
    "text"
  ],
  "operativeContainerTypeRef": "text",
  "packingContainerTypeRef": "text",
  "storageLocationRef": "text"
}

Get target container delivery note

get

Authorizations

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

targetcontainerIdstringRequired

ID of the packingTargetContainer 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 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}/deliverynote

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

Delete target container line item

delete

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

Authorizations

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 patch

lineItemIdstringRequired

ID of line item you want to patch

Responses

200

LineItem 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

Facility not found

application/json

delete

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

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

No content

Update target container line item

patch

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

Authorizations

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 patch

lineItemIdstringRequired

ID of line item you want to patch

Body

PackingTargetContainerActionsParameter

Responses

200

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

application/json

PackingTargetContainer

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

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

{
  "name": "UpdateLineItem",
  "payload": {
    "lineItem": {
      "article": {},
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "measurementUnitKey": "liter",
      "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
      "quantity": 1,
      "secondaryMeasurementUnitKey": "gram",
      "secondaryQuantity": 200,
      "stickers": [],
      "tags": [],
      "customAttributes": {},
      "globalLineItemId": "text",
      "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"
      ]
    }
  },
  "version": 1
}

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25.5
  },
  "documentsRef": "text",
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "iconUrl": "text",
  "id": "text",
  "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"
      ]
    }
  ],
  "name": "text",
  "operativeProcessRef": "text",
  "packJobRef": "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-13T15:09:38.974Z",
        "startTime": "2026-03-13T15:09:38.974Z"
      },
      "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"
        }
      ]
    }
  ],
  "shortId": "text",
  "type": "VIRTUAL",
  "weightLimitInG": 2500,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "codes": [
    "text"
  ],
  "operativeContainerTypeRef": "text",
  "packingContainerTypeRef": "text",
  "storageLocationRef": "text"
}

Get target container return note

get

Authorizations

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

targetcontainerIdstringRequired

ID of the PackingTargetContainer

Query parameters

localestringOptional

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

Responses

200

Returns a return note for the PackingTargetContainer.

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}/targetcontainers/{targetcontainerId}/returnnote

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

Get target container transfer label

get

Authorizations

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

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

Get pack job transfer label

get

Authorizations

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

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

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

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-13T15:09:38.974Z",
              "gt": "2026-03-13T15:09:38.974Z",
              "gte": "2026-03-13T15:09:38.974Z",
              "lt": "2026-03-13T15:09:38.974Z",
              "lte": "2026-03-13T15:09:38.974Z",
              "notEq": "2026-03-13T15:09:38.974Z"
            },
            "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-13T15:09:38.974Z",
              "gt": "2026-03-13T15:09:38.974Z",
              "gte": "2026-03-13T15:09:38.974Z",
              "lt": "2026-03-13T15:09:38.974Z",
              "lte": "2026-03-13T15:09:38.974Z",
              "notEq": "2026-03-13T15:09:38.974Z"
            },
            "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-13T15:09:38.974Z",
              "gt": "2026-03-13T15:09:38.974Z",
              "gte": "2026-03-13T15:09:38.974Z",
              "lt": "2026-03-13T15:09:38.974Z",
              "lte": "2026-03-13T15:09:38.974Z",
              "notEq": "2026-03-13T15:09:38.974Z"
            },
            "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-13T15:09:38.974Z",
          "gt": "2026-03-13T15:09:38.974Z",
          "gte": "2026-03-13T15:09:38.974Z",
          "lt": "2026-03-13T15:09:38.974Z",
          "lte": "2026-03-13T15:09:38.974Z",
          "notEq": "2026-03-13T15:09:38.974Z"
        },
        "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-13T15:09:38.974Z",
              "gt": "2026-03-13T15:09:38.974Z",
              "gte": "2026-03-13T15:09:38.974Z",
              "lt": "2026-03-13T15:09:38.974Z",
              "lte": "2026-03-13T15:09:38.974Z",
              "notEq": "2026-03-13T15:09:38.974Z"
            },
            "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-13T15:09:38.974Z",
              "gt": "2026-03-13T15:09:38.974Z",
              "gte": "2026-03-13T15:09:38.974Z",
              "lt": "2026-03-13T15:09:38.974Z",
              "lte": "2026-03-13T15:09:38.974Z",
              "notEq": "2026-03-13T15:09:38.974Z"
            },
            "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-13T15:09:38.974Z",
              "gt": "2026-03-13T15:09:38.974Z",
              "gte": "2026-03-13T15:09:38.974Z",
              "lt": "2026-03-13T15:09:38.974Z",
              "lte": "2026-03-13T15:09:38.974Z",
              "notEq": "2026-03-13T15:09:38.974Z"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "orderDate": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-13T15:09:38.974Z",
          "gt": "2026-03-13T15:09:38.974Z",
          "gte": "2026-03-13T15:09:38.974Z",
          "lt": "2026-03-13T15:09:38.974Z",
          "lte": "2026-03-13T15:09:38.974Z",
          "notEq": "2026-03-13T15:09:38.974Z"
        },
        "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-13T15:09:38.974Z",
          "gt": "2026-03-13T15:09:38.974Z",
          "gte": "2026-03-13T15:09:38.974Z",
          "lt": "2026-03-13T15:09:38.974Z",
          "lte": "2026-03-13T15:09:38.974Z",
          "notEq": "2026-03-13T15:09:38.974Z"
        },
        "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-13T15:09:38.974Z",
      "gt": "2026-03-13T15:09:38.974Z",
      "gte": "2026-03-13T15:09:38.974Z",
      "lt": "2026-03-13T15:09:38.974Z",
      "lte": "2026-03-13T15:09:38.974Z",
      "notEq": "2026-03-13T15:09:38.974Z"
    },
    "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-13T15:09:38.974Z",
          "gt": "2026-03-13T15:09:38.974Z",
          "gte": "2026-03-13T15:09:38.974Z",
          "lt": "2026-03-13T15:09:38.974Z",
          "lte": "2026-03-13T15:09:38.974Z",
          "notEq": "2026-03-13T15:09:38.974Z"
        },
        "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-13T15:09:38.974Z",
          "gt": "2026-03-13T15:09:38.974Z",
          "gte": "2026-03-13T15:09:38.974Z",
          "lt": "2026-03-13T15:09:38.974Z",
          "lte": "2026-03-13T15:09:38.974Z",
          "notEq": "2026-03-13T15:09:38.974Z"
        },
        "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-13T15:09:38.974Z",
          "gt": "2026-03-13T15:09:38.974Z",
          "gte": "2026-03-13T15:09:38.974Z",
          "lt": "2026-03-13T15:09:38.974Z",
          "lte": "2026-03-13T15:09:38.974Z",
          "notEq": "2026-03-13T15:09:38.974Z"
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "orderDate": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-13T15:09:38.974Z",
      "gt": "2026-03-13T15:09:38.974Z",
      "gte": "2026-03-13T15:09:38.974Z",
      "lt": "2026-03-13T15:09:38.974Z",
      "lte": "2026-03-13T15:09:38.974Z",
      "notEq": "2026-03-13T15:09:38.974Z"
    },
    "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-13T15:09:38.974Z",
      "gt": "2026-03-13T15:09:38.974Z",
      "gte": "2026-03-13T15:09:38.974Z",
      "lt": "2026-03-13T15:09:38.974Z",
      "lte": "2026-03-13T15:09:38.974Z",
      "notEq": "2026-03-13T15:09:38.974Z"
    },
    "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
}

Last updated 1 hour ago

hashtagList packing container types

hashtagCreate packing container type

hashtagGet packing container type

hashtagUpdate packing container type

hashtagList packing source containers

hashtagCreate packing source container

hashtagGet packing source container

hashtagList pack jobs

hashtagCreate pack job

hashtagGet pack job

hashtagUpdate pack job

hashtagCall pack job action

hashtagGet pack job delivery note

hashtagGet pack job document handling

hashtagGet pack job return note

hashtagList pack job target containers

hashtagCreate pack job target container

hashtagGet pack job target container

hashtagAdd pack job target container line item

hashtagDelete pack job target container

hashtagUpdate pack job target container

hashtagGet target container delivery note

hashtagDelete target container line item

hashtagUpdate target container line item

hashtagGet target container return note

hashtagGet target container transfer label

hashtagGet pack job transfer label

hashtagList pack jobs (search)

List packing container types

Create packing container type

Get packing container type

Update packing container type

List packing source containers

Create packing source container

Get packing source container

List pack jobs

Create pack job

Get pack job

Update pack job

Call pack job action

Get pack job delivery note

Get pack job document handling

Get pack job return note

List pack job target containers

Create pack job target container

Get pack job target container

Add pack job target container line item

Delete pack job target container

Update pack job target container

Get target container delivery note

Delete target container line item

Update target container line item

Get target container return note

Get target container transfer label

Get pack job transfer label

List pack jobs (search)