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