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

Dojo Orders API

The Orders API from Dojo — 7 operation(s) for orders.

Dojo Orders API is one of 19 APIs that Dojo publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 9 operations across 7 paths, and defines 41 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://your-epos.example.com.

9 operations 7 paths 41 schemas 2 DELETE2 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.dojo.tech
Resource Areas
1

Paths & Operations 9

Across 7 paths, the API surfaces 9 operations — 2 DELETE, 2 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Orders 9
POST
/v1/orders
Create an order
v1-post-orders 4 params body → 2004XX5XX
GET
/v1/orders/{orderId}
Get an order by id
v1-get-orders-orderId 5 params → 2004XX5XX
DELETE
/v1/orders/{orderId}
Cancel an order by id
v1-delete-orders-orderId 5 params → 2004XX5XX
POST
/v1/orders/search
Search orders
4 params body → 2004XX5XX
POST
/v1/orders/{orderId}/lock
Lock an EPOS Order
v1-post-order-lock 5 params body → 2004094XX5XX
DELETE
/v1/orders/{orderId}/locks/{lockId}
Unlock an EPOS Order
v1-delete-order-lock 6 params → 2004XX5XX
PUT
/v1/orders/{orderId}/locks/{lockId}
Extend an EPOS Order Lock
v1-put-extend-order-lock 6 params body → 2004XX5XX
GET
/v1/orders/{orderId}/bill
Get a printable bill
v1-get-orders-bill 5 params → 2004XX5XX
POST
/v1/orders/{orderId}/record-payment
Record Payment Request
v1-post-record-order-payment 5 params body → 2004XX5XX

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are Order (18 properties), CreateOrderRequest (12 properties), BillLine (11 properties), OrderItem (7 properties). Each schema is shown below with its type and property counts.

BillLine
object
11 properties 1 required
BillMerchantEmailAddress
object
A predefined bill field, containing the merchants contact email address. This will be pre-formatted in the bill
1 property 1 required
Payment
object
3 properties 2 required
Align
string
DineInDetails
object
Details for an order-in order
5 properties
OrderItem
object
7 properties 4 required
BillTaxNumber
object
A predefined bill field, containing the merchants tax number. This will be pre-formatted in the bill, and shown at the bottom
2 properties 2 required
SearchDineInDetails
object
Details for searching order-in orders
4 properties
BillHorizontalLine
object
A bill line containing a horizontal line
1 property
SearchOrdersRequest
object
3 properties
Money
object
2 properties 2 required
BillLineType
string
BillMerchantName
object
A predefined bill field, containing the merchants name. This will be pre-formatted in the bill
1 property 1 required
BillMerchantAddress
object
A predefined bill field, containing an address. This will be pre-formatted in the receipt
2 properties 2 required
CollectionDetails
object
2 properties
ExtendOrderLockRequest
object
Request an extension to the write lock on an Order.
1 property 1 required
Size
string
BillMerchantPhoneNumber
object
A predefined bill field, containing the merchants contact phone number. This will be pre-formatted in the bill
1 property 1 required
PaymentWithLockId
object
4 properties 2 required
Order
object
18 properties 3 required
BillSection
object
An object representing either a header or footer on a BillSection
1 property 1 required
EPOSError
object
3 properties 1 required
Cursor
object
A cursor for use in pagination.
3 properties
PagedOrdersResponse
object
3 properties
BillLogo
object
A predefined bill field, containing a logo. This will appear at the top of the bill
1 property 1 required
OrderType
string
OrderDetails
object
Details about the order including the type and the details.
3 properties 1 required
CreateOrderRequest
object
12 properties 5 required
Customer
object
4 properties
OrderStatus
string
BillImage
object
A bill line containing an image
2 properties 1 required
CreateOrderLockRequest
object
Request a write lock on an Order, guaranteeing only Dojo can write changes to the order, until receiving the corresponding UnlockOrder request.
2 properties 2 required
OrderSubItem
object
6 properties 4 required
ExtendOrderLockResponse
object
Response for a write lock extension request
OrderBill
object
3 properties 3 required
BillURL
object
A bill line containing a URL. This can be printed as a QR code on bills, or a hyperlink with the text as the description, in digital format.
4 properties 1 required
EPOSErrorType
string
TaxLine
object
The tax line object.
5 properties 1 required
BillText
object
A bill line containing text, with optional conditional formatting
4 properties 2 required
Modifier
object
4 properties 4 required
Discount
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dojo-orders-api-openapi.yml Raw ↑

Other APIs Dojo publishes across the network.

Dojo Areas API
Dojo Capabilities API
Dojo Captures API
Dojo Customers API
Dojo Events API
Dojo Flows API
Dojo Parties API
Dojo Payment intents API
Dojo Refunds API
Dojo Reservations API
Dojo Reversal API
Dojo Setup intents API
Where this information came from

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