Update a product

PATCH/products/{product_id}

Authorization

X-API-KeyAPI key · headerrequired

API key in format `sk_*`. Scoped to your partner account; server-side use only.

Path parameters

product_idstring<uuid>required

Request body

requiredapplication/json

dimensionsDimensions

Show properties

heightnumberrequired

lengthnumberrequired

unitstringrequired

Allowed:incm

widthnumberrequired

image_urlstring<uri> | null

namestring

skustring

upcstring | null

weightWeight

Show properties

unitstringrequired

Allowed:ozg

valuenumberrequired

Responses

200Catalog product updated.

dimensionsDimensionsrequired

Show properties

heightnumberrequired

lengthnumberrequired

unitstringrequired

Allowed:incm

widthnumberrequired

image_urlstring<uri> | null

namestringrequired

skustringrequired

Unique within the partner organization.

upcstring | null

weightWeightrequired

Show properties

unitstringrequired

Allowed:ozg

valuenumberrequired

created_atstring<date-time>required

product_idstring<uuid>required

updated_atstring<date-time>required

400Validation failed.

codeErrorCoderequired

Stable machine-readable error vocabulary for v1.

Allowed:validation_errorstate_conflictenvironment_mismatchunsupported_destinationinvalid_api_keynot_foundrate_limited

extraobjectrequired

Structured details such as field errors or SKU availability.

messagestringrequired

Human-readable summary.

401Missing, invalid, expired, or environment-mismatched API key.

codeErrorCoderequired

Stable machine-readable error vocabulary for v1.

Allowed:validation_errorstate_conflictenvironment_mismatchunsupported_destinationinvalid_api_keynot_foundrate_limited

extraobjectrequired

Structured details such as field errors or SKU availability.

messagestringrequired

Human-readable summary.

404No such resource exists for this partner and environment.

codeErrorCoderequired

Stable machine-readable error vocabulary for v1.

Allowed:validation_errorstate_conflictenvironment_mismatchunsupported_destinationinvalid_api_keynot_foundrate_limited

extraobjectrequired

Structured details such as field errors or SKU availability.

messagestringrequired

Human-readable summary.

409The resource state prevents the requested action.

codeErrorCoderequired

Stable machine-readable error vocabulary for v1.

Allowed:validation_errorstate_conflictenvironment_mismatchunsupported_destinationinvalid_api_keynot_foundrate_limited

extraobjectrequired

Structured details such as field errors or SKU availability.

messagestringrequired

Human-readable summary.

429Rate limit exceeded for this API key.

codeErrorCoderequired

Stable machine-readable error vocabulary for v1.

Allowed:validation_errorstate_conflictenvironment_mismatchunsupported_destinationinvalid_api_keynot_foundrate_limited

extraobjectrequired

Structured details such as field errors or SKU availability.

messagestringrequired

Human-readable summary.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

product_idpath*

Bodyapplication/json

Request body

Request

curl -X PATCH "https://api.vault.stashtab.gg/v1/products/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dimensions": {
    "height": 0,
    "length": 0,
    "unit": "in",
    "width": 0
  },
  "image_url": "http://example.com",
  "name": "string",
  "sku": "string",
  "upc": "string",
  "weight": {
    "unit": "oz",
    "value": 0
  }
}'

const response = await fetch("https://api.vault.stashtab.gg/v1/products/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  method: "PATCH",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "dimensions": {
    "height": 0,
    "length": 0,
    "unit": "in",
    "width": 0
  },
  "image_url": "http://example.com",
  "name": "string",
  "sku": "string",
  "upc": "string",
  "weight": {
    "unit": "oz",
    "value": 0
  }
})
});

Response

{
  "dimensions": {
    "height": 0,
    "length": 0,
    "unit": "in",
    "width": 0
  },
  "image_url": "http://example.com",
  "name": "string",
  "sku": "string",
  "upc": "string",
  "weight": {
    "unit": "oz",
    "value": 0
  },
  "created_at": "2019-08-24T14:15:22Z",
  "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  "updated_at": "2019-08-24T14:15:22Z"
}

{
  "code": "validation_error",
  "extra": {},
  "message": "string"
}

{
  "code": "validation_error",
  "extra": {},
  "message": "string"
}

{
  "code": "validation_error",
  "extra": {},
  "message": "string"
}

{
  "code": "validation_error",
  "extra": {},
  "message": "string"
}

{
  "code": "validation_error",
  "extra": {},
  "message": "string"
}