Integration steps
-
Register your POS
Section titled “Register your POS”You create the account in the portal and receive a
partner_name. See account registration. -
Add the two mandatory contacts
Section titled “Add the two mandatory contacts”Without them you cannot perform operations in the system. See account registration.
-
Create an API key
Section titled “Create an API key”It is the value you send on the
Authorizationheader and, at the same time, the key that protects your own endpoints. See API keys. -
Define your endpoints
Section titled “Define your endpoints”At least one of type order notification. You can test them from the portal before saving. See endpoints.
-
Implement order reception
Section titled “Implement order reception”Your endpoint accepts a
POSTwith JSON, validates theAuthorizationheader and replies200. See receiving orders. -
Implement menu updates
Section titled “Implement menu updates”Build the menu payload and send it. Validate it first, so format errors do not eat into your daily quota. See full menu update.
-
Allocate a test store and test end to end
Section titled “Allocate a test store and test end to end”Point the test store at your webhook, place real orders on it and check what you received. See test store.
-
Verify your results in the trace
Section titled “Verify your results in the trace”Look your test orders up by code and confirm that what we sent matches what you processed. See order lookup.
-
Add the real brands and locations
Section titled “Add the real brands and locations”Every location must be activated by our team before it receives orders. See brands and locations.
-
Release the test store
Section titled “Release the test store”There are only so many of them, and the allocation expires in two weeks anyway. See test store.
Before you request a live store
Section titled “Before you request a live store”- Your order endpoint replies
200and does not process the same order twice (unique index onorder_code). - The menu passes validation with no errors.
- You have tested orders where the customer asks for cutlery, has allergies and adds paid attributes.
- You have tested a marketplace order, where you receive customer details and the address.
- You have decided whether to enable delivery retry.