Loja Integrada

Adicionando o conector

Requisitos

  1. Possuir o plano pago do Loja Integrada
  2. Seguir as instruções abaixo com um usuário administrador

Instruções

  1. No painel da sua loja, acesse o caminho Configurações > Chave para API
  2. Na tela seguinte, clique em Cadastrar nova chave para gerar a chave API.
  3. Informe em Identificação da Chave, o nome que desejar, por exemplo “Kondado”
  4. Pronto, a sua chave foi gerada 
  5. Faça login na Kondado, clique em CRIAR + > Conector > Loja Integrada
  6. Na página do conector, informe em Chave de API o valor de Chave obtido no passo anterior
  7. 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

id

text

[pt] Identificador único da categoria na Loja Integrada.

categoria_pai

text

[pt] URI da categoria pai, usada para criar hierarquia entre categorias.

descricao

text

[pt] Descrição completa da categoria, geralmente utilizada para SEO e exibição na loja.

id_externo

text

[pt] Identificador externo da categoria usado para integração com sistemas próprios.

nome

text

[pt] Nome da categoria exibido na loja.

resource_uri

text

[pt] URI do recurso da categoria na API da Loja Integrada.

seo

text

[pt] URI do recurso de SEO associado à categoria.

url

text

[pt] URL pública da página da categoria na loja virtual.

Clientes

Objeto principal

Campo Tipo

id

text

[pt] Identificador único do cliente na Loja Integrada.

aceita_newsletter

boolean

[pt] Indica se o cliente aceitou receber comunicações por e-mail (newsletter).

cnpj

text

[pt] Número do CNPJ do cliente, se for pessoa jurídica.

cpf

text

[pt] Número do CPF do cliente, se for pessoa física.

data_criacao

timestamp

[pt] Data e hora de criação do cadastro do cliente.

data_modificacao

timestamp

[pt] Data e hora da última modificação no cadastro do cliente.

data_nascimento

date

[pt] Data de nascimento do cliente.

email

text

[pt] Endereço de e-mail do cliente.

grupo_id

text

[pt] Identificador único do grupo de clientes.

    Clientes: grupos > > id

grupo_nome

text

[pt] Nome do grupo de clientes.

grupo_padrao

boolean

[pt] Indica se este é o grupo padrão para novos clientes.

grupo_resource_uri

text

[pt] URI do recurso do grupo de clientes na API.

ie

text

[pt] Inscrição estadual do cliente, se pessoa jurídica.

nome

text

[pt] Nome completo do cliente.

razao_social

text

[pt] Razão social do cliente, usada para pessoa jurídica.

resource_uri

text

[pt] URI do recurso do cliente na API da Loja Integrada.

rg

text

[pt] Número do RG do cliente.

sexo

text

[pt] Sexo do cliente (ex: 'm' para masculino, 'f' para feminino).

telefone_celular

text

[pt] Número de telefone celular do cliente.

telefone_comercial

text

[pt] Número de telefone comercial do cliente.

telefone_principal

text

[pt] Número de telefone principal do cliente.

tipo

text

[pt] Tipo de pessoa (PF para física, PJ para jurídica).

loja_integrada_cliente_enderecos

Campo Tipo

cliente_id

text

[pt] Identificador único do cliente na Loja Integrada.

enderecos_bairro

text

[pt] Bairro do endereço do cliente.

enderecos_cep

text

[pt] CEP do endereço do cliente.

enderecos_cidade

text

[pt] Cidade do endereço do cliente.

enderecos_cliente

text

[pt] URI do cliente associado ao endereço.

enderecos_complemento

text

[pt] Complemento do endereço do cliente (ex: bloco, apto).

enderecos_endereco

text

[pt] Logradouro do endereço do cliente.

enderecos_estado

text

[pt] Estado do endereço do cliente (UF).

enderecos_id

text

[pt] Identificador único do endereço do cliente.

enderecos_nome

text

[pt] Nome da pessoa de referência para o endereço.

enderecos_numero

text

[pt] Número do imóvel no endereço do cliente.

enderecos_pais

text

[pt] País do endereço do cliente.

enderecos_principal

boolean

[pt] Indica se este é o endereço principal do cliente.

enderecos_referencia

text

[pt] Ponto de referência próximo ao endereço do cliente.

enderecos_resource_uri

text

[pt] URI do recurso do endereço na API da Loja Integrada.

Clientes: grupos

Campo Tipo

id

text

[pt] Identificador único do grupo de clientes na Loja Integrada.

nome

text

[pt] Nome do grupo de clientes, utilizado para segmentação e regras específicas.

padrao

boolean

[pt] Indica se este é o grupo padrão atribuído automaticamente a novos clientes.

resource_uri

text

[pt] URI do recurso do grupo de clientes na API da Loja Integrada.

Cupons

Campo Tipo

id

text

[pt] Identificador único do cupom na Loja Integrada.

aplicar_no_total

boolean

[pt] Indica se o desconto deve ser aplicado sobre o valor total do pedido.

ativo

boolean

[pt] Indica se o cupom está ativo e disponível para uso.

categorias

text

[pt] Lista de categorias às quais o cupom pode ser aplicado.

clientes

text

[pt] Lista de clientes específicos que podem usar o cupom.

codigo

text

[pt] Código do cupom utilizado na finalização da compra.

condicao_cliente

text

[pt] Condição de aplicação do cupom com base no tipo de cliente (ex: todos, novos, recorrentes).

condicao_produto

text

[pt] Condição de aplicação do cupom com base no tipo de produto (ex: todos, específicos).

cumulativo

boolean

[pt] Indica se o cupom pode ser usado em conjunto com outros cupons.

data_criacao

timestamp

[pt] Data e hora em que o cupom foi criado.

data_modificacao

timestamp

[pt] Data e hora da última modificação do cupom.

descricao

text

[pt] Descrição do cupom, geralmente usada para identificação interna.

grupos

text

[pt] Lista de grupos de clientes aos quais o cupom pode ser aplicado.

id_externo

text

[pt] Identificador externo do cupom, usado para integração com sistemas próprios.

produtos

text

[pt] Lista de produtos específicos aos quais o cupom pode ser aplicado.

quantidade

float

[pt] Quantidade total de usos disponíveis para o cupom.

quantidade_por_cliente

float

[pt] Número máximo de vezes que um mesmo cliente pode usar o cupom.

quantidade_usada

float

[pt] Número de vezes que o cupom já foi utilizado.

resource_uri

text

[pt] URI do recurso do cupom na API da Loja Integrada.

tipo

text

[pt] Tipo de desconto oferecido pelo cupom (ex: porcentagem, valor fixo).

validade

timestamp

[pt] Data de expiração do cupom.

valor

float

[pt] Valor do desconto oferecido pelo cupom.

valor_minimo

float

[pt] Valor mínimo do pedido para que o cupom possa ser aplicado.

Enviali: etiquetas

Campo Tipo

postage_id

text

estimate_eta

text

[pt] Prazo estimado de entrega, no formato 'dias:horas:minutos:segundos'.

estimate_price

float

[pt] Valor estimado da postagem antes da confirmação da etiqueta, em centavos.

order_code

float

[pt] Código identificador do pedido vinculado à etiqueta.

    Pedidos > > id

order_date_time

timestamp

[pt] Data e hora em que o pedido foi realizado.

order_merchandise_value

float

[pt] Valor total dos produtos no pedido, em centavos.

postage_date_time

timestamp

postage_delivery_suspension_requested_at

timestamp

postage_expires_at

timestamp

postage_price

float

postage_service_name

text

postage_service_slug

text

postage_status

text

postage_tracking_code

float

postage_tracking_status

text

recipient_name

text

[pt] Nome do destinatário da entrega.

Formas de envio

Campo Tipo

id

text

[pt] Identificador único da forma de envio.

codigo

text

[pt] Código identificador da forma de envio, usado internamente pela plataforma.

configuracoes_ativo

boolean

[pt] Indica se a forma de envio está ativa no painel da loja.

configuracoes_disponivel

boolean

[pt] Indica se a forma de envio está disponível para seleção no checkout.

imagem

text

[pt] URL da imagem (ícone/logo) da forma de envio exibida no checkout.

nome

text

[pt] Nome da forma de envio apresentado ao cliente no processo de compra.

resource_uri

text

[pt] URI do recurso da forma de envio na API da Loja Integrada.

tipo

text

[pt] Tipo da forma de envio, como faixa de CEP, correios, transportadora, etc.

Formas de pagamentos

Campo Tipo

id

text

[pt] Identificador único da forma de pagamento.

codigo

text

[pt] Código identificador da forma de pagamento, utilizado internamente pela plataforma.

configuracoes_ativo

boolean

[pt] Indica se a forma de pagamento está ativa no painel da loja.

configuracoes_disponivel

boolean

[pt] Indica se a forma de pagamento está visível e utilizável pelos clientes no checkout.

imagem

text

[pt] URL da imagem (logo) da forma de pagamento exibida no checkout.

nome

text

[pt] Nome da forma de pagamento, exibido na loja e para o lojista.

resource_uri

text

[pt] URI do recurso da forma de pagamento na API da Loja Integrada.

Marcas

Campo Tipo

id

text

[pt] Identificador único da marca na Loja Integrada.

apelido

text

[pt] Apelido da marca utilizado para formar a URL amigável.

ativo

boolean

[pt] Indica se a marca está ativa e visível na loja.

descricao

text

[pt] Descrição da marca, utilizada em listagens e páginas da loja.

id_externo

text

[pt] Identificador externo da marca utilizado para integrações com sistemas próprios.

imagem

text

[pt] Caminho ou identificador da imagem associada à marca.

nome

text

[pt] Nome da marca exibido na loja.

resource_uri

text

[pt] URI do recurso da marca na API da Loja Integrada.

Pedidos

Objeto principal

Campo Tipo

id

text

[pt] Identificador único do pedido.

cliente_cnpj

text

[pt] CNPJ do cliente.

cliente_cpf

text

[pt] CPF do cliente.

cliente_data_nascimento

date

[pt] Data de nascimento do cliente.

cliente_email

text

[pt] Endereço de e-mail do cliente.

cliente_id

text

[pt] Identificador único do cliente.

    Clientes > > id

cliente_nome

text

[pt] Nome do cliente.

cliente_razao_social

text

[pt] Razão social do cliente.

cliente_resource_uri

text

[pt] URI do recurso do cliente.

cliente_sexo

text

[pt] Sexo do cliente.

cliente_telefone_celular

text

[pt] Telefone celular do cliente.

cliente_telefone_principal

text

[pt] Telefone principal do cliente.

cliente_obs

text

[pt] Observação relacionada ao cliente.

cupom_desconto_aplicar_no_total

boolean

[pt] Indica se o desconto é aplicado sobre o valor total.

cupom_desconto_ativo

boolean

[pt] Indica se o cupom está ativo.

cupom_desconto_codigo

text

[pt] Código do cupom de desconto.

cupom_desconto_condicao_cliente

text

[pt] Condição de cliente para uso do cupom.

cupom_desconto_condicao_produto

text

[pt] Condição de produto para uso do cupom.

cupom_desconto_cumulativo

boolean

[pt] Indica se o cupom pode ser acumulado com outros.

cupom_desconto_data_criacao

timestamp

[pt] Data de criação do cupom.

cupom_desconto_data_modificacao

timestamp

[pt] Data de modificação do cupom.

cupom_desconto_descricao

text

[pt] Descrição do cupom de desconto.

cupom_desconto_id

text

[pt] Identificador único do cupom.

    Cupons > > id

cupom_desconto_id_externo

text

[pt] Identificador externo do cupom.

cupom_desconto_produtos

text

[pt] Lista de produtos vinculados ao cupom.

cupom_desconto_quantidade

float

[pt] Quantidade total de usos do cupom.

cupom_desconto_quantidade_por_cliente

float

[pt] Limite de uso por cliente.

cupom_desconto_quantidade_usada

float

[pt] Quantidade já utilizada do cupom.

cupom_desconto_resource_uri

text

[pt] URI do recurso do cupom.

cupom_desconto_tipo

text

[pt] Tipo de desconto (porcentagem, valor fixo, etc).

cupom_desconto_validade

timestamp

[pt] Data de validade do cupom.

cupom_desconto_valor

float

[pt] Valor do desconto do cupom.

cupom_desconto_valor_minimo

float

[pt] Valor mínimo do pedido para aplicar o cupom.

data_criacao

timestamp

[pt] Data de criação do pedido.

data_expiracao

timestamp

[pt] Data de expiração do pedido.

data_modificacao

timestamp

[pt] Data de modificação do pedido.

endereco_entrega_bairro

text

[pt] Bairro do endereço de entrega.

endereco_entrega_cep

text

[pt] CEP do endereço de entrega.

endereco_entrega_cidade

text

[pt] Cidade do endereço de entrega.

endereco_entrega_cnpj

text

[pt] CNPJ do destinatário.

endereco_entrega_complemento

text

[pt] Complemento do endereço.

endereco_entrega_cpf

text

[pt] CPF do destinatário.

endereco_entrega_endereco

text

[pt] Logradouro do endereço de entrega.

endereco_entrega_estado

text

[pt] Estado do endereço de entrega.

endereco_entrega_id

text

[pt] Identificador do endereço de entrega.

endereco_entrega_ie

text

[pt] Inscrição estadual do destinatário.

endereco_entrega_nome

text

[pt] Nome do destinatário.

endereco_entrega_numero

text

[pt] Número do endereço.

endereco_entrega_pais

text

[pt] País do endereço de entrega.

endereco_entrega_razao_social

text

[pt] Razão social do destinatário.

endereco_entrega_referencia

text

[pt] Ponto de referência do endereço.

endereco_entrega_rg

text

[pt] RG do destinatário.

endereco_entrega_tipo

text

[pt] Tipo de pessoa (Física ou Jurídica).

id_anymarket

text

[pt] ID do pedido na plataforma AnyMarket.

id_externo

text

[pt] Identificador externo do pedido.

integration_data_external_id

text

[pt] Identificador externo no marketplace.

integration_data_integrator

text

[pt] Nome do integrador da plataforma.

integration_data_marketplace

text

[pt] Marketplace de origem do pedido.

integration_data_unique_id

text

[pt] Identificador único da integração.

numero

text

[pt] Número do pedido.

peso_real

float

[pt] Peso total real do pedido.

resource_uri

text

[pt] URI do recurso do pedido.

situacao_aprovado

boolean

[pt] Indica se o pedido foi aprovado.

situacao_cancelado

boolean

[pt] Indica se o pedido foi cancelado.

situacao_codigo

text

[pt] Código da situação do pedido.

situacao_final

boolean

[pt] Indica se essa é a situação final do pedido.

situacao_id

text

[pt] Identificador único da situação.

    Situações dos pedidos > > id

situacao_nome

text

[pt] Nome da situação do pedido.

situacao_notificar_comprador

boolean

[pt] Indica se o comprador será notificado sobre essa situação.

situacao_padrao

boolean

[pt] Indica se essa é a situação padrão dos pedidos.

situacao_resource_uri

text

[pt] URI da situação do pedido.

utm_campaign

text

[pt] Nome da campanha de marketing utilizada.

valor_desconto

float

[pt] Valor total de desconto aplicado ao pedido.

valor_envio

float

[pt] Valor do frete aplicado ao pedido.

valor_subtotal

float

[pt] Subtotal dos produtos no pedido (sem frete e desconto).

valor_total

float

[pt] Valor total do pedido com descontos e frete aplicados.

loja_integrada_pedidos_itens

Campo Tipo

pedido_id

text

[pt] Identificador único do pedido.

itens_altura

float

[pt] Altura do item em centímetros.

itens_disponibilidade

float

[pt] Quantidade disponível em estoque no momento da venda.

itens_id

text

[pt] Identificador único do item do pedido.

itens_largura

float

[pt] Largura do item em centímetros.

itens_linha

float

[pt] Número da linha no pedido.

itens_ncm

text

[pt] Código NCM do produto.

itens_nome

text

[pt] Nome do produto vendido.

itens_pedido

text

[pt] Referência ao pedido.

itens_peso

float

[pt] Peso do item em quilogramas.

itens_preco_cheio

float

[pt] Preço cheio sem desconto.

itens_preco_custo

float

[pt] Preço de custo do item.

itens_preco_promocional

float

[pt] Preço promocional aplicado ao item.

itens_preco_subtotal

float

[pt] Subtotal do item no pedido.

itens_preco_venda

float

[pt] Preço de venda do item com desconto.

itens_produto

text

[pt] Referência ao produto.

    Produtos > > id

itens_produto_pai

text

[pt] Identificador do produto pai, se houver.

itens_profundidade

float

[pt] Profundidade do item em centímetros.

itens_quantidade

float

[pt] Quantidade de unidades do item vendidas.

itens_sku

text

[pt] SKU (código de estoque) do produto.

    Produtos > > sku

itens_tipo

text

[pt] Tipo do item (ex: normal, brinde).

itens_variacao

text

[pt] Referência à variação do produto (ex: cor, tamanho).

loja_integrada_pedidos_pagamentos

Campo Tipo

pedido_id

text

[pt] Identificador único do pedido.

pagamentos_authorization_code

text

[pt] Código de autorização da transação.

pagamentos_bandeira

text

[pt] Bandeira do cartão de crédito utilizado.

pagamentos_boleto_url

text

[pt] Link para visualização do boleto gerado.

pagamentos_codigo_retorno_gateway

text

[pt] Código de retorno fornecido pelo gateway de pagamento.

pagamentos_forma_pagamento_codigo

text

[pt] Código interno da forma de pagamento.

pagamentos_forma_pagamento_configuracoes_ativo

boolean

[pt] Indica se a forma de pagamento está ativa.

pagamentos_forma_pagamento_configuracoes_disponivel

boolean

[pt] Indica se a forma de pagamento está disponível para o cliente.

pagamentos_forma_pagamento_id

text

[pt] Identificador da forma de pagamento.

    Formas de pagamentos > > id

pagamentos_forma_pagamento_imagem

text

[pt] URL da imagem representando a forma de pagamento.

pagamentos_forma_pagamento_nome

text

[pt] Nome da forma de pagamento (ex: Pix, Boleto, Cartão).

pagamentos_forma_pagamento_resource_uri

text

[pt] URI do recurso da forma de pagamento.

pagamentos_id

text

[pt] Identificador do pagamento.

pagamentos_identificador_id

text

[pt] Identificador externo da transação.

pagamentos_mensagem_gateway

text

[pt] Mensagem de retorno do gateway.

pagamentos_pagamento_tipo

text

[pt] Tipo do pagamento realizado (ex: instantâneo, parcelado).

pagamentos_parcelamento_numero_parcelas

float

[pt] Número de parcelas no pagamento.

pagamentos_parcelamento_valor_parcela

float

[pt] Valor de cada parcela.

pagamentos_pix_code

text

[pt] Código Pix da transação para pagamento instantâneo.

pagamentos_pix_qrcode

text

[pt] URL do QR Code para pagamento via Pix.

pagamentos_transacao_id

text

[pt] Identificador da transação no sistema de pagamentos.

pagamentos_valor

float

[pt] Valor total do pagamento.

pagamentos_valor_pago

float

[pt] Valor que foi efetivamente pago.

loja_integrada_pedidos_envios

Campo Tipo

pedido_id

text

[pt] Identificador único do pedido.

envios_data_criacao

timestamp

[pt] Data de criação do envio.

envios_data_modificacao

timestamp

[pt] Data da última modificação do envio.

envios_forma_envio_code

text

[pt] Código interno da forma de envio.

envios_forma_envio_id

text

[pt] Identificador único da forma de envio.

    Formas de envio > > id

envios_forma_envio_nome

text

[pt] Nome da forma de envio.

envios_forma_envio_tipo

text

[pt] Tipo de entrega (ex: PAC, SEDEX).

envios_id

text

[pt] Identificador único do envio.

envios_objeto

text

[pt] Identificador do objeto de transporte.

envios_pedido

text

[pt] Referência ao pedido associado ao envio.

envios_prazo

float

[pt] Prazo de entrega estimado em dias.

envios_valor

float

[pt] Valor cobrado pelo envio.

Pedidos: histórico de situações

Campo Tipo

id

text

[pt] Identificador único do histórico de situação.

alterado_por

text

[pt] Origem da alteração da situação do pedido (ex: gateway, lojista, sistema).

alterado_por_nome

text

[pt] Nome de quem realizou a alteração (ex: nome do gateway ou usuário).

data

timestamp

[pt] Data e hora em que a alteração de situação foi registrada.

numero

text

[pt] Número do pedido ao qual esta alteração de situação pertence.

    Pedidos > > numero

obs

text

[pt] Observações adicionadas no momento da alteração de situação.

resource_uri

text

[pt] URI do recurso do histórico de situação na API da Loja Integrada.

situacao_aprovado

boolean

[pt] Indica se a nova situação representa um pedido aprovado.

situacao_cancelado

boolean

[pt] Indica se a nova situação representa um pedido cancelado.

situacao_codigo

text

[pt] Código da nova situação do pedido.

situacao_final

boolean

[pt] Indica se a nova situação é considerada final no fluxo do pedido.

situacao_id

text

[pt] Identificador único da nova situação.

situacao_nome

text

[pt] Nome descritivo da nova situação atribuída ao pedido.

situacao_notificar_comprador

boolean

[pt] Indica se o comprador foi notificado sobre essa nova situação.

situacao_padrao

boolean

[pt] Indica se a nova situação é a situação padrão de pedidos.

situacao_resource_uri

text

[pt] URI do recurso da nova situação na API.

situacao_anterior_aprovado

boolean

[pt] Indica se a situação anterior representava um pedido aprovado.

situacao_anterior_cancelado

boolean

[pt] Indica se a situação anterior representava um pedido cancelado.

situacao_anterior_codigo

text

[pt] Código da situação anterior do pedido.

situacao_anterior_final

boolean

[pt] Indica se a situação anterior era considerada final no fluxo do pedido.

situacao_anterior_id

text

[pt] Identificador único da situação anterior.

situacao_anterior_nome

text

[pt] Nome descritivo da situação anterior do pedido.

situacao_anterior_notificar_comprador

boolean

[pt] Indica se o comprador foi notificado sobre a situação anterior.

situacao_anterior_padrao

boolean

[pt] Indica se a situação anterior era a padrão dos pedidos.

situacao_anterior_resource_uri

text

[pt] URI do recurso da situação anterior na API.

Pedidos: notas fiscais

Campo Tipo

id_pedido

text

[pt] Identificador único do pedido.

    Pedidos > > id

numero_pedido

text

[pt] Identificador único do pedido.

    Pedidos > > numero

numero

text

[pt] Número da nota fiscal emitida para o pedido.

access_key

text

[pt] Chave de acesso da nota fiscal eletrônica (NFe), composta por 44 dígitos.

data

timestamp

[pt] Data e hora de emissão ou registro da nota fiscal.

enviada

boolean

[pt] Indica se a nota fiscal foi enviada ao cliente ou à SEFAZ.

resource_uri

text

[pt] URI do recurso da nota fiscal na API da Loja Integrada.

serie

float

[pt] Número da série da nota fiscal, utilizada para controle fiscal.

url

text

[pt] URL pública para visualização ou download da nota fiscal em formato PDF (pode estar vazia se ainda não enviada).

url_xml

text

[pt] URL para download do arquivo XML da nota fiscal (pode estar vazia se ainda não enviada).

Produtos

Objeto principal

Campo Tipo

id

text

[pt] Identificador único do produto na Loja Integrada.

altura

float

[pt] Altura física do produto, utilizada para cálculo de frete.

apelido

text

[pt] Apelido do produto usado para URL amigável ou identificação interna.

ativo

boolean

[pt] Indica se o produto está ativo e disponível na loja.

bloqueado

boolean

[pt] Indica se o produto está bloqueado para edição ou exibição.

data_criacao

timestamp

[pt] Data em que o produto foi criado na Loja Integrada.

data_modificacao

timestamp

[pt] Data da última modificação realizada no produto.

descricao_completa

text

[pt] Descrição completa do produto, geralmente em HTML.

destaque

boolean

[pt] Indica se o produto está em destaque na loja.

estoque_gerenciado

boolean

[pt] Define se o controle de estoque está ativo para este produto.

estoque_quantidade

float

[pt] Quantidade disponível em estoque do produto.

estoque_situacao_em_estoque

float

[pt] Código de situação para quando o produto está disponível.

estoque_situacao_sem_estoque

float

[pt] Código de situação para quando o produto está indisponível.

gtin

text

[pt] Código GTIN (código de barras) do produto.

id_externo

text

[pt] Identificador externo do produto usado para integração com outros sistemas.

imagem_principal_caminho

text

[pt] Caminho da imagem principal no servidor.

imagem_principal_grande

text

[pt] URL da imagem em tamanho grande.

imagem_principal_icone

text

[pt] URL da imagem em formato ícone (miniatura).

imagem_principal_id

text

[pt] Identificador da imagem principal.

imagem_principal_id_anymarket

text

[pt] Identificador da imagem no sistema AnyMarket.

imagem_principal_imagem_id

text

[pt] ID da imagem relacionada ao produto.

imagem_principal_imagem_variacao

text

[pt] Identificador da variação relacionada a esta imagem.

imagem_principal_media

text

[pt] URL da imagem em tamanho médio.

imagem_principal_mime

text

[pt] Tipo MIME da imagem (ex: image/jpeg).

imagem_principal_pequena

text

[pt] URL da imagem em tamanho pequeno.

imagem_principal_posicao

float

[pt] Posição da imagem na ordem de exibição.

imagem_principal_principal

boolean

[pt] Indica se esta imagem é a principal do produto.

imagem_principal_produto

text

[pt] Referência ao produto relacionado à imagem.

imagem_principal_resource_uri

text

[pt] URI da imagem principal na API.

largura

float

[pt] Largura física do produto, utilizada para cálculo de frete.

marca

text

[pt] URI da marca associada ao produto.

    Marcas > > id

mpn

text

[pt] Código MPN (Manufacturer Part Number), usado para identificar peças ou produtos do fabricante.

ncm

text

[pt] Código NCM utilizado para classificação fiscal do produto.

nome

text

[pt] Nome do produto que será exibido na loja.

pai

text

[pt] Identificador do produto pai (em caso de variações).

peso

float

[pt] Peso físico do produto em quilogramas.

preco_cheio

float

[pt] Preço original do produto antes de qualquer desconto.

preco_custo

float

[pt] Preço de custo do produto para o lojista.

preco_promocional

float

[pt] Preço promocional aplicado ao produto.

preco_sob_consulta

float

[pt] Indica se o preço está sob consulta (exibe 'sob consulta' na loja).

produto_id_anymarket

text

[pt] Identificador do produto no sistema AnyMarket.

produto_id_sku_anymarket

text

[pt] SKU do produto no sistema AnyMarket.

profundidade

float

[pt] Profundidade física do produto, usada para cálculo de frete.

removido

boolean

[pt] Indica se o produto foi removido da loja.

resource_uri

text

[pt] URI do recurso do produto na API da Loja Integrada.

seo

text

[pt] URI do recurso de SEO associado ao produto.

sku

text

[pt] Código SKU (Stock Keeping Unit) único para controle de estoque do produto.

tags

text

[pt] Lista de tags aplicadas ao produto, utilizadas para filtros e funcionalidades internas.

tipo

text

url

text

[pt] URL pública do produto na loja virtual.

url_video_youtube

text

[pt] Link para vídeo do YouTube relacionado ao produto.

usado

boolean

[pt] Indica se o produto é usado (segunda mão).

loja_integrada_produtos_imagens

Campo Tipo

produto_id

text

[pt] Identificador único do produto na Loja Integrada.

imagens_id

text

[pt] Identificador único da imagem.

imagens_caminho

text

[pt] Caminho da imagem no servidor da Loja Integrada.

imagens_grande

text

[pt] URL da imagem em tamanho grande (ideal para visualização em tela cheia).

imagens_icone

text

[pt] URL da imagem em formato ícone, utilizada em miniaturas e listas.

imagens_id_anymarket

text

[pt] Identificador da imagem no sistema de marketplace AnyMarket.

imagens_imagem_id

text

[pt] ID da imagem associada ao produto na Loja Integrada.

    Produtos: imagens > > id

imagens_media

text

[pt] URL da imagem em tamanho médio (padrão para exibição em listagens).

imagens_mime

text

[pt] Tipo MIME da imagem (ex: image/jpeg, image/png).

imagens_pequena

text

[pt] URL da imagem em tamanho pequeno (miniatura reduzida).

imagens_posicao

float

[pt] Posição da imagem na ordem de exibição das imagens do produto.

imagens_principal

boolean

[pt] Indica se esta imagem é a principal do produto.

imagens_produto

text

[pt] URI do produto ao qual esta imagem pertence.

imagens_resource_uri

text

[pt] URI do recurso da imagem na API da Loja Integrada.

loja_integrada_produtos_categorias

Campo Tipo

produto_id

text

[pt] Identificador único do produto na Loja Integrada.

categoria_id

text

[pt] Lista de URIs das categorias às quais o produto pertence.

    Categorias > > id

loja_integrada_produtos_variacoes

Campo Tipo

produto_id

text

[pt] Identificador único do produto na Loja Integrada.

variacao_id

text

[pt] Lista de URIs das variações específicas do produto.

    Produtos: grades de variação > variacoes > id

variacao_grade_id

text

[pt] Lista de URIs das grades (variações) associadas ao produto.

    Produtos: grades de variação > > id

loja_integrada_produtos_grades

Campo Tipo

produto_id

text

[pt] Identificador único do produto na Loja Integrada.

grade_id

text

[pt] Lista de URIs das grades (variações) associadas ao produto.

    Produtos: grades de variação > > id

Produtos: estoque

Campo Tipo

id

text

[pt] Identificador único do registro de estoque do produto.

gerenciado

boolean

[pt] Indica se o estoque do produto é gerenciado automaticamente pela plataforma.

produto

text

[pt] URI do produto ao qual o estoque está associado.

    Produtos > > id

quantidade

float

[pt] Quantidade total do produto disponível em estoque.

quantidade_disponivel

float

[pt] Quantidade realmente disponível para venda (total - reservada).

quantidade_reservada

float

[pt] Quantidade reservada para pedidos ainda não finalizados.

resource_uri

text

[pt] URI do recurso de estoque na API da Loja Integrada.

situacao_em_estoque

float

[pt] Código da situação para exibir quando o produto está em estoque.

situacao_sem_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

id

text

[pt] Identificador único da grade de variação na Loja Integrada.

id_externo

text

[pt] Identificador externo da grade, utilizado para integração com sistemas próprios.

nome

text

[pt] Nome da grade de variação (ex: Tamanho, Cor, Gênero).

nome_visivel

text

[pt] Nome da grade exibido para o cliente na loja.

resource_uri

text

[pt] URI do recurso da grade de variação na API.

loja_integrada_produtos_grade_variacoes

Campo Tipo

grade_id

text

[pt] Identificador único da grade de variação na Loja Integrada.

variacoes_grade

text

[pt] URI da grade à qual esta variação pertence.

variacoes_id

text

[pt] Identificador único da variação dentro da grade.

variacoes_id_externo

text

[pt] Identificador externo da variação, usado para integrações com sistemas externos.

variacoes_nome

text

[pt] Nome da variação (ex: P, M, G, Azul, Feminino, Unissex).

variacoes_resource_uri

text

[pt] URI da variação na API da Loja Integrada.

Produtos: imagens

Campo Tipo

id

text

[pt] Identificador único da imagem do produto.

caminho

text

[pt] Caminho da imagem no servidor da Loja Integrada, relativo à estrutura de diretórios da loja.

id_anymarket

text

[pt] Identificador da imagem no sistema AnyMarket, usado em integrações com marketplaces.

imagem_id

text

[pt] Identificador interno da imagem, utilizado para controle na plataforma.

mime

text

[pt] Tipo MIME da imagem, como image/jpeg ou image/png.

posicao

float

[pt] Ordem de exibição da imagem na galeria do produto.

principal

boolean

[pt] Indica se esta é a imagem principal do produto.

produto

text

[pt] URI do produto ao qual esta imagem pertence.

    Produtos > > id

resource_uri

text

[pt] URI do recurso da imagem na API da Loja Integrada.

Produtos: preços

Campo Tipo

id

text

[pt] Identificador único do registro de preço na Loja Integrada.

cheio

float

[pt] Preço original do produto antes de descontos ou promoções.

custo

float

[pt] Preço de custo do produto para o lojista (pode ser nulo se não informado).

produto

text

[pt] URI do produto ao qual este preço está associado.

    Produtos > > id

promocional

float

[pt] Preço promocional do produto, se houver (pode ser nulo).

resource_uri

text

[pt] URI do recurso de preço do produto na API.

sob_consulta

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

id

text

[pt] Identificador único da situação do pedido na Loja Integrada.

aprovado

boolean

[pt] Indica se a situação representa um pedido aprovado.

cancelado

boolean

[pt] Indica se a situação representa um pedido cancelado.

codigo

text

[pt] Código interno da situação do pedido, usado para controle e automações.

final

boolean

[pt] Indica se essa é uma situação final do pedido, ou seja, se o fluxo está encerrado.

nome

text

[pt] Nome da situação, exibido ao lojista e, em alguns casos, ao cliente.

notificar_comprador

boolean

[pt] Indica se o comprador será notificado por e-mail quando o pedido atingir essa situação.

padrao

boolean

[pt] Indica se essa é a situação padrão para novos pedidos.

resource_uri

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