customer.address.info

This method is used to get the information of a customer address.

Arguments

This method has the URL https://server/services/customer/v1/customer.address.info and follows the MicroBase API calling conventions.

Argument Required Type Example Description
customerId yes String HkhhuXESl Customer identifier.
addressId yes String r1h2uQ4rx Address identifier.

Response

Returns a address object:

{
    "ok": true,
    "address": [
        {
            "name": "Work",
            "firstName": "John",
            "lastName": "Doe",
            "address_1": "1650 Bolman Court",
            "address_2": "Number 10",
            "postCode": "61701",
            "city": "Bloomington",
            "state": "Illinois",
            "country": "US",
            "company": "My Company",
            "phone": 2173203531,
            "instructions": "Some Instructions",
            "id": "r1h2uQ4rx"
        }
    }
}

Errors

Expected errors that this method could return. Some errors return additional data.

Error Data Description
validation_error The data causing the error Some validation error
customer_not_found The data causing the error Customer not found
customer_address_not_found The data causing the error Customer address not found

Example

curl --request POST \
  --url http://localhost:3005/services/customer/v1/customer.address.info \
  --header 'authorization: Bearer xxxxx...' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{
        "customerId": "HkhhuXESl",
        "addressId": "B1Q5HiGHg88"
      }'