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>"
    }
  ]
}
Returns every non-deleted shipping option configured for the store. For options of type auto, the store-level shipping configuration is merged into the returned object. Returns a bare array as data. Requires the READ_SHIPPING scope.

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