VTEX · Schema

responseGetMatchedOffersList

Response with the list of offers available on the Marketplace.

CommerceE-CommerceRetailMarketplacePayments
View JSON Schema on GitHub

JSON Schema

vtex-responsegetmatchedofferslist-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/responseGetMatchedOffersList",
  "title": "responseGetMatchedOffersList",
  "type": "array",
  "description": "Response with the list of offers available on the Marketplace.",
  "items": {
    "type": "object",
    "description": "Array of SKUs in the offer.",
    "properties": {
      "LastModified": {
        "type": "string",
        "description": "Last date the offer was modified.",
        "example": "2021-05-06T21:37:24.262529"
      },
      "ProductId": {
        "type": "string",
        "description": "A string that identifies the seller's product. This is the ID that the marketplace will use for all references to this product.",
        "example": "941947"
      },
      "CategoryId": {
        "type": "integer",
        "description": "Offer's Category ID that the product belongs to, configured in the Catalog. It should be the marketplace's category chosen for the offer to be matched with.",
        "example": 1563
      },
      "BrandId": {
        "type": "integer",
        "description": "Offer's brand ID that the product belongs to, configured in the Catalog. It should be the marketplace's brand chosen for the offer to be matched with.",
        "example": 2004291
      },
      "ProductName": {
        "type": "string",
        "description": "Name of the offer's product.",
        "example": "Name of the Product - 123"
      },
      "Skus": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/Sku2"
        }
      }
    }
  }
}