Update a product variant

put

https://api.twoboxes.io/api/v1/product-variants/{product_variant_id}

Updates an existing product variant by its UUID. Validates the path parameter and
request body, then applies the update to the variant record and its metadata in the
database.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

product_variant_id

string

required

UUID of the product variant to update

Body Params

Updated product variant fields

Request body for updating an existing product variant by ID. Optional fields will be set to null unless a default value is otherwise given.

barcode

string

Barcode (e.g. UPC/EAN) assigned to this variant by the merchant. Required if sku not provided.

capture_expiration_date

boolean

Whether an expiration date must be recorded when receiving or grading. Default: false. Optional.

capture_lot_code

boolean

Whether a lot code must be recorded when receiving or grading. Default: false. Optional.

currency

string

Currency used for MSRP pricing, as an ISO 4217 code (e.g. "usd"). Optional.

merchant

object

required

Prevents automated storefront syncs from overwriting this variant's data. Default: false. Optional.

metadata

object

Arbitrary key-value pairs attached to this variant. Optional.

msrp

number

Manufacturer's suggested retail price in the variant's local Currency. Optional.

name

string

required

Variant-level display name (e.g. "Blue / Large"). Required.

shelf_life_days

integer

Days this variant is sellable after being received. Zero means no restriction. Default: 0. Optional.

sku

string

Stock-keeping unit identifier assigned by the merchant. Required if barcode not provided.

source_image_url

string

Source image URL for this variant; the system processes it and serves it via CDN. Optional.

storefront_product_category

string

Product category as defined by the originating storefront. Must map to a Two Boxes product category. Optional but recommended.

storefront_product_type

string

Product type as defined by the originating storefront. Can be any value, where a Two Boxes product alias
should be created to map this value to a known entry in the Two Boxes product type taxonomy. Optional but recommended if storefront_product_category not provided..

title

string

Parent product title from the originating storefront (e.g. "Vintage Denim Jacket"). Optional.

valid_lot_codes

array of strings

Accepted lot codes during receiving. An empty or nil slice means all lot codes are accepted. Optional.

valid_lot_codes

variant_id

string

Variant-specific identifier from the originating storefront (e.g. Shopify variant ID). Optional.

weight_oz

number

Weight of this variant in ounces. Optional.

Responses

200OK

400product_variant_id is not a valid UUID or request body is malformed

403Caller lacks access to the variant's merchant or attempted to change the merchant

404Product variant not found

422Missing required fields, invalid status, or duplicate identifier

500Database or internal service failure