Stow job endpoints

Get stow job

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

stowJobIdstringRequired

Responses

200

Requested Stow Job entity

application/json

StowJob

createdstring · date-timeOptional

Creation date of the entity, auto-generated if not provided

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

facilityRefstringRequired

Non-human-readable reference to the facility where the stow job is executed

idstringRequired

Auto-generated, unique primary identifier of the stow job

lastModifiedstring · date-timeOptional

Service-generated last modification date of the entity

prioritynumberOptional

Priority level of the job

shortIdstringOptional

Readable identifier for display purposes, not unique.

statusstring · enumRequired

The status of the stowJob

Possible values:

targetTimestring · date-timeOptional

The time by which the job should be completed. Use for prioritization and scheduling

versionnumberRequired

The version of the entity, used for optimistic locking mechanisms

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

get

/api/stowjobs/{stowJobId}

HTTPcURLJavaScriptPython

GET /api/stowjobs/{stowJobId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "assignedUsers": [
    {
      "userId": "text",
      "username": "text"
    }
  ],
  "created": "2026-03-02T17:20:17.578Z",
  "customAttributes": {},
  "facilityRef": "text",
  "id": "text",
  "lastModified": "2026-03-02T17:20:17.578Z",
  "priority": 1,
  "shortId": "text",
  "status": "OPEN",
  "stowLineItems": [
    {
      "article": {
        "titleLocalized": {},
        "customAttributes": {},
        "imageUrl": "text",
        "measurementUnitKey": "text",
        "scannableCodes": [
          "text"
        ],
        "tenantArticleId": "text",
        "title": "text"
      },
      "customAttributes": {},
      "heldStockRef": "text",
      "id": "text",
      "reasons": [
        {
          "reasonLocalized": {},
          "tenantReasonId": "text"
        }
      ],
      "stowTo": [
        {
          "id": "text",
          "quantity": 1,
          "scannableCodes": [
            "text"
          ],
          "stockRef": "text",
          "storageLocationRef": "text",
          "stowed": {
            "stowedAt": "2026-03-02T17:20:17.578Z",
            "stowedQuantity": 1,
            "stowedStockRef": "text",
            "stowedStorageLocationRef": "text"
          },
          "type": "STOCK"
        }
      ],
      "takeFrom": {
        "quantity": 1,
        "scannableCodes": [
          "text"
        ],
        "stockInformation": {
          "properties": {
            "expiry": "text"
          },
          "traitConfig": [
            {
              "enabled": true,
              "trait": "text"
            }
          ]
        },
        "stockRef": "text",
        "storageLocationRef": "text",
        "taken": {
          "takenAt": "2026-03-02T17:20:17.578Z",
          "takenQuantity": 1,
          "takenStockRef": "text"
        },
        "type": "STOCK"
      }
    }
  ],
  "targetTime": "2026-03-02T17:20:17.578Z",
  "version": 1
}

List stow jobs

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

sizenumber · min: 1 · max: 100OptionalDefault: 25

startAfterIdstringOptional

sortstring · enumOptionalPossible values:

facilityRefstring[]Optional

tenantArticleIdstring[]Optional

locationRefstring[]Optional

stockRefstring[]Optional

shortIdstring[]Optional

prioritynumber[]Optional

Responses

200

Paginated result containing the matching Stow Job entities

application/json

StowJobPaginatedResult

totalnumberOptional

The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

get

/api/stowjobs

HTTPcURLJavaScriptPython

GET /api/stowjobs HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "stowJobs": [
    {
      "assignedUsers": [
        {
          "userId": "text",
          "username": "text"
        }
      ],
      "created": "2026-03-02T17:20:17.578Z",
      "customAttributes": {},
      "facilityRef": "text",
      "id": "text",
      "lastModified": "2026-03-02T17:20:17.578Z",
      "priority": 1,
      "shortId": "text",
      "status": "OPEN",
      "stowLineItems": [
        {
          "article": {
            "titleLocalized": {},
            "customAttributes": {},
            "imageUrl": "text",
            "measurementUnitKey": "text",
            "scannableCodes": [
              "text"
            ],
            "tenantArticleId": "text",
            "title": "text"
          },
          "customAttributes": {},
          "heldStockRef": "text",
          "id": "text",
          "reasons": [
            {
              "reasonLocalized": {},
              "tenantReasonId": "text"
            }
          ],
          "stowTo": [
            {
              "id": "text",
              "quantity": 1,
              "scannableCodes": [
                "text"
              ],
              "stockRef": "text",
              "storageLocationRef": "text",
              "stowed": {
                "stowedAt": "2026-03-02T17:20:17.578Z",
                "stowedQuantity": 1,
                "stowedStockRef": "text",
                "stowedStorageLocationRef": "text"
              },
              "type": "STOCK"
            }
          ],
          "takeFrom": {
            "quantity": 1,
            "scannableCodes": [
              "text"
            ],
            "stockInformation": {
              "properties": {
                "expiry": "text"
              },
              "traitConfig": [
                {
                  "enabled": true,
                  "trait": "text"
                }
              ]
            },
            "stockRef": "text",
            "storageLocationRef": "text",
            "taken": {
              "takenAt": "2026-03-02T17:20:17.578Z",
              "takenQuantity": 1,
              "takenStockRef": "text"
            },
            "type": "STOCK"
          }
        }
      ],
      "targetTime": "2026-03-02T17:20:17.578Z",
      "version": 1
    }
  ],
  "total": 1
}

Create stow job

post

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

StowJobForCreation

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

facilityRefstringRequired

Non-human-readable reference to the facility where the stow job is executed

prioritynumberOptional

Priority level of the job

shortIdstringOptional

Readable identifier for display purposes, not unique.

statusstring · enumRequired

The status of the stowJob

Possible values:

targetTimestring · date-timeOptional

The time by which the job should be completed. Use for prioritization and scheduling

Responses

201

Created Stow Job entity

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

422

The syntax of the request content was correct, but it was unable to process the contained instructions, possibly due to semantic errors.

application/json

post

/api/stowjobs

HTTPcURLJavaScriptPython

POST /api/stowjobs HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 985

{
  "assignedUsers": [
    {
      "userId": "text"
    }
  ],
  "customAttributes": {},
  "facilityRef": "text",
  "priority": 1,
  "shortId": "text",
  "status": "OPEN",
  "stowLineItems": [
    {
      "article": {
        "titleLocalized": {},
        "customAttributes": {},
        "imageUrl": "text",
        "measurementUnitKey": "text",
        "scannableCodes": [
          "text"
        ],
        "tenantArticleId": "text",
        "title": "text"
      },
      "customAttributes": {},
      "reasons": [
        {
          "reasonLocalized": {},
          "id": "text",
          "tenantReasonId": "text"
        }
      ],
      "stowTo": [
        {
          "quantity": 1,
          "scannableCodes": [
            "text"
          ],
          "stockRef": "text",
          "storageLocationRef": "text",
          "stowed": {
            "stowedAt": "2026-03-02T17:20:17.578Z",
            "stowedQuantity": 1,
            "stowedStockRef": "text",
            "stowedStorageLocationRef": "text"
          },
          "type": "STOCK"
        }
      ],
      "takeFrom": {
        "quantity": 1,
        "scannableCodes": [
          "text"
        ],
        "stockInformation": {
          "properties": {
            "expiry": "text"
          },
          "traitConfig": [
            {
              "enabled": true,
              "trait": "text"
            }
          ]
        },
        "stockRef": "text",
        "storageLocationRef": "text",
        "taken": {
          "takenAt": "2026-03-02T17:20:17.578Z",
          "takenQuantity": 1,
          "takenStockRef": "text"
        },
        "type": "STOCK"
      }
    }
  ],
  "targetTime": "2026-03-02T17:20:17.578Z"
}

{
  "assignedUsers": [
    {
      "userId": "text",
      "username": "text"
    }
  ],
  "created": "2026-03-02T17:20:17.578Z",
  "customAttributes": {},
  "facilityRef": "text",
  "id": "text",
  "lastModified": "2026-03-02T17:20:17.578Z",
  "priority": 1,
  "shortId": "text",
  "status": "OPEN",
  "stowLineItems": [
    {
      "article": {
        "titleLocalized": {},
        "customAttributes": {},
        "imageUrl": "text",
        "measurementUnitKey": "text",
        "scannableCodes": [
          "text"
        ],
        "tenantArticleId": "text",
        "title": "text"
      },
      "customAttributes": {},
      "heldStockRef": "text",
      "id": "text",
      "reasons": [
        {
          "reasonLocalized": {},
          "tenantReasonId": "text"
        }
      ],
      "stowTo": [
        {
          "id": "text",
          "quantity": 1,
          "scannableCodes": [
            "text"
          ],
          "stockRef": "text",
          "storageLocationRef": "text",
          "stowed": {
            "stowedAt": "2026-03-02T17:20:17.578Z",
            "stowedQuantity": 1,
            "stowedStockRef": "text",
            "stowedStorageLocationRef": "text"
          },
          "type": "STOCK"
        }
      ],
      "takeFrom": {
        "quantity": 1,
        "scannableCodes": [
          "text"
        ],
        "stockInformation": {
          "properties": {
            "expiry": "text"
          },
          "traitConfig": [
            {
              "enabled": true,
              "trait": "text"
            }
          ]
        },
        "stockRef": "text",
        "storageLocationRef": "text",
        "taken": {
          "takenAt": "2026-03-02T17:20:17.578Z",
          "takenQuantity": 1,
          "takenStockRef": "text"
        },
        "type": "STOCK"
      }
    }
  ],
  "targetTime": "2026-03-02T17:20:17.578Z",
  "version": 1
}

List stow jobs (search)

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Search for StowJob

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

StowJobSearchPayload

afterstringOptional

The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.

beforestringOptional

The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).

lastnumber · min: 1 · max: 250Optional

Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.

sizenumber · min: 1 · max: 250Optional

Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.

startAfterIdstringOptionalDeprecated

The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.

Responses

200

Your search result

application/json

StowJobPaginatedResult

totalnumberOptional

The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

post

/api/stowjobs/search

HTTPcURLJavaScriptPython

POST /api/stowjobs/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 9183

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T17:20:17.578Z",
              "gt": "2026-03-02T17:20:17.578Z",
              "gte": "2026-03-02T17:20:17.578Z",
              "lt": "2026-03-02T17:20:17.578Z",
              "lte": "2026-03-02T17:20:17.578Z",
              "notEq": "2026-03-02T17:20:17.578Z"
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "priority": {
              "eq": 1,
              "gt": 1,
              "gte": 1,
              "in": [
                1
              ],
              "lt": 1,
              "lte": 1,
              "notEq": 1,
              "notIn": [
                1
              ]
            },
            "shortId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            },
            "stowLineItems": {
              "contains": {
                "article": {
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                },
                "heldStockRef": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "id": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "stowTo": {
                  "contains": {
                    "storageLocationRef": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    },
                    "stowed": {
                      "stowedStockRef": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      },
                      "stowedStorageLocationRef": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      }
                    },
                    "type": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    }
                  }
                },
                "takeFrom": {
                  "storageLocationRef": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "taken": {
                    "takenStockRef": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    }
                  },
                  "type": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T17:20:17.578Z",
              "gt": "2026-03-02T17:20:17.578Z",
              "gte": "2026-03-02T17:20:17.578Z",
              "lt": "2026-03-02T17:20:17.578Z",
              "lte": "2026-03-02T17:20:17.578Z",
              "notEq": "2026-03-02T17:20:17.578Z"
            }
          }
        ],
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T17:20:17.578Z",
          "gt": "2026-03-02T17:20:17.578Z",
          "gte": "2026-03-02T17:20:17.578Z",
          "lt": "2026-03-02T17:20:17.578Z",
          "lte": "2026-03-02T17:20:17.578Z",
          "notEq": "2026-03-02T17:20:17.578Z"
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T17:20:17.578Z",
              "gt": "2026-03-02T17:20:17.578Z",
              "gte": "2026-03-02T17:20:17.578Z",
              "lt": "2026-03-02T17:20:17.578Z",
              "lte": "2026-03-02T17:20:17.578Z",
              "notEq": "2026-03-02T17:20:17.578Z"
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "priority": {
              "eq": 1,
              "gt": 1,
              "gte": 1,
              "in": [
                1
              ],
              "lt": 1,
              "lte": 1,
              "notEq": 1,
              "notIn": [
                1
              ]
            },
            "shortId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            },
            "stowLineItems": {
              "contains": {
                "article": {
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                },
                "heldStockRef": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "id": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "stowTo": {
                  "contains": {
                    "storageLocationRef": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    },
                    "stowed": {
                      "stowedStockRef": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      },
                      "stowedStorageLocationRef": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      }
                    },
                    "type": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    }
                  }
                },
                "takeFrom": {
                  "storageLocationRef": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "taken": {
                    "takenStockRef": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    }
                  },
                  "type": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T17:20:17.578Z",
              "gt": "2026-03-02T17:20:17.578Z",
              "gte": "2026-03-02T17:20:17.578Z",
              "lt": "2026-03-02T17:20:17.578Z",
              "lte": "2026-03-02T17:20:17.578Z",
              "notEq": "2026-03-02T17:20:17.578Z"
            }
          }
        ],
        "priority": {
          "eq": 1,
          "gt": 1,
          "gte": 1,
          "in": [
            1
          ],
          "lt": 1,
          "lte": 1,
          "notEq": 1,
          "notIn": [
            1
          ]
        },
        "shortId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "status": {
          "eq": "OPEN",
          "in": [
            "OPEN"
          ],
          "notEq": "OPEN"
        },
        "stowLineItems": {
          "contains": {
            "article": {
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "heldStockRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "stowTo": {
              "contains": {
                "storageLocationRef": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "stowed": {
                  "stowedStockRef": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "stowedStorageLocationRef": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                },
                "type": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "takeFrom": {
              "storageLocationRef": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "taken": {
                "takenStockRef": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "type": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          }
        },
        "targetTime": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T17:20:17.578Z",
          "gt": "2026-03-02T17:20:17.578Z",
          "gte": "2026-03-02T17:20:17.578Z",
          "lt": "2026-03-02T17:20:17.578Z",
          "lte": "2026-03-02T17:20:17.578Z",
          "notEq": "2026-03-02T17:20:17.578Z"
        }
      }
    ],
    "created": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T17:20:17.578Z",
      "gt": "2026-03-02T17:20:17.578Z",
      "gte": "2026-03-02T17:20:17.578Z",
      "lt": "2026-03-02T17:20:17.578Z",
      "lte": "2026-03-02T17:20:17.578Z",
      "notEq": "2026-03-02T17:20:17.578Z"
    },
    "customAttributes": {
      "ANY_ADDITIONAL_PROPERTY": {
        "eq": true,
        "notEq": true
      }
    },
    "facilityRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T17:20:17.578Z",
          "gt": "2026-03-02T17:20:17.578Z",
          "gte": "2026-03-02T17:20:17.578Z",
          "lt": "2026-03-02T17:20:17.578Z",
          "lte": "2026-03-02T17:20:17.578Z",
          "notEq": "2026-03-02T17:20:17.578Z"
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "priority": {
          "eq": 1,
          "gt": 1,
          "gte": 1,
          "in": [
            1
          ],
          "lt": 1,
          "lte": 1,
          "notEq": 1,
          "notIn": [
            1
          ]
        },
        "shortId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "status": {
          "eq": "OPEN",
          "in": [
            "OPEN"
          ],
          "notEq": "OPEN"
        },
        "stowLineItems": {
          "contains": {
            "article": {
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "heldStockRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "stowTo": {
              "contains": {
                "storageLocationRef": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "stowed": {
                  "stowedStockRef": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "stowedStorageLocationRef": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                },
                "type": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "takeFrom": {
              "storageLocationRef": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "taken": {
                "takenStockRef": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "type": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          }
        },
        "targetTime": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T17:20:17.578Z",
          "gt": "2026-03-02T17:20:17.578Z",
          "gte": "2026-03-02T17:20:17.578Z",
          "lt": "2026-03-02T17:20:17.578Z",
          "lte": "2026-03-02T17:20:17.578Z",
          "notEq": "2026-03-02T17:20:17.578Z"
        }
      }
    ],
    "priority": {
      "eq": 1,
      "gt": 1,
      "gte": 1,
      "in": [
        1
      ],
      "lt": 1,
      "lte": 1,
      "notEq": 1,
      "notIn": [
        1
      ]
    },
    "shortId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "status": {
      "eq": "OPEN",
      "in": [
        "OPEN"
      ],
      "notEq": "OPEN"
    },
    "stowLineItems": {
      "contains": {
        "article": {
          "tenantArticleId": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "heldStockRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "stowTo": {
          "contains": {
            "storageLocationRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "stowed": {
              "stowedStockRef": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "stowedStorageLocationRef": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "type": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        },
        "takeFrom": {
          "storageLocationRef": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "taken": {
            "takenStockRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "type": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        }
      }
    },
    "targetTime": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T17:20:17.578Z",
      "gt": "2026-03-02T17:20:17.578Z",
      "gte": "2026-03-02T17:20:17.578Z",
      "lt": "2026-03-02T17:20:17.578Z",
      "lte": "2026-03-02T17:20:17.578Z",
      "notEq": "2026-03-02T17:20:17.578Z"
    }
  },
  "size": 1,
  "sort": [
    {
      "created": "ASC",
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "lastModified": "ASC",
      "targetTime": "ASC"
    }
  ]
}

{
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "stowJobs": [
    {
      "assignedUsers": [
        {
          "userId": "text",
          "username": "text"
        }
      ],
      "created": "2026-03-02T17:20:17.578Z",
      "customAttributes": {},
      "facilityRef": "text",
      "id": "text",
      "lastModified": "2026-03-02T17:20:17.578Z",
      "priority": 1,
      "shortId": "text",
      "status": "OPEN",
      "stowLineItems": [
        {
          "article": {
            "titleLocalized": {},
            "customAttributes": {},
            "imageUrl": "text",
            "measurementUnitKey": "text",
            "scannableCodes": [
              "text"
            ],
            "tenantArticleId": "text",
            "title": "text"
          },
          "customAttributes": {},
          "heldStockRef": "text",
          "id": "text",
          "reasons": [
            {
              "reasonLocalized": {},
              "tenantReasonId": "text"
            }
          ],
          "stowTo": [
            {
              "id": "text",
              "quantity": 1,
              "scannableCodes": [
                "text"
              ],
              "stockRef": "text",
              "storageLocationRef": "text",
              "stowed": {
                "stowedAt": "2026-03-02T17:20:17.578Z",
                "stowedQuantity": 1,
                "stowedStockRef": "text",
                "stowedStorageLocationRef": "text"
              },
              "type": "STOCK"
            }
          ],
          "takeFrom": {
            "quantity": 1,
            "scannableCodes": [
              "text"
            ],
            "stockInformation": {
              "properties": {
                "expiry": "text"
              },
              "traitConfig": [
                {
                  "enabled": true,
                  "trait": "text"
                }
              ]
            },
            "stockRef": "text",
            "storageLocationRef": "text",
            "taken": {
              "takenAt": "2026-03-02T17:20:17.578Z",
              "takenQuantity": 1,
              "takenStockRef": "text"
            },
            "type": "STOCK"
          }
        }
      ],
      "targetTime": "2026-03-02T17:20:17.578Z",
      "version": 1
    }
  ],
  "total": 1
}

Update stow job

patch

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

stowJobIdstringRequired

Body

application/json

StowJobForPatch

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

prioritynumberOptional

Information for user about which job should be started first

targetTimestring · date-timeOptional

versionnumberRequired

The version of the document to be used in optimistic locking mechanisms

Responses

200

Stow Job successfully patched

No content

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

409

A version conflict occurred.

application/json

422

The syntax of the request content was correct, but it was unable to process the contained instructions, possibly due to semantic errors.

application/json

patch

/api/stowjobs/{stowJobId}

HTTPcURLJavaScriptPython

PATCH /api/stowjobs/{stowJobId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "assignedUsers": [
    {
      "userId": "text"
    }
  ],
  "customAttributes": {},
  "priority": 1,
  "targetTime": "2026-03-02T17:20:17.578Z",
  "version": 1
}

No content

Call stow job action

post

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

stowJobIdstringRequired

Body

application/json

or

or

or

or

or

or

Responses

200

Actions successfully performed

No content

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

409

A version conflict occurred.

application/json

422

The syntax of the request content was correct, but it was unable to process the contained instructions, possibly due to semantic errors.

application/json

post

/api/stowjobs/{stowJobId}/actions

HTTPcURLJavaScriptPython

POST /api/stowjobs/{stowJobId}/actions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "name": "START_STOW_JOB",
  "version": 1
}

No content