Edit an order

patch

https://api.vrio.app/orders/{order_id}

Edit an existing order's information using the unique order ID

Path Params

order_id

integer

required

Body Params

customer_card_id

integer

Change the customer card that will be used for all charges for an order.

string

Email address of the customer. This is what creates a unique customer ID. Note - if using the same email all orders will group to that customer. Only editable until the order is complete.

first_name

string

Customer first name. If not passed, the bill_fname value will be used. Only editable until the order is complete.

last_name

string

Customer last name. If not passed, the bill_lname value will be used. Only editable until the order is complete.

phone

string

Customer telephone number. Only editable until the order is complete.

customers_address_billing_id

integer

Change the customer billing address that will be used for an order.

customers_address_shipping_id

integer

Change the customer shipping address that will be used for an order.

bill_fname

string

Billing first name. Required when customers_address_billing_id is empty and passing any billing information for the order. Only editable until the order is complete.

bill_lname

string

Billing last name. Required when customers_address_billing_id is empty and passing any billing information for the order. Only editable until the order is complete.

bill_address1

string

Billing address line 1. Required when customers_address_billing_id is empty and passing any billing information for the order. Only editable until the order is complete.

bill_address2

string

Billing address line 2. Only editable until the order is complete.

bill_city

string

Billing city. Required when customers_address_billing_id is empty and passing any billing information for the order. Only editable until the order is complete.

bill_country

string

Billing country code 2 letters (example : US). Required when customers_address_billing_id is empty and passing any billing information for the order. Only editable until the order is complete.

bill_organization

string

Billing organization. Only editable until the order is complete.

bill_state

string

Billing state. Required when customers_address_billing_id is empty and bill_county is US or CA and passing any billing information for the order. Only editable until the order is complete.

bill_zipcode

string

Billing zipcode. Required when customers_address_billing_id is empty and passing any billing information for the order. Only editable until the order is complete.

same_address

boolean

Pass as true to use the same address for billing and shipping. Only one of those is required in that case. Only editable until the order is complete.

ship_fname

string

Shipping first name. Required when customers_address_shipping_id is empty and order has shippable items and passing any shipping information for the order. Only editable until the order is complete.

ship_lname

string

Shipping last name. Required when customers_address_shipping_id is empty and order has shippable items and passing any shipping information for the order. Only editable until the order is complete.

ship_address1

string

Shipping address line 1. Required when customers_address_shipping_id is empty and order has shippable items and passing any shipping information for the order. Only editable until the order is complete.

ship_address2

string

Shipping address line 2. Only editable until the order is complete.

ship_city

string

Shipping city. Required when customers_address_shipping_id is empty and order has shippable items and passing any shipping information for the order. Only editable until the order is complete.

ship_country

string

Shipping country code, 2 letters (example : US). Required when customers_address_shipping_id is empty and order has shippable items and passing any shipping information for the order. Only editable until the order is complete.

ship_organization

string

Shipping organization. Only editable until the order is complete.

ship_state

string

Shipping state. Required when customers_address_shipping_id is empty and order has shippable items and ship_country is US or CA and passing any shipping information for the order. Only editable until the order is complete.

ship_zipcode

string

Shipping zipcode. Required when customers_address_shipping_id is empty and order has shippable items and passing any shipping information for the order. Only editable until the order is complete.

discount_code

string

Apply a discount code to the order. Only editable until the order is complete.

shipping_profile_id

integer

Shipping profile to be used to determine shipping logic. Required if shipping profiles are setup on the campaign and there are shippable items on the order and passing any shipping information for the order. Only editable until the order is complete.

order_discount

string

Apply a discount percentage to an order that will be used for all recurring charges.

date_auto_capture

date-time

Auto capture date (2025-08-17 00:00:00) in EST.

create_cart

boolean

Create and associate a cart, if none currently set.

tracking1

string

Custom Tracking Variable Option 1

tracking2

string

Custom Tracking Variable Option 2

tracking3

string

Custom Tracking Variable Option 3

tracking4

string

Custom Tracking Variable Option 4

tracking5

string

Custom Tracking Variable Option 5

tracking6

string

Custom Tracking Variable Option 6

tracking7

string

Custom Tracking Variable Option 7

tracking8

string

Custom Tracking Variable Option 8

tracking9

string

Custom Tracking Variable Option 9

tracking10

string

Custom Tracking Variable Option 10

tracking11

string

Custom Tracking Variable Option 11

tracking12

string

Custom Tracking Variable Option 12

tracking13

string

Custom Tracking Variable Option 13

tracking14

string

Custom Tracking Variable Option 14

tracking15

string

Custom Tracking Variable Option 15

tracking16

string

Custom Tracking Variable Option 16

tracking17

string

Custom Tracking Variable Option 17

tracking18

string

Custom Tracking Variable Option 18

tracking19

string

Custom Tracking Variable Option 19

tracking20

string

Custom Tracking Variable Option 20

is_test

boolean

Flag an order as a Test Order. Orders will always be flagged as test when using a test credit card.

order_notes

string

Apply note to the history of this order.

Responses

200OK

400Error response

401Unauthorized response

403Forbidden response

500Error response