OrderItem - AfterShip Commerce API

The OrderItem model represents an individual product within an order. It includes details such as the product ID, quantity, price and so on. This model ensures accurate item-level tracking for every order placed.

string

required

A unique identifier for the line item within the order. This should be provided when creating an order.

Please note:

This is NOT the product.id of the Product resource.
This ID should be the same as fulfillment.*.line_items.id.

<= 32 characters

Example:

13097711141107

sku

string

The item's SKU (stock keeping unit).

<= 256 characters

Example:

SKU001

quantity

integer

required

The number of items that have been purchased.

Example:

unit_weight

Weight

The item's weight.

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:

unit_price

Money

The price of the item before discounts and taxes have been applied.Show all...

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:

product_title

string

required

The title of the product.

Example:

Power Mobile Phone

product_variant_title

string

The title of the product variant.

<= 1024 characters

Example:

Power Mobile Phone Pro

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.

<= 100 characters

Example:

tax

string

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

<= 100 characters

Example:

product_id

string

The ID of the product in your system.

Note that it should be the same as the product.id of the Product resource.

<= 128 characters

Example:

8021450916083

product_variant_id

string

The ID of the product variant in source system.

Note that it should be the same as the product.variants.id of the Product resource.

<= 32 characters

Example:

43768285298931

hs_code

string

Harmonized System (HS) Codes.

<= 256 characters

Example:

554521

origin_country_region

string

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

Example:

USA

Match pattern:

^[A-Z]{3}$

image_urls

array[string]

Image urls of this variant.

<= 100 items

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.

Example: