Local fulfillment configuration

The order fulfillment with the fulfillmenttools mobile app has three stages:

• Picking

• Packing

• Handover

First, the order items need to be picked, then packed into boxes, and then handed over to the carrier or the customer. Let's configure the behavior!

Picking

More Tag-Configuration-API information can be found here: REST API documentation - Tag-Configuration

As discovered in earlier parts of our tutorial, the entity involved in the picking process is the pick job. To configure the app's behavior in that process, we need to adjust the pick job tag configuration. Let's first get our information on how it is currently configured:

GET https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/configurations/tags/pickjob

200 OK response

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

We do not need special documents in the picking step, so the default settings fit our needs here. In further stages of the integration, something like a sticker shown in the app for some tags might be imaginable, but LU.XY does not need anything special for now.

Packing

Now let's have a look at the PackJob's configuration:

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 shows us which documents are offered for printing inside the packing process. Per default, these are the shipping label and a return note. LU.XY does not need a return note, as the delivery note shows the information. They want to print these documents:

• Shipping label

• Return label

• External documents (delivery note from some marketplaces)

• Delivery note

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

As you might have noticed, the list of offeredDocumentsByDefault is a bit longer and contains different items. The response is a 200 OK reading back the uploaded information:

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

More Handover-Tag-API information can be found here: REST API documentation - Handover-Tag

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

GET https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/configurations/tags/handoverjob

200 OK response

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