Overview
Below is a high-level overview of the key Commerce API interactions, with a brief description of the role they play in supporting the complete ordering journey from store discovery through to POS order injection;
Discover Nearby Stores — GET /stores
Returns locations available, sorted by distance to the user's current location and filtered by preferred fulfilment type.
Select a Specific Store — GET /stores/{storeId}
Return locations available, sort by distance to the user's current location and filter by preferred fulfilment type.
Browse Menu Options — GET /stores/{storeId}/menus
Review the categories and options within the menu along with their pricing, images, description, metadata, etc.
Create a Basket and Choose a Fulfilment Type — POST /baskets
Specify the fulfilment type of Delivery/Dispatch, Pickup, Eat-in or Curbside; this establishes the fulfilment type and starts the order.
Add Items and Other Details to Get Updated Order Amount — PATCH /baskets/{basketId}/items
Update the basket as the user selects items, and with similar methods update user data /customer, apply loyalty or coupons /discounts, include tips /payment, and other order fees via /charges.
Capture Payment — Pay API
Proceed to process payment via Deliverect's Pay API (optional).
Complete the Order — POST v2/checkouts
Finalise the transaction and specify which payment method was used, along with the unique order identifier and any order notes, to trigger POS order injection.
Commerce Workflow
See below for a complete workflow diagram;