OAuth | Integrate a venue | Use SSIO/WIO/Brand auth to integrate a venue. | |
Order API | Integrator is able to listen to webhook notifications: CREATED, PRODUCTION, READY, DELIVERED and take appropriate action | Place a purchase in your test storefront, and go through the full flow by: React to “CREATED” Get the order details in Accept the order Make sure to use the right endpoint based on delivery providerMake sure to check if it’s an instant or pre-order“PRODUCTION” notification is sent as confirmation Mark the order ‘Ready’ “READY” notification is sent as confirmationTakeaway only: Mark order ‘Delivered’ “DELIVERED” notification is sent as confirmation | We expect at least 3 purchase IDs here:Wolt delivery, instant order Wolt delivery, pre-order Takeaway instant order
If you have partners using self-delivery, repeat the scenarios:Self-delivery, instant order Self-delivery, pre-order |
| Integrator is able to listen to CANCELED and take appropriate action | Take appropriate action to inform the venue that the order has been canceled and does not need preparation anymore. | |
Optional Webhook notifications | React to:Courier arrival notification Courier picked up order Customer Reviews | Courier arrival notification: Use this as a trigger to push the order to the venue’s kitchen screens. This ensures that the order is done just in time for the courier’s arrival. Courier Picked up order: Use this as trigger to remove the order from your screens Customer Reviews: Get real time customer reviews and comments to your venue’s screen or dashboards | |
| Reject an order | Use it when an order cannot be fulfilled (missing items or other reasons). Always provide a reason for rejections. An order can be rejected via API only during the “CREATED” stage. | |
| Basket Discount | Create an order value discount via Merchant Admin > Campaigns and check the payload. The basket discount is spread proportionally over items. | |
| Item Discount | Create Item Promo discounts via Merchant Admin > Campaigns and check the payload. The item discount is applied only on the target items and their options. | |
| Basket & Item Discount | Ask your Wolt TAM to create stackable promotions! | |
| Free Delivery | Create an Free Delivery via Merchant Admin > Campaigns and check the payload | |
Venue API | Set Store Online / Offline | Set venue offline until [specify time]Set venue back online | |
| Get Store Status | Retrieve venue status | |
| Set new Opening Hours | Update venue opening hours to [specify time] | |
| Set special opening hours | Update special opening hours for [specify day, time] | |
| OptionalRetrieve current delivery provider | Returns the currently defined delivery provider for a venue on the Wolt marketplace. | |
| OptionalChange Delivery provider | Changes delivery provider between Self delivery and Wolt | |
Menu API | Create menu | a) Post a full 'menu' - assortment to the venue.b) Make a change to the 'menu' assortment by adding new items.c) Check if changes are successfully reflected in the consumer storefront | Please provide a timestamp of when the operation was executed |
Menu API | OptionalGet Menu | Retrieve menu information | Please provide a timestamp of when the operation was executed |
Item API | Update menu items.price | Update the price of selected items. Verify the result in the storefront | Please provide a timestamp of when the operation was executed |
| Update menu items.discounted.price | Set a discounted price to selected items. Verify the result in the storefront | Please provide a timestamp of when the operation was executed |
| Update menu items.enabled | Disable a selected item by setting "enabled" to false | Please provide an item name |
| Update menu items.in.stock | Disable a selected item by setting "in_stock" to false | Please provide an item name |
Options API | Update menu options | Update price or visibility of an option | |