API ReferenceEndpointsPublic API (v1)Live carrier rates for an order

Live carrier rates for an order

Asks every installed shipping app that serves the order destination for live rates. Each rate ID names the app that issued it and is what POST /v1/orders/{id}/shipments/app-label takes as rateId. Quoting creates a shipment at the carrier, so it is refused for a read-only (imported) order.

GET
/v1/orders/{id}/shipments/app-rates
AuthorizationBearer <token>

Admin API key (server-to-server). Issue via the dashboard at Settings → API keys. Plain-text key is shown once — store in a secret manager. Format: Authorization: Bearer brainerce_xxxxxxxxx.

In: header

Path Parameters

idstring

Order ID

curl -X GET "https://api.brainerce.com/api/v1/orders/string/shipments/app-rates"
[
  {
    "id": "clx1a2b3c4d5e6f7g8h9",
    "name": "USPS Priority",
    "description": "Delivery in 3 to 5 business days",
    "price": "15.00",
    "currency": "USD",
    "estimatedDays": 4,
    "carrier": "ups",
    "service": "ground",
    "quoted": true
  }
]

{
  "statusCode": 400,
  "code": "VALIDATION_FAILED",
  "message": "name should not be empty, price must be a positive number",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/v1/orders/{id}/shipments/app-rates"
}

{
  "statusCode": 401,
  "code": "UNAUTHORIZED",
  "message": "Invalid or expired credential",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/v1/orders/{id}/shipments/app-rates"
}

{
  "statusCode": 403,
  "code": "INSUFFICIENT_SCOPE",
  "message": "API key does not have the required scope: products:write",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/v1/orders/{id}/shipments/app-rates"
}

{
  "statusCode": 404,
  "code": "RESOURCE_NOT_FOUND",
  "message": "Resource not found",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/v1/orders/{id}/shipments/app-rates"
}

{
  "statusCode": 429,
  "code": "RATE_LIMITED",
  "message": "Too many requests",
  "details": {
    "retryAfterSeconds": 12
  },
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/v1/store"
}