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

Kardinal Order API

How to create, retrieve, update and delete orders in a plan.

Kardinal Order API is one of 8 APIs that Kardinal 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, an API reference, a getting-started guide, and authentication docs.

This API exposes 3 operations across 1 path, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 2.55.0.

Requests are made against a single base URL, /api/v2.

3 operations 1 paths 20 schemas 1 DELETE1 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.55.0
Base URL
https://app.kardinal.ai/api/v2
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 5

Kardinal Order API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (otp_token). It accepts HTTP bearer tokens (JWT) (gdpr_token). It accepts HTTP bearer tokens (JWT) (access_token). It accepts HTTP bearer tokens (JWT) (refresh_token). It accepts HTTP bearer tokens (JWT) (password_token). By default, every request must be authenticated.

Paths & Operations 3

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

Order 3

How to create, retrieve, update and delete orders in a plan.

GET
/agencies/{agencyId}/plans/{planId}/orders/{orderId}
Retrieve a plan's order
getPlanOrder 3 params → 200401403404500
PUT
/agencies/{agencyId}/plans/{planId}/orders/{orderId}
Create or update a plan's order
putPlanOrder 4 params body → 200201400401403404500
DELETE
/agencies/{agencyId}/plans/{planId}/orders/{orderId}
Delete a plan's order
deletePlanOrder 4 params → 204401403404500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are SingleStop (10 properties), Order (8 properties), EnvelopedOrder (4 properties), Error (3 properties). Each schema is shown below with its type and property counts.

EnvelopedOrder
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
4 properties
Capacities
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
AgencyId
The agency id.
ErrorProperties
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
StopKind
string
[TOVALIDATE] Description pending review by a Kardinal engineer.
PlanId
The plan id.
Duration
string
A period of time, expressed in the ISO8601 duration format.
Position
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
2 properties 2 required
EnvelopedErrors
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
1 property
RegexPrefixedIdValidation
string
An id beginning with a prefix and an underscore.
SingleStop
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
10 properties 2 required
PlanVersion
integer
The plan version.
DateTime
string
A full calendar date time, expressed in the ISO8601 date format: YYYY-MM-DDThh:mm:ssZ.
RegexIdValidation
string
At least one character among those allowed: unaccented alpha-numeric characters, "-", ".", "", "~", ":", "@", "!", "$", ",".
Stop
[TOVALIDATE] Description pending review by a Kardinal engineer.
Properties
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
Order
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
8 properties 2 required
Error
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
3 properties 2 required
TaggedTimeWindow
object
TimeWindow with resource tags.
3 properties 2 required
AlternativesStop
object
A stop composed of different alternative single stops.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kardinal-order-api-openapi.yml Raw ↑

Other APIs Kardinal publishes across the network.

Kardinal Authenticate API
Kardinal Core API
Kardinal Management API
Kardinal Plan API
Kardinal Resource API
Kardinal Simple Plan API
Kardinal Solution API
Where this information came from

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