Update a product variation - Vantr Developer Docs

PATCH

/

v2

/

products

/

{productId}

/

variations

/

{variationId}

Update a product variation

curl --request PATCH \
  --url https://api.vantr.ai/v2/products/{productId}/variations/{variationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "price": 123,
  "unit": "EA",
  "sku": "<string>",
  "barcode": "<string>",
  "ebt_eligible": true,
  "wic_eligible": true,
  "organic_certified": true,
  "kosher_certified": true,
  "tobacco": true,
  "allergens": [],
  "tax_code": "<string>",
  "tags": [
    "<string>"
  ],
  "square_sync_enabled": true,
  "is_archived": true
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    price: 123,
    unit: 'EA',
    sku: '<string>',
    barcode: '<string>',
    ebt_eligible: true,
    wic_eligible: true,
    organic_certified: true,
    kosher_certified: true,
    tobacco: true,
    allergens: [],
    tax_code: '<string>',
    tags: ['<string>'],
    square_sync_enabled: true,
    is_archived: true
  })
};

fetch('https://api.vantr.ai/v2/products/{productId}/variations/{variationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.vantr.ai/v2/products/{productId}/variations/{variationId}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "price": 123,
    "unit": "EA",
    "sku": "<string>",
    "barcode": "<string>",
    "ebt_eligible": True,
    "wic_eligible": True,
    "organic_certified": True,
    "kosher_certified": True,
    "tobacco": True,
    "allergens": [],
    "tax_code": "<string>",
    "tags": ["<string>"],
    "square_sync_enabled": True,
    "is_archived": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "success": false,
  "code": "<string>",
  "message": "<string>"
}

{
  "success": false,
  "code": "<string>",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

OAuth 2.0 with opaque bearer tokens. Authorization-code requests require PKCE S256.

Scopes

products.write

Create, update, tag, and archive products and product variations.

Headers

X-API-Version

string

Pin a dated API release (YYYY-MM-DD). Omit for the latest (2026-06-09). Unknown values return 400 unsupported_api_version; the resolved version is echoed back in the X-API-Version response header.

Pattern: ^\d{4}-\d{2}-\d{2}$

Example:

"2026-06-09"

Path Parameters

productId

string<uuid>

required

variationId

string<uuid>

required

Body

application/json

name

string

description

string

price

number

unit

string

Example:

"EA"

sku

string

barcode

string

ebt_eligible

boolean

wic_eligible

boolean

organic_certified

boolean

kosher_certified

boolean

tobacco

boolean

alcohol_class

enum<string>

Available options:

beer,

wine,

liquor,

cider,

sake,

rtd

controlled_class

enum<string>

Available options:

cbd,

hemp,

thc

allergens

enum<string>[]

Available options:

gluten,

dairy,

nut,

soy,

shellfish,

egg,

wheat,

fish,

sesame

tax_code

string

tags

string[]

square_sync_enabled

boolean

default:true

is_archived

boolean

Response

Variation updated.

Update a product variation

curl --request PATCH \
  --url https://api.vantr.ai/v2/products/{productId}/variations/{variationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "price": 123,
  "unit": "EA",
  "sku": "<string>",
  "barcode": "<string>",
  "ebt_eligible": true,
  "wic_eligible": true,
  "organic_certified": true,
  "kosher_certified": true,
  "tobacco": true,
  "allergens": [],
  "tax_code": "<string>",
  "tags": [
    "<string>"
  ],
  "square_sync_enabled": true,
  "is_archived": true
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    price: 123,
    unit: 'EA',
    sku: '<string>',
    barcode: '<string>',
    ebt_eligible: true,
    wic_eligible: true,
    organic_certified: true,
    kosher_certified: true,
    tobacco: true,
    allergens: [],
    tax_code: '<string>',
    tags: ['<string>'],
    square_sync_enabled: true,
    is_archived: true
  })
};

fetch('https://api.vantr.ai/v2/products/{productId}/variations/{variationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.vantr.ai/v2/products/{productId}/variations/{variationId}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "price": 123,
    "unit": "EA",
    "sku": "<string>",
    "barcode": "<string>",
    "ebt_eligible": True,
    "wic_eligible": True,
    "organic_certified": True,
    "kosher_certified": True,
    "tobacco": True,
    "allergens": [],
    "tax_code": "<string>",
    "tags": ["<string>"],
    "square_sync_enabled": True,
    "is_archived": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "success": false,
  "code": "<string>",
  "message": "<string>"
}

{
  "success": false,
  "code": "<string>",
  "message": "<string>"
}