Search Bags
Search for all Bags
placed through your application given certain filter critera.
Query parameters
pageinteger · int32OptionalDefault:
1
sizeinteger · int32OptionalDefault:
20
extendedbooleanOptionalDefault:
false
exclude_in_progressbooleanOptionalDefault:
true
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Body
Bag Search Request
merchant_idinteger · int32Optional
Merchant ID
order_idinteger · int64Optional
Order ID
idinteger · int64Optional
Bag ID
external_idstringOptional
Bag External ID
bag_statusstring · enumOptionalPossible values:
Bag Status
app_order_idstringOptional
Order ID in the Channels System
before_datestring · date-timeOptionalDeprecated
Use date_last_modified:max
.
after_datestring · date-timeOptionalDeprecated
Use date_last_modified:min
.
before_date_createdstring · date-timeOptionalDeprecated
Use date_created:max
.
after_date_createdstring · date-timeOptionalDeprecated
Use date_created:min
.
sort_bystringOptional
Property to sort by in camelCase
sort_directionstringOptional
Direction to sort by
date_last_modified:minstring · date-timeOptionalPattern:
Only include bags modified after this date.
yyyy-MM-dd'T'HH:mm:ssZ
date_last_modified:maxstring · date-timeOptionalPattern:
Only include bags modified before this date.
yyyy-MM-dd'T'HH:mm:ssZ
date_created:minstring · date-timeOptionalPattern:
Only include bags created after this date.
yyyy-MM-dd'T'HH:mm:ssZ
date_created:maxstring · date-timeOptionalPattern:
Only include bags created before this date.
yyyy-MM-dd'T'HH:mm:ssZ
date_submitted:minstring · date-timeOptionalPattern:
Only include bags submitted after this date.
yyyy-MM-dd'T'HH:mm:ssZ
date_submitted:maxstring · date-timeOptionalPattern:
Only include bags submitted before this date.
yyyy-MM-dd'T'HH:mm:ssZ
Responses
default
default response
application/json
post
POST /v1/orders/bags/search 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: 440
{
"merchant_id": 1,
"order_id": 1,
"id": 1,
"external_id": "text",
"bag_status": "IN_PROGRESS",
"app_order_id": "text",
"sort_by": "text",
"sort_direction": "text",
"date_last_modified:min": "2025-07-10T07:00:49.384Z",
"date_last_modified:max": "2025-07-10T07:00:49.384Z",
"date_created:min": "2025-07-10T07:00:49.384Z",
"date_created:max": "2025-07-10T07:00:49.384Z",
"date_submitted:min": "2025-07-10T07:00:49.384Z",
"date_submitted:max": "2025-07-10T07:00:49.384Z"
}
default
default response
{
"content": [
{
"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-10T07:00:49.384Z",
"date_last_modified": "2025-07-10T07:00:49.384Z",
"date_last_consolidated": "2025-07-10T07:00:49.384Z",
"date_submitted": "2025-07-10T07:00:49.384Z",
"remorse_period_ends": "2025-07-10T07:00:49.384Z",
"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-10T07:00:49.384Z",
"date_last_modified": "2025-07-10T07:00:49.384Z",
"email": "text"
}
],
"wallet_based_checkout": false,
"app_name": "text",
"bag_id": 1,
"bag_status": "IN_PROGRESS",
"merchant_name": "text"
}
],
"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?