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

CloudKitchens Orders Endpoints API

Endpoints used by ordering marketplaces and other order sources to send orders to a store and keep them up to date.This domain lets an order source submit new orders as customers place them, reflect later changes as the orders progress, and backfill historical orders for reporting.

CloudKitchens Orders Endpoints API is one of 27 APIs that CloudKitchens publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orders Endpoints. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 6 operations across 6 paths, and defines 54 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://{{public-api-url}}.

6 operations 6 paths 54 schemas 3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.cloudkitchens.com
Authentication
OAuth 2.0
License
Proprietary
Resource Areas
1

Authentication & Security 1

CloudKitchens Orders Endpoints API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2.0) using the clientCredentials and authorizationCode flows, exposing 29 scopes.

  • OAuth2.0 — The Authorization API is based on the [OAuth2.0 protocol](https://tools.ietf.org/html/rfc6749), supporting the (Client Credentials)[https://datatracker.ietf.or…

Paths & Operations 6

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

orders_endpoints 6

Endpoints used by ordering marketplaces and other order sources to send orders to a store and keep them up to date. This domain lets an order source submit new orders as customers…

POST
/v1/orders
Create order
createOrder 1 param body → 200400401403404422
PUT
/v1/orders/{orderId}
Update order
updateOrder 2 params body → 200400401403404422
POST
/v1/orders/{orderId}/status
Update order status
updateOrderStatus 3 params body → 202400401403404422
PUT
/v1/orders/{orderId}/payments
Update order customer payment
updateOrderCustomerPayment 2 params body → 202400401403404422
PUT
/v1/orders/{orderId}/delivery
Update order delivery information
updateOrderDeliveryInfo 2 params body → 202400401403404422
POST
/v1/orders/past-orders
Upload past orders
uploadPastOrders 1 param body → 200400401403404422

Schemas 54

The contract defines 54 schemas that model the data the API accepts and returns. The most detailed are FinancialData (19 properties), Item (14 properties), Order (14 properties), ItemModifier (11 properties). Each schema is shown below with its type and property counts.

OrderReference
object
An order reference.
2 properties 2 required
OrderTotal
object
Flat, customer-facing breakdown of an order's monetary values (V1). orderTotal captures only what the customer was charged, as a small set of aggregate figures…
8 properties 1 required
Payout
objectnull
Breakdown of the net payout the store receives for this order, by source of the payout. The sum of these fields represents the money the store ultimately nets;…
3 properties
PromotionDetails
objectnull
Order promotion details.
3 properties
PictureRequirement
objectnull
Enables and configure the picture requirement.
1 property
AccountType
string
The type of ACH account.
CardBrandType
string
The brand of the card.
CompositeFinanceLine
object
composite finance line can represent a value, tax and VAT for a given line as a list of SimpleFinanceLine objects
1 property 1 required
SimpleFinanceLine
object
simple finance line.
3 properties 3 required
ErrorDetail
object
The error detail response object.
2 properties
ItemModifier
object
11 properties 1 required
SourceExternalIdentifiers
objectnull
The external identifiers.
5 properties
MandateStatus
string
The status of the mandate.
ErrorMessage
object
The error response object.
2 properties
PaymentDetailsCard
object
Details of a card payment method.
10 properties
PaymentDetailsBacs
object
Details of a BACS payment method in the UK.
6 properties
PaymentDetailsBecs
object
Details of a BECS payment method in Australia.
5 properties
Address
objectnull
Order delivery address.
8 properties
RecordProviderType
string
The type of payment provider.
Courier
objectnull
Details about the delivery courier.
5 properties
RecordPaymentType
string
The type of payment method.
LoyaltyInfo
objectnull
The customer's loyalty information.
1 property
OrderExternalIdentifiers
object
The external identifiers.
5 properties 2 required
PreparationTime
objectnull
Preparation time information for an order.
1 property
FinancialData
object
Breakdown of order values. Represents total values, fees, discounts, and any possible adjustments that may happen in the order value. Breakdown lists can be us…
19 properties 1 required
UploadPastOrdersResponse
object
The response to create a past order (read only).
1 property 1 required
SignatureRequirement
objectnull
Enables and configure the signature requirement.
3 properties
OrderDeliveryInfoUpdateRequest
object
The request to update an order delivery info status.
1 property 1 required
CustomerPayment
object
8 properties 3 required
Location
objectnull
Latitude and longitude of the address.
2 properties 2 required
PaymentDetailsSepa
object
Details of a SEPA payment method in EU countries.
8 properties
FulfillmentInfo
objectnull
Information on order fulfillment.
7 properties
UploadPastOrdersRequest
object
The request to create past orders (read only).
1 property 1 required
AccountHolderType
string
The type of account holder.
Order
object
An order placed by a customer. Orders are pushed into Otter by ordering marketplaces / order sources and read back (including merchant-side detail) via the Ord…
14 properties 3 required
Person
objectnull
The recipient information.
5 properties
DeliveryInfo
objectnull
Information on order's delivery process.
7 properties
Item
object
14 properties 1 required
CardFundingType
string
The funding type of the card.
OrderStatusUpdateRequest
object
The request to change an order status.
1 property 1 required
CardWalletType
string
The type of wallet associated with the card.
DropoffInstructions
objectnull
Requirements to verify the completion of the delivery.
2 properties
PaymentRecord
object
Represents the details and metadata of a payment method used in transactions.
7 properties
CustomerPaymentV2
objectnull
Details about customer payment.
4 properties
OrderTotalV2
objectnull
Richer, line-itemized breakdown of an order's monetary values (V2). orderTotalV2 is the preferred way to describe order economics. Where the V1 orderTotal expo…
4 properties 1 required
StoreId
string
The unique identifier of the store in the partner application. This ID, along with the Application ID, will be used to match the correct store when performing…
CardInfo
objectnull
Additional card information.
2 properties 2 required
RequiredDeliveryInfo
object
Information on order's delivery process.
7 properties
PaymentDetailsAcss
object
Details of an ACSS payment method in Canada.
9 properties
ServiceProviderCharge
objectnull
Breakdown of the charges the order source (the ordering marketplace / service provider) deducts from or bills to the store for this order. These are not charge…
7 properties
PersonalIdentifiers
objectnull
The person's personal identifiers (e.g. tax identification number).
2 properties
OrderCustomerPaymentUpdateRequest
object
The request to update customer payment for an order.
4 properties 2 required
PaymentDetailsAch
object
Details of a debit ACH payment method in the US.
7 properties
VerificationRequirements
objectnull
Verification requirements for the delivery.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudkitchens-orders-endpoints-api-openapi.yml Raw ↑

Other APIs CloudKitchens publishes across the network.

CloudKitchens Account Pairing Endpoints API
CloudKitchens Account Pairing Webhooks API
CloudKitchens Auth Endpoints API
CloudKitchens Callback Endpoints API
CloudKitchens Delivery Endpoints API
CloudKitchens Delivery Webhooks API
CloudKitchens Direct Orders Endpoints API
CloudKitchens Finance Endpoints API
CloudKitchens Inventory Endpoints API
CloudKitchens Manager Loyalty Endpoints API
CloudKitchens Manager Menu Endpoints API
CloudKitchens Manager Order Endpoints API
Where this information came from

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