Skip to main content
GET
Get a shipping option
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.