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
    • Inbound process
    • Outbound stocks
    • Purchase order
    • Receipt
    • Routing strategy (context-based multi-config DOMS)
    • 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
  • Add or change configuration
  • Add reasons to a picking task.
Edit on GitHub
  1. More Integration Guides
  2. Configurations for order fulfillment

Short-pick reasons

If a picking task cannot be completed because some of the required items are unavailable, it is referred to as a short-pick. To provide clarity on why specific picking tasks cannot be fulfilled entirely, short-pick reasons can be added to the line items of each picking task.

To integrate these reasons into a pick line item, they must be predefined in a configuration file. These reasons are constructed using a multi-language JSON format and are translated accordingly.

The multi language JSON looks like this, with all possible 2-code country codes as valid keys:

{
  "reasonLocalized": {
    "de_DE": "Artikel nicht gefunden",
    "en_US": "Item not found"
  }
}

Add or change configuration

Picking configuration with short-pick reasons

{
  "pickingShortPickConfiguration": {
    "shortPickReasons": [
      {
        "de_DE": "Artikel nicht gefunden",
        "en_US": "Item not found"
      }
    ]
  }
}

Add reasons to a picking task.

Adding shortpick reasons is currently under development. It may not be possible to add shortpick reasons to pickline items at this moment.

Short-pick reasons can be added through the API methods of our PickJobs. See:

A line item with short-pick reasons can look like this.

{
  "id": "87b6d771-ad00-45cb-a00c-527d182a9f57",
  "status": "CLOSED",
  "article": {
    "title": "Item-Name",
    "tenantArticleId": "daf9e470-23f1-4d99-87e8-f20aafc85e0a"
  },
  "quantity": 5,
  "picked": 4,
  "shortPickReasons": [
    {
      "reasonLocalized": {
        "de_DE": "Artikel nicht gefunden",
        "en_US": "Item not found"
      }
    }
  ]
}

When accessed through the API, shortpick reasons will be translated into the required language. The language is determined either by the requested locale or the user's default locale. If neither is specified, the translation will default to the first available localizedReason, or if unavailable, it will default to the localization for "en_US".

If a picking task is restarted or reseted, the short-pick reasons on the pick line items will be deleted.

Last updated 5 months ago