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

AttributeTypeDescription
codestringThe unique internal identifier for the address
namestringContact name at this address
companystringThe country name of receiver address
post_codestringPostal code
streetstringStreet Name and number
suburbstringSuburb or locality
citystringTown or city
statestringState, region, province or county name
countrystringCountry name
phonestringPhone number for this contact
instructionsstringDelivery instructions when placing an order with the carrier
buildingstringName of the building at the address
emailstringEmail address for this contact
carrierintegerDefault carrier to use for this contact
signature_requiredbooleanDefault value for signature required on customer orders