Sync Offer by Offer ID

POST

sync

offers

{offer_id}

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

{
  "id": 123,
  "product_id": "<string>",
  "external_id": "<string>",
  "external_url": "<string>",
  "name": "<string>",
  "description": "<string>",
  "source": "OTHER",
  "seller": "Foot Locker",
  "vendor": "Nike",
  "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,
              "alt_text": "<string>",
              "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,
            "alt_text": "<string>",
            "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,
          "alt_text": "<string>",
          "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,
        "alt_text": "<string>",
        "primary": true
      }
    }
  ],
  "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",
  "three_d_enabled": false,
  "three_d_resource": "<string>",
  "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,
      "parent_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"
    }
  ],
  "shipping": {
    "message": "<string>",
    "methods": [
      {
        "external_id": "<string>",
        "name": "<string>",
        "price": {
          "amount": 123,
          "currency": "USD"
        },
        "regions": {
          "countries": [
            "US"
          ]
        },
        "conditions": [
          {
            "price": {
              "amount": 123,
              "currency": "USD"
            },
            "weight": {
              "value": 123,
              "unit": "INCHES"
            },
            "type": "TOTAL_PRICE",
            "operator": "LESS_THAN_OR_EQUAL_TO"
          }
        ]
      }
    ]
  },
  "tags": [
    "<string>"
  ]
}

Resync an existing Offer in the Violet system using the offer_id.

If a merchant is configured to sync shipping data this will also refresh the shipping data on the Offer.

This endpoint should not be used programatically. It performs calls to the external commerce platform and consumes rate limits. Abuse of this endpoint can result in the failure of other interactions with the merchants system.

Headers

X-Violet-Token

string

X-Violet-App-Secret

string

X-Violet-App-Id

integer

Path Parameters

offer_id

integer

required

The ID of an Offer in the Violet system.

Response

200

application/json

successful operation

Product Offer

integer

Unique ID of the Offer.

product_id

string

deprecated

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

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. Note: if the value for visible is false this URL will likely result in a 404.

name

string

Name of the offer.

description

string | null

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

Maximum length: 65000

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

seller

string | null

Name of the merchant selling product.

vendor

string | null

Name of the source vendor or brand.

merchant_id

integer

ID of the merchant who sourced this Offer.

available

boolean

Is the product currently available for purchase in the merchants system.

visible

boolean

Is the product visible or hidden in the merchants storefront. Note: a product can be hidden while still being available for purchase.

min_price

integer

Minimum price the Offer sells for. This is the lowest of the Sku sale prices.

max_price

integer

Maximum price the Offer sells for. This is the highest of the Sku sale prices.

currency

string

The currency of the Offer. By default this value will be the merchants currency but can be changed by the API user using a base_currency parameter.

source_category_name

string | null

Original Category on Source Platform

metadata

object[] | null

Additional Meta Data of the Offer

variants

object[]

Product variations configured by the merchant in their external store. Note: Variations can have any name the merchant chooses to use. There is no pre-defined set of possible variants or variant values.

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.offer_id

integer

required

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

skus.merchant_id

integer

required

ID of the Merchant that originated the Sku.

skus.name

string

required

Name of the Sku. This often a combination of the Offer name and the Variant Values unique to this Sku.

skus.sale_price

integer

required

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

skus.currency

string

required

The base currency of this Sku.

skus.type

enum<string>

required

Available options:

PHYSICAL,

DIGITAL,

VIRTUAL,

BUNDLED

skus.id

integer

The unique ID of the Sku.

skus.external_id

string

The ID of the Sku in the merchants external store.

skus.asin

string | null

Amazon Standard Identification Number

skus.gtin

string | null

Global Trade Item Number

skus.upc

string | null

Universal Product Code

skus.ean

string | null

European Article Number

skus.isbn

string | null

International Standard Book Number

skus.in_stock

boolean

Is the Sku in stock in the merchants external store.

skus.quantity_available

integer

The total quantity of this Sku available for purchase.

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.retail_price

integer

Retail Price of the Sku. This is often a "Compare-To" or "MSRP" type price and is typically not what the customer will be charged.

skus.presented_currency

string

The presented currency of this Sku.

skus.taxable

boolean

Is the Sku taxable.

skus.tax_type

enum<string>

Type of Tax on this Sku.

Available options:

DEFAULT,

APPAREL,

SERVICE

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.name

string

Name of Album

skus.albums.media

object[]

Album media

skus.albums.primary_media

object

Product and SKU Media

skus.variant_values

array | null

Variant Values that apply to this SKU

skus.status

enum<string>

SKU Status

Available options:

UNAVAILABLE,

AVAILABLE,

DISABLED_UNAVAILABLE,

DISABLED_AVAILABLE,

FOR_DELETION,

ARCHIVED

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.sku_dimensions

object | null

Individual Sku Dimensions

skus.shipping_dimensions

object | null

Individual Sku Dimensions

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.

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.name

string

Name of Album

albums.media

object[]

Album media

albums.primary_media

object

Product and SKU Media

type

enum<string>

Type of product. Note: Offers with a type of BUNDLED cannot be purchased through the API at this time due to ecom platform limitations.

Available options:

PHYSICAL,

DIGITAL,

VIRTUAL,

BUNDLED

status

enum<string>

Current status of the Offer.

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 in ISO 8601 format.

date_last_modified

string

Date of last offer update in ISO 8601 format.

date_last_consolidated

string

Date of last consolidation in ISO 8601 format. Consolidation is the process of querying the merchants store to see if this product still exists. This date is jittered for performance reasons and can be in the future.

three_d_enabled

boolean | null

default:

false

Is the product 3D Enabled

three_d_resource

string | null

3D Resource Object

commission_rate

number

Amount given by merchant

currency_symbol

string | null

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. This data is not pre-processed by Violet and is only provided for reference when using using the Violet Relay API.

collections

object[]

Collections this offer belongs to

shipping

object | null

[BETA] - 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.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.

shipping.methods.conditions

array | null

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

tags

string[]

Was this page helpful?

Relay - Get Shipping Zones

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

{
  "id": 123,
  "product_id": "<string>",
  "external_id": "<string>",
  "external_url": "<string>",
  "name": "<string>",
  "description": "<string>",
  "source": "OTHER",
  "seller": "Foot Locker",
  "vendor": "Nike",
  "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,
              "alt_text": "<string>",
              "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,
            "alt_text": "<string>",
            "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,
          "alt_text": "<string>",
          "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,
        "alt_text": "<string>",
        "primary": true
      }
    }
  ],
  "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",
  "three_d_enabled": false,
  "three_d_resource": "<string>",
  "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,
      "parent_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"
    }
  ],
  "shipping": {
    "message": "<string>",
    "methods": [
      {
        "external_id": "<string>",
        "name": "<string>",
        "price": {
          "amount": 123,
          "currency": "USD"
        },
        "regions": {
          "countries": [
            "US"
          ]
        },
        "conditions": [
          {
            "price": {
              "amount": 123,
              "currency": "USD"
            },
            "weight": {
              "value": 123,
              "unit": "INCHES"
            },
            "type": "TOTAL_PRICE",
            "operator": "LESS_THAN_OR_EQUAL_TO"
          }
        ]
      }
    ]
  },
  "tags": [
    "<string>"
  ]
}

Overview

Login

Merchants

Catalog

Orders & Checkout

Events

Apps

Operations

Relay

Ecom Syncs

Headers

Path Parameters

Response