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
  • Setting the Packing Configuration
  • Scanning Type
  • Packing Container Required
  • Packing Item Confirmation Needed
  • Packing Source Container Configuration
Edit on GitHub
  1. More Integration Guides
  2. Configurations for order fulfillment

Packing configuration

Setting the Packing Configuration

You can set:

  • the scanning type for pack line items

  • if packing containers are required

  • if pack line items need a confirmation

  • if packing source containers are used

Request
curl -sSL -X PATCH 'https://your.api.fulfillmenttools.com/api/configurations/packing' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "scanningConfiguration":{
        "scanningType" : "MUST_SCAN_FIRST"
    },
    "packingContainerRequiredConfiguration": {
        "active": false
    },
    "packingItemConfirmationNeededConfiguration": {
        "active": true
    },
    "packingSourceContainerConfiguration":{
        "active": false
    },
    "version": 42,
}'
Response
Status: 200 OK

{
    "id": "packing-configurations",
    "packingContainerRequiredConfiguration": {
        "active": false
    },
    "version": 42,
    "created": "2023-05-12T08:38:32.182Z",
    "lastModified": "2023-08-17T13:39:08.347Z",
    "packingItemConfirmationNeededConfiguration": {
        "active": true
    },
    "packingSourceContainerConfiguration": {
        "active": false
    },
    "scanningConfiguration": {
        "scanningType": "MUST_SCAN_FIRST"
    }
}

Scanning Type

The scanning type defines whether a physical scan of the code of all pack line items is required in order to finish a pack job or not.

The available options are: SCAN_NOT_REQUIRED or MUST_SCAN_EACH.

SCAN_NOT_REQUIRED: a scan is not needed MUST_SCAN_EACH: each pack line item has to be scanned

Packing Container Required

This flag enables the search for pack jobs via the scanned code of load units.

If set to true, the search is available in the pack job screen, if set to false, the search is not available

Packing Item Confirmation Needed

This flag activates the need to check off each pack line item within a pack job in order to finish a pack job.

If set to true, each pick line item needs to be checked off, if set to false, checking off is not needed in order to finish a pack job.

This config will have no effect when Scanning Type is set to MUST_SCAN_EACH. In this case scanning each pack line item is mandatory in order to finish a pack job.

Packing Source Container Configuration

This flag enables the creation of packing source container. Packing source containers are entities that contain one ore more items for a pack job. These entities can be, for example, a load unit.

If set to true, packing source container are created from existing load units when a pack job is created from a pick job. If set to false, packing source container are not created as explained in the previous sentence.

In order to be able to search for pack jobs via the scanned code of a load unit packing packingContainerRequiredConfiguration as well as packingSourceContainerConfiguration have to be set to true.

Last updated 5 months ago