v1

latestSwagger 2.02026-07-17148179252.3 KB
Catalog

Creates a Variant object.

post/catalog/products/{product_id}/variants

Request body

cost_pricenumber double nullable

The cost price of the variant. Not affected by Price List prices.

pricenumber double nullable

This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's default price (set in the Product resource's price field) will be used as the base price.

sale_pricenumber double nullable

This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's price field) will be used as the sale price.

retail_pricenumber double nullable

This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's price field) will be used as the retail price.

weightnumber double nullable

This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight.

widthnumber double nullable

Width of the variant, which can be used when calculating shipping costs. If this value is null, the product's default width (set in the Product resource's width field) will be used as the base width.

heightnumber double nullable

Height of the variant, which can be used when calculating shipping costs. If this value is null, the product's default height (set in the Product resource's height field) will be used as the base height.

depthnumber double nullable

Depth of the variant, which can be used when calculating shipping costs. If this value is null, the product's default depth (set in the Product resource's depth field) will be used as the base depth.

is_free_shippingboolean

Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero.

fixed_cost_shipping_pricenumber double nullable

A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.

purchasing_disabledboolean

If true, this variant will not be purchasable on the storefront.

purchasing_disabled_messagestring

If purchasing_disabled is true, this message should show on the storefront when the variant is selected.

image_urlstring

The image that will be displayed when this variant is selected on the storefront. When updating a SKU image, send the publicly accessible URL. Supported image formats are JPEG, PNG, and GIF. Generic product images not specific to the variant should be stored on the product.

upcstring nullable

The UPC code used in feeds for shopping comparison sites and external channel integrations.

inventory_levelinteger nullable

Inventory level for the variant, which is used when the product's inventory_tracking is set to variant.

inventory_warning_levelinteger nullable

When the variant hits this inventory level, it is considered low stock.

bin_picking_numberstring nullable

Identifies where in a warehouse the variant is located.

product_idinteger
skustring

Response

A variant and metadata.

metaMeta

Empty meta object; may be used later.