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. Integration Guides

Stow jobs

PreviousShow sticker to clientsNextCarrier management

Last updated 2 months ago

Stow jobs represent the intention or instruction to change the storage location and/or the amount of stock in a facility. While the stow job itself holds general information such as the facility or priority of the job, the stow line item contains information on the items to be moved, their quantity, location, and more. Stow line items cannot exist without a stow job.

A step by step implementation guide can be found under . More StowJob-API information can be found here:

Create a stow job

This page describes how to create stow job for relocating items between locations. For other use cases, please refer to the .

To create a stowJob, do the following POST call with the JSON body:

POST https://{YOUR-TENANT-NAME}.fulfillmenttools.com/api/stowjobs
{
    "facilityRef": "YOUR_FACILITY_REF",
    "priority": 0,
    "shortId": "YOUR_SHORT_ID",
    "status": "OPEN",
    "stowLineItems": [
        {
            "article": {
                "tenantArticleId": "string"
                // if you already defined a listing for this article you can reference it by providing only the tenantArticleId
                // the remaining attributes will be taken from the listing but you can override certain attributes by providing them here
            },
            "stowTo": [ // If the taken items should be put on different locations, mulitple stowTo objects can be defined.
                {
                    "quantity": 2,
                    "storageLocationRef": "YOUR_STORAGE_LOCATION_REF",
                    "type": "LOCATION"
                }
            ],
            "takeFrom": {
                "quantity": 2
            },
            "storageLocationRef": "YOUR_STORAGE_LOCATION_REF",
            "type": "LOCATION"
        }
    ],
    "targetTime": "1970-01-01T00:00:00.000Z"
}

If the request is successful, we receive a 201 CREATED response with a body like this:

{
    "id": "71523fea-d80f-45e2-a128-9af163352db3",
    "created": "2024-12-16T12:00:38.362Z",
    "lastModified": "2024-12-16T12:00:38.362Z",
    "version": 1,
    "facilityRef": "YOUR_FACILITY_REF",
    "status": "OPEN",
    "stowLineItems": [
        {
            "id": "94ba740e-e8ac-47c2-8d38-30ad01f8c45b",
            "stowTo": [
                {
                    "id": "ID_OF_STOWTO_OBJECT",
                    "quantity": 1,
                    "storageLocationRef": "YOUR_STORAGE_LOCATION_REF",
                    "type": "LOCATION"
                }
            ],
            "takeFrom": {
                "quantity": 1,
                "scannableCodes": [
                    "12345"
                ],
                "storageLocationRef": "YOUR_STORAGE_LOCATION_REF",
                "type": "LOCATION"
            },
            "article": {
                "tenantArticleId": "11111",
                "imageUrl": "YOUR_IMAGE_URL",
                "title": "YOUR_LISTING_TITLE",
                "titleLocalized": {
                    "en_US": "YOUR_LOCALIZED_TITLE",
                    "de_DE": "YOUR_LOCALIZED_TITLE"
                },
                "measurementUnitKey": "YOUR_LISTING_MEASUREMENT_UNIT",
                "scannableCodes": [
                    "YOUR_LISTING_SCANNABLE_CODES"
                ]
            },
            "reasons": []
        }
    ],
    "shortId": "YOUR_SHORT_ID",
    "priority": 0
}
REST API documentation - Stow Jobs
Products – Use Cases
use case section