Blizzfull API documentation

Manage orders, menus, items, and restaurants with the Blizzfull Online Ordering API.

Base URL: https://apiv2.blizzfull.com
Auth: Two API-key headers
Spec: OpenAPI 3.0.2
Calls: 13

Browse the reference Download the spec (JSON)

Thirteen calls, four groups.

Every call answers in JSON. Open one to see its parameters and what comes back.

Authenticate. Send X-Blizzfull-API-User and X-Blizzfull-API-Token with every request.
Start with recent orders. Call /orders/getRecent for the last 12 hours of orders.
Then poll. Call /orders/poll with the latest timestamp to get only what came in since.

$ curl -G \
    https://apiv2.blizzfull.com/orders/getRecent \
    -d restaurantID=1042 -d locationID=1 \
    -H "X-Blizzfull-API-User: $API_USER" \
    -H "X-Blizzfull-API-Token: $API_TOKEN"

200 OK
{
  "order": {
    "restaurantID": "1042",
    "confirmationCode": 4817,
    "type": "pickup",
    "subTotalPrice": 38.50,
    "tax": 3.66,
    "tip": 6.00,
    "totalPaid": 48.16,
    "accepted": false,
    …
  }
}

Example request and response for step two. Send your own API user and token.

Orders 6 calls

Read, list, poll and accept orders.

GET/orders/{orderId}Get full order details for a Blizzfull order
RequestGET https://apiv2.blizzfull.com/orders/{orderId}
Parameters
Name In Type Description
orderIdrequired path integer Numeric ID of the order to get
posToMap query string String name of POS to map from
Responses
- 200application/json · { order: Order }
Headers: X-Blizzfull-API-User, X-Blizzfull-API-Token
GET/orders/{orderId}/getWithRestaurantGet full order details for a Blizzfull order and include the restaurant information as well. Useful for rendering receipts that may require restaurant information on every call
RequestGET https://apiv2.blizzfull.com/orders/{orderId}/getWithRestaurant
Parameters
Name In Type Description
orderIdrequired path integer Numeric ID of the order to get
Responses
- 200application/json · { order: Order, restaurant: Restaurant }
Headers: X-Blizzfull-API-User, X-Blizzfull-API-Token
POST/orders/{orderId}/acceptAccept/Confirm an order with Blizzfull with an ETA. Informs the customer with the ETA and may dispatch a courier if the order type is a delivery with a courier enabled for that zone.
RequestPOST https://apiv2.blizzfull.com/orders/{orderId}/accept
Parameters
Name In Type Description
orderIdrequired path integer Numeric ID of the order to get
Request bodyrequired
application/x-www-form-urlencoded · object · eta should be ISO 8601 string in UTC
Request body fields for POST /orders/{orderId}/accept
Field Type
eta string
Responses
- 200application/json · { order: Order }
Headers: X-Blizzfull-API-User, X-Blizzfull-API-Token

Name	In	Type	Description
`orderId`required	path	integer	Numeric ID of the order to get
`posToMap`	query	string	String name of POS to map from

Name	In	Type	Description
`orderId`required	path	integer	Numeric ID of the order to get

Name	In	Type	Description
`orderId`required	path	integer	Numeric ID of the order to get

Request body fields for POST /orders/{orderId}/accept
Field	Type
`eta`	string

GET/orders/pollPoll orders for a restaurant using a timestamp. Any order submitted after the timestamp will be returned.

RequestGET https://apiv2.blizzfull.com/orders/poll

Parameters

Name	In	Type	Description
`restaurantID`	query	integer	Numeric ID of the restaurant to poll orders from. If your API user is scoped to a specific restaurant, you do not need to provide this value
`orderList`	query	integer	orderList corresponds to the poll type. Returns an order list with complete order objects. Input a standard unix timestamp to poll orders submitted after the supplied timestamp
`orderListLazy`	query	integer	orderListLazy corresponds to the poll type. Returns an order list with lazy (basic) order objects. Input a standard unix timestamp to poll orders submitted after the supplied timestamp
`posToMap`	query	string	String name of POS to map from

Responses

200application/json · { order: Order }

Headers: X-Blizzfull-API-User, X-Blizzfull-API-Token

GET/orders/getRecentReturns orders submitted within the last 12 hours. Usually you will make this call to start, then use /poll using the latest timestamp

RequestGET https://apiv2.blizzfull.com/orders/getRecent

Parameters

Name	In	Type	Description
`restaurantID`required	query	integer	Numeric ID of the restaurant to poll orders from
`locationID`required	query	integer	Numeric ID of the restaurant’s location (for multi-location restaurants). Should almost always be 1

Responses

200application/json · { order: Order }

Headers: X-Blizzfull-API-User, X-Blizzfull-API-Token

GET/orders/getListGet all orders based on query parameters

RequestGET https://apiv2.blizzfull.com/orders/getList

Parameters

Name	In	Type	Description
`restaurantID`	query	integer	Only supply orders based for the specific restaurant. If this query parameter is excluded, the server will provide all orders across every restaurant assigned to your partnership account
`locationID`	query	integer	Numeric ID of the restaurant’s location (for multi-location restaurants). Should almost always be 1
`limit`	query	integerdefault 100 or 500	Number of orders returned in the call. Defaults to 100 when a restaurant ID is provided. 500 otherwise
`offset`	query	integerdefault 0	(Paired with 'limit' parameter). Returns the orders after the specified offset
`dateFilter`required	query	string	Comma delimited date constraint, comprised of a start and an end. Multiple time formats are supported but ISO 8601 is preferred.

Responses

200application/json · { order: Order, restaurant: Restaurant }

Headers: X-Blizzfull-API-User, X-Blizzfull-API-Token

Items 2 calls

Read the menu as the guest sees it.

GET/items/getFullMenuGet the full menu for the restaurant, including categories, items and options/modifiers
RequestGET https://apiv2.blizzfull.com/items/getFullMenu
Parameters
Name In Type Description
restaurantIDrequired query integer Restaurant to pull menu from
locationIDrequired query integer Location ID to pull menu from. Always just use "1"
Responses
- 200application/json · object
Headers: X-Blizzfull-API-User, X-Blizzfull-API-Token
GET/items/getListGet simple menu item list for restaurant
RequestGET https://apiv2.blizzfull.com/items/getList
Parameters
Name In Type Description
restaurantIDrequired query integer Restaurant to pull menu from
locationIDrequired query integer Location ID to pull menu from. Always just use "1"
Responses
- 200application/json · object
Headers: X-Blizzfull-API-User, X-Blizzfull-API-Token

Name	In	Type	Description
`restaurantID`required	query	integer	Restaurant to pull menu from
`locationID`required	query	integer	Location ID to pull menu from. Always just use "1"

Name	In	Type	Description
`restaurantID`required	query	integer	Restaurant to pull menu from
`locationID`required	query	integer	Location ID to pull menu from. Always just use "1"

Menu 3 calls

Import a menu, or clear one.

POST/menu/importImport your menu, as JSON, into Blizzfull
RequestPOST https://apiv2.blizzfull.com/menu/import
Parameters
Name In Type Description
restaurantIDrequired query integer Restaurant to import menu into
locationIDrequired query integer Location ID to import menu into. Always just use "1"
Request bodyrequired
application/json · Menu · JSON menu
Responses
- 200application/json · object
Headers: X-Blizzfull-API-User, X-Blizzfull-API-Token

Name	In	Type	Description
`restaurantID`required	query	integer	Restaurant to import menu into
`locationID`required	query	integer	Location ID to import menu into. Always just use "1"

POST/menu/importExternalPOSMenu/{posName}Import your point-of-sale menu, as JSON, into Blizzfull for mapping

RequestPOST https://apiv2.blizzfull.com/menu/importExternalPOSMenu/{posName}

Parameters

Name	In	Type	Description
`posName`required	path	string	String name of the POS integration
`restaurantID`required	query	integer	Restaurant to import menu into
`locationID`required	query	integer	Location ID to import menu into. Always just use "1"

Request bodyrequired

application/json · Menu · JSON menu

Responses

200application/json · object

Headers: X-Blizzfull-API-User, X-Blizzfull-API-Token

POST/menu/deleteDelete the whole menu - Removes all categories, items & optionsRemoves data
RequestPOST https://apiv2.blizzfull.com/menu/delete
Parameters
Name In Type Description
restaurantIDrequired query integer Restaurant to delete menu from
locationIDrequired query integer Location ID to delete menu from. Always just use "1"
Responses
- 200application/json · object
Headers: X-Blizzfull-API-User, X-Blizzfull-API-Token

Name	In	Type	Description
`restaurantID`required	query	integer	Restaurant to delete menu from
`locationID`required	query	integer	Location ID to delete menu from. Always just use "1"

Restaurants 2 calls

Read or create a restaurant.

GET/restaurants/{restaurantID}Get full restaurant data object
RequestGET https://apiv2.blizzfull.com/restaurants/{restaurantID}
Parameters
Name In Type Description
restaurantIDrequired path integer Numeric ID of the restaurant to get
Responses
- 200application/json · { order: Restaurant }
Headers: X-Blizzfull-API-User, X-Blizzfull-API-Token
POST/restaurants/createCreate restaurant object
RequestPOST https://apiv2.blizzfull.com/restaurants/create
No parameters.
Request bodyrequired
application/json · blizzfullRestaurantSchema (external)
Responses
- 200application/json · object
Headers: X-Blizzfull-API-User, X-Blizzfull-API-Token

Name	In	Type	Description
`restaurantID`required	path	integer	Numeric ID of the restaurant to get

MenuPublished by the API
https://apiv2.blizzfull.com/schema/blizzfullMenuSchema.json

Order67 fields

Order fields
Field	Type
`itemLastModified`	integer
`userItemCost`	number (float)
`items`	array of OrderItem
`restaurantID`	string
`locationID`	string
`time`	string
`status`	string
`locked`	boolean
`shared`	boolean
`specialInstructions`	string
`type`	string
`tip`	number (float)
`delayedTime`	integer
`delivery`	Delivery
`phone`	string
`estimatedReadyTime`	integer
`phoneExt`	string
`totalPaid`	number (float)
`lastModified`	integer
`readyTimeInputValue`	integer
`confirmationCode`	integer
`subTotalPrice`	number (float)
`taxExemptAmount`	number (float)
`taxExemptItemDiscounts`	number (float)
`subTotalPaid`	number (float)
`totalUsedDiscounts`	number (float)
`totalUsedItemDiscounts`	number (float)
`totalAppliedItemDiscounts`	number (float)
`lastChargedAmountTip`	string
`lastChargedAmountDelivery`	string
`lastChargedAmountDiscounts`	string
`taxRate`	number (float)
`receiptPrinted`	boolean
`reviewAcceptedBy`	number
`deliveryCharge`	number (float)
`taxOnDelivery`	boolean
`tax`	number (float)
`expectedTotal`	number (float)
`balanceOwed`	number (float)
`subTotalPriceWithItemDiscounts`	number (float)
`accepted`	boolean
`curbside`	boolean
`contactFree`	boolean
`menuVersion`	string
`testMode`	boolean
`shareNickname`	string
`groupOrderEnds`	integer
`processingVia`	string
`anonymousName`	string
`shareMessage`	string
`coupons`	array of Coupon
`couponVersion`	string
`shareType`	string
`hasSingleOfferRestriction`	boolean
`hasSpecialDeal`	boolean
`hasAlcohol`	boolean
`faxFees`	number (float)
`readyForSubmission`	string
`primaryFaxID`	string
`maxAmount`	integer
`lockedUntil`	string
`lazy`	boolean
`users`	object
`multiUser`	boolean
`leader`	string
`id`	string
`transactions`	array of Transaction

OrderItem27 fields

OrderItem fields
Field	Type
`itemID`	integer
`orderItemID`	integer
`summary`	object
`mask`	object
`adjustedMask`	object
`externalOptionMapMask`	object
`quantity`	integer
`sizeID`	string
`category`	string
`name`	string
`specialInstructions`	string
`price`	number (float)
`paidAmount`	string
`modified`	integer
`userID`	string
`paidForByUserID`	string
`discounts`	number (float)
`singleOfferRestriction`	boolean
`comboID`	string
`externalID`	string
`externalSizeID`	string
`points`	integer
`loyaltyItemID`	integer
`pointsPaid`	string
`taxExempt`	boolean
`stockTracking`	boolean
`paid`	boolean

Coupon34 fields

Coupon fields
Field	Type
`couponID`	string
`name`	string
`description`	string
`discount`	string
`discountType`	string
`conditions`	object
`expires`	string
`appliesTo`	string
`appliesToIDs`	array of string
`code`	string
`causedAddOf`	string
`userID`	string
`stackable`	boolean
`appliedToOrderItemIDs`	array of string
`includedSizes`	array of string
`amountUsed`	string
`realizedDiscountValue`	number (float)
`maxUses`	string
`orderCouponID`	integer
`autoApplied`	integer
`used`	boolean
`shareable`	boolean
`applicable`	boolean
`applicableByOrderItemID`	string
`dynamic`	boolean
`reusable`	string
`lockedUntil`	integer
`appliesToMany`	boolean
`points`	integer
`loyaltyItemLink`	string
`usePerCustomer`	string
`version`	string
`active`	string
`owner`	array of string

Transaction33 fields

Transaction fields
Field	Type
`transactionID`	string
`value`	string
`tax`	string
`tip`	string
`cashTip`	string
`delivery`	string
`discounts`	string
`userID`	string
`name`	string
`action`	string
`items`	string
`ip`	string
`paymentDigits`	string
`paymentType`	string
`extraCCData`	string
`externalTransactionID`	string
`transactionTime`	string
`status`	string
`deliveryCourierTip`	string
`deliveryCourierServiceFee`	string
`processor`	string
`fixedGatewayFees`	string
`details`	string
`detailsOn`	string
`externalPaymentMethod`	string
`refundAmount`	string
`refundedTransactionID`	string
`settled`	string
`pointsEarned`	string
`fraudPoints`	string
`fraudChecks`	string
`postSubmissionModeUserInterface`	string
`actionable`	boolean

Delivery24 fields

Delivery fields
Field	Type
`geoLocation`	GeoLocation
`distance`	string
`street`	string
`street2`	string
`city`	string
`state`	string
`zip`	string
`addressID`	string
`driverID`	string
`deliveryCharge`	number (float)
`deliveryChargePaid`	boolean
`taxOnDelivery`	boolean
`validLocations`	array of string
`courierQuoteID`	string
`courierQuote`	number (float)
`courierDeliveryID`	string
`courierID`	integer
`courierStatus`	string
`courierDriverName`	string
`courierTracking`	string
`courierPhotoURL`	string
`pickupETA`	string
`courierFailure`	string
`signatureImage`	string

Restaurant6 fields
Restaurant fields
Field Type
restaurantID string
name string
streetAddress string
city string
state string
zip string
RestaurantCreationPublished by the API
https://apiv2.blizzfull.com/schema/blizzfullRestaurantSchema.json
GeoLocation4 fields
GeoLocation fields
Field Type
latitude number (float)
longitude number (float)
entityType string
isAddress boolean