> ## Documentation Index > Fetch the complete documentation index at: https://docs.yampi.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Objetos ## Variáveis Globais ### `merchantData` Contém informações gerais sobre a loja, como domínio, tema e configurações. | Campo | Tipo | Descrição | | :--------- | :------ | :------------------------------------------- | | `id` | Integer | ID único da loja. | | `alias` | String | Apelido interno da loja. | | `domain` | String | Domínio principal da loja. | | `base_url` | String | URL base da loja. | | `logo_url` | String | URL do logotipo da loja. | | `has_mp` | Boolean | Indica se há meios de pagamento habilitados. | ### `merchantData.checkout` Contém informações sobre o processo de checkout. | Campo | Tipo | Descrição | | :------------- | :------ | :---------------------------------------------------- | | `base_domain` | String | URL base do checkout. | | `skip_cart` | Boolean | Indica se o carrinho é pulado no checkout. | | `items` | String | URL para obter os itens do carrinho. | | `items_json` | String | URL para obter os itens do carrinho em formato JSON. | | `redirect_to` | String | URL para redirecionamento ao carrinho. | | `orders` | String | URL para histórico de pedidos do cliente. | | `store_token` | String | Token da loja para autenticação nas URLs do checkout. | | `default_card` | String | Cartão de crédito padrão do cliente, como `Visa`. | | `shopper_url` | String | URL para a conta do cliente na loja. | ### `merchantData.manifest` Contém dados específicos do manifesto da loja. | Campo | Tipo | Descrição | | :------------ | :----- | :--------------------------------------------------------------- | | `name` | String | Nome completo da loja. | | `short_name` | String | Nome curto da loja, utilizado em interfaces com espaço limitado. | | `start_url` | String | URL inicial para carregar a loja como um aplicativo web. | | `description` | String | Descrição da loja. | | `lang` | String | Idioma da loja, no formato ISO (ex: `pt-BR`). | ### `merchantData.meta` Contém informações de metadados adicionais. | Campo | Tipo | Descrição | | :------------ | :----- | :-------------------------------- | | `title` | String | Título da loja. | | `description` | String | Descrição meta da loja para SEO. | | `icons` | Array | Lista de ícones usados pela loja. | ### `merchantData.company` Contém informações da empresa responsável pela loja. | Campo | Tipo | Descrição | | :------------- | :----- | :---------------------------------------------------- | | `person_type` | String | Tipo de pessoa física ou jurídica. | | `cnpj` | String | CNPJ da empresa (caso aplicável). | | `razao_social` | String | Razão social da empresa. | | `name` | String | Nome fantasia ou comercial da loja. | | `cpf` | String | CPF (caso a loja seja registrada como pessoa física). | | `phone` | String | Telefone da loja ou empresa. | | `whatsapp` | Array | Dados de contato do WhatsApp. | | `email` | String | Endereço de e-mail de contato da loja. | | `address` | Array | Endereço da empresa ou loja. | | `social` | Array | Redes sociais da loja ou empresa. | ### `sections` Contém detalhes sobre as seções da interface. | Campo | Tipo | Descrição | | :-------------- | :------ | :------------------------------------------------------------------ | | `section_alias` | String | Identificador único da seção, como `header`, `footer`, etc. | | `position` | Integer | Posição da seção na interface, indicando sua ordem de apresentação. | | `order` | Integer | Ordem específica para organização da seção em relação a outras. | | `visible` | Boolean | Indica se a seção está visível ao usuário. | | `params` | Array | Parâmetros adicionais para a seção. | ### `sorted_categories` Contém informações sobre categorias organizadas. | Campo | Tipo | Descrição | | :--------------- | :------ | :-------------------------------------------------------------------------------------- | | `id` | Integer | Identificador único da categoria. | | `featured` | Boolean | Indica se a categoria é destacada. | | `parent_id` | Integer | ID da categoria pai (ou `null` se for uma categoria principal). | | `is_parent` | Boolean | Indica se a categoria é uma categoria pai. | | `name` | String | Nome da categoria. | | `slug` | String | Identificador amigável para URL da categoria. | | `url` | String | URL completa da categoria. | | `url_path` | String | Caminho relativo para acesso direto à categoria, com parâmetros de ordenação incluídos. | | `path` | String | Caminho completo de navegação da categoria, exibido no formato textual. | | `category_cover` | Mixed | URL da imagem de capa da categoria (ou `null` se não tiver uma). | | `order` | Integer | Ordem de exibição da categoria em relação às outras. | | `children` | Array | Lista de subcategorias, se houver. | ### `featured_categories` Contém informações sobre categorias destacadas. | Campo | Tipo | Descrição | | :--------------- | :------ | :-------------------------------------------------------------------------------------- | | `id` | Integer | Identificador único da categoria. | | `featured` | Boolean | Indica se a categoria é destacada. | | `parent_id` | Integer | ID da categoria pai (ou `null` se for uma categoria principal). | | `is_parent` | Boolean | Indica se a categoria é uma categoria pai. | | `name` | String | Nome da categoria. | | `slug` | String | Identificador amigável para URL da categoria. | | `url` | String | URL completa da categoria. | | `url_path` | String | Caminho relativo para acesso direto à categoria, com parâmetros de ordenação incluídos. | | `path` | String | Caminho completo de navegação da categoria, exibido no formato textual. | | `category_cover` | Mixed | URL da imagem de capa da categoria (ou `null` se não tiver uma). | | `order` | Integer | Ordem de exibição da categoria em relação às outras. | ### `categories` Contém informações sobre todas as categorias disponíveis. | Campo | Tipo | Descrição | | :--------------- | :------ | :-------------------------------------------------------------------------------------- | | `id` | Integer | Identificador único da categoria. | | `featured` | Boolean | Indica se a categoria é destacada. | | `parent_id` | Integer | ID da categoria pai (ou `null` se for uma categoria principal). | | `is_parent` | Boolean | Indica se a categoria é uma categoria pai. | | `name` | String | Nome da categoria. | | `slug` | String | Identificador amigável para URL da categoria. | | `url` | String | URL completa da categoria. | | `url_path` | String | Caminho relativo para acesso direto à categoria, com parâmetros de ordenação incluídos. | | `path` | String | Caminho completo de navegação da categoria, exibido no formato textual. | | `category_cover` | Mixed | URL da imagem de capa da categoria (ou `null` se não tiver uma). | | `order` | Integer | Ordem de exibição da categoria em relação às outras. | | `children` | Array | Lista de subcategorias, se houver. | ### `pageConfig` Contém informações sobre a configuração da página. | Campo | Tipo | Descrição | | :--------- | :----- | :------------------------------------------------------------- | | `page` | String | Nome da página atual (por exemplo, `product`). | | `theme` | Array | Informações sobre o tema da página. | | `sections` | Array | Lista de seções da página, contendo detalhes sobre cada seção. | ### `pageConfig.theme` | Campo | Tipo | Descrição | | :------- | :----- | :--------------------------------- | | `alias` | String | Alias do tema. | | `params` | Array | Todos os parâmetros gerais do tema | ### `pageConfig.sections` | Campo | Tipo | Descrição | | :-------------- | :------ | :--------------------------------------- | | `section_alias` | String | Alias da seção. | | `order` | Number | Ordem de exibição relativa entre seções. | | `visible` | Boolean | Define se a seção está visível. | | `params` | Array | Parâmetros específicos da seção. | ## Variáveis na Página de Categoria/Busca/Promoção ### `content` Contém informações sobre o conteúdo da página | Campo | Tipo | Descrição | | :-------- | :----- | :------------------------------------------------------------------------------- | | `meta` | Array | Metadados da página. | | `data` | Array | Dados dos produtos da página. | | `slug` | String | Slug da página. | | `limit` | Number | Limite de produtos exibidos por página. | | `context` | String | Contexto da página. Valores possíveis: **category**, **promotion** ou **search** | ### `content.meta` Metadados da página | Campo | Tipo | Descrição | | :------------ | :----- | :-------------------------- | | `name` | String | Nome da categoria. | | `description` | String | Descrição da categoria. | | `seo` | Array | Propriedades SEO da página. | | `parent` | Array | Lista de categorias-pai. | | `data` | Array | Lista de produtos | ### `content.meta.seo` Propriedades SEO da página | Campo | Tipo | Descrição | | :-------------- | :----- | :------------------------------ | | `title` | String | Título SEO da categoria. | | `description` | String | Descrição SEO da categoria. | | `keywords` | String | Palavras-chave SEO da categoria | | `canonical_url` | String | URL canônica para SEO. | ### `content.data` Lista de produtos da página | Campo | Tipo | Descrição | | :----------------------- | :------ | :--------------------------------------------------------------- | | `id` | Number | ID do produto. | | `sku_id` | Number | ID do SKU. | | `gift_value` | Number | Valor de presente. | | `simple` | Boolean | Indica se o produto é simples. | | `has_variations` | Boolean | Indica se possui variações. | | `is_digital` | Boolean | Indica se é um produto digital. | | `warranty` | Number | Garantia do produto. | | `custom_shipping` | Boolean | Se há frete personalizado. | | `shipping_price` | Number | Preço do frete. | | `name` | String | Nome do produto. | | `slug` | String | Slug da URL do produto. | | `sku` | String | Código SKU do produto. | | `blocked_sale` | Boolean | Indica se está bloqueado para venda. | | `rating` | String | Avaliação média. | | `total_approved_reviews` | Number | Total de avaliações aprovadas. | | `url` | String | URL completa do produto. | | `url_path` | String | Caminho relativo da URL. | | `use_different_images` | Boolean | Se usa imagens diferentes para variações. | | `brand` | Array | Informações da marca. [Ver mais](#product-brand) | | `images` | Array | Lista de imagens do produto. [Ver mais](#product-images) | | `prices` | Array | Informações de preços. [Ver mais](#product-prices) | | `flags` | Array | Lista de selos associados ao produto. [Ver mais](#product-flags) | ### `config` Contém as informações de configuração da seção de categorias. | Campo | Tipo | Descrição | | :-------------- | :------ | :-------------------------------------------- | | `section_alias` | String | Alias da seção (ex: `main_category_content`). | | `position` | Number | Posição da seção na tela. | | `order` | Number | Ordem de exibição relativa entre seções. | | `visible` | Boolean | Define se a seção está visível. | | `params` | Objeto | Parâmetros de configuração da seção. | ### `config.params` Parâmetros da seção de categoria | Campo | Tipo | Descrição | | :------------------- | :------ | :------------------------------------------ | | `products_per_page` | String | Quantidade de produtos por página. | | `show_sort` | Boolean | Exibe ou não o seletor de ordenação. | | `filters_enabled` | Boolean | Habilita ou não os filtros na seção. | | `show_subcategories` | Boolean | Exibe ou não as subcategorias. | | `show_price_slider` | Boolean | Exibe ou não o filtro de faixa de preço. | | `show_brand` | Boolean | Exibe ou não o filtro de marcas. | | `show_banners` | Boolean | Exibe ou não os banners na seção. | | `slider_delay` | Number | Tempo de rotação dos banners (em segundos). | ## Variáveis na Página de Produto ### `product` Contém informações detalhadas sobre o produto. | Campo | Tipo | Descrição | | :----------------------- | :------ | :---------------------------------------------------------------------- | | `id` | Integer | Identificador único do produto. | | `sku_id` | Integer | ID do SKU do produto. | | `gift_value` | Float | Valor associado ao produto como presente, se aplicável. | | `simple` | Boolean | Indica se o produto é simples ou possui variações. | | `has_variations` | Boolean | Indica se o produto possui variações. | | `is_digital` | Boolean | Indica se o produto é digital. | | `warranty` | Integer | Garantia do produto, em meses. | | `custom_shipping` | Boolean | Indica se o produto possui frete personalizado. | | `shipping_price` | Float | Valor do frete, se personalizado. | | `name` | String | Nome do produto. | | `slug` | String | Identificador amigável para URL do produto. | | `sku` | String | SKU do produto. | | `blocked_sale` | Boolean | Indica se a venda do produto está bloqueada. | | `rating` | Float | Classificação do produto. | | `total_approved_reviews` | Integer | Número total de avaliações aprovadas. | | `url` | String | URL completa do produto. | | `url_path` | String | Caminho relativo do produto. | | `use_different_images` | Boolean | Indica se o produto usa imagens diferentes para variações. | | `brand` | Array | Informações da marca do produto. | | `images` | Array | Lista de URLs das imagens do produto. | | `prices` | Array | Informações de preços e descontos do produto. | | `flags` | Array | Selos do produto. | | `variations` | Array | Lista de variações disponíveis do produto. | | `skus` | Array | Conjunto de SKUs adicionais associados ao produto. | | `extras` | Array | Informações extras associadas ao produto. | | `texts` | Array | Textos adicionais relacionados ao produto, como descrição e instruções. | | `seo` | Array | Informações de SEO do produto, como título e meta descrições. | | `categories` | Array | Categorias às quais o produto pertence. | | `breadcrumbs` | Array | Estrutura de navegação para o produto (breadcrumb). | #### `product.brand` Contém informações sobre a marca do produto. | Campo | Tipo | Descrição | | :--------- | :------ | :---------------------------------------- | | `id` | Integer | Identificador da marca. | | `name` | String | Nome da marca. | | `logo_url` | String | URL do logotipo da marca (se disponível). | #### `product.images` Contém URLs das imagens do produto. | Campo | Tipo | Descrição | | :---- | :----- | :------------------------ | | `url` | String | URL da imagem do produto. | #### `product.prices` Contém informações sobre preços e descontos. | Campo | Tipo | Descrição | | :------------------------ | :------ | :----------------------------------------------- | | `currency` | String | Moeda do preço. | | `price_cost` | Float | Custo do produto. | | `price_cost_formated` | String | Custo do produto formatado. | | `price` | Float | Preço do produto. | | `price_formated` | String | Preço do produto formatado. | | `price_sale` | Float | Preço de venda do produto. | | `price_sale_formated` | String | Preço de venda formatado. | | `price_discount` | Float | Preço com desconto do produto. | | `price_discount_formated` | String | Preço com desconto formatado. | | `has_promotion` | Boolean | Indica se o produto tem promoção. | | `percent_discount` | Float | Percentual de desconto do produto. | | `billet` | Array | Informações sobre o preço do produto via boleto. | | `pix` | Array | Informações sobre o preço do produto via Pix. | | `installments` | Array | Informações sobre as parcelas do produto. | #### `product.flags` Contém os selos do produto. | Campo | Tipo | Descrição | | :----- | :---- | :------------------------- | | `data` | Array | Lista de selos do produto. | #### `product.flags.data` Contém as informações de cada selo | Campo | Tipo | Descrição | | :----------------- | :----- | :------------------------------------------ | | `id` | Number | Identificador do selo. | | `name` | String | Nome do selo. | | `slug` | String | Slug do selo. | | `text_color` | String | Cor do texto (formato hexadecimal). | | `background_color` | String | Cor de fundo do selo (formato hexadecimal). | | `image_url` | String | URL de imagem associada. | #### `product.variations` Contém variações disponíveis do produto. | Campo | Tipo | Descrição | | :----- | :---- | :----------------------------------------- | | `data` | Array | Lista de variações disponíveis do produto. | #### `product.skus` Contém informações sobre SKUs adicionais. | Campo | Tipo | Descrição | | :--------------------------------- | :------ | :----------------------------------------------- | | `id` | Integer | Identificador do SKU. | | `product_id` | Integer | ID do produto associado ao SKU. | | `sku` | String | SKU do produto. | | `blocked_sale` | Boolean | Indica se a venda do SKU está bloqueada. | | `title` | String | Título do SKU. | | `availability` | Integer | Disponibilidade do SKU. | | `days_availability_formated` | String | Disponibilidade formatada do SKU. | | `price_sale` | Float | Preço de venda do SKU. | | `price_discount` | Float | Preço com desconto do SKU. | | `combinations` | String | Combinações disponíveis para o SKU. | | `order` | Integer | Ordem de exibição do SKU. | | `total_in_stock` | Integer | Total em estoque do SKU. | | `allow_sell_without_customization` | Boolean | Indica se é permitido vender sem personalização. | #### `product.extras` Contém informações extras associadas ao produto. | Campo | Tipo | Descrição | | :--------------- | :------ | :----------------------------------- | | `video` | String | URL do vídeo relacionado ao produto. | | `total_in_stock` | Integer | Total em estoque do produto. | | `for_gift` | Boolean | Indica se o produto é para presente. | #### `product.texts` Contém textos adicionais relacionados ao produto. | Campo | Tipo | Descrição | | :--------------- | :----- | :------------------------- | | `description` | String | Descrição do produto. | | `specifications` | String | Especificações do produto. | | `measures` | String | Medidas do produto. | #### `product.seo` Contém informações de SEO do produto. | Campo | Tipo | Descrição | | :---------------- | :----- | :----------------------------- | | `seo_title` | String | Título SEO do produto. | | `seo_description` | String | Descrição SEO do produto. | | `seo_keywords` | String | Palavras-chave SEO do produto. | | `canonical_url` | String | URL canônica do produto. | #### `product.categories` Contém categorias às quais o produto pertence. | Campo | Tipo | Descrição | | :---------- | :------ | :-------------------------------------------- | | `id` | Integer | Identificador da categoria. | | `name` | String | Nome da categoria. | | `parent_id` | Integer | ID da categoria pai (se houver). | | `slug` | String | Identificador amigável para URL da categoria. | | `url_path` | String | Caminho relativo da categoria. | #### `product.breadcrumbs` Contém estrutura de navegação para o produto (breadcrumb). | Campo | Tipo | Descrição | | :--------- | :------ | :------------------------------------------- | | `id` | Integer | Identificador da categoria de breadcrumb. | | `name` | String | Nome da categoria de breadcrumb. | | `url_path` | String | Caminho relativo da categoria de breadcrumb. |