For the complete documentation index, see llms.txt.

Models

Starshipit API model

Full Package Model

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

18 fields

Referenced models

These fields use another model for their nested structure.

AttributeTypeDescription
package_idintegerThe unique numeric identifier for the package
namestringName of the package
weightdoublePhysical weight of the parcel in kilograms (kg)
heightdoubleHeight of the parcel in meters (m)
widthdoubleWidth of the parcel in meters (m)
lengthdoubleLength of the parcel in meters (m)
packaging_typestringThe packaging type for this parcel. Example valid values: Carton, Box, Envelope, Item, Jiffy, Pallet, Satchel, Skid or Bag
carrier_service_codestringCarrier service code for delivery
carrier_service_namestringCarrier service name for delivery
tracking_numberstringCarrier tracking number
tracking_urlstringCarrier tracking url
delivery_statusstringCurrent delivery status of this parcel
shipment_typestringType of shipment: outgoing, return or transfer
label_created_datedatetimeThe date and time when the label was generated in UTC
labelsLabel Info Model listList of label files associated with this package
contentsstringThe shipment contents that appears on the label or invoice
barcodestringCarrier barcode number.
ssccstringSerial Shipping Container Code provided by supported carriers.