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

403

insufficient permissions

application/json

404

offer not found

application/json

get

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": "2025-07-30T10:05:31.660Z",
      "date_last_modified": "2025-07-30T10:05:31.660Z",
      "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": "2025-07-30T10:05:31.660Z",
  "date_last_modified": "2025-07-30T10:05:31.660Z",
  "date_last_consolidated": "2025-07-30T10:05:31.660Z",
  "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": "2025-07-30T10:05:31.660Z"
      },
      "date_created": "2025-07-30T10:05:31.660Z",
      "date_last_modified": "2025-07-30T10:05:31.660Z"
    }
  ],
  "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"
  ]
}