v2.0.0
External Orders API 2.0
External Orders API 2.0
Link connects PAR’s ordering platform to your marketplace (MP).
Flow Overview
| # | Area | Event | Summary |
|---|---|---|---|
| 1 | Onboarding | Authenticate | OAuth client credentials → Bearer token |
| 2 | Store | Store connected | Link → MP: map Link venue_id to your storefront |
| 3 | Store | Store disconnected | Link → MP: stop new orders; complete in-flight as agreed |
| 4 | Store | Store paused | Either side can pause accepting orders |
| 5 | Store | Store resumed | Resume normal order flow |
| 6 | Menu | Menu published | Link → MP: fetch full menu from menu_url |
| 7 | Menu | Menu unpublished | Link → MP: remove menu from your catalog |
| 8 | Order | New order | MP → Link: submit order for the restaurant |
| 9 | Order | Order confirmed | Link → MP: restaurant accepted; prep time included |
| 10 | Order | Order rejected | Link → MP: restaurant rejected; reason included |
| 11 | Order | Order ready | Link → MP: ready for pickup / handoff |
| 12 | Order | Order cancelled | MP ↔ Link: stay aligned on cancel state |
Order Lifecycle
States are driven mostly by notifications between MP and Link (restaurant actions flow through Link).
| # | State | Side | What happens |
|---|---|---|---|
| 1 | PENDING / INIT | MP | MP sends new order to Link; restaurant sees it |
| 2a | CONFIRMED / SENT | Link | Restaurant accepts; Link notifies MP with prep time |
| 2b | REJECTED | Link | Restaurant rejects; Link notifies MP with reason |
| 3 | IN PREP | Link | Kitchen preparing; Link may adjust ETA toward MP |
| 4 | READY | Link | Order ready for pickup or handoff |
| — | CANCELLED | MP ↔ Link | Either side can initiate; rules depend on stage |
Priority and Sequencing
Phase 1 — Foundation
| Area | Why |
|---|---|
| Authentication | Required for every call |
| Store connect / disconnect | Mapping before menus or orders |
Phase 2 — Primary Order Path
| Area | Why |
|---|---|
| Menu push to MP | Menus before orders |
| New order | Inbound traffic |
| Confirm / reject | Restaurant decision back to MP |
| Ready | Dispatch-critical |
Phase 3 — Full Lifecycle
| Area | Why |
|---|---|
| Pause / resume store | Operational control |
| Cancel order | Exceptions |
Phase 4 — Polish
| Area | Why |
|---|---|
| Store status read | Support / reconciliation |
| Menu pull on demand | Recovery and audits |
Client Libraries