Create shipping address
curl --request POST \
--url https://store.salesive.com/api/v1/shipping-address \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-shop-id: <api-key>' \
--data '
{
"fullName": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"phone": "<string>",
"street2": "<string>",
"latitude": 123,
"longitude": 123,
"landmark": "<string>",
"isDefault": true
}
'import requests
url = "https://store.salesive.com/api/v1/shipping-address"
payload = {
"fullName": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"phone": "<string>",
"street2": "<string>",
"latitude": 123,
"longitude": 123,
"landmark": "<string>",
"isDefault": True
}
headers = {
"Authorization": "Bearer <token>",
"x-shop-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'x-shop-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
fullName: '<string>',
street: '<string>',
city: '<string>',
state: '<string>',
zipCode: '<string>',
country: '<string>',
phone: '<string>',
street2: '<string>',
latitude: 123,
longitude: 123,
landmark: '<string>',
isDefault: true
})
};
fetch('https://store.salesive.com/api/v1/shipping-address', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://store.salesive.com/api/v1/shipping-address",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fullName' => '<string>',
'street' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zipCode' => '<string>',
'country' => '<string>',
'phone' => '<string>',
'street2' => '<string>',
'latitude' => 123,
'longitude' => 123,
'landmark' => '<string>',
'isDefault' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-shop-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://store.salesive.com/api/v1/shipping-address"
payload := strings.NewReader("{\n \"fullName\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\",\n \"phone\": \"<string>\",\n \"street2\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"landmark\": \"<string>\",\n \"isDefault\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("x-shop-id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://store.salesive.com/api/v1/shipping-address")
.header("Authorization", "Bearer <token>")
.header("x-shop-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fullName\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\",\n \"phone\": \"<string>\",\n \"street2\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"landmark\": \"<string>\",\n \"isDefault\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://store.salesive.com/api/v1/shipping-address")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-shop-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fullName\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\",\n \"phone\": \"<string>\",\n \"street2\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"landmark\": \"<string>\",\n \"isDefault\": true\n}"
response = http.request(request)
puts response.read_body{
"status": 123,
"success": true,
"message": "<string>",
"data": {
"shippingAddress": {
"_id": "<string>",
"fullName": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"isDefault": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"phone": "<string>",
"street2": "<string>",
"latitude": 123,
"longitude": 123,
"landmark": "<string>"
}
}
}Shipping address
Create shipping address
Store a new shipping address for the authenticated shopper and optionally set it as default.
POST
/
shipping-address
Create shipping address
curl --request POST \
--url https://store.salesive.com/api/v1/shipping-address \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-shop-id: <api-key>' \
--data '
{
"fullName": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"phone": "<string>",
"street2": "<string>",
"latitude": 123,
"longitude": 123,
"landmark": "<string>",
"isDefault": true
}
'import requests
url = "https://store.salesive.com/api/v1/shipping-address"
payload = {
"fullName": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"phone": "<string>",
"street2": "<string>",
"latitude": 123,
"longitude": 123,
"landmark": "<string>",
"isDefault": True
}
headers = {
"Authorization": "Bearer <token>",
"x-shop-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'x-shop-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
fullName: '<string>',
street: '<string>',
city: '<string>',
state: '<string>',
zipCode: '<string>',
country: '<string>',
phone: '<string>',
street2: '<string>',
latitude: 123,
longitude: 123,
landmark: '<string>',
isDefault: true
})
};
fetch('https://store.salesive.com/api/v1/shipping-address', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://store.salesive.com/api/v1/shipping-address",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fullName' => '<string>',
'street' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zipCode' => '<string>',
'country' => '<string>',
'phone' => '<string>',
'street2' => '<string>',
'latitude' => 123,
'longitude' => 123,
'landmark' => '<string>',
'isDefault' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-shop-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://store.salesive.com/api/v1/shipping-address"
payload := strings.NewReader("{\n \"fullName\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\",\n \"phone\": \"<string>\",\n \"street2\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"landmark\": \"<string>\",\n \"isDefault\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("x-shop-id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://store.salesive.com/api/v1/shipping-address")
.header("Authorization", "Bearer <token>")
.header("x-shop-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fullName\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\",\n \"phone\": \"<string>\",\n \"street2\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"landmark\": \"<string>\",\n \"isDefault\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://store.salesive.com/api/v1/shipping-address")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-shop-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fullName\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\",\n \"phone\": \"<string>\",\n \"street2\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"landmark\": \"<string>\",\n \"isDefault\": true\n}"
response = http.request(request)
puts response.read_body{
"status": 123,
"success": true,
"message": "<string>",
"data": {
"shippingAddress": {
"_id": "<string>",
"fullName": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"isDefault": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"phone": "<string>",
"street2": "<string>",
"latitude": 123,
"longitude": 123,
"landmark": "<string>"
}
}
}Request
POST /shipping-address
Authorization: Bearer {{token}}
x-shop-id: {{shopId}}
Content-Type: application/json
{
"name": "Jane Smith",
"email": "jane@example.com",
"phone": "+2348099887766",
"address": "12 Computation Way, Lagos",
"city": "Lagos",
"state": "Lagos",
"zipCode": "100001",
"country": "NG",
"latitude": 6.4541,
"longitude": 3.3947,
"isDefault": true
}
Headers
| Header | Type | Description |
|---|---|---|
Authorization | string | Include the shopper token as Bearer <jwt>. |
x-shop-id | string | Scope the request to a specific shop. |
Content-Type | string | Always set to application/json. |
Body parameters
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Recipient name for the delivery. |
email | string | No | Contact email for the recipient. |
phone | string | No | Contact phone number for the recipient. |
address | string | Yes | Full street address (geocoded on save). |
city | string | Yes | City where the delivery should be made. |
state | string | Yes | State or province component of the address. |
zipCode | string | Yes | Postal or ZIP code. |
country | string | Yes | ISO 3166-1 alpha-2 country code (e.g. NG, US, GB). |
latitude | number | No | Latitude coordinate for geocoding. |
longitude | number | No | Longitude coordinate for geocoding. |
isDefault | boolean | No | Set to true to make this the default shipping address. |
Successful response
{
"status": 200,
"success": true,
"message": "Shipping address saved",
"data": {
"shippingAddress": {
"_id": "6a27d707289b87893fcbde52",
"user": "69360693a7a8f7dc8ae32d6d",
"name": "Jane Smith",
"email": "jane@example.com",
"phone": "+2348099887766",
"address": "12 Computation Way, Lagos",
"city": "Lagos",
"state": "Lagos",
"zipCode": "100001",
"country": "NG",
"latitude": 6.4541,
"longitude": 3.3947,
"validated": {
"address_code": 536035068,
"address": "12 Computation Way, Lagos Island, Lagos, Nigeria",
"name": "Jane Smith",
"email": "jane@example.com",
"street_no": "12",
"street": "Computation Way",
"phone": "+2348099887766",
"formatted_address": "12 Computation Way, Lagos Island, Lagos, Nigeria",
"country": "Nigeria",
"country_code": "NG",
"city": "Lagos Island",
"city_code": "Lagos Island",
"state": "Lagos",
"state_code": "LA",
"postal_code": "100001",
"latitude": 6.4541,
"longitude": 3.3947
},
"isDefault": false,
"deleted": false,
"createdAt": "2026-06-09T09:04:07.485Z",
"updatedAt": "2026-06-09T09:04:07.485Z",
"__v": 0
}
}
}
Error response
{
"status": 400,
"success": false,
"message": "\"name\" is required",
"data": {}
}
Authorizations
JWT issued by the Salesive Store API for authenticated shoppers.
Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.
Headers
Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.
Body
application/json
Recipient name for the delivery.
Primary street address.
City component of the address.
State or province component of the address.
Postal or ZIP code.
Country for the address.
Optional phone number for delivery coordination.
Additional address details such as apartment or suite.
Latitude coordinate for mapping purposes.
Longitude coordinate for mapping purposes.
Helpful nearby landmark or delivery instruction.
Set to true to make this the default shipping address.
Was this page helpful?
⌘I