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.
| Attribute | Type | Description |
|---|---|---|
| name | string | Contact name of the receiver (max length: 100) |
| email (optional) | string | Contact email address of the receiver (max length: 100) |
| phone (optional) | string | Contact phone number of the receiver (max length: 100) |
| building (optional) | string | Building name of the delivery address (max length: 100) |
| company (optional) | string | Name of company that the parcel is being delivered to (max length: 100) |
| street | string | Street number and name of the delivery address (max length: 100) |
| suburb | string | Suburb of the delivery address (max length: 100) |
| city (optional) | string | City of the delivery address (max length: 100) |
| state (optional) | string | Regional, provincial or county name of the delivery address (max length: 100) |
| post_code (optional) | string | Postal or zip code of the delivery address (max length: 10) |
| country | string | The country name of delivery address (min length: 2, max length: 100) |
| delivery_instructions (optional) | string | Delivery instructions for courier (max length: 100) |
| tax_numbers (optional) | Tax Numbers Model list | List of receiver tax numbers |
| tax_number (optional) | string | Recipient tax number (max length: 20) |
| eori_number (optional, legacy) | string | Legacy recipient EORI number. Prefer tax_numbers for new integrations. |
| vat_number (optional, legacy) | string | Legacy recipient VAT number. Prefer tax_numbers for new integrations. |