Skip to main content
GET
/
shipping-address
List shipping addresses
curl --request GET \
  --url https://store.salesive.com/api/v1/shipping-address \
  --header 'Authorization: Bearer <token>' \
  --header 'x-shop-id: <api-key>'
{
  "status": 123,
  "success": true,
  "message": "<string>",
  "data": {
    "shippingAddresses": [
      {
        "_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>"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.salesive.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

  • Ensure you authenticate the shopper and include the bearer token in requests.
  • Provide the x-shop-id header when working with multi-store setups.

​
Request

GET /shipping-address
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": "Shipping addresses retrieved",
  "data": {
    "shippingAddresses": [
      {
        "_id": "68fa0f33b8e1b7249a7feab1",
        "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,
        "createdAt": "2025-10-24T01:10:42.121Z",
        "updatedAt": "2025-10-24T01:10:42.121Z"
      }
    ]
  }
}

​
Error response

{
  "status": 401,
  "success": false,
  "message": "Unauthorized",
  "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.

Response

Shipping addresses retrieved successfully.

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