For the complete documentation index, see llms.txt.

Models

Starshipit API model

Update Order - Item Model

Field names, types, and descriptions for this shared API model.

29 fields

Referenced models

These fields use another model for their nested structure.

AttributeTypeDescription
item_idintegerThe unique numeric identifier for the order item
descriptionstringProduct name or description
skustringProduct code or SKU (max length: 50)
tariff_codestringThe harmonized system code that indicates the type of this order item (max length: 18)
country_of_originstringThe country in which this item was manufactured (max length: 50)
quantitydoubleThe number of product ordered
quantity_to_shipdoubleThe number of items to ship
weightdoubleUnit weight of the product in kilograms (kg)
valuedoubleUnit price of the product
deletebooleanAn indicator used to determine whether this order item should be deleted when updating the order
colorstringThe colour of the item
sizestringThe size of the item
barcodestringThe barcode of the item, used for packing validation and printed on the packing slips
stock_on_handintThe count of stock for that item, used on packing slips
quantity_shippedintegerThe number of shipped items for partial orders.
return_reasonstringReason for return.
additional_return_reasonstringAdditional or specific return reason.
returned_itemsUpdate Order - Item Model listReturned item details.
brandstringName of the company that manufactured the item.
usagestringDescription of how the item is used.
materialstringDescription of what substances the item is made of.
modelstringModel of the item.
mid_codestringManufacturer ID code for customs paperwork.
bin_locationstringBin location of the item.
image_urlstringHTTPS URL for the item's product image.
import_hs_codestringImport HS code for DHL Express India commodity mapping (max length: 18).
merchant_product_idstringMerchant or seller-assigned product identifier, such as a SKU or product code.
manufacturer_product_idstringProduct identifier assigned by the manufacturer or brand owner; identifies a product, not its manufacturer.
standardised_product_idstringRecognised standardised product identifier, such as a GTIN, EAN, UPC or ISBN.