1min

Get Offer by ID

GET
Retrieves a single offer by ID.
PATH PARAMETERS
offer_idinteger*
HEADER PARAMETERS
X-Violet-Tokenstring
X-Violet-App-Secretstring
X-Violet-App-Idinteger
RESPONSES
200
successful operation
Offer
Product Offer
idinteger<int64>
product_idstring
The parent/container product ID
external_idstring
External ID
external_urlstring
External URL
namestring
Name of Product in Offer
descriptionstring
Product Description
sourcestring<OTHER | SHOPIFY | MAGENTO | MAGENTO_ONE | WOOCOMMERCE | BIGCOMMERCE | LIGHTSPEED | ECWID | YAAS | SPREECOMMERCE | DEMANDWARE | VOLUSION>
Source Platform
sellerstring
Name of Merchant Selling Product
vendorstring
Name of Original Vendor
merchant_idinteger<int32>
Merchant ID
availableboolean
Is Product Available
visibleboolean
Is Product Visible
min_priceinteger<int32>
Minimum Price the Product sells for
max_priceinteger<int32>
Maximum Price the Product sells for
commission_ratenumber<double>
Amount given by merchant
special_commission_rateboolean
If the commission rate is unique to this offer.
currencystring
Default Currency of Offer
source_category_namestring
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_enablesboolean
Is the product 3D Enabled
three_d_resourcestring
3D Resource Object
typestring<PHYSICAL | DIGITAL | VIRTUAL>
Product Type
statusstring<ENABLED | DISABLED>
Status
date_createdstring<date-time>
Date of offer creation
date_last_modifiedstring<date-time>
Date of last offer update
weight_unitstring<OUNCES | POUNDS | GRAMS | KILOGRAMS | CARATS | TONNES | MILLIGRAMS | LITERS | MILLILITERS | QUARTS | QUARTERS | GALLONS | PINTS>
Weight Unit
size_unitstring<MILLIMETERS | CENTIMETERS | INCHES | FEET | METERS | YARDS>
Size Unit
Updated 21 Apr 2022
Did this page help you?
Yes
No