Become an integration partner
Sign up to start developing your commerce integration.
Build a 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 (optional). Use the Get Locations endpoint to retrieve all locations for your customer account.
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 the 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.
Available endpoints
The following endpoints are available for the Store API.
Endpoint | Type | Method | Purpose |
Account | GET | Retrieved the accounts linked to the partner account | |
Account | GET | Retrieve the locations of an account | |
Store | GET | Retrieve the products inside an account | |
Store | GET | Store Menus | |
Basket creation | POST | Create a basket | |
Basket update | PATCH | Update Discount information | |
Basket update | PATCH | Update fulfillment type/ details | |
Basket update | PATCH | Update items in the basket (add, delete items) | |
Basket update | PATCH | Update tip amount | |
Basket checkout | POST | Creates a checkout session from a basket, leading to a payment intent based on the provided gateway | |
Basket checkout | GET | Returns a checkout session by ID | |
Upsell | POST | Fetch a list of relevant upsell recommendations |
Basic workflow diagram
