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

Read product containment and actual stock

GET/v1/organizations/{orgId}/product-configuration
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 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
productIdstring
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Responses
200

Success

dataobjectrequired
Show properties
productobject | nullrequired
Show properties
Any of:
object
idstringrequired
namestringrequired
skustringrequired
providerRevisionstring | nullrequired
kindstringrequired
Allowed:standalonebundlecondition_variantunverified
packagingobject | nullrequired
Show properties
Any of:
object
unitLabelstringrequired
unitsPerCartoninteger | nullrequired
Show properties
Any of:
integer
integer
null
null
unitsPerCaseinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
revisionintegerrequired
min 0 · max 9007199254740991
null
null
stockobjectrequired
Show properties
physicalinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
availableinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
committedinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
containerEquivalentsobjectrequired
Show properties
cartonsnumber | nullrequired
casesnumber | nullrequired
bundleCapacityinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
componentsobject[] | nullrequired
Show properties
Any of:
object[]
Array of object
productIdstringrequired
skustringrequired
quantityintegerrequired
max 9007199254740991
null
null
conversionobject | nullrequired
Show properties
Any of:
object
packSkustringrequired
packsPerBoxintegerrequired
max 9007199254740991
potentialPacksinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
loosePacksinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
null
null
reservedForOpeningbooleanrequired
null
null
productsobject[]required
Show properties
Array of object
idstringrequired
namestringrequired
skustringrequired
standalonebooleanrequired
metaobjectrequired
Show properties
requestIdstringrequired
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/product-configuration' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json'
Response
{
  "data": {
    "product": {
      "id": "string",
      "name": "string",
      "sku": "string",
      "providerRevision": "string",
      "kind": "standalone",
      "packaging": {
        "unitLabel": "string",
        "unitsPerCarton": 1,
        "unitsPerCase": 1,
        "revision": 0
      },
      "stock": {
        "physical": null,
        "available": null,
        "committed": null
      },
      "containerEquivalents": {
        "cartons": 0,
        "cases": 0
      },
      "bundleCapacity": -9007199254740991,
      "components": [
        {
          "productId": "string",
          "sku": "string",
          "quantity": 1
        }
      ],
      "conversion": {
        "packSku": "string",
        "packsPerBox": 1,
        "potentialPacks": -9007199254740991,
        "loosePacks": -9007199254740991
      },
      "reservedForOpening": true
    },
    "products": [
      {
        "id": "string",
        "name": "string",
        "sku": "string",
        "standalone": true
      }
    ]
  },
  "meta": {
    "requestId": "string"
  }
}

Was this page helpful?