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
    • Address formats for specific carriers
    • Basics
      • Article categories
      • Audits
      • Custom services & bundled line items
      • Facilities
      • Facility groups
      • GDPR configuration
      • Listings
      • Orders
        • Order types
        • Order status
      • 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
    • Availability & promising
    • Returns
Powered by GitBook
On this page
Edit on GitHub
  1. More Integration Guides
  2. Configurations for order fulfillment

Printing and document configuration

It is possible to add documents that are relevant in the operational process, for example, while picking or packing.

Instructions

PUT on /api/configurations/tags/pickjob

OR /api/configurations/tags/packjob. Depending on which process steps it is needed.

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

It is up to you, if you like to handle it per default means for every pickjob/packjob the same or via tags. Tags can be helpful to handle pickjobs/packjobs differently. For example a marketplace order needs other documents than orders from it’s own store. Then do this:

    "offeredDocumentsPerTag": [
        {
            "tagRef": "TAG-ID",
            "matchingValues": [
                "MUST-MATCH-VALUE-IN-TAG"
            ],
            "offeredDocuments": [
                {
                    "documentCategory": "EXTERNAL"
                }
            ],
            "tagRef": "TAG-ID",
            "matchingValues": [
                "MUST-MATCH-VALUE-IN-TAG"
            ],
            "offeredDocuments": [
                {
                    "documentCategory": "RETURNNOTE"
                }
            ]
        }
    ]

If you handle it via tags, then every order/pickjob/packjob needs a tag, when it’s created

    "tags": [
        {
            "tagRef": "string",
            "value": "string"
        }

Effect in the fft clients:

If it’s configured in pickjobs you see this:

If it’s configured in packjobs you see this:

Last updated 6 months ago