Get Offer by ID

GET

catalog

offers

{offer_id}

curl --request GET \
  --url https://sandbox-api.violet.io/v1/catalog/offers/{offer_id}

{
  "id": 123,
  "product_id": "<string>",
  "external_id": "<string>",
  "external_url": "<string>",
  "name": "<string>",
  "description": "<string>",
  "source": "OTHER",
  "seller": "<string>",
  "vendor": "<string>",
  "merchant_id": 123,
  "available": true,
  "visible": true,
  "min_price": 123,
  "max_price": 123,
  "currency": "<string>",
  "source_category_name": "<string>",
  "metadata": [
    {
      "version": 123,
      "type": "STRING",
      "external_type": "<string>",
      "key": "<string>",
      "value": {},
      "external_id": "<string>",
      "source": "INTERNAL"
    }
  ],
  "variants": [
    {
      "id": 123,
      "product_variant_id": "<string>",
      "external_id": "<string>",
      "name": "<string>",
      "visual": true,
      "values": [
        {
          "id": 123,
          "product_variant_value_id": "<string>",
          "external_id": "<string>",
          "name": "<string>",
          "sku_ids": [
            123
          ],
          "display_order": 123
        }
      ],
      "display_order": 123
    }
  ],
  "skus": [
    {
      "id": 123,
      "offer_id": 123,
      "merchant_id": 123,
      "external_id": "<string>",
      "name": "<string>",
      "asin": "<string>",
      "gtin": "<string>",
      "upc": "<string>",
      "ean": "<string>",
      "isbn": "<string>",
      "in_stock": true,
      "quantity_available": 123,
      "inventory_tracked": true,
      "sale_price": 123,
      "retail_price": 123,
      "currency": "<string>",
      "presented_currency": "<string>",
      "taxable": true,
      "tax_type": "DEFAULT",
      "albums": [
        {
          "id": 123,
          "parent_id": 123,
          "type": "OFFER",
          "name": "<string>",
          "media": [
            {
              "id": 123,
              "album_id": 123,
              "external_id": "<string>",
              "cloud_id": "<string>",
              "url": "<string>",
              "source_url": "<string>",
              "type": "IMAGE",
              "display_order": 123,
              "primary": true
            }
          ],
          "primary_media": {
            "id": 123,
            "album_id": 123,
            "external_id": "<string>",
            "cloud_id": "<string>",
            "url": "<string>",
            "source_url": "<string>",
            "type": "IMAGE",
            "display_order": 123,
            "primary": true
          }
        }
      ],
      "variant_values": [
        {
          "variant": "<string>",
          "value": "<string>"
        }
      ],
      "type": "PHYSICAL",
      "status": "UNAVAILABLE",
      "date_created": "2023-11-07T05:31:56Z",
      "date_last_modified": "2023-11-07T05:31:56Z",
      "sku_dimensions": {
        "sku_id": 123,
        "weight": 123,
        "height": 123,
        "width": 123,
        "length": 123,
        "type": "SKU"
      },
      "shipping_dimensions": {
        "sku_id": 123,
        "weight": 123,
        "height": 123,
        "width": 123,
        "length": 123,
        "type": "SKU"
      },
      "display_order": 123
    }
  ],
  "albums": [
    {
      "id": 123,
      "parent_id": 123,
      "type": "OFFER",
      "name": "<string>",
      "media": [
        {
          "id": 123,
          "album_id": 123,
          "external_id": "<string>",
          "cloud_id": "<string>",
          "url": "<string>",
          "source_url": "<string>",
          "type": "IMAGE",
          "display_order": 123,
          "primary": true
        }
      ],
      "primary_media": {
        "id": 123,
        "album_id": 123,
        "external_id": "<string>",
        "cloud_id": "<string>",
        "url": "<string>",
        "source_url": "<string>",
        "type": "IMAGE",
        "display_order": 123,
        "primary": true
      }
    }
  ],
  "three_d_enabled": true,
  "three_d_resource": "<string>",
  "type": "PHYSICAL",
  "status": "UNAVAILABLE",
  "publishing_status": "NOT_PUBLISHED",
  "date_created": "2023-11-07T05:31:56Z",
  "date_last_modified": "2023-11-07T05:31:56Z",
  "date_last_consolidated": "2023-11-07T05:31:56Z",
  "commission_rate": 123,
  "currency_symbol": "<string>",
  "presented_currency": "<string>",
  "default_image_url": "<string>",
  "subscription_status": "NOT_SUBSCRIBED",
  "external_data": {},
  "collections": [
    {
      "id": 123,
      "external_id": "<string>",
      "merchant_id": 123,
      "name": "<string>",
      "handle": "<string>",
      "description": "<string>",
      "status": "INACTIVE",
      "type": "CUSTOM",
      "media": {
        "source_url": "<string>",
        "alt": "<string>",
        "height": 123,
        "width": 123,
        "date_created": "2023-11-07T05:31:56Z"
      },
      "date_created": "2023-11-07T05:31:56Z",
      "date_last_modified": "2023-11-07T05:31:56Z"
    }
  ],
  "tags": [
    "<string>"
  ]
}

Retrieve a specific Offer given its offer_id.

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

Headers

X-Violet-Token

string

X-Violet-App-Secret

string

X-Violet-App-Id

integer

X-Violet-Api-Features

string

Path Parameters

offer_id

integer

required

Query Parameters

base_currency

string

default: USD

exchange_rate

number

include

string

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

Response

default - application/json

integer

product_id

string

required

The parent/container product ID

external_id

string

External ID

external_url

string

External URL

name

string

required

Name of Product in Offer

description

string

Product Description

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

seller

string

Name of Merchant Selling Product

vendor

string

Name of Original Vendor

merchant_id

integer

required

Merchant ID

available

boolean

required

Is Product Available

visible

boolean

required

Is Product Visible

min_price

integer

required

Minimum Price the Product sells for

max_price

integer

Maximum Price the Product sells for

currency

string

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

source_category_name

string

Original Category on Source Platform

metadata

object[]

Additional Meta Data of the Offer

variants

object[]

Product Variations

skus

object[]

Product SKUs

skus.id

integer

skus.offer_id

integer

required

ID of the Offer

skus.merchant_id

integer

required

ID of the Merchant

skus.external_id

string

ID of the SKU on the External Ecom Platform

skus.name

string

Sku Name

skus.asin

string

Amazon Standard Identification Number

skus.gtin

string

Global Trade Item Number

skus.upc

string

Universal Product Code

skus.ean

string

European Article Number

skus.isbn

string

International Standard Book Number

skus.in_stock

boolean

Is the Product in Stock

skus.quantity_available

integer

Quantity Available

skus.inventory_tracked

boolean

Is the SKUs inventory tracked

skus.sale_price

integer

required

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

skus.retail_price

integer

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

skus.currency

string

required

The base currency of this SKU

skus.presented_currency

string

The presented currency of this SKU

skus.taxable

boolean

Is the product taxable

skus.tax_type

enum<string>

Type of Tax on this SKU

Available options:

DEFAULT,

APPAREL,

SERVICE

skus.albums

object[]

Sku Albums

skus.variant_values

object[]

Variant Values that apply to this SKU

skus.type

enum<string>

required

Available options:

PHYSICAL,

DIGITAL,

VIRTUAL,

BUNDLED

skus.status

enum<string>

SKU Status

Available options:

UNAVAILABLE,

AVAILABLE,

DISABLED_UNAVAILABLE,

DISABLED_AVAILABLE,

FOR_DELETION,

ARCHIVED

skus.date_created

string

Date of SKU creation

skus.date_last_modified

string

Date of last SKU update

skus.sku_dimensions

object

Individual Sku Dimensions

skus.shipping_dimensions

object

Individual Sku Dimensions

skus.display_order

integer

Order to display SKU

albums

object[]

Product Albums

three_d_enabled

boolean

Is the product 3D Enabled

three_d_resource

string

3D Resource Object

type

enum<string>

Product Type

Available options:

PHYSICAL,

DIGITAL,

VIRTUAL,

BUNDLED,

PHYSICAL,

DIGITAL,

VIRTUAL,

BUNDLED

status

enum<string>

Status

Available options:

UNAVAILABLE,

AVAILABLE,

DISABLED_UNAVAILABLE,

DISABLED_AVAILABLE,

FOR_DELETION,

ARCHIVED

publishing_status

enum<string>

Publishing Status

Available options:

NOT_PUBLISHED,

PUBLISHED

date_created

string

Date of offer creation

date_last_modified

string

Date of last offer update

date_last_consolidated

string

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

commission_rate

number

Amount given by merchant

currency_symbol

string

Symbol representing the desired currency

presented_currency

string

The presented currency of this SKU

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.

subscription_status

enum<string>

Subscription status

Available options:

NOT_SUBSCRIBED,

SUBSCRIBED

external_data

object

The raw external product data from the external commerce platform

collections

object[]

Collections this offer belongs to

tags

string[]

Was this page helpful?

Get Count of Merchant Offers Search Offers

curl --request GET \
  --url https://sandbox-api.violet.io/v1/catalog/offers/{offer_id}

{
  "id": 123,
  "product_id": "<string>",
  "external_id": "<string>",
  "external_url": "<string>",
  "name": "<string>",
  "description": "<string>",
  "source": "OTHER",
  "seller": "<string>",
  "vendor": "<string>",
  "merchant_id": 123,
  "available": true,
  "visible": true,
  "min_price": 123,
  "max_price": 123,
  "currency": "<string>",
  "source_category_name": "<string>",
  "metadata": [
    {
      "version": 123,
      "type": "STRING",
      "external_type": "<string>",
      "key": "<string>",
      "value": {},
      "external_id": "<string>",
      "source": "INTERNAL"
    }
  ],
  "variants": [
    {
      "id": 123,
      "product_variant_id": "<string>",
      "external_id": "<string>",
      "name": "<string>",
      "visual": true,
      "values": [
        {
          "id": 123,
          "product_variant_value_id": "<string>",
          "external_id": "<string>",
          "name": "<string>",
          "sku_ids": [
            123
          ],
          "display_order": 123
        }
      ],
      "display_order": 123
    }
  ],
  "skus": [
    {
      "id": 123,
      "offer_id": 123,
      "merchant_id": 123,
      "external_id": "<string>",
      "name": "<string>",
      "asin": "<string>",
      "gtin": "<string>",
      "upc": "<string>",
      "ean": "<string>",
      "isbn": "<string>",
      "in_stock": true,
      "quantity_available": 123,
      "inventory_tracked": true,
      "sale_price": 123,
      "retail_price": 123,
      "currency": "<string>",
      "presented_currency": "<string>",
      "taxable": true,
      "tax_type": "DEFAULT",
      "albums": [
        {
          "id": 123,
          "parent_id": 123,
          "type": "OFFER",
          "name": "<string>",
          "media": [
            {
              "id": 123,
              "album_id": 123,
              "external_id": "<string>",
              "cloud_id": "<string>",
              "url": "<string>",
              "source_url": "<string>",
              "type": "IMAGE",
              "display_order": 123,
              "primary": true
            }
          ],
          "primary_media": {
            "id": 123,
            "album_id": 123,
            "external_id": "<string>",
            "cloud_id": "<string>",
            "url": "<string>",
            "source_url": "<string>",
            "type": "IMAGE",
            "display_order": 123,
            "primary": true
          }
        }
      ],
      "variant_values": [
        {
          "variant": "<string>",
          "value": "<string>"
        }
      ],
      "type": "PHYSICAL",
      "status": "UNAVAILABLE",
      "date_created": "2023-11-07T05:31:56Z",
      "date_last_modified": "2023-11-07T05:31:56Z",
      "sku_dimensions": {
        "sku_id": 123,
        "weight": 123,
        "height": 123,
        "width": 123,
        "length": 123,
        "type": "SKU"
      },
      "shipping_dimensions": {
        "sku_id": 123,
        "weight": 123,
        "height": 123,
        "width": 123,
        "length": 123,
        "type": "SKU"
      },
      "display_order": 123
    }
  ],
  "albums": [
    {
      "id": 123,
      "parent_id": 123,
      "type": "OFFER",
      "name": "<string>",
      "media": [
        {
          "id": 123,
          "album_id": 123,
          "external_id": "<string>",
          "cloud_id": "<string>",
          "url": "<string>",
          "source_url": "<string>",
          "type": "IMAGE",
          "display_order": 123,
          "primary": true
        }
      ],
      "primary_media": {
        "id": 123,
        "album_id": 123,
        "external_id": "<string>",
        "cloud_id": "<string>",
        "url": "<string>",
        "source_url": "<string>",
        "type": "IMAGE",
        "display_order": 123,
        "primary": true
      }
    }
  ],
  "three_d_enabled": true,
  "three_d_resource": "<string>",
  "type": "PHYSICAL",
  "status": "UNAVAILABLE",
  "publishing_status": "NOT_PUBLISHED",
  "date_created": "2023-11-07T05:31:56Z",
  "date_last_modified": "2023-11-07T05:31:56Z",
  "date_last_consolidated": "2023-11-07T05:31:56Z",
  "commission_rate": 123,
  "currency_symbol": "<string>",
  "presented_currency": "<string>",
  "default_image_url": "<string>",
  "subscription_status": "NOT_SUBSCRIBED",
  "external_data": {},
  "collections": [
    {
      "id": 123,
      "external_id": "<string>",
      "merchant_id": 123,
      "name": "<string>",
      "handle": "<string>",
      "description": "<string>",
      "status": "INACTIVE",
      "type": "CUSTOM",
      "media": {
        "source_url": "<string>",
        "alt": "<string>",
        "height": 123,
        "width": 123,
        "date_created": "2023-11-07T05:31:56Z"
      },
      "date_created": "2023-11-07T05:31:56Z",
      "date_last_modified": "2023-11-07T05:31:56Z"
    }
  ],
  "tags": [
    "<string>"
  ]
}

Overview

Login

Catalog

Orders & Checkout

Merchants

Events

Apps

Operations

Relay

Headers

Path Parameters

Query Parameters

Response