Get All Merchant Offers
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.
Use date_last_modified:min
.
1
The total number of desired results. Any value over 100
will default to 100
.
20
true
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
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
GET /v1/catalog/offers/merchants/{merchant_id} HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Accept: */*
default response
{
"content": [
{
"id": 1,
"external_id": "text",
"external_url": "text",
"name": "text",
"description": "text",
"source": "OTHER",
"seller": "Foot Locker",
"vendor": "Nike",
"merchant_id": 1,
"available": true,
"visible": true,
"min_price": 1,
"max_price": 1,
"currency": "text",
"external_currency": "text",
"source_category_name": "text",
"metadata": [
{
"version": 1,
"type": "STRING",
"external_type": "text",
"key": "text",
"value": {},
"external_id": "text",
"source": "INTERNAL"
}
],
"variants": [
{
"id": 1,
"external_id": "text",
"name": "text",
"visual": true,
"values": [
{
"id": 1,
"product_variant_value_id": "text",
"external_id": "text",
"name": "text",
"sku_ids": [
1
],
"display_order": 1
}
],
"display_order": 1
}
],
"skus": [
{
"id": 1,
"offer_id": 1,
"merchant_id": 1,
"external_id": "text",
"name": "text",
"asin": "text",
"gtin": "text",
"upc": "text",
"ean": "text",
"isbn": "text",
"in_stock": true,
"qty_available": 1,
"inventory_tracked": true,
"sale_price": 1,
"retail_price": 1,
"currency": "text",
"external_currency": "text",
"presented_currency": "text",
"taxable": true,
"tax_type": "DEFAULT",
"albums": [
{
"id": 1,
"parent_id": 1,
"type": "OFFER",
"name": "text",
"media": [
{
"id": 1,
"album_id": 1,
"external_id": "text",
"cloud_id": "text",
"url": "text",
"source_url": "text",
"type": "IMAGE",
"display_order": 1,
"alt_text": "text",
"primary": true
}
],
"primary_media": {
"id": 1,
"album_id": 1,
"external_id": "text",
"cloud_id": "text",
"url": "text",
"source_url": "text",
"type": "IMAGE",
"display_order": 1,
"alt_text": "text",
"primary": true
}
}
],
"variant_values": [
{
"variant": "text",
"value": "text"
}
],
"type": "PHYSICAL",
"status": "UNAVAILABLE",
"date_created": "2025-07-10T06:32:55.318Z",
"date_last_modified": "2025-07-10T06:32:55.318Z",
"sku_dimensions": {
"sku_id": 1,
"weight": 1,
"height": 1,
"width": 1,
"length": 1,
"type": "SKU"
},
"shipping_dimensions": {
"sku_id": 1,
"weight": 1,
"height": 1,
"width": 1,
"length": 1,
"type": "SKU"
},
"metadata": [
{
"version": 1,
"type": "STRING",
"external_type": "text",
"key": "text",
"value": {},
"external_id": "text",
"source": "INTERNAL"
}
],
"display_order": 1
}
],
"albums": [
{
"id": 1,
"parent_id": 1,
"type": "OFFER",
"name": "text",
"media": [
{
"id": 1,
"album_id": 1,
"external_id": "text",
"cloud_id": "text",
"url": "text",
"source_url": "text",
"type": "IMAGE",
"display_order": 1,
"alt_text": "text",
"primary": true
}
],
"primary_media": {
"id": 1,
"album_id": 1,
"external_id": "text",
"cloud_id": "text",
"url": "text",
"source_url": "text",
"type": "IMAGE",
"display_order": 1,
"alt_text": "text",
"primary": true
}
}
],
"type": "PHYSICAL",
"status": "UNAVAILABLE",
"publishing_status": "NOT_PUBLISHED",
"date_created": "2025-07-10T06:32:55.318Z",
"date_last_modified": "2025-07-10T06:32:55.318Z",
"date_last_consolidated": "2025-07-10T06:32:55.318Z",
"three_d_enabled": false,
"three_d_resource": "text",
"commission_rate": 1,
"currency_symbol": "text",
"presented_currency": "text",
"default_image_url": "text",
"subscription_status": "NOT_SUBSCRIBED",
"external_data": {},
"collections": [
{
"id": 1,
"external_id": "text",
"merchant_id": 1,
"parent_id": 1,
"name": "text",
"handle": "text",
"description": "text",
"status": "INACTIVE",
"type": "CUSTOM",
"media": {
"source_url": "text",
"alt": "text",
"height": 1,
"width": 1,
"date_created": "2025-07-10T06:32:55.318Z"
},
"date_created": "2025-07-10T06:32:55.318Z",
"date_last_modified": "2025-07-10T06:32:55.318Z"
}
],
"shipping": {
"message": "text",
"methods": [
{
"external_id": "text",
"name": "text",
"price": {
"amount": 1,
"currency": "USD"
},
"regions": {
"countries": [
"US"
]
},
"conditions": [
{
"price": {
"amount": 1,
"currency": "USD"
},
"weight": {
"value": 1,
"unit": "INCHES"
},
"type": "TOTAL_PRICE",
"operator": "LESS_THAN_OR_EQUAL_TO"
}
]
}
]
},
"tags": [
"text"
]
}
],
"last": true,
"total_pages": 1,
"total_elements": 1,
"first": true,
"number_of_elements": 1,
"size": 1,
"number": 1,
"empty": true,
"next_page_cursor": "text",
"pageable": {
"page_number": 1,
"page_size": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"offset": 1,
"paged": true,
"unpaged": true
},
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
}
}
Last updated
Was this helpful?