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 Delivery API

The OmniPoint Delivery API lets authorized shippers request, price, update, and track deliveries through the OneRail carrier network. It covers rate shopping across qualified carriers, order and delivery creation (order-first and delivery-first), progressive partial updates on draft orders, availability checks, delivery pre-validation, rescheduling, cancellation, shipping-label and manifest generation, scan data, multi-stop route creation with an optional optimizer bypass, and visibility-only tracking for shipments fulfilled outside the OneRail booking process.

This API exposes 31 operations across 29 paths, organized into 9 resource areas, and defines 49 schemas. It is described by OpenAPI 3.0.1, at version 0.0.3.

Requests are made against the base URL https://onerail-delivery-api-prod.azurewebsites.net.

31 operations 29 paths 49 schemas 8 GET1 HEAD1 PATCH20 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
0.0.3
Base URL
https://onerail-delivery-api-prod.azurewebsites.net
Authentication
API Key, API Key, API Key
License
UNLICENSED
Resource Areas
9

Authentication & Security 3

OneRail Delivery API declares 3 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). By default, every request must be authenticated.

Paths & Operations 31

Across 29 paths, the API surfaces 31 operations — 8 GET, 1 HEAD, 1 PATCH, 20 POST, 1 PUT. They span 9 resource areas: Home, HealthCheck, Operations, Order, Visibility, Routes, OAuth2, Documents, Manifest. Each is listed below with its method, path, parameters, and response codes.

Home 1
GET
/
Root path showing app name and version number
index → 200400
HealthCheck 1
HEAD
/
Health check
healthCheck → 400default
Operations 17
POST
/user/authenticate
Creates and returns an authentication token
authenticate body → 200401default
POST
/delivery/create
Creates a new delivery
createDelivery body → 200422default
POST
/delivery/get-rates
Fetches rates of delivery through OneRail network. If saveDraftDelivery is set to true then a delivery will be created. If set to false rates will be fetched without creating a delivery.
getDeliveryRates body → 200400
POST
/delivery/check-availability
Check delivery availability using progressive input. Minimal requests can return top-level availability only; richer requests can include service-level details.
checkDeliveryAvailability body → 200400
GET
/delivery/{id}/details
Returns delivery details
getDetails 2 params → 200404default
GET
/delivery/get-historical-rates
Get historical rates for a delivery
getHistoricalDeliveryRates 2 params → 200400404
POST
/delivery/{deliveryId}/reschedule
Reschedule delivery
rescheduleDelivery 1 param body → 200400
POST
/delivery/{id}/cancel
Cancel a delivery
cancelDelivery 1 param body → 200404default
POST
/delivery/{id}/shipment-id
Update the shipmentId on a delivery
updateShipmentId 1 param body → 200400
POST
/delivery/pre-validation
Validate delivery before creation
preValidateDelivery body → 200422default
POST
/delivery/pre-validation-multiple
Validate delivery before creation
preValidateDeliverySlas body → 200422default
GET
/shipping-label/{id}
Returns labels for all containers of the delivery
labelInfo 1 param → 200400
GET
/shipping-label/{id}/{containerId}
Returns label for a specific container
containerLabelInfo 2 params → 200400
GET
/shipping-label/generate/{deliveryId}
Returns labels for all containers of the delivery
getLabelCached 1 param → 200400
GET
/assets/{image}
Display image stored in Azure storage account
viewImage 2 params → 302400
POST
/set-redis-key/{key}
Display image stored in Azure storage account
setPayload 1 param body → 200422
POST
/delivery/{deliveryId}/scanData
Create scan data records for containers.
createScanData 1 param body → 200404default
Order 6
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
Visibility 2
POST
/visibility/create
Use the visibility endpoint
createVisibility body → 200422default
POST
/visibility/{orderId}/add-deliveries
Add visibility deliveries to order
addVisibility 1 param body → 200422default
Routes 1
POST
/v1/routes
Create new orders within one or more routes.
createRoutes body → 200422default
OAuth2 1
POST
/oauth2/token
An endpoint that processes a clientId and clientSecret, verifies the client's credentials, and issues an access token for authorized API access upon successful validation.
issueToken body → 200401default
Documents 1
GET
/delivery/{id}/documents
Retrieve all documents associated with a specific delivery. This includes a variety of documents required for the shipment process, such as shipping labels, hazard labels, Bills of Lading (BOL), invo…
getDocuments 3 params → 200404default
Manifest 1
POST
/close-manifest
Close a carrier manifest
closeManifest body → 200400default

Schemas 49

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

Error
object
4 properties 1 required
CloseManifestRequest
object
7 properties 3 required
CapabilityTags
array
UserCredentials
object
3 properties 2 required
Delivery
object
27 properties 4 required
DeliveryAvailabilityRequest
object
27 properties 2 required
AvailabilityLocationInfo
object
Location data for availability check. Provide any combination of address fields and/or a geopoint.
18 properties
DeliveryAvailabilityResponse
object
3 properties
DeliveryOptions
string
LocationInfo
object
18 properties 4 required
OrderData
object
10 properties 1 required
HazardousMaterialContainerDetails
object
8 properties
HazardousMaterialOrderItemDetails
object
8 properties
EmergencyContact
object
4 properties
OrderItem
object
14 properties 6 required
DeliveryType
string
CustomerData
object
4 properties 3 required
v2OrderRequest
object
9 properties 3 required
v2OrderResponse
object
5 properties
OrderCreate
object
8 properties
OrderUpdate
object
8 properties 1 required
ReturnDeliveryCreate
object
7 properties 1 required
OrderPartialUpdate
object
27 properties
OrderInfo
object
8 properties
OriginLocation
object
13 properties 4 required
OrderDelivery
object
22 properties 3 required
ReturnDelivery
DeliveryCreated
object
12 properties
DeliveryOrderItemCreated
object
14 properties
DeliveryData
object
13 properties
DeliveryList
OrderCreated
object
4 properties
Containers
array
PredefinedContainerBase
object
11 properties 3 required
PredefinedContainer
object
1 property
ChildPredefinedContainer
object
1 property
GrandChildPredefinedContainer
object
1 property
CustomContainerBase
object
15 properties 5 required
CustomContainer
object
1 property
ChildCustomContainer
object
1 property
GrandChildCustomContainer
object
1 property
LabelInfo
object
8 properties
ContainerLabelInfo
object
11 properties
HistoricalRateInfo
object
15 properties
ContainerOrderItem
object
14 properties 6 required
ScanData
object
2 properties 1 required
OAuthCredentials
object
3 properties 3 required
OAuthTokenResponse
object
3 properties 3 required
RatesResponse
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onerail-delivery-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of OneRail Delivery 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.