User Address

Search…
User Address
Get user address details and update address
Get Address Details
get
‎
https://<domain>/<api prefix>/<version>/user/get/address/
Sample code
Node
1
​var request = require('request');
2
var options = {
3
  'method': 'GET',
4
  'url': 'https://<domain>/<api prefix>/<version>/user/get/address/',
5
  'headers': {
6
    'apikey': '<apikey>',
7
    'Authorization': 'Bearer <access-token>',
8
  },
9
  formData: {}
10
};
11
request(options, function (error, response) {
12
  if (error) throw new Error(error);
13
  console.log(response.body);
14
});
Copied!
PHP
1
<?php
2
​
3
$curl = curl_init();
4
​
5
curl_setopt_array($curl, array(
6
  CURLOPT_URL => "https://<domain>/<api prefix>/<version>/user/get/address/",
7
  CURLOPT_RETURNTRANSFER => true,
8
  CURLOPT_ENCODING => "",
9
  CURLOPT_MAXREDIRS => 10,
10
  CURLOPT_TIMEOUT => 0,
11
  CURLOPT_FOLLOWLOCATION => true,
12
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13
  CURLOPT_CUSTOMREQUEST => "GET",
14
  CURLOPT_HTTPHEADER => array(
15
    "apikey: <apikey>",
16
    "Authorization: Bearer <access-token>"
17
  ),
18
));
19
​
20
$response = curl_exec($curl);
21
​
22
curl_close($curl);
23
echo $response;
Copied!
Update Address Details
post
‎
https://<domain>/<api prefix>/<version>/user/manage/address/
Sample code
Node
1
var request = require('request');
2
var options = {
3
  'method': 'POST',
4
  'url': 'https://<domain>/<api prefix>/<version>/user/manage/address/',
5
  'headers': {
6
    'apikey': '<apikey>',
7
    'Authorization': 'Bearer <access-token>',
8
  },
9
  formData: {
10
    'address': '<address>',
11
    'city': '<city>',
12
    'phone': '<phone>',
13
    'postcode': '<postcode>'
14
    'state': '<state_id>',
15
    'country': '<country_id>',
16
  }
17
};
18
request(options, function (error, response) {
19
  if (error) throw new Error(error);
20
  console.log(response.body);
21
});
Copied!
PHP
1
<?php
2
​
3
$curl = curl_init();
4
​
5
curl_setopt_array($curl, array(
6
  CURLOPT_URL => "https://<domain>/<api prefix>/<version>/user/manage/address/",
7
  CURLOPT_RETURNTRANSFER => true,
8
  CURLOPT_ENCODING => "",
9
  CURLOPT_MAXREDIRS => 10,
10
  CURLOPT_TIMEOUT => 0,
11
  CURLOPT_FOLLOWLOCATION => true,
12
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13
  CURLOPT_CUSTOMREQUEST => "POST",
14
  CURLOPT_POSTFIELDS => array('address' => '<address>','city' => '<city>','phone' => '<phone>','postcode' => '<postcode>','state' => '<state_id>','country' => '<country_id>',)
15
  CURLOPT_HTTPHEADER => array(
16
    "apikey: <apikey>",
17
    "Authorization: Bearer <access-token>",
18
  ),
19
));
20
​
21
$response = curl_exec($curl);
22
​
23
curl_close($curl);
24
echo $response;
Copied!
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.
User Profile
About User
Last modified 6mo ago
Copy link
Contents
Get Address Details
get
Update Address Details
post