How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OneRail Order API

The Order API from OneRail — 22 operation(s) for order.

OneRail Order API is one of 75 APIs that OneRail publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 24 operations across 22 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, /.

24 operations 22 paths 37 schemas 7 GET2 PATCH13 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://onerail-delivery-api-prod.azurewebsites.net
Authentication
API Key, API Key, API Key, HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 5

OneRail Order API declares 5 security schemes for authenticating requests. An API key is passed in the header as X-ONERAIL-API-KEY (ApiKey). An API key is passed in the header as X-ONERAIL-APP-ID (AppId). An API key is passed in the header as X-ONERAIL-API-KEY-AND-APP-ID (ApiKeyAndAppId). It accepts HTTP bearer tokens (bearer). It supports OAuth 2.0 (OAuth) using the authorizationCode flow.

  • bearer — Standard JWT bearer token used for authenticated OmniPoint users and internal service-to-service calls. Clients send Authorization: Bearer and the token is val…
  • OAuth — OAuth 2.0 access token validated by the Operations service (e.g. Okta-backed integrations). Clients obtain tokens from their own IdP outside of this API and ca…

Paths & Operations 24

Across 22 paths, the API surfaces 24 operations — 7 GET, 2 PATCH, 13 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Order 24
POST
/v2/order
Create an order with deliveries and returns
createV2 body → 200422default
PATCH
/order/{orderId}/partial-update
Partial update an order with deliveries, appending items and containers
patchPartialUpdate 1 param body → 200422default
PUT
/order/{orderId}/partial-update
Partial update an order with deliveries, replacing items and containers
putPartialUpdate 1 param body → 200422default
POST
/order/create
Create an order with deliveries
create body → 200422default
POST
/order/add-return
Add return delivery to order
addReturn body → 200422default
POST
/order/add-delivery
Create an order with deliveries
addDelivery body → 200422default
POST
/v1/order/optimize/{organizationId}
Optimize system orders
optimize 1 param body → 200default
POST
/v1/order/optimize/{organizationId}/with-multiple-locations
Optimize system orders with multiple locations
optimizeOrdersWithMultipleLocations 1 param body → 200default
GET
/v1/order/control-tower
Optimize system orders
controlTower 3 params → 200default
GET
/v1/order/control-tower/locations
Load locations from an org that the user has access to.
controlTowerFilters 1 param → 200404default
GET
/v1/order/optimized-drivers-location
Get Driver Locations of optimized orders
getActiveDriversLocations → 200default
POST
/v1/bulk-orders-delete
Bulk delete orders and associated data. Request body should be an array of order IDs.
bulkDelete body → 200default
GET
/v1/bulk-status
Get status of a bulk process
bulkStatus 1 param → 200default
POST
/v1/order/set-status
Change orders status to Shipping
setOrderAsShipping body → 200default
POST
/v1/order/advance
Advance order status
advanceOrder body → 200default
GET
/v1/order/{orderId}
Get a order details
getOrder 4 params → 200404default
POST
/v1/order/add-deliveries-api
Add one or more deliveries to an order using an apikey for auth
addDeliveriesToOrderFromApi 1 param body → 200404default
POST
/v1/order/add-returns-api
Add one or more returns to an order using an apikey for auth
addReturnsToOrderFromApi 1 param body → 200404default
POST
/v1/order/add-returns-api/{deliveryId}
Add one or more returns to an order using an apikey for auth, update original delivery's status to INCOMPLETE, filters list of LPs
addReturnsToOrderFromApiDeliveryUpdate 1 param body → 200default
POST
/v1/order/api
Creates an order from API call with one or more deliveries
createOrderFromApi 1 param body → 200default
PATCH
/v1/order/partial-update-api
Partial update order from API call with one or more deliveries
partialUpdatePatch body → 200default
PUT
/v1/order/partial-update-api
Partial update order from API call with one or more deliveries
partialUpdatePut body → 200default
GET
/v1/order/{orderId}/container/{containerId}/scan-history
Get the scan history for a container inside an order
getDeliveryContainerScanHistory 2 params → 200404default
GET
/v1/order/{orderId}/delivery/{deliveryId}/items
Get a paginated list of a delivery's order items
getOrderDeliveryItems 4 params → 200404default

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are Delivery (27 properties), OrderPartialUpdate (27 properties), OrderDelivery (22 properties), LocationInfo (18 properties). Each schema is shown below with its type and property counts.

Containers
array
HazardousMaterialOrderItemDetails
object
8 properties
OrderItem
object
14 properties 6 required
OrderCreated
object
4 properties
OrderInfo
object
8 properties
DeliveryType
string
DeliveryData
object
13 properties
CustomerData
object
4 properties 3 required
GrandChildCustomContainer
object
1 property
ContainerOrderItem
object
14 properties 6 required
PredefinedContainer
object
1 property
DeliveryCreated
object
12 properties
PredefinedContainerBase
object
11 properties 3 required
ChildCustomContainer
object
1 property
CapabilityTags
array
DeliveryOrderItemCreated
object
14 properties
v2OrderRequest
object
9 properties 3 required
OrderData
object
10 properties 1 required
OrderPartialUpdate
object
27 properties
ReturnDelivery
Delivery
object
27 properties 4 required
v2OrderResponse
object
5 properties
CustomContainerBase
object
15 properties 5 required
DeliveryOptions
string
HazardousMaterialContainerDetails
object
8 properties
ChildPredefinedContainer
object
1 property
RatesResponse
object
5 properties
OrderDelivery
object
22 properties 3 required
Error
object
4 properties 1 required
GrandChildPredefinedContainer
object
1 property
CustomContainer
object
1 property
LocationInfo
object
18 properties 4 required
OrderCreate
object
8 properties
OrderUpdate
object
8 properties 1 required
EmergencyContact
object
4 properties
OriginLocation
object
13 properties 4 required
ReturnDeliveryCreate
object
7 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onerail-order-api-openapi.yml Raw ↑

Other APIs OneRail publishes across the network.

OneRail Delivery API
OneRail Api Auth API
OneRail Assets API
OneRail Associated Location API
OneRail Authentication API
OneRail Blob Storage API API
OneRail Box API
OneRail Bulk Approve SLA Template API
OneRail Bulk Send SLA Template API
OneRail Bulk Uploads API
OneRail Cancellation Reason API
OneRail Carrier API
Where this information came from

This is an independent, third-party profile of OneRail Order API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.