Shipping

Add an overview of the Shipping API here. This block is preserved across regenerations.

Endpoints

GET /api/v1/shipping-options

List available shipping options for a destination address. Returns rates from the pluggable shipping provider configured for this tenant.

get

https://peakcommerce.app/api/v1https://sandbox.peakcommerce.app/api/v1

/shipping-options

Authorizations

ApiKeyAuthBearerAuth

X-API-KeystringRequired

Scoped API key. Scopes: read, commerce, admin.

Query parameters

currencystringOptionalDefault: USD

countrystringOptional

statestringOptional

postalCodestringOptional

citystringOptional

Responses

200

Available shipping options

application/json

401

API key missing or invalid

application/json

get/shipping-options

HTTPcURLJavaScriptPython

GET /api/v1/shipping-options HTTP/1.1
Host: peakcommerce.app
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "carrier": "text",
      "estimatedDays": 1,
      "priceCents": 1,
      "currency": "text",
      "description": "text"
    }
  ]
}

Notes, examples, or caveats for GET /shipping-options go here.