Update product variant - AfterShip Commerce API

Update a specific variant of a product by its ID.

Request

Security: API Key

Headers

as-store-id

string

required

This value equals to store.id of Store Resource. You can obtain this id by making a GET /stores call to get existing stores or a POST /stores to create a new store.

Body

available_quantity

integer

Available quantity of the product variant.

Example:

sku

string

The product SKU of the product variant.

<= 1024 characters

Example:

SKU001

title

string

The title of the product variant.

<= 1024 characters

Example:

Power Mobile Phone

price

string

The price of the product variant.

<= 100 characters

Example:

image_urls

array[string]

The product image URL of the product variant.

<= 100 items

compare_at_price

string

The original price of the item before an adjustment or a sale.

<= 100 characters

weight

The weight information of the product variant.

allow_backorder

boolean

To specify whether customers are permitted to place an order for this out-of-stock product variant.

options

array[object]

The custom product variant properties, such as size, color, and material.

>= 1 items

name

string

The field name of the custom product property.

<= 256 characters

Example:

color

value

string

The value of the custom product property.

<= 256 characters

Example:

white