For the complete documentation index, see llms.txt.

Models

Starshipit API model

Full Item Model

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

37 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\
tariff_codestringThe harmonized system code that indicates the type of this order item
country_of_originstringThe country in which this item was manufactured
quantityintegerThe number of product ordered
quantity_to_shipintegerThe number of items to ship
weightdoubleUnit weight of the product in kilograms (kg)
valuedoubleUnit price of the product
colorstringProduct color variant.
sizestringProduct size variant.
quantity_shippedintegerThe number of shipped items for partial orders.
heightdoubleHeight of the product.
widthdoubleWidth of the product.
lengthdoubleLength of the product.
product_idstringIdentifier of the product.
barcodestringBarcode of the product.
bin_locationstringBin or shelf location of the product.
stock_on_handintegerStock on hand of the product.
model_numberstringModel number of the product.
warehouse_locationstringWarehouse location of the product.
return_reasonstringReason for return.
additional_return_reasonstringAdditional or specific reason for return.
returned_itemsFull 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.
image_urlstringURL for the item's product image.
is_under_meis_schemestringDHL Express India DEC item value mapped to IsUnderMEISScheme.
ship_piece_igst_percentagestringDHL Express India DEC item value mapped to ShipPieceIGSTPercentage.
ship_piece_igststringDHL Express India DEC item value mapped to ShipPieceIGST.
fob_valuestringDHL Express India DEC item value mapped to FOBValue.
discountstringDHL Express India DEC item value mapped to Discount.
ship_piece_cessstringDHL Express India DEC item value mapped to ShipPieceCESS.
import_hs_codestringDHL Express India DEC item value mapped to CommodityCode.