Shipper API

Get a quote by ID

Retrieves an existing quote by its unique identifier. Quotes are valid for 2 days from creation.

get/v1/shipper/quote/{quoteId}

Request

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

Path parameters

quoteIdstring required

Unique quote ID

Response

Quote retrieved successfully

idstring

Unique quote identifier

quotedPriceInCentsinteger

Total quoted price in cents (USD)

quoteExpirationTimestring date-time

When this quote expires (ISO 8601 format). Quotes are valid for 2 days.

transitDaysinteger nullable

Number of business days to deliver the shipment after pickup. Pickup day is excluded; weekends are not counted. May be null when the ETA cannot be computed.

estimatedDeliveryDatestring date-time nullable

Estimated delivery date and time (ISO 8601 format, UTC). May be null when the ETA cannot be computed.

Example response

{
  "id": "507f1f77bcf86cd799439013",
  "quotedPriceInCents": 125000,
  "quoteExpirationTime": "2024-12-20T15:30:00Z",
  "transitDays": 2,
  "estimatedDeliveryDate": "2024-12-22T15:30:00Z"
}

Changes

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