Get Orders
Retrieve the details for all Orders that have been placed through your app_id.
Query parameters
pageinteger · int32OptionalDefault:
1sizeinteger · int32OptionalDefault:
20date_last_modified:minstringOptional
Query only the orders that have been modified after the given date time, using the standard Violet datetime format, ISO 8601. Example: 2017-06-15T01:01:01+0000
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Body
stringOptionalExample:
2017-06-25T01:01:01+0000Responses
default
default response
application/json
get
GET /v1/orders HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 26
"2017-06-25T01:01:01+0000"default
default response
{
"content": [
{
"id": 1,
"errors": [
{
"id": 1,
"order_id": 1,
"bag_id": 1,
"entity_id": "text",
"entity_type": "ORDER",
"type": "EXTERNAL_CREATE_CART",
"message": "text",
"date_created": "2025-07-10T04:46:25.629Z",
"platform": "OTHER"
}
],
"app_id": 1,
"developer_id": 1,
"customer": {
"first_name": "text",
"last_name": "text",
"email": "text",
"shipping_address": {
"name": "text",
"city": "text",
"state": "text",
"country": "text",
"postal_code": "text",
"phone": "text",
"type": "SHIPPING",
"email": "text",
"address_1": "text",
"address_2": "text",
"first_name": "text",
"last_name": "text"
},
"billing_address": {
"name": "text",
"city": "text",
"state": "text",
"country": "text",
"postal_code": "text",
"phone": "text",
"type": "SHIPPING",
"email": "text",
"address_1": "text",
"address_2": "text",
"first_name": "text",
"last_name": "text"
},
"same_address": false,
"name": "text"
},
"bags": [
{
"id": 1,
"order_id": 1,
"merchant_id": 1,
"app_id": 1,
"external_id": "text",
"external_reference_id": "text",
"status": "IN_PROGRESS",
"fulfillment_status": "PROCESSING",
"financial_status": "UNPAID",
"dispute_status": "UNDISPUTED",
"skus": [
{
"id": 1,
"offer_id": 1,
"merchant_id": 1,
"app_id": 1,
"sku_id": 1,
"external_id": "text",
"name": "text",
"brand": "text",
"thumbnail": "text",
"quantity": 1,
"price": 1,
"weight": 1,
"height": 1,
"width": 1,
"length": 1,
"available": true,
"status": "IN_PROGRESS",
"product_type": "PHYSICAL",
"custom": true,
"custom_properties": [
{
"name": "engraving",
"value": "Happy Birthday!"
}
],
"quantity_fulfilled": 1,
"rates": [
{
"order_sku_id": 1,
"amount": 1,
"rate": 1,
"type": "TAX",
"name": "text",
"decimal_rate": 1,
"dollar_amount": 1
}
],
"line_price": 1
}
],
"shipping_method": {
"type": "CALCULATED",
"Carrier": "OTHER",
"label": "text",
"price": 1,
"custom": true,
"min_subtotal": 1,
"max_subtotal": 1,
"min_weight": 1,
"max_weight": 1,
"external_id": "text",
"id": 1,
"shipping_method_id": "text",
"bag_id": 1,
"merchant_id": 1
},
"taxes": [
{
"order_id": 1,
"merchant_id": 1,
"skus": [
"text"
],
"state": "text",
"postal_code": "text",
"rate": 1,
"amount": 1,
"description": "text"
}
],
"sub_total": 1,
"shipping_total": 1,
"tax_total": 1,
"discount_total": 1,
"total": 1,
"taxes_included": false,
"external_checkout": true,
"commission_rate": 1,
"date_created": "2025-07-10T04:46:25.629Z",
"date_last_modified": "2025-07-10T04:46:25.629Z",
"date_last_consolidated": "2025-07-10T04:46:25.629Z",
"date_submitted": "2025-07-10T04:46:25.629Z",
"remorse_period_ends": "2025-07-10T04:46:25.629Z",
"currency": "text",
"external_currency": "text",
"currency_exchange_rate": 1,
"channel": "APP",
"app_order_id": "text",
"platform": "OTHER",
"fulfillments": [
{
"id": 1,
"bag_id": 1,
"external_id": "text",
"carrier": "OTHER",
"raw_carrier": "text",
"status": "PENDING",
"carrier_status": "PENDING",
"tracking_number": "text",
"tracking_url": "text",
"skus": [
{
"id": 1,
"fulfillment_id": 1,
"order_sku_id": 1,
"quantity_fulfilled": 1
}
]
}
],
"discounts": [
{
"id": 1,
"bag_id": 1,
"status": "PENDING",
"type": "CODE",
"value_type": "AMOUNT",
"target_type": "ORDER",
"code": "text",
"external_id": "text",
"amount": 1,
"percentage": 1,
"amount_total": 1,
"date_created": "2025-07-10T04:46:25.629Z",
"date_last_modified": "2025-07-10T04:46:25.629Z",
"email": "text"
}
],
"wallet_based_checkout": false,
"app_name": "text",
"bag_id": 1,
"bag_status": "IN_PROGRESS",
"merchant_name": "text"
}
],
"shipping_address": {
"name": "text",
"city": "text",
"state": "text",
"country": "text",
"postal_code": "text",
"phone": "text",
"type": "SHIPPING",
"email": "text",
"address_1": "text",
"address_2": "text",
"first_name": "text",
"last_name": "text"
},
"billing_address": {
"name": "text",
"city": "text",
"state": "text",
"country": "text",
"postal_code": "text",
"phone": "text",
"type": "SHIPPING",
"email": "text",
"address_1": "text",
"address_2": "text",
"first_name": "text",
"last_name": "text"
},
"payment_method": {
"brand": "text",
"last_four": "text",
"exp_month": 1,
"exp_year": 1,
"cardholder_name": "text",
"payment_method_id": 1,
"default": true
},
"sub_total": 0,
"shipping_total": 0,
"tax_total": 0,
"discount_total": 0,
"total": 0,
"app_customer_id": "text",
"app_order_id": "text",
"status": "IN_PROGRESS",
"is_guest": true,
"date_created": "2025-07-10T04:46:25.629Z",
"date_last_modified": "2025-07-10T04:46:25.629Z",
"date_submitted": "2025-07-10T04:46:25.629Z",
"priced": false,
"wallet_based_checkout": false,
"currency": "USD",
"referral_id": "text",
"currency_symbol": "text",
"app_name": "text",
"stripe_key": "text",
"payment_intent_client_secret": "text",
"payment_transactions": [
{
"id": 1,
"order_id": 1,
"payment_provider": "text",
"payment_provider_transaction_id": "text",
"payment_method_id": 1,
"payment_provider_payment_method_id": "text",
"payment_intent_client_secret": "text",
"amount": 1,
"currency": "text",
"capture_status": "PROCESSING",
"capture_method": "AUTOMATIC",
"transfer_status": "SENT",
"transfer_method": "AUTOMATIC",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"related_bags": [
"text"
],
"related_refunds": [
"text"
],
"errors": [
{
"id": 1,
"error_code": 1,
"error_message": "text",
"resolved": true,
"date_resolved": "2025-07-10T04:46:25.629Z",
"date_created": "2025-07-10T04:46:25.629Z",
"payment_transaction_id": 1
}
],
"date_created": "2025-07-10T04:46:25.629Z",
"date_last_modified": "2025-07-10T04:46:25.629Z",
"status": "PROCESSING"
}
],
"order_id": 1,
"guest": true,
"order_status": "IN_PROGRESS",
"intent_based_checkout": true
}
],
"last": true,
"total_pages": 1,
"total_elements": 1,
"first": true,
"number_of_elements": 1,
"size": 1,
"number": 1,
"empty": true,
"next_page_cursor": "text",
"pageable": {
"page_number": 1,
"page_size": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"offset": 1,
"paged": true,
"unpaged": true
},
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
}
}Last updated
Was this helpful?