Adicionando o conector
Requisitos
- Possuir o plano pago do Loja Integrada
- Seguir as instruções abaixo com um usuário administrador
Instruções
- No painel da sua loja, acesse o caminho Configurações > Chave para API
- Na tela seguinte, clique em Cadastrar nova chave para gerar a chave API.
- Informe em Identificação da Chave, o nome que desejar, por exemplo “Kondado”
- Pronto, a sua chave foi gerada
- Faça login na Kondado, clique em CRIAR + > Conector > Loja Integrada
- Na página do conector, informe em Chave de API o valor de Chave obtido no passo anterior
- Basta clicar em SALVAR e testar sua conexão
Fonte: documentação da central de ajuda da Loja Integrada em de 2025-04-09
Integrações
Índice
Gráfico de relacionamento
Clique para ampliar
Categorias
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da categoria na Loja Integrada. |
|
text |
[pt] URI da categoria pai, usada para criar hierarquia entre categorias. |
|
text |
[pt] Descrição completa da categoria, geralmente utilizada para SEO e exibição na loja. |
|
text |
[pt] Identificador externo da categoria usado para integração com sistemas próprios. |
|
text |
[pt] Nome da categoria exibido na loja. |
|
text |
[pt] URI do recurso da categoria na API da Loja Integrada. |
|
text |
[pt] URI do recurso de SEO associado à categoria. |
|
text |
[pt] URL pública da página da categoria na loja virtual. |
Clientes
Objeto principal
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único do cliente na Loja Integrada. |
|
boolean |
[pt] Indica se o cliente aceitou receber comunicações por e-mail (newsletter). |
|
text |
[pt] Número do CNPJ do cliente, se for pessoa jurídica. |
|
text |
[pt] Número do CPF do cliente, se for pessoa física. |
|
timestamp |
[pt] Data e hora de criação do cadastro do cliente. |
|
timestamp |
[pt] Data e hora da última modificação no cadastro do cliente. |
|
date |
[pt] Data de nascimento do cliente. |
|
text |
[pt] Endereço de e-mail do cliente. |
|
text |
[pt] Identificador único do grupo de clientes. |
|
text |
[pt] Nome do grupo de clientes. |
|
boolean |
[pt] Indica se este é o grupo padrão para novos clientes. |
|
text |
[pt] URI do recurso do grupo de clientes na API. |
|
text |
[pt] Inscrição estadual do cliente, se pessoa jurídica. |
|
text |
[pt] Nome completo do cliente. |
|
text |
[pt] Razão social do cliente, usada para pessoa jurídica. |
|
text |
[pt] URI do recurso do cliente na API da Loja Integrada. |
|
text |
[pt] Número do RG do cliente. |
|
text |
[pt] Sexo do cliente (ex: 'm' para masculino, 'f' para feminino). |
|
text |
[pt] Número de telefone celular do cliente. |
|
text |
[pt] Número de telefone comercial do cliente. |
|
text |
[pt] Número de telefone principal do cliente. |
|
text |
[pt] Tipo de pessoa (PF para física, PJ para jurídica). |
loja_integrada_cliente_enderecos
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único do cliente na Loja Integrada. |
|
text |
[pt] Bairro do endereço do cliente. |
|
text |
[pt] CEP do endereço do cliente. |
|
text |
[pt] Cidade do endereço do cliente. |
|
text |
[pt] URI do cliente associado ao endereço. |
|
text |
[pt] Complemento do endereço do cliente (ex: bloco, apto). |
|
text |
[pt] Logradouro do endereço do cliente. |
|
text |
[pt] Estado do endereço do cliente (UF). |
|
text |
[pt] Identificador único do endereço do cliente. |
|
text |
[pt] Nome da pessoa de referência para o endereço. |
|
text |
[pt] Número do imóvel no endereço do cliente. |
|
text |
[pt] País do endereço do cliente. |
|
boolean |
[pt] Indica se este é o endereço principal do cliente. |
|
text |
[pt] Ponto de referência próximo ao endereço do cliente. |
|
text |
[pt] URI do recurso do endereço na API da Loja Integrada. |
Clientes: grupos
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único do grupo de clientes na Loja Integrada. |
|
text |
[pt] Nome do grupo de clientes, utilizado para segmentação e regras específicas. |
|
boolean |
[pt] Indica se este é o grupo padrão atribuído automaticamente a novos clientes. |
|
text |
[pt] URI do recurso do grupo de clientes na API da Loja Integrada. |
Cupons
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único do cupom na Loja Integrada. |
|
boolean |
[pt] Indica se o desconto deve ser aplicado sobre o valor total do pedido. |
|
boolean |
[pt] Indica se o cupom está ativo e disponível para uso. |
|
text |
[pt] Lista de categorias às quais o cupom pode ser aplicado. |
|
text |
[pt] Lista de clientes específicos que podem usar o cupom. |
|
text |
[pt] Código do cupom utilizado na finalização da compra. |
|
text |
[pt] Condição de aplicação do cupom com base no tipo de cliente (ex: todos, novos, recorrentes). |
|
text |
[pt] Condição de aplicação do cupom com base no tipo de produto (ex: todos, específicos). |
|
boolean |
[pt] Indica se o cupom pode ser usado em conjunto com outros cupons. |
|
timestamp |
[pt] Data e hora em que o cupom foi criado. |
|
timestamp |
[pt] Data e hora da última modificação do cupom. |
|
text |
[pt] Descrição do cupom, geralmente usada para identificação interna. |
|
text |
[pt] Lista de grupos de clientes aos quais o cupom pode ser aplicado. |
|
text |
[pt] Identificador externo do cupom, usado para integração com sistemas próprios. |
|
text |
[pt] Lista de produtos específicos aos quais o cupom pode ser aplicado. |
|
float |
[pt] Quantidade total de usos disponíveis para o cupom. |
|
float |
[pt] Número máximo de vezes que um mesmo cliente pode usar o cupom. |
|
float |
[pt] Número de vezes que o cupom já foi utilizado. |
|
text |
[pt] URI do recurso do cupom na API da Loja Integrada. |
|
text |
[pt] Tipo de desconto oferecido pelo cupom (ex: porcentagem, valor fixo). |
|
timestamp |
[pt] Data de expiração do cupom. |
|
float |
[pt] Valor do desconto oferecido pelo cupom. |
|
float |
[pt] Valor mínimo do pedido para que o cupom possa ser aplicado. |
Enviali: etiquetas
Campo | Tipo | |
---|---|---|
text |
||
text |
[pt] Prazo estimado de entrega, no formato 'dias:horas:minutos:segundos'. |
|
float |
[pt] Valor estimado da postagem antes da confirmação da etiqueta, em centavos. |
|
float |
[pt] Código identificador do pedido vinculado à etiqueta. |
|
timestamp |
[pt] Data e hora em que o pedido foi realizado. |
|
float |
[pt] Valor total dos produtos no pedido, em centavos. |
|
timestamp |
||
timestamp |
||
timestamp |
||
float |
||
text |
||
text |
||
text |
||
float |
||
text |
||
text |
[pt] Nome do destinatário da entrega. |
Formas de envio
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da forma de envio. |
|
text |
[pt] Código identificador da forma de envio, usado internamente pela plataforma. |
|
boolean |
[pt] Indica se a forma de envio está ativa no painel da loja. |
|
boolean |
[pt] Indica se a forma de envio está disponível para seleção no checkout. |
|
text |
[pt] URL da imagem (ícone/logo) da forma de envio exibida no checkout. |
|
text |
[pt] Nome da forma de envio apresentado ao cliente no processo de compra. |
|
text |
[pt] URI do recurso da forma de envio na API da Loja Integrada. |
|
text |
[pt] Tipo da forma de envio, como faixa de CEP, correios, transportadora, etc. |
Formas de pagamentos
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da forma de pagamento. |
|
text |
[pt] Código identificador da forma de pagamento, utilizado internamente pela plataforma. |
|
boolean |
[pt] Indica se a forma de pagamento está ativa no painel da loja. |
|
boolean |
[pt] Indica se a forma de pagamento está visível e utilizável pelos clientes no checkout. |
|
text |
[pt] URL da imagem (logo) da forma de pagamento exibida no checkout. |
|
text |
[pt] Nome da forma de pagamento, exibido na loja e para o lojista. |
|
text |
[pt] URI do recurso da forma de pagamento na API da Loja Integrada. |
Marcas
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da marca na Loja Integrada. |
|
text |
[pt] Apelido da marca utilizado para formar a URL amigável. |
|
boolean |
[pt] Indica se a marca está ativa e visível na loja. |
|
text |
[pt] Descrição da marca, utilizada em listagens e páginas da loja. |
|
text |
[pt] Identificador externo da marca utilizado para integrações com sistemas próprios. |
|
text |
[pt] Caminho ou identificador da imagem associada à marca. |
|
text |
[pt] Nome da marca exibido na loja. |
|
text |
[pt] URI do recurso da marca na API da Loja Integrada. |
Pedidos
Objeto principal
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único do pedido. |
|
text |
[pt] CNPJ do cliente. |
|
text |
[pt] CPF do cliente. |
|
date |
[pt] Data de nascimento do cliente. |
|
text |
[pt] Endereço de e-mail do cliente. |
|
text |
[pt] Identificador único do cliente. |
|
text |
[pt] Nome do cliente. |
|
text |
[pt] Razão social do cliente. |
|
text |
[pt] URI do recurso do cliente. |
|
text |
[pt] Sexo do cliente. |
|
text |
[pt] Telefone celular do cliente. |
|
text |
[pt] Telefone principal do cliente. |
|
text |
[pt] Observação relacionada ao cliente. |
|
boolean |
[pt] Indica se o desconto é aplicado sobre o valor total. |
|
boolean |
[pt] Indica se o cupom está ativo. |
|
text |
[pt] Código do cupom de desconto. |
|
text |
[pt] Condição de cliente para uso do cupom. |
|
text |
[pt] Condição de produto para uso do cupom. |
|
boolean |
[pt] Indica se o cupom pode ser acumulado com outros. |
|
timestamp |
[pt] Data de criação do cupom. |
|
timestamp |
[pt] Data de modificação do cupom. |
|
text |
[pt] Descrição do cupom de desconto. |
|
text |
[pt] Identificador único do cupom. |
|
text |
[pt] Identificador externo do cupom. |
|
text |
[pt] Lista de produtos vinculados ao cupom. |
|
float |
[pt] Quantidade total de usos do cupom. |
|
float |
[pt] Limite de uso por cliente. |
|
float |
[pt] Quantidade já utilizada do cupom. |
|
text |
[pt] URI do recurso do cupom. |
|
text |
[pt] Tipo de desconto (porcentagem, valor fixo, etc). |
|
timestamp |
[pt] Data de validade do cupom. |
|
float |
[pt] Valor do desconto do cupom. |
|
float |
[pt] Valor mínimo do pedido para aplicar o cupom. |
|
timestamp |
[pt] Data de criação do pedido. |
|
timestamp |
[pt] Data de expiração do pedido. |
|
timestamp |
[pt] Data de modificação do pedido. |
|
text |
[pt] Bairro do endereço de entrega. |
|
text |
[pt] CEP do endereço de entrega. |
|
text |
[pt] Cidade do endereço de entrega. |
|
text |
[pt] CNPJ do destinatário. |
|
text |
[pt] Complemento do endereço. |
|
text |
[pt] CPF do destinatário. |
|
text |
[pt] Logradouro do endereço de entrega. |
|
text |
[pt] Estado do endereço de entrega. |
|
text |
[pt] Identificador do endereço de entrega. |
|
text |
[pt] Inscrição estadual do destinatário. |
|
text |
[pt] Nome do destinatário. |
|
text |
[pt] Número do endereço. |
|
text |
[pt] País do endereço de entrega. |
|
text |
[pt] Razão social do destinatário. |
|
text |
[pt] Ponto de referência do endereço. |
|
text |
[pt] RG do destinatário. |
|
text |
[pt] Tipo de pessoa (Física ou Jurídica). |
|
text |
[pt] ID do pedido na plataforma AnyMarket. |
|
text |
[pt] Identificador externo do pedido. |
|
text |
[pt] Identificador externo no marketplace. |
|
text |
[pt] Nome do integrador da plataforma. |
|
text |
[pt] Marketplace de origem do pedido. |
|
text |
[pt] Identificador único da integração. |
|
text |
[pt] Número do pedido. |
|
float |
[pt] Peso total real do pedido. |
|
text |
[pt] URI do recurso do pedido. |
|
boolean |
[pt] Indica se o pedido foi aprovado. |
|
boolean |
[pt] Indica se o pedido foi cancelado. |
|
text |
[pt] Código da situação do pedido. |
|
boolean |
[pt] Indica se essa é a situação final do pedido. |
|
text |
[pt] Identificador único da situação. |
|
text |
[pt] Nome da situação do pedido. |
|
boolean |
[pt] Indica se o comprador será notificado sobre essa situação. |
|
boolean |
[pt] Indica se essa é a situação padrão dos pedidos. |
|
text |
[pt] URI da situação do pedido. |
|
text |
[pt] Nome da campanha de marketing utilizada. |
|
float |
[pt] Valor total de desconto aplicado ao pedido. |
|
float |
[pt] Valor do frete aplicado ao pedido. |
|
float |
[pt] Subtotal dos produtos no pedido (sem frete e desconto). |
|
float |
[pt] Valor total do pedido com descontos e frete aplicados. |
loja_integrada_pedidos_itens
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único do pedido. |
|
float |
[pt] Altura do item em centímetros. |
|
float |
[pt] Quantidade disponível em estoque no momento da venda. |
|
text |
[pt] Identificador único do item do pedido. |
|
float |
[pt] Largura do item em centímetros. |
|
float |
[pt] Número da linha no pedido. |
|
text |
[pt] Código NCM do produto. |
|
text |
[pt] Nome do produto vendido. |
|
text |
[pt] Referência ao pedido. |
|
float |
[pt] Peso do item em quilogramas. |
|
float |
[pt] Preço cheio sem desconto. |
|
float |
[pt] Preço de custo do item. |
|
float |
[pt] Preço promocional aplicado ao item. |
|
float |
[pt] Subtotal do item no pedido. |
|
float |
[pt] Preço de venda do item com desconto. |
|
text |
[pt] Referência ao produto. |
|
text |
[pt] Identificador do produto pai, se houver. |
|
float |
[pt] Profundidade do item em centímetros. |
|
float |
[pt] Quantidade de unidades do item vendidas. |
|
text |
[pt] SKU (código de estoque) do produto. |
|
text |
[pt] Tipo do item (ex: normal, brinde). |
|
text |
[pt] Referência à variação do produto (ex: cor, tamanho). |
loja_integrada_pedidos_pagamentos
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único do pedido. |
|
text |
[pt] Código de autorização da transação. |
|
text |
[pt] Bandeira do cartão de crédito utilizado. |
|
text |
[pt] Link para visualização do boleto gerado. |
|
text |
[pt] Código de retorno fornecido pelo gateway de pagamento. |
|
text |
[pt] Código interno da forma de pagamento. |
|
boolean |
[pt] Indica se a forma de pagamento está ativa. |
|
boolean |
[pt] Indica se a forma de pagamento está disponível para o cliente. |
|
text |
[pt] Identificador da forma de pagamento. |
|
text |
[pt] URL da imagem representando a forma de pagamento. |
|
text |
[pt] Nome da forma de pagamento (ex: Pix, Boleto, Cartão). |
|
text |
[pt] URI do recurso da forma de pagamento. |
|
text |
[pt] Identificador do pagamento. |
|
text |
[pt] Identificador externo da transação. |
|
text |
[pt] Mensagem de retorno do gateway. |
|
text |
[pt] Tipo do pagamento realizado (ex: instantâneo, parcelado). |
|
float |
[pt] Número de parcelas no pagamento. |
|
float |
[pt] Valor de cada parcela. |
|
text |
[pt] Código Pix da transação para pagamento instantâneo. |
|
text |
[pt] URL do QR Code para pagamento via Pix. |
|
text |
[pt] Identificador da transação no sistema de pagamentos. |
|
float |
[pt] Valor total do pagamento. |
|
float |
[pt] Valor que foi efetivamente pago. |
loja_integrada_pedidos_envios
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único do pedido. |
|
timestamp |
[pt] Data de criação do envio. |
|
timestamp |
[pt] Data da última modificação do envio. |
|
text |
[pt] Código interno da forma de envio. |
|
text |
[pt] Identificador único da forma de envio. |
|
text |
[pt] Nome da forma de envio. |
|
text |
[pt] Tipo de entrega (ex: PAC, SEDEX). |
|
text |
[pt] Identificador único do envio. |
|
text |
[pt] Identificador do objeto de transporte. |
|
text |
[pt] Referência ao pedido associado ao envio. |
|
float |
[pt] Prazo de entrega estimado em dias. |
|
float |
[pt] Valor cobrado pelo envio. |
Pedidos: histórico de situações
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único do histórico de situação. |
|
text |
[pt] Origem da alteração da situação do pedido (ex: gateway, lojista, sistema). |
|
text |
[pt] Nome de quem realizou a alteração (ex: nome do gateway ou usuário). |
|
timestamp |
[pt] Data e hora em que a alteração de situação foi registrada. |
|
text |
[pt] Número do pedido ao qual esta alteração de situação pertence. |
|
text |
[pt] Observações adicionadas no momento da alteração de situação. |
|
text |
[pt] URI do recurso do histórico de situação na API da Loja Integrada. |
|
boolean |
[pt] Indica se a nova situação representa um pedido aprovado. |
|
boolean |
[pt] Indica se a nova situação representa um pedido cancelado. |
|
text |
[pt] Código da nova situação do pedido. |
|
boolean |
[pt] Indica se a nova situação é considerada final no fluxo do pedido. |
|
text |
[pt] Identificador único da nova situação. |
|
text |
[pt] Nome descritivo da nova situação atribuída ao pedido. |
|
boolean |
[pt] Indica se o comprador foi notificado sobre essa nova situação. |
|
boolean |
[pt] Indica se a nova situação é a situação padrão de pedidos. |
|
text |
[pt] URI do recurso da nova situação na API. |
|
boolean |
[pt] Indica se a situação anterior representava um pedido aprovado. |
|
boolean |
[pt] Indica se a situação anterior representava um pedido cancelado. |
|
text |
[pt] Código da situação anterior do pedido. |
|
boolean |
[pt] Indica se a situação anterior era considerada final no fluxo do pedido. |
|
text |
[pt] Identificador único da situação anterior. |
|
text |
[pt] Nome descritivo da situação anterior do pedido. |
|
boolean |
[pt] Indica se o comprador foi notificado sobre a situação anterior. |
|
boolean |
[pt] Indica se a situação anterior era a padrão dos pedidos. |
|
text |
[pt] URI do recurso da situação anterior na API. |
Pedidos: notas fiscais
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único do pedido. |
|
text |
[pt] Identificador único do pedido. |
|
text |
[pt] Número da nota fiscal emitida para o pedido. |
|
text |
[pt] Chave de acesso da nota fiscal eletrônica (NFe), composta por 44 dígitos. |
|
timestamp |
[pt] Data e hora de emissão ou registro da nota fiscal. |
|
boolean |
[pt] Indica se a nota fiscal foi enviada ao cliente ou à SEFAZ. |
|
text |
[pt] URI do recurso da nota fiscal na API da Loja Integrada. |
|
float |
[pt] Número da série da nota fiscal, utilizada para controle fiscal. |
|
text |
[pt] URL pública para visualização ou download da nota fiscal em formato PDF (pode estar vazia se ainda não enviada). |
|
text |
[pt] URL para download do arquivo XML da nota fiscal (pode estar vazia se ainda não enviada). |
Produtos
Objeto principal
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único do produto na Loja Integrada. |
|
float |
[pt] Altura física do produto, utilizada para cálculo de frete. |
|
text |
[pt] Apelido do produto usado para URL amigável ou identificação interna. |
|
boolean |
[pt] Indica se o produto está ativo e disponível na loja. |
|
boolean |
[pt] Indica se o produto está bloqueado para edição ou exibição. |
|
timestamp |
[pt] Data em que o produto foi criado na Loja Integrada. |
|
timestamp |
[pt] Data da última modificação realizada no produto. |
|
text |
[pt] Descrição completa do produto, geralmente em HTML. |
|
boolean |
[pt] Indica se o produto está em destaque na loja. |
|
boolean |
[pt] Define se o controle de estoque está ativo para este produto. |
|
float |
[pt] Quantidade disponível em estoque do produto. |
|
float |
[pt] Código de situação para quando o produto está disponível. |
|
float |
[pt] Código de situação para quando o produto está indisponível. |
|
text |
[pt] Código GTIN (código de barras) do produto. |
|
text |
[pt] Identificador externo do produto usado para integração com outros sistemas. |
|
text |
[pt] Caminho da imagem principal no servidor. |
|
text |
[pt] URL da imagem em tamanho grande. |
|
text |
[pt] URL da imagem em formato ícone (miniatura). |
|
text |
[pt] Identificador da imagem principal. |
|
text |
[pt] Identificador da imagem no sistema AnyMarket. |
|
text |
[pt] ID da imagem relacionada ao produto. |
|
text |
[pt] Identificador da variação relacionada a esta imagem. |
|
text |
[pt] URL da imagem em tamanho médio. |
|
text |
[pt] Tipo MIME da imagem (ex: image/jpeg). |
|
text |
[pt] URL da imagem em tamanho pequeno. |
|
float |
[pt] Posição da imagem na ordem de exibição. |
|
boolean |
[pt] Indica se esta imagem é a principal do produto. |
|
text |
[pt] Referência ao produto relacionado à imagem. |
|
text |
[pt] URI da imagem principal na API. |
|
float |
[pt] Largura física do produto, utilizada para cálculo de frete. |
|
text |
[pt] URI da marca associada ao produto. |
|
text |
[pt] Código MPN (Manufacturer Part Number), usado para identificar peças ou produtos do fabricante. |
|
text |
[pt] Código NCM utilizado para classificação fiscal do produto. |
|
text |
[pt] Nome do produto que será exibido na loja. |
|
text |
[pt] Identificador do produto pai (em caso de variações). |
|
float |
[pt] Peso físico do produto em quilogramas. |
|
float |
[pt] Preço original do produto antes de qualquer desconto. |
|
float |
[pt] Preço de custo do produto para o lojista. |
|
float |
[pt] Preço promocional aplicado ao produto. |
|
float |
[pt] Indica se o preço está sob consulta (exibe 'sob consulta' na loja). |
|
text |
[pt] Identificador do produto no sistema AnyMarket. |
|
text |
[pt] SKU do produto no sistema AnyMarket. |
|
float |
[pt] Profundidade física do produto, usada para cálculo de frete. |
|
boolean |
[pt] Indica se o produto foi removido da loja. |
|
text |
[pt] URI do recurso do produto na API da Loja Integrada. |
|
text |
[pt] URI do recurso de SEO associado ao produto. |
|
text |
[pt] Código SKU (Stock Keeping Unit) único para controle de estoque do produto. |
|
text |
[pt] Lista de tags aplicadas ao produto, utilizadas para filtros e funcionalidades internas. |
|
text |
||
text |
[pt] URL pública do produto na loja virtual. |
|
text |
[pt] Link para vídeo do YouTube relacionado ao produto. |
|
boolean |
[pt] Indica se o produto é usado (segunda mão). |
loja_integrada_produtos_imagens
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único do produto na Loja Integrada. |
|
text |
[pt] Identificador único da imagem. |
|
text |
[pt] Caminho da imagem no servidor da Loja Integrada. |
|
text |
[pt] URL da imagem em tamanho grande (ideal para visualização em tela cheia). |
|
text |
[pt] URL da imagem em formato ícone, utilizada em miniaturas e listas. |
|
text |
[pt] Identificador da imagem no sistema de marketplace AnyMarket. |
|
text |
[pt] ID da imagem associada ao produto na Loja Integrada. |
|
text |
[pt] URL da imagem em tamanho médio (padrão para exibição em listagens). |
|
text |
[pt] Tipo MIME da imagem (ex: image/jpeg, image/png). |
|
text |
[pt] URL da imagem em tamanho pequeno (miniatura reduzida). |
|
float |
[pt] Posição da imagem na ordem de exibição das imagens do produto. |
|
boolean |
[pt] Indica se esta imagem é a principal do produto. |
|
text |
[pt] URI do produto ao qual esta imagem pertence. |
|
text |
[pt] URI do recurso da imagem na API da Loja Integrada. |
loja_integrada_produtos_categorias
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único do produto na Loja Integrada. |
|
text |
[pt] Lista de URIs das categorias às quais o produto pertence. |
loja_integrada_produtos_variacoes
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único do produto na Loja Integrada. |
|
text |
[pt] Lista de URIs das variações específicas do produto. |
|
text |
[pt] Lista de URIs das grades (variações) associadas ao produto. |
loja_integrada_produtos_grades
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único do produto na Loja Integrada. |
|
text |
[pt] Lista de URIs das grades (variações) associadas ao produto. |
Produtos: estoque
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único do registro de estoque do produto. |
|
boolean |
[pt] Indica se o estoque do produto é gerenciado automaticamente pela plataforma. |
|
text |
[pt] URI do produto ao qual o estoque está associado. |
|
float |
[pt] Quantidade total do produto disponível em estoque. |
|
float |
[pt] Quantidade realmente disponível para venda (total - reservada). |
|
float |
[pt] Quantidade reservada para pedidos ainda não finalizados. |
|
text |
[pt] URI do recurso de estoque na API da Loja Integrada. |
|
float |
[pt] Código da situação para exibir quando o produto está em estoque. |
|
float |
[pt] Código da situação para exibir quando o produto está sem estoque. |
Produtos: grades de variação
Objeto principal
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da grade de variação na Loja Integrada. |
|
text |
[pt] Identificador externo da grade, utilizado para integração com sistemas próprios. |
|
text |
[pt] Nome da grade de variação (ex: Tamanho, Cor, Gênero). |
|
text |
[pt] Nome da grade exibido para o cliente na loja. |
|
text |
[pt] URI do recurso da grade de variação na API. |
loja_integrada_produtos_grade_variacoes
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da grade de variação na Loja Integrada. |
|
text |
[pt] URI da grade à qual esta variação pertence. |
|
text |
[pt] Identificador único da variação dentro da grade. |
|
text |
[pt] Identificador externo da variação, usado para integrações com sistemas externos. |
|
text |
[pt] Nome da variação (ex: P, M, G, Azul, Feminino, Unissex). |
|
text |
[pt] URI da variação na API da Loja Integrada. |
Produtos: imagens
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da imagem do produto. |
|
text |
[pt] Caminho da imagem no servidor da Loja Integrada, relativo à estrutura de diretórios da loja. |
|
text |
[pt] Identificador da imagem no sistema AnyMarket, usado em integrações com marketplaces. |
|
text |
[pt] Identificador interno da imagem, utilizado para controle na plataforma. |
|
text |
[pt] Tipo MIME da imagem, como image/jpeg ou image/png. |
|
float |
[pt] Ordem de exibição da imagem na galeria do produto. |
|
boolean |
[pt] Indica se esta é a imagem principal do produto. |
|
text |
[pt] URI do produto ao qual esta imagem pertence. |
|
text |
[pt] URI do recurso da imagem na API da Loja Integrada. |
Produtos: preços
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único do registro de preço na Loja Integrada. |
|
float |
[pt] Preço original do produto antes de descontos ou promoções. |
|
float |
[pt] Preço de custo do produto para o lojista (pode ser nulo se não informado). |
|
text |
[pt] URI do produto ao qual este preço está associado. |
|
float |
[pt] Preço promocional do produto, se houver (pode ser nulo). |
|
text |
[pt] URI do recurso de preço do produto na API. |
|
boolean |
[pt] Indica se o preço do produto está sob consulta, ou seja, não é exibido diretamente na loja. |
Situações dos pedidos
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da situação do pedido na Loja Integrada. |
|
boolean |
[pt] Indica se a situação representa um pedido aprovado. |
|
boolean |
[pt] Indica se a situação representa um pedido cancelado. |
|
text |
[pt] Código interno da situação do pedido, usado para controle e automações. |
|
boolean |
[pt] Indica se essa é uma situação final do pedido, ou seja, se o fluxo está encerrado. |
|
text |
[pt] Nome da situação, exibido ao lojista e, em alguns casos, ao cliente. |
|
boolean |
[pt] Indica se o comprador será notificado por e-mail quando o pedido atingir essa situação. |
|
boolean |
[pt] Indica se essa é a situação padrão para novos pedidos. |
|
text |
[pt] URI do recurso da situação do pedido na API da Loja Integrada. |
Notas
Descrição dos campos
Devido à ausência de descrição de alguns dos campos na documentação da API , parte das descrições foi gerada com inteligência artificial com exemplos dos valores retornados