Skip to main content
GET
Quote a per-km delivery price
An installed app is already bound to one store, so it must pass lat and lng. domain is used only for human callers, and shippingAddressId is refused for apps because a saved address belongs to a shopper.

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

lat
number

Destination latitude. Required for app callers.

Required range: -90 <= x <= 90
lng
number

Destination longitude. Required for app callers.

Required range: -180 <= x <= 180
domain
string

The storefront domain. Used only for human callers; an app resolves the store from its token.

shippingAddressId
string

A saved shopper address. Human callers only; apps must use lat and lng.

Response

The quote.

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