Skip to main content
GET
/
shipping
/
options
Get shipping options
curl --request GET \
  --url https://store.salesive.com/api/v1/shipping/options \
  --header 'Authorization: Bearer <token>' \
  --header 'x-shop-id: <api-key>'
{
  "status": 123,
  "success": true,
  "message": "<string>",
  "data": [
    {
      "_id": "<string>",
      "name": "<string>",
      "carrier": "<string>",
      "estimatedDays": "<string>",
      "price": 123,
      "formattedPrice": "<string>"
    }
  ]
}

​
Request

GET /shipping/options?shippingAddressId=68fc5211e908b620db5bfcdc&orderId=690ff00acf4de460fd1f6114
Authorization: Bearer {{token}}
x-shop-id: {{shopId}}

​
Headers

HeaderTypeDescription
AuthorizationstringProvide the customer token in the format Bearer <jwt>.
x-shop-idstringIdentify the shop that owns the order.

​
Query parameters

ParameterTypeRequiredDescription
shippingAddressIdstringYesThe shipping address ID to calculate shipping options for.
orderIdstringYesThe order ID to calculate shipping costs for.

​
Successful response

{
  "status": 200,
  "success": true,
  "message": "Shipping options retrieved successfully",
  "data": [
    {
      "_id": "68fd6e0e27e0b21f55b403ce",
      "name": "Standard Shipping",
      "carrier": "USPS",
      "estimatedDays": "5-7 business days",
      "price": 500,
      "formattedPrice": "$5.00"
    },
    {
      "_id": "68fd6e0e27e0b21f55b403cf",
      "name": "Express Shipping",
      "carrier": "FedEx",
      "estimatedDays": "2-3 business days",
      "price": 1500,
      "formattedPrice": "$15.00"
    },
    {
      "_id": "68fd6e0e27e0b21f55b403d0",
      "name": "Next Day Delivery",
      "carrier": "DHL",
      "estimatedDays": "1 business day",
      "price": 2500,
      "formattedPrice": "$25.00"
    }
  ]
}

​
Error response

{
  "status": 404,
  "success": false,
  "message": "Shipping address not found",
  "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.

Query Parameters

​
shippingAddressId
string
required

The shipping address ID to calculate shipping options for.

​
orderId
string
required

The order ID to calculate shipping costs for.

Response

Shipping options retrieved successfully.

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