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.
| Attribute | Type | Description |
|---|---|---|
| package_id | integer | The unique numeric identifier for the package |
| name | string | Name of the package |
| weight | double | Physical weight of the parcel in kilograms (kg) |
| height | double | Height of the parcel in meters (m) |
| width | double | Width of the parcel in meters (m) |
| length | double | Length of the parcel in meters (m) |
| packaging_type | string | The packaging type for this parcel. Example valid values: Carton, Box, Envelope, Item, Jiffy, Pallet, Satchel, Skid or Bag |
| carrier_service_code | string | Carrier service code for delivery |
| carrier_service_name | string | Carrier service name for delivery |
| tracking_number | string | Carrier tracking number |
| tracking_url | string | Carrier tracking url |
| delivery_status | string | Current delivery status of this parcel |
| shipment_type | string | Type of shipment: outgoing, return or transfer |
| label_created_date | datetime | The date and time when the label was generated in UTC |
| labels | Label Info Model list | List of label files associated with this package |
| contents | string | The shipment contents that appears on the label or invoice |
| barcode | string | Carrier barcode number. |
| sscc | string | Serial Shipping Container Code provided by supported carriers. |