OrderItem - AfterShip Commerce API

source_id

string

required

A unique identifier for the line item in your system. You should pass it when create order. Please note:

This is NOT the product.source_id of products API.
This source_id should be the same as order.shipments.items.source_order_item_id.

<= 32 characters

Example:

13097711141107

sku

string

The item's SKU (stock keeping unit).

<= 256 characters

Example:

yellow

quantity

integer

required

The number of items that have been purchased.

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

Weight value.

unit_price

string

The price of the item before discounts and taxes have been applied.
Please note that the item total price needs to meet the following formula:
item total price paid = unit_price*quantity - discount + tax

<= 100 characters

Example:

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:

fulfillable_quantity

integer

Deprecated, do not use. This field is no longer supported and should not be included in API requests. Total items available to fulfill.

source_product_id

string

The ID of the product that the line item belongs to. It Please note:

It should be the same as the product.source_id of products API.

<= 32 characters

Example:

8021450916083

source_variant_id

string

The ID of the product variant. Default is the same value as source_product_id. Please note:

It should be the same as the product.variants.source_id of products API.

<= 32 characters

Example:

43768285298931

title

string

required

The title of the product variant.

<= 1024 characters

Example:

good hair

hs_code

string

Harmonized System (HS) Codes.

<= 256 characters

Example:

sw343

origin_country_region

string

The origin country of this product.

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

Example: