User Address

Get user address details and update address

Get Address Details

get
​

β€Žhttps://<domain>/<api prefix>/<version>/user/get/address/
This API endpoint will give you the user address details.
Request
Response
Request
Headers
apikey
required
string
apikey
Authorization
required
string
Bearer access-token
Response
200: OK
​HTTP/1.1 200 OK
Content-Type: application/json
​
Body:
{
"status_code": 200,
"errors": {},
"data": {
"UserAddress": {
"address": "<address>",
"city": "<city>",
"postcode": "<postcode>",
"phone": "<phone_number>",
"state": {
"id": <state id>,
"name": <state name>
},
"country": {
"id": <country id>,
"name": <country name>,
"sortname": <country short name code>
}
}
}
}

Sample code

Node

​var request = require('request');
var options = {
'method': 'GET',
'url': 'https://<domain>/<api prefix>/<version>/user/get/address/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access-token>',
},
formData: {}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});

PHP

<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => "https://<domain>/<api prefix>/<version>/user/get/address/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"apikey: <apikey>",
"Authorization: Bearer <access-token>"
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;

Update Address Details

post
​

β€Žhttps://<domain>/<api prefix>/<version>/user/manage/address/
This API endpoint will update user address details.
Request
Response
Request
Headers
apikey
required
string
apikey
Authorization
required
string
Bearer access-token
Body Parameters
country
required
string
country id
address
required
string
address
city
required
string
city
postcode
required
string
postcode
phone
required
string
phone number
state
required
string
state id
Response
200: OK
HTTP/1.1 200 OK
Content-Type: application/json
​
Body:
{
"status_code": 200,
"errors": {},
"data": {}
}

Sample code

Node

var request = require('request');
var options = {
'method': 'POST',
'url': 'https://<domain>/<api prefix>/<version>/user/manage/address/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access-token>',
},
formData: {
'address': '<address>',
'city': '<city>',
'phone': '<phone>',
'postcode': '<postcode>'
'state': '<state_id>',
'country': '<country_id>',
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});

PHP

<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => "https://<domain>/<api prefix>/<version>/user/manage/address/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => array('address' => '<address>','city' => '<city>','phone' => '<phone>','postcode' => '<postcode>','state' => '<state_id>','country' => '<country_id>',)
CURLOPT_HTTPHEADER => array(
"apikey: <apikey>",
"Authorization: Bearer <access-token>",
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;

Error Responses

Status Code

Error Type

Field

Description

400

Validation Error

phone

Phone number must be entered in the formate: '99999999'. Up to 15 digits allowed.

400

Validation Error

postcode

The postcode is not valid for <country_name>.

400

Validation Error

country, state

A valid integer is required.

400

Validation Error

address, phone, city, postcode

This field may not be blank.