Welcome!
Integrate Wolf and your restaurant’s Point of Sale (POS) system to send Wolf orders straight to the till using our new Restaurant partner API. With it, restaurants can see all their orders in one place, in real time.
How it works
- A customer orders on Wolf website or app
- The restaurant accepts (or rejects) this order from B3 for Business App
- If the order is accepted, you will receive the order from our /orders endpoint with the order details payload
Before we go live
Make sure we’ve done the following:
- Matched Wolf menu item IDs with the POS IDs
- Set up your API credentials (API key)
If this hasn't been done yet, talk to us.
Authentication
Authentication is performed via HTTP Basic Auth. Use your API key as the Basic Auth access token.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail, as will API requests made without any authentication headers.
The content-type header for all requests must be set to application/json.
Our REST API will be served over HTTPS with JSON payloads.
List Menu Items
Returns menu information for a place.
Products
| product_id Strinng Unique id of the product |
| title String Title of the product |
| price String Price of the product |
| categoryname String Category the product is included in |
| currency String The international 3-letter code as defined by the ISO 4217 standard |
| modifiers String { } Modifiers for the current product |
Settings
Settings of the modifier group of this product
| minimumModifiers Number Minimum number of modifiers allowed to be chosen in this modifier group |
| maximumModifiers Number Maximum number of modifiers allowed to be chosen in this modifier group |
| modifierQuantity Number If the modifier group allows multiple choice of the same modifier |
| modifierName String Name of the modifier group |
Modifiers
| title String Name of the current modifier |
| price String Price of the modifier |
| active Number If the modifier is active on the product |
| default Number If the modifier is included as ingredient in the product |
get
https://api.b3.my/v4.0/products/list?access_token=
Example request
get
https://api.b3.my/v4.0/products/list?access_token=ff98e83afd79d17874f8520851584e52fde1f68ee1d8c0d885a8e9cdbdea9db7
Example response
Get orders
Here you’ll find information on our API endpoints which received the Accepted Orders. Once you receive the order, our API will not send it again in your next request.
Data
| id String Unique ID of the order |
|
| created_at String Date and time when the customer placed the order |
|
| processed_at String Date and time when the restaurant accepts the order via the app |
|
| fulfillment_at String Date and time when the restaurant needs to fulfill the order. |
|
| order_type String The way the customer wishes to receive the order. Delivery / Takeaway / Drivethrough |
|
| notes String Allergy notes from the customer |
|
| subtotal_price String Anything before the absolute end sum, such as before the delivery charges or discounts are calculated. |
|
| delivery_cost String Delivery cost of the specific zone. |
|
| surcharge_cost String A payment card surcharge, also known as a checkout fee, is an additional fee a customers accepts to reach the minimum order cost. |
|
| total_price String The amount paid by the customer |
|
| currency String The international 3-letter code as defined by the ISO 4217 standard |
|
| total_discounts String The total discount the customer received either using a coupon code or credits from the wallet. |
|
| payment_method String The way the customer paid the order. Cash or Paid Online Cod / paidonline |
|
| Items The items in the order |
|
| delivery Delivery Address details of the customer |
|
| customer Customer details of the specific order |
items
| product_id String Unique ID of the product |
| pos_item_id String POS ID of the product |
| title String Title of the item |
| quantity String Number of same items ordered by the customer |
| price_per_item String Price of the item |
| total String Total price of the item including the quantity. |
| note String Allergy notes from the customer |
| modifiers List of modifiers of the specific item |
Modifiers
| product_id String Unique ID of the product |
| pos_item_id String POS ID of the product. |
| title String Title of the item |
| quantity String Number of same items ordered by the customer |
| price_per_item String Price of the item |
| total String Total price of the item including the quantity. |
Delivery
| line1 String First line of address info the customer enters at checkout like street name and number |
| line2 String Second line of address info the customer enters at checkout like building number |
| street String Street name of the delivery address |
| number String Street Number of the delivery address |
| area String Area the order needs to be delivered |
| city String The town or city the customer enters at checkout |
| type String Type of property. House or flat |
| floor String Floor the flat is |
| flat_number String Flat number of the delivery |
| court String Building court name |
| postcode String The postcode of the town or city the customer enters at checkout |
| country String The country the customer order is from |
| contact_number String A third party number used to contact customers |
| note String Extra notes added by the customer for the delivery |
Customer
| name String Name of the customer |
| surname String Surname of the customer |
| telephone String Phone number of the customer |
| note String Notes on the customer |
get
https://api.b3.my/v4.0/orders/list?access_token=
Example request
get
https://api.b3.my/v4.0/orders/list?access_token=ff98e83afd79d17874f8520851584e52fde1f68ee1d8c0d885a8e9cdbdea9db7
Example response