PATCH /v1/commerce/products/{productID}/variants/{variantID}

PATCH/v1/commerce/products/{productID}/variants/{variantID}

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

productIDstringrequired

variantIDstringrequired

Request body

requiredapplication/json

digital_delivery_urlstring

image_urlstring

option_valuesobject

price_amountinteger<int64>

min 0

price_delta_amountinteger<int64>

skustring

stock_qtyinteger<int32>

min 0

titlestringrequired

Responses

200OK

digital_delivery_urlstring

idstringrequired

image_urlstring

option_valuesobject

price_amountinteger<int64>

price_delta_amountinteger<int64>required

product_idstringrequired

skustring

stock_qtyinteger<int32>required

titlestringrequired

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X PATCH "/v1/commerce/products/string/variants/string" \
  -H "Content-Type: application/json" \
  -d '{
  "digital_delivery_url": "string",
  "image_url": "string",
  "option_values": {},
  "price_amount": 0,
  "price_delta_amount": 0,
  "sku": "string",
  "stock_qty": 0,
  "title": "string"
}'

const response = await fetch("/v1/commerce/products/string/variants/string", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "digital_delivery_url": "string",
  "image_url": "string",
  "option_values": {},
  "price_amount": 0,
  "price_delta_amount": 0,
  "sku": "string",
  "stock_qty": 0,
  "title": "string"
})
});

import requests

response = requests.patch(
    "/v1/commerce/products/string/variants/string",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "digital_delivery_url": "string",
  "image_url": "string",
  "option_values": {},
  "price_amount": 0,
  "price_delta_amount": 0,
  "sku": "string",
  "stock_qty": 0,
  "title": "string"
},
)

Response

{
  "digital_delivery_url": "string",
  "id": "string",
  "image_url": "string",
  "option_values": {},
  "price_amount": 0,
  "price_delta_amount": 0,
  "product_id": "string",
  "sku": "string",
  "stock_qty": 0,
  "title": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}