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
Get All Merchant Offers
Use date_last_modified:min.
Comma-separated list of extra data to be included.
Return only the published offers that have been modified after the given date time, using the standard Violet datetime format, ISO 8601. Example: 2017-06-15T01:01:01+0000
Return only the published offers that have been modified before the given date time, using the standard Violet datetime format, ISO 8601. Example: 2017-06-25T01:01:01+0000
Retrieve a list of all Offer’s for a Merchant, given their merchant_id. For most performant results please make sure to use the since property.
This endpoint supports collections and metadata. Use the include query param.
To avoid performance issues, total_elements and total_pages properties are not populated for this endpoint response, being both returned with default value of 0.
Violet strongly discourages scraping this endpoint. Most offers do not change very often, so re-scraping all of a merchant’s offers on a regular basis is a very costly way to keep your catalog up to date.
Violet’s recommendation is to make use of offer webhooks to be notified when offers are added/updated in Violet’s system. This works because when your merchants onboard, their products are pulled into Violet’s system and so you will receive a webhook for each of the new merchant’s offers. Additionally, Violet employs a number of methods to keep our merchant’s catalogs up to date and all of those methods will generate webhooks sent to your system.
Headers
Path Parameters
Query Parameters
Use date_last_modified:min.
Comma-separated list of extra data to be included.
metadata, collections, shipping Return only the published offers that have been modified after the given date time, using the standard Violet datetime format, ISO 8601. Example: 2017-06-15T01:01:01+0000
Return only the published offers that have been modified before the given date time, using the standard Violet datetime format, ISO 8601. Example: 2017-06-25T01:01:01+0000
Response
The actual content of the response; A list of the result objects
The parent/container product ID. Note: this is a legacy property and is now considered deprecated.
The ID of the product in the merchants external store.
The URL to the product page in the merchants store.
Name of the offer.
Description of the offer. Note: this value may contain HTML elements.
65000Commerce platform the offer was sourced from.
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 Name of merchant selling product.
Name of source vendor or brand.
Merchant ID
Is the product available for purchase.
Is the product hidden in the merchants store. Note: a product can be hidden while still being available for purchase.
Minimum Price the Offer sells for.
Maximum Price the Offer sells for.
Base Currency of Offer. Intended for reference only. The currency property of the SKU is the currency source of truth.
Original Category on Source Platform
Additional Meta Data of the Offer
Schema version
Type of the value
STRING, JSON, INTEGER, LONG, DECIMAL, BOOLEAN Type of the value in the external commerce platform
The key of meta value
The meta value. Values of type JSON will be stringified
ID of the meta object in the external commerce platform
The source the meta object originated from, either EXTERNAL or INTERNAL, with EXTERNAL representing data from the external commerce platform
INTERNAL, EXTERNAL Product variations configured by the merchant in their external store. Note: Variations can have any name the merchant chooses to use. There is no pre-defined set of possible variants or variant values.
ID of the Product Variant
ID of the Variant on the External Ecommerce Platform
The name given to the Variant by the merchant.
Is the variant a visual characteristic. Common examples of this would be Color, Pattern, or Material.
Variant Values
ID of the Product Variation Value
ID of the Variant in the External Ecommerce Platform
Variant Value Name
ID's of SKU's containing this Variant Value
The order the variant values are displayed in.
The order the variants are displayed in.
Sku's are unique combinations of Variants the compose a purchasable entity. When placing orders a Sku is the item that will be purchased.
ID of the parent Offer that this Sku is a child of.
ID of the Merchant that originated the Sku.
The ID of the Sku in the merchants external store.
Sku Name
Amazon Standard Identification Number
Global Trade Item Number
Universal Product Code
European Article Number
International Standard Book Number
Is the Sku in stock in the merchants external store.
The total quantity of this Sku available for purchase.
Is the Sku's inventory tracked in the merchants system. Untracked inventory can be oversold even when the available quantity is 0.
Sale Price of the Sku. This is the actual sale cost when the Sku is purchased.
Retail Price of the Sku. This is the recommended or common price of the Sku and is typically not what the customer will be charged..
The base currency of this Sku.
The presented currency of this Sku.
Is the Sku taxable.
Type of Tax on this Sku.
DEFAULT, APPAREL, SERVICE Sku Albums
ID of the parent entity
Parent Type
OFFER, SKU Name of Album
Album media
Album ID
The ID of the media in the merchants store.
The unique ID of hosted cloud entity. Only present on media from self-hosted platforms.
The URL that should be used when displaying media within your app. For cloud hosted commerce platforms that provide a CDN this will often be the same as the source_url property. For self-hosted platforms this will typically be a Violet CDN URL.
The original URL from the merchants system.
Media Type
IMAGE, VIDEO The order in which the merchant displayed the media in relation to other media in the same collection.
Text describing the media. This value is sourced from the merchant.
512If the media is the primary or default image in the merchants store for an Offer or Sku. This is typically the cover image on a product details page.
Product and SKU Media
Album ID
The ID of the media in the merchants store.
The unique ID of hosted cloud entity. Only present on media from self-hosted platforms.
The URL that should be used when displaying media within your app. For cloud hosted commerce platforms that provide a CDN this will often be the same as the source_url property. For self-hosted platforms this will typically be a Violet CDN URL.
The original URL from the merchants system.
Media Type
IMAGE, VIDEO The order in which the merchant displayed the media in relation to other media in the same collection.
Text describing the media. This value is sourced from the merchant.
512If the media is the primary or default image in the merchants store for an Offer or Sku. This is typically the cover image on a product details page.
PHYSICAL, DIGITAL, VIRTUAL, BUNDLED SKU Status
UNAVAILABLE, AVAILABLE, DISABLED_UNAVAILABLE, DISABLED_AVAILABLE, FOR_DELETION, ARCHIVED Date when the Sku was first created in Violet.
Date when the Sku was last updated in Violet.
Individual Sku Dimensions
ID of SKU Dimensions Belong To
Weight of SKU
Height of SKU
Width of SKU
Length of SKU
Dimensions Type
SKU, SHIPPING Individual Sku Dimensions
ID of SKU Dimensions Belong To
Weight of SKU
Height of SKU
Width of SKU
Length of SKU
Dimensions Type
SKU, SHIPPING The order that the merchant has chosen to display this Sku in relation to other Sku's that are children of the same Offer.
Grouped of media for the Offer. Note: For most commerce platforms there will only be a single album per Offer.
ID of the parent entity
Parent Type
OFFER, SKU Name of Album
Album media
Album ID
The ID of the media in the merchants store.
The unique ID of hosted cloud entity. Only present on media from self-hosted platforms.
The URL that should be used when displaying media within your app. For cloud hosted commerce platforms that provide a CDN this will often be the same as the source_url property. For self-hosted platforms this will typically be a Violet CDN URL.
The original URL from the merchants system.
Media Type
IMAGE, VIDEO The order in which the merchant displayed the media in relation to other media in the same collection.
Text describing the media. This value is sourced from the merchant.
512If the media is the primary or default image in the merchants store for an Offer or Sku. This is typically the cover image on a product details page.
Product and SKU Media
Album ID
The ID of the media in the merchants store.
The unique ID of hosted cloud entity. Only present on media from self-hosted platforms.
The URL that should be used when displaying media within your app. For cloud hosted commerce platforms that provide a CDN this will often be the same as the source_url property. For self-hosted platforms this will typically be a Violet CDN URL.
The original URL from the merchants system.
Media Type
IMAGE, VIDEO The order in which the merchant displayed the media in relation to other media in the same collection.
Text describing the media. This value is sourced from the merchant.
512If the media is the primary or default image in the merchants store for an Offer or Sku. This is typically the cover image on a product details page.
Type of product. Note: Offers with a type of BUNDLED cannot be purchased through the API at this time due to ecom platform limitations.
PHYSICAL, DIGITAL, VIRTUAL, BUNDLED Current status of the Offer.
UNAVAILABLE, AVAILABLE, DISABLED_UNAVAILABLE, DISABLED_AVAILABLE, FOR_DELETION, ARCHIVED Publishing Status
NOT_PUBLISHED, PUBLISHED Date of offer creation in ISO 8601 format.
Date of last offer update in ISO 8601 format.
Date of last consolidation in ISO 8601 format. This date is jittered for performance reasons and can be in the future
Is the product 3D Enabled
3D Resource Object
Amount given by merchant
Symbol representing the desired currency
The presented currency of this SKU
The default image for this Offer. Only present on responses from the Search API. In other cases this value will be on the album's primary media object.
Subscription status
NOT_SUBSCRIBED, SUBSCRIBED The raw external product data from the external commerce platform
Collections this offer belongs to
External ID
Merchant ID
Parent ID for platforms that have a parent-child collection structure.
Name of this collection
Handle of this collection
Description of this collection
Status of this collection
INACTIVE, ACTIVE, SYNC_IN_PROGRESS, FOR_DELETION Type of this collection
CUSTOM, AUTOMATED Date of creation of this collection on platform
Date of last update of this collection on platform
[ALPHA] - Shipping data for the Offer.
Context regarding the shipping data for this Offer.
List of available shipping methods for this Offer.
ID of the shipping method in the external commerce system.
Name of the shipping method as provided by the merchant.
Price in cents required to enable the shipping method.
Price in cents.
ISO 4217 Currency Code
USD, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SVC, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, BTN Regions this shipping method is enabled for.
List of ISO 3166 Country Codes
US, AU, AT, BE, CA, DK, FI, FR, DE, HK, IE, IT, JP, LU, MX, NL, NZ, NO, PT, SG, ES, SE, CH, GB, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AZ, BS, BH, BD, BB, BY, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, GF, PF, TF, GA, GM, GE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IM, IL, JM, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, AN, NC, NI, NE, NG, NU, NF, MP, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PR, QA, RE, RO, RU, RW, SH, KN, LC, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SK, SI, SB, SO, ZA, GS, LK, SD, SR, SJ, SZ, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW Conditions that must be met for the method to be available.
Price in cents required to enable the shipping method.
Weight required to enable the shipping method.
Condition type, whether it's price or weight based.
TOTAL_PRICE, TOTAL_WEIGHT Operator indicating if the price or weight is >= or <= the condition value.
LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_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?