Get Offer by ID - Violet Documentation

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

enum<string>

Comma-separated list of extra data to be included.

Available options:

metadata,

collections,

shipping

Response

200 - application/json

Product Offer

albums

object[]

Grouped of media for the Offer. Note: For most commerce platforms there will only be a single album per Offer.

albums.parent_id

integer

required

ID of the parent entity

albums.type

enum<string>

required

Parent Type

Available options:

OFFER,

SKU

albums.id

integer

albums.media

object[]

Album media

albums.name

string

Name of Album

albums.primary_media

object

Product and SKU Media

available

boolean

Is the product available for purchase.

collections

object[]

Collections this offer belongs to

commission_rate

number

Amount given by merchant

currency

string

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

currency_symbol

string | null

Symbol representing the desired currency

date_created

string

Date of offer creation in ISO 8601 format.

date_last_consolidated

string

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

date_last_modified

string

Date of last offer update in ISO 8601 format.

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.

description

string | null

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

Maximum length: 65000

external_data

object

The raw external product data from the external commerce platform

external_id

string

The ID of the product in the merchants external store.

external_url

string

The URL to the product page in the merchants store.

integer

max_price

integer

Maximum Price the Offer sells for.

merchant_id

integer

Merchant ID

metadata

array | null

Additional Meta Data of the Offer

min_price

integer

Minimum Price the Offer sells for.

name

string

Name of the offer.

presented_currency

string

The presented currency of this SKU

product_id

string

deprecated

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

publishing_status

enum<string>

Publishing Status

Available options:

NOT_PUBLISHED,

PUBLISHED

seller

string | null

Name of merchant selling product.

shipping

object | null

[ALPHA] - Shipping data for the Offer.

shipping.message

string | null

Context regarding the shipping data for this Offer.

shipping.methods

array | null

List of available shipping methods for this Offer.

shipping.methods.conditions

array | null

Conditions that must be met for the method to be available.

shipping.methods.external_id

string | null

ID of the shipping method in the external commerce system.

shipping.methods.name

string | null

Name of the shipping method as provided by the merchant.

shipping.methods.price

object | null

Price in cents required to enable the shipping method.

shipping.methods.regions

object | null

Regions this shipping method is enabled for.

skus

object[]

Sku's are unique combinations of Variants the compose a purchasable entity. When placing orders a Sku is the item that will be purchased.

skus.currency

string

required

The base currency of this Sku.

skus.merchant_id

integer

required

ID of the Merchant that originated the Sku.

skus.offer_id

integer

required

ID of the parent Offer that this Sku is a child of.

skus.sale_price

integer

required

Sale Price of the Sku. This is the actual sale cost when the Sku is purchased.

skus.type

enum<string>

required

Available options:

PHYSICAL,

DIGITAL,

VIRTUAL,

BUNDLED

skus.albums

object[] | null

Sku Albums

skus.albums.parent_id

integer

required

ID of the parent entity

skus.albums.type

enum<string>

required

Parent Type

Available options:

OFFER,

SKU

skus.albums.id

integer

skus.albums.media

object[]

Album media

skus.albums.name

string

Name of Album

skus.albums.primary_media

object

Product and SKU Media

skus.asin

string | null

Amazon Standard Identification Number

skus.date_created

string

Date when the Sku was first created in Violet.

skus.date_last_modified

string

Date when the Sku was last updated in Violet.

skus.display_order

integer

The order that the merchant has chosen to display this Sku in relation to other Sku's that are children of the same Offer.

skus.ean

string | null

European Article Number

skus.external_id

string

The ID of the Sku in the merchants external store.

skus.gtin

string | null

Global Trade Item Number

skus.id

integer

skus.in_stock

boolean

Is the Sku in stock in the merchants external store.

skus.inventory_tracked

boolean

Is the Sku's inventory tracked in the merchants system. Untracked inventory can be oversold even when the available quantity is 0.

skus.isbn

string | null

International Standard Book Number

skus.name

string

Sku Name

skus.presented_currency

string

The presented currency of this Sku.

skus.quantity_available

integer

The total quantity of this Sku available for purchase.

skus.retail_price

integer

Retail Price of the Sku. This is the recommended or common price of the Sku and is typically not what the customer will be charged..

skus.shipping_dimensions

object | null

Individual Sku Dimensions

skus.sku_dimensions

object | null

Individual Sku Dimensions

skus.status

enum<string>

SKU Status

Available options:

UNAVAILABLE,

AVAILABLE,

DISABLED_UNAVAILABLE,

DISABLED_AVAILABLE,

FOR_DELETION,

ARCHIVED

skus.tax_type

enum<string>

Type of Tax on this Sku.

Available options:

DEFAULT,

APPAREL,

SERVICE

skus.taxable

boolean

Is the Sku taxable.

skus.upc

string | null

Universal Product Code

skus.variant_values

array | null

Variant Values that apply to this SKU

source

enum<string>

Commerce platform the offer was sourced from.

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

source_category_name

string | null

Original Category on Source Platform

status

enum<string>

Current status of the Offer.

Available options:

UNAVAILABLE,

AVAILABLE,

DISABLED_UNAVAILABLE,

DISABLED_AVAILABLE,

FOR_DELETION,

ARCHIVED

subscription_status

enum<string>

Subscription status

Available options:

NOT_SUBSCRIBED,

SUBSCRIBED