For the complete documentation index, see llms.txt.
Address Book
Manage address book records used when creating and shipping orders.
4 related endpoints
Endpoint
Endpoint URL
https://api.starshipit.com/api/addressbook/
Details
Save address information for a new contact.
Request Parameters
Add Address Response
Request body
{
"address": {
"code": "111",
"name": "Add Address Test",
"company": "My Company",
"post_code": "3000",
"street": "55 Bourke St",
"suburb": "Melbourne",
"city": "Melbourne",
"state": "VIC",
"country": "Australia",
"phone": "123123123123",
"instructions": "",
"building": "Big Tall Building",
"email": "test@starshipit.com",
"carrier": 0,
"signature_required": false
}
}Response examples
Add Address (200)
{
"id": 7093680,
"address": {
"code": "111",
"name": "Add Address Test",
"company": "My Company",
"post_code": "3000",
"street": "55 Bourke St",
"suburb": "Melbourne",
"city": "Melbourne",
"state": "VIC",
"country": "Australia",
"phone": "123123123123",
"instructions": "",
"building": "Big Tall Building",
"email": "test@starshipit.com",
"carrier": 0,
"signature_required": false
},
"success": true,
"errors": []
}