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

product_id

string

The ID of the product in your system.

<= 128 characters

product_variant_id

string

The ID of the product variant in your system.

<= 128 characters

product_title

string

The title of the product.

<= 1024 characters

product_variant_title

string

The title of the product variant.

<= 1024 characters

sku

string

The SKU of the product variant.

<= 256 characters

quantity

integer

The quantity of the item ordered.

unit_price

Money

The unit price of the item.

Example:

{"currency":"USD","amount":"10"}

currency

string

Currency code for the amount, adhering to the ISO 4217 standard.

Allowed values:

USDAFNEURALLDZDAOAXCDARSAMDAWGAUDAZNBSDBHDBDTBBDBYNBZDXOFBMDINRBTNBOBBOVBAMBWPNOKBRLBNDBGNBIFCVEKHRXAFCADKYDCLPCLFCNYCOPCOUKMFCDFNZDCRCHRKCUPCUCANGCZKDKKDJFDOPEGPSVCERNETBFKPFJDXPFGMDGELGHSGIPGTQGBPGNFGYDHTGHNLHKDHUFISKIDRXDRIRRIQDILSJMDJPYJODKZTKESKPWKRWKWDKGSLAKLBPLSLZARLRDLYDCHFMOPMKDMGAMWKMYRMVRMRUMURXUAMXNMXVMDLMNTMADMZNMMKNADNPRNIONGNOMRPKRPABPGKPYGPENPHPPLNQARRONRUBRWFSHPWSTSTNSARRSDSCRSLLSGDXSUSBDSOSSSPLKRSDGSRDSZLSEKCHECHWSYPTWDTJSTZSTHBTOPTTDTNDTRYTMTUGXUAHAEDUSNUYUUYIUYWUZSVUVVESVNDYERZMWZWLXBAXBBXBCXBDXTSXXXXAUXPDXPT

Example:

USD

amount

string

The amount value in string format.

Example:

unit_weight

Weight

The unit weight of the item.

Example:

{"unit":"kg","value":10}

unit

string

The weight unit eg: g or kg.

Allowed values:

kglbozg

value

number

The value of the weight.

Example:

image_urls

array[string]

URLs of the product images.

discount

string

The total amount of the discount allocated to the line item. Including the discount applied only on this item and the allocated discount for the order level discount.

tax

string

The total amount of the tax allocated to the line item.

hs_code

string

Harmonized System (HS) Codes.

origin_country_region

string

The origin country of this product. The field should in ISO 3166-1 alpha-3 format.

product_tags

array[string]

Product tags of this variant.

product_categories

array[string]

Product categories of this variant.

returnable_quantity

integer

This field allows you to set the maximum returnable quantity for an order item when importing the order. When a shopper requests a return, they will not be able to select a quantity exceeding this specified limit.

Auth

Parameters

Body

preparing...