Stock Availability Thresholds (Inventory)

Endpoints to create, update, and read stock availability thresholds.

Create stock availability threshold configuration

post

This part of the API is in Alpha status. For details, see the API release lifecycle documentation. Creates a new stock availability threshold configuration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

StockAvailabilityThresholdConfigForCreation

tenantThresholdIdstringRequired

Tenant-unique identifier of this threshold configuration

Example: LOW_STOCK_ARTICLE_ABC123

Responses

201

The created stock availability threshold configuration

application/json

StockAvailabilityThresholdConfigValidationOutcome

successbooleanRequired

Whether the threshold configuration passed business validation.

400

The provided threshold configuration failed validation

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 endpoint

application/json

post/api/configurations/availability/thresholds

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

{
  "target": {
    "context": [
      {
        "type": "FACILITY",
        "values": [
          "facilityRef1"
        ]
      }
    ]
  },
  "tenantThresholdId": "LOW_STOCK_ARTICLE_ABC123",
  "thresholds": [
    {
      "levels": [
        {
          "key": "LOW_STOCK",
          "limit": 100,
          "sticker": {
            "nameLocalized": "{ en_US: 'SomeName' }",
            "color": "#19b6b5",
            "key": "LGMl2DuvPnfPoSHhYFOm",
            "name": "SomeName",
            "priority": 100
          }
        }
      ],
      "thresholdOnValue": "AVAILABLE_FOR_PICKING"
    }
  ]
}

{
  "result": {
    "created": "2026-01-01T00:00:00.000Z",
    "id": "5aa18b4d-45de-4e9e-92db-936288040272",
    "lastModified": "2026-01-01T00:00:00.000Z",
    "target": {
      "context": [
        {
          "type": "FACILITY",
          "values": [
            "facilityRef1"
          ]
        }
      ]
    },
    "tenantThresholdId": "LOW_STOCK_ARTICLE_ABC123",
    "thresholds": [
      {
        "levels": [
          {
            "key": "LOW_STOCK",
            "limit": 100,
            "sticker": {
              "nameLocalized": "{ en_US: 'SomeName' }",
              "color": "#19b6b5",
              "key": "LGMl2DuvPnfPoSHhYFOm",
              "name": "SomeName",
              "priority": 100
            }
          }
        ],
        "thresholdOnValue": "AVAILABLE_FOR_PICKING"
      }
    ],
    "version": 1
  },
  "success": true,
  "validations": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Get stock availability threshold configuration

get

This part of the API is in Alpha status. For details, see the API release lifecycle documentation. Returns a single stock availability threshold configuration by id.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

thresholdIdstringRequired

Responses

200

The stock availability threshold configuration

application/json

StockAvailabilityThresholdConfig

createdstring · date-timeRequired

Creation date of this stockAvailabilityThresholdConfig

idstringRequired

Unique identifier of this stockAvailabilityThresholdConfig

Example: 5aa18b4d-45de-4e9e-92db-936288040272

lastModifiedstring · date-timeRequired

Last modification date of this stockAvailabilityThresholdConfig

tenantThresholdIdstringOptional

Tenant-unique identifier of this threshold configuration

Example: LOW_STOCK_ARTICLE_ABC123

versionnumberRequired

Version number of this stockAvailabilityThresholdConfig

Example: 1

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

404

The requested entity was not found

application/json

get/api/configurations/availability/thresholds/{thresholdId}

GET /api/configurations/availability/thresholds/{thresholdId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "created": "2026-01-01T00:00:00.000Z",
  "id": "5aa18b4d-45de-4e9e-92db-936288040272",
  "lastModified": "2026-01-01T00:00:00.000Z",
  "target": {
    "context": [
      {
        "type": "FACILITY",
        "values": [
          "facilityRef1"
        ]
      }
    ]
  },
  "tenantThresholdId": "LOW_STOCK_ARTICLE_ABC123",
  "thresholds": [
    {
      "levels": [
        {
          "key": "LOW_STOCK",
          "limit": 100,
          "sticker": {
            "nameLocalized": "{ en_US: 'SomeName' }",
            "color": "#19b6b5",
            "key": "LGMl2DuvPnfPoSHhYFOm",
            "name": "SomeName",
            "priority": 100
          }
        }
      ],
      "thresholdOnValue": "AVAILABLE_FOR_PICKING"
    }
  ],
  "version": 1
}

Update stock availability threshold configuration

put

This part of the API is in Alpha status. For details, see the API release lifecycle documentation. Updates an existing stock availability threshold configuration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

thresholdIdstringRequired

Body

StockAvailabilityThresholdConfigForUpdate

versioninteger · min: 1Required

Version number of this stockAvailabilityThresholdConfig

Example: 1

Responses

200

The updated stock availability threshold configuration

application/json

StockAvailabilityThresholdConfigValidationOutcome

successbooleanRequired

Whether the threshold configuration passed business validation.

400

The provided threshold configuration failed validation

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 endpoint

application/json

404

The requested entity was not found

application/json

409

A version conflict occurred.

application/json

put/api/configurations/availability/thresholds/{thresholdId}

PUT /api/configurations/availability/thresholds/{thresholdId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 317

{
  "target": {
    "context": [
      {
        "type": "FACILITY",
        "values": [
          "facilityRef1"
        ]
      }
    ]
  },
  "thresholds": [
    {
      "levels": [
        {
          "key": "LOW_STOCK",
          "limit": 100,
          "sticker": {
            "nameLocalized": "{ en_US: 'SomeName' }",
            "color": "#19b6b5",
            "key": "LGMl2DuvPnfPoSHhYFOm",
            "name": "SomeName",
            "priority": 100
          }
        }
      ],
      "thresholdOnValue": "AVAILABLE_FOR_PICKING"
    }
  ],
  "version": 1
}

{
  "result": {
    "created": "2026-01-01T00:00:00.000Z",
    "id": "5aa18b4d-45de-4e9e-92db-936288040272",
    "lastModified": "2026-01-01T00:00:00.000Z",
    "target": {
      "context": [
        {
          "type": "FACILITY",
          "values": [
            "facilityRef1"
          ]
        }
      ]
    },
    "tenantThresholdId": "LOW_STOCK_ARTICLE_ABC123",
    "thresholds": [
      {
        "levels": [
          {
            "key": "LOW_STOCK",
            "limit": 100,
            "sticker": {
              "nameLocalized": "{ en_US: 'SomeName' }",
              "color": "#19b6b5",
              "key": "LGMl2DuvPnfPoSHhYFOm",
              "name": "SomeName",
              "priority": 100
            }
          }
        ],
        "thresholdOnValue": "AVAILABLE_FOR_PICKING"
      }
    ],
    "version": 1
  },
  "success": true,
  "validations": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Delete stock availability threshold configuration

delete

This part of the API is in Alpha status. For details, see the API release lifecycle documentation. Deletes a stock availability threshold configuration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

thresholdIdstringRequired

Responses

200

The stock availability threshold configuration was found & 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

404

The requested entity was not found

application/json

delete/api/configurations/availability/thresholds/{thresholdId}

DELETE /api/configurations/availability/thresholds/{thresholdId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Search stock availability threshold configurations

post

This part of the API is in Alpha status. For details, see the API release lifecycle documentation. Search for StockAvailabilityThresholdConfig

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

StockAvailabilityThresholdConfigSearchPayload

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

StockAvailabilityThresholdConfigPaginatedResult

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/configurations/availability/thresholds/search

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

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "or": "[Circular Reference]",
            "tenantThresholdId": "MY_THRESHOLD_ID"
          }
        ],
        "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "or": [
          {
            "and": "[Circular Reference]",
            "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "or": "[Circular Reference]",
            "tenantThresholdId": "MY_THRESHOLD_ID"
          }
        ],
        "tenantThresholdId": "MY_THRESHOLD_ID"
      }
    ],
    "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "or": [
      {
        "and": "[Circular Reference]",
        "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "or": "[Circular Reference]",
        "tenantThresholdId": "MY_THRESHOLD_ID"
      }
    ],
    "tenantThresholdId": "MY_THRESHOLD_ID"
  },
  "size": 10,
  "sort": [
    {
      "id": "ASC"
    }
  ]
}

{
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "stockAvailabilityThresholdConfigs": [
    {
      "created": "2026-01-01T00:00:00.000Z",
      "id": "5aa18b4d-45de-4e9e-92db-936288040272",
      "lastModified": "2026-01-01T00:00:00.000Z",
      "target": {
        "context": [
          {
            "type": "FACILITY",
            "values": [
              "facilityRef1"
            ]
          }
        ]
      },
      "tenantThresholdId": "LOW_STOCK_ARTICLE_ABC123",
      "thresholds": [
        {
          "levels": [
            {
              "key": "LOW_STOCK",
              "limit": 100,
              "sticker": {
                "nameLocalized": "{ en_US: 'SomeName' }",
                "color": "#19b6b5",
                "key": "LGMl2DuvPnfPoSHhYFOm",
                "name": "SomeName",
                "priority": 100
              }
            }
          ],
          "thresholdOnValue": "AVAILABLE_FOR_PICKING"
        }
      ],
      "version": 1
    }
  ],
  "total": 1
}