For the complete documentation index, see llms.txt.

Models

Starshipit API model

Destination Details Model

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

16 fields

Referenced models

These fields use another model for their nested structure.

AttributeTypeDescription
namestringContact name of the receiver (max length: 100)
email (optional)stringContact email address of the receiver (max length: 100)
phone (optional)stringContact phone number of the receiver (max length: 100)
building (optional)stringBuilding name of the delivery address (max length: 100)
company (optional)stringName of company that the parcel is being delivered to (max length: 100)
streetstringStreet number and name of the delivery address (max length: 100)
suburbstringSuburb of the delivery address (max length: 100)
city (optional)stringCity of the delivery address (max length: 100)
state (optional)stringRegional, provincial or county name of the delivery address (max length: 100)
post_code (optional)stringPostal or zip code of the delivery address (max length: 10)
countrystringThe country name of delivery address (min length: 2, max length: 100)
delivery_instructions (optional)stringDelivery instructions for courier (max length: 100)
tax_numbers (optional)Tax Numbers Model listList of receiver tax numbers
tax_number (optional)stringRecipient tax number (max length: 20)
eori_number (optional, legacy)stringLegacy recipient EORI number. Prefer tax_numbers for new integrations.
vat_number (optional, legacy)stringLegacy recipient VAT number. Prefer tax_numbers for new integrations.