Skip to content
The Merchant Engine
You are reading the unreleased documentation. No version is released yet, and these pages describe code that is not in a release.

Shipping (storefront API)

Storefront and customer routes of the shipping module. Send Accept-Language (or X-Locale from a browser) on every call; a customer route needs the session cookie.

POST /v1/shipping/rates

Section titled “POST /v1/shipping/rates”

Calculate shipping rates

Request body: CalculateRatesDto.

Responses:

  • 200: Rates calculated.
  • 400: Invalid input.

Schemas

Section titled “Schemas”

CalculateRatesDto

Section titled “CalculateRatesDto”
  • country (string, min length 2, max length 2, required).
  • postalCode (string, optional).
  • items (array of ShippingRateItemDto, required).
  • subtotal (number, min 0, required).

ShippingRateItemDto

Section titled “ShippingRateItemDto”
  • weight (number, min 0, required).
  • quantity (number, min 1, required).