POST /api/customer-address HTTP/1.1
Host: <API_HOST>
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

{
  "firstName": "Asha",
  "lastName": "Kumar",
  "address1": "12 Market Road",
  "address2": "Suite 4",
  "city": "Chennai",
  "state": "Tamil Nadu",
  "countryId": 99,
  "postcode": "600001",
  "addressType": 1,
  "company": "",
  "landmark": "Near Central Park",
  "phoneNumber": "9876543210",
  "isDefault": 1
}

{
  "message": "New Address is created successfully",
  "status": "1",
  "data": {
    "addressId": 1,
    "customerId": 1,
    "countryId": 99,
    "firstName": "Asha",
    "lastName": "Kumar",
    "address1": "12 Market Road",
    "city": "Chennai",
    "state": "Tamil Nadu",
    "postcode": "600001",
    "addressType": 1,
    "isActive": 1,
    "isDefault": 1
  }
}

Address book

Create a customer address.

Authentication: Customer bearer token and customer permission required.

Feature area: Customer address

Implementation source: src/api/store/controllers/CustomerAddressController.ts

Request example provenance: Request and response structure from source @api comment; postcode is shown as a string to preserve leading zeroes.

Response example provenance: Request and response structure from source @api comment; postcode is shown as a string to preserve leading zeroes.

Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.

POST

api

customer-address

POST /api/customer-address HTTP/1.1
Host: <API_HOST>
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

{
  "firstName": "Asha",
  "lastName": "Kumar",
  "address1": "12 Market Road",
  "address2": "Suite 4",
  "city": "Chennai",
  "state": "Tamil Nadu",
  "countryId": 99,
  "postcode": "600001",
  "addressType": 1,
  "company": "",
  "landmark": "Near Central Park",
  "phoneNumber": "9876543210",
  "isDefault": 1
}

{
  "message": "New Address is created successfully",
  "status": "1",
  "data": {
    "addressId": 1,
    "customerId": 1,
    "countryId": 99,
    "firstName": "Asha",
    "lastName": "Kumar",
    "address1": "12 Market Road",
    "city": "Chennai",
    "state": "Tamil Nadu",
    "postcode": "600001",
    "addressType": 1,
    "isActive": 1,
    "isDefault": 1
  }
}

Authorizations

Authorization

string

header

required

Paste the JWT access token returned by the corresponding login endpoint.

Body

application/json

Sample request body. Request and response structure from source @api comment; postcode is shown as a string to preserve leading zeroes.

firstName

string

lastName

string

address1

string

address2

string

city

string

state

string

countryId

integer

postcode

string

addressType

integer

company

string

landmark

string

phoneNumber

string

isDefault

integer

Response

200 - application/json

Successful response. Request and response structure from source @api comment; postcode is shown as a string to preserve leading zeroes.

message

string

status

string

data

object

Show child attributes

Store API

Vendor API

Create a customer address.

Authorizations

Body

Response