Overview
Login
- Access
Merchants
- Merchant
- Configuration
- 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
Events
- Webhooks
- Webhook Events
- Wekbhook Headers
Apps
- Merchant/App Installs
- Commission Rates
Operations
- Connection
Relay
- Shipping
Ecom Syncs
- Offers
Search Bags
curl --request POST \
--url https://sandbox-api.violet.io/v1/orders/bags/search \
--header 'Content-Type: application/json' \
--data '{
"merchant_id": 123,
"order_id": 123,
"id": 123,
"external_id": "<string>",
"bag_status": "IN_PROGRESS",
"app_order_id": "<string>",
"before_date": "2023-11-07T05:31:56Z",
"after_date": "2023-11-07T05:31:56Z",
"before_date_created": "2023-11-07T05:31:56Z",
"after_date_created": "2023-11-07T05:31:56Z",
"sort_by": "<string>",
"sort_direction": "<string>",
"date_last_modified:min": "2023-11-07T05:31:56Z",
"date_last_modified:max": "2023-11-07T05:31:56Z",
"date_created:min": "2023-11-07T05:31:56Z",
"date_created:max": "2023-11-07T05:31:56Z"
}'{
"content": [
{
"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",
"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_status": "IN_PROGRESS",
"bag_id": 123,
"merchant_name": "<string>"
}
],
"last": true,
"total_pages": 123,
"total_elements": 123,
"first": true,
"number_of_elements": 123,
"size": 123,
"number": 123,
"empty": true,
"next_page_cursor": "<string>",
"pageable": {
"page_number": 123,
"page_size": 123,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"offset": 123,
"paged": true,
"unpaged": true
},
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
}
}Search for all Bags placed through your application given certain filter critera.
Query Parameters
Body
Bag Search Request
Merchant ID
Order ID
Bag ID
Bag External ID
Bag Status
IN_PROGRESS, SUBMITTED, ACCEPTED, COMPLETED, PARTIALLY_REFUNDED, REFUNDED, REJECTED, CANCELED, BACKORDERED Order ID in the Channels System
Use date_last_modified:max.
Use date_last_modified:min.
Use date_created:max.
Use date_created:min.
Property to sort by in camelCase
Direction to sort by
Only include bags modified after this date.
Only include bags modified before this date.
Only include bags created after this date.
Only include bags created before this date.
Response
The actual content of the response; A list of the result objects
ID of the parent order the Bag is a child of.
ID of the merchant the Bag is related to.
ID of the App responsible for the creation and submission of this Order.
Unique ID of the Bag.
ID of the Order on the external commerce platform. This value will be null until the Order submitted.
An alternative vanity or reference ID that the external commerce platform may use for an order. This is typically an ID or number that may be shown to the shopper in communication from the merchant when the true order ID is hidden.
Overall status of the Bag.
IN_PROGRESS, SUBMITTED, ACCEPTED, COMPLETED, PARTIALLY_REFUNDED, REFUNDED, REJECTED, CANCELED, BACKORDERED Fulfillment status of the Bag.
PROCESSING, SHIPPED, PARTIALLY_SHIPPED, DELIVERED, COULD_NOT_DELIVER, RETURNED Financial status of the Bag.
UNPAID, AUTHORIZED, PENDING, PAID, PARTIALLY_PAID, REFUNDED, PARTIALLY_REFUNDED, VOIDED Dispute status of the Bag.
UNDISPUTED, IN_DISPUTE, DISPUTE_WON, DISPUTE_LOST Sku's (line items) that have been added to the Bag.
ID of the referenced Sku from the Violet catalog.
Unique ID of the Sku in relation to the order.
ID of the parent Offer that this Sku is a child of.
ID of the Merchant this Sku belongs to.
ID of the App responsible for the creation and submission of this Order.
ID of the parent product the offer is a child off.
ID of the SKU on the external commerce platform.
Name of the Sku, as provided by the merchant.
Name of the brand selling this Sku.
URL of the thumbnail image. Useful for order overview displays.
Quantity of the Sku being purchased. Quantities over 1000 will default to 1000.
x < 1000Price of the individual SKU, in cents.
Weight of Sku.
Height of Sku.
Width of Sku.
Length of Sku.
Is the product still available for purchase. If a Sku becomes unavailable it likely means that the product became out of stock after it was added to the cart. Unavailable Sku's cannot be purchased.
Current status of the Sku.
IN_PROGRESS, PROCESSING, SHIPPED, PARTIALLY_SHIPPED, DELIVERED, COULD_NOT_DELIVER, RETURNED, CANCELED, REFUNDED, ERROR, PARTIALLY_RETURNED, PARTIALLY_REFUNDED Product type that describes the Sku.
PHYSICAL, DIGITAL, VIRTUAL, BUNDLED Is the Sku custom. Is true when the price has been overridden.
Used to provide the merchant with custom values for the product. This functionality is currently limited to Shopify merchants.
The quantity of this item that has been fulfilled by the merchant.
Rates that apply specifically to this Sku such as taxes, fees, or duties.
ID of the Order SKU the Rate belongs to
Total Tax amount on Bag. In Cents
Rate Type
TAX, SHIPPING, FEE, DUTY Rate Name
Rate
Price of the Sku multiplied by the quantity, in Cents
Shipping Methods belonging to an Order
Total cost of the Shipping Method. In Cents
ID of the referenced Shipping Method
ID of the Bag the Shipping Method applies to
ID of the merchant the bag belongs to
Type of Shipping Method
CALCULATED, FLAT_RATE_PRICE, FLAT_RATE_WEIGHT OTHER, UPS, USPS, FEDEX, DHL, ONTRAC, ROYAL_MAIL, SENDLE, POSTNORD Shipping Method Label
Is the shipping method custom. True when the price has been overridden.
Minimum Subtotal. In Cents. Only applies to Flat Rate by Price
Maximum Subtotal. In Cents. Only applies to Flat Rate by Price
Minimum Weight. In Cents. Only applies to Flat Rate by Weight
Maximum Weight. In Cents. Only applies to Flat Rate by Weight
ID(s) on external ecommerce platform
Carrier Tracking Number. Deprecated: Use fulfillments on the Bag object instead.
Tax rates applied to the Bag.
ID of the Order the Tax belongs to
ID of the Merchant the Bag belongs to
State abbreviation
Tax Rate
Total Tax amount on Bag. In Cents
SKUs covered by the Tax
Postal/Zip Code
Description of the Tax
255The price of the Bag in the base currency before discounts, shipping, duties, taxes, and tips. In Cents.
The sum of all shipping methods applied to the Bag in the base currency. In Cents
The sum of all the taxes applied to the Bag in the base currency. In Cents
The total discounts applied to the price of the Bag in the base currency. In Cents
The sum of all item prices, discounts, shipping, and taxes applied to the Bag in the base currency. In Cents
Are taxes included in the cart subtotal. When true the taxes will not be summed separately.
If the Bag is attached to an external cart in the commerce platform.
The rate used to calculate the apps commission rate for the Bag.
Date the Bag was created in Violet.
Date the Bag was last modified in Violet.
Date the Bag was last checked for updates. This is a part of Order Parity and is used to discover missed or unsent webhooks from the external commerce platforms.
Date when the Bag can no longer be refunded.
Base currency of the Bag.
Currency of the equivalent cart on external commerce platform.
Exchange rate of currency and external currency, if different, at the time the Bag was last priced.
The type of Channel that originated this Bag.
APP, MARKETPLACE, FACEBOOK, INSTAGRAM, WALMART, GOOGLE, TIKTOK, SNAPCHAT, PINTEREST Optional ID of the Order in the channels system. Automatically obtained through the app_order_id applied to the Order.
64The commerce platform used by this merchant.
OTHER, SHOPIFY, MAGENTO, MAGENTO_ONE, WOOCOMMERCE, BIGCOMMERCE, LIGHTSPEED, ECWID, YAAS, SPREECOMMERCE, DEMANDWARE, VOLUSION, PRESTASHOP, THREEDCART, SYLIUS, WIX, SWELL, MIVA, WEBSPHERE, ORACLECC, SAPCC, SQUARESPACE, SHOPWARE, COMMERCETOOLS, MEDUSA, ABICART, SPRYKER, MYSTORE, CENTRA, XCART, VTEX, KIBO, SALEOR, VENDO, CHORD, DIGITALRIVER, SQUARE, AMAZON, BIGCARTEL, CUSTOM A list of fulfillments, if any, that have been applied to this Bag.
ID of the bag the fulfillment belongs to.
ID of the fulfillment on the external commerce platform.
Carrier responsible for the fulfillment. Will be OTHER if raw carrier is not recognized.
OTHER, UPS, USPS, FEDEX, DHL, ONTRAC, ROYAL_MAIL, SENDLE, POSTNORD Raw name of carrier from the external commerce platform.
Status of the bag fullfillment.
PENDING, PROCESSING, SUCCESS, CANCELED, ERROR, FAILURE, NONE_PROVIDED Status provided by the carrier.
PENDING, LABEL_PURCHASED, LABEL_PRINTED, CONFIRMED, READY_FOR_PICKUP, IN_TRANSIT, OUT_FOR_DELIVERY, ATTEMPTED_DELIVERY, DELIVERED, FAILURE, NONE_PROVIDED Tracking number provided by the carrier.
Tracking URL provided by the carrier.
SKUs fulfilled by this fulfillment.
ID of the fulfillment that contains this item.
ID of the SKU in the Bag.
Quantity of the this item fulfilled by this fulfillment.
A list of discounts, if any, that have been applied to this Bag.
ID of the Bag this discount belong to
Status of discount
PENDING, APPLIED, INVALID, NOT_SUPPORTED, ERROR, EXPIRED Type of discount
CODE Value type of discount
AMOUNT, PERCENTAGE Target type of the discount
ORDER, SKU, SHIPPING Code of discount
External ID of discount
Amount of discount
Percentage of discount
Total amount of discount applied to bag
Date of creation
Date of last bag discount update
Customer email address, possibly necessary for once-per-customer discounts.
Is this Bag going to be placed through wallet-based checkout.
Name of app that originated the order. Use the "extended" query param when looking up orders to include this value.
IN_PROGRESS, SUBMITTED, ACCEPTED, COMPLETED, PARTIALLY_REFUNDED, REFUNDED, REJECTED, CANCELED, BACKORDERED Name of the merchant the Bag is related to.
Boolean indicating if this is the last page
The total count of pages available
The total count of objects available
Boolean indicating if this is the first page of the response
The total number of objects in this specific response
The page size selected at request time
The page number selected at request time
Boolean indicating if the response content is empty
Contains the cursor for the next page. This property will only be used for situations where the API does not support the page number/page size paradigm and it will mutually exclusive with the size/number fields in the response. If this property is returned it must be passed when requesting the next page from the API. Does not apply to endpoints that do not have a next_page_cursor query param documented.
Violet wrapper for springframework pageable
The current page number (one based)
The number of elements per page
The offset
Boolean indicating if the result is paged
Boolean indicating if the result is unpaged
Was this page helpful?
curl --request POST \
--url https://sandbox-api.violet.io/v1/orders/bags/search \
--header 'Content-Type: application/json' \
--data '{
"merchant_id": 123,
"order_id": 123,
"id": 123,
"external_id": "<string>",
"bag_status": "IN_PROGRESS",
"app_order_id": "<string>",
"before_date": "2023-11-07T05:31:56Z",
"after_date": "2023-11-07T05:31:56Z",
"before_date_created": "2023-11-07T05:31:56Z",
"after_date_created": "2023-11-07T05:31:56Z",
"sort_by": "<string>",
"sort_direction": "<string>",
"date_last_modified:min": "2023-11-07T05:31:56Z",
"date_last_modified:max": "2023-11-07T05:31:56Z",
"date_created:min": "2023-11-07T05:31:56Z",
"date_created:max": "2023-11-07T05:31:56Z"
}'{
"content": [
{
"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",
"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_status": "IN_PROGRESS",
"bag_id": 123,
"merchant_name": "<string>"
}
],
"last": true,
"total_pages": 123,
"total_elements": 123,
"first": true,
"number_of_elements": 123,
"size": 123,
"number": 123,
"empty": true,
"next_page_cursor": "<string>",
"pageable": {
"page_number": 123,
"page_size": 123,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"offset": 123,
"paged": true,
"unpaged": true
},
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
}
}