Skip to main content
GET
/
shipping-address
/
default
Get default shipping address
curl --request GET \
  --url https://store.salesive.com/api/v1/shipping-address/default \
  --header 'Authorization: Bearer <token>' \
  --header 'x-shop-id: <api-key>'
{
  "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 pass the bearer token.
  • Provide the x-shop-id header for multi-store environments.

Request

GET /shipping-address/default
Authorization: Bearer {{token}}
x-shop-id: {{shopId}}

Headers

HeaderTypeDescription
AuthorizationstringInclude the shopper token as Bearer <jwt>.
x-shop-idstringScope the request to a specific shop.

Successful response

{
  "status": 200,
  "success": true,
  "message": "Default shipping address retrieved",
  "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"
    }
  }
}

No default set

{
  "status": 200,
  "success": true,
  "message": "Default shipping address not set",
  "data": {
    "shippingAddress": null
  }
}

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.

Response

Default shipping address retrieved.

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