Search Bags - Violet Documentation

Search for all Bags placed through your application given certain filter critera.

Headers

X-Violet-Token

string

X-Violet-App-Secret

string

X-Violet-App-Id

integer

Query Parameters

page

integer

default:

size

integer

default:

extended

boolean

default:

false

exclude_in_progress

boolean

default:

true

Body

application/json

Bag Search Request

after_date

string

deprecated

Use date_last_modified:min.

after_date_created

string

deprecated

Use date_created:min.

app_order_id

string

Order ID in the Channels System

bag_status

enum<string>

Bag Status

Available options:

IN_PROGRESS,

SUBMITTED,

ACCEPTED,

COMPLETED,

PARTIALLY_REFUNDED,

REFUNDED,

REJECTED,

CANCELED,

BACKORDERED

before_date

string

deprecated

Use date_last_modified:max.

before_date_created

string

deprecated

Use date_created:max.

date_created:max

string

Only include bags created before this date.

date_created:min

string

Only include bags created after this date.

date_last_modified:max

string

Only include bags modified before this date.

date_last_modified:min

string

Only include bags modified after this date.

external_id

string

Bag External ID

integer

Bag ID

merchant_id

integer

Merchant ID

order_id

integer

Order ID

sort_by

string

Property to sort by in camelCase

sort_direction

string

Direction to sort by

Response

default - application/json

content

object[]

The actual content of the response; A list of the result objects

content.app_id

integer

required

ID of the App responsible for the creation and submission of this Order.

content.merchant_id

integer

required

ID of the merchant the Bag is related to.

content.order_id

integer

required

ID of the parent order the Bag is a child of.

content.app_name

string

Name of app that originated the order. Use the "extended" query param when looking up orders to include this value.

content.app_order_id

string | null

Optional ID of the Order in the channels system. Automatically obtained through the app_order_id applied to the Order.

content.bag_id

integer

content.bag_status

enum<string>

Available options:

IN_PROGRESS,

SUBMITTED,

ACCEPTED,

COMPLETED,

PARTIALLY_REFUNDED,

REFUNDED,

REJECTED,

CANCELED,

BACKORDERED

content.channel

enum<string>

The type of Channel that originated this Bag.

Available options:

APP,

MARKETPLACE,

FACEBOOK,

INSTAGRAM,

WALMART,

GOOGLE,

TIKTOK,

SNAPCHAT,

PINTEREST

content.commission_rate

number

The rate used to calculate the apps commission rate for the Bag.

content.currency

string

Base currency of the Bag.

content.currency_exchange_rate

number | null

Exchange rate of currency and external currency, if different, at the time the Bag was last priced.

content.date_created

string

Date the Bag was created in Violet.

content.date_last_consolidated

string

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.

content.date_last_modified

string

Date the Bag was last modified in Violet.

content.discount_total

integer

The total discounts applied to the price of the Bag in the base currency. In Cents

content.discounts

array | null

A list of discounts, if any, that have been applied to this Bag.

content.dispute_status

enum<string>

default:

UNDISPUTED

Dispute status of the Bag.

Available options:

UNDISPUTED,

IN_DISPUTE,

DISPUTE_WON,

DISPUTE_LOST

content.external_checkout

boolean

default:

true

If the Bag is attached to an external cart in the commerce platform.

content.external_currency

string

Currency of the equivalent cart on external commerce platform.

content.external_id

string | null

ID of the Order on the external commerce platform. This value will be null until the Order submitted.

content.financial_status

enum<string>

Financial status of the Bag.

Available options:

UNPAID,

AUTHORIZED,

PENDING,

PAID,

PARTIALLY_PAID,

REFUNDED,

PARTIALLY_REFUNDED,

VOIDED

content.fulfillment_status

enum<string>

Fulfillment status of the Bag.

Available options:

PROCESSING,

SHIPPED,

PARTIALLY_SHIPPED,

DELIVERED,

COULD_NOT_DELIVER,

RETURNED

content.fulfillments

array | null

A list of fulfillments, if any, that have been applied to this Bag.

content.id

integer

Unique ID of the Bag.

content.merchant_name

string

Name of the merchant the Bag is related to.

content.platform

enum<string>

The commerce platform used by this merchant.

Available options:

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

content.remorse_period_ends

string

Date when the Bag can no longer be refunded.

content.shipping_method

object | null

Shipping Methods belonging to an Order

content.shipping_total

integer

The sum of all shipping methods applied to the Bag in the base currency. In Cents

content.skus

object[]

Sku's (line items) that have been added to the Bag.

content.skus.sku_id

integer

required

ID of the referenced Sku from the Violet catalog.

content.skus.app_id

integer

ID of the App responsible for the creation and submission of this Order.

content.skus.available

boolean

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.

content.skus.brand

string

Name of the brand selling this Sku.

content.skus.custom

boolean

Is the Sku custom. Is true when the price has been overridden.

content.skus.custom_properties

array | null

Used to provide the merchant with custom values for the product. This functionality is currently limited to Shopify merchants.

content.skus.external_id

string

ID of the SKU on the external commerce platform.

content.skus.height

number | null

Height of Sku.

content.skus.id

integer

Unique ID of the Sku in relation to the order.

content.skus.length

number | null

Length of Sku.

content.skus.line_price

integer

Price of the Sku multiplied by the quantity, in Cents

content.skus.merchant_id

integer

ID of the Merchant this Sku belongs to.

content.skus.name

string

Name of the Sku, as provided by the merchant.

content.skus.offer_id

integer

ID of the parent Offer that this Sku is a child of.

content.skus.price

integer

Price of the individual SKU, in cents.

content.skus.product_id

string

deprecated

ID of the parent product the offer is a child off.

content.skus.product_type

enum<string>

Product type that describes the Sku.

Available options:

PHYSICAL,

DIGITAL,

VIRTUAL,

BUNDLED

content.skus.quantity

integer

Quantity of the Sku being purchased. Quantities over 1000 will default to 1000.

Required range: x < 1000

content.skus.quantity_fulfilled

integer

The quantity of this item that has been fulfilled by the merchant.

content.skus.rates

object[]

Rates that apply specifically to this Sku such as taxes, fees, or duties.

content.skus.status

enum<string>

Current status of the Sku.

Available options:

IN_PROGRESS,

PROCESSING,

SHIPPED,

PARTIALLY_SHIPPED,

DELIVERED,

COULD_NOT_DELIVER,

RETURNED,

CANCELED,

REFUNDED,

ERROR,

PARTIALLY_RETURNED,

PARTIALLY_REFUNDED

content.skus.thumbnail

string

URL of the thumbnail image. Useful for order overview displays.

content.skus.weight

number | null

Weight of Sku.

content.skus.width

number | null

Width of Sku.

content.status

enum<string>

Overall status of the Bag.

Available options:

IN_PROGRESS,

SUBMITTED,

ACCEPTED,

COMPLETED,

PARTIALLY_REFUNDED,

REFUNDED,

REJECTED,

CANCELED,

BACKORDERED

content.sub_total

integer

The price of the Bag in the base currency before discounts, shipping, duties, taxes, and tips. In Cents.

content.tax_total

integer

The sum of all the taxes applied to the Bag in the base currency. In Cents

content.taxes

array | null

Tax rates applied to the Bag.

content.taxes_included

boolean

default:

false

Are taxes included in the cart subtotal. When true the taxes will not be summed separately.

content.total

integer

The sum of all item prices, discounts, shipping, and taxes applied to the Bag in the base currency. In Cents

content.wallet_based_checkout

boolean

default:

false

Is this Bag going to be placed through wallet-based checkout.

empty

boolean

Boolean indicating if the response content is empty

first

boolean

Boolean indicating if this is the first page of the response

last

boolean

Boolean indicating if this is the last page

next_page_cursor

string

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.

number

integer

The page number selected at request time

number_of_elements

integer

The total number of objects in this specific response

pageable

object

Violet wrapper for springframework pageable

size

integer

The page size selected at request time

sort

object

Violet Wrapper for springframework sort

total_elements

integer

The total count of objects available

total_pages

integer

The total count of pages available