Locus Order API is one of 16 APIs that Locus 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 and API documentation.
This API exposes
9 operations
across 8 paths,
and defines 121 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://oms.locus-api.com/v1.
9 operations8 paths121 schemas2 GET1 POST6 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://oms.locus-api.com/v1
Authentication
HTTP Basic, API Key
Resource Areas
1
Authentication & Security 2
Locus Order API declares
2 security schemes
for authenticating requests.
It accepts HTTP basic authentication (locusauth).
An API key is passed in the header as Authorization (apiKeyAuth).
locusauth — HTTP Basic Authentication
Paths & Operations 9
Across 8 paths, the API surfaces 9 operations — 2 GET, 1 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 121 schemas that model the data the API accepts and returns. The most detailed are OrderMetadata (92 properties), TourDetail (21 properties), OrderVisitDetails (20 properties), MinimalLineItem (19 properties). Each schema is shown below with its type and property counts.
DateSlotInfoElement
object
2 properties
PaymentInstrumentType
string
Denotes the type of payment instrument
ChecklistItems
object
4 properties
OrderFreightCostMetadata
object
1 property
TransactionDetail
ContractId
object
OrderPaymentStatus
string
Payment status of an order.
OrderCostEnum
string
Status based on contract calculation. Possible values DISABLED, CONTRACTMISSING, CALCULATIONFAILURE, AVAILABLE
LineItemPart
object
A part of the line item which can be shipped separately
6 properties1 required
FreightCost
TourCostMetadata
object
1 property
LineItemSummary
object
3 properties
Reason
object
1 property
Payment
object
A payment request, through any of the payment instruments.
15 properties5 required
OrderGeocodedLocation
object
2 properties
GeocodingConfidence
ParkOrderRequest
object
1 property
OrderStatusUpdate
object
Merge patch request wrapper
6 properties
PaymentId
object
Id of the payment instrument as identified by a provider
2 properties2 required
ChecklistItem
DeliveryAttempt
object
Delivery attempt history
1 property
OmsDimensions
object
Dimensions of an item
4 properties
AmountType
string
Payment status of an order.
Amount
object
Amount of an item
3 properties
PromiseInformation
MinimalMasterLineItem
object
4 properties
StructuredAddress
object
A real world address
13 properties
ProviderInstrumentId
object
Id of the payment instrument as identified by a provider
2 properties2 required
Actor
object
OrderStatus
string
Order status enum
MinimalLatLng
object
A latitude, longitude pair
2 properties2 required
AutoSortDetails
object
details containing the route
3 properties
TransitCode
object
2 properties
AppFields
ResponseSource
Quantity
object
Quantity of items
2 properties2 required
LineItemTransactionStatus
OrderRescheduleRequest
object
2 properties
CratingInfo
TourDetail
object
Tour details
21 properties
BaseCostBreakup
object
PodVerificationStatusEnum
CompleteOrderRequest
object
Order complete request
7 properties
Order
Order model
MinimalLineItem
object
A single item contained in the order
19 properties2 required
BoxDetailSummary
object
4 properties
EntityDefinition
object
RescheduleRequest
object
4 properties
LineItemDetails
PaymentStatus
string
Status of the payment
BaseTransactionStatus
object
6 properties3 required
ContractCostMetadata
object
4 properties
LocationSource
string
location provider source.
SlaStatusEnum
TransactionStatus
InventoryVerificationRequest
object
Inventory Verification Request
2 properties1 required
BaseLineItemTransactionStatus
object
Transaction status of a line item
3 properties
Volume
object
Volume of an item
2 properties2 required
VolumeUnit
string
Unit for volume
TimelineEntry
object
12 properties3 required
CreatePromiseInformationRequest
object
1 property
FulfillmentChannel
string
Channel through which the Order is fulfilled
TransactionChecklistItems
object
4 properties
PaymentInstrument
object
A method of payment
3 properties2 required
ShipmentRateDetail
object
OrderDetailStatusEnum
string
ReasonCode
string
Reason Code Enum
GenericResponse
object
1 property1 required
Checklist
object
A map containing selected values for each checklist item.
FulfillmentMode
string
Channel through which the Order is fulfilled
TimeSlot
PodVerificationResult
AmountTransaction
object
Transaction of an amount.
5 properties
AutomationMetadata
object
Order automation metadata
8 properties
AmountExchangeType
string
Amount exchange enum
OrderType
PodChecklistVerificationResult
object
2 properties
FreightCostSource
string
OrderSubStatus
string
Order sub status enum
LocationType
VersionedMapId
object
OrchestrationShipmentMetadata
object
5 properties
BaseAmount
object
Amount value of an item
1 property
PromiseTimelineElement
object
5 properties
ShipmentLegMetadata
object
Shipment related extra info relevant for an order
5 properties
Distance
object
2 properties
CreateLineItemDetails
CancelOrderRequest
object
1 property
MinimalContactPoint
object
Contact point at a visit location.
5 properties
WeightUnit
string
Unit for weight
LengthUnit
string
Unit for length
AmountDetails
object
It represents all amount components.
4 properties
GeocodingProvider
StringObjectMap
object
OrderAmountInformation
object
It represents all financial details of an order
10 properties
PaymentChecklistItems
object
3 properties
OrchestrationWaybillMetadata
object
3 properties
RejectedTourDetail
object
Tour details
3 properties
PartItemVolume
object
2 properties
MinimalAutosortRoute
object
Weight
object
Weight of order
2 properties2 required
CreateOrderRequest
Create order request
2 required
ChecklistMetadata
object
Order checklist metadata
2 properties
TrackingInfo
object
Tracking info
1 property
TransporterType
OrderMetadata
object
Order planning and execution metadata
92 properties
OrchestrationStatus
object
OrderVisitDetails
object
visit related details by statuses
20 properties
ShippingLabelInfo
object
BagDetails
object
object to store bagging related details on order
3 properties
TransactionDurationInfo
object
5 properties
MasterLineItemPart
object
3 properties
ExtendedStructuredAddress
DistributionChannel
string
GeocodingMetadata
object
Metadata for geocoding of the address
8 properties
OrchestrationMetadata
object
5 properties
HandlingUnitEnum
string
delivery handling units to identify deliverable field
TourFreightCostMetadata
object
3 properties
AmountDetailsTimeline
object
Maintains a chronological log of amount updates with details
5 properties
OrderCostMetadata
object
2 properties
Payments
object
Container for all payment related info
5 properties4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Locus 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.
