Skip to content
campaiDeveloper
campai.com

Sales · Inventory

GET/{organizationId}/{mandateId}/sales/products/{productId}/inventory

Get product inventory

Returns product stock and availability derived from product components

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Permission checks in detail
Required permissions
  • mandate.read
  • product.read
  • inventory.read
Required for some requests, where input is what the request sends
  • salesPeriod.read, if input.includePeriods

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • productIdidrequired

Query parameters

  • includePeriodsboolean

    default false

  • limitinteger

    1–100 · default 50

  • offsetinteger

    at least 0 · default 0

  • returnCountboolean

    default false

Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/sales/products/YOUR_PRODUCT_ID/inventory' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

object

Response200
{
  "kind": "unlimited",
  "count": 0
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.