For the complete documentation index, see llms.txt.

Address Book
POST/api/addressbook/update

Update Address

Edit the address information for a saved 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/update

Details

Edit the address information for a saved contact.

Request Parameters

Parameter Type Description
id integer Unique identifier for the record to be updated
address object Updated address details for the contact

Edit Address Response

Attribute Type Description
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)

Address Detail Model

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
email 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

Request body

{
    "id": 6926658,
    "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": "9879879876",
        "instructions": "",
        "building": "Big Tall Building",
        "email": "test@starshipit.com",
        "carrier": 0,
        "signature_required": false
    }
}

Response examples

Update Address (200)
{
    "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": "9879879876",
        "instructions": "",
        "building": "Big Tall Building",
        "email": "test@starshipit.com",
        "carrier": 0,
        "signature_required": false
    },
    "success": true,
    "errors": []
}

Related endpoints