Skip to main content
GET
/
shipping
/
options
/
{id}
Get a shipping option
curl --request GET \
  --url https://api.salesive.com/api/v1/shipping/options/{id} \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "success": true,
  "message": "Get a shipping option",
  "data": {
    "_id": "6650a1f2c3d4e5f601020304",
    "name": "Standard Shipping",
    "description": "3-5 business day delivery",
    "type": "custom",
    "price": 1500,
    "match": "all",
    "couriers": [],
    "triggers": [
      {
        "type": "totalAmount",
        "operator": ">=",
        "value": 10000
      }
    ],
    "enabled": true,
    "shop": "6630b2a1d4e5f60102030405",
    "deleted": false,
    "createdAt": "2026-05-20T10:00:00.000Z",
    "updatedAt": "2026-05-20T10:00:00.000Z"
  }
}
Returns a single shipping option by id. The option must belong to the store bound to the app token. For auto options the store-level shipping configuration is merged into the result. 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.

Path Parameters

​
id
string
required

ObjectId of the shipping option.

Response

Get a shipping option.

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

A configured shipping option. For options of type auto, the store-level shipping configuration is merged into the object.