Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
ShippingService

GetShippingQuote

Get shipping quote for a single order. The request specifies the order id and list of integrated services for which the shipping quote should be run. You can get the list of all integrated services in ShippingService/GetIntegrations Once a list of services obtained you can use ShippingService/SetShippingMethodFromQuote call to set the selected shipping service for an order <b>Permissions Required: </b> GlobalPermissions.ShippingService.ShippingQuoteNode <b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>100</b></span> / minute

get/api/ShippingService/GetShippingQuote

Query parameters

request.pkOrderIdstring uuid

Unique Order Identifier for which the shipping quote will be run

{"stackTrail":"paths:/api/ShippingService/GetShippingQuote:get:parameters:1:schema:items","oasType":"schema","type":"unknown"}

List of Integrated accounts to include in the shipping quote. Only shipping integrations that support shipping quotes will be used.

Response

OK

pkOrderIdstring uuid

Unique order identifier

Example response

{
  "pkOrderId": "00000000-0000-0000-0000-000000000000",
  "Quotes": [
    {
      "ServiceId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}