0min
Get Order by ID

GET
Retrieves a single order by ID.
PATH PARAMETERS
order_idinteger*
HEADER PARAMETERS
X-Violet-Tokenstring
X-Violet-App-Secretstring
X-Violet-App-Idinteger
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
OrderCustomer
The Customer Placing the Order
bags
Bag[]
Bags in the Order
shipping_address
OrderAddress
The shipping or billing address of a user placing an order
billing_address
OrderAddress
The shipping or billing address of a user placing an order
payment_method
OrderPaymentMethod
Payment 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 21 Oct 2022
Did this page help you?
Yes
UP NEXT
Get Webhook Event Body
Docs powered by archbee