Vtex Structure

{
  "provider": "VTEX",
  "providerId": "vtex",
  "kind": "json-structure",
  "description": "Structural overview of the VTEX API surface; extracted from openapi/.",
  "schemaCount": 25,
  "operationCount": 15,
  "schemas": [
    {
      "name": "Example",
      "type": "object",
      "propertyCount": 9,
      "required": [
        "productId",
        "productName",
        "brand",
        "linkText",
        "productReference",
        "categories",
        "link",
        "description",
        "items"
      ]
    },
    {
      "name": "Item",
      "type": "object",
      "propertyCount": 13,
      "required": [
        "itemId",
        "name",
        "nameComplete",
        "complementName",
        "ean",
        "measurementUnit",
        "unitMultiplier",
        "images",
        "sellers"
      ]
    },
    {
      "name": "ReferenceId",
      "type": "object",
      "propertyCount": 2,
      "required": [
        "Key",
        "Value"
      ]
    },
    {
      "name": "Image",
      "type": "object",
      "propertyCount": 5,
      "required": [
        "imageId",
        "imageLabel",
        "imageTag",
        "imageUrl",
        "imageText"
      ]
    },
    {
      "name": "Seller",
      "type": "object",
      "propertyCount": 5,
      "required": [
        "sellerId",
        "sellerName",
        "addToCartLink",
        "sellerDefault",
        "commertialOffer"
      ]
    },
    {
      "name": "CommertialOffer",
      "type": "object",
      "propertyCount": 15,
      "required": [
        "DeliverySlaSamplesPerRegion",
        "Installments",
        "DiscountHighLight",
        "GiftSkuIds",
        "Teasers",
        "BuyTogether",
        "Price",
        "ListPrice",
        "PriceValidUntil",
        "AvailableQuantity",
        "Tax",
        "DeliverySlaSamples",
        "GetInfoErrorMessage",
        "CacheVersionUsedToCallCheckout"
      ]
    },
    {
      "name": "generatedObject",
      "type": "object",
      "propertyCount": 2,
      "required": [
        "DeliverySlaPerTypes",
        "Region"
      ]
    },
    {
      "name": "DeliverySlaPerType",
      "type": "object",
      "propertyCount": 3,
      "required": [
        "TypeName",
        "Price",
        "EstimatedTimeSpanToDelivery"
      ]
    },
    {
      "name": "Region",
      "type": "object",
      "propertyCount": 7,
      "required": [
        "IsPersisted",
        "IsRemoved",
        "Id",
        "Name",
        "CountryCode",
        "ZipCode",
        "CultureInfoName"
      ]
    },
    {
      "name": "Installment",
      "type": "object",
      "propertyCount": 7,
      "required": [
        "Value",
        "InterestRate",
        "TotalValuePlusInterestRate",
        "NumberOfInstallments",
        "PaymentSystemName",
        "PaymentSystemGroupName",
        "Name"
      ]
    },
    {
      "name": "DeliverySlaSample",
      "type": "object",
      "propertyCount": 2,
      "required": [
        "DeliverySlaPerTypes",
        "Region"
      ]
    },
    {
      "name": "DeliverySlaPerType2",
      "type": "object",
      "propertyCount": 3,
      "required": []
    },
    {
      "name": "Region2",
      "type": "object",
      "propertyCount": 7,
      "required": []
    },
    {
      "name": "Example2",
      "type": "object",
      "propertyCount": 4,
      "required": [
        "Departments",
        "Brands",
        "SpecificationFilters",
        "CategoriesTrees"
      ]
    },
    {
      "name": "Department",
      "type": "object",
      "propertyCount": 3,
      "required": [
        "Quantity",
        "Name",
        "Link"
      ]
    },
    {
      "name": "Brand",
      "type": "object",
      "propertyCount": 3,
      "required": [
        "Quantity",
        "Name",
        "Link"
      ]
    },
    {
      "name": "SpecificationFilters",
      "type": "object",
      "propertyCount": 3,
      "required": [
        "Resolu\u00e7\u00e3o",
        "Tamanho da Tela",
        "Aplicativos de TV"
      ]
    },
    {
      "name": "ResoluO",
      "type": "object",
      "propertyCount": 3,
      "required": [
        "Quantity",
        "Name",
        "Link"
      ]
    },
    {
      "name": "TamanhoDaTela",
      "type": "object",
      "propertyCount": 3,
      "required": [
        "Quantity",
        "Name",
        "Link"
      ]
    },
    {
      "name": "AplicativosDeTV",
      "type": "object",
      "propertyCount": 3,
      "required": [
        "Quantity",
        "Name",
        "Link"
      ]
    },
    {
      "name": "CategoriesTree",
      "type": "object",
      "propertyCount": 4,
      "required": [
        "Quantity",
        "Name",
        "Link",
        "Children"
      ]
    },
    {
      "name": "Child",
      "type": "object",
      "propertyCount": 4,
      "required": [
        "Quantity",
        "Name",
        "Link",
        "Children"
      ]
    },
    {
      "name": "Child1",
      "type": "object",
      "propertyCount": 4,
      "required": [
        "Quantity",
        "Name",
        "Link",
        "Children"
      ]
    },
    {
      "name": "Example3",
      "type": "object",
      "propertyCount": 1,
      "required": [
        "itemsReturned"
      ]
    },
    {
      "name": "ItemsReturned",
      "type": "object",
      "propertyCount": 4,
      "required": [
        "thumb",
        "name",
        "href",
        "criteria"
      ]
    }
  ],
  "operations": [
    {
      "method": "GET",
      "path": "/api/catalog_system/pub/products/crossselling/whosawalsosaw/{productId}",
      "operationId": "ProductSearchWhoSawAlsoSaw",
      "summary": "VTex Get Product Search of Who Saw Also Saw",
      "tags": [
        "CrossSelling"
      ]
    },
    {
      "method": "GET",
      "path": "/api/catalog_system/pub/products/crossselling/whosawalsobought/{productId}",
      "operationId": "ProductSearchWhoSawAlsoBought",
      "summary": "VTex Get Product Search of Who Saw Also Bought",
      "tags": [
        "CrossSelling"
      ]
    },
    {
      "method": "GET",
      "path": "/api/catalog_system/pub/products/crossselling/whoboughtalsobought/{productId}",
      "operationId": "ProductSearchWhoBoughtAlsoBought",
      "summary": "VTex Get Product Search of Who Bought Also Bought",
      "tags": [
        "CrossSelling"
      ]
    },
    {
      "method": "GET",
      "path": "/api/catalog_system/pub/products/crossselling/showtogether/{productId}",
      "operationId": "ProductSearchShowTogether",
      "summary": "VTex Get Product Search of Show Together",
      "tags": [
        "CrossSelling"
      ]
    },
    {
      "method": "GET",
      "path": "/api/catalog_system/pub/products/crossselling/accessories/{productId}",
      "operationId": "ProductSearchAccessories",
      "summary": "VTex Get Product Search of Accessories",
      "tags": [
        "CrossSelling"
      ]
    },
    {
      "method": "GET",
      "path": "/api/catalog_system/pub/products/crossselling/similars/{productId}",
      "operationId": "ProductSearchSimilars",
      "summary": "VTex Get Product Search of Similars",
      "tags": [
        "CrossSelling"
      ]
    },
    {
      "method": "GET",
      "path": "/api/catalog_system/pub/products/crossselling/suggestions/{productId}",
      "operationId": "ProductSearchSuggestions",
      "summary": "VTex Get Product Search of Suggestions",
      "tags": [
        "CrossSelling"
      ]
    },
    {
      "method": "GET",
      "path": "/api/catalog_system/pub/products/search/{search}",
      "operationId": "ProductSearch",
      "summary": "VTex Search for Products",
      "tags": [
        "Search"
      ]
    },
    {
      "method": "GET",
      "path": "/api/catalog_system/pub/products/search",
      "operationId": "ProductSearchFilteredandOrdered",
      "summary": "VTex Search for Products with Filter, Order and Pagination",
      "tags": [
        "Search"
      ]
    },
    {
      "method": "GET",
      "path": "/api/catalog_system/pub/products/search/{product-text-link}/p",
      "operationId": "Searchbyproducturl",
      "summary": "VTex Search Product by Product URL",
      "tags": [
        "Search"
      ]
    },
    {
      "method": "GET",
      "path": "/api/catalog_system/pub/products/offers/{productId}",
      "operationId": null,
      "summary": "VTex Search Product offers",
      "tags": [
        "Offers"
      ]
    },
    {
      "method": "GET",
      "path": "/api/catalog_system/pub/products/offers/{productId}/sku/{skuId}",
      "operationId": null,
      "summary": "VTex Search SKU offers",
      "tags": [
        "Offers"
      ]
    },
    {
      "method": "GET",
      "path": "/api/catalog_system/pub/facets/category/{categoryId}",
      "operationId": null,
      "summary": "VTex Get Category Facets",
      "tags": [
        "Facets"
      ]
    },
    {
      "method": "GET",
      "path": "/api/catalog_system/pub/facets/search/{term}",
      "operationId": "Facetscategory",
      "summary": "VTex Search by Store Facets",
      "tags": [
        "Facets"
      ]
    },
    {
      "method": "GET",
      "path": "/buscaautocomplete",
      "operationId": "AutoComplete",
      "summary": "VTex Product Search Autocomplete",
      "tags": [
        "Autocomplete"
      ]
    }
  ]
}