Get Order by ID
2min
GET
AUTHENTICATION
Authorization
string
Bearer
PATH PARAMETERS
order_id
integer
*HEADER PARAMETERS
X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer
RESPONSES
200
successful operation
Order
Order
id
integer<int64>
token
string
user_id
integer<int64>
ID of the User placing the order
app_id
integer<int32>
ID of the App creating the order
developer_id
integer<int32>
ID of the Developer who placed
customer
OrderCustomer
Customer placing the order
bags
Bag[]
Bags in the Order
shipping_address
OrderAddress
Shipping Address of the Order
billing_address
OrderAddress
Billing Address of the Order
payment_method
OrderPaymentMethod
Payment Method of the Order
sub_total
integer<int32>
Subtotal of the Order
shipping_total
integer<int32>
Shipping Total of the Order
tax_total
integer<int32>
Tax Total of the Order
discount_total
integer<int32>
Discount Total of the Order
total
integer<int32>
Total of the Order
app_customer_id
string
App Customer ID
app_order_id
string
App Order ID
status
string<in_progress | processing | completed | canceled | partially_refunded | refunded | requires_action>
*Status of the Order
is_guest
boolean
Order is Guest
date_created
string<date-time>
Date of order creation
date_last_modified
string<date-time>
Date of last order update
priced
boolean
Is the cart priced
wallet_based_checkout
boolean
Is this cart going to be placed through wallet-based checkout
currency
string
Base currency of cart
referral_id
string
Optional value used to represent an identifier in your system.
errors
OrderError[]
Errors on the Order
currency_symbol
string
Symbol representing the desired currency
app_name
string
Name of app that originated the order.
stripe_key
string
Stripe publishable key. Use for tokenizing payment methods.
payment_intent_client_secret
string
Payment intent client secret
orderStatus
string<IN_PROGRESS | PROCESSING | COMPLETED | CANCELED | PARTIALLY_REFUNDED | REFUNDED | REQUIRES_ACTION>
orderId
integer<int64>
intentBasedCheckout
boolean
guest
boolean
Updated 16 May 2023
Did this page help you?
Yes
No