API Reference
  1. Oway Shipper API
  2. Shipments

Create a new shipment

post
https://api.oway.io/v1/shipper/shipment

Creates a new shipment order. Optionally reference a previously generated quote. The shipment must be confirmed after creation.

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request to create a new shipment

string

Optional ID of a previously generated quote.

pickupAddress
object
required

Pickup location address

deliveryAddress
object
required

Delivery location address

orderComponents
array of objects
required

List of cargo components in the shipment

orderComponents*
string
required

Description of the shipment contents

string

Purchase order number for reference

string

Your reference number for this shipment (typically your Bill of Lading number). Prints on partner-branded BOLs alongside the Oway order number.

date-time

Required pickup date (ISO 8601 format)

date-time

Required delivery by date (ISO 8601 format)

appointments
object

Optional inline appointment metadata per stop. May only be set for stops whose address has appointmentRequired=true. Each entry has the same shape as PUT /v1/shipper/shipment/{orderNumber}/appointment/{stop}.

shipperDispatch
object

Optional operational dispatch contact for this order. Distinct from the shipper company itself; useful when the desk handling questions about the load is different from the company account holder.

Headers
string

Optional idempotency key. Retrying the same request with the same key within 24h returns the original response without creating a second shipment. Reusing the key with a different body returns 409 idempotency_key_conflict.

Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?