SHshipoway
Shipper API

Read a batch of quotes

The batch and every item's outcome, as they stand: the same body the create call answered with. While the status is PRICING, Retry-After says how long to wait before reading again. A batch belonging to another company is not found.

get/v1/shipper/quotes/batch/{batchId}

Request

  • Base URL
    https://api.oway.io
  • URL
    https://api.oway.io/v1/shipper/quotes/batch/{batchId}
  • Auth
    HTTP bearer and API key in header x-oway-api-key

Path parameters

batchIdstring required

The batch id the create call answered with

Response

The batch

idstring

The batch id; read the batch by it

status'PRICING' | 'COMPLETED' | 'FAILED' required

PRICING: accepted, still pricing; read the batch again after Retry-After seconds. COMPLETED: every item has an outcome; items can still move from UNDER_REVIEW to QUOTED or NOT_QUOTED, and nothing else on the batch changes. FAILED: the run could not finish; submit the items again.

customerReferencestring

Your reference for the whole set, as sent

createdAtstring date-time

When the batch was accepted

completedAtstring date-time

When every item had an outcome; absent while PRICING

Example response

{
  "id": "QB-8F3K29XA",
  "customerReference": "plan-2026-10-14",
  "createdAt": "2026-10-14T13:05:00Z",
  "completedAt": "2026-10-14T13:06:40Z",
  "counts": {
    "items": 120,
    "quoted": 97,
    "notQuoted": 20,
    "underReview": 3
  },
  "items": [
    {
      "customerReference": "2835391",
      "quote": {
        "id": "507f1f77bcf86cd799439013",
        "quotedPriceInCents": 125000,
        "quoteExpirationTime": "2024-12-20T15:30:00Z",
        "transitDays": 2,
        "estimatedDeliveryDate": "2024-12-22T15:30:00Z"
      },
      "problem": {
        "type": "https://api.oway.io/errors/location-not-serviceable",
        "title": "Bad Request",
        "status": 400,
        "detail": "pickupAddress.zipCode must be a 5-digit ZIP code",
        "reason": "pickup_not_covered",
        "violations": [
          {
            "field": "orderComponents[0].dimensions",
            "entity": "deliveryAddress",
            "reason": "Component dimensions of 110x48x40 are invalid (pallets must be less than 96x96x108, and greater than 1x1x1)"
          }
        ]
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.