For the complete documentation index, see llms.txt.
Models
Starshipit API model
Address Detail Model
Field names, types, and descriptions for this shared API model.
15 fields
| Attribute | Type | Description |
|---|---|---|
| code | string | The unique internal identifier for the address |
| name | string | Contact name at this address |
| company | string | The country name of receiver address |
| post_code | string | Postal code |
| street | string | Street Name and number |
| suburb | string | Suburb or locality |
| city | string | Town or city |
| state | string | State, region, province or county name |
| country | string | Country name |
| phone | string | Phone number for this contact |
| instructions | string | Delivery instructions when placing an order with the carrier |
| building | string | Name of the building at the address |
| string | Email address for this contact | |
| carrier | integer | Default carrier to use for this contact |
| signature_required | boolean | Default value for signature required on customer orders |