Overview
Login
- Access
Merchants
- Merchant
- Configuration
- Onboarding
- 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
Payments
- Payout Accounts
- Distributions
- Transfers
Events
- Webhooks
- Webhook Events
- Webhook Headers
Apps
- Merchant/App Installs
- Commission Rates
Operations
- Connection
Relay
- Shipping
Ecom Syncs
- Offers
Get All Merchant Offers
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": "Foot Locker",
"vendor": "Nike",
"merchant_id": 123,
"available": true,
"visible": true,
"min_price": 123,
"max_price": 123,
"currency": "<string>",
"external_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,
"qty_available": 123,
"inventory_tracked": true,
"sale_price": 123,
"retail_price": 123,
"currency": "<string>",
"external_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,
"alt_text": "<string>",
"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,
"alt_text": "<string>",
"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"
},
"metadata": [
{
"version": 123,
"type": "STRING",
"external_type": "<string>",
"key": "<string>",
"value": {},
"external_id": "<string>",
"source": "INTERNAL"
}
],
"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,
"alt_text": "<string>",
"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,
"alt_text": "<string>",
"primary": true
}
}
],
"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",
"three_d_enabled": false,
"three_d_resource": "<string>",
"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,
"parent_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"
}
],
"shipping": {
"message": "<string>",
"methods": [
{
"external_id": "<string>",
"name": "<string>",
"price": {
"amount": 123,
"currency": "USD"
},
"regions": {
"countries": [
"US"
]
},
"conditions": [
{
"price": {
"amount": 123,
"currency": "USD"
},
"weight": {
"value": 123,
"unit": "INCHES"
},
"type": "TOTAL_PRICE",
"operator": "LESS_THAN_OR_EQUAL_TO"
}
]
}
]
},
"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
Use date_last_modified:min
.
The total number of desired results. Any value over 100
will default to 100
.
x <= 100
Comma-separated list of extra data to be included.
metadata
, collections
, shipping
, sku_metadata
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
"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
"2017-06-25T01:01:01+0000"
Response
The response is of type object
.
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": "Foot Locker",
"vendor": "Nike",
"merchant_id": 123,
"available": true,
"visible": true,
"min_price": 123,
"max_price": 123,
"currency": "<string>",
"external_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,
"qty_available": 123,
"inventory_tracked": true,
"sale_price": 123,
"retail_price": 123,
"currency": "<string>",
"external_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,
"alt_text": "<string>",
"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,
"alt_text": "<string>",
"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"
},
"metadata": [
{
"version": 123,
"type": "STRING",
"external_type": "<string>",
"key": "<string>",
"value": {},
"external_id": "<string>",
"source": "INTERNAL"
}
],
"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,
"alt_text": "<string>",
"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,
"alt_text": "<string>",
"primary": true
}
}
],
"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",
"three_d_enabled": false,
"three_d_resource": "<string>",
"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,
"parent_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"
}
],
"shipping": {
"message": "<string>",
"methods": [
{
"external_id": "<string>",
"name": "<string>",
"price": {
"amount": 123,
"currency": "USD"
},
"regions": {
"countries": [
"US"
]
},
"conditions": [
{
"price": {
"amount": 123,
"currency": "USD"
},
"weight": {
"value": 123,
"unit": "INCHES"
},
"type": "TOTAL_PRICE",
"operator": "LESS_THAN_OR_EQUAL_TO"
}
]
}
]
},
"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
}
}