Local fulfillment configuration

Order fulfillment with the fulfillmenttools Operations App has three stages:

• Picking

• Packing

• Handover

During these stages, order items are picked, packed into boxes, and handed over to the carrier or the customer. This guide explains how to configure the system behavior for each stage.

Picking

For detailed information, see the pickjob Tag Configuration API documentation.

The entity involved in the picking process is the pick job. To configure the behavior of the Operations App during this process, the pick job tag configuration can be adjusted.

First, retrieve the current configuration:

GET https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/configurations/tags/pickjob

200 OK response

{
  "version": 1,
  "offeredDocumentsPerTag": [],
  "offeredDocumentsByDefault": [
    {
      "documentCategory": "SENDLABEL"
    },
    {
      "documentCategory": "RETURNNOTE"
    }
  ]
}

This use case does not require special documents during the picking step, so the default settings are sufficient.

Packing

Next, examine the configuration for the pack job.

GET https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/configurations/tags/packjob

200 OK response

{
  "id": "tag_packjob",
  "version": 1,
  "created": "2024-02-06T13:13:49.810Z",
  "lastModified": "2024-02-06T13:13:49.810Z",
  "offeredDocumentsByDefault": [
    {
      "documentCategory": "SENDLABEL"
    },
    {
      "documentCategory": "RETURNNOTE"
    }
  ],
  "offeredDocumentsPerTag": [],
  "packJobCreationPerTag": []
}

The offeredDocumentsByDefault property defines which documents are available for printing during the packing process. By default, these are the shipping label (SENDLABEL) and a return note (RETURNNOTE).

The LU.XY use case does not require a return note. Instead, the following documents must be available for printing:

• Shipping Label

• Return Label

• External Document (e.g., a delivery note from a marketplace)

• Delivery Note

To apply this change, send a PUT request with the updated list of documents.

PUT request to update document offerings

PUT https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/configurations/tags/packjob

{
    "version": 1,
    "offeredDocumentsByDefault": [
        {
            "documentCategory": "SENDLABEL"
        },
        {
            "documentCategory": "RETURNLABEL"
        },
        {
            "documentCategory": "EXTERNAL"
        },
        {
            "documentCategory": "DELIVERYNOTE"
        }
    ],
    "offeredDocumentsPerTag": [],
    "packJobCreationPerTag": []
}

The API returns a 200 OK response containing the updated configuration with an incremented version number.

200 OK response

{
    "id": "tag_packjob",
    "version": 2,
    "created": "2023-11-23T12:21:01.256Z",
    "lastModified": "2024-02-06T13:24:10.747Z",
    "offeredDocumentsByDefault": [
        {
            "documentCategory": "SENDLABEL"
        },
        {
            "documentCategory": "RETURNLABEL"
        },
        {
            "documentCategory": "EXTERNAL"
        },
        {
            "documentCategory": "DELIVERYNOTE"
        }
    ],
    "offeredDocumentsPerTag": [],
    "packJobCreationPerTag": []
}

Handover

For detailed information, see the handoverjob Tag Configuration API documentation.

The handover is the process of giving the package to the parcel courier. When using a label generated with the fulfillmenttools platform, the handover job is closed automatically.

To review the current configuration, retrieve it via the API:

GET https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/configurations/tags/handoverjob

200 OK response

{
    "version": 1,
    "offeredDocumentsPerTag": [],
    "offeredDocumentsByDefault": [
        {
            "documentCategory": "SENDLABEL"
        },
        {
            "documentCategory": "RETURNNOTE"
        }
    ]
}