> ## 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. # Criar produto > Cria um novo produto ## OpenAPI ````yaml post /{alias}/catalog/products openapi: 3.0.0 info: title: Yampi API description: Documentação oficial da API da Yampi version: '2.0' servers: - url: https://api.dooki.com.br/v2 description: Endpoint de produção security: - ApiToken: [] ApiSecretKey: [] tags: - name: Catálogo - Atualização em massa x-folder: catalogo/atualizacao-em-massa - name: Catálogo - Avaliações de produtos x-folder: catalogo/produtos/avaliacoes-de-produtos - name: Catálogo - Categorias x-folder: catalogo/categorias - name: Catálogo - Coleções x-folder: catalogo/colecoes - name: Catálogo - Comentários de produtos x-folder: catalogo/produtos/comentarios-de-produtos - name: Catálogo - Customizações x-folder: catalogo/customizacoes - name: Catálogo - Estoques de SKU x-folder: catalogo/skus/estoques-de-sku - name: Catálogo - Feeds x-folder: catalogo/feeds - name: Catálogo - Filtros x-folder: catalogo/filtros - name: Catálogo - Grupos x-folder: catalogo/grupos - name: Catálogo - Imagens x-folder: catalogo/imagens - name: Catálogo - Looks x-folder: catalogo/looks - name: Catálogo - Kits x-folder: catalogo/kits - name: Catálogo - Marcas x-folder: catalogo/marcas - name: Catálogo - Notificações de estoque x-folder: catalogo/notificacoes-de-estoque - name: Catálogo - Produtos x-folder: catalogo/produtos - name: Catálogo - Produtos relacionados x-folder: catalogo/produtos/produtos-relacionados - name: Catálogo - Selos x-folder: catalogo/selos - name: Catálogo - Sincronizar estoques x-folder: catalogo/skus/sincronizar-estoques - name: Catálogo - SKUs x-folder: catalogo/skus - name: Catálogo - Valores de filtros x-folder: catalogo/filtros/valores-de-filtros - name: Catálogo - Valores de variações x-folder: catalogo/variacoes/valores-de-variacoes - name: Catálogo - Variações x-folder: catalogo/variacoes - name: Público - Catálogo x-folder: /publico/catalogo - name: Público - Busca x-folder: /publico/busca - name: Público - Loja x-folder: /publico/loja - name: Checkout - Bancos x-folder: checkout/bancos - name: Checkout - Links de Pagamento x-folder: checkout/links-de-pagamento - name: Checkout - Carrinhos abandonados x-folder: checkout/carrinhos-abandonados - name: Checkout - Configurações de pagamentos x-folder: checkout/configuracoes-de-pagamentos - name: Checkout - Formas de pagamentos x-folder: checkout/formas-de-pagamentos - name: Checkout - Gateways de pagamento x-folder: checkout/gateways-de-pagamento - name: Checkout - Parcelamento x-folder: checkout/parcelamento - name: Checkout - Status de pedidos x-folder: checkout/status-de-pedidos - name: Checkout - Transações x-folder: checkout/transacoes - name: Clientes - Cliente x-folder: clientes/cliente - name: Clientes - Clusters description: >- Clusters são grupos de clientes com condições comerciais flexíveis, como preço de produto, frete e forma de entrega x-folder: clientes/clusters - name: Clientes - Endereços x-folder: clientes/enderecos - name: Clientes - Regras de frete dos clusters x-folder: clientes/clusters/regras-de-frete-dos-clusters - name: Configurações - Carrinhos abandonados x-folder: configuracoes/carrinhos-abandonados - name: Configurações - Checkout x-folder: configuracoes/checkout - name: Configurações - Credenciais da loja x-folder: configuracoes/credenciais-da-loja - name: Configurações - Dados da loja x-folder: configuracoes/dados-da-loja - name: Configurações - Fotos x-folder: configuracoes/fotos - name: Configurações - Integrações x-folder: configuracoes/integracoes - name: Configurações - IPs bloqueados x-folder: configuracoes/ips-bloqueados - name: Configurações - Overview x-folder: configuracoes/overview - name: Conteúdo - Páginas x-folder: conteudo/paginas - name: Conteúdo - Redirecionamentos x-folder: conteudo/redirecionamentos - name: Descontos x-folder: descontos - name: Leads x-folder: leads - name: Logística - Armazéns x-folder: logistica/armazens - name: Logística - Simular frete x-folder: logistica/simular-frete - name: Logística - CEP x-folder: logistica/cep - name: Logística - Embalagens x-folder: logistica/embalagens - name: Logística - Estoques description: >- O lojista pode ter um cadastro de múltiplos estoques onde ele pode associar posteriormente os SKUS com suas respectivas quantidades. Um exemplo prático é permitir que ele consiga trabalhar com estoques de fornecedores externos com diferentes prazos de entrega. x-folder: logistica/estoques - name: Logística - Países x-folder: logistica/paises - name: Logística - Preços de frete x-folder: logistica/precos-de-frete - name: Logística - Reservas de estoque x-folder: logistica/reservas-de-estoque - name: Logística - Transportadoras x-folder: logistica/transportadoras - name: Logística - API de Frete x-folder: logistica/api-de-frete - name: Marketing x-folder: marketing - name: Marketing - Brindes x-folder: marketing/brindes - name: Pedidos - Comentários description: Endpoints de comentários de pedidos x-folder: pedidos/comentarios - name: Pedidos - Emails description: Endpoints de e-mails de pedidos x-folder: pedidos/emails - name: Pedidos - Endereços description: Endpoints de endereços de pedidos x-folder: pedidos/enderecos - name: Pedidos - Etiquetas description: Endpoints de etiquetas de pedidos x-folder: pedidos/etiquetas - name: Pedidos - Notas fiscais description: Endpoints de notas fiscais de pedidos x-folder: pedidos/notas-fiscais - name: Pedidos - Rastreamento description: Endpoints de emails de pedidos x-folder: pedidos/rastreamento - name: Pedidos - Pedido description: Endpoints de pedidos x-folder: pedidos/pedido - name: Promoções - Combos x-folder: promocoes/combos - name: Promoções - Desconto progressivo x-folder: promocoes/desconto-progressivo - name: Promoções - Frete grátis x-folder: promocoes/frete-gratis - name: Promoções - Order Bump x-folder: promocoes/orderbump - name: Promoções - Upsells x-folder: promocoes/upsells - name: Promoções - Carteira x-folder: promocoes/carteira - name: Sistema description: Endpoints informativos do sistema x-folder: sistema - name: Busca - Global x-folder: busca/global - name: Busca - Pedidos x-folder: busca/pedidos - name: Busca - Produtos x-folder: busca/produtos - name: Busca - Clientes x-folder: busca/clientes - name: Busca - Leads x-folder: busca/leads - name: Busca - Carrinhos x-folder: busca/carrinhos - name: Usuários x-folder: usuarios - name: Usuários - Convites x-folder: usuarios/convites - name: Usuários - Grupos x-folder: usuarios/grupos - name: Usuários - Permissões x-folder: usuarios/permissoes - name: Webhooks x-folder: webhooks - name: Loja Virtual - Scripts x-folder: loja-virtual/scripts - name: Modulo - Recurso description: Modulo - Recurso - name: Marketplaces - Atributos description: Marketplaces - Atributos - name: Marketplaces - Anúncios description: Marketplaces - Anúncios - name: Links de Pagamento description: Links de Pagamento - name: Checkout - Contas bancárias description: Checkout - Contas bancárias - name: Checkout - Vendedores description: Checkout - Vendedores - name: Configurações - E-mails description: Configurações - E-mails - name: Logística - Frete Público description: Logística - Frete Público - name: Marketplaces - Categorias description: Marketplaces - Categorias - name: Marketplaces - Contas description: Marketplaces - Contas - name: Marketplaces - Lista de erros description: Marketplaces - Lista de erros - name: Marketplaces description: Marketplaces - name: Métricas - Cashback description: Métricas - Cashback - name: Promoções - Cashbacks description: Promoções - Cashbacks - name: Promoções - Cashback description: Promoções - Cashback - name: Promoções - Cupons de desconto description: Promoções - Cupons de desconto - name: Promoções - Produtos description: Promoções - Produtos - name: Filas description: Filas paths: /{alias}/catalog/products: post: tags: - Catálogo - Produtos summary: Criar produto description: Cria um novo produto operationId: PostCatalogProducts parameters: - name: alias in: path description: Alias da loja required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ProductRequest' responses: '200': description: Produto criado com sucesso content: application/json: schema: $ref: '#/components/schemas/Product' '400': description: Requisição inválida '422': description: >- Dados inválidos. Pode ocorrer quando campos obrigatórios estão ausentes, o formato é incorreto, ou quando o valor enviado resulta em uma string vazia após sanitização e normalização. components: schemas: ProductRequest: title: Requisição de produto description: Representa os dados necessários para criar ou atualizar um produto required: - simple - brand_id - active - name properties: simple: description: Produto possui ou não variações type: boolean example: true brand_id: description: ID da marca type: integer erp_id: description: ID de ERP type: integer active: description: Indica se o produto está ativo type: boolean example: true searchable: description: Indica se o produto é buscável type: boolean example: true is_digital: description: Indica se o produto é digital type: boolean example: true buy_similars: description: Sugerir carrossel de produtos similares na compra type: boolean example: true priority: description: Nível de relevância (1 ->Padrão, 2 -> Média, 3 -> Alta) type: integer rating: type: integer example: 4 ncm: description: Código NCM type: string name: description: Nome do produto. O valor é sanitizado e normalizado automaticamente. type: string slug: description: Utilizado em URL e listagens type: string example: nome-do-produto video: description: Vídeo do produto type: string description: description: >- Descrição do produto. O valor é sanitizado e normalizado automaticamente. type: string specifications: description: >- Especificações do produto. O valor é sanitizado e normalizado automaticamente. type: string measures: description: >- Medidas do produto (ex: 10x20x30 cm). O valor é sanitizado e normalizado automaticamente. type: string gift_value: description: Valor de presente associado ao produto type: number format: float seo_title: description: Título do produto para SEO type: string seo_description: description: Descrição do produto para SEO type: string seo_keywords: description: Palavras-chave para SEO type: string canonical_url: description: URL canônica do produto type: string google_category: description: Categoria Google do produto type: string search_terms: description: Termos extras de busca do produto type: string categories_ids: description: IDs das categorias vinculadas type: array items: type: integer flags_ids: description: IDs das flags vinculadas type: array items: type: integer filters_values_ids: description: IDs dos valores de filtros vinculados type: array items: type: integer variations_ids: description: IDs das variações do produto type: array items: type: integer similars_ids: description: IDs de produtos similares type: array items: type: integer collections_ids: description: IDs das coleções vinculadas type: array items: type: integer skus: type: array items: properties: sku: description: Código identificador principal do produto type: string erp_id: description: ID do SKU no sistema ERP type: integer barcode: description: Código de barras do SKU type: string price_cost: description: Preço de custo type: number format: float price_sale: description: Preço de venda type: number format: float price_discount: description: Preço com desconto type: number format: float weight: description: Peso do SKU em kg type: number format: float height: description: Altura do SKU em cm type: number format: float width: description: Largura do SKU em cm type: number format: float length: description: Comprimento do SKU em cm type: number format: float quantity_managed: description: Controle de estoque habilitado type: boolean example: true availability: description: Disponibilidade do SKU em estoque type: integer availability_soldout: description: Disponibilidade após esgotar type: integer blocked_sale: description: Bloqueia a venda deste SKU type: boolean example: true images: description: Imagens do SKU type: array items: properties: url: type: string format: uri type: object type: object create_redirect: description: >- Se presente na requisição, cria um redirect junto com a atualização. A presença do nó é o que sinaliza a intenção — o conteúdo descreve o redirect. required: - url_from - url_to properties: url_from: description: URL de origem do redirect (path relativo iniciando com /). type: string example: /produto-antigo url_to: description: >- URL de destino do redirect (path relativo iniciando com /). Deve ser diferente de url_from. type: string example: /produto-novo type: object type: object Product: title: Produto description: Representa um produto do catálogo properties: id: type: integer example: 12345678 merchant_id: description: ID da loja type: integer readOnly: true example: 1 affiliation_id: description: ID de afiliação do produto type: integer erp_id: description: ID do produto no ERP type: integer seller_id: description: ID do vendedor type: integer active: description: Indica se o produto está ativo type: boolean example: true searchable: description: Indica se o produto é buscável type: boolean example: true is_digital: description: Indica se o produto é digital type: boolean example: true rating: type: integer example: 4 priority: description: Nível de relevância (1 -> Padrão, 2 -> Média, 3 -> Alta) type: integer ncm: description: Código NCM do produto type: string name: description: Nome do produto type: string slug: description: Slug (URL amigável) do produto type: string example: nome-do-produto warranty: description: Garantia em meses type: integer custom_shipping: description: Indica se o Frete é customizado type: boolean example: true shipping_price: description: Valor do frete customizado em reais type: number format: float example: 39.9 gift_value: description: Valor de presente (se aplicável) type: number format: float simple: description: Indica se o produto é simples type: boolean example: true type: object securitySchemes: ApiToken: type: apiKey name: User-Token in: header ApiSecretKey: type: apiKey name: User-Secret-Key in: header ````