Overview

Become an Integration Partner

Become a partner to gain access to our APIs. You can then begin developing your Commerce integration.


Build a Commerce Integration

Below are the general steps to integrating our Commerce API

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 Locations (optional) — Get Locations

Retrieve all locations for your customer account.

4

Get Stores — Get Stores

Retrieve the channelLinkId for a customer account.

5

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

Retrieve menus for a given store.

6

Create Basket — Create Basket

Create a basket to begin building the order.

7

Update Basket (optional)

Update the basket as needed using the following endpoints:

8

Request Payment (optional) — Request Payment

Only applies for DPAY (Deliverect Pay) payment type.

9

Checkout — Basket Checkout

Proceed to checkout and specify the payment method.

10

Checkout Status Webhook — Basket Checkout Status Webhook

Monitor the status of the checkout.


Available endpoints

See all the endpoints available in the Commerce API via link below Checkout

Commerce Order Flow Diagram


Did this page help you?