Skip to main content
POST
/
shipping-rates
Calculate shipping rates
curl --request POST \
  --url https://admin.aeoliancms.com/api/v1/shipping-rates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "variantIds": [
    "<string>"
  ],
  "country": "<string>",
  "orderTotal": 123
}
'
{
  "variantRates": [
    {
      "variantId": "<string>",
      "profileId": "<string>",
      "rates": [
        {
          "id": "<string>",
          "name": "<string>",
          "price": "<string>",
          "deliveryDescription": "<string>",
          "deliveryTimeframeMin": 123,
          "deliveryTimeframeMax": 123,
          "minOrderPrice": "<string>",
          "maxOrderPrice": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

API key in format ak_<48-hex-chars>

Body

application/json
variantIds
string[]
required
country
string
required

2-letter country code

orderTotal
number

Optional order total to filter rates by price range

Response

Shipping rates for each variant

variantRates
object[]