openapi: 3.0.0 info: title: VTex Anti-fraud Provider Account Search API description: ">ℹ️ Onboarding guide\r\n>\r\n> Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.\r\n\r\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\r\n\r\n>⚠️ You can also access our [template on GitHub](https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\r\n\r\nTo learn more about the Anti-fraud Provider Protocol, check our [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works).\r\n\r\n## Anti-fraud Provider API Index\r\n\r\n### Anti-fraud Flow\r\n\r\n- `POST` [Send Anti-fraud Pre-Analysis Data (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/pre-analysis)\r\n- `POST` [Send Anti-fraud Data](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/transactions)\r\n- `PUT` [Update Anti-fraud Transactions (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#put-/transactions/-transactionId-)\r\n- `GET` [List Anti-fraud Provider Manifest](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/manifest)\r\n- `GET` [Get Anti-fraud Status](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/transactions/-transactions.id-)\r\n- `DELETE` [Stop Anti-fraud Analysis (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#delete-/transactions/-transactions.Id-)\r\n\r\n### OAuth Flow\r\n\r\n1. `POST` [Retrieve Token](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/authorization/token)\r\n2. `GET` [Redirect](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/redirect)\r\n3. `GET` [Return to VTEX](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorizationCode)\r\n4. `GET` [Get Credentials](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorization/credentials)" version: '1.0' servers: - url: https://{providerApiEndpoint} description: Anti-fraud provider endpoint URL. variables: providerApiEndpoint: description: Anti-fraud provider endpoint URL. default: '{providerApiEndpoint}' tags: - name: Search paths: /api/catalog_system/pub/products/search/{search}: get: tags: - Search summary: VTex Search for Products description: "Retrieves general information about the products related to the term searched. \r\nThis is the main search used by the store. The user can type anything to be searched. \r\n\r\nFor example, if they search for a \"decanter\", this is the URL: `https://{{accountName}}.{{environment}}.com.br/api/catalog_system/pub/products/search/decanter`. \r\n\r\nNote that maybe the response can be HTTP 200 or 206, 206 means that it's a partial content response.\r\n\r\nIf it is a 206 take a look at the Headers, will be an entry called resources. E.g.: resources → 0-9/19. This means that the response is showing items from 0 to 9, 10 items, but there were 19 items found. See more information at the paging route example." operationId: ProductSearch parameters: - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string example: application/json - name: Content-Type in: header description: Describes the type of the content being sent. required: true style: simple schema: type: string example: application/json - name: search in: path description: Term used to search products required: true style: simple schema: type: string example: jacket responses: '200': description: OK content: application/json: example: - 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: null categoryId: '1' productTitle: '' metaTagDescription: '' 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 Percentuals: - 4,9 Percentual: - 4,9 Total: - Percentuals - Percentual Teste de Api: - a Ale: - '1' Teste da Api2: - Teste de Api - Ale Alcool: - Percentual allSpecifications: - Percentuals - Percentual - Teste de Api - Ale allSpecificationsGroups: - Total - Teste da Api2 description: '' 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: hoegaarden-kit 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: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount 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 schema: type: array items: type: object required: - productId - productName - brand - brandId - brandImageUrl - linkText - productReference - productReferenceCode - categoryId - productTitle - metaTagDescription - releaseDate - clusterHighlights - productClusters - searchableClusters - categories - categoriesIds - link - Percentuals - Percentual - Total - Teste de Api - Ale - Teste da Api2 - Alcool - allSpecifications - allSpecificationsGroups - description - items properties: productId: type: string description: Product unique identifier. example: '35' productName: type: string description: Product name. example: Kit de Hoegaarden brand: type: string description: Brand name. example: Hoegaarden brandId: type: integer description: Product brand ID. example: 2000004 brandImageUrl: type: string description: Product's brand image URL. example: https://merch.vteximg.com.br/arquivos/ids/155532/hoegardden-logo.jpg linkText: type: string description: Product URL. example: kit-6-cerveja-hoegaarden productReference: type: string description: Product reference. example: 000806 productReferenceCode: type: integer description: Product reference ID. nullable: true example: 1234 categoryId: type: string description: Product category ID. example: '1' productTitle: type: string description: Text that is in the browser tab and corresponds to the title of the product page. This field is important for SEO. example: Kit 6 cerveja Hoegaarden metaTagDescription: type: string description: 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. example: Category for Beers releaseDate: type: string description: Product release date. example: '2020-10-07T00:00:00' clusterHighlights: type: object description: Cluster highlight ID and name. example: '138': teste2 productClusters: type: object description: Product clusters' IDs and names. example: '138': teste2 '143': NaoPesquisavel '146': colecaotestesubcategoria '161': merch_import_test1 searchableClusters: type: object description: Searchable clusters IDs and names example: '138': teste2 categories: type: array description: Array of the product's categories URLs. example: - /Beers Beers Mesmo/ categoriesIds: type: array description: Array of the product's categories IDs. example: - /1/ link: type: string description: Product URL. example: https://merch.vtexcommercestable.com.br/kit-6-cerveja-hoegaarden/p allSpecifications: type: array description: Array of the product's specifications. example: - Percentuals - Percentual items: type: string description: Product specification. example: Percentual allSpecificationsGroups: type: array description: Array of the product's specifications groups. example: - Total - Teste da Api2 items: type: string description: Product specification group example: Teste da Api2 description: type: string description: Description of the main information related to the product. A simple and easy to understand summary for the customer. example: Description example nullable: true items: type: array description: Array containing the product SKU general information. example: - 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: hoegaarden-kit 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: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount 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 items: type: object example: 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: hoegaarden-kit 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: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount 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 required: - itemId - name - nameComplete - complementName - ean - referenceId - measurementUnit - unitMultiplier - modalType - isKit - kitItems - images - sellers - Videos - estimatedDateArrival properties: itemId: type: string description: SKU ID. example: '310118469' name: type: string description: SKU name. example: Kit com 6 nameComplete: type: string description: SKU complete name. example: Kit de Hoegaarden Kit com 6 complementName: type: string description: SKU complement name. example: Complement name ean: type: string description: SKU unique identification code (barcode), accepts up to 13 numerical characters. example: '12345567' referenceId: type: array description: Reference code ID. example: - Key: RefId Value: 000806 items: type: object example: Key: RefId Value: 000806 required: - Key - Value properties: Key: type: string description: Reference Code. example: RefId Value: type: string description: Unique reference code used internally for organizational purposes. example: 000806 measurementUnit: type: string description: Used only in cases when you need to convert the unit of measure for sale. In common cases, use 'un'. example: un unitMultiplier: type: number description: numerical unit that multiplies the selected quantity of the product when it is inserted in the cart. example: 1 modalType: type: string description: Modal Type. nullable: true example: Modal Type test isKit: type: boolean description: If the SKU is part of a kit. example: true kitItems: type: array description: Array with information of SKUs components from a Kit. example: - itemId: '310118466' amount: 6 items: type: object example: itemId: '310118466' amount: 6 required: - itemId - amount properties: itemId: type: string description: SKU kit component ID. example: '310118466' amount: type: integer description: Amount of the SKU component in the kit. example: 6 images: type: array description: Array of information about the SKU image. example: - imageId: '155489' imageLabel: '' imageTag: hoegaarden-kit 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' items: type: object example: imageId: '155489' imageLabel: '' imageTag: hoegaarden-kit 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' required: - imageId - imageLabel - imageTag - imageUrl - imageText - imageLastModified properties: imageId: type: string description: Image ID. example: '155489' imageLabel: type: string description: Image label. example: Label test imageTag: type: string description: Image tag. example: hoegaarden-kit imageUrl: type: string description: Image URL. example: https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000 imageText: type: string description: Image text. nullable: true example: hoegaarden-kit imageLastModified: type: string description: Date and time of the last update of the image. example: '2020-10-07T12:49:27.5800000Z' sellers: type: array description: Array of SKU sellers. example: - 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: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount 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: [] items: type: object example: 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: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount 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: [] required: - sellerId - sellerName - addToCartLink - sellerDefault - commertialOffer properties: sellerId: type: string description: SKU seller ID. example: '1' sellerName: type: string description: SKU seller name. example: COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE addToCartLink: type: string description: URL to add the product to the cart. example: https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1 sellerDefault: type: boolean description: If the seller is default or not. example: true commertialOffer: type: object description: AKA Commertial Condition. example: 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: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount 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: [] required: - DeliverySlaSamplesPerRegion - Installments - DiscountHighLight - GiftSkuIds - Teasers - BuyTogether - ItemMetadataAttachment - Price - ListPrice - PriceWithoutDiscount - RewardValue - PriceValidUntil - AvailableQuantity - IsAvailable - Tax - SaleChannel - DeliverySlaSamples - GetInfoErrorMessage - CacheVersionUsedToCallCheckout - PaymentOptions properties: DeliverySlaSamplesPerRegion: type: object description: Delivery SLA samples per region. example: '0': DeliverySlaPerTypes: [] Region: 'null' properties: '0': type: object description: Delivery SLA ID. example: DeliverySlaPerTypes: [] Region: null required: - DeliverySlaPerTypes - Region properties: DeliverySlaPerTypes: type: array description: Delivery SLA per types. example: [] Region: type: string description: Region. nullable: true example: '' Installments: type: array description: Installments options. example: - 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 items: type: object example: Value: 42 InterestRate: 0 TotalValuePlusInterestRate: 42 NumberOfInstallments: 1 PaymentSystemName: Visa PaymentSystemGroupName: creditCardPaymentGroup Name: Visa à vista required: - Value - InterestRate - TotalValuePlusInterestRate - NumberOfInstallments - PaymentSystemName - PaymentSystemGroupName - Name properties: Value: type: number description: Value of the installment. example: 42 InterestRate: type: number description: Interest rate of the installment. example: 0 TotalValuePlusInterestRate: type: number description: Total value plus interest rate of the installment. example: 42 NumberOfInstallments: type: integer description: Number of the installment. example: 1 PaymentSystemName: type: string description: Payment system name of the installment. example: Visa PaymentSystemGroupName: type: string description: Payment system group name of the installment. example: creditCardPaymentGroup Name: type: string description: Name of the installment. example: Visa à vista DiscountHighLight: type: array description: Discount hightlight. example: [] GiftSkuIds: type: array description: Array of SKU gifts IDs. example: [] Teasers: type: array description: List with promotions teasers. example: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount k__BackingField: '1' items: type: object properties: k__BackingField: type: string description: Name. k__BackingField: type: object description: 'General values. Each property follows the format: `{field}:{value}.' properties: '{field}': type: string example: '{value}' k__BackingField: type: object description: Conditions. properties: k__BackingField: type: integer description: Minimum quantity. k__BackingField: type: array description: Parameters. items: type: object description: Parameter. properties: k__BackingField: type: string description: Name. k__BackingField: type: string description: Value. k__BackingField: type: object description: Effects. properties: k__BackingField: type: array description: Parameters. items: type: object description: Parameter. properties: k__BackingField: type: string description: Name. k__BackingField: type: string description: Value. PromotionTeasers: type: array description: List with promotions teasers. example: - Name: TesteInfoAdicional GeneralValues: Time: Flamengo Nome: Pedro Camisa: '9' Conditions: MinimumQuantity: 0 Parameters: - Name: PaymentMethodId Value: '4' Effects: Parameters: - Name: PercentualDiscount Value: '1' items: type: object properties: Name: type: string description: Name. GeneralValues: type: object description: 'General values. Each property follows the format: `{field}:{value}.' properties: '{field}': type: string example: '{value}' Conditions: type: object description: Conditions. properties: MinimumQuantity: type: integer description: Minimum quantity. Parameters: type: array description: Parameters. items: type: object description: Parameter. properties: Name: type: string description: Name. Value: type: string description: Value. Effects: type: object description: Effects. properties: Parameters: type: array description: Parameters. items: type: object description: Parameter. properties: Name: type: string description: Name. Value: type: string description: Value. BuyTogether: type: array description: Array of other products that can be bought together with the product in question. example: [] ItemMetadataAttachment: type: array description: Item metadata attachment. example: [] Price: type: number description: Price of the product. example: 42 ListPrice: type: number description: List price of the product. example: 42 PriceWithoutDiscount: type: number description: Price of the product without discount. example: 42 RewardValue: type: number description: Reward value of the product. example: 0 PriceValidUntil: type: string description: Price of the product valid until a certain date. example: '4000-01-01T03:00:00Z' AvailableQuantity: type: integer description: Use the `IsAvailable` field instead. example: 16 IsAvailable: type: boolean description: If the product is available or not. example: true Tax: type: number description: Tax of the product. example: 0 SaleChannel: type: integer description: Trade policy which the product is contained. example: 0 DeliverySlaSamples: type: array description: Delivery SLA samples. example: - DeliverySlaPerTypes: [] Region: null items: type: object example: DeliverySlaPerTypes: [] Region: null required: - DeliverySlaPerTypes - Region properties: DeliverySlaPerTypes: type: array description: Delivery SLA per types. example: [] Region: type: string description: Region. nullable: true example: null GetInfoErrorMessage: type: string description: Get info error message. nullable: true example: null CacheVersionUsedToCallCheckout: type: string description: Cache version used to call checkout. example: 95EF7E5476DF276E679167A399FE3103_ PaymentOptions: type: object description: Payment options. example: 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: [] required: - installmentOptions - paymentSystems - payments - giftCards - giftCardMessages - availableAccounts - availableTokens properties: installmentOptions: type: array description: installment options. example: - 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 items: type: object example: 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 required: - paymentSystem - bin - paymentName - paymentGroupName - value - installments properties: paymentSystem: type: string description: Payment system. example: '2' bin: type: string description: Bin. nullable: true example: null paymentName: type: string description: Payment name. example: Visa paymentGroupName: type: string description: Payment group name. example: creditCardPaymentGroup value: type: integer description: Value. example: 4200 installments: type: array description: Installments. example: - 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 items: type: object example: count: 1 hasInterestRate: false interestRate: 0 value: 4200 total: 4200 sellerMerchantInstallments: - id: MERCH count: 1 hasInterestRate: false interestRate: 0 value: 4200 total: 4200 required: - count - hasInterestRate - interestRate - value - total - sellerMerchantInstallments properties: count: type: integer description: Count. example: 1 hasInterestRate: type: boolean description: Has interest rate. example: false interestRate: type: integer description: Interest rate. example: 0 value: type: integer description: Value. example: 4200 total: type: integer description: Total. example: 4200 sellerMerchantInstallments: type: array description: Seller merchant installments. example: - id: MERCH count: 1 hasInterestRate: false interestRate: 0 value: 4200 total: 4200 items: type: object example: id: MERCH count: 1 hasInterestRate: false interestRate: 0 value: 4200 total: 4200 required: - id - count - hasInterestRate - interestRate - value - total properties: id: type: string description: ID. example: MERCH count: type: integer description: Count. example: 1 hasInterestRate: type: boolean description: Has interest rate. example: false interestRate: type: integer description: Interest rate. example: 0 value: type: integer description: Value. example: 4200 total: type: integer description: Total. example: 4200 paymentSystems: type: array description: Payment systems. example: - 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 items: type: object example: 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 required: - id - name - groupName - validator - stringId - template - requiresDocument - isCustom - description - requiresAuthentication - dueDate - availablePayments properties: id: type: integer description: ID. example: 17 name: type: string description: Name. example: Promissory groupName: type: string description: Group name. example: promissoryPaymentGroup validator: type: string description: Validator. nullable: true example: '' stringId: type: string description: String ID. example: '17' template: type: string description: Template. example: promissoryPaymentGroup-template requiresDocument: type: boolean description: If requires document or not. example: false isCustom: type: boolean description: If is custom or not. example: false description: type: string description: Description. nullable: true example: '' requiresAuthentication: type: boolean description: If requires authentication. example: false dueDate: type: string description: Due date. example: '2021-07-01T18:43:00.0264384Z' availablePayments: type: string description: Available payments. nullable: true example: '' payments: type: array description: Payments. example: [] giftCards: type: array description: GiftCards. example: [] giftCardMessages: type: array description: GiftCardMessages. example: [] availableAccounts: type: array description: Available accounts. example: [] availableTokens: type: array description: Available tokens. example: [] Videos: type: array description: Videos. example: [] estimatedDateArrival: type: string description: Estimated date arrival. nullable: true example: '' deprecated: false servers: - url: http://example.com/.{environment}.com.br variables: environment: default: DefaultParameterValue /api/catalog_system/pub/products/search: get: tags: - Search summary: VTex Search for Products with Filter, Order and Pagination description: "Retrieves general information about the store's products. This information can be filtered and ordered by a number of options. It also can be paginated, filtered and ordered. \r\n\r\n## Filters \r\n\r\n- **Filter by full text** - `ft={searchWord}` \r\nE.g.: `ft=television`\r\n\r\n- **Filter by category** - `fq=C:/{a}/{b}` \r\n`{a}` and `{b}` are Category IDs \r\nE.g.: `fq=C:/1000041/1000049/`\r\n\r\n- **Filter by brand** - `fq=B:/{a}/{b}` \r\n`{a}` and `{b}` are Brand IDs\r\nE.g.: `fq=B:/189385/189387/`\r\n\r\n- **Filter by specification** - `fq=specificationFilter_{a}:{b}` \r\n`{a}` is the specification ID\r\n`{b}` is the specification value\r\nE.g.: To filter products where the color is Blue, find the specification ID for color. Suppose it is 123, then the query will be: `fq=specificationFilter_123:Blue`\r\n\r\n- **Filter by price range** - `fq=P:[{a} TO {b}]` \r\n`{a}` is the minimum price \"from\"\r\n`{b}` is the highest price \"to\" \r\nE.g.: `fq=P:[0 TO 20]` will search products between 0.00 and 20.00. \r\n\r\n- **Filter by collection** - `fq=productClusterIds:{{productClusterId}}` \r\n`productClusterId` is the same as `collectionId` \r\nFor more information about collections, read [Creating a product collection](https://help.vtex.com/en/tutorial/creating-a-product-collection).\r\n\r\n- **Filter by product ID** - `fq=productId:{{productId}}`\r\n\r\n- **Filter by SKU ID** - `fq=skuId:{{skuId}}`\r\n\r\n- **Filter by referenceId** - `fq=alternateIds_RefId:{{referenceId}}`\r\n\r\n- **Filter by EAN13** - `fq=alternateIds_Ean:{{ean13}}`\r\n\r\n- **Filter by availability at a specific sales channel** - `fq=isAvailablePerSalesChannel_{{sc}}:{{bool}}` \r\n`{{sc}}` is the desired sales channel \r\n`{{bool}}` is true ou false, 1 or 0. \r\nE.g.: seaching available products for the sales channel 4 would be `fq=isAvailablePerSalesChannel_4:1`\r\n\r\n- **Filter by available at a specific seller** - `fq=sellerId:{{sellerId}}`\r\nThe search does not include White Label Sellers.\r\n\r\n## Pagination\r\n\r\n- **Initial item number** - `_from={{first}}`\r\n- **Final item number** - `_to={{last}}`\r\n\r\n>⚠️ This endpoint returns a maximum of 50 items per response, so the difference between `_from` and `_to` should not exceed this number. The result order is descending, from the highest product ID to the lowest.\r\n\r\n## Sorting\r\n\r\n- **Price** \r\n`O=OrderByPriceDESC` \r\n`O=OrderByPriceASC`\r\n\r\n- **Top Selling Products** \r\n`O=OrderByTopSaleDESC`\r\n\r\n- **Best Reviews** \r\n`O=OrderByReviewRateDESC`\r\n\r\n- **Name** \r\n`O=OrderByNameASC` \r\n`O=OrderByNameDESC`\r\n\r\n- **Release Date** \r\n`O=OrderByReleaseDateDESC`\r\n\r\n- **Best Discounts** \r\n`O=OrderByBestDiscountDESC`\r\n\r\n- **Score** \r\n`O=OrderByScoreDESC`" operationId: ProductSearchFilteredandOrdered parameters: - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string example: application/json - name: Content-Type in: header description: Describes the type of the content being sent. required: true style: simple schema: type: string example: application/json - name: _from in: query description: Starting page of the pagination range. This number must be below or equal to 2500 for the query to work. Note that the difference between the initial and final pages cannot exceed 50 pages. Therefore, each page will display a maximum of 50 items. required: false style: form schema: type: string example: '1' - name: _to in: query description: Final page of the pagination range. Note that the difference between the initial and final pages cannot exceed 50 pages. Therefore, each page will display a maximum of 50 items. required: false style: form schema: type: string example: '50' - name: ft in: query description: Filter by full text. The form is`ft={searchWord}`. required: false style: form schema: type: string example: television - name: fq in: query description: General filter. It can be by category (`fq=C:/{a}/{b}`), by specification (`fq=specificationFilter_{a}:{b}`), by price range (`fq=P:[{a} TO {b}]`), by collection (`fq=productClusterIds:{{productClusterId}}`), by product ID (`fq=productId:{{productId}}`), by SKU ID (`fq=skuId:{{skuId}}`), by Reference ID (`fq=alternateIds_RefId:{{referenceId}}`), by EAN13 (`fq=alternateIds_Ean:{{ean13}}`), by availability at a specific sales channel (`fq=isAvailablePerSalesChannel_{{sc}}:{{bool}}`), by available at a specific seller (`fq=sellerId:{{sellerId}}`). required: false style: form schema: type: string example: C:/1000041/1000049/ - name: O in: query description: Sorting method. It can be by Price (`O=OrderByPriceDESC` or `O=OrderByPriceASC`), by Top Selling Products (`O=OrderByTopSaleDESC`), by Best Reviews (`O=OrderByReviewRateDESC`), by Name (`O=OrderByNameASC` or `O=OrderByNameDESC`), by Release Date (`O=OrderByReleaseDateDESC`), by Best Discounts (`O=OrderByBestDiscountDESC`), by Score (`O=OrderByScoreDESC`). required: false style: form schema: type: string example: OrderByNameASC responses: '200': description: OK content: application/json: example: - 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: null categoryId: '1' productTitle: '' metaTagDescription: '' 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 Percentuals: - 4,9 Percentual: - 4,9 Total: - Percentuals - Percentual Teste de Api: - a Ale: - '1' Teste da Api2: - Teste de Api - Ale Alcool: - Percentual allSpecifications: - Percentuals - Percentual - Teste de Api - Ale allSpecificationsGroups: - Total - Teste da Api2 description: '' 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: hoegaarden-kit 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: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount 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 schema: type: array items: type: object required: - productId - productName - brand - brandId - brandImageUrl - linkText - productReference - productReferenceCode - categoryId - productTitle - metaTagDescription - releaseDate - clusterHighlights - productClusters - searchableClusters - categories - categoriesIds - link - Percentuals - Percentual - Total - Teste de Api - Ale - Teste da Api2 - Alcool - allSpecifications - allSpecificationsGroups - description - items properties: productId: type: string description: Product unique identifier. example: '35' productName: type: string description: Product name. example: Kit de Hoegaarden brand: type: string description: Brand name. example: Hoegaarden brandId: type: integer description: Product brand ID. example: 2000004 brandImageUrl: type: string description: Product's brand image URL. example: https://merch.vteximg.com.br/arquivos/ids/155532/hoegardden-logo.jpg linkText: type: string description: Product URL. example: kit-6-cerveja-hoegaarden productReference: type: string description: Product reference. example: 000806 productReferenceCode: type: integer description: Product reference ID. nullable: true example: 1234 categoryId: type: string description: Product category ID. example: '1' productTitle: type: string description: Text that is in the browser tab and corresponds to the title of the product page. This field is important for SEO. example: Kit 6 cerveja Hoegaarden metaTagDescription: type: string description: 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. example: Category for Beers releaseDate: type: string description: Product release date. example: '2020-10-07T00:00:00' clusterHighlights: type: object description: Cluster highlight ID and name. example: '138': teste2 productClusters: type: object description: Product clusters' IDs and names. example: '138': teste2 '143': NaoPesquisavel '146': colecaotestesubcategoria '161': merch_import_test1 searchableClusters: type: object description: Searchable clusters IDs and names example: '138': teste2 categories: type: array description: Array of the product's categories URLs. example: - /Beers Beers Mesmo/ categoriesIds: type: array description: Array of the product's categories IDs. example: - /1/ link: type: string description: Product URL. example: https://merch.vtexcommercestable.com.br/kit-6-cerveja-hoegaarden/p allSpecifications: type: array description: Array of the product's specifications. example: - Percentuals - Percentual items: type: string description: Product specification. example: Percentual allSpecificationsGroups: type: array description: Array of the product's specifications groups. example: - Total - Teste da Api2 items: type: string description: Product specification group example: Teste da Api2 description: type: string description: Description of the main information related to the product. A simple and easy to understand summary for the customer. example: Description example nullable: true items: type: array description: Array containing the product SKU general information. example: - 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: hoegaarden-kit 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: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount 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 items: type: object example: 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: hoegaarden-kit 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: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount 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 required: - itemId - name - nameComplete - complementName - ean - referenceId - measurementUnit - unitMultiplier - modalType - isKit - kitItems - images - sellers - Videos - estimatedDateArrival properties: itemId: type: string description: SKU ID. example: '310118469' name: type: string description: SKU name. example: Kit com 6 nameComplete: type: string description: SKU complete name. example: Kit de Hoegaarden Kit com 6 complementName: type: string description: SKU complement name. example: Complement name ean: type: string description: SKU unique identification code (barcode), accepts up to 13 numerical characters. example: '12345567' referenceId: type: array description: Reference code ID. example: - Key: RefId Value: 000806 items: type: object example: Key: RefId Value: 000806 required: - Key - Value properties: Key: type: string description: Reference Code. example: RefId Value: type: string description: Unique reference code used internally for organizational purposes. example: 000806 measurementUnit: type: string description: Used only in cases when you need to convert the unit of measure for sale. In common cases, use 'un'. example: un unitMultiplier: type: number description: numerical unit that multiplies the selected quantity of the product when it is inserted in the cart. example: 1 modalType: type: string description: Modal Type. nullable: true example: Modal Type test isKit: type: boolean description: If the SKU is part of a kit. example: true kitItems: type: array description: Array with information of SKUs components from a Kit. example: - itemId: '310118466' amount: 6 items: type: object example: itemId: '310118466' amount: 6 required: - itemId - amount properties: itemId: type: string description: SKU kit component ID. example: '310118466' amount: type: integer description: Amount of the SKU component in the kit. example: 6 images: type: array description: Array of information about the SKU image. example: - imageId: '155489' imageLabel: '' imageTag: hoegaarden-kit 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' items: type: object example: imageId: '155489' imageLabel: '' imageTag: hoegaarden-kit 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' required: - imageId - imageLabel - imageTag - imageUrl - imageText - imageLastModified properties: imageId: type: string description: Image ID. example: '155489' imageLabel: type: string description: Image label. example: Label test imageTag: type: string description: Image tag. example: hoegaarden-kit imageUrl: type: string description: Image URL. example: https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000 imageText: type: string description: Image text. nullable: true example: hoegaarden-kit imageLastModified: type: string description: Date and time of the last update of the image. example: '2020-10-07T12:49:27.5800000Z' sellers: type: array description: Array of SKU sellers. example: - 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: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount 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: [] items: type: object example: 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: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount 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: [] required: - sellerId - sellerName - addToCartLink - sellerDefault - commertialOffer properties: sellerId: type: string description: SKU seller ID. example: '1' sellerName: type: string description: SKU seller name. example: COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE addToCartLink: type: string description: URL to add the product to the cart. example: https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1 sellerDefault: type: boolean description: If the seller is default or not. example: true commertialOffer: type: object description: AKA Commertial Condition. example: 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: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount 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: [] required: - DeliverySlaSamplesPerRegion - Installments - DiscountHighLight - GiftSkuIds - Teasers - BuyTogether - ItemMetadataAttachment - Price - ListPrice - PriceWithoutDiscount - RewardValue - PriceValidUntil - AvailableQuantity - IsAvailable - Tax - SaleChannel - DeliverySlaSamples - GetInfoErrorMessage - CacheVersionUsedToCallCheckout - PaymentOptions properties: DeliverySlaSamplesPerRegion: type: object description: Delivery SLA samples per region. example: '0': DeliverySlaPerTypes: [] Region: 'null' properties: '0': type: object description: Delivery SLA ID. example: DeliverySlaPerTypes: [] Region: null required: - DeliverySlaPerTypes - Region properties: DeliverySlaPerTypes: type: array description: Delivery SLA per types. example: [] Region: type: string description: Region. nullable: true example: '' Installments: type: array description: Installments options. example: - 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 items: type: object example: Value: 42 InterestRate: 0 TotalValuePlusInterestRate: 42 NumberOfInstallments: 1 PaymentSystemName: Visa PaymentSystemGroupName: creditCardPaymentGroup Name: Visa à vista required: - Value - InterestRate - TotalValuePlusInterestRate - NumberOfInstallments - PaymentSystemName - PaymentSystemGroupName - Name properties: Value: type: number description: Value of the installment. example: 42 InterestRate: type: number description: Interest rate of the installment. example: 0 TotalValuePlusInterestRate: type: number description: Total value plus interest rate of the installment. example: 42 NumberOfInstallments: type: integer description: Number of the installment. example: 1 PaymentSystemName: type: string description: Payment system name of the installment. example: Visa PaymentSystemGroupName: type: string description: Payment system group name of the installment. example: creditCardPaymentGroup Name: type: string description: Name of the installment. example: Visa à vista DiscountHighLight: type: array description: Discount hightlight. example: [] GiftSkuIds: type: array description: Array of SKU gifts IDs. example: [] Teasers: type: array description: List with promotions teasers. example: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount k__BackingField: '1' items: type: object properties: k__BackingField: type: string description: Name. k__BackingField: type: object description: 'General values. Each property follows the format: `{field}:{value}.' properties: '{field}': type: string example: '{value}' k__BackingField: type: object description: Conditions. properties: k__BackingField: type: integer description: Minimum quantity. k__BackingField: type: array description: Parameters. items: type: object description: Parameter. properties: k__BackingField: type: string description: Name. k__BackingField: type: string description: Value. k__BackingField: type: object description: Effects. properties: k__BackingField: type: array description: Parameters. items: type: object description: Parameter. properties: k__BackingField: type: string description: Name. k__BackingField: type: string description: Value. PromotionTeasers: type: array description: List with promotions teasers. example: - Name: TesteInfoAdicional GeneralValues: Time: Flamengo Nome: Pedro Camisa: '9' Conditions: MinimumQuantity: 0 Parameters: - Name: PaymentMethodId Value: '4' Effects: Parameters: - Name: PercentualDiscount Value: '1' items: type: object properties: Name: type: string description: Name. GeneralValues: type: object description: 'General values. Each property follows the format: `{field}:{value}.' properties: '{field}': type: string example: '{value}' Conditions: type: object description: Conditions. properties: MinimumQuantity: type: integer description: Minimum quantity. Parameters: type: array description: Parameters. items: type: object description: Parameter. properties: Name: type: string description: Name. Value: type: string description: Value. Effects: type: object description: Effects. properties: Parameters: type: array description: Parameters. items: type: object description: Parameter. properties: Name: type: string description: Name. Value: type: string description: Value. BuyTogether: type: array description: Array of other products that can be bought together with the product in question. example: [] ItemMetadataAttachment: type: array description: Item metadata attachment. example: [] Price: type: number description: Price of the product. example: 42 ListPrice: type: number description: List price of the product. example: 42 PriceWithoutDiscount: type: number description: Price of the product without discount. example: 42 RewardValue: type: number description: Reward value of the product. example: 0 PriceValidUntil: type: string description: Price of the product valid until a certain date. example: '4000-01-01T03:00:00Z' AvailableQuantity: type: integer description: Use the `IsAvailable` field instead. example: 16 IsAvailable: type: boolean description: If the product is available or not. example: true Tax: type: number description: Tax of the product. example: 0 SaleChannel: type: integer description: Trade policy which the product is contained. example: 0 DeliverySlaSamples: type: array description: Delivery SLA samples. example: - DeliverySlaPerTypes: [] Region: null items: type: object example: DeliverySlaPerTypes: [] Region: null required: - DeliverySlaPerTypes - Region properties: DeliverySlaPerTypes: type: array description: Delivery SLA per types. example: [] Region: type: string description: Region. nullable: true example: null GetInfoErrorMessage: type: string description: Get info error message. nullable: true example: null CacheVersionUsedToCallCheckout: type: string description: Cache version used to call checkout. example: 95EF7E5476DF276E679167A399FE3103_ PaymentOptions: type: object description: Payment options. example: 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: [] required: - installmentOptions - paymentSystems - payments - giftCards - giftCardMessages - availableAccounts - availableTokens properties: installmentOptions: type: array description: installment options. example: - 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 items: type: object example: 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 required: - paymentSystem - bin - paymentName - paymentGroupName - value - installments properties: paymentSystem: type: string description: Payment system. example: '2' bin: type: string description: Bin. nullable: true example: null paymentName: type: string description: Payment name. example: Visa paymentGroupName: type: string description: Payment group name. example: creditCardPaymentGroup value: type: integer description: Value. example: 4200 installments: type: array description: Installments. example: - 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 items: type: object example: count: 1 hasInterestRate: false interestRate: 0 value: 4200 total: 4200 sellerMerchantInstallments: - id: MERCH count: 1 hasInterestRate: false interestRate: 0 value: 4200 total: 4200 required: - count - hasInterestRate - interestRate - value - total - sellerMerchantInstallments properties: count: type: integer description: Count. example: 1 hasInterestRate: type: boolean description: Has interest rate. example: false interestRate: type: integer description: Interest rate. example: 0 value: type: integer description: Value. example: 4200 total: type: integer description: Total. example: 4200 sellerMerchantInstallments: type: array description: Seller merchant installments. example: - id: MERCH count: 1 hasInterestRate: false interestRate: 0 value: 4200 total: 4200 items: type: object example: id: MERCH count: 1 hasInterestRate: false interestRate: 0 value: 4200 total: 4200 required: - id - count - hasInterestRate - interestRate - value - total properties: id: type: string description: ID. example: MERCH count: type: integer description: Count. example: 1 hasInterestRate: type: boolean description: Has interest rate. example: false interestRate: type: integer description: Interest rate. example: 0 value: type: integer description: Value. example: 4200 total: type: integer description: Total. example: 4200 paymentSystems: type: array description: Payment systems. example: - 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 items: type: object example: 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 required: - id - name - groupName - validator - stringId - template - requiresDocument - isCustom - description - requiresAuthentication - dueDate - availablePayments properties: id: type: integer description: ID. example: 17 name: type: string description: Name. example: Promissory groupName: type: string description: Group name. example: promissoryPaymentGroup validator: type: string description: Validator. nullable: true example: '' stringId: type: string description: String ID. example: '17' template: type: string description: Template. example: promissoryPaymentGroup-template requiresDocument: type: boolean description: If requires document or not. example: false isCustom: type: boolean description: If is custom or not. example: false description: type: string description: Description. nullable: true example: '' requiresAuthentication: type: boolean description: If requires authentication. example: false dueDate: type: string description: Due date. example: '2021-07-01T18:43:00.0264384Z' availablePayments: type: string description: Available payments. nullable: true example: '' payments: type: array description: Payments. example: [] giftCards: type: array description: GiftCards. example: [] giftCardMessages: type: array description: GiftCardMessages. example: [] availableAccounts: type: array description: Available accounts. example: [] availableTokens: type: array description: Available tokens. example: [] Videos: type: array description: Videos. example: [] estimatedDateArrival: type: string description: Estimated date arrival. nullable: true example: '' deprecated: false servers: - url: http://example.com/.{environment}.com.br variables: environment: default: DefaultParameterValue /api/catalog_system/pub/products/search/{product-text-link}/p: get: tags: - Search summary: VTex Search Product by Product URL description: Retrieves general information about the product of the URL you searched for. operationId: Searchbyproducturl parameters: - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string example: application/json - name: Content-Type in: header description: Describes the type of the content being sent. required: true style: simple schema: type: string example: application/json - name: product-text-link in: path description: Product URL required: true style: simple schema: type: string example: blue-shirt responses: '200': description: '' headers: {} content: application/json: example: - 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: null categoryId: '1' productTitle: '' metaTagDescription: '' 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 Percentuals: - 4,9 Percentual: - 4,9 Total: - Percentuals - Percentual Teste de Api: - a Ale: - '1' Teste da Api2: - Teste de Api - Ale Alcool: - Percentual allSpecifications: - Percentuals - Percentual - Teste de Api - Ale allSpecificationsGroups: - Total - Teste da Api2 description: '' 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: hoegaarden-kit 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: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount 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 schema: type: array items: type: object required: - productId - productName - brand - brandId - brandImageUrl - linkText - productReference - productReferenceCode - categoryId - productTitle - metaTagDescription - releaseDate - clusterHighlights - productClusters - searchableClusters - categories - categoriesIds - link - Percentuals - Percentual - Total - Teste de Api - Ale - Teste da Api2 - Alcool - allSpecifications - allSpecificationsGroups - description - items properties: productId: type: string description: Product unique identifier. example: '35' productName: type: string description: Product name. example: Kit de Hoegaarden brand: type: string description: Brand name. example: Hoegaarden brandId: type: integer description: Product brand ID. example: 2000004 brandImageUrl: type: string description: Product's brand image URL. example: https://merch.vteximg.com.br/arquivos/ids/155532/hoegardden-logo.jpg linkText: type: string description: Product URL. example: kit-6-cerveja-hoegaarden productReference: type: string description: Product reference. example: 000806 productReferenceCode: type: integer description: Product reference ID. nullable: true example: 1234 categoryId: type: string description: Product category ID. example: '1' productTitle: type: string description: Text that is in the browser tab and corresponds to the title of the product page. This field is important for SEO. example: Kit 6 cerveja Hoegaarden metaTagDescription: type: string description: 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. example: Category for Beers releaseDate: type: string description: Product release date. example: '2020-10-07T00:00:00' clusterHighlights: type: object description: Cluster highlight ID and name. example: '138': teste2 productClusters: type: object description: Product clusters' IDs and names. example: '138': teste2 '143': NaoPesquisavel '146': colecaotestesubcategoria '161': merch_import_test1 searchableClusters: type: object description: Searchable clusters IDs and names example: '138': teste2 categories: type: array description: Array of the product's categories URLs. example: - /Beers Beers Mesmo/ categoriesIds: type: array description: Array of the product's categories IDs. example: - /1/ link: type: string description: Product URL. example: https://merch.vtexcommercestable.com.br/kit-6-cerveja-hoegaarden/p allSpecifications: type: array description: Array of the product's specifications. example: - Percentuals - Percentual items: type: string description: Product specification. example: Percentual allSpecificationsGroups: type: array description: Array of the product's specifications groups. example: - Total - Teste da Api2 items: type: string description: Product specification group example: Teste da Api2 description: type: string description: Description of the main information related to the product. A simple and easy to understand summary for the customer. example: Description example nullable: true items: type: array description: Array containing the product SKU general information. example: - 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: hoegaarden-kit 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: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount 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 items: type: object example: 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: hoegaarden-kit 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: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount 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 required: - itemId - name - nameComplete - complementName - ean - referenceId - measurementUnit - unitMultiplier - modalType - isKit - kitItems - images - sellers - Videos - estimatedDateArrival properties: itemId: type: string description: SKU ID. example: '310118469' name: type: string description: SKU name. example: Kit com 6 nameComplete: type: string description: SKU complete name. example: Kit de Hoegaarden Kit com 6 complementName: type: string description: SKU complement name. example: Complement name ean: type: string description: SKU unique identification code (barcode), accepts up to 13 numerical characters. example: '12345567' referenceId: type: array description: Reference code ID. example: - Key: RefId Value: 000806 items: type: object example: Key: RefId Value: 000806 required: - Key - Value properties: Key: type: string description: Reference Code. example: RefId Value: type: string description: Unique reference code used internally for organizational purposes. example: 000806 measurementUnit: type: string description: Used only in cases when you need to convert the unit of measure for sale. In common cases, use 'un'. example: un unitMultiplier: type: number description: numerical unit that multiplies the selected quantity of the product when it is inserted in the cart. example: 1 modalType: type: string description: Modal Type. nullable: true example: Modal Type test isKit: type: boolean description: If the SKU is part of a kit. example: true kitItems: type: array description: Array with information of SKUs components from a Kit. example: - itemId: '310118466' amount: 6 items: type: object example: itemId: '310118466' amount: 6 required: - itemId - amount properties: itemId: type: string description: SKU kit component ID. example: '310118466' amount: type: integer description: Amount of the SKU component in the kit. example: 6 images: type: array description: Array of information about the SKU image. example: - imageId: '155489' imageLabel: '' imageTag: hoegaarden-kit 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' items: type: object example: imageId: '155489' imageLabel: '' imageTag: hoegaarden-kit 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' required: - imageId - imageLabel - imageTag - imageUrl - imageText - imageLastModified properties: imageId: type: string description: Image ID. example: '155489' imageLabel: type: string description: Image label. example: Label test imageTag: type: string description: Image tag. example: hoegaarden-kit imageUrl: type: string description: Image URL. example: https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000 imageText: type: string description: Image text. nullable: true example: hoegaarden-kit imageLastModified: type: string description: Date and time of the last update of the image. example: '2020-10-07T12:49:27.5800000Z' sellers: type: array description: Array of SKU sellers. example: - 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: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount 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: [] items: type: object example: 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: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount 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: [] required: - sellerId - sellerName - addToCartLink - sellerDefault - commertialOffer properties: sellerId: type: string description: SKU seller ID. example: '1' sellerName: type: string description: SKU seller name. example: COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE addToCartLink: type: string description: URL to add the product to the cart. example: https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1 sellerDefault: type: boolean description: If the seller is default or not. example: true commertialOffer: type: object description: AKA Commertial Condition. example: 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: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount 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: [] required: - DeliverySlaSamplesPerRegion - Installments - DiscountHighLight - GiftSkuIds - Teasers - BuyTogether - ItemMetadataAttachment - Price - ListPrice - PriceWithoutDiscount - RewardValue - PriceValidUntil - AvailableQuantity - IsAvailable - Tax - SaleChannel - DeliverySlaSamples - GetInfoErrorMessage - CacheVersionUsedToCallCheckout - PaymentOptions properties: DeliverySlaSamplesPerRegion: type: object description: Delivery SLA samples per region. example: '0': DeliverySlaPerTypes: [] Region: 'null' properties: '0': type: object description: Delivery SLA ID. example: DeliverySlaPerTypes: [] Region: null required: - DeliverySlaPerTypes - Region properties: DeliverySlaPerTypes: type: array description: Delivery SLA per types. example: [] Region: type: string description: Region. nullable: true example: '' Installments: type: array description: Installments options. example: - 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 items: type: object example: Value: 42 InterestRate: 0 TotalValuePlusInterestRate: 42 NumberOfInstallments: 1 PaymentSystemName: Visa PaymentSystemGroupName: creditCardPaymentGroup Name: Visa à vista required: - Value - InterestRate - TotalValuePlusInterestRate - NumberOfInstallments - PaymentSystemName - PaymentSystemGroupName - Name properties: Value: type: number description: Value of the installment. example: 42 InterestRate: type: number description: Interest rate of the installment. example: 0 TotalValuePlusInterestRate: type: number description: Total value plus interest rate of the installment. example: 42 NumberOfInstallments: type: integer description: Number of the installment. example: 1 PaymentSystemName: type: string description: Payment system name of the installment. example: Visa PaymentSystemGroupName: type: string description: Payment system group name of the installment. example: creditCardPaymentGroup Name: type: string description: Name of the installment. example: Visa à vista DiscountHighLight: type: array description: Discount hightlight. example: [] GiftSkuIds: type: array description: Array of SKU gifts IDs. example: [] Teasers: type: array description: List with promotions teasers. example: - k__BackingField: TesteInfoAdicional k__BackingField: Time: Flamengo Nome: Pedro Camisa: '9' k__BackingField: k__BackingField: 0 k__BackingField: - k__BackingField: PaymentMethodId k__BackingField: '4' k__BackingField: k__BackingField: - k__BackingField: PercentualDiscount k__BackingField: '1' items: type: object properties: k__BackingField: type: string description: Name. k__BackingField: type: object description: 'General values. Each property follows the format: `{field}:{value}.' properties: '{field}': type: string example: '{value}' k__BackingField: type: object description: Conditions. properties: k__BackingField: type: integer description: Minimum quantity. k__BackingField: type: array description: Parameters. items: type: object description: Parameter. properties: k__BackingField: type: string description: Name. k__BackingField: type: string description: Value. k__BackingField: type: object description: Effects. properties: k__BackingField: type: array description: Parameters. items: type: object description: Parameter. properties: k__BackingField: type: string description: Name. k__BackingField: type: string description: Value. PromotionTeasers: type: array description: List with promotions teasers. example: - Name: TesteInfoAdicional GeneralValues: Time: Flamengo Nome: Pedro Camisa: '9' Conditions: MinimumQuantity: 0 Parameters: - Name: PaymentMethodId Value: '4' Effects: Parameters: - Name: PercentualDiscount Value: '1' items: type: object properties: Name: type: string description: Name. GeneralValues: type: object description: 'General values. Each property follows the format: `{field}:{value}.' properties: '{field}': type: string example: '{value}' Conditions: type: object description: Conditions. properties: MinimumQuantity: type: integer description: Minimum quantity. Parameters: type: array description: Parameters. items: type: object description: Parameter. properties: Name: type: string description: Name. Value: type: string description: Value. Effects: type: object description: Effects. properties: Parameters: type: array description: Parameters. items: type: object description: Parameter. properties: Name: type: string description: Name. Value: type: string description: Value. BuyTogether: type: array description: Array of other products that can be bought together with the product in question. example: [] ItemMetadataAttachment: type: array description: Item metadata attachment. example: [] Price: type: number description: Price of the product. example: 42 ListPrice: type: number description: List price of the product. example: 42 PriceWithoutDiscount: type: number description: Price of the product without discount. example: 42 RewardValue: type: number description: Reward value of the product. example: 0 PriceValidUntil: type: string description: Price of the product valid until a certain date. example: '4000-01-01T03:00:00Z' AvailableQuantity: type: integer description: Use the `IsAvailable` field instead. example: 16 IsAvailable: type: boolean description: If the product is available or not. example: true Tax: type: number description: Tax of the product. example: 0 SaleChannel: type: integer description: Trade policy which the product is contained. example: 0 DeliverySlaSamples: type: array description: Delivery SLA samples. example: - DeliverySlaPerTypes: [] Region: null items: type: object example: DeliverySlaPerTypes: [] Region: null required: - DeliverySlaPerTypes - Region properties: DeliverySlaPerTypes: type: array description: Delivery SLA per types. example: [] Region: type: string description: Region. nullable: true example: null GetInfoErrorMessage: type: string description: Get info error message. nullable: true example: null CacheVersionUsedToCallCheckout: type: string description: Cache version used to call checkout. example: 95EF7E5476DF276E679167A399FE3103_ PaymentOptions: type: object description: Payment options. example: 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: [] required: - installmentOptions - paymentSystems - payments - giftCards - giftCardMessages - availableAccounts - availableTokens properties: installmentOptions: type: array description: installment options. example: - 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 items: type: object example: 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 required: - paymentSystem - bin - paymentName - paymentGroupName - value - installments properties: paymentSystem: type: string description: Payment system. example: '2' bin: type: string description: Bin. nullable: true example: null paymentName: type: string description: Payment name. example: Visa paymentGroupName: type: string description: Payment group name. example: creditCardPaymentGroup value: type: integer description: Value. example: 4200 installments: type: array description: Installments. example: - 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 items: type: object example: count: 1 hasInterestRate: false interestRate: 0 value: 4200 total: 4200 sellerMerchantInstallments: - id: MERCH count: 1 hasInterestRate: false interestRate: 0 value: 4200 total: 4200 required: - count - hasInterestRate - interestRate - value - total - sellerMerchantInstallments properties: count: type: integer description: Count. example: 1 hasInterestRate: type: boolean description: Has interest rate. example: false interestRate: type: integer description: Interest rate. example: 0 value: type: integer description: Value. example: 4200 total: type: integer description: Total. example: 4200 sellerMerchantInstallments: type: array description: Seller merchant installments. example: - id: MERCH count: 1 hasInterestRate: false interestRate: 0 value: 4200 total: 4200 items: type: object example: id: MERCH count: 1 hasInterestRate: false interestRate: 0 value: 4200 total: 4200 required: - id - count - hasInterestRate - interestRate - value - total properties: id: type: string description: ID. example: MERCH count: type: integer description: Count. example: 1 hasInterestRate: type: boolean description: Has interest rate. example: false interestRate: type: integer description: Interest rate. example: 0 value: type: integer description: Value. example: 4200 total: type: integer description: Total. example: 4200 paymentSystems: type: array description: Payment systems. example: - 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 items: type: object example: 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 required: - id - name - groupName - validator - stringId - template - requiresDocument - isCustom - description - requiresAuthentication - dueDate - availablePayments properties: id: type: integer description: ID. example: 17 name: type: string description: Name. example: Promissory groupName: type: string description: Group name. example: promissoryPaymentGroup validator: type: string description: Validator. nullable: true example: '' stringId: type: string description: String ID. example: '17' template: type: string description: Template. example: promissoryPaymentGroup-template requiresDocument: type: boolean description: If requires document or not. example: false isCustom: type: boolean description: If is custom or not. example: false description: type: string description: Description. nullable: true example: '' requiresAuthentication: type: boolean description: If requires authentication. example: false dueDate: type: string description: Due date. example: '2021-07-01T18:43:00.0264384Z' availablePayments: type: string description: Available payments. nullable: true example: '' payments: type: array description: Payments. example: [] giftCards: type: array description: GiftCards. example: [] giftCardMessages: type: array description: GiftCardMessages. example: [] availableAccounts: type: array description: Available accounts. example: [] availableTokens: type: array description: Available tokens. example: [] Videos: type: array description: Videos. example: [] estimatedDateArrival: type: string description: Estimated date arrival. nullable: true example: '' deprecated: false servers: - url: http://example.com/.{environment}.com.br variables: environment: default: DefaultParameterValue /api/dataentities/{dataEntityName}/search: get: tags: - Search summary: VTex Search documents description: "Retrieves documents' information, while choosing which fields will be returned and filtering documents by specific fields.\r\n\r\n> The response header `REST-Content-Range` indicates the total amount of results for that specific search. For example, it may return `resources 0-100/136108`, which indicates it has returned results from 0 to 100 of a total 136108.\r\n\r\nBelow you can see some query examples and learn more about each query parameter.\n\r\n\r> Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `503`.\r\n\r\n## Query examples\r\n\r\n### Simple filter\r\n\r\n```\r\n/dataentities/Newsletter/search?email=my@email.com\r\n```\r\n\r\n### Complex filter\r\n\r\n```\r\n/dataentities/Newsletter/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)\r\n```\r\n\r\n### Date Range\r\n\r\n```\r\n/dataentities/Newsletter/search?_where=createdIn between 2001-01-01 AND 2016-01-01\r\n```\r\n\r\n### Range numeric fields\r\n\r\n```\r\n/dataentities/Newsletter/search?_where=age between 18 AND 25\r\n```\r\n\r\n### Partial filter\r\n\r\n```\r\n/dataentities/Newsletter/search?firstName=*Maria*\r\n```\r\n\r\n### Filter for null values\r\n\r\n```\r\n/dataentities/Newsletter/search?_where=firstName is null\r\n```\r\n\r\n### Filter for non-null values\r\n\r\n```\r\n/dataentities/Newsletter/search?_where=firstName is not null\r\n```\r\n\r\n### Filter for difference\r\n```\r\n/dataentities/Newsletter/search?_where=firstName<>maria\r\n```\r\n\r\n### Filter greater than or less than\r\n```\r\n/dataentities/Newsletter/search?_where=number>5\r\n/dataentities/Newsletter/search?_where=date<2001-01-01\r\n``` \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: Searchdocuments parameters: - $ref: '#/components/parameters/dataEntityName' - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/REST-Range' - $ref: '#/components/parameters/_fields' - $ref: '#/components/parameters/_where' - $ref: '#/components/parameters/_schema' - $ref: '#/components/parameters/_sort' responses: '200': description: OK content: application/json: schema: type: array description: List of documents that correspond to the result of the search. items: $ref: '#/components/schemas/Using_fields_all' example: - id: b818cbda-e489-11e6-94f4-0ac138d2d42e accountId: 14af940d-9300-4279-9355-61d44c2ff879 accountName: apiexamples dataEntityId: Newsletter '400': description: Bad Request content: application/json: schema: type: object description: Response body object. properties: Message: type: string description: Error message. example: Message: Field 'X' not found in schema '403': description: Forbidden content: application/json: schema: type: object description: Response body object. properties: Message: type: string description: Error message. example: Message: Cannot filter by private fields '503': description: Service Unavailable. Wildcard queries temporarily blocked due to excessive usage. Consider adjusting your code to remove them or reduce the rate of search requests with wildcards (*). This temporary block may also be due to excessive use of requests with the parameter `keyword`. deprecated: false components: parameters: _fields: name: _fields in: query description: Fields that should be returned by document. Separate fields' names with commas. For example `_fields=email,firstName,document`. You can also use `_fields=_all` to fetch all fields. required: false style: form schema: type: string example: email,firstName,document dataEntityName: name: dataEntityName in: path required: true description: Name of the data entity. schema: type: string example: Newsletter _sort: name: _sort in: query description: Sets sorting mode in two parts. The first part is the name of the field you want to sort by. In the second part, use `ASC` for ascending or `DESC` for descending. required: false style: form schema: type: string example: firstName ASC _schema: name: _schema in: query description: Name of the [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) that the document complies with. This field is required when using `_where` or `_fields` query parameters. required: false style: form schema: type: string example: schema REST-Range: name: REST-Range in: header description: Defines the collection of documents to be returned. A range within the collection limited by 100 documents per query. required: true style: simple schema: type: string example: resources=0-10 Accept: name: Accept in: header description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string example: application/json Content-Type: name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string example: application/json _where: name: _where in: query description: Defines a clause the document must comply with. required: false style: form schema: type: string example: firstName is not null schemas: Using_fields_all: title: Using_fields=_all required: - id - accountId - accountName - dataEntityId type: object description: Document information. properties: id: type: string description: ID of the document. accountId: type: string description: ID of the VTEX account. accountName: type: string description: Name of the VTEX account. dataEntityId: type: string description: Data entity name. securitySchemes: VtexIdclientAutCookie: type: apiKey in: header name: VtexIdclientAutCookie description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'