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

shipper_id

carrier_id

freight_type

pickup_window_start

pickup_window_end

dropoff_window_start

dropoff_window_end

po_number

order_date

first_available

delivery_date

Order will be shipped by your middle mile carrier into an Onward carrier's final mile warehouse. This makes pickup_info/store_info and store_name NOT required. If a carrier is not predetermined then city/state/zip will be used as a rough estimate for distance/mileage/pricing calculations.

is_middle_mile

reference_id

order_notes

order_revenue

Custom shape identifier for grouping orders in Onward Dispatch

custom_shape

items

return_items

This is the consignee information. You may also use the alias "customer_info".

dropoff_info

This is the store/warehouse information. You may also use the alias "store_info".

pickup_info

warehouse_trailer_id

warehouse_delivery_notes

warehouse_estimated_ship_date

warehouse_estimated_delivery_date

hazardous_materials

preferred_driver_id

pricing_option_id

Tab 1

<p class="slate-p " >Here are some common configuration options for submitting orders to Onward</p><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >Marketplace Orders</p><p class="slate-p " ></p><p class="slate-p " >Pricing and submitting orders to the Onward Marketplace require additional fields:</p><p class="slate-p " >For orders:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">dropoff_info.phone</div></li><li class="slate-li " ><div style="position:relative">dropoff_info.del_type</div></li><li class="slate-li " ><div style="position:relative">dropoff_info.dest_type</div></li></ul><p class="slate-p " >For Items:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">item_type_details</div></li><li class="slate-li " ><div style="position:relative">assembly_type</div></li></ul><p class="slate-p " ></p><p class="slate-p " >For marketplace orders that are being shipped into an Onward carrier&apos;s warehouse, include this field if the store_info/pickup_info is the shipper origin rather than the carrier warehouse.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">pickup_info.is_middle_mile_origin: true</div></li></ul><p class="slate-p " ></p></div></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Here are some common configuration options for submitting orders to Onward

<p class="slate-p " >Get Routes for a given Shipper after start (inclusive) before end (exclusive)</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

Get Routes for a given Shipper after start (inclusive) before end (exclusive)

start

routes

<p class="slate-p " ><p class="slate-p " >Creates <a href="https://app.theneo.io/onward-delivery/new-api-test/demand-api/orders" target="_self">orders</a> in the onward system</p><p class="slate-p " ></p></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " >Orders are processing asynchronously. Use <a href="https://app.theneo.io/onward-delivery/new-api-test/webhooks" target="_self">webhooks</a> to listen for an <code class="slate-code">order_created</code> event</p><p class="slate-p " ></p><p class="slate-p " ></p>

Orders are processing asynchronously. Use 

shipments

<p class="slate-p " >Updates <a href="https://app.theneo.io/onward-delivery/new-api-test/demand-api/orders" target="_self">orders </a>in the onward system</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " >Orders are processing asynchronously</p><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p" placeholder="Type / for widgets">Price an <a href="https://app.theneo.io/onward-delivery/new-api-test/demand-api/orders" target="_self">Order</a>. Does not save the order</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><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>

shipment

order

<p class="slate-p " >List <a href="https://app.theneo.io/onward-delivery/new-api-test/demand-api/orders" target="_self">orders</a> in the onward system for a particular shipper_id or carrier_id</p><p class="slate-p " ><p class="slate-p " ></p></p><p class="slate-p " ></p><p class="slate-p " ></p>

 in the onward system for a particular shipper_id or carrier_id

orders

<p class="slate-p " >Retrieves Order Status Details in the onward system. </p><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=error ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M9.08366 9.9801C9.25033 9.9801 9.39269 9.92107 9.51074 9.80302C9.6288 9.68496 9.68783 9.53566 9.68783 9.3551V5.31344C9.68783 5.14677 9.62533 5.00441 9.50033 4.88635C9.37533 4.7683 9.22949 4.70927 9.06283 4.70927C8.88227 4.70927 8.73296 4.7683 8.61491 4.88635C8.49685 5.00441 8.43783 5.15371 8.43783 5.33427V9.37594C8.43783 9.5426 8.50033 9.68496 8.62533 9.80302C8.75033 9.92107 8.9031 9.9801 9.08366 9.9801ZM9.00033 13.1676C9.19477 13.1676 9.35796 13.1016 9.48991 12.9697C9.62185 12.8377 9.68783 12.6745 9.68783 12.4801C9.68783 12.2857 9.62185 12.1225 9.48991 11.9905C9.35796 11.8586 9.19477 11.7926 9.00033 11.7926C8.80588 11.7926 8.64269 11.8586 8.51074 11.9905C8.3788 12.1225 8.31283 12.2857 8.31283 12.4801C8.31283 12.6745 8.3788 12.8377 8.51074 12.9697C8.64269 13.1016 8.80588 13.1676 9.00033 13.1676ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C10.9448 16.0843 12.6114 15.3898 14.0003 14.0009C15.3892 12.612 16.0837 10.9454 16.0837 9.00094C16.0837 7.05649 15.3892 5.38982 14.0003 4.00094C12.6114 2.61205 10.9448 1.9176 9.00033 1.9176C7.05588 1.9176 5.38921 2.61205 4.00033 4.00094C2.61144 5.38982 1.91699 7.05649 1.91699 9.00094C1.91699 10.9454 2.61144 12.612 4.00033 14.0009C5.38921 15.3898 7.05588 16.0843 9.00033 16.0843Z" fill="#E90005"></path></svg></div><div ><p class="slate-p " >DEPRECATED - See Webhook Management instead or poll /job/{id}</p></div></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

Retrieves Order Status Details in the onward system. 

po_numbers

shipper_ids

<p class="slate-p" placeholder="Type / for widgets">Cancels an Order in the Onward system</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>

statusCode

errors

<p class="slate-p " ><p class="slate-p " >Return Job status as well as successfully created orders</p></p><p class="slate-p " ></p><p class="slate-p " ></p>

status

Sections