Stow jobs

A stow job represents the instruction to change the storage location or the amount of stock in a facility. The stow job resource holds general information such as the facilityRef or priority, while the stow line item contains information on the items to be moved, their quantity, and their location. A stow line item cannot exist without a parent stow job.

For a step-by-step implementation guide, see the Stow Job Use Cases. For detailed endpoint specifications, refer to the stowjobs section of the REST API Reference.

Create a stow job

This section describes how to create a stow job for relocating items between storage locations. Other scenarios are detailed in the Stow Job Use Cases guide.

To create a stow job, make a POST request to the /api/stowjobs endpoint.

POST https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/stowjobs

The request body must contain the details of the job.

• If a listing is already defined for an article, it can be referenced by providing only the tenantArticleId. The remaining attributes are taken from the listing, but they can be overridden by including them in the request.

• The stowTo array can contain one or more objects if the items are being moved to different destination storage locations.

{
    "facilityRef": "YOUR_FACILITY_REF",
    "priority": 0,
    "shortId": "YOUR_SHORT_ID",
    "status": "OPEN",
    "stowLineItems": [
        {
            "article": {
                "tenantArticleId": "string"
            },
            "stowTo": [
                {
                    "quantity": 2,
                    "storageLocationRef": "DESTINATION_STORAGE_LOCATION_REF",
                    "type": "LOCATION"
                }
            ],
            "takeFrom": {
                "quantity": 2,
                "storageLocationRef": "SOURCE_STORAGE_LOCATION_REF",
                "type": "LOCATION"
            }
        }
    ],
    "targetTime": "1970-01-01T00:00:00.000Z"
}

A successful request returns a HTTP 201 Created status code and a response body representing the created stow job:

{
    "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": "DESTINATION_STORAGE_LOCATION_REF",
                    "type": "LOCATION"
                }
            ],
            "takeFrom": {
                "quantity": 1,
                "scannableCodes": [
                    "12345"
                ],
                "storageLocationRef": "SOURCE_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
}