POST

/v1/catalog/offers/search

X-Violet-Token
X-Violet-App-Secret
X-Violet-App-Id
curl --request POST \
  --url https://sandbox-api.violet.io/v1/catalog/offers/search \
  --header 'Content-Type: application/json'
{
  "content": [
    {
      "albums": [
        {
          "id": "integer",
          "media": [
            {
              "album_id": "integer",
              "cloud_id": "string",
              "display_order": "integer",
              "external_id": "string",
              "id": "integer",
              "primary": "boolean",
              "source_url": "string",
              "type": "IMAGE",
              "url": "string"
            }
          ],
          "name": "string",
          "parent_id": "integer",
          "primary_media": {
            "album_id": "integer",
            "cloud_id": "string",
            "display_order": "integer",
            "external_id": "string",
            "id": "integer",
            "primary": "boolean",
            "source_url": "string",
            "type": "IMAGE",
            "url": "string"
          },
          "type": "OFFER"
        }
      ],
      "available": "boolean",
      "commission_rate": "number",
      "currency": "string",
      "currency_symbol": "string",
      "date_created": "string",
      "date_last_modified": "string",
      "description": "string",
      "external_id": "string",
      "external_url": "string",
      "id": "integer",
      "max_price": "integer",
      "merchant_id": "integer",
      "meta": [
        {
          "id": "integer",
          "key": "string",
          "offer_id": "integer",
          "value": "string"
        }
      ],
      "min_price": "integer",
      "name": "string",
      "presented_currency": "string",
      "product_id": "string",
      "publishing_status": "NOT_PUBLISHED",
      "seller": "string",
      "size_unit": "MILLIMETERS",
      "skus": [
        {
          "albums": [
            {
              "id": "integer",
              "media": [
                {
                  "album_id": "integer",
                  "cloud_id": "string",
                  "display_order": "integer",
                  "external_id": "string",
                  "id": "integer",
                  "primary": "boolean",
                  "source_url": "string",
                  "type": "IMAGE",
                  "url": "string"
                }
              ],
              "name": "string",
              "parent_id": "integer",
              "primary_media": {
                "album_id": "integer",
                "cloud_id": "string",
                "display_order": "integer",
                "external_id": "string",
                "id": "integer",
                "primary": "boolean",
                "source_url": "string",
                "type": "IMAGE",
                "url": "string"
              },
              "type": "OFFER"
            }
          ],
          "asin": "string",
          "currency": "string",
          "date_created": "string",
          "date_last_modified": "string",
          "display_order": "integer",
          "ean": "string",
          "external_id": "string",
          "gtin": "string",
          "id": "integer",
          "in_stock": "boolean",
          "inventory_tracked": "boolean",
          "isbn": "string",
          "merchant_id": "integer",
          "name": "string",
          "offer_id": "integer",
          "presented_currency": "string",
          "quantity_available": "integer",
          "retail_price": "integer",
          "sale_price": "integer",
          "sku_dimensions": {
            "height": "number",
            "length": "number",
            "sku_id": "integer",
            "type": "SKU",
            "weight": "number",
            "width": "number"
          },
          "status": "AVAILABLE",
          "tax_type": "default",
          "taxable": "boolean",
          "type": "physical",
          "upc": "string",
          "variant_values": [
            {
              "value": "string",
              "variant": "string"
            }
          ]
        }
      ],
      "source": "OTHER",
      "source_category_name": "string",
      "status": "AVAILABLE",
      "subscription_status": "NOT_SUBSCRIBED",
      "tags": [
        "string"
      ],
      "three_d_enables": "boolean",
      "three_d_resource": "string",
      "type": "PHYSICAL",
      "variants": [
        {
          "external_id": "string",
          "id": "integer",
          "name": "string",
          "product_variant_id": "string",
          "values": [
            {
              "external_id": "string",
              "id": "integer",
              "name": "string",
              "product_variant_value_id": "string",
              "sku_ids": [
                "integer"
              ]
            }
          ],
          "visual": "boolean"
        }
      ],
      "vendor": "string",
      "visible": "boolean",
      "weight_unit": "OUNCES"
    }
  ],
  "empty": "boolean",
  "first": "boolean",
  "last": "boolean",
  "number": "integer",
  "number_of_elements": "integer",
  "pageable": {
    "offset": "integer",
    "page_number": "integer",
    "page_size": "integer",
    "paged": "boolean",
    "sort": {
      "empty": "boolean",
      "sorted": "boolean",
      "unsorted": "boolean"
    },
    "unpaged": "boolean"
  },
  "size": "integer",
  "sort": {
    "empty": "boolean",
    "sorted": "boolean",
    "unsorted": "boolean"
  },
  "total_elements": "integer",
  "total_pages": "integer"
}

Retrieve a list of Offer’s that match a set of filter criteria. These Offers are limited to the Merchants that you are connected to.

Offer Search also provides a new beta experience that you can use by adding in the beta=true flag as a query parameter.

You can then pass in additional filter criteria, such as the query field, which performs AI based search across all Offers you have access to.

Headers

X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer

Query Parameters

page
Default: "1"
integer
size
Default: "20"
integer
exclude_public
Default: false
boolean
exclude_hidden
Default: true
boolean

Body

application/json
external_id
string

External ID

id
integer
max_price
integer

Maximum Price

merchant_id
integer
min_price
integer

Minimum Price

name
string

Name of Product in Offer

product_id
string

The parent/container product ID

publishing_status
string

Publishing status

seller
string

Name of Merchant Selling Product

sort_by
string

Property to sort by in camelCase

sort_direction
string

Direction to sort by

subscription_status
string

Subscription status

vendor
string

Name of Original Vendor (Brand)

Response

200 - application/json
content
object[]
empty
boolean
first
boolean
last
boolean
number
integer
number_of_elements
integer
pageable
object
size
integer
sort
object
total_elements
integer
total_pages
integer
Get Offer by IDGet Sku by ID