Stock endpoints

Get stock

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

stockIdstringRequired

Responses

200

Stock

application/json

Stock

availablenumberRequired

availableUntilstring · date-timeOptional

defines until when a stock is included in the stock availability as available and used for routing

createdstring · date-timeRequired

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

facility in which the stock is located

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

facilityWideReservednumberRequiredDeprecated

idstringRequired

lastModifiedstring · date-timeRequired

locationRefstringOptional

location on which the stock is placed

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

receiptDatestring · date-timeOptional

date-time when stock has entered the system, defaults to the creation date

Example: 2026-06-17T12:00:00.000Z

reservednumberRequired

amount of this stock reserved for customer orders

scannableCodesstring[]Optional

scannableCodes such as barcodes that identify this stock

serializedPropertiesstringRequired

properties object serialized as JSON string, sorted alphabetically by key

tenantArticleIdstring · min: 1Required

tenantArticleId of the stock

Example: MY_ARTICLE_ID

tenantStockIdstringOptional

tenantStockId is an optional identifier for the stock in the tenant system.

Example: MY_STOCK_ID

valueinteger · int32RequiredExample: 42

versionnumberRequired

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 endpoint

application/json

get/api/stocks/{stockId}

HTTPcURLJavaScriptPython

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

{
  "available": 1,
  "availableUntil": "2026-07-22T22:31:55.253Z",
  "conditions": [
    "DEFECTIVE"
  ],
  "created": "2026-07-22T22:31:55.253Z",
  "customAttributes": {},
  "facility": {
    "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "tenantFacilityId": "MY_FACILITY_ID"
  },
  "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "id": "text",
  "lastModified": "2026-07-22T22:31:55.253Z",
  "locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "properties": {
    "expiry": "text"
  },
  "receiptDate": "2026-06-17T12:00:00.000Z",
  "reserved": 1,
  "scannableCodes": [
    "text"
  ],
  "scores": [
    {
      "scoreName": "ZONE",
      "scoreType": "RATING",
      "scoreValue": 1
    }
  ],
  "serializedProperties": "text",
  "tenantArticleId": "MY_ARTICLE_ID",
  "tenantStockId": "MY_STOCK_ID",
  "traitConfig": [
    {
      "enabled": true,
      "trait": "text"
    }
  ],
  "traits": [
    "PICKABLE"
  ],
  "value": 42,
  "version": 1
}

List stocks

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

facilityRefstringOptional

tenantFacilityIdstringOptional

tenantArticleIdstring[] · max: 500OptionalExample: MY_ARTICLE_ID

locationRefstring[] · max: 500OptionalExample: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

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

startAfterIdstringOptional

Responses

200

Stocks

application/json

StockPaginatedResult

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 endpoint

application/json

get/api/stocks

HTTPcURLJavaScriptPython

GET /api/stocks 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"
  },
  "stocks": [
    {
      "available": 1,
      "availableUntil": "2026-07-22T22:31:55.253Z",
      "conditions": [
        "DEFECTIVE"
      ],
      "created": "2026-07-22T22:31:55.253Z",
      "customAttributes": {},
      "facility": {
        "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "tenantFacilityId": "MY_FACILITY_ID"
      },
      "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "id": "text",
      "lastModified": "2026-07-22T22:31:55.253Z",
      "locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "properties": {
        "expiry": "text"
      },
      "receiptDate": "2026-06-17T12:00:00.000Z",
      "reserved": 1,
      "scannableCodes": [
        "text"
      ],
      "scores": [
        {
          "scoreName": "ZONE",
          "scoreType": "RATING",
          "scoreValue": 1
        }
      ],
      "serializedProperties": "text",
      "tenantArticleId": "MY_ARTICLE_ID",
      "tenantStockId": "MY_STOCK_ID",
      "traitConfig": [
        {
          "enabled": true,
          "trait": "text"
        }
      ],
      "traits": [
        "PICKABLE"
      ],
      "value": 42,
      "version": 1
    }
  ],
  "total": 1
}

List stock summaries

get

Get the accumulated Stock for each Article

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

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

startAfterIdstringOptional

The stockSummaries.article.tenantArticleId value should be used for pagination.

facilityGroupRefsstring[] · max: 1OptionalExample: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]

facilityRefsstring[]Optional

allowStalebooleanOptional

tenantArticleIdsstring[]Optional

maxPageSizenumber · min: 1 · max: 100Optional

Returns stock summaries using adaptive batching to reduce latency spikes, as a consequence response time will have a more consistent upper bound but page size may be reduced below the maximum - This overrides size argument.

channelRefsstring[] · max: 50Optional

The channels to included under "channelAdjusted" in the stock summary. Provide up to 50 channelRefs, specify "UNALLOCATED for unallocated stock."

Example: ["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]

Responses

200

Stock summaries was loaded & you were allowed to access it. The result is in the body.

application/json

StockSummaries

totalnumberRequired

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 endpoint

application/json

get/api/stocks/summaries

HTTPcURLJavaScriptPython

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

{
  "stockSummaries": [
    {
      "article": {
        "imageUrl": "text",
        "tenantArticleId": "text",
        "title": "text"
      },
      "details": {
        "availableForPicking": 1,
        "availableOnStock": 1,
        "byTrait": {
          "ACCESSIBLE": 1,
          "PICKABLE": 1
        },
        "channelAdjusted": [
          {
            "availableForPicking": 1,
            "availableOnStock": 1,
            "channelRef": "text"
          }
        ],
        "reserved": 1,
        "safetyStock": 1,
        "stockOnHand": 1,
        "totalAmount": 1
      },
      "includedFacilityRefs": [
        "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
      ]
    }
  ],
  "total": 1
}

Create stock

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

StockForCreation

availableUntilstring · date-timeOptional

defines until when a stock is included in the stock availability as available and used for routing

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.

facilityone ofOptional

Selector for the facility. Either a facility reference or a tenant facility ID must be provided.

or

facilityRefstringOptionalDeprecated

facility in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

locationRefstringOptional

location on which the stock is placed

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

receiptDatestring · date-timeOptional

date-time when stock has entered the system, defaults to the creation date

Example: 2026-06-17T12:00:00.000Z

tenantArticleIdstring · min: 1Required

tenantArticleId of the stock

Example: MY_ARTICLE_ID

tenantFacilityIdstringOptionalDeprecated

tenantFacilityId in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead

Example: MY_FACILITY_ID

tenantStockIdstringOptional

tenantStockId is an optional identifier for the stock in the tenant system.

Example: MY_STOCK_ID

valueinteger · int32RequiredExample: 42

Responses

201

Stock was created.

application/json

Stock

availablenumberRequired

availableUntilstring · date-timeOptional

defines until when a stock is included in the stock availability as available and used for routing

createdstring · date-timeRequired

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

facility in which the stock is located

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

facilityWideReservednumberRequiredDeprecated

idstringRequired

lastModifiedstring · date-timeRequired

locationRefstringOptional

location on which the stock is placed

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

receiptDatestring · date-timeOptional

date-time when stock has entered the system, defaults to the creation date

Example: 2026-06-17T12:00:00.000Z

reservednumberRequired

amount of this stock reserved for customer orders

scannableCodesstring[]Optional

scannableCodes such as barcodes that identify this stock

serializedPropertiesstringRequired

properties object serialized as JSON string, sorted alphabetically by key

tenantArticleIdstring · min: 1Required

tenantArticleId of the stock

Example: MY_ARTICLE_ID

tenantStockIdstringOptional

tenantStockId is an optional identifier for the stock in the tenant system.

Example: MY_STOCK_ID

valueinteger · int32RequiredExample: 42

versionnumberRequired

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 endpoint

application/json

post/api/stocks

HTTPcURLJavaScriptPython

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

{
  "availableUntil": "2026-07-22T22:31:55.253Z",
  "conditions": [
    "DEFECTIVE"
  ],
  "customAttributes": {},
  "facility": {
    "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
  },
  "locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "properties": {
    "expiry": "text",
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "receiptDate": "2026-06-17T12:00:00.000Z",
  "tenantArticleId": "MY_ARTICLE_ID",
  "tenantStockId": "MY_STOCK_ID",
  "traitConfig": [
    {
      "enabled": true,
      "trait": "text"
    }
  ],
  "value": 42
}

{
  "available": 1,
  "availableUntil": "2026-07-22T22:31:55.253Z",
  "conditions": [
    "DEFECTIVE"
  ],
  "created": "2026-07-22T22:31:55.253Z",
  "customAttributes": {},
  "facility": {
    "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "tenantFacilityId": "MY_FACILITY_ID"
  },
  "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "id": "text",
  "lastModified": "2026-07-22T22:31:55.253Z",
  "locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "properties": {
    "expiry": "text"
  },
  "receiptDate": "2026-06-17T12:00:00.000Z",
  "reserved": 1,
  "scannableCodes": [
    "text"
  ],
  "scores": [
    {
      "scoreName": "ZONE",
      "scoreType": "RATING",
      "scoreValue": 1
    }
  ],
  "serializedProperties": "text",
  "tenantArticleId": "MY_ARTICLE_ID",
  "tenantStockId": "MY_STOCK_ID",
  "traitConfig": [
    {
      "enabled": true,
      "trait": "text"
    }
  ],
  "traits": [
    "PICKABLE"
  ],
  "value": 42,
  "version": 1
}

Update stocks

put

Update and create many stocks at once

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

StocksForUpsert

Responses

200

Stock upsert result

application/json

StockUpsertOperationResult

statusstring · enumRequiredPossible values:

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 endpoint

application/json

put/api/stocks

HTTPcURLJavaScriptPython

PUT /api/stocks HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 454

{
  "stocks": [
    {
      "availableUntil": "2026-07-22T22:31:55.253Z",
      "conditions": [
        "DEFECTIVE"
      ],
      "customAttributes": {},
      "facility": {
        "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
      },
      "locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "properties": {
        "expiry": "text",
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "receiptDate": "2026-06-17T12:00:00.000Z",
      "tenantArticleId": "MY_ARTICLE_ID",
      "tenantStockId": "MY_STOCK_ID",
      "traitConfig": [
        {
          "enabled": true,
          "trait": "text"
        }
      ],
      "value": 42
    }
  ]
}

[
  {
    "status": "UPDATED",
    "stock": {
      "available": 1,
      "availableUntil": "2026-07-22T22:31:55.253Z",
      "conditions": [
        "DEFECTIVE"
      ],
      "created": "2026-07-22T22:31:55.253Z",
      "customAttributes": {},
      "facility": {
        "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "tenantFacilityId": "MY_FACILITY_ID"
      },
      "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "id": "text",
      "lastModified": "2026-07-22T22:31:55.253Z",
      "locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "properties": {
        "expiry": "text"
      },
      "receiptDate": "2026-06-17T12:00:00.000Z",
      "reserved": 1,
      "scannableCodes": [
        "text"
      ],
      "scores": [
        {
          "scoreName": "ZONE",
          "scoreType": "RATING",
          "scoreValue": 1
        }
      ],
      "serializedProperties": "text",
      "tenantArticleId": "MY_ARTICLE_ID",
      "tenantStockId": "MY_STOCK_ID",
      "traitConfig": [
        {
          "enabled": true,
          "trait": "text"
        }
      ],
      "traits": [
        "PICKABLE"
      ],
      "value": 42,
      "version": 1
    }
  }
]

Update stock

put

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

stockIdstringRequired

Body

application/json

or

Responses

200

Stock

application/json

Stock

availablenumberRequired

availableUntilstring · date-timeOptional

defines until when a stock is included in the stock availability as available and used for routing

createdstring · date-timeRequired

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

facility in which the stock is located

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

facilityWideReservednumberRequiredDeprecated

idstringRequired

lastModifiedstring · date-timeRequired

locationRefstringOptional

location on which the stock is placed

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

receiptDatestring · date-timeOptional

date-time when stock has entered the system, defaults to the creation date

Example: 2026-06-17T12:00:00.000Z

reservednumberRequired

amount of this stock reserved for customer orders

scannableCodesstring[]Optional

scannableCodes such as barcodes that identify this stock

serializedPropertiesstringRequired

properties object serialized as JSON string, sorted alphabetically by key

tenantArticleIdstring · min: 1Required

tenantArticleId of the stock

Example: MY_ARTICLE_ID

tenantStockIdstringOptional

tenantStockId is an optional identifier for the stock in the tenant system.

Example: MY_STOCK_ID

valueinteger · int32RequiredExample: 42

versionnumberRequired

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 endpoint

application/json

put/api/stocks/{stockId}

HTTPcURLJavaScriptPython

PUT /api/stocks/{stockId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "conditions": [
    "DEFECTIVE"
  ],
  "customAttributes": {},
  "locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "tenantStockId": "MY_STOCK_ID",
  "traitConfig": [
    {
      "enabled": true,
      "trait": "text"
    }
  ],
  "value": 42,
  "version": 1
}

{
  "available": 1,
  "availableUntil": "2026-07-22T22:31:55.253Z",
  "conditions": [
    "DEFECTIVE"
  ],
  "created": "2026-07-22T22:31:55.253Z",
  "customAttributes": {},
  "facility": {
    "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "tenantFacilityId": "MY_FACILITY_ID"
  },
  "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "id": "text",
  "lastModified": "2026-07-22T22:31:55.253Z",
  "locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "properties": {
    "expiry": "text"
  },
  "receiptDate": "2026-06-17T12:00:00.000Z",
  "reserved": 1,
  "scannableCodes": [
    "text"
  ],
  "scores": [
    {
      "scoreName": "ZONE",
      "scoreType": "RATING",
      "scoreValue": 1
    }
  ],
  "serializedProperties": "text",
  "tenantArticleId": "MY_ARTICLE_ID",
  "tenantStockId": "MY_STOCK_ID",
  "traitConfig": [
    {
      "enabled": true,
      "trait": "text"
    }
  ],
  "traits": [
    "PICKABLE"
  ],
  "value": 42,
  "version": 1
}

Delete stock

delete

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

stockIdstringRequired

Responses

200

Stock was deleted.

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 endpoint

application/json

delete/api/stocks/{stockId}

HTTPcURLJavaScriptPython

DELETE /api/stocks/{stockId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List stocks (search)

post

Search for Stock

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

StockSearchPayload

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.

Example: 10

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

StockPaginatedResult

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 endpoint

application/json

post/api/stocks/search

HTTPcURLJavaScriptPython

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

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "availableUntil": {
              "after": "text",
              "before": "text",
              "eq": "2026-07-22T22:31:55.253Z",
              "gt": "2026-07-22T22:31:55.253Z",
              "gte": "2026-07-22T22:31:55.253Z",
              "lt": "2026-07-22T22:31:55.253Z",
              "lte": "2026-07-22T22:31:55.253Z",
              "notEq": "2026-07-22T22:31:55.253Z"
            },
            "conditions": {
              "contains": {
                "eq": "DEFECTIVE",
                "in": [
                  "DEFECTIVE"
                ],
                "notEq": "DEFECTIVE"
              }
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "or": "[Circular Reference]",
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "receiptDate": "2026-06-17T12:00:00.000Z",
            "scannableCodes": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "tenantArticleId": "MY_ARTICLE_ID",
            "tenantFacilityId": "MY_FACILITY_ID",
            "tenantStockId": "MY_STOCK_ID",
            "traits": {
              "contains": {
                "eq": "PICKABLE",
                "in": [
                  "PICKABLE"
                ],
                "notEq": "PICKABLE"
              }
            },
            "value": {
              "eq": 1,
              "gt": 1,
              "gte": 1,
              "in": [
                1
              ],
              "lt": 1,
              "lte": 1,
              "notEq": 1,
              "notIn": [
                1
              ]
            }
          }
        ],
        "availableUntil": {
          "after": "text",
          "before": "text",
          "eq": "2026-07-22T22:31:55.253Z",
          "gt": "2026-07-22T22:31:55.253Z",
          "gte": "2026-07-22T22:31:55.253Z",
          "lt": "2026-07-22T22:31:55.253Z",
          "lte": "2026-07-22T22:31:55.253Z",
          "notEq": "2026-07-22T22:31:55.253Z"
        },
        "conditions": {
          "contains": {
            "eq": "DEFECTIVE",
            "in": [
              "DEFECTIVE"
            ],
            "notEq": "DEFECTIVE"
          }
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "or": [
          {
            "and": "[Circular Reference]",
            "availableUntil": {
              "after": "text",
              "before": "text",
              "eq": "2026-07-22T22:31:55.253Z",
              "gt": "2026-07-22T22:31:55.253Z",
              "gte": "2026-07-22T22:31:55.253Z",
              "lt": "2026-07-22T22:31:55.253Z",
              "lte": "2026-07-22T22:31:55.253Z",
              "notEq": "2026-07-22T22:31:55.253Z"
            },
            "conditions": {
              "contains": {
                "eq": "DEFECTIVE",
                "in": [
                  "DEFECTIVE"
                ],
                "notEq": "DEFECTIVE"
              }
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "or": "[Circular Reference]",
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "receiptDate": "2026-06-17T12:00:00.000Z",
            "scannableCodes": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "tenantArticleId": "MY_ARTICLE_ID",
            "tenantFacilityId": "MY_FACILITY_ID",
            "tenantStockId": "MY_STOCK_ID",
            "traits": {
              "contains": {
                "eq": "PICKABLE",
                "in": [
                  "PICKABLE"
                ],
                "notEq": "PICKABLE"
              }
            },
            "value": {
              "eq": 1,
              "gt": 1,
              "gte": 1,
              "in": [
                1
              ],
              "lt": 1,
              "lte": 1,
              "notEq": 1,
              "notIn": [
                1
              ]
            }
          }
        ],
        "properties": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "receiptDate": "2026-06-17T12:00:00.000Z",
        "scannableCodes": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "tenantArticleId": "MY_ARTICLE_ID",
        "tenantFacilityId": "MY_FACILITY_ID",
        "tenantStockId": "MY_STOCK_ID",
        "traits": {
          "contains": {
            "eq": "PICKABLE",
            "in": [
              "PICKABLE"
            ],
            "notEq": "PICKABLE"
          }
        },
        "value": {
          "eq": 1,
          "gt": 1,
          "gte": 1,
          "in": [
            1
          ],
          "lt": 1,
          "lte": 1,
          "notEq": 1,
          "notIn": [
            1
          ]
        }
      }
    ],
    "availableUntil": {
      "after": "text",
      "before": "text",
      "eq": "2026-07-22T22:31:55.253Z",
      "gt": "2026-07-22T22:31:55.253Z",
      "gte": "2026-07-22T22:31:55.253Z",
      "lt": "2026-07-22T22:31:55.253Z",
      "lte": "2026-07-22T22:31:55.253Z",
      "notEq": "2026-07-22T22:31:55.253Z"
    },
    "conditions": {
      "contains": {
        "eq": "DEFECTIVE",
        "in": [
          "DEFECTIVE"
        ],
        "notEq": "DEFECTIVE"
      }
    },
    "customAttributes": {
      "ANY_ADDITIONAL_PROPERTY": {
        "eq": true,
        "notEq": true
      }
    },
    "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "or": [
      {
        "and": "[Circular Reference]",
        "availableUntil": {
          "after": "text",
          "before": "text",
          "eq": "2026-07-22T22:31:55.253Z",
          "gt": "2026-07-22T22:31:55.253Z",
          "gte": "2026-07-22T22:31:55.253Z",
          "lt": "2026-07-22T22:31:55.253Z",
          "lte": "2026-07-22T22:31:55.253Z",
          "notEq": "2026-07-22T22:31:55.253Z"
        },
        "conditions": {
          "contains": {
            "eq": "DEFECTIVE",
            "in": [
              "DEFECTIVE"
            ],
            "notEq": "DEFECTIVE"
          }
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "or": "[Circular Reference]",
        "properties": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "receiptDate": "2026-06-17T12:00:00.000Z",
        "scannableCodes": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "tenantArticleId": "MY_ARTICLE_ID",
        "tenantFacilityId": "MY_FACILITY_ID",
        "tenantStockId": "MY_STOCK_ID",
        "traits": {
          "contains": {
            "eq": "PICKABLE",
            "in": [
              "PICKABLE"
            ],
            "notEq": "PICKABLE"
          }
        },
        "value": {
          "eq": 1,
          "gt": 1,
          "gte": 1,
          "in": [
            1
          ],
          "lt": 1,
          "lte": 1,
          "notEq": 1,
          "notIn": [
            1
          ]
        }
      }
    ],
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      }
    },
    "receiptDate": "2026-06-17T12:00:00.000Z",
    "scannableCodes": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "tenantArticleId": "MY_ARTICLE_ID",
    "tenantFacilityId": "MY_FACILITY_ID",
    "tenantStockId": "MY_STOCK_ID",
    "traits": {
      "contains": {
        "eq": "PICKABLE",
        "in": [
          "PICKABLE"
        ],
        "notEq": "PICKABLE"
      }
    },
    "value": {
      "eq": 1,
      "gt": 1,
      "gte": 1,
      "in": [
        1
      ],
      "lt": 1,
      "lte": 1,
      "notEq": 1,
      "notIn": [
        1
      ]
    }
  },
  "size": 10,
  "sort": [
    {
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "lastModified": "ASC",
      "locationName": "ASC",
      "tenantArticleId": "ASC",
      "value": "ASC"
    }
  ]
}

{
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "stocks": [
    {
      "available": 1,
      "availableUntil": "2026-07-22T22:31:55.253Z",
      "conditions": [
        "DEFECTIVE"
      ],
      "created": "2026-07-22T22:31:55.253Z",
      "customAttributes": {},
      "facility": {
        "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "tenantFacilityId": "MY_FACILITY_ID"
      },
      "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "id": "text",
      "lastModified": "2026-07-22T22:31:55.253Z",
      "locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "properties": {
        "expiry": "text"
      },
      "receiptDate": "2026-06-17T12:00:00.000Z",
      "reserved": 1,
      "scannableCodes": [
        "text"
      ],
      "scores": [
        {
          "scoreName": "ZONE",
          "scoreType": "RATING",
          "scoreValue": 1
        }
      ],
      "serializedProperties": "text",
      "tenantArticleId": "MY_ARTICLE_ID",
      "tenantStockId": "MY_STOCK_ID",
      "traitConfig": [
        {
          "enabled": true,
          "trait": "text"
        }
      ],
      "traits": [
        "PICKABLE"
      ],
      "value": 42,
      "version": 1
    }
  ],
  "total": 1
}

Call stock action

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

StockAction

actionone ofOptional

Action to be performed on the stock. If a user has specific facility context limitations, only stocks located in the referenced facilities will be affected

or

or

or

or

Responses

200

Stock action result

application/json

StockActionResult

namestring · enumRequiredPossible values:

resultone ofRequired

or

or

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 endpoint

application/json

post/api/stocks/actions

HTTPcURLJavaScriptPython

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

{
  "action": {
    "locationRefs": [
      "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
    ],
    "name": "DELETE_BY_LOCATIONS"
  }
}

{
  "name": "DELETE_BY_LOCATIONS",
  "result": {
    "ids": [
      "text"
    ]
  }
}