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": "<string>",
"vendor": "<string>",
"merchant_id": 123,
"available": true,
"visible": true,
"min_price": 123,
"max_price": 123,
"currency": "<string>",
"source_category_name": "<string>",
"meta": [],
"variants": [],
"skus": [],
"albums": [],
"three_d_enables": true,
"three_d_resource": "<string>",
"type": "PHYSICAL",
"status": "AVAILABLE",
"publishing_status": "NOT_PUBLISHED",
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"commission_rate": 123,
"weight_unit": "OUNCES",
"size_unit": "MILLIMETERS",
"currency_symbol": "<string>",
"presented_currency": "<string>",
"subscription_status": "NOT_SUBSCRIBED",
"tags": []
}
],
"last": true,
"total_pages": 123,
"total_elements": 123,
"first": true,
"number_of_elements": 123,
"size": 123,
"number": 123,
"empty": true,
"next_page_cursor": "<string>"
}
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
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 merchants 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
Response
The actual content of the response; A list of the result objects
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.
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>",
"meta": [],
"variants": [],
"skus": [],
"albums": [],
"three_d_enables": true,
"three_d_resource": "<string>",
"type": "PHYSICAL",
"status": "AVAILABLE",
"publishing_status": "NOT_PUBLISHED",
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"commission_rate": 123,
"weight_unit": "OUNCES",
"size_unit": "MILLIMETERS",
"currency_symbol": "<string>",
"presented_currency": "<string>",
"subscription_status": "NOT_SUBSCRIBED",
"tags": []
}
],
"last": true,
"total_pages": 123,
"total_elements": 123,
"first": true,
"number_of_elements": 123,
"size": 123,
"number": 123,
"empty": true,
"next_page_cursor": "<string>"
}