General
Do I need an agreement before starting?
Not for the sandbox. At launch we create partner accounts ourselves; then self-registration opens in the developer dashboard, and the sandbox works right away. Before going live you accept the partner terms in the dashboard and pass certification.
Is the API free?
Free during the beta, with usage limits from day one: requests per minute and events per day. Pricing will be announced later. The limits are in Errors and limits.
Will you build a custom integration for my system?
No. We publish one API for every system, and you connect to it yourself.
Can I call the API from a mobile app or a browser?
No. The secret must stay on your server. Have your app talk to your server, and your server talk to us.
Linking
Can I link a merchant without their consent?
No. Every link starts with a code the merchant enters themselves, after seeing the scopes.
The merchant has ten branches. Do they need ten codes?
Yes, one code per branch, because each branch has its own menu and orders. Accounting systems are the exception: one merchant-level link covers every branch.
What happens if the merchant removes the link?
You receive link.removed. New orders stop and your menu leaves the place page. Open orders can still be finished for 24 hours.
Menus
Do I send the full menu on every change?
No. Send it in full the first time and for big changes. For a small change use a patch, and for sold out and temporary prices use availability.
Do you change my item ids?
No. We keep your ids as they are and give them back in orders.
The menu showed an old price. Why?
Most likely an old state arrived after a newer one and we ignored it. Make sure as_of is the real time of the change in your system. Then compare hashes from menu/hashes.
Orders and money
Who charges the customer?
AurMap. It charges the card, or records cash at pickup, and pays the merchant.
Who refunds the customer on cancellation?
AurMap, always. The refund is in full, unless the customer did not come and the merchant declared a partial amount. Your system never refunds anything for AurMap orders.
The customer never came to pick up. What happens?
The merchant decides within 24 hours of the order being ready. The default is a full refund to the customer. For a partial refund, the merchant declares the amount and the reason through merchant_refund. Details in Orders.
Can the customer cancel after the kitchen started?
No. After acceptance only the merchant cancels.
My server was down for ten minutes. Are the orders lost?
No. We retry events, and you can read waiting orders and the events log. But the accept window keeps running, so check waiting orders as soon as you are back.
Is there delivery?
At launch, pickup only. Delivery is coming soon.
Why is the customer’s number masked?
To protect their personal data. The full number arrives only if the merchant granted you customer:contact. Do not use it for marketing unless marketing_opt_in is true.
Security
My secret leaked. What do I do?
Revoke the key in the developer dashboard at once, then create a new one. Revocation takes effect immediately.
How do I know an event came from you?
Verify the signature with your webhook secret, and reject any message older than 5 minutes. Details in Events.