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.
| Attribute | Type | Description |
|---|---|---|
| item_id | integer | The unique numeric identifier for the order item |
| description | string | Product name or description |
| sku | string | Product code or SKU (max length: 50) |
| tariff_code | string | The harmonized system code that indicates the type of this order item (max length: 18) |
| country_of_origin | string | The country in which this item was manufactured (max length: 50) |
| quantity | double | The number of product ordered |
| quantity_to_ship | double | The number of items to ship |
| weight | double | Unit weight of the product in kilograms (kg) |
| value | double | Unit price of the product |
| delete | boolean | An indicator used to determine whether this order item should be deleted when updating the order |
| color | string | The colour of the item |
| size | string | The size of the item |
| barcode | string | The barcode of the item, used for packing validation and printed on the packing slips |
| stock_on_hand | int | The count of stock for that item, used on packing slips |
| quantity_shipped | integer | The number of shipped items for partial orders. |
| return_reason | string | Reason for return. |
| additional_return_reason | string | Additional or specific return reason. |
| returned_items | Update Order - Item Model list | Returned item details. |
| brand | string | Name of the company that manufactured the item. |
| usage | string | Description of how the item is used. |
| material | string | Description of what substances the item is made of. |
| model | string | Model of the item. |
| mid_code | string | Manufacturer ID code for customs paperwork. |
| bin_location | string | Bin location of the item. |
| image_url | string | HTTPS URL for the item's product image. |
| import_hs_code | string | Import HS code for DHL Express India commodity mapping (max length: 18). |
| merchant_product_id | string | Merchant or seller-assigned product identifier, such as a SKU or product code. |
| manufacturer_product_id | string | Product identifier assigned by the manufacturer or brand owner; identifies a product, not its manufacturer. |
| standardised_product_id | string | Recognised standardised product identifier, such as a GTIN, EAN, UPC or ISBN. |