Ordering
Ordering Stack - Ordering API. Provides functionalities for order lifecycle. Create new order, add items, remove items, abandon order...
187 subscribers
949 ms avg latency
40 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Ordering endpoints
| Method | Endpoint | Description |
|---|---|---|
| order | ||
| GET |
listLast /ordering-api/api/orders/last |
Get last orders for user (all states included). |
| POST |
removeCoupon /ordering-api/api/order/{uid}/removeCoupon |
Remove coupon from order. |
| POST |
commentOrderLine /ordering-api/api/order/{uid}/{lid}/comment |
Add comment to order line. |
| POST |
splitLines /ordering-api/api/order/{uid}/lines/split |
Split order lines. Makes copies of existing order line with smaller quantities. Sum of quantities must match. |
| POST |
setDue /ordering-api/api/order/{uid}/due |
Set due timestamp for order. |
| POST |
deliverOrder /ordering-api/api/order/{uid}/deliver |
Mark order as delivered. |
| POST |
alterExtra /ordering-api/api/order/{uid}/extra |
Change extra params in order. |
| POST |
addCoupon /ordering-api/api/order/{uid}/addCoupon |
Add coupon to order. |
| POST |
setQueuePos /ordering-api/api/order/{uid}/queuePos |
Manually set queue pos for order. Tenant configuration must allow it. |
| POST |
confirmLineOrder /ordering-api/api/order/{uid}/lines/confirm |
Mark order lines as confirmed. |
| POST |
removeLineOrder /ordering-api/api/order/{uid}/lines/remove |
Remove order line. Whether line can be removed depends on its state. |
| POST |
newOrder /ordering-api/api/order/new |
Create new order. |
| POST |
alterLinesExtra /ordering-api/api/order/{uid}/lines/extra |
Change extra params in order. |
| POST |
cancelOrder /ordering-api/api/order/{uid}/cancel |
Cancel order. Cancelling is available for restaurant staff. Involves e-payments refund. If refund fails - cancelling does not take place. |
| POST |
paymentUpdate /ordering-api/api/order/{uid}/payment-update |
Update payment information in order. |
| POST |
addFiscalize /ordering-api/api/order/{uid}/fiscalize |
Add fiscal information to order. This should reflect printed fiscal strip. |
| GET |
getList /ordering-api/api/orders |
Get paginated list of orders. This endpoint is compatible with React AdminOnRest framework to provide DataSource. |
| POST |
processedLineOrder /ordering-api/api/order/{uid}/lines/processed |
Mark order line as processed/prepared. |
| POST |
attach /ordering-api/api/order/{uid}/attachLoyaltyCard |
Attach loyalty ID to order. |
| POST |
appendLineOrder /ordering-api/api/order/{uid}/append |
Add order line to order. |
| POST |
setAddress /ordering-api/api/order/{uid}/address |
Set delivery address for order. |
| POST |
processingLineOrder /ordering-api/api/order/{uid}/lines/processing |
Mark order lines as preparing/processing. |
| POST |
requestFiscal /ordering-api/api/order/{uid}/requestFiscalData |
Request fiscal data for order. Data is returnet through websocket. |
| GET |
listOpenedVenue /ordering-api/api/orders/venue/{uid} |
Get opened orders in venue. Used by KDS, queue displays etc. |
| POST |
abandonOrder /ordering-api/api/order/{uid}/abandon |
Abandon order. Only not completed orders can be abandoned this way. |
| POST |
contact /ordering-api/api/order/{uid}/contact |
Set contact information for user. |
| POST |
voidLineOrder /ordering-api/api/order/{uid}/lines/void |
Mark order lines as voided. |
| GET |
listOpened /ordering-api/api/orders/opened |
Get opened orders for user. |
| POST |
detach /ordering-api/api/order/{uid}/detachLoyaltyCard |
Detach loyalty ID from order. |
| POST |
changeVenues /ordering-api/api/order/{uid}/venues |
Set venues (buckets) in order. |
| POST |
changeQuantities /ordering-api/api/order/{uid}/quantity |
Change lines quantity. |
| POST |
kdsTraceView /ordering-api/api/order/{uid}/kds-trace-view |
Track order visibility on KDS. |
| GET |
get /ordering-api/api/orders/{uid} |
Get single order by ID. |
| POST |
claimOrder /ordering-api/api/order/{uid}/claim |
Claim order. This is used to attach additional user to order. User can be just another user, waiter or technical account for kiosk, etc. |
| POST |
commentOrder /ordering-api/api/order/{uid}/comment |
Add comment to order. |
| POST |
payOrder /ordering-api/api/order/{uid}/payment |
Add payment information to order. |
| internal | ||
| POST |
syncOrder /ordering-api/api/order/sync |
Sync order from external source. It acts as snaptshot and all required order structures must be filled. |
| loyalty | ||
| POST |
simpleLoyalty /ordering-api/simple-loyalty |
Simple loyalty implementation with '3-parts sets 10% off' and 'every third item - half price'. It uses product extra tags 'PART' which should take one of values: 'main', 'side',… |
| upsell | ||
| POST |
simpleUpsell /ordering-api/simple-upsell |
Simple upsell implementation. Uses 'category' extra tag in menu-api service to link categories that should co-exist in order. Configuration is in tenant as 'upselCfg' and consist… |
| verification | ||
| POST |
verifyOrderPayment /ordering-api/api/order/{uid}/verifyPayment |
Verify order by ID if it can be paid. |
Ordering pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
