GET /v1/commerce/shipping/health

GET/v1/commerce/shipping/health

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

couriersstring

live_shipping_availablebooleanrequired

platform_configuredbooleanrequired

store_locator_readybooleanrequired

webhook_public_urlstring

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/commerce/shipping/health"

const response = await fetch("/v1/commerce/shipping/health", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/commerce/shipping/health",
)

Response

{
  "couriers": "string",
  "live_shipping_available": true,
  "platform_configured": true,
  "store_locator_ready": true,
  "webhook_public_url": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}