Update variant

Updates an existing variant. You can also look up the variant by sku instead of id by passing ?sku=YOUR_SKU as a query parameter. Requires admin scope.

PUT/shops/{shop_id}/variants/{id}

Authorization

AuthorizationBearer token (JWT) · headerrequired

OAuth 2.0 Bearer token. Obtain via POST https://auth.onbolder.com/oauth/token.

Scopes:admin

Path parameters

shop_idstringrequired

Shop ID or subdomain

idstringrequired

Variant ID (or any value when using ?sku= lookup)

Query parameters

skustring

Look up variant by SKU instead of ID

Request body

requiredapplication/json

titlestring

Required on create

positioninteger

Ordering position (lower comes first). On a chained-variants product, omitting it on create defaults to the current highest position instead of 0.

skustring

Must be unique within the shop

stockinteger

default: 1

available_if_no_stockinteger

1 = always available, 0 = unavailable when out of stock

default: 1

Allowed:01

weight_in_gramsinteger

priceinteger

Override product price for this variant (cents)

price_comparisoninteger

Override comparison price for this variant (cents)

Responses

200

Variant updated

idinteger

titlestring

positioninteger

skustring | null

priceinteger

price_comparisoninteger | null

stockinteger

available_if_no_stockboolean

weight_in_gramsinteger

_linksobject

422

Validation errors

_classstring[]

_embeddedobject

Show properties

errorsobject[]

Show properties

Array of object

_classstring[]

fieldstring

messagesstring[]

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

shop_idpath*Shop ID or subdomainidpath*Variant ID (or any value when using `?sku=` lookup)skuqueryLook up variant by SKU instead of ID

Bodyapplication/json

titlestringRequired on createpositionintegerOrdering position (lower comes first). On a chained-variants product, omitting it on create defaults to the current highest position instead of 0. skustringMust be unique within the shopstockintegeravailable_if_no_stockinteger`1` = always available, `0` = unavailable when out of stockweight_in_gramsintegerpriceintegerOverride product price for this variant (cents)price_comparisonintegerOverride comparison price for this variant (cents)

Request

curl -X PUT 'https://api.onbolder.com/v1/shops/string/variants/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "string",
  "position": 0,
  "sku": "string",
  "stock": 1,
  "available_if_no_stock": 0,
  "weight_in_grams": 0,
  "price": 0,
  "price_comparison": 0
}'

const response = await fetch("https://api.onbolder.com/v1/shops/string/variants/string", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"title\": \"string\",\n  \"position\": 0,\n  \"sku\": \"string\",\n  \"stock\": 1,\n  \"available_if_no_stock\": 0,\n  \"weight_in_grams\": 0,\n  \"price\": 0,\n  \"price_comparison\": 0\n}"
});

import requests

response = requests.put(
    "https://api.onbolder.com/v1/shops/string/variants/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"title\": \"string\",\n  \"position\": 0,\n  \"sku\": \"string\",\n  \"stock\": 1,\n  \"available_if_no_stock\": 0,\n  \"weight_in_grams\": 0,\n  \"price\": 0,\n  \"price_comparison\": 0\n}",
)

Response

{
  "id": 0,
  "title": "string",
  "position": 0,
  "sku": "string",
  "price": 0,
  "price_comparison": 0,
  "stock": 0,
  "available_if_no_stock": true,
  "weight_in_grams": 0,
  "_links": {}
}

{
  "_class": [
    "errors"
  ],
  "_embedded": {
    "errors": [
      {
        "_class": [
          "error"
        ],
        "field": "product.title",
        "messages": [
          "can't be blank"
        ]
      }
    ]
  }
}