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

Locus OrderServiceability API

The OrderServiceability API from Locus — 1 operation(s) for orderserviceability.

Locus OrderServiceability API is one of 16 APIs that Locus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include OrderServiceability. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 26 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.

1 operations 1 paths 26 schemas 1 POST

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 OrderServiceability 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

OrderServiceability 1
POST
/client/{clientId}/get-slots
Get available future slots for the given order
getServiceableSlots 1 param body → 200

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are GetServiceableSlotsRequest (25 properties), MinimalLineItem (19 properties), StructuredAddress (13 properties), DlcTimeSlot (10 properties). Each schema is shown below with its type and property counts.

SlotSelectionStrategy
string
MinimalLatLng
object
A latitude, longitude pair
2 properties 2 required
TimeSlot
TransitCode
object
2 properties
Weight
object
Weight of order
2 properties 2 required
AmountTransaction
object
Transaction of an amount.
5 properties
OrderType
DlcTimeSlot
object
Time slot for a delivery linked checkout (DLC)
10 properties 1 required
CapacityMetadata
object
3 properties
LineItemPart
object
A part of the line item which can be shipped separately
6 properties 1 required
LineItemSummary
object
3 properties
MinimalLineItem
object
A single item contained in the order
19 properties 2 required
BoxDetailSummary
object
4 properties
BaseAmount
object
Amount value of an item
1 property
GetSlotsResponse
object
Response with available time slots for the drop
3 properties 1 required
LocationSource
string
location provider source.
OmsDimensions
object
Dimensions of an item
4 properties
Amount
object
Amount of an item
3 properties
MinimalContactPoint
object
Contact point at a visit location.
5 properties
HandlingUnitEnum
string
delivery handling units to identify deliverable field
WeightUnit
string
Unit for weight
Volume
object
Volume of an item
2 properties 2 required
VolumeUnit
string
Unit for volume
GetServiceableSlotsRequest
object
Get Serviceable Slot request
25 properties 3 required
StructuredAddress
object
A real world address
13 properties
LengthUnit
string
Unit for length

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

locus-sh-orderserviceability-api-openapi.yml Raw ↑

Other APIs Locus publishes across the network.

Locus HomebaseMaster API
Locus LocationMaster API
Locus Order API
Locus PersonnelMaster API
Locus Rider API
Locus RiderPersona API
Locus Roster API
Locus ServiceType API
Locus ServiceTypeConfiguration API
Locus ShiftTag API
Locus SKUMaster API
Locus TeamMaster API
Where this information came from

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