Get Offer by ID

Retrieve a specific Offer given its offer_id.

This endpoint supports collections and metadata. Use the include query param.

Get Offer by ID

get

Path parameters

offer_idinteger · int64Required

Query parameters

base_currencystringOptionalDefault: USD

exchange_ratenumber · doubleOptional

includestring · enumOptional

Comma-separated list of extra data to be included.

Possible values:

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

X-Violet-Api-FeaturesstringOptional

Responses

200

successful operation

application/json

Product Offer

idinteger · int64Read-onlyOptional

Unique ID of the Offer.

product_idstringOptionalDeprecated

The parent/container product ID. Note: this is a legacy property and is now considered deprecated.

external_idstringOptional

The ID of the product in the merchants external store.

external_urlstringOptional

The URL to the product page in the merchants store. Note: if the value for visible is false this URL will likely result in a 404.

namestringOptional

Name of the offer.

descriptionstring · max: 65000 · nullableOptional

Description of the offer. Note: this value may contain HTML elements.

sourcestring · enumOptional

Commerce platform the offer was sourced from.

Possible values:

sellerstring · nullableOptional

Name of the merchant selling product.

Example: Foot Locker

vendorstring · nullableOptional

Name of the source vendor or brand.

Example: Nike

merchant_idinteger · int32Optional

ID of the merchant who sourced this Offer.

availablebooleanOptional

Is the product currently available for purchase in the merchants system.

visiblebooleanOptional

Is the product visible or hidden in the merchants storefront. Note: a product can be hidden while still being available for purchase.

min_priceinteger · int32Optional

Minimum price the Offer sells for. This is the lowest of the Sku sale prices.

max_priceinteger · int32Optional

Maximum price the Offer sells for. This is the highest of the Sku sale prices.

currencystringOptional

The currency of the Offer. By default this value will be the merchants currency but can be changed by the API user using a base_currency parameter.

external_currencystringOptional

The external currency of the Offer. This value is the associated merchants default currency.

source_category_namestring · nullableOptional

Original Category on Source Platform

typestring · enumOptional

Type of product. Note: Offers with a type of BUNDLED cannot be purchased through the API at this time due to ecom platform limitations.

Possible values:

statusstring · enumOptional

Current status of the Offer.

Possible values:

publishing_statusstring · enumOptional

Publishing Status

Possible values:

date_createdstring · date-timeOptional

Date of offer creation in ISO 8601 format.

date_last_modifiedstring · date-timeOptional

Date of last offer update in ISO 8601 format.

date_last_consolidatedstring · date-timeOptional

Date of last consolidation in ISO 8601 format. Consolidation is the process of querying the merchants store to see if this product still exists. This date is jittered for performance reasons and can be in the future.

three_d_enabledboolean · nullableOptional

Is the product 3D Enabled

Default: false

three_d_resourcestring · nullableOptional

3D Resource Object

commission_ratenumber · doubleOptional

Amount given by merchant

currency_symbolstring · nullableOptional

Symbol representing the desired currency

presented_currencystringOptional

The presented currency of this SKU

default_image_urlstringOptional

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.

subscription_statusstring · enumOptional

Subscription status

Possible values:

external_dataobjectOptional

The raw external product data from the external commerce platform. This data is not pre-processed by Violet and is only provided for reference when using using the Violet Relay API.

tagsstring[]Optional

403

insufficient permissions

application/json

404

offer not found

application/json

get

/catalog/offers/{offer_id}

HTTPcURLJavaScriptPython

GET /v1/catalog/offers/{offer_id} HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Accept: */*

{
  "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": "2026-02-22T06:24:40.749Z",
      "date_last_modified": "2026-02-22T06:24:40.749Z",
      "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": "2026-02-22T06:24:40.749Z",
  "date_last_modified": "2026-02-22T06:24:40.749Z",
  "date_last_consolidated": "2026-02-22T06:24:40.749Z",
  "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": "2026-02-22T06:24:40.749Z"
      },
      "date_created": "2026-02-22T06:24:40.749Z",
      "date_last_modified": "2026-02-22T06:24:40.749Z"
    }
  ],
  "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"
  ]
}