VTEX · Schema

Offer

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
SellerId string ID of the seller in the marketplace. This ID must be created by the marketplace.
SellerSkuId string A string that identifies the SKU in the seller. This is the ID that the marketplace will use for future references to this SKU, such as price and inventory notifications.
OffersPerSalesChannel array Each element in the array corresponds to an offer in a specific sales channel.
AvailableSalesChannels string The sales channel (or [trade policy](https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV#master-data)) ID in which the SKU is available.
View JSON Schema on GitHub

JSON Schema

vtex-offer-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Offer",
  "title": "Offer",
  "required": [
    "SellerId",
    "SellerSkuId",
    "OffersPerSalesChannel",
    "AvailableSalesChannels"
  ],
  "type": "object",
  "properties": {
    "SellerId": {
      "type": "string",
      "description": "ID of the seller in the marketplace. This ID must be created by the marketplace.",
      "default": "1"
    },
    "SellerSkuId": {
      "type": "string",
      "description": "A string that identifies the SKU in the seller. This is the ID that the marketplace will use for future references to this SKU, such as price and inventory notifications.",
      "default": "1070268"
    },
    "OffersPerSalesChannel": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OffersPerSalesChannel"
      },
      "description": "Each element in the array corresponds to an offer in a specific sales channel."
    },
    "AvailableSalesChannels": {
      "type": "string",
      "nullable": true,
      "description": "The sales channel (or [trade policy](https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV#master-data)) ID in which the SKU is available.",
      "default": "1"
    }
  },
  "example": {
    "SellerId": "1",
    "SellerSkuId": "1070268",
    "OffersPerSalesChannel": [
      {
        "SaleChannel": 1,
        "Price": 0,
        "ListPrice": 0,
        "PriceWithoutDiscount": 0,
        "AvailableQuantity": 0
      }
    ],
    "AvailableSalesChannels": null
  }
}