fulfillmenttools
API documentationIncident ManagementFeedback
Developer Docs
Developer Docs
  • Developer docs
  • Getting Started
    • Quickstart
    • Integration tutorial
      • Adding facilities
      • Adding listings to facilities
      • Configuring stocks
      • Carrier configuration
      • Placing orders
      • Checkout options
      • Distributed Order Management System (Routing)
      • Local fulfillment configuration
    • Free trial
  • Technical Basics
    • Access to fulfillmenttools
    • Feature status
    • Available regions
    • Backup policies
  • Connecting to fulfillmenttools
    • Client SDKs
    • commercetools connect
    • OpenID connect
      • Configure Microsoft Entra ID / Azure Active Directory
      • Configure Keycloak
  • API
    • Core concepts
      • Authentication & authorization
      • API Versioning & lifecycle
      • Assign user to jobs
      • Localization
      • Resource timestamps
      • Custom attributes
      • Article attributes
      • Recordable attributes
      • Data update guarantees
      • Rate limits & scaling
      • Retries
      • Performance on test vs. production systems
      • Load testing
    • API calls
      • Postman
      • cURL
      • GraphQL Explorer
    • GraphQL API
    • RESTful API
      • Pagination interface
      • RapiDoc
      • OpenAPI 3.0 Spec
    • Eventing
      • Structure of an event
      • Available events
        • Event flows
      • Eventing example
      • Event export
  • Integration Guides
    • Basics
      • Article categories
      • Audits
      • Facilities
      • Facility groups
      • GDPR configuration
      • Listings
      • Remote configuration
      • Receipts
      • Search
      • Subscribe to events
      • Sticker
      • Stocks
      • Storage locations
      • Tags
      • Users
    • Channel inventory
    • Facility discounts
    • Inbound process
    • Outbound stocks
    • Purchase order
    • Receipt
    • Routing strategy
    • Show sticker to clients
    • Stow jobs
  • More Integration Guides
    • Carrier management
      • Introduction to carrier configuration
      • Required data when operating carriers
      • Adding & connecting carriers to facilities
      • Custom carrier
    • Configurations for order fulfillment
      • Picking configuration
      • Packing configuration
      • Handover configuration
      • Printing and document configuration
      • Packing container types
      • Parcel tag configuration
      • Headless order fulfillment
      • Short-pick reasons
      • External documents in order fulfillment
      • Service jobs
      • Load units
      • Running sequence
    • DOMS - distributed order management system (routing)
    • External actions
    • Interfacility transfer
    • Notifications
    • Orders
      • Place your first order
      • Ship-from-store orders
      • Click-and-collect orders
      • Locked orders
      • Order with custom services
      • Bundled items in an order
      • Order process status
    • Availability & promising
    • Returns
Powered by GitBook
On this page
  • Picking
  • Packing
Edit on GitHub
  1. More Integration Guides

Configurations for order fulfillment

Last updated 5 months ago

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

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

This page serves as an introduction to the configurations. Please see the sub-pages of this site for more detailed information.

Picking

As discovered in earlier parts of our tutorial, the entity involved in the picking process is the pickjob. To configure the app's behaviour in that process, we need to adjust the PickJob tag configuration. This is made using the . Let's first get our information how it is currently configured:

curl --location 'https://your.api.fulfillmenttools.com/api/configurations/tags/pickjob' \
--header 'Authorization: Bearer <TOKEN>'

The platform responds with a 200 OK response showing us the configuration:

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

As we do not need special documents in the picking step, 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:

curl --location 'https://your.api.fulfillmenttools.com/api/configurations/tags/packjob' \
--header 'Authorization: Bearer <TOKEN>'

Again we will receive a 200 OK response showing the configuration:

{
  "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 information is shown on the delivery note. They want to print these documents:

  • Shipping label

  • Return label

  • External documents (delivery note from some marketplaces)

  • Delivery note

curl --location --request PUT 'https://your.api.fulfillmenttools.com/api/configurations/tags/packjob' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data '{
    "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:

{
    "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

curl --location 'https://your.api.fulfillmenttools.com/api/configurations/tags/handoverjob' \
--header 'Authorization: Bearer <TOKEN>'

The 200 OK response again informs us about the current configuration:

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

This is configured by the :

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. However, let's look at the configuring using :

Picking
Packing
Handover
tag configuration endpoint
PUT PackJob configuration endpoint
GET endpoint