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

Update product shipping metadata

PATCH/v1/organizations/{orgId}/products/{productId}
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.

Path parameters
orgIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
productIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Request body
requiredapplication/json
aliasesobject[]
max items 50
Show properties
Array of object
aliasstringrequired
min length 1 · max length 100
storeRefstringrequired
min length 1 · max length 64
customsobject
Show properties
countryOfOriginstring | null
Show properties
Any of:
string
string
null
null
declaredValueobject | null
Show properties
Any of:
object
amountstringrequired
matches ^(0|[1-9]\d{0,8})(\.\d{1,4})?$
null
null
descriptionstring | null
Show properties
Any of:
string
string
null
null
tariffCodestring | null
Show properties
Any of:
string
string
null
null
expectedRevisionstringrequired
min length 1 · max length 64
submissionKeystringrequired
min length 8 · max length 128 · matches ^[A-Za-z0-9_.:-]+$
weightobject
Show properties
unitstringrequired
Allowed:gramkilogramouncepound
valuenumberrequired
max 1000000
Responses
200

Success

dataobjectrequired
Show properties
effectsstring[]required
operationIdstringrequired
outcomestringrequired
productobjectrequired
Show properties
aliasesobject[]required
Show properties
Array of object
aliasstringrequired
storeRefstringrequired
customsobject | nullrequired
Show properties
Any of:
object
countryOfOriginstring | nullrequired
declaredValueobject | nullrequired
Show properties
Any of:
object
amountstringrequired
currencystringrequired
null
null
descriptionstring | nullrequired
tariffCodestring | nullrequired
null
null
defaultAliasStoreRefstring
idstringrequired
revisionstring | nullrequired
weightobject | nullrequired
Show properties
Any of:
object
unitstring | nullrequired
valuenumber | nullrequired
null
null
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 PATCH '/v1/organizations/string/products/string' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "aliases": [
    {
      "alias": "string",
      "storeRef": "string"
    }
  ],
  "customs": {
    "countryOfOrigin": "string",
    "declaredValue": {
      "amount": "string"
    },
    "description": "string",
    "tariffCode": "string"
  },
  "expectedRevision": "string",
  "submissionKey": "stringst",
  "weight": {
    "unit": "gram",
    "value": 1
  }
}'
Response
{
  "data": {
    "effects": [
      "string"
    ],
    "operationId": "string",
    "outcome": "confirmed",
    "product": {
      "aliases": [
        {
          "alias": "string",
          "storeRef": "string"
        }
      ],
      "customs": {
        "countryOfOrigin": "string",
        "declaredValue": {
          "amount": "string",
          "currency": "USD"
        },
        "description": "string",
        "tariffCode": "string"
      },
      "defaultAliasStoreRef": "string",
      "id": "string",
      "revision": "string",
      "weight": {
        "unit": "string",
        "value": 0
      }
    }
  },
  "meta": {
    "requestId": "string"
  }
}

Was this page helpful?