GET

/v1/catalog/offers/{offer_id}

X-Violet-Token
X-Violet-App-Secret
X-Violet-App-Id
X-Violet-Api-Features
curl --request GET \
  --url https://sandbox-api.violet.io/v1/catalog/offers/{offer_id}
{
  "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"
}

Retrieve a specific Offer given its offer_id.

Headers

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

Path Parameters

offer_idrequired
integer

Query Parameters

base_currency
Default: "USD"
string
exchange_rate
number

Response

200 - application/json
albums
object[]

Product Albums

availablerequired
boolean

Is Product Available

commission_rate
number

Amount given by merchant

currency
string

Base Currency of Offer

currency_symbol
string

Symbol representing the desired currency

date_created
string

Date of offer creation

date_last_modified
string

Date of last offer update

description
string

Product Description

external_id
string

External ID

external_url
string

External URL

id
integer
max_price
integer

Maximum Price the Product sells for

merchant_idrequired
integer

Merchant ID

meta
object[]

Additional Meta Data of the Offer

min_pricerequired
integer

Minimum Price the Product sells for

namerequired
string

Name of Product in Offer

presented_currency
string

The presented currency of this SKU

product_idrequired
string

The parent/container product ID

publishing_status
enum<string>

Publishing Status

Available options:
NOT_PUBLISHED,
PUBLISHED
seller
string

Name of Merchant Selling Product

size_unit
enum<string>

Size Unit

Available options:
MILLIMETERS,
CENTIMETERS,
INCHES,
FEET,
METERS,
YARDS
skus
object[]

Product SKUs

sourcerequired
enum<string>

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,
DIGITALRIVER,
CUSTOM
source_category_name
string

Original Category on Source Platform

status
enum<string>

Status

Available options:
AVAILABLE,
UNAVAILABLE,
DISABLED_AVAILABLE,
DISABLED_UNAVAILABLE,
ARCHIVED,
FOR_DELETION
subscription_status
enum<string>

Subscription status

Available options:
NOT_SUBSCRIBED,
SUBSCRIBED
tags
string[]
three_d_enables
boolean

Is the product 3D Enabled

three_d_resource
string

3D Resource Object

type
enum<string>

Product Type

Available options:
PHYSICAL,
DIGITAL,
VIRTUAL
variants
object[]

Product Variations

vendor
string

Name of Original Vendor

visiblerequired
boolean

Is Product Visible

weight_unit
enum<string>

Weight Unit

Available options:
OUNCES,
POUNDS,
GRAMS,
KILOGRAMS,
CARATS,
TONNES,
MILLIGRAMS,
LITERS,
MILLILITERS,
QUARTS,
QUARTERS,
GALLONS,
PINTS