For AI agents: visit https://docs.vrio.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Vrio API
HomeGuidesRecipesAPI Reference
v1.0

Vrio API
Guides
v1.0HomeGuidesRecipesAPI Reference

Getting Started

  • Quick Start Guide
    • Placing Orders
      • Placing Orders in the UI
      • Placing Orders via API
      • Placing Orders with Hosted Checkout
  • What is Vrio
  • Vrio Launch Checklist
  • Testing and Troubleshooting
    • Placing a Test Order
    • Transaction Validation and Errors
    • Shipment Validation and Errors
  • Architecture and Compliance
  • Data Hierarchy

Organization

  • User Access
    • Adding a User
    • Login Assistance
    • User Group

Campaigns & Settings

  • Campaign Overview
    • Creating a Campaign
    • Items & Offers
    • Processing Settings
    • Auto Capture Triggers
    • Fulfillment Settings
    • Custom Branding and URLs
      • Use Custom URL
    • Responder Settings
    • Checkout Settings
      • Direct Pay URL
      • Via Cart API
    • Post-back Pixels
  • Third Party Platforms
    • Shopify
      • Adding a Store
      • Syncing with Shopify
      • Subscriptions on Shopify
    • Woo Commerce
      • Adding the plugin
  • Settings
    • Shipping Logic
    • Fulfillment Routers
    • Customer Communication
      • Custom Responders
      • Stock Responders
      • Activating a Responder
      • Responder Triggers
      • Partial Responders
      • Merge Tags
    • Tax Profile
    • Returns Logic
    • Reason Codes
      • Cancellation Reasons

Items, Offers & Pricing

  • Item - Physical or Digital
    • Creating an Item
    • Adding an Item to a Campaign
    • Item Variants
    • Pricing Overrides
  • Offers
    • Offer Types
    • Offer Configurations
      • Create Custom Offers
      • Create Shared Offers
    • Offer Cycles
    • Billing Timing and Scheduling
      • Creating Custom Timeframes
    • Pricing Logic
      • Setting Custom Offer Pricing
      • Setting Shared Offer Pricing
      • Quantity Discount Setup
    • Responder System & Email Automation
    • Shipping & Fulfillment Configuration
      • Prepaid Offers
    • Customer Management & Controls
      • Gift Offers
      • Frequency Editing
      • Offer Expiration
      • Offer Swapping
      • Skipping Renewels and Shipments
      • Offer Pausing
    • Business Growth Tools & Optimization
      • Upsell Offers
      • Return Profiles
    • Offer Glossary
  • Common Selling Strategies
    • Subscriptions
    • Prepaid
    • Gifting
  • Promotions & Discounts
    • Discount Codes
    • Shipping Discounts
    • Quantity Discounts
    • Promotional Profiles
    • Gift Cards

Payments

  • Payments Overview
    • Single Merchant Setup
    • Using the Payment Router
      • Create/Edit a Payment Router
      • Activating a Payment Router
      • Auto Deactivation
      • Initial Decline Reattempts
      • Item Based Routing
      • Max Attempts
      • Merchant Groups
      • Priorities and Cap
      • Payment Router Logic
      • FAQ
      • Troubleshooting
    • API Overrides
  • Adding a Merchant Account
  • Dunning Profiles
  • Supported Payment Gateways
    • Authorize.net
    • Adyen
      • Apple Pay / Google Pay
    • Bill1st
    • Braintree
    • Cash
    • CCBill
    • Checkout.com
    • ConnectX
    • Cybersource
    • Everypay
    • Finix
    • Flexfactor
    • Fluid Pay
    • PayNetworx
    • NMI
      • Apple Pay / Google Pay
    • PayPal
      • PayPal
    • Qoin
    • Paysafe
    • Revolv3
    • Sezzle
    • SurePay
    • Stripe
      • Apple Pay / Google Pay
      • Afterpay / Klarna
      • Payment Tokens
      • Stripe Bank Transfer
      • Radar
    • Test
    • USA ePay
  • Advanced
    • BIN Routing
    • Currency
    • Payment Restriction Rules
    • Disputes - Alert Handling
    • Hard Declines
  • Payment APIs
    • Upsells
      • Multiple Order Upsell Processing
      • Single Order Upsell Processing
      • Upsell Reporting
    • Auth & Capture
    • Tracking Variables
    • Handling 101 Response Codes
    • Creating Leads
    • Third Party 3DS Providers
    • Duplicate Prevention

Manage Orders

  • Vrio Customer Records and Statuses
    • Searching for a Customer
    • Orders
    • Sales
    • Transactions
    • Shipments
    • Deleting Test Orders
  • Record Modifications
    • Update Payment Method
    • Update Shipping Address
    • Blacklist a Customer
    • Cancel a Subscription
    • Reactivate a Subscription
    • Change Quantity
    • Process a Scheduled Transaction
    • Refund or Void a Charge
    • Store Credit
    • Reprocessing Declines
    • Apply a Dispute: Alert or Chargeback
    • Shipment Modifications
      • Cancel a Shipment
      • Skip & Unskip a Shipment
      • Reschedule a Shipment
      • Reship an Item
      • Swap Shipment Item
      • RMA & Returns
      • Change Shipment Address
      • Add/Edit Tracking
      • Post to Fulfillment
      • Re-Post to Fulfillment
      • Edit Shipment Items
      • Fetch Tracking Number
      • Mark as Delivered
      • Mark as Error
    • UI Bulk Actions
      • Cancel Subscriptions
      • Reactivate Subscriptions
      • Deleting Orders
      • Moving Orders to Another Customer
      • Merging Customers
      • Deleting Customers
      • Reschedule Transactions
      • Change Merchant
      • Reprocess Sales
    • Bulk Update Import
      • Update Merchants
      • Update Campaigns
      • Update Offers
      • Update Items
      • Update Transactions
      • Update Shipments
  • Customer APIs
    • Subscription Management

Connections

  • What is a Connection?
  • Adding a New Connection
  • Fulfillment Integrations
    • Shipstation
    • Fulfillment.com
    • The Fulfillment Lab
    • ReadyCloud
  • Tax Connections
    • Avalara
      • AvaTax Setup
      • AvaTax CRM Configuration
  • Dunning Connections
    • FlexFactor
  • Fraud Connections
    • Kount360
  • Customer Communication
    • Klaviyo
    • SMTP Server
    • Media Brand Consulting
  • Chargeback Representment
    • Midigator
  • Customer Service
    • Gorgias
      • Gorgias Setup
      • Gorgias Capabilities
  • Other
    • Card Insight
    • Webhooks overview
      • Transaction Webhooks
      • Order Webhooks
      • Shipment Webhooks
      • Order Offer Webhooks

Data & Analytics

  • Getting Started
    • Report Builder Quick Guide
    • Saving Custom Reports
    • Creating Alerts & Notifications
    • Creating Scheduled Reports
    • Rulesets
    • Creating Dashboard Metrics
    • User Permissions - Analytics Only
  • Build Custom Dashboards
  • Custom Reporting Fields
    • Categories
    • Offer Mapping
    • Calculating Fees
  • Why are some reports delayed?
  • Reports Overview
    • Average Order Value (AOV) Report
    • Profit & Loss - Cash Basis Report
    • Transactions Report
    • New Sales Report
    • Cancellations Report
    • Order Modifications Report
    • Abandons Report
    • Net Subscriptions Report
    • Active Subscriptions Report
    • Subscriptions LTV Report
    • Customer Lifetime Value (CLV) Report
    • Sales LTV Report
    • First Renewal Report
    • 6 Cycle Retention Report
    • 36 Cycle Retention Report
    • Retention Snapshot Report
    • Dunning Report
    • Disputes by Dispute Date Report
    • Disputes by Charge Date Report
    • Revenue Forecasting Report
    • Inventory Forecasting Report
    • Gateway Report
    • Merchant Capacity Report
    • Router Capacity Report
    • Shipments by Scheduled Date Report
    • Shipments by Shipped Date Report
    • Prepaid Shipments Report
    • Responders Report
    • API Requests Report
Powered by 

Mark as Delivered

Manually mark a shipped item as delivered and record the delivery date.

    • Prerequisites
    • How to Mark as Delivered
      • Step 1: Navigate to the Shipment
      • Step 2: Open the Deliver Form
      • Step 3: Complete the Deliver Form
    • What Happens After Submitting
    • Other Ways to Mark as Delivered
    • FAQ