For the complete documentation index, see llms.txt.

Address Book
POST/api/addressbook/

Add Address

Save address information for a new contact.

View as MarkdownCopy for LLM

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

Parameter Type Description
address object Updated address details for the contact

Add Address Response

Attribute Type Description
id integer Unique identifier for the record that has just been added
address object The updated address record (Address Detail Model)
success boolean Determines whether the request was successfully submitted
errors object list List of detailed errors (Error Model)

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": []
}

Related endpoints