CloudKitchens Manager Order 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 Manager Order 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
11 operations
across 11 paths,
and defines 63 schemas.
It is described by OpenAPI 3.2.0, at version v1.
Requests are made against a single base URL, https://{{public-api-url}}.
The identity and technical contract details declared by the specification.
manager_order_endpoints 11
Endpoints for applications that act on the merchant/store side of an order rather than as the ordering marketplace — typically Point-of-Sale (POS) systems, Business Intelligence (…
POST
/manager/order/v1/orders/order-created
Notify the result of a Create Order event
orderCreated
2 params
→ 200400401403404422
GET
/manager/order/v1/orders
Fetch order feed for a store
managerGetOrderFeed
5 params
→ 200400401403404422
GET
/manager/order/v1/sources/{source}/orders/{orderId}
Fetch order with Manager Info
getManagerOrder
3 params
→ 200400401403404422
POST
/manager/order/v1/sources/{source}/orders/{orderId}/confirm
Request order confirmation
requestOrderConfirmation
3 params
body
→ 202400401403404422
POST
/manager/order/v1/sources/{source}/orders/{orderId}/cancel
Request order cancelation
requestOrderCancelation
3 params
body
→ 202400401403404422
POST
/manager/order/v1/sources/{source}/orders/{orderId}/ready-to-pickup
Mark an order as ready to pickup
markAsReadyToPickup
3 params
→ 202400401403404422
POST
/manager/order/v1/sources/{source}/orders/{orderId}/create-packaging-component
Create a packaging component
createPackagingOrderComponent
3 params
→ 200400401403404422
POST
/manager/order/v1/sources/{source}/orders/{orderId}/fulfill
Mark an order as fulfilled
markAsFulfilled
3 params
→ 202400401403404422
POST
/manager/order/v1/sources/{source}/orders/{orderId}/close
Mark a dine-in (open-tab) order as closed
markDineInOrderClosed
3 params
→ 202400401403404409422
PUT
/manager/order/v1/sources/{source}/orders/{orderId}/items
Update order customer items
managerUpdateOrderCustomerItems
3 params
body
→ 202400401403404409422
POST
/manager/order/v1/sources/{source}/orders/{orderId}/prep-time
Update order prep time
updateOrderPrepTime
3 params
body
→ 202400401403404422
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
PromotionDetails
objectnull
Order promotion details.
3 properties
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
OrderWithManagerInfo
object
An order placed by a customer with manager injection details
5 properties
3 required
ItemAddedModification
object
1 property
1 required
CustomerItemModification
object
One modification to apply. Exactly one of quantityUpdated, priceAdjusted, or itemAdded must be set.
3 properties
PictureRequirement
objectnull
Enables and configure the picture requirement.
1 property
AccountType
string
The type of ACH account.
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
ManagerOrderIssue
object
Issue codes for issues encountered when processing a manager order
2 properties
1 required
ManagerConfirmOrderRequest
object
The request to confirm an order.
1 property
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
PaymentDetailsBecs
object
Details of a BECS payment method in Australia.
5 properties
PaymentDetailsBacs
object
Details of a BACS payment method in the UK.
6 properties
PaymentDetailsCard
object
Details of a card payment method.
10 properties
Address
objectnull
Order delivery address.
8 properties
Courier
objectnull
Details about the delivery courier.
5 properties
OrderPriceAdjustedModification
object
1 property
1 required
RecordPaymentType
string
The type of payment method.
RecordProviderType
string
The type of payment provider.
LoyaltyInfo
objectnull
The customer's loyalty information.
1 property
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
OrderExternalIdentifiers
object
The external identifiers.
5 properties
2 required
SignatureRequirement
objectnull
Enables and configure the signature requirement.
3 properties
OrderComponentId
object
2 properties
CustomerPayment
object
8 properties
3 required
Location
objectnull
Latitude and longitude of the address.
2 properties
2 required
ManagerOrderIssues
object
Manager order issues
2 properties
PaymentDetailsSepa
object
Details of a SEPA payment method in EU countries.
8 properties
QuantityUpdatedModification
object
3 properties
3 required
FulfillmentInfo
objectnull
Information on order fulfillment.
7 properties
OrderFeed
object
An order feed response
2 properties
1 required
OrderCustomerItemsUpdateRequest
object
Request to update order customer items. Only supported for dine-in orders when slug is d2c-eater-website and the order tab is open. Modifying party and modific…
2 properties
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
ManagerCancelOrderRequest
object
The request to cancel an order.
2 properties
1 required
Person
objectnull
The recipient information.
5 properties
DeliveryInfo
objectnull
Information on order's delivery process.
7 properties
Item
object
14 properties
1 required
DropoffInstructions
objectnull
Requirements to verify the completion of the delivery.
2 properties
CardFundingType
string
The funding type of the card.
CardWalletType
string
The type of wallet associated with the card.
ManagerItemIssue
object
A detailed issue encountered with this item or modifier
2 properties
1 required
ManagerItemIssues
object
Manager item or modifier issues
2 properties
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…
PaymentRecord
object
Represents the details and metadata of a payment method used in transactions.
7 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
CardInfo
objectnull
Additional card information.
2 properties
2 required
CustomerPaymentV2
objectnull
Details about customer payment.
4 properties
ManagerOrderCancelDetails
object
Details about a canceled manager order
1 property
1 required
PaymentDetailsAcss
object
Details of an ACSS payment method in Canada.
9 properties
OrderPrepTimeUpdateRequest
object
The request to change an order prep time.
1 property
1 required
PersonalIdentifiers
objectnull
The person's personal identifiers (e.g. tax identification number).
2 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
CardBrandType
string
The brand of the card.
PaymentDetailsAch
object
Details of a debit ACH payment method in the US.
7 properties
VerificationRequirements
objectnull
Verification requirements for the delivery.
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs CloudKitchens publishes across the network.
