Start here

Build your first Oway integration

Choose the workflow your application performs:

  • Shippers: quote → create → confirm → track → retrieve documents. Follow the shipper quickstart.
  • Carriers: find an assigned offer → accept → pickup → report location → upload POD → deliver. Follow the carrier quickstart.

Start with authentication and environments. Both workflows require a provisioned sandbox company and a synthetic scenario. They create sandbox records; they do not reset themselves.

The official SDK supports TypeScript and Go. Use TypeScript SDK 0.4.0 or Go SDK 0.4.4 for these quickstarts. The runnable examples include installation and setup instructions. cURL examples show the exact HTTP contract.

After the first shipment, use the webhook quickstart and existing signature examples to receive events. A signed test event proves your receiver setup; it does not prove that every shipment transition emits an event. Use the published event catalog and keep a reconciliation path.


Did this page help you?