Onward Delivery

API Reference

Demand API

Submitting Orders

Get Routes

Create orders

Updates multiple orders in the onward system

Update Orders

Retrieves Order Prices as they would be at the moment of request

Price Order

List Orders

Retrieves Order Status Details in the onward system

Get Order Status

Cancel Order

Get Job

Supply API

Share order and route activity with Onward

Ingest activity

Webhook Management

Subscriptions

List Subscriptions

Get Subscription

Create Subscription

Update Subscription

Events

Payload

Authentication

Partners

List Partners

Get Partner

Create Partner

Delete Partner

Update Partner

Create Draft Manifest

Get Manifest

List Manifests

Onward API

Onward API V2

Production

Sandbox

<p class="slate-p " ><h2 class="slate-h2 " >Authorization</h2></p><p class="slate-p " >Append provided api_key as a query parameter for all requests</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden">https://api-stg.onwarddelivery.com/…?key=${API_KEY} </textarea><code class="language-plainText keep-markup drop-tokens"></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Append provided api_key as a query parameter for all requests

start

shipper_id

carrier_id

created_at

enabled

event_subscription_id

subscribed_event

target_url

updated_at

Tab 1

<p class="slate-p" placeholder="Type / for widgets">Each api key can attach one webhook to each supported event</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Each api key can attach one webhook to each supported event

<p class="slate-p" placeholder="Type / for widgets">List all current <a href="https://app.theneo.io/onward-delivery/new-api-test/webhooks/subscriptions">subscriptions</a></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

subscriptions

<p class="slate-p" placeholder="Type / for widgets">Get a specific <a href="https://app.theneo.io/onward-delivery/new-api-test/webhooks/subscriptions" target="_self">subscription</a></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

subscription

<p class="slate-p" placeholder="Type / for widgets">Create a new <a href="https://app.theneo.io/onward-delivery/new-api-test/webhooks/subscriptions" target="_self">subscription</a></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

event

created

<p class="slate-p" placeholder="Type / for widgets">Update / disable a <a>subscription</a></p><p class="slate-p" placeholder="Type / for widgets"><div class="slate-mention_input"></div></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

updated

<p class="slate-p " >The possible values and their descriptions for the “event” field of the webhook payload.</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:322px;">Title</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:322px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Event</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Description</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >order_created</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Order has successfully been created in Onward.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >mm_pickup_scheduled</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Order has been scheduled for pickup by a middle mile carrier.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >mm_in_transit</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Order has been picked up by a middle mile carrier and is en route to the final mile terminal.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >mm_arrived</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Order has been delivered to the final mile terminal by a middle mile carrier.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >carrier_received</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Order has been received into the final mile terminal by the carrier.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >customer_comms_availability</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Onward has reached out to the customer via sms for their availability</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >customer_comms_predelivery</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Onward has reached out the the customer via sms to confirm their delivery information</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >order_scheduled</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Order has been assigned a delivery window</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >order_in_transit</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Order has been picked up by the carrier and is en route to the consignee.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >order_completed</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Order has been completed by the carrier.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >order_rejected</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Order has been rejected by the carrier.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >order_cancelled</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Order has been cancelled by the shipper.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >pod_uploaded</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >A POD has been uploaded by the carrier.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >exception_reported</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The driver has reported an exception for this order. Order may be cancelled or rescheduled depending on the severity of the exception.</p></td></div></tr></tbody></table></div><h3 class="slate-h3 " >POD Uploaded</h3><p class="slate-p " >For the “pod_uploaded” event, the order object will contain a “pod” array of files. Each file contains a “filename” which includes the extension (png, jpg, jpeg, or pdf), and the “file” which is a Base64 encoded string of the file contents.</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">  &quot;event&quot;: &quot;order_completed&quot;,</div><div class="slate-code_line">  &quot;timestamp&quot;: &quot;2024-01-16T21:50:46.158Z&quot;,</div><div class="slate-code_line">  &quot;location&quot;: {</div><div class="slate-code_line">    &quot;lat&quot;: 39.6754944,</div><div class="slate-code_line">    &quot;lng&quot;: -104.7658496</div><div class="slate-code_line">  },</div><div class="slate-code_line">  &quot;order&quot;: {</div><div class="slate-code_line">    &quot;order_number&quot;: &quot;OD67065&quot;,</div><div class="slate-code_line">    &quot;po_number&quot;: &quot;test-1&quot;,</div><div class="slate-code_line">    “pod”: [</div><div class="slate-code_line">      {</div><div class="slate-code_line">        “filename”: “xxx-xxx-xxx-xxx.jpg”</div><div class="slate-code_line">        “file”: “base64 string”</div><div class="slate-code_line">      }</div><div class="slate-code_line">    ]</div><div class="slate-code_line">    ...</div><div class="slate-code_line">  }</div><div class="slate-code_line">}</div></code></pre></div><h3 class="slate-h3 " >Exception Reported</h3><p class="slate-p " >For the “exception_reported” event,  the webhook payload will additionally include the “exception” object as shown below.</p><p class="slate-p " >Exception Types:</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Damaged</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Shortage</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Overage</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Refusal</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Attempted Delivery</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Customer Cancellation</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No Room on Truck</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Carrier/Onward Cancellation</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Weather</p></td></div></tr></tbody></table></div><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">  &quot;event&quot;: &quot;order_completed&quot;,</div><div class="slate-code_line">  &quot;timestamp&quot;: &quot;2024-01-16T21:50:46.158Z&quot;,</div><div class="slate-code_line">  &quot;location&quot;: {</div><div class="slate-code_line">    &quot;lat&quot;: 39.6754944,</div><div class="slate-code_line">    &quot;lng&quot;: -104.7658496</div><div class="slate-code_line">  },</div><div class="slate-code_line">  &quot;order&quot;: {</div><div class="slate-code_line">    &quot;order_number&quot;: &quot;OD67065&quot;,</div><div class="slate-code_line">    &quot;po_number&quot;: &quot;test-1&quot;,</div><div class="slate-code_line">    ...</div><div class="slate-code_line">  },</div><div class="slate-code_line">  “exception”: {
    “type”: “Attempted Delivery”,// see table above for possible values</div><div class="slate-code_line">    “reported_at”: “DROPOFF”, //either “PICKUP” or “DROPOFF”</div><div class="slate-code_line">    “notes”: “customer not home”</div><div class="slate-code_line">  }</div><div class="slate-code_line">}</div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p>

The possible values and their descriptions for the “event” field of the webhook payload.

Title

Description

For the “pod_uploaded” event, the order object will contain a “pod” array of files. Each file contains a “filename” which includes the extension (png, jpg, jpeg, or pdf), and the “file” which is a Base64 encoded string of the file contents.

For the “exception_reported” event,  the webhook payload will additionally include the “exception” object as shown below.

<p class="slate-p " ><p class="slate-p " ></p></p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">  &quot;event&quot;: &quot;order_created&quot;,</div><div class="slate-code_line">  &quot;timestamp&quot;: &quot;2024-01-16T21:50:46.158Z&quot;,</div><div class="slate-code_line">  &quot;location&quot;: {</div><div class="slate-code_line">    &quot;lat&quot;: 39.6754944,</div><div class="slate-code_line">    &quot;lng&quot;: -104.7658496</div><div class="slate-code_line">  },</div><div class="slate-code_line">  &quot;order&quot;: {</div><div class="slate-code_line">    &quot;order_number&quot;: &quot;OD67065&quot;,</div><div class="slate-code_line">    &quot;po_number&quot;: &quot;test-1&quot;,</div><div class="slate-code_line">    &quot;notes&quot;: [</div><div class="slate-code_line">       {</div><div class="slate-code_line">         &quot;timestamp&quot;: &quot;2024-12-03T16:19:05.731838+00:00&quot;,</div><div class="slate-code_line">         &quot;note&quot;: &quot;Order Notes - Test Notes&quot;</div><div class="slate-code_line">       }   </div><div class="slate-code_line">    ]</div><div class="slate-code_line">    ...</div><div class="slate-code_line">  }</div><div class="slate-code_line">}</div></code></pre></div><p class="slate-p " ></p>

<p class="slate-p " ></p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"></div></code></pre></div><p class="slate-p " >Onward will sign the payload with your <code class="slate-code">api_key</code> and include the signature in the <code class="slate-code">x-onward-signature</code> header.</p><p class="slate-p " >A sample express middleware handler:</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">const crypto = require(&apos;crypto-js&apos;);</div><div class="slate-code_line">const { ONWARD_API_KEY } = process.env;</div><div class="slate-code_line"></div><div class="slate-code_line">const handler = (req, res, next) =&gt; {
  const signature = req.headers[&quot;x-onward-signature&quot;];
  const hash = crypto.HmacSHA256(JSON.stringify(req.body), ONWARD_API_KEY).toString();</div><div class="slate-code_line">  if(signature === hash) {</div><div class="slate-code_line">    return next();</div><div class="slate-code_line">  }</div><div class="slate-code_line"></div><div class="slate-code_line">  return res.status(401).send(&apos;Unauthorized&apos;);</div><div class="slate-code_line">}</div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p>

Sections