v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-1915251.8 MB
Search

Search product by product URL

Retrieves general information about the product of the URL you searched for.

get/api/catalog_system/pub/products/search/{product-text-link}/p

Path parameters

product-text-linkstring required
Example:blue-shirt

Product URL

Headers

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Content-Typestring required
Example:application/json

Describes the type of the content being sent.

Response

productIdstring required

Product unique identifier.

productNamestring required

Product name.

brandstring required

Brand name.

brandIdinteger required

Product brand ID.

brandImageUrlstring required

Product's brand image URL.

linkTextstring required

Product URL.

productReferencestring required

Product reference.

productReferenceCodeinteger nullable required

Product reference ID.

categoryIdstring required

Product category ID.

productTitlestring required

Text that is in the browser tab and corresponds to the title of the product page. This field is important for SEO.

metaTagDescriptionstring required

Brief description of the category. It's recommended that you don't exceed 150 characters so that the search engines can display it correctly in the results page.

releaseDatestring required

Product release date.

clusterHighlightsobject required

Cluster highlight ID and name.

productClustersobject required

Product clusters' IDs and names.

searchableClustersobject required

Searchable clusters IDs and names.

linkstring required

Product URL.

allSpecificationsstring[] required

Array of the product's specifications.

allSpecificationsGroupsstring[] required

Array of the product's specifications groups.

descriptionstring nullable required

Description of the main information related to the product. A simple and easy to understand summary for the customer.

Example response

[
  {
    "productId": "35",
    "productName": "Kit de Hoegaarden",
    "brand": "Hoegaarden",
    "brandId": 2000004,
    "brandImageUrl": "https://merch.vteximg.com.br/arquivos/ids/155532/hoegardden-logo.jpg",
    "linkText": "kit-6-cerveja-hoegaarden",
    "productReference": "000806",
    "productReferenceCode": 1234,
    "categoryId": "1",
    "productTitle": "Kit 6 cerveja Hoegaarden",
    "metaTagDescription": "Category for Beers",
    "releaseDate": "2020-10-07T00:00:00",
    "clusterHighlights": {
      "138": "teste2"
    },
    "productClusters": {
      "138": "teste2",
      "143": "NaoPesquisavel",
      "146": "colecaotestesubcategoria",
      "161": "merch_import_test1"
    },
    "searchableClusters": {
      "138": "teste2"
    },
    "categories": [
      "/Beers Beers Mesmo/"
    ],
    "categoriesIds": [
      "/1/"
    ],
    "link": "https://merch.vtexcommercestable.com.br/kit-6-cerveja-hoegaarden/p",
    "allSpecifications": [
      "Percentuals",
      "Percentual"
    ],
    "allSpecificationsGroups": [
      "Total",
      "Teste da Api2"
    ],
    "description": "Description example",
    "items": [
      {
        "itemId": "310118469",
        "name": "Kit com 6",
        "nameComplete": "Kit de Hoegaarden Kit com 6",
        "complementName": "",
        "ean": "",
        "referenceId": [
          {
            "Key": "RefId",
            "Value": "000806"
          }
        ],
        "measurementUnit": "un",
        "unitMultiplier": 1,
        "modalType": null,
        "isKit": true,
        "kitItems": [
          {
            "itemId": "310118466",
            "amount": 6
          }
        ],
        "images": [
          {
            "imageId": "155489",
            "imageLabel": "",
            "imageTag": "<img src=\"~/arquivos/ids/155489-#width#-#height#/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000\" width=\"#width#\" height=\"#height#\" alt=\"hoegaarden-kit\" id=\"\" />",
            "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000",
            "imageText": "hoegaarden-kit",
            "imageLastModified": "2020-10-07T12:49:27.5800000Z"
          }
        ],
        "sellers": [
          {
            "sellerId": "1",
            "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE",
            "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1",
            "sellerDefault": true,
            "commertialOffer": {
              "DeliverySlaSamplesPerRegion": {
                "0": {
                  "DeliverySlaPerTypes": [],
                  "Region": null
                }
              },
              "Installments": [
                {
                  "Value": 42,
                  "InterestRate": 0,
                  "TotalValuePlusInterestRate": 42,
                  "NumberOfInstallments": 1,
                  "PaymentSystemName": "Visa",
                  "PaymentSystemGroupName": "creditCardPaymentGroup",
                  "Name": "Visa à vista"
                },
                {
                  "Value": 21,
                  "InterestRate": 0,
                  "TotalValuePlusInterestRate": 42,
                  "NumberOfInstallments": 2,
                  "PaymentSystemName": "Visa",
                  "PaymentSystemGroupName": "creditCardPaymentGroup",
                  "Name": "Visa 2 vezes sem juros"
                },
                {
                  "Value": 14,
                  "InterestRate": 0,
                  "TotalValuePlusInterestRate": 42,
                  "NumberOfInstallments": 3,
                  "PaymentSystemName": "Visa",
                  "PaymentSystemGroupName": "creditCardPaymentGroup",
                  "Name": "Visa 3 vezes sem juros"
                },
                {
                  "Value": 10.5,
                  "InterestRate": 0,
                  "TotalValuePlusInterestRate": 42,
                  "NumberOfInstallments": 4,
                  "PaymentSystemName": "Visa",
                  "PaymentSystemGroupName": "creditCardPaymentGroup",
                  "Name": "Visa 4 vezes sem juros"
                },
                {
                  "Value": 42,
                  "InterestRate": 0,
                  "TotalValuePlusInterestRate": 42,
                  "NumberOfInstallments": 1,
                  "PaymentSystemName": "Promissory",
                  "PaymentSystemGroupName": "promissoryPaymentGroup",
                  "Name": "Promissory à vista"
                }
              ],
              "DiscountHighLight": [],
              "GiftSkuIds": [],
              "Teasers": [
                {
                  "<Name>k__BackingField": "TesteInfoAdicional",
                  "<GeneralValues>k__BackingField": {
                    "Time": "Flamengo",
                    "Nome": "Pedro",
                    "Camisa": "9"
                  },
                  "<Conditions>k__BackingField": {
                    "<MinimumQuantity>k__BackingField": 0,
                    "<Parameters>k__BackingField": [
                      {
                        "<Name>k__BackingField": "PaymentMethodId",
                        "<Value>k__BackingField": "4"
                      }
                    ]
                  },
                  "<Effects>k__BackingField": {
                    "<Parameters>k__BackingField": [
                      {
                        "<Name>k__BackingField": "PercentualDiscount",
                        "<Value>k__BackingField": "1"
                      }
                    ]
                  }
                }
              ],
              "PromotionTeasers": [
                {
                  "Name": "TesteInfoAdicional",
                  "GeneralValues": {
                    "Time": "Flamengo",
                    "Nome": "Pedro",
                    "Camisa": "9"
                  },
                  "Conditions": {
                    "MinimumQuantity": 0,
                    "Parameters": [
                      {
                        "Name": "PaymentMethodId",
                        "Value": "4"
                      }
                    ]
                  },
                  "Effects": {
                    "Parameters": [
                      {
                        "Name": "PercentualDiscount",
                        "Value": "1"
                      }
                    ]
                  }
                }
              ],
              "BuyTogether": [],
              "ItemMetadataAttachment": [],
              "Price": 42,
              "ListPrice": 42,
              "PriceWithoutDiscount": 42,
              "RewardValue": 0,
              "PriceValidUntil": "4000-01-01T03:00:00Z",
              "AvailableQuantity": 16,
              "IsAvailable": true,
              "Tax": 0,
              "SaleChannel": 0,
              "DeliverySlaSamples": [
                {
                  "DeliverySlaPerTypes": [],
                  "Region": null
                }
              ],
              "GetInfoErrorMessage": null,
              "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_",
              "PaymentOptions": {
                "installmentOptions": [
                  {
                    "paymentSystem": "2",
                    "bin": null,
                    "paymentName": "Visa",
                    "paymentGroupName": "creditCardPaymentGroup",
                    "value": 4200,
                    "installments": [
                      {
                        "count": 1,
                        "hasInterestRate": false,
                        "interestRate": 0,
                        "value": 4200,
                        "total": 4200,
                        "sellerMerchantInstallments": [
                          {
                            "id": "MERCH",
                            "count": 1,
                            "hasInterestRate": false,
                            "interestRate": 0,
                            "value": 4200,
                            "total": 4200
                          }
                        ]
                      },
                      {
                        "count": 2,
                        "hasInterestRate": false,
                        "interestRate": 0,
                        "value": 2100,
                        "total": 4200,
                        "sellerMerchantInstallments": [
                          {
                            "id": "MERCH",
                            "count": 2,
                            "hasInterestRate": false,
                            "interestRate": 0,
                            "value": 2100,
                            "total": 4200
                          }
                        ]
                      },
                      {
                        "count": 3,
                        "hasInterestRate": false,
                        "interestRate": 0,
                        "value": 1400,
                        "total": 4200,
                        "sellerMerchantInstallments": [
                          {
                            "id": "MERCH",
                            "count": 3,
                            "hasInterestRate": false,
                            "interestRate": 0,
                            "value": 1400,
                            "total": 4200
                          }
                        ]
                      },
                      {
                        "count": 4,
                        "hasInterestRate": false,
                        "interestRate": 0,
                        "value": 1050,
                        "total": 4200,
                        "sellerMerchantInstallments": [
                          {
                            "id": "MERCH",
                            "count": 4,
                            "hasInterestRate": false,
                            "interestRate": 0,
                            "value": 1050,
                            "total": 4200
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "paymentSystem": "17",
                    "bin": null,
                    "paymentName": "Promissory",
                    "paymentGroupName": "promissoryPaymentGroup",
                    "value": 4200,
                    "installments": [
                      {
                        "count": 1,
                        "hasInterestRate": false,
                        "interestRate": 0,
                        "value": 4200,
                        "total": 4200,
                        "sellerMerchantInstallments": [
                          {
                            "id": "MERCH",
                            "count": 1,
                            "hasInterestRate": false,
                            "interestRate": 0,
                            "value": 4200,
                            "total": 4200
                          }
                        ]
                      }
                    ]
                  }
                ],
                "paymentSystems": [
                  {
                    "id": 17,
                    "name": "Promissory",
                    "groupName": "promissoryPaymentGroup",
                    "validator": null,
                    "stringId": "17",
                    "template": "promissoryPaymentGroup-template",
                    "requiresDocument": false,
                    "isCustom": false,
                    "description": null,
                    "requiresAuthentication": false,
                    "dueDate": "2021-07-01T18:43:00.0264384Z",
                    "availablePayments": null
                  },
                  {
                    "id": 2,
                    "name": "Visa",
                    "groupName": "creditCardPaymentGroup",
                    "validator": null,
                    "stringId": "2",
                    "template": "creditCardPaymentGroup-template",
                    "requiresDocument": false,
                    "isCustom": false,
                    "description": null,
                    "requiresAuthentication": false,
                    "dueDate": "2021-07-01T18:43:00.0264384Z",
                    "availablePayments": null
                  }
                ],
                "payments": [],
                "giftCards": [],
                "giftCardMessages": [],
                "availableAccounts": [],
                "availableTokens": []
              }
            }
          }
        ],
        "Videos": [],
        "estimatedDateArrival": null
      }
    ]
  }
]