Overview

Become an integration partner

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

Follow these steps to start using the commerce API:

Step 1. Call the Get Access Token endpoint to retrieve a token granting you access to our endpoints.

Step 2. Retrieve the customer accounts linked to your partner account with the Get Linked Accounts endpoint

Step 3. Use the Get Locations endpoint to retrieve all locations for your customer account (optional)

Step 4. Use the Get Stores endpoint to retrieve storeIds a customer account

Step 5. Use the Get store Menus endpoint to retrieve menus for a given store

Step 6. Use the Create basket endpoint to create a basket

Update basket (optional):

Step 7. Optional Request payment. Only Applies for DPAY (Deliverect pay) payment type .

Step 8. Use the Basket Checkout endpoint to proceed to the checkout and specify the payment method

Step 9. Use the Basket Checkout status webhook to monitor the status of the checkout.

The following endpoints are available for the Store API.

Endpoint	Type	Method	Purpose
GET Accounts	Account	GET	Retrieved the accounts linked to the partner account
Get Locations	Account	GET	Retrieve the locations of an account
GET Stores	Store	GET	Retrieve the products inside an account
GET Store Menus	Store	GET	Store Menus
Create Basket	Basket creation	POST	Create a basket
Update Discounts	Basket update	PATCH	Update Discount information.
Update Fulfillment	Basket update	PATCH	Update fulfillment type/ details
Update Items	Basket update	PATCH	Update items on the basket (add, delete items).
Update tips	Basket update	PATCH	Update tip amount
Basket Checkout	Basket checkout	POST	Creates a checkout session from a basket, leading to a payment intent based on the provided gateway.
GET Basket Checkout	Basket checkout	GET	Returns a checkout session by ID
GET Upsell suggestions	Upsell	POST	Fetch a list of relevant upsell recommendations