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 Shipper Contract API

The Shipper Contract API from OneRail — 9 operation(s) for shipper contract.

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

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

This API exposes 13 operations across 9 paths. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, /.

13 operations 9 paths 0 schemas 1 DELETE6 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 4

OneRail Shipper Contract API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearer). 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). It supports OAuth 2.0 (OAuth) using the authorizationCode flow. By default, every request must be authenticated.

  • 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…
  • ApiKey — Shared secret key used for machine-to-machine integrations. Must be sent together with X-ONERAIL-APP-ID and is validated against the stored ApiAuth record for…
  • AppId — Application identifier (UUID) that pairs with X-ONERAIL-API-KEY for machine-to-machine integrations. Both headers are required for ApiKey-based authentication.
  • 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 13

Across 9 paths, the API surfaces 13 operations — 1 DELETE, 6 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Shipper Contract 13
POST
/v1/shipper-contract
Create Shipper Contract
createShipperContract body → 200default
GET
/v1/shipper-contract/{shipperContractId}
Get Shipper Contract
getShipperContract 1 param → 200default
PUT
/v1/shipper-contract/{shipperContractId}
Update Shipper Contract
updateShipperContract 1 param body → 200default
DELETE
/v1/shipper-contract/{shipperContractId}
Remove Shipper Contract
removeShipperContract 1 param → 200default
POST
/v1/shipper-contract/{shipperContractId}/sla
Create an SLA for a Shipper Contract
createSla 1 param body → 200default
GET
/v1/shipper-contract/{shipperContractId}/slas
Get all SLAs for a Shipper Contract
getSlas 5 params → 200default
GET
/v1/shipper-contract/{shipperContractId}/slas-info
Get basic info for all SLAs for a Shipper Contract
getSlaInfos 5 params → 200400default
POST
/v1/shipper-contract/{shipperContractId}/submit-approval
Notify OneRail Approver to approve SLAs for a Shipper Contract
approveNotifyShipperContract 1 param body → 200default
GET
/v1/shipper-contract/{shipperContractId}/shipper-contract-sla-templates
Get all sla template for this Shipper Contract
getAllSlaTemplates 5 params → 200default
PUT
/v1/shipper-contract/{shipperContractId}/shipper-contract-sla-templates
Update Shipper Contract
updateSlaTemplateCapabilityUsageCharge 1 param body → 200default
GET
/v1/shipper-contract/{shipperContractId}/lp-contract-sla
Get all lp contract sla for this Shipper Contract
getAllLpContractSlas 6 params → 200default
PUT
/v1/shipper-contract/{shipperContractId}/lp-contract-sla
Update LP Contract Sla
updateLpContractSlaCapabilityUsageCharge 1 param body → 200default
GET
/v1/shipper-contract/{shipperContractId}/all-slas-approved
Send boolean base on all slas have been approved
checkForAllSlasApproval 1 param → 200default

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onerail-shipper-contract-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 Shipper Contract 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.