- Get API Keys
- Welcome
Access
Offers
SKUs
Categories
Collections
Currencies
Cart
Payment
Customer
Completion
Shipping
Discounts
Items
Refunds
Orders
Merchant
Configuration
Explore
Webhooks
Webhook Events
Wekbhook Headers
Merchant/App Installs
Connection
Shipping
Overview
Login
Catalog
Orders & Checkout
Merchants
Events
Apps
Operations
Relay
Get All Merchant Offers
A date represented in epoch milliseconds (https://www.epochconverter.com/). Gets offers last modified after the given date.
Comma-separated list of extra data to be included. E.g. metadata,collections.
curl --request GET \
--url https://sandbox-api.violet.io/v1/catalog/offers/merchants/{merchant_id}
{
"content": [
{
"id": 123,
"product_id": "<string>",
"external_id": "<string>",
"external_url": "<string>",
"name": "<string>",
"description": "<string>",
"source": "OTHER",
"seller": "<string>",
"vendor": "<string>",
"merchant_id": 123,
"available": true,
"visible": true,
"min_price": 123,
"max_price": 123,
"currency": "<string>",
"source_category_name": "<string>",
"metadata": [
{
"version": 123,
"type": "STRING",
"external_type": "<string>",
"key": "<string>",
"value": {},
"external_id": "<string>",
"source": "INTERNAL"
}
],
"variants": [
{
"id": 123,
"product_variant_id": "<string>",
"external_id": "<string>",
"name": "<string>",
"visual": true,
"values": [
{
"id": 123,
"product_variant_value_id": "<string>",
"external_id": "<string>",
"name": "<string>",
"sku_ids": [
123
],
"display_order": 123
}
],
"display_order": 123
}
],
"skus": [
{
"id": 123,
"offer_id": 123,
"merchant_id": 123,
"external_id": "<string>",
"name": "<string>",
"asin": "<string>",
"gtin": "<string>",
"upc": "<string>",
"ean": "<string>",
"isbn": "<string>",
"in_stock": true,
"quantity_available": 123,
"inventory_tracked": true,
"sale_price": 123,
"retail_price": 123,
"currency": "<string>",
"presented_currency": "<string>",
"taxable": true,
"tax_type": "DEFAULT",
"albums": [
{
"id": 123,
"parent_id": 123,
"type": "OFFER",
"name": "<string>",
"media": [
{
"id": 123,
"album_id": 123,
"external_id": "<string>",
"cloud_id": "<string>",
"url": "<string>",
"source_url": "<string>",
"type": "IMAGE",
"display_order": 123,
"primary": true
}
],
"primary_media": {
"id": 123,
"album_id": 123,
"external_id": "<string>",
"cloud_id": "<string>",
"url": "<string>",
"source_url": "<string>",
"type": "IMAGE",
"display_order": 123,
"primary": true
}
}
],
"variant_values": [
{
"variant": "<string>",
"value": "<string>"
}
],
"type": "PHYSICAL",
"status": "UNAVAILABLE",
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"sku_dimensions": {
"sku_id": 123,
"weight": 123,
"height": 123,
"width": 123,
"length": 123,
"type": "SKU"
},
"shipping_dimensions": {
"sku_id": 123,
"weight": 123,
"height": 123,
"width": 123,
"length": 123,
"type": "SKU"
},
"display_order": 123
}
],
"albums": [
{
"id": 123,
"parent_id": 123,
"type": "OFFER",
"name": "<string>",
"media": [
{
"id": 123,
"album_id": 123,
"external_id": "<string>",
"cloud_id": "<string>",
"url": "<string>",
"source_url": "<string>",
"type": "IMAGE",
"display_order": 123,
"primary": true
}
],
"primary_media": {
"id": 123,
"album_id": 123,
"external_id": "<string>",
"cloud_id": "<string>",
"url": "<string>",
"source_url": "<string>",
"type": "IMAGE",
"display_order": 123,
"primary": true
}
}
],
"three_d_enabled": true,
"three_d_resource": "<string>",
"type": "PHYSICAL",
"status": "UNAVAILABLE",
"publishing_status": "NOT_PUBLISHED",
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"date_last_consolidated": "2023-11-07T05:31:56Z",
"commission_rate": 123,
"currency_symbol": "<string>",
"presented_currency": "<string>",
"default_image_url": "<string>",
"subscription_status": "NOT_SUBSCRIBED",
"external_data": {},
"collections": [
{
"id": 123,
"external_id": "<string>",
"merchant_id": 123,
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"status": "INACTIVE",
"type": "CUSTOM",
"media": {
"source_url": "<string>",
"alt": "<string>",
"height": 123,
"width": 123,
"date_created": "2023-11-07T05:31:56Z"
},
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z"
}
],
"tags": [
"<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
}
}
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
A date represented in epoch milliseconds (https://www.epochconverter.com/). Gets offers last modified after the given date.
Comma-separated list of extra data to be included. E.g. metadata,collections.
Response
The actual content of the response; A list of the result objects
The parent/container product ID
External ID
External URL
Name of Product in Offer
Product Description
Source Platform
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 Original Vendor
Merchant ID
Is Product Available
Is Product Visible
Minimum Price the Product sells for
Maximum Price the Product 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
ID of the Product Variant
ID of the Variant on the External Ecommerce Platform
Variant Name
Is the variant visual
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.
Product SKUs
ID of the Offer
ID of the Merchant
ID of the SKU on the External Ecom Platform
Sku Name
Amazon Standard Identification Number
Global Trade Item Number
Universal Product Code
European Article Number
International Standard Book Number
Is the Product in Stock
Quantity Available
Is the SKUs inventory tracked
Sale Price of the SKU. This is the actual sale cost of the product is purchased.
Retail Price of the SKU. This is the recommended or common price of the SKU.
The base currency of this SKU
The presented currency of this SKU
Is the product 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
External ID
ID of hosted cloud entity
Media URL
Media Source URL
Media Type
IMAGE
, VIDEO
Display Order
Primary Media
Product and SKU Media
Album ID
External ID
ID of hosted cloud entity
Media URL
Media Source URL
Media Type
IMAGE
, VIDEO
Display Order
Primary Media
Variant Values that apply to this SKU
Variant Name
Variant Value
PHYSICAL
, DIGITAL
, VIRTUAL
, BUNDLED
SKU Status
UNAVAILABLE
, AVAILABLE
, DISABLED_UNAVAILABLE
, DISABLED_AVAILABLE
, FOR_DELETION
, ARCHIVED
Date of SKU creation
Date of last SKU update
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
Order to display SKU
Product Albums
ID of the parent entity
Parent Type
OFFER
, SKU
Name of Album
Album media
Album ID
External ID
ID of hosted cloud entity
Media URL
Media Source URL
Media Type
IMAGE
, VIDEO
Display Order
Primary Media
Product and SKU Media
Album ID
External ID
ID of hosted cloud entity
Media URL
Media Source URL
Media Type
IMAGE
, VIDEO
Display Order
Primary Media
Is the product 3D Enabled
3D Resource Object
Product Type
PHYSICAL
, DIGITAL
, VIRTUAL
, BUNDLED
, PHYSICAL
, DIGITAL
, VIRTUAL
, BUNDLED
Status
UNAVAILABLE
, AVAILABLE
, DISABLED_UNAVAILABLE
, DISABLED_AVAILABLE
, FOR_DELETION
, ARCHIVED
Publishing Status
NOT_PUBLISHED
, PUBLISHED
Date of offer creation
Date of last offer update
Date of last consolidation. This date is jittered for performance reasons and can be in the future
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
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
Collection Media
Source URL
Alt
Height
Width
Date of media creation on platform
Date of creation of this collection on platform
Date of last update of this collection on platform
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
The offset
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
Was this page helpful?
curl --request GET \
--url https://sandbox-api.violet.io/v1/catalog/offers/merchants/{merchant_id}
{
"content": [
{
"id": 123,
"product_id": "<string>",
"external_id": "<string>",
"external_url": "<string>",
"name": "<string>",
"description": "<string>",
"source": "OTHER",
"seller": "<string>",
"vendor": "<string>",
"merchant_id": 123,
"available": true,
"visible": true,
"min_price": 123,
"max_price": 123,
"currency": "<string>",
"source_category_name": "<string>",
"metadata": [
{
"version": 123,
"type": "STRING",
"external_type": "<string>",
"key": "<string>",
"value": {},
"external_id": "<string>",
"source": "INTERNAL"
}
],
"variants": [
{
"id": 123,
"product_variant_id": "<string>",
"external_id": "<string>",
"name": "<string>",
"visual": true,
"values": [
{
"id": 123,
"product_variant_value_id": "<string>",
"external_id": "<string>",
"name": "<string>",
"sku_ids": [
123
],
"display_order": 123
}
],
"display_order": 123
}
],
"skus": [
{
"id": 123,
"offer_id": 123,
"merchant_id": 123,
"external_id": "<string>",
"name": "<string>",
"asin": "<string>",
"gtin": "<string>",
"upc": "<string>",
"ean": "<string>",
"isbn": "<string>",
"in_stock": true,
"quantity_available": 123,
"inventory_tracked": true,
"sale_price": 123,
"retail_price": 123,
"currency": "<string>",
"presented_currency": "<string>",
"taxable": true,
"tax_type": "DEFAULT",
"albums": [
{
"id": 123,
"parent_id": 123,
"type": "OFFER",
"name": "<string>",
"media": [
{
"id": 123,
"album_id": 123,
"external_id": "<string>",
"cloud_id": "<string>",
"url": "<string>",
"source_url": "<string>",
"type": "IMAGE",
"display_order": 123,
"primary": true
}
],
"primary_media": {
"id": 123,
"album_id": 123,
"external_id": "<string>",
"cloud_id": "<string>",
"url": "<string>",
"source_url": "<string>",
"type": "IMAGE",
"display_order": 123,
"primary": true
}
}
],
"variant_values": [
{
"variant": "<string>",
"value": "<string>"
}
],
"type": "PHYSICAL",
"status": "UNAVAILABLE",
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"sku_dimensions": {
"sku_id": 123,
"weight": 123,
"height": 123,
"width": 123,
"length": 123,
"type": "SKU"
},
"shipping_dimensions": {
"sku_id": 123,
"weight": 123,
"height": 123,
"width": 123,
"length": 123,
"type": "SKU"
},
"display_order": 123
}
],
"albums": [
{
"id": 123,
"parent_id": 123,
"type": "OFFER",
"name": "<string>",
"media": [
{
"id": 123,
"album_id": 123,
"external_id": "<string>",
"cloud_id": "<string>",
"url": "<string>",
"source_url": "<string>",
"type": "IMAGE",
"display_order": 123,
"primary": true
}
],
"primary_media": {
"id": 123,
"album_id": 123,
"external_id": "<string>",
"cloud_id": "<string>",
"url": "<string>",
"source_url": "<string>",
"type": "IMAGE",
"display_order": 123,
"primary": true
}
}
],
"three_d_enabled": true,
"three_d_resource": "<string>",
"type": "PHYSICAL",
"status": "UNAVAILABLE",
"publishing_status": "NOT_PUBLISHED",
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"date_last_consolidated": "2023-11-07T05:31:56Z",
"commission_rate": 123,
"currency_symbol": "<string>",
"presented_currency": "<string>",
"default_image_url": "<string>",
"subscription_status": "NOT_SUBSCRIBED",
"external_data": {},
"collections": [
{
"id": 123,
"external_id": "<string>",
"merchant_id": 123,
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"status": "INACTIVE",
"type": "CUSTOM",
"media": {
"source_url": "<string>",
"alt": "<string>",
"height": 123,
"width": 123,
"date_created": "2023-11-07T05:31:56Z"
},
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z"
}
],
"tags": [
"<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
}
}