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>"
    }
  }
}

​
Prerequisites

  • Authenticate the shopper and include the bearer token in requests.
  • Provide the x-shop-id header when working with multiple storefronts.

​
Request

POST /shipping-address
Authorization: Bearer {{token}}
x-shop-id: {{shopId}}
Content-Type: application/json

{
  "fullName": "Ada Lovelace",
  "phone": "+44 20 7946 0958",
  "street": "12 Computation Way",
  "street2": "Flat 4B",
  "city": "London",
  "state": "London",
  "zipCode": "SW1A 1AA",
  "country": "United Kingdom",
  "latitude": 51.5074,
  "longitude": -0.1278,
  "landmark": "Near the Royal Society",
  "isDefault": true
}

​
Body parameters

FieldTypeRequiredDescription
fullNamestringYesRecipient name for the delivery.
phonestringNoContact phone number for the recipient.
streetstringYesPrimary street address.
street2stringNoAdditional address details such as apartment or suite.
citystringYesCity where the delivery should be made.
statestringYesState or province component of the address.
zipCodestringYesPostal or ZIP code.
countrystringYesCountry of the address.
latitudenumberNoLatitude coordinate for mapping purposes.
longitudenumberNoLongitude coordinate for mapping purposes.
landmarkstringNoHelpful nearby landmark or delivery instruction.
isDefaultbooleanNoSet to true to make this the default shipping address.

​
Successful response

{
  "status": 200,
  "success": true,
  "message": "Shipping address saved",
  "data": {
    "shippingAddress": {
      "_id": "68fa0f33b8e1b7249a7feab1",
      "fullName": "Ada Lovelace",
      "street": "12 Computation Way",
      "city": "London",
      "state": "London",
      "zipCode": "SW1A 1AA",
      "country": "United Kingdom",
      "isDefault": true,
      "createdAt": "2025-10-24T01:10:42.121Z",
      "updatedAt": "2025-10-24T01:10:42.121Z"
    }
  }
}

​
Error response

{
  "status": 400,
  "success": false,
  "message": "\"fullName\" 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