Get All Merchant Offers (Lightweight)

Retrieve a lightweight list of all Offer's for a Merchant, given their merchant_id. Unlike the standard endpoint, this version does not eagerly load SKUs, variants, or albums, significantly reducing payload size and response time.

Use this endpoint when you only need offer-level fields such as name, price, merchant, and status — for example, in dashboard views or listing pages.

This endpoint supports the same filtering, pagination, and currency parameters as the standard Get All Merchant Offers endpoint. Maximum page size is 100.

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.

Get Merchant Offers - V1.1

get

Lightweight version that returns offer data without SKUs, variants, or albums. Maximum size limit of 100 results.

Path parameters
merchant_idinteger · int32Required
Query parameters
pageinteger · int32OptionalDefault: 1
sizeinteger · int32 · max: 100Optional

The total number of desired results. Any value over 100 will default to 100.

Default: 20
base_currencystringOptional
includestring · enumOptional

Comma-separated list of extra data to be included.

Possible values:
date_last_modified:minstringOptional

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

Example: 2017-06-15T01:01:01+0000
date_last_modified:maxstringOptional

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

Example: 2017-06-25T01:01:01+0000
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
X-Violet-Api-FeaturesstringOptional
Responses
get
/catalog/offers/merchants/{merchant_id}/v1.1
default

default response

Last updated

Was this helpful?