If you are running on the Legacy API Version and are looking to update that integration please read along carefully.

In this article we will outline:

Top components that have changed
Vrio API Endpoints matched to the Legacy Endpoints

Legacy API Version
If you are running on the Legacy API Version and wish to remain on the Legacy API while utilizing the Vrio Frontend - click here.

Vrio UI Enhancements

Configuration

The largest configuration enhancement when upgrading to Vrio is the ability to use Dynamic Offers. A Dynamic Offer allows you to build your offer, or billing schedule, and attach multiple Items to a single Offer.

This eliminates the need to create a new Offer for ever new Item.

Reusing the already created offer:

Pricing to charge the customer will pull from the Item price
You may override that and set unique pricing on the Item/Offer combination within a Campaign

Learn more about pricing overrides here.

Customer Handling View

Vrio takes feedback and uses that feedback to improve customer experience. We have updated the Customer page based on that feedback to streamline the ability to manage a customer.

Main goals:

Combine all orders into a single view
Breakdown of Subscriptions, what is upcoming & all previous transactions in one view
Easy to see Actions

Learn more about Customer Handling here.

Navigation

The menu bar has now moved to the top to show a full view of what is most used:

Dashboards
Analytics
Search
Merchants
Campaigns
Offers
Items
Settings

Under Settings is where you will find all other configuration and functionality components.

Vrio API

Access

The Vrio API is the most up to date version of the API to be used.

To gain access to the Vrio API, an API user will need to be created within your instance.

User Type	Definition	Access
Vrio API	This is the newest version API user. This user type will have access to the Vrio API. An API Key will be generated when the user is created.	This user will not be able to login to the User Interface with this User Type.
Legacy API	This user type should only be used if your account or integration was setup prior to September 2023. This is a legacy version API user. User ID and User Password will be used.	This user will not be able to login to the User Interface with this User Type.

User Type

Definition

Access

Vrio API

This is the newest version API user. This user type will have access to the Vrio API.

An API Key will be generated when the user is created.

This user will not be able to login to the User Interface with this User Type.

Legacy API

This user type should only be used if your account or integration was setup prior to September 2023. This is a legacy version API user.

User ID and User Password will be used.

This user will not be able to login to the User Interface with this User Type.

API Endpoint Updates

CRM Configuration

	LEGACY API ENDPOINT		VRIO API ENDPOINT
CAMPAIGNS
POST	/campaign/index	GET	/campaigns
GET	/campaign/view/{}campaign_id}	GET	/campaigns/{}id}
POST	/campaign/items/{}campaign_id}	GET	/campaigns/{}id}/items
POST	/campaign/doAdd
GET	/campaign/view_item/{}campaign_item_id}	GET	/campaigns/{}id}/items/{}campaign_item_id}
POST	/campaign/calculate_item_price	POST	/campaigns/{}id}/calculate_price
POST	/campaign/item_categories/{}campaign_id}	GET	/campaigns/{}id}/item_categories
POST	/campaign/item_filters/{}campaign_id}	GET	/campaigns/{}id}/item_filters
POST	/campaign/pages/{}campaign_id}	GET	/campaigns/{}id}/pages
GET	/campaign/view_page_slug/{}campaign_page_slug}	GET	/campaigns/{}id}/pages
GET	/campaign/view_menu_identifier/{}campaign_menu_identifier}	GET	/campaigns/{}id}/menus
POST	/campaign/reviews/{}campaign_id}	GET	/campaigns/{}id}/reviews
MERCHANTS
POST	/merchant/index	GET	/merchants
GET	/merchant/view/{}merchant_id}	GET	/merchants/{}id}
POST	/merchant/doAdd
ROUTES
POST	/route/index	GET	/routes
GET	/route/view/{}route_id}	GET	/routes/{}id}
GET	/route/getMerchant	GET	/campaigns/{}id}/route_merchant

CRM Products

	LEGACY API ENDPOINT		VRIO API ENDPOINT
ITEM CATEGORY
POST	/item_category/index	GET	/item_categories
GET	/item_category/view/{}item_category_id}	GET	/item_categories/{}id}
POST	/item_category/doAdd	POST	/item_categories
POST	/item_category/doEdit	PATCH	/item_categories/{}id}
ITEMS
POST	/item/index	GET	/items
GET	/item/view/{}item_id}	GET	/items/{}id}
GET	/item/swap_options/{}item_id}	GET	/items/{}id}/swap_options
POST	/item/doAdd	POST	/items
POST	/item/doEdit	PATCH	/items/{}id}
OFFERS
POST	/offer/index	GET	/offers
POST	/offer/cycles/{}offer_id}	GET	/offers/{}id}/cycles
POST	/offer/timeframes/{}offer_id}	GET	/offers/{}id}/timeframes
POST	/offer/doAdd
POST	/offer/doAddCycle

Selling

	LEGACY API ENDPOINT		VRIO API ENDPOINT
CARTS
POST	/cart/doAdd	POST	/carts
POST	/cart/doEdit	PUT	/carts/{}cart_token}
POST	/cart/doDelete
GET	/cart/token/{}token}
Not available		GET	/carts/{}cart_token}
Not available		GET	/carts/{}cart_token}/preview
Not available		PUT	/carts/{}cart_token}/quantity
DISCOUNT
POST	/discount/index	GET	/discounts
POST	/discount/cycles
GET	/discount/view/{}discount_id}	GET	/discounts/{}id}
GET	/discount/validate_discount/{}offer_id}/{}discount_code}	POST	/discounts/validate
POST	/discount/calculate_discount	POST	/discounts/calculate
POST	/discount/related_discount	POST	/discounts/related
GIFT CARDS
POST	/gift_card/index	GET	/gift_cards
POST	/gift_card/doAdd	POST	/gift_cards
POST	/gift_card/doEdit	PATCH	/gift_cards/{}id}
POST	/gift_card/doDelete	DELETE	/gift_cards/{}id}
GET	/gift_card/get_balance/{}gift_card_code}
GET	/gift_card/validate_balance/{}gift_card_code}/{}gift_card_apply}
POST	/gift_card/doClaim	POST	/gift_cards/claim

Customer Service

	LEGACY API ENDPOINT		VRIO API ENDPOINT	Parameter
CUSTOMER
POST	/customer/index	GET	/customers
GET	/customer/view/{}customer_id}	GET	/customers/{}id}
POST	/customer/doAdd	POST	/customers
POST	/customer/doEdit	PATCH	/customers/{}id}
POST	/customer/doAddAddress	POST	/customers/{}id}/addresses
POST	/customer/doEditAddress	PATCH	/customers/{}id}/addresses/{}address_id}
POST	/customer/doDeleteAddress	DELETE	/customers/{}id}/addresses/{}address_id}
POST	/customer/doAddCustomerAddress	POST	/customers
POST	/customer/doAddCard	POST	/customers/{}id}/cards
POST	/customer/doDeleteCard	DELETE	/customers/{}id}/cards/{}card_id}
GET	/customer/rewards/{}customer_id}	GET	/customers/{}id}/rewards
ORDERS
POST	/order/index	GET	/orders
POST	/order/upsells	GET	/orders/{}id}/upsells
GET	/order/view/{}order_id}	GET	/orders/{}id}
POST	/order/doAdd	POST	/orders
POST	/order/doProcess	POST	/orders/{}id}/process
POST	/order/doProcess3ds	POST	/orders/{}id}/complete
POST	/order/doProcessPaypal	POST	/orders/{}id}/complete
POST	/order/doAddProcess	POST	/orders	action=process
POST	/order/doAddProcessOrder	POST	/orders	action=process
POST	/order/doAuth	POST	/orders/{}id}/authorize
POST	/order/doAddAuth	POST	/orders	action=authorize
POST	/order/doCapture	POST	/orders/{}id}/capture
POST	/order/doEdit	PATCH	/orders/{}id}
POST	/order/doArchive	POST	/orders/{}id}/archive
POST	/order/doUnarchive	POST	/orders/{}id}/unarchive
POST	/order/doNote	POST	/orders/{}id}/notes
ORDER OFFER
POST	/order_offer/index	GET	/order_offers
GET	/order_offer/view/{}order_offer_id}	GET	/order_offers/{}id}
GET	/order_offer/swap_options/{}order_offer_id}	GET	/order_offers/{}id}/swap_options
GET	/order_offer/frequency_options/{}order_offer_id}	GET	/order_offers/{}id}/frequency_options
POST	/order_offer/doAdd	POST	/order_offers
POST	/order_offer/doCancel	POST	/order_offers/{}id}/cancel
POST	/order_offer/doReactivate	POST	/order_offers/{}id}/reactivate
POST	/order_offer/doPause	POST	/order_offers/{}id}/pause
POST	/order_offer/doUnpause	POST	/order_offers/{}id}/unpause
POST	/order_offer/doExpire	POST	/order_offers/{}id}/expire
POST	/order_offer/doEdit	PATCH	/order_offers/{}id}
POST	/order_offer/doEditMap	PUT	/order_offers/{}id}/map
POST	/order_offer/doSwap	POST	/order_offers/{}id}/swap
POST	/order_offer/doChangeFrequency	PUT	/order_offers/{}id}/frequency
POST	/order_offer/doChangeQuantity	PUT	/order_offers/{}id}/quantity
POST	/order_offer/doNote	POST	/order_offers/{}id}/notes
GET	/order_offer/viewGift/{}order_offer_id}	GET	/order_offers/{}id}/gift
POST	/order_offer/doEditGift	PATCH	/order_offers/{}id}/gift
POST	/order_offer/doResendGift	POST	/order_offers/{}id}/resend_gift
TRANSACTION
POST	/transaction/index
POST	/charge/index	GET	/transactions
POST	/order_offer_cycle/index	GET	/line_items
GET	/transaction/view/{}transaction_id}	GET	/transactions/{}id}
POST	/transaction/doProcess	POST	/transactions/{}id}/process
POST	/transaction/doRefund	POST	/transactions/{}id}/refund
POST	/transaction/doChargeback	POST	/transactions/{}id}/chargeback
POST	/transaction/doAlert	POST	/transactions/{}id}/alert
POST	/transaction/doVoid	POST	/transactions/{}id}/void
POST	/transaction/doChangeScheduled	POST	/transactions/{}id}/schedule
POST	/transaction/doSkip	POST	/transactions/{}id}/skip
POST	/transaction/doUnskip	POST	/transactions/{}id}/unskip
POST	/transaction/doReorder
RESPONDERS
POST	/responder/doSend	POST	/responders/{}id}/send
POST	/responder/doAdd
REWARDS PROFILE
POST	/reward_profile/doSendReferral	POST	/reward_profiles/referral
POST	/reward_profile/doClaimReward	POST	/reward_profiles/claim

Fulfillment

	LEGACY API ENDPOINT		VRIO API ENDPOINT
POST	/shipment/index	GET	/shipments
	/shipment/view/{}shipment_id}	GET	/shipments/{}id}
POST	/shipment/doEdit	PATCH	/shipments/{}id}
POST	/shipment/doEditAddress	PUT	/shipments/{}id}/address
POST	/shipment/doTracking	POST	/shipments/{}id}/track
POST	/shipment/doDeliver	POST	/shipments/{}id}/deliver
POST	/shipment/doCancel	POST	/shipments/{}id}/cancel
POST	/shipment/doRMA	POST	/shipments/{}id}/rma
POST	/shipment/doReturn	POST	/shipments/{}id}/return
POST	/shipment/doReship	POST	/shipments/{}id}/reship
POST	/shipment/doSkip	POST	/shipments/{}id}/skip
POST	/shipment/doSwapItem	POST	/shipments/{}id}/swap
POST	/shipment/doChangeScheduled	POST	/shipments/{}id}/schedule
POST	/shipment/doUnskip	POST	/shipments/{}id}/unskip

Users

	LEGACY API ENDPOINT		VRIO API ENDPOINT
GET	/user/view/{}user_id}	GET	/users/{}id}
POST	/user/doAdd	POST	/users

Reports

	LEGACY API ENDPOINT		VRIO API ENDPOINT
POST	/report/filters/{}report_id}	GET	/reports/{}id}/filters
POST	/report/data	GET	/reports/{}id}/data

Legacy API Users

If you were already fully integrated with the Legacy API version prior to Sept 2023 and do not wish to update that integration currently, you can still get the benefits of the updated Vrio UI, while utilizing the Legacy API.

Note that the Legacy API may not have all new features available over the Vrio API. We recommend upgrading to the Vrio API.

Key Points:
User Type = Legacy API
API Docs = {}subdomain}.vrio.app/api_docs
Offers using Dynamic Items require the Item ID to be passed when creating and/or processing an Order. If your current integration does not support passing the item_id, Dynamic Items should not be used.