Skip to main content
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
}
'
{
  "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

HeaderTypeDescription
AuthorizationstringInclude the shopper token as Bearer <jwt>.
x-shop-idstringScope the request to a specific shop.
Content-TypestringAlways set to application/json.

​
Body parameters

FieldTypeRequiredDescription
namestringYesRecipient name for the delivery.
emailstringNoContact email for the recipient.
phonestringNoContact phone number for the recipient.
addressstringYesFull street address (geocoded on save).
citystringYesCity where the delivery should be made.
statestringYesState or province component of the address.
zipCodestringYesPostal or ZIP code.
countrystringYesISO 3166-1 alpha-2 country code (e.g. NG, US, GB).
latitudenumberNoLatitude coordinate for geocoding.
longitudenumberNoLongitude coordinate for geocoding.
isDefaultbooleanNoSet 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

​
Authorization
string
header
required

JWT issued by the Salesive Store API for authenticated shoppers.

​
x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

​
x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Body

application/json
​
fullName
string
required

Recipient name for the delivery.

​
street
string
required

Primary street address.

​
city
string
required

City component of the address.

​
state
string
required

State or province component of the address.

​
zipCode
string
required

Postal or ZIP code.

​
country
string
required

Country for the address.

​
phone
string

Optional phone number for delivery coordination.

​
street2
string

Additional address details such as apartment or suite.

​
latitude
number

Latitude coordinate for mapping purposes.

​
longitude
number

Longitude coordinate for mapping purposes.

​
landmark
string

Helpful nearby landmark or delivery instruction.

​
isDefault
boolean

Set to true to make this the default shipping address.

Response

Shipping address saved successfully.

​
status
integer
required
​
success
boolean
required
​
message
string
required
​
data
object
required