Overview

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;

1

Get an Access Token — Get Access Token

Retrieve a token granting you access to our endpoints.

2

Retrieve Linked Customer Accounts — Get Linked Accounts

Retrieve the customer accounts linked to your partner account.

3

Get Stores — Get Stores

Retrieve the channelLinkId for a customer account.

4

Get Store Menu(s) — Get Store Menu(s)

Retrieve menus for a given store.

5

Create Basket — Create Basket

Create a basket to begin building the order.

6

Update Basket (optional)

Update the basket as needed using the following endpoints:

7

Request Payment (optional) — Request Payment

Only applies for DPAY (Deliverect Pay) payment type.

8

Checkout — Basket Checkout

Proceed to checkout and specify the payment method.

9

Checkout Status Webhook — Basket Checkout Status Webhook

Monitor the status of the checkout.