Search for all Bags
placed through your application given certain filter critera.
Available options:
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
.
Property to sort by in camelCase
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 default - application/json
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.
ID of the Order on the external commerce platform. This value will be null
until the Order submitted.
content. external_reference_id
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.
Available options:
IN_PROGRESS
,
SUBMITTED
,
ACCEPTED
,
COMPLETED
,
PARTIALLY_REFUNDED
,
REFUNDED
,
REJECTED
,
CANCELED
,
BACKORDERED
content. fulfillment_status
Fulfillment status of the Bag.
Available options:
PROCESSING
,
SHIPPED
,
PARTIALLY_SHIPPED
,
DELIVERED
,
COULD_NOT_DELIVER
,
RETURNED
Financial status of the Bag.
Available options:
UNPAID
,
AUTHORIZED
,
PENDING
,
PAID
,
PARTIALLY_PAID
,
REFUNDED
,
PARTIALLY_REFUNDED
,
VOIDED
Dispute status of the Bag.
Available options:
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.
Required range: x < 1000
Price of the individual SKU, in cents.
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.
Available options:
IN_PROGRESS
,
PROCESSING
,
SHIPPED
,
PARTIALLY_SHIPPED
,
DELIVERED
,
COULD_NOT_DELIVER
,
RETURNED
,
CANCELED
,
REFUNDED
,
ERROR
,
PARTIALLY_RETURNED
,
PARTIALLY_REFUNDED
content.skus. product_type
Product type that describes the Sku.
Available options:
PHYSICAL
,
DIGITAL
,
VIRTUAL
,
BUNDLED
Is the Sku custom. Is true
when the price has been overridden.
content.skus. custom_properties
Used to provide the merchant with custom values for the product. This functionality is currently limited to Shopify merchants.
content.skus.custom_properties. name
Name of the custom property.
Minimum length: 1
content.skus.custom_properties. value
Value of the custom property.
Minimum length: 1
content.skus. quantity_fulfilled
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.
content.skus.rates. order_sku_id
ID of the Order SKU the Rate belongs to
content.skus.rates. amount
Total Tax amount on Bag. In Cents
Available options:
TAX
,
SHIPPING
,
FEE
,
DUTY
content.skus.rates. decimal_rate
content.skus.rates. dollar_amount
Price of the Sku multiplied by the quantity, in Cents
Shipping Methods belonging to an Order
content.shipping_method. price
Total cost of the Shipping Method. In Cents
content.shipping_method. shipping_method_id
ID of the referenced Shipping Method
content.shipping_method. bag_id
ID of the Bag the Shipping Method applies to
content.shipping_method. merchant_id
ID of the merchant the bag belongs to
content.shipping_method. type
Available options:
CALCULATED
,
FLAT_RATE_PRICE
,
FLAT_RATE_WEIGHT
content.shipping_method. Carrier
Available options:
OTHER
,
UPS
,
USPS
,
FEDEX
,
DHL
,
ONTRAC
,
ROYAL_MAIL
,
SENDLE
,
POSTNORD
content.shipping_method. label
content.shipping_method. custom
Is the shipping method custom. True when the price has been overridden.
content.shipping_method. min_subtotal
Minimum Subtotal. In Cents. Only applies to Flat Rate by Price
content.shipping_method. max_subtotal
Maximum Subtotal. In Cents. Only applies to Flat Rate by Price
content.shipping_method. min_weight
Minimum Weight. In Cents. Only applies to Flat Rate by Weight
content.shipping_method. max_weight
Maximum Weight. In Cents. Only applies to Flat Rate by Weight
content.shipping_method. external_id
ID(s) on external ecommerce platform
content.shipping_method. id
content.shipping_method. tracking_number
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
content.taxes. merchant_id
ID of the Merchant the Bag belongs to
Total Tax amount on Bag. In Cents
content.taxes. postal_code
content.taxes. description
The 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.
content. external_checkout
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.
content. date_last_modified
Date the Bag was last modified in Violet.
content. date_last_consolidated
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. remorse_period_ends
Date when the Bag can no longer be refunded.
Base currency of the Bag.
content. external_currency
Currency of the equivalent cart on external commerce platform.
content. currency_exchange_rate
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.
Available options:
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.
Maximum length: 64
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
A list of fulfillments, if any, that have been applied to this Bag.
content.fulfillments. bag_id
ID of the bag the fulfillment belongs to.
content.fulfillments. external_id
ID of the fulfillment on the external commerce platform.
content.fulfillments. carrier
Carrier responsible for the fulfillment. Will be OTHER if raw carrier is not recognized.
Available options:
OTHER
,
UPS
,
USPS
,
FEDEX
,
DHL
,
ONTRAC
,
ROYAL_MAIL
,
SENDLE
,
POSTNORD
content.fulfillments. raw_carrier
Raw name of carrier from the external commerce platform.
content.fulfillments. status
Status of the bag fullfillment.
Available options:
PENDING
,
PROCESSING
,
SUCCESS
,
CANCELED
,
ERROR
,
FAILURE
,
NONE_PROVIDED
content.fulfillments. carrier_status
Status provided by the carrier.
Available options:
PENDING
,
LABEL_PURCHASED
,
LABEL_PRINTED
,
CONFIRMED
,
READY_FOR_PICKUP
,
IN_TRANSIT
,
OUT_FOR_DELIVERY
,
ATTEMPTED_DELIVERY
,
DELIVERED
,
FAILURE
,
NONE_PROVIDED
content.fulfillments. tracking_number
Tracking number provided by the carrier.
content.fulfillments. tracking_url
Tracking URL provided by the carrier.
content.fulfillments. skus
SKUs fulfilled by this fulfillment.
content.fulfillments.skus. id
content.fulfillments.skus. fulfillment_id
ID of the fulfillment that contains this item.
content.fulfillments.skus. order_sku_id
ID of the SKU in the Bag.
content.fulfillments.skus. quantity_fulfilled
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
Available options:
PENDING
,
APPLIED
,
INVALID
,
NOT_SUPPORTED
,
ERROR
,
EXPIRED
content.discounts. value_type
Available options:
AMOUNT
,
PERCENTAGE
content.discounts. target_type
Target type of the discount
Available options:
ORDER
,
SKU
,
SHIPPING
content.discounts. external_id
content.discounts. percentage
content.discounts. amount_total
Total amount of discount applied to bag
content.discounts. date_created
content.discounts. date_last_modified
Date of last bag discount update
Customer email address, possibly necessary for once-per-customer discounts.
content. wallet_based_checkout
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.
Available options:
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
Violet Wrapper for springframework sort
Boolean indicating if the result set is unsorted
Boolean indicating if the result set is sorted
Boolean indicating if the result set is empty
Boolean indicating if the result is paged
Boolean indicating if the result is unpaged
Violet Wrapper for springframework sort
Boolean indicating if the result set is unsorted
Boolean indicating if the result set is sorted
Boolean indicating if the result set is empty