Uptrend Systems
Opal API
Getting Started
- Purpose / Audience
- Evolution
- Let's Get Technical
- Some Recommended Order Flows
- v2 Changelog
- v1 Changelog
v2 Endpoints
Accounts
account.pvp -
Customer Account Status
glogin.pvp -
Guest Login
temp_password.pvp -
Generate Temporary Password
reset_password.pvp -
Reset Password
login.pvp -
Login
get_profiles.pvp -
Get Profiles Associated with Customer
del_profile.pvp -
Delete a Profile
Account Creation
get_types.pvp -
Get a list of Dwelling Types
vprofile.pvp -
Validate a Profile and assign to order
vuser.pvp -
Validate a New Profile and assign to order
del_cc.pvp -
Delete a saved tokenized credit card from customer profile
Location Data Lookup
_street.pxp -
Address autocomplete
postal_lookup.pvp -
Look Up Streets by Postal Code
city_lookup.pvp -
Look Up City by Address
getcities.pvp -
Get Cities with a Store
getcities_prov.pvp -
Get Cities with a Store (sorted by province)
getstores_city.pvp -
Get Stores Within a City
getstores_prov.pvp -
Get Stores Within a Province
getstores_gc.pvp -
Get All Stores Ordered Geographically
getstore.pvp -
Get a Single Store's Data
Order Details
method.pvp -
Set Pickup/Delivery
now_or_later.pvp -
Set Pickup/Delivery Time
Menu Endpoints
get_groups.pvp -
Get Menu Groups/Categories
group.pvp -
Get Menu Items in a Group/Category
menu_all.pvp -
Get All Menu Items
productlist.pvp -
Get Product List
toppings.pvp -
Obtain a List of Pizza Toppings
Cart Management
cart.pvp -
Get Configuration Details for a Product
vcart.pvp -
Submit a Product to the Cart
get_items.pvp -
Obtain an Item(s) from the cart for editing
remove_item.pvp -
Remove an Item from the Cart
add_qty.pvp -
Increment the quantity of an item in the cart
dec_qty.pvp -
Decrement the quantity of an item in the cart
clear_cart.pvp -
Clear all items from the cart
upsize.pvp -
Upsize an item in the cart
runningtotal.pvp -
Get the running total of the customer's cart
lastord.pvp -
Get the last order placed by the customer
coupon.pvp -
Evaluate a coupon code
viewcart.pvp -
Get the contents of the customer's cart
Checkout
paytypes.pvp -
Get Available Payment Methods
vc_checkout.pvp -
Evaluate order and payment types
genord.pvp -
Generate the order
v1 Endpoints
Accounts
login.pvp -
Login
Uptrend Systems
Opal API Documentation
Loading API documentation...