01.software Docs

checkStock

Use the SDK for application integration. This read-only reference covers Commerce, Customer Auth, Membership and Events.

All HTTP operations
POST
/api/products/stock-check

Quantity availability hint only; non-visible IDs return zeroed not_found/not_published/archived status, unlimited inventory uses a boolean.

Authorization

publishableKey
headerX-Publishable-Key<token>

Tenant publishable key for authentication (sent via X-Publishable-Key header)

Request Body

application/json
  1. body
items*array<>
Items1 <= items <= 100

Response Body

Actual shaped success body

application/json
  1. response
results*array<>
allAvailable*boolean

Examples may be generated from schemas; they are illustrative, not recorded successful API calls. Example snippets may omit required authentication headers.

Example Request
curl -X POST 'https://api.01.software/api/products/stock-check' \  -H 'Content-Type: application/json' \  -d '{  "items": [    {      "variantId": "string",      "quantity": 1    }  ]}'
Example Response
{  "results": [    {      "variantId": "string",      "status": "available",      "availableStock": 0,      "isUnlimited": true,      "available": true,      "requestedQuantity": 0,      "error": "string"    }  ],  "allAvailable": true}