Skip to content
Stashtab Docs
Esc
↑↓navigate↵open⌘Jpreview

List inventory

GET/v1/organizations/{orgId}/inventory
Authorization
AuthorizationBasic auth · headerrequired

Registered confidential integration credentials. Keep the secret server-side.

or
CookieAPI key · headerrequired

Console-managed Vault session cookie; secure cookie naming may vary by environment.

or
AuthorizationBearer token (Vault TEST service token) · headerrequired

Customer- and resource-bound service grant, rechecked on every call. Existing Live opening-feed authority remains narrow; ordinary Test business requests refuse until shared Test composition is available.

or
AuthorizationBearer token (Vault organization API key) · headerrequired

Organization-owned credential with immutable mode and Read-only or Read/write permissions. Only explicitly declared ordinary customer operations accept it. Test business access refuses until shared Test composition is available; no staff, team, key-management or protocol authority is granted.

Path parameters
orgIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Query parameters
cursorstring
min length 1 · max length 2048
limitinteger
min 1 · max 100 · default: 50
qstring
max length 200
Responses
200

Success

dataobject[]required
Show properties
Array of object
aliasesobject[]required
Show properties
Array of object
aliasstringrequired
storeRefstringrequired
baseSkustringrequired
bindingstringrequired
Allowed:verifiedunproved
conditionstring | nullrequired
Show properties
Any of:
string
string
null
null
idstringrequired
namestring | nullrequired
skustring | nullrequired
stockobjectrequired
Show properties
availableinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
committedinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
physicalinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
bundleCapacityinteger | null
Show properties
Any of:
integer
integer
null
null
matchedAliasstring | nullrequired
weightobject | nullrequired
Show properties
Any of:
object
unitstring | nullrequired
valuenumber | nullrequired
null
null
metaobjectrequired
Show properties
requestIdstringrequired
nextCursorstring | nullrequired
previousCursorstring | nullrequired
default

Error

errorobjectrequired
Show properties
codestringrequired
Allowed:forbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_ready
fieldsobject[]
Show properties
Array of object
codestringrequired
messagestringrequired
pathstringrequired
messagestringrequired
operationIdstring
metaobjectrequired
Show properties
requestIdstringrequired
Request
curl -X GET '/v1/organizations/string/inventory' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json'
Response
{
  "data": [
    {
      "aliases": [
        {
          "alias": "string",
          "storeRef": "string"
        }
      ],
      "baseSku": "string",
      "binding": "verified",
      "condition": "nm",
      "id": "string",
      "name": "string",
      "sku": "string",
      "stock": {
        "available": null,
        "committed": null,
        "physical": null
      },
      "bundleCapacity": -9007199254740991,
      "matchedAlias": "string",
      "weight": {
        "unit": "string",
        "value": 0
      }
    }
  ],
  "meta": {
    "requestId": "string",
    "nextCursor": "string",
    "previousCursor": "string"
  }
}

Was this page helpful?