Domino's Pizza API
This is a node.js API for integrating with the Domino's pizza APIs. See the pretty Domino's Pizza API documentation
PAYMENT-SUPPORTED-MODULE This module will pass payment information directly from the customer to Domino's Pizza for Domino's Pizza to process.
npm dominos info : See npm trends and stats for dominos
Special thanks to : @madelinecameron, a major contributor to this repo.
This work is licenced via the DBAD Public Licence. It is a derivative work from Dominos API.
Dominos pizza api
Install thenpm i dominos
or npm i --save dominos
Contributing
- Pull or Fork code.
- from the cloned directory run
npm install
(this will install required dependancies, depending on your system may require) - be awesome!
Examples
You can run the domino's pizza command line interface from your terminal just by running npm start
! See the example in the examples directory.
See the examples directory for simple apps and demonstrations on using the basic functionality.
Testing
Simply run npm test
if you have issues with this you may want to try installing mocha globally like this : npm install -g mocha
-OR for manual testing-
- Install mocha
npm install -g mocha
- Run the tests
mocha
For Canada
Set the urls.json file to be:
{
"referer":"https://order.dominos.ca/en/pages/order/",
"sourceUri":"order.dominos.ca",
"store": {
"find": "https://order.dominos.ca/power/store-locator?s=${line1}&c=${line2}&type=${type}",
"info": "https://order.dominos.ca/power/store/${storeID}/profile",
"menu": "https://order.dominos.ca/power/store/${storeID}/menu?lang=${lang}&structured=true"
},
"order": {
"validate": "https://order.dominos.ca/power/validate-order",
"price": "https://order.dominos.ca/power/price-order",
"place": "https://order.dominos.ca/power/place-order"
},
"track": "https://trkweb.dominos.ca/orderstorage/GetTrackerData?"
}
Finding Stores
argument | type | default | required |
---|---|---|---|
address | full or partial address string | null | true |
type | Delivery, Carryout, all | all | true |
callback | function to pass the api result to | null | true |
Note: the 'address' parameter is passed to the Address class. This means any formatting that works for Address will work being passed here. This means you can pass JSON, array or string.
By Postal Code
this yields the least accurate information
var pizzapi = ; pizzapiUtil;
By City and Postal Code
this yields less accurate information but is better than just using the postal code
var pizzapi = ; pizzapiUtil;
Using Full or Nearly Full Address
this yields the best information and sorts stores by actual distance
var pizzapi = ; pizzapiUtil;
Store
argument | type | default | required |
---|---|---|---|
ID | Integer | null | true |
//Get Store Info for Store #4336 var pizzapi = ; var myStore = ; myStoreID=4336; myStore;
Store menu
argument | type | default | required |
---|---|---|---|
callback | function | null | true |
//Get Menu for Store #4336 var pizzapi = ; var myStore = ; myStoreID = 4336; myStore;
Store info
argument | type | default | required |
---|---|---|---|
callback | function | null | true |
//Get Info for Store #4336 var pizzapi = ; var myStore = ; myStoreID = 4336; myStore;
Friendly menu list
argument | type | default | required |
---|---|---|---|
callback | function | null | true |
Returns a list of all items the store offers in an JSON array, formatted {Code: Friendly Name}
//Get friendly name menu for Store #4336 var pizzapi = ; var myStore = ; myStoreID = 4336; myStore;
Address
When creating a new Address object, there are many ways to instantiate the object!
The following are examples of the methods:
From string note the commas
var fullAddress = '900 Clark Ave, St. Louis, MO, 63102'; //or var partAddress = 'St. Louis, MO, 63102'; //or var stateAndZip = 'St. Louis, 63102'; //or var cityAndZip = 'St. Louis, 63102'; //only zip var onlyZip = '63102';
From JSON
var jsonAddress = Street: '900 Clark Ave' City: 'St. Louis' Region: 'MO' PostalCode: 63102 ;
From array
var arrayAddress = '900 Clark Ave' 'St. Louis' 'MO' '63102';
Customer
argument | type | default |
---|---|---|
address | Address | null |
firstName | String | '' |
lastName | String | '' |
String | '' | |
phone | String | '' |
var customer = address: someAddressObj firstName: 'Barack' lastName: 'Obama' phone: '1-800-The-White-House' email: 'br'
Item
You can get the codes from one of the menu requests.
argument | type | default |
---|---|---|
code | String | null |
quantity | Integer | 1 |
options | Array | [] |
var newItem = code: '14SCREEN' ; //and so on...
Order
This is the class that every other class feeds into.
argument | type | default |
---|---|---|
code | String | null |
quantity | Integer | 1 |
options | Array | [] |
creating an order
var pizzapi = ; var thePresident = firstName: 'Barack' lastName: 'Obama' address: '700 Pennsylvania Avenue, Washington, DC' email: 'barack@whitehouse.gov' ; var order = customer: thePresident //optional set the store ID right away storeID: myStoreID deliveryMethod: 'Delivery' //(or 'Carryout') ; //or var order = ; orderFirstName = data; orderLastName = data; orderEmail = data; orderPhone = data; //and if you want to update the store id just : orderStoreID = myStoreID;
duplicating an order
var anotherIdenticalOrder = order:order //or //Order:order //because domino's pizza web API returns pascal case... ; //or create a duplicate order WITH different customer params var order = customer: thePresident deliveryMethod: 'Delivery' //(or 'Carryout') ;
Adding a product to the order :
order;
Validating an Order
This step is Strongly recommended
order;
Price an Order
order;
Place an Order
At least one item must've been added to place an order.
with payment allowed
You don't have to do anything for the payment, Domino's Pizza will handle all transactions.
var pizzapi = ; var cardNumber = '4100123422343234'; var cardInfo = ; cardInfoAmount = orderAmountsCustomer; cardInfoNumber = cardNumber; cardInfoCardType = order; cardInfoExpiration = '0115';// 01/15 just the numbers "01/15".replace(/\D/g,''); cardInfoSecurityCode = '777'; cardInfoPostalCode = '90210'; // Billing Zipcode orderPayments; order;
Tracking
By Phone
argument | type | default | required |
---|---|---|---|
phone | Phone number string or int | null | true |
callback | function to pass the api result to | null | true |
var pizzapi = ; pizzapiTrack;
By orderKey
argument | type | default | required |
---|---|---|---|
orderKey | string or int | null | true |
storeID | sting or int | null | true |
callback | function to pass the api result to | null | true |
var pizzapi = ; pizzapiTrack;
Code, Order, Eat, Be Happy!