Orders
Get Order by ID
Overview
Login
- Access
Merchants
- Merchant
- Configuration
- Onboarding
- Explore
Catalog
- Offers
- SKUs
- Categories
- Collections
- Currencies
Orders & Checkout
- Carts
- Cart Items
- Cart Customer
- Cart Discounts
- Cart Shipping
- Cart Pricing
- Cart Payment
- Cart Completion
- Orders
- Order Refunds
- Order Cancellations
- Transfers
Payments
- Payout Accounts
- Distributions
- Transfers
Events
- Webhooks
- Webhook Events
- Wekbhook Headers
Apps
- Merchant/App Installs
- Commission Rates
Operations
- Connection
Relay
- Shipping
Ecom Syncs
- Offers
Orders
Get Order by ID
GET
/
orders
/
{order_id}
curl --request GET \
--url https://sandbox-api.violet.io/v1/orders/{order_id}
{
"id": 123,
"token": "<string>",
"errors": [
{
"id": 123,
"order_id": 123,
"bag_id": 123,
"entity_id": "<string>",
"entity_type": "ORDER",
"type": "EXTERNAL_CREATE_CART",
"message": "<string>",
"date_created": "2023-11-07T05:31:56Z",
"platform": "OTHER"
}
],
"user_id": 123,
"app_id": 123,
"developer_id": 123,
"customer": {
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"shipping_address": {
"name": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"type": "SHIPPING",
"email": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"billing_address": {
"name": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"type": "SHIPPING",
"email": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"same_address": false,
"name": "<string>"
},
"bags": [
{
"id": 123,
"order_id": 123,
"merchant_id": 123,
"app_id": 123,
"external_id": "<string>",
"external_reference_id": "<string>",
"status": "IN_PROGRESS",
"fulfillment_status": "PROCESSING",
"financial_status": "UNPAID",
"dispute_status": "UNDISPUTED",
"skus": [
{
"id": 123,
"offer_id": 123,
"merchant_id": 123,
"app_id": 123,
"product_id": "<string>",
"sku_id": 123,
"external_id": "<string>",
"name": "<string>",
"brand": "<string>",
"thumbnail": "<string>",
"quantity": 123,
"price": 123,
"weight": 123,
"height": 123,
"width": 123,
"length": 123,
"available": true,
"status": "IN_PROGRESS",
"product_type": "PHYSICAL",
"custom": true,
"custom_properties": [
{
"name": "engraving",
"value": "Happy Birthday!"
}
],
"quantity_fulfilled": 123,
"rates": [
{
"order_sku_id": 123,
"amount": 123,
"rate": 123,
"type": "TAX",
"name": "<string>",
"decimal_rate": 123,
"dollar_amount": 123
}
],
"line_price": 123
}
],
"shipping_method": {
"type": "CALCULATED",
"Carrier": "OTHER",
"label": "<string>",
"price": 123,
"custom": true,
"min_subtotal": 123,
"max_subtotal": 123,
"min_weight": 123,
"max_weight": 123,
"external_id": "<string>",
"id": 123,
"shipping_method_id": "<string>",
"bag_id": 123,
"merchant_id": 123,
"tracking_number": "<string>"
},
"taxes": [
{
"order_id": 123,
"merchant_id": 123,
"skus": [
"<string>"
],
"state": "<string>",
"postal_code": "<string>",
"rate": 123,
"amount": 123,
"description": "<string>"
}
],
"sub_total": 123,
"shipping_total": 123,
"tax_total": 123,
"discount_total": 123,
"total": 123,
"taxes_included": false,
"external_checkout": true,
"commission_rate": 123,
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"date_last_consolidated": "2023-11-07T05:31:56Z",
"date_submitted": "2023-11-07T05:31:56Z",
"remorse_period_ends": "2023-11-07T05:31:56Z",
"currency": "<string>",
"external_currency": "<string>",
"currency_exchange_rate": 123,
"channel": "APP",
"app_order_id": "<string>",
"platform": "OTHER",
"fulfillments": [
{
"id": 123,
"bag_id": 123,
"external_id": "<string>",
"carrier": "OTHER",
"raw_carrier": "<string>",
"status": "PENDING",
"carrier_status": "PENDING",
"tracking_number": "<string>",
"tracking_url": "<string>",
"skus": [
{
"id": 123,
"fulfillment_id": 123,
"order_sku_id": 123,
"quantity_fulfilled": 123
}
]
}
],
"discounts": [
{
"id": 123,
"bag_id": 123,
"status": "PENDING",
"type": "CODE",
"value_type": "AMOUNT",
"target_type": "ORDER",
"code": "<string>",
"external_id": "<string>",
"amount": 123,
"percentage": 123,
"amount_total": 123,
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"email": "<string>"
}
],
"wallet_based_checkout": false,
"app_name": "<string>",
"bag_id": 123,
"bag_status": "IN_PROGRESS",
"merchant_name": "<string>"
}
],
"shipping_address": {
"name": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"type": "SHIPPING",
"email": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"billing_address": {
"name": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"type": "SHIPPING",
"email": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"payment_method": {
"brand": "<string>",
"last_four": "<string>",
"exp_month": 123,
"exp_year": 123,
"cardholder_name": "<string>",
"payment_method_id": 123,
"default": true
},
"sub_total": 0,
"shipping_total": 0,
"tax_total": 0,
"discount_total": 0,
"total": 0,
"app_customer_id": "<string>",
"app_order_id": "<string>",
"status": "IN_PROGRESS",
"is_guest": true,
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"date_submitted": "2023-11-07T05:31:56Z",
"priced": false,
"wallet_based_checkout": false,
"currency": "USD",
"referral_id": "<string>",
"currency_symbol": "<string>",
"app_name": "<string>",
"stripe_key": "<string>",
"payment_intent_client_secret": "<string>",
"payment_transactions": [
{
"id": 123,
"order_id": 123,
"payment_provider": "<string>",
"payment_provider_transaction_id": "<string>",
"payment_method_id": 123,
"payment_provider_payment_method_id": "<string>",
"payment_intent_client_secret": "<string>",
"amount": 123,
"currency": "<string>",
"capture_status": "PROCESSING",
"capture_method": "AUTOMATIC",
"transfer_status": "SENT",
"transfer_method": "AUTOMATIC",
"metadata": {},
"related_bags": [
"<string>"
],
"related_refunds": [
"<string>"
],
"errors": [
{
"id": 123,
"error_code": 123,
"error_message": "<string>",
"resolved": true,
"date_resolved": "2023-11-07T05:31:56Z",
"date_created": "2023-11-07T05:31:56Z",
"payment_transaction_id": 123
}
],
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"status": "PROCESSING"
}
],
"order_id": 123,
"guest": true,
"order_status": "IN_PROGRESS",
"intent_based_checkout": true
}
Retrieve the details for an Order
given its order_id
.
Path Parameters
Response
default - application/json
default response
Violet Order Entity
Was this page helpful?
curl --request GET \
--url https://sandbox-api.violet.io/v1/orders/{order_id}
{
"id": 123,
"token": "<string>",
"errors": [
{
"id": 123,
"order_id": 123,
"bag_id": 123,
"entity_id": "<string>",
"entity_type": "ORDER",
"type": "EXTERNAL_CREATE_CART",
"message": "<string>",
"date_created": "2023-11-07T05:31:56Z",
"platform": "OTHER"
}
],
"user_id": 123,
"app_id": 123,
"developer_id": 123,
"customer": {
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"shipping_address": {
"name": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"type": "SHIPPING",
"email": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"billing_address": {
"name": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"type": "SHIPPING",
"email": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"same_address": false,
"name": "<string>"
},
"bags": [
{
"id": 123,
"order_id": 123,
"merchant_id": 123,
"app_id": 123,
"external_id": "<string>",
"external_reference_id": "<string>",
"status": "IN_PROGRESS",
"fulfillment_status": "PROCESSING",
"financial_status": "UNPAID",
"dispute_status": "UNDISPUTED",
"skus": [
{
"id": 123,
"offer_id": 123,
"merchant_id": 123,
"app_id": 123,
"product_id": "<string>",
"sku_id": 123,
"external_id": "<string>",
"name": "<string>",
"brand": "<string>",
"thumbnail": "<string>",
"quantity": 123,
"price": 123,
"weight": 123,
"height": 123,
"width": 123,
"length": 123,
"available": true,
"status": "IN_PROGRESS",
"product_type": "PHYSICAL",
"custom": true,
"custom_properties": [
{
"name": "engraving",
"value": "Happy Birthday!"
}
],
"quantity_fulfilled": 123,
"rates": [
{
"order_sku_id": 123,
"amount": 123,
"rate": 123,
"type": "TAX",
"name": "<string>",
"decimal_rate": 123,
"dollar_amount": 123
}
],
"line_price": 123
}
],
"shipping_method": {
"type": "CALCULATED",
"Carrier": "OTHER",
"label": "<string>",
"price": 123,
"custom": true,
"min_subtotal": 123,
"max_subtotal": 123,
"min_weight": 123,
"max_weight": 123,
"external_id": "<string>",
"id": 123,
"shipping_method_id": "<string>",
"bag_id": 123,
"merchant_id": 123,
"tracking_number": "<string>"
},
"taxes": [
{
"order_id": 123,
"merchant_id": 123,
"skus": [
"<string>"
],
"state": "<string>",
"postal_code": "<string>",
"rate": 123,
"amount": 123,
"description": "<string>"
}
],
"sub_total": 123,
"shipping_total": 123,
"tax_total": 123,
"discount_total": 123,
"total": 123,
"taxes_included": false,
"external_checkout": true,
"commission_rate": 123,
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"date_last_consolidated": "2023-11-07T05:31:56Z",
"date_submitted": "2023-11-07T05:31:56Z",
"remorse_period_ends": "2023-11-07T05:31:56Z",
"currency": "<string>",
"external_currency": "<string>",
"currency_exchange_rate": 123,
"channel": "APP",
"app_order_id": "<string>",
"platform": "OTHER",
"fulfillments": [
{
"id": 123,
"bag_id": 123,
"external_id": "<string>",
"carrier": "OTHER",
"raw_carrier": "<string>",
"status": "PENDING",
"carrier_status": "PENDING",
"tracking_number": "<string>",
"tracking_url": "<string>",
"skus": [
{
"id": 123,
"fulfillment_id": 123,
"order_sku_id": 123,
"quantity_fulfilled": 123
}
]
}
],
"discounts": [
{
"id": 123,
"bag_id": 123,
"status": "PENDING",
"type": "CODE",
"value_type": "AMOUNT",
"target_type": "ORDER",
"code": "<string>",
"external_id": "<string>",
"amount": 123,
"percentage": 123,
"amount_total": 123,
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"email": "<string>"
}
],
"wallet_based_checkout": false,
"app_name": "<string>",
"bag_id": 123,
"bag_status": "IN_PROGRESS",
"merchant_name": "<string>"
}
],
"shipping_address": {
"name": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"type": "SHIPPING",
"email": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"billing_address": {
"name": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"type": "SHIPPING",
"email": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"payment_method": {
"brand": "<string>",
"last_four": "<string>",
"exp_month": 123,
"exp_year": 123,
"cardholder_name": "<string>",
"payment_method_id": 123,
"default": true
},
"sub_total": 0,
"shipping_total": 0,
"tax_total": 0,
"discount_total": 0,
"total": 0,
"app_customer_id": "<string>",
"app_order_id": "<string>",
"status": "IN_PROGRESS",
"is_guest": true,
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"date_submitted": "2023-11-07T05:31:56Z",
"priced": false,
"wallet_based_checkout": false,
"currency": "USD",
"referral_id": "<string>",
"currency_symbol": "<string>",
"app_name": "<string>",
"stripe_key": "<string>",
"payment_intent_client_secret": "<string>",
"payment_transactions": [
{
"id": 123,
"order_id": 123,
"payment_provider": "<string>",
"payment_provider_transaction_id": "<string>",
"payment_method_id": 123,
"payment_provider_payment_method_id": "<string>",
"payment_intent_client_secret": "<string>",
"amount": 123,
"currency": "<string>",
"capture_status": "PROCESSING",
"capture_method": "AUTOMATIC",
"transfer_status": "SENT",
"transfer_method": "AUTOMATIC",
"metadata": {},
"related_bags": [
"<string>"
],
"related_refunds": [
"<string>"
],
"errors": [
{
"id": 123,
"error_code": 123,
"error_message": "<string>",
"resolved": true,
"date_resolved": "2023-11-07T05:31:56Z",
"date_created": "2023-11-07T05:31:56Z",
"payment_transaction_id": 123
}
],
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"status": "PROCESSING"
}
],
"order_id": 123,
"guest": true,
"order_status": "IN_PROGRESS",
"intent_based_checkout": true
}