Update an order item by ID.
The ID of the order.
The ID of the order item.
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.
The ID of the product in your system.
The ID of the product variant in your system.
The title of the product.
The title of the product variant.
The SKU of the product variant.
The quantity of the item ordered.
The unit price of the item.
Currency code for the amount, adhering to the ISO 4217 standard.
The amount value in string format.
The unit weight of the item.
The weight unit eg: g or kg.
The value of the weight.
URLs of the product images.
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.
The total amount of the tax allocated to the line item.
Harmonized System (HS) Codes.
The origin country of this product. The field should in ISO 3166-1 alpha-3 format.
Product tags of this variant.
Product categories of this variant.
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.
The Meta model holds the metadata of the API response, including relevant error details for debugging purposes.Show all...
Error code in integer format. For detailed information, please refer to the Request Error introduction page.
Response type string for the reference. For detailed information, please refer to the Request Error introduction page.
Human-readable response message. For detailed information, please refer to the Request Error introduction page.
Error detail object. Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a human-readable description of the error.Show all...
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.Show all...
A unique identifier for the line item within the order. This should be provided when creating an order.
Please note:
product.id of the Product resource.fulfillment.*.line_items.id.The item's SKU (stock keeping unit).
The number of items that have been purchased.
The item's weight.
The price of the item excluding discounts and taxes. Please note that the item total price needs to meet the following formula:Show all...
The title of the product.
The title of the product variant.
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.
The total amount of the tax allocated to the line item.
The ID of the product in your system.
Note that it should be the same as the product.id of the Product resource.
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.
Harmonized System (HS) Codes.
The origin country of this product. The field should in ISO 3166-1 alpha-3 format.
Image urls of this variant.
Product tags of this variant.
Product categories of this variant.
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.
{
"product_id": "string",
"product_variant_id": "string",
"product_title": "string",
"product_variant_title": "string",
"sku": "string",
"quantity": 0,
"unit_price": {
"currency": "USD",
"amount": "10"
},
"unit_weight": {
"unit": "kg",
"value": 10
},
"image_urls": [
"string"
],
"discount": "string",
"tax": "string",
"hs_code": "string",
"origin_country_region": "string",
"product_tags": [
"string"
],
"product_categories": [
"string"
],
"returnable_quantity": 0
}{ "meta": { "code": 20000, "type": "OK", "message": "The request was successfully processed by AfterShip." }, "data": { "id": "13097711141107", "sku": "SKU001", "quantity": 1, "unit_weight": { "unit": "kg", "value": 10 }, "unit_price": { "currency": "USD", "amount": "10" }, "product_title": "Power Mobile Phone", "product_variant_title": "Power Mobile Phone Pro", "discount": "10", "tax": "10", "product_id": "8021450916083", "product_variant_id": "43768285298931", "hs_code": "554521", "origin_country_region": "USA", "image_urls": [ "https://www.example.com/product/phone/image.jpg" ], "product_tags": [ "mobile-phone" ], "product_categories": [ "mobile-phone" ], "returnable_quantity": 1 } }