Get Offers for a Merchant

Note: For more details on this endpoint and the other possible filter options it can take, please refer to the API Reference

When retrieving Offers, if you provide the base_currency query parameter the currency in the Offer object will match what was passed in and all prices will reflect that currency. The default currency when no parameter is provided is USD.

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

X-Violet-Token

string

X-Violet-App-Secret

string

X-Violet-App-Id

integer

X-Violet-Api-Features

string

Path Parameters

merchant_id

integer

required

Query Parameters

since

integer

A date represented in epoch milliseconds (https://www.epochconverter.com/). Gets offers last modified after the given date.

page

integer

default: 1

size

integer

default: 20

map_variants

boolean

default: true

base_currency

string

include

string

Comma-separated list of extra data to be included. E.g. metadata,collections.

Response

default - application/json

content

object[]

The actual content of the response; A list of the result objects

content.id

integer

content.product_id

string

required

The parent/container product ID

content.external_id

string

External ID

content.external_url

string

External URL

content.name

string

required

Name of Product in Offer

content.description

string

Product Description

content.source

enum<string>

required

Source Platform

Available options:

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

content.seller

string

Name of Merchant Selling Product

content.vendor

string

Name of Original Vendor

content.merchant_id

integer

required

Merchant ID

content.available

boolean

required

Is Product Available

content.visible

boolean

required

Is Product Visible

content.min_price

integer

required

Minimum Price the Product sells for

content.max_price

integer

Maximum Price the Product sells for

content.currency

string

Base Currency of Offer. Intended for reference only. The currency property of the SKU is the currency source of truth.

content.source_category_name

string

Original Category on Source Platform

content.metadata

object[]

Additional Meta Data of the Offer

content.variants

object[]

Product Variations

content.skus

object[]

Product SKUs

content.skus.id

integer

content.skus.offer_id

integer

required

ID of the Offer

content.skus.merchant_id

integer

required

ID of the Merchant

content.skus.external_id

string

ID of the SKU on the External Ecom Platform

content.skus.name

string

Sku Name

content.skus.asin

string

Amazon Standard Identification Number

content.skus.gtin

string

Global Trade Item Number

content.skus.upc

string

Universal Product Code

content.skus.ean

string

European Article Number

content.skus.isbn

string

International Standard Book Number

content.skus.in_stock

boolean

Is the Product in Stock

content.skus.quantity_available

integer

Quantity Available

content.skus.inventory_tracked

boolean

Is the SKUs inventory tracked

content.skus.sale_price

integer

required

Sale Price of the SKU. This is the actual sale cost of the product is purchased.

content.skus.retail_price

integer

Retail Price of the SKU. This is the recommended or common price of the SKU.

content.skus.currency

string

required

The base currency of this SKU

content.skus.presented_currency

string

The presented currency of this SKU

content.skus.taxable

boolean

Is the product taxable

content.skus.tax_type

enum<string>

Type of Tax on this SKU

Available options:

DEFAULT,

APPAREL,

SERVICE

content.skus.albums

object[]

Sku Albums

content.skus.variant_values

object[]

Variant Values that apply to this SKU

content.skus.type

enum<string>

required

Available options:

PHYSICAL,

DIGITAL,

VIRTUAL,

BUNDLED

content.skus.status

enum<string>

SKU Status

Available options:

UNAVAILABLE,

AVAILABLE,

DISABLED_UNAVAILABLE,

DISABLED_AVAILABLE,

FOR_DELETION,

ARCHIVED

content.skus.date_created

string

Date of SKU creation

content.skus.date_last_modified

string

Date of last SKU update

content.skus.sku_dimensions

object

Individual Sku Dimensions

content.skus.shipping_dimensions

object

Individual Sku Dimensions

content.skus.display_order

integer

Order to display SKU

content.albums

object[]

Product Albums

content.three_d_enabled

boolean

Is the product 3D Enabled

content.three_d_resource

string

3D Resource Object

content.type

enum<string>

Product Type

Available options:

PHYSICAL,

DIGITAL,

VIRTUAL,

BUNDLED,

PHYSICAL,

DIGITAL,

VIRTUAL,

BUNDLED

content.status

enum<string>

Status

Available options:

UNAVAILABLE,

AVAILABLE,

DISABLED_UNAVAILABLE,

DISABLED_AVAILABLE,

FOR_DELETION,

ARCHIVED

content.publishing_status

enum<string>

Publishing Status

Available options:

NOT_PUBLISHED,

PUBLISHED

content.date_created

string

Date of offer creation

content.date_last_modified

string

Date of last offer update

content.date_last_consolidated

string

Date of last consolidation. This date is jittered for performance reasons and can be in the future

content.commission_rate

number

Amount given by merchant

content.currency_symbol

string

Symbol representing the desired currency

content.presented_currency

string

The presented currency of this SKU

content.default_image_url

string

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.

content.subscription_status

enum<string>

Subscription status

Available options:

NOT_SUBSCRIBED,

SUBSCRIBED

content.external_data

object

The raw external product data from the external commerce platform

content.collections

object[]

Collections this offer belongs to

content.tags

string[]

last

boolean

Boolean indicating if this is the last page

total_pages

integer

The total count of pages available

total_elements

integer

The total count of objects available

first

boolean

Boolean indicating if this is the first page of the response

number_of_elements

integer

The total number of objects in this specific response

size

integer

The page size selected at request time

number

integer

The page number selected at request time

empty

boolean

Boolean indicating if the response content is empty

next_page_cursor

string

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.

pageable

object

Violet wrapper for springframework pageable

sort

object

Violet Wrapper for springframework sort

Introduction

Getting Started

Checkout

Violet Connect

Relay

Product Info

Support

Headers

Path Parameters

Query Parameters

Response