Get Offer by ID
2min
GET
AUTHENTICATION
Authorization
string
Bearer
PATH PARAMETERS
offer_id
integer
*QUERY PARAMETERS
base_currency
string
exchange_rate
number
HEADER PARAMETERS
X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer
X-Violet-Api-Features
string
RESPONSES
200
successful operation
Offer
Product Offer
id
integer<int64>
product_id
string
*The parent/container product ID
external_id
string
External ID
external_url
string
External URL
name
string
*Name of Product in Offer
description
string
Product Description
source
string<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 Platform
seller
string
Name of Merchant Selling Product
vendor
string
Name of Original Vendor
merchant_id
integer<int32>
*Merchant ID
available
boolean
*Is Product Available
visible
boolean
*Is Product Visible
min_price
integer<int32>
*Minimum Price the Product sells for
max_price
integer<int32>
Maximum Price the Product sells for
currency
string
Base Currency of Offer
source_category_name
string
Original Category on Source Platform
meta
Meta[]
Additional Meta Data of the Offer
variants
Variant[]
Product Variations
skus
Sku[]
Product SKUs
albums
Album[]
Product Albums
three_d_enables
boolean
Is the product 3D Enabled
three_d_resource
string
3D Resource Object
type
string<PHYSICAL | DIGITAL | VIRTUAL>
Product Type
status
string<AVAILABLE | UNAVAILABLE | DISABLED_AVAILABLE | DISABLED_UNAVAILABLE | ARCHIVED | FOR_DELETION>
Status
publishing_status
string<NOT_PUBLISHED | PUBLISHED>
Publishing Status
date_created
string<date-time>
Date of offer creation
date_last_modified
string<date-time>
Date of last offer update
commission_rate
number<double>
Amount given by merchant
weight_unit
string<OUNCES | POUNDS | GRAMS | KILOGRAMS | CARATS | TONNES | MILLIGRAMS | LITERS | MILLILITERS | QUARTS | QUARTERS | GALLONS | PINTS>
Weight Unit
size_unit
string<MILLIMETERS | CENTIMETERS | INCHES | FEET | METERS | YARDS>
Size Unit
currency_symbol
string
Symbol representing the desired currency
presented_currency
string
The presented currency of this SKU
subscription_status
string<NOT_SUBSCRIBED | SUBSCRIBED>
Subscription status
tags
string[]
Updated 16 May 2023
Did this page help you?
Yes
No