SHshipoway
Shipper API

Request a shipping quote

Generates a price quote for a shipment based on origin, destination, and cargo details. The quote is valid for 2 days.

Note: The companyId is automatically extracted from your API key. You do not need to provide this value in the request body.

For M2M (machine-to-machine) integrations, no user context is required.

post/v1/shipper/quote

Request

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

Request body

requiredPickupDatestring date-time

Required pickup date (ISO 8601), read as a day in the pickup location's time zone. Send it with that zone's offset so the day is unambiguous.

shipmentMode'ltl' | 'ftl'

Shipment mode (LTL or FTL).

customerReferencestring

Your own reference for this load, such as your order or load number, at most 64 characters. Stored on the quote, so a later shipment can name it and GET /v1/shipper/quotes/by-reference can find the quote.

Example request

{
  "pickupAddress": {
    "name": "Fairgrounds Distribution Center",
    "address1": "1531 Junipero Avenue",
    "address2": "Dock 5",
    "city": "Long Beach",
    "state": "CA",
    "zipCode": "90804",
    "country": "US",
    "phoneNumber": "+18087857650",
    "contactPerson": "Mike Johnson",
    "phoneExtension": "204",
    "email": "dock@example.com",
    "openTime": "10:00",
    "closeTime": "16:00",
    "notes": "Dock 3, enter from back of building",
    "appointmentRequired": true,
    "callAheadRequired": true
  },
  "deliveryAddress": {
    "name": "Fairgrounds Distribution Center",
    "address1": "1531 Junipero Avenue",
    "address2": "Dock 5",
    "city": "Long Beach",
    "state": "CA",
    "zipCode": "90804",
    "country": "US",
    "phoneNumber": "+18087857650",
    "contactPerson": "Mike Johnson",
    "phoneExtension": "204",
    "email": "dock@example.com",
    "openTime": "10:00",
    "closeTime": "16:00",
    "notes": "Dock 3, enter from back of building",
    "appointmentRequired": true,
    "callAheadRequired": true
  },
  "orderComponents": [
    {
      "palletCount": 2,
      "poundsWeight": 500,
      "palletDimensions": [
        72,
        48,
        48
      ],
      "dimensions": {
        "length": 48,
        "width": 48,
        "height": 72
      },
      "description": "Stone NOI",
      "nmfcCode": "90500-04",
      "freightClass": "100",
      "packagingType": "Pallets"
    }
  ],
  "requiredPickupDate": "2026-04-01T08:00:00-07:00",
  "customerReference": "2835391"
}

Response

Quote generated 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.