Skip to main content
GET
/
shipping
/
options
/
available
List eligible shipping options for an order
curl --request GET \
  --url https://api.salesive.com/api/v1/shipping/options/available \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "success": true,
  "message": "List eligible shipping options for an order",
  "data": [
    {
      "_id": "6650a1f2c3d4e5f601020304",
      "name": "Express Delivery",
      "description": "1-2 business day delivery",
      "type": "auto",
      "price": 2500,
      "couriers": [
        "dhl"
      ],
      "enabled": true,
      "shop": "6630b2a1d4e5f60102030405",
      "createdAt": "2026-05-20T10:00:00.000Z",
      "updatedAt": "2026-05-20T10:00:00.000Z"
    }
  ]
}
Returns the shipping options that are eligible for the given order and buyer shipping address, after evaluating each option’s trigger rules against the order context. When a manual option matches, only manual options are returned; otherwise auto options are returned with a live cost estimate populated on the price field. The store is bound to the app token server-side. Requires the READ_SHIPPING scope.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Query Parameters

shippingAddressId
string
required

ObjectId of the buyer's shipping address.

orderId
string
required

ObjectId of the order to evaluate options for.

Response

List eligible shipping options for an order.

Standard Salesive response envelope. The operation-specific payload is carried in data.

status
integer
required

HTTP status code, echoed in the body.

success
boolean
required

Whether the request succeeded.

message
string
required

Human-readable result message.

data
object[]