VTEX · Schema
responseGetMatchedOffersDataByProductId
Array of matched offers data by product ID.
CommerceE-CommerceRetailMarketplacePayments
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/responseGetMatchedOffersDataByProductId",
"title": "responseGetMatchedOffersDataByProductId",
"type": "array",
"description": "Array of matched offers data by product ID.",
"items": {
"type": "object",
"description": "Schema for individual offer data.",
"properties": {
"productId": {
"type": "string",
"description": "The unique identifier for the product.",
"example": "1561208"
},
"skuId": {
"type": "string",
"description": "The unique identifier for the product SKU.",
"example": "1559161"
},
"nameComplete": {
"type": "string",
"description": "The complete name of the product.",
"example": "Blusa Cardigan Manga Longa Vestem - Feminina - CINZA G"
},
"mainImage": {
"type": "object",
"description": "Schema for the main product image.",
"required": [
"imagePath"
],
"properties": {
"imagePath": {
"type": "string",
"description": "The file path of the main product image.",
"example": "~/arquivos/ids/8567753-#width#-#height#/image-05b40d3167b5b7ed42285124f6862f12.jpg"
}
}
},
"sellersOffers": {
"type": "array",
"description": "Array of offers from different sellers.",
"items": {
"type": "object",
"description": "Schema for individual seller offer data.",
"properties": {
"sellerId": {
"type": "string",
"description": "The unique identifier for the seller.",
"example": "1"
},
"sellerSkuId": {
"type": "string",
"description": "The unique identifier for the seller's SKU.",
"example": "1559161"
},
"salesChannelOffer": {
"type": "object",
"description": "Schema for the offer data on a specific sales channel.",
"properties": {
"salesChannelId": {
"type": "string",
"description": "The unique identifier for the sales channel.",
"example": "1"
},
"salesChannelName": {
"type": "string",
"description": "The name of the sales channel.",
"example": "Principal"
},
"price": {
"type": "number",
"description": "The offer price.",
"example": 0
},
"listPrice": {
"type": "number",
"description": "The list price of the product.",
"example": 0
},
"priceWithoutDiscount": {
"type": "number",
"description": "The offer price without any discount.",
"example": 0
},
"availableQuantity": {
"type": "integer",
"description": "The available quantity of the product.",
"example": 0
}
}
}
}
}
}
}
}
}