GET

/v1/catalog/offers/merchants/{merchant_id}

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

Note: For more details on this endpoint and the other possible filter options it can take, please refer to the API Reference

When retrieving Offers, if you provide the base_currency query parameter the currency in the Offer object will match what was passed in and all prices will reflect that currency. The default currency when no parameter is provided is USD.

  • Params

HEADER PARAMETERS

X-Violet-App-Secretrequired
String
X-Violet-App-Idrequired
String
X-Violet-App-Tokenrequired
String
curl --request GET
  --url https://sandbox-api.violet.io/v1/catalog/offers/merchants/10000?page=1&size=2
  --header 'X-Violet-App-Id: <Your App Id Here>'
  --header 'X-Violet-App-Secret: <Your App Secret Here>'
  --header 'X-Violet-Token: <Your Violet token here>'
  --header 'Accept: application/json'
{
    "content": [
        {
            "id": 10064,
            "product_id": "0ff55c5cda7447118d6ae1c8395f8f11",
            "external_id": "1525149073526",
            "external_url": "https://violet-besties.myshopify.com/products/gopro-karma-quadcopter-with-hero6-black-white",
            "name": "GoPro - Karma Quadcopter with HERO6 Black - White",
            "description": "Ultra portable; includes GoPro HERO6 Black and detachable camera stabilizer; flying range up to 3280 ft; game-style controller with ultra bright touch display; grip handle included; built-in no-fly zones",
            "source": "SHOPIFY",
            "seller": "Violet-Besties",
            "vendor": "GoPro",
            "merchant_id": 10000,
            "available": true,
            "visible": true,
            "min_price": 84999,
            "max_price": 84999,
            "commission_rate": 15.0,
            "currency": "USD",
            "source_category_name": "Unmanned_Aerial_Vehicles",
            "meta": [],
            "variants": [
                {
                    "external_id": "2049150550134",
                    "name": "Color",
                    "visual": true,
                    "values": [
                        {
                            "external_id": "White",
                            "name": "White",
                            "sku_ids": [
                                10064
                            ]
                        }
                    ]
                }
            ],
            "skus": [
                {
                    "id": 10064,
                    "offer_id": 10064,
                    "merchant_id": 10000,
                    "external_id": "13884047425654",
                    "name": "GoPro - Karma Quadcopter with HERO6 Black - White - White",
                    "in_stock": true,
                    "qty_available": 9999,
                    "inventory_tracked": true,
                    "sale_price": 84999,
                    "retail_price": 99999,
                    "currency": "USD",
                    "taxable": true,
                    "tax_type": "DEFAULT",
                    "albums": [],
                    "variant_values": [
                        {
                            "variant": "Color",
                            "value": "White"
                        }
                    ],
                    "type": "PHYSICAL",
                    "status": "AVAILABLE",
                    "date_created": "2018-08-15T15:56:31+0000",
                    "date_last_modified": "2021-03-05T21:56:01+0000",
                    "sku_dimensions": {
                        "weight": 13.45,
                        "type": "SKU"
                    }
                }
            ],
            "albums": [
                {
                    "id": 10064,
                    "parent_id": 10064,
                    "type": "OFFER",
                    "name": "Primary Album",
                    "media": [
                        {
                            "id": 10064,
                            "album_id": 10064,
                            "external_id": "4192655900790",
                            "url": "https://cdn.shopify.com/s/files/1/0057/6467/7750/products/6029300_ra.jpg",
                            "source_url": "https://cdn.shopify.com/s/files/1/0057/6467/7750/products/6029300_ra.jpg",
                            "type": "IMAGE",
                            "display_order": 1,
                            "primary": true
                        }
                    ],
                    "primary_media": {
                        "id": 10064,
                        "album_id": 10064,
                        "external_id": "4192655900790",
                        "url": "https://cdn.shopify.com/s/files/1/0057/6467/7750/products/6029300_ra.jpg",
                        "source_url": "https://cdn.shopify.com/s/files/1/0057/6467/7750/products/6029300_ra.jpg",
                        "type": "IMAGE",
                        "display_order": 1,
                        "primary": true
                    }
                }
            ],
            "three_denabled": false,
            "status": "AVAILABLE",
            "date_created": "2018-08-15T15:56:31+0000",
            "date_last_modified": "2021-03-05T21:56:01+0000"
        },
        {
            "id": 10063,
            "product_id": "7c25e72a40fb48c694fb84c956b5aaf4",
            "external_id": "1525144223862",
            "external_url": "https://violet-besties.myshopify.com/products/gopro-karma-quadcopter-with-hero5-black-black-white",
            "name": "GoPro - Karma Quadcopter with HERO5 Black - Black/White",
            "description": "Ultra portable; includes GoPro HERO5 Black and detachable camera stabilizer; 4K video & 12MP photo; flying range up to 3280 ft; game-style controller with ultra bright touch display; grip handle included; built-in no-fly zones",
            "source": "SHOPIFY",
            "seller": "Violet-Besties",
            "vendor": "GoPro",
            "merchant_id": 10000,
            "available": true,
            "visible": true,
            "min_price": 89999,
            "max_price": 89999,
            "commission_rate": 15.0,
            "currency": "USD",
            "source_category_name": "Unmanned_Aerial_Vehicles",
            "meta": [],
            "variants": [
                {
                    "external_id": "2049144520822",
                    "name": "Color",
                    "visual": true,
                    "values": [
                        {
                            "external_id": "Black/White",
                            "name": "Black/White",
                            "sku_ids": [
                                10063
                            ]
                        }
                    ]
                }
            ],
            "skus": [
                {
                    "id": 10063,
                    "offer_id": 10063,
                    "merchant_id": 10000,
                    "external_id": "13884031074422",
                    "name": "GoPro - Karma Quadcopter with HERO5 Black - Black/White - Black/White",
                    "in_stock": true,
                    "qty_available": 9999,
                    "inventory_tracked": true,
                    "sale_price": 89999,
                    "retail_price": 89999,
                    "currency": "USD",
                    "taxable": true,
                    "tax_type": "DEFAULT",
                    "albums": [],
                    "variant_values": [
                        {
                            "variant": "Color",
                            "value": "Black/White"
                        }
                    ],
                    "type": "PHYSICAL",
                    "status": "AVAILABLE",
                    "date_created": "2018-08-15T15:56:31+0000",
                    "date_last_modified": "2021-03-05T21:56:01+0000",
                    "sku_dimensions": {
                        "weight": 13.9,
                        "type": "SKU"
                    }
                }
            ],
            "albums": [
                {
                    "id": 10063,
                    "parent_id": 10063,
                    "type": "OFFER",
                    "name": "Primary Album",
                    "media": [
                        {
                            "id": 10063,
                            "album_id": 10063,
                            "external_id": "4192642924662",
                            "url": "https://cdn.shopify.com/s/files/1/0057/6467/7750/products/5732803_sa.jpg",
                            "source_url": "https://cdn.shopify.com/s/files/1/0057/6467/7750/products/5732803_sa.jpg",
                            "type": "IMAGE",
                            "display_order": 1,
                            "primary": true
                        }
                    ],
                    "primary_media": {
                        "id": 10063,
                        "album_id": 10063,
                        "external_id": "4192642924662",
                        "url": "https://cdn.shopify.com/s/files/1/0057/6467/7750/products/5732803_sa.jpg",
                        "source_url": "https://cdn.shopify.com/s/files/1/0057/6467/7750/products/5732803_sa.jpg",
                        "type": "IMAGE",
                        "display_order": 1,
                        "primary": true
                    }
                }
            ],
            "three_denabled": false,
            "status": "AVAILABLE",
            "date_created": "2018-08-15T15:56:31+0000",
            "date_last_modified": "2021-03-05T21:56:01+0000"
        }
    ],
    "pageable": {
        "sort": {
            "unsorted": false,
            "sorted": true,
            "empty": false
        },
        "page_number": 0,
        "page_size": 2,
        "offset": 0,
        "paged": true,
        "unpaged": false
    },
    "total_elements": 110,
    "last": false,
    "total_pages": 55,
    "sort": {
        "unsorted": false,
        "sorted": true,
        "empty": false
    },
    "number_of_elements": 2,
    "first": true,
    "size": 2,
    "number": 0,
    "empty": false
}

Headers

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

Path Parameters

merchant_idrequired
integer

Query Parameters

since
integer
page
Default: "1"
integer
size
Default: "20"
integer
map_variants
Default: true
boolean
base_currency
string

Response

200 - application/json
content
object[]
empty
boolean
first
boolean
last
boolean
number
integer
number_of_elements
integer
pageable
object
size
integer
sort
object
total_elements
integer
total_pages
integer