0min
Set Billing Address
POST
PATH PARAMETERS
cart_idinteger*
QUERY PARAMETERS
price_cartboolean
HEADER PARAMETERS
X-Violet-Tokenstring
X-Violet-App-Secretstring
X-Violet-App-Idinteger
BODY PARAMETERS
body
OrderAddressThe shipping or billing address of a user placing an order
namestring
Name on Address
citystring
City
statestring
State Abbreviation
countrystring
Country ISO2 Code
postal_codestring
Postal/Zip Code
phonestring
Phone Number
typestring<shipping | billing>
Address Type
address_1string
First line of the Address
address_2string
Second line of the Address
RESPONSES
200
successful operation
Order
Order
idinteger<int64>
tokenstring
seller_idinteger<int64>
ID of the Seller
user_idinteger<int64>
ID of the User placing the order
app_idinteger<int64>
ID of the App creating the order
customer
OrderCustomerThe Customer Placing the Order
bags
Bag[]Bags in the Order
shipping_address
OrderAddressThe shipping or billing address of a user placing an order
billing_address
OrderAddressThe shipping or billing address of a user placing an order
payment_method
OrderPaymentMethodPayment Method belonging to an Order
sub_totalinteger<int32>
Subtotal of the Order
shipping_totalinteger<int32>
Shipping Total of the Order
tax_totalinteger<int32>
Tax Total of the Order
totalinteger<int32>
Total of the Order
app_customer_idstring
App Customer ID
app_order_idstring
App Order ID
statusstring<in_progress | processing | completed | canceled | partially_refunded | refunded>
Status of the Order
date_createdstring<date-time>
Date of order creation
date_last_modifiedstring<date-time>
Date of last order update
guestboolean
Is the customer a guest or an authed user.
referral_idstring
Optional value used to represent an identifier in your system. Max length of 128 characters.
Updated 22 Aug 2022
Did this page help you?
Yes
No
Updated 22 Aug 2022
Did this page help you?
Yes
No