Descrição dos campos

A seguir temos o detalhamento dos tipos de campos (ou subcampos) presentes dentro do campo dados dos objetos JSON retornados pelos eventos.

Alguns eventos enviam o mesmo tipo de objeto, como é o caso dos eventos de Pedido gerado, Pedido faturado e Pedido cancelado, que enviam um objeto do tipo Pedido.

Tipo Pedido

Campo	Tipo	Descrição
id	Integer	Identificador único.
total	Double	Valor total do pedido.
numero	Integer	Número auto-incremental do pedido.
status	String: 1	Status atual do pedido. 0 = Cancelado, 1 = Orçamento, 2 = Pedido.
cliente_id	Integer	Identificador único do cliente.
criador_id	Integer	Identificador único do vendedor que fez o pedido.
status_b2b	Integer	Status atual do pedido no B2b. null = Pedido não foi gerado com o B2B, 1 = Em aberto, 2 = Concluído.
cliente_cep	String: 8	CEP do cliente
cliente_rua	String: 100	Rua do cliente
observacoes	String: 500	Informações adicionais que o vendedor registrou no pedido.
valor_frete	Double	Valor do frete.
cliente_cnpj	String: 14	CNPJ do cliente
contato_nome	String: 50	Nome do contato do cliente.
data_criacao	DateTime	Data de criação do pedido. Pode ser diferente da data_emissao pois um pedido pode ter sido criado ontem e emitido apenas hoje.
data_emissao	Date	Data de emissão do pedido. Pode ser null.
nome_contato	String: 50	Nome do contato do cliente.
rastreamento	String: 200	Código ou link para rastreamento de envio do pedido.
cliente_email	List	Lista com emails do cliente
cliente_bairro	String: 30	Bairro do cliente
cliente_cidade	String: 50	Cidade do cliente
cliente_estado	String: 2	Estado do cliente
cliente_numero	String: 100	Número do endereço do cliente
tipo_pedido_id	Integer	Identificador único do tipo de pedido. É usado apenas caso você integre a entidade Tipo de Pedido.
cliente_suframa	String: 20	Suframa do cliente
representada_id	Integer	ID da Representada
cliente_telefone	List	Lista com telefones do cliente
pedido_origem_id	Integer	Identificador da origem do pedido.
status_custom_id	Integer	Identificador único do status de pedido customizado. É usado apenas caso você integre a entidade Status de Pedido Customizado.
ultima_alteracao	DateTime	Data e hora da última modificação do pedido.
transportadora_id	Integer	Identificador único da transportadora.
condicao_pagamento	String: 100	Condição de pagamento em formato texto livre. É usado apenas caso você não integre a entidade Condições de Pagamento.
forma_pagamento_id	Integer	Identificador único da forma de pagamento. É usado apenas caso você integre a entidade Formas de Pagamento.
status_faturamento	Integer	Não faturado = 0, Parcialmente faturado = 1, Faturado = 2.
cliente_complemento	String: 50	Complemento do cliente
transportadora_nome	String: 50	Nome da transportadora.
cliente_razao_social	String: 100	Razão social do cliente
comissoes_vendedores	List	percentual de comissões de cada vendedor do pedido, cada comissão da lista está no formato: `{"vendedor_id": Integer, "percentual": Double}`.
cliente_nome_fantasia	String: 100	Nome fantasia do cliente
condicao_pagamento_id	Integer	Identificador único da condição de pagamento. É usado apenas caso você integre a entidade Condições de Pagamento.
representada_razao_social	String: 50	Razão Social da Representada
cliente_inscricao_estadual	String: 30	Inscrição estadual do cliente
representada_nome_fantasia	String: 50	Nome fantasia da Representada
possui_informacao_pagamento	Boolean	Indica se o pedido possui link de pagamento.
percentual_total_comissao_pedido	Double	percentual total de comissão do pedido.

Item do pedido: campo `itens`

Campo	Tipo	Descrição
id	Integer	Identificador único do item do pedido.
st	Double	Valor da ST (Substituição Tributária)
ipi	Double	Valor do IPI do produto
excluido	Boolean	Indica se o item está excluído.
subtotal	Double	Subtotal final calculado
tipo_ipi	Char	Indica se o IPI é percentual P ou valor fixo V
produto_id	Integer	ID do produto na Mercos.
quantidade	Double	Quantidade vendida.
observacoes	String: 500	Informações adicionais que o vendedor registrou no item.
grupo_grades	UUID	Identificador para um conjunto de produtos grade
preco_tabela	Double	Preço padrão do produto no momento da venda (campo “preco_tabela” da entidade Produto) ou caso tenha sido utilizada uma tabela de preço (tabela_preco_id diferente de null) será o valor da tabela de preço utilizada.
produto_nome	String: 100	Nome do Produto na Mercos.
cotacao_moeda	Double	Cotação da moeda, em caso de venda em moeda estrangeira.
preco_liquido	Double	Preço de venda do produto.
produto_codigo	String: 50	Código do Produto na Mercos.
tabela_preco_id	Integer	ID da tabela de preço na Mercos. Caso tenha sido utilizado o preço padrão (campo “preco_tabela” da entidade Produto), a tabela_preco_id será null.
quantidade_grades	List	Lista com as grades de cores e tamanhos usadas, e suas respectivas quantidades. Caso o produto possua somente Cor, o Tamanho será null, e vice-versa. A soma das quantidades nesta lista será igual ao campo quantidade do item.cor String: 15tamanho String: 15quantidade Double
produto_agregador_id	Integer	ID do produto agregador no Mercos, quando item é do tipo grade
descontos_do_vendedor	List	Lista com os acréscimos e descontos concedidos pelo vendedor ao item, em formato Double. Um acréscimo é identificado por um desconto com valor negativo.
descontos_de_promocoes	List	Lista com os descontos de promoções aplicadas ao item, cada elemento da lista é um objeto no formato: `{"regra_id": Integer, "desconto": Double}`
descontos_de_politicas	List	Lista com os acréscimos ou descontos de políticas comerciais aplicadas ao item, cada elemento da lista é um objeto no formato: `{"regra_id": Integer, "desconto": Double}` Um acréscimo é identificado por um desconto com valor negativo.

Campos extras do pedido: campo `extras`

Campo	Tipo	Descrição
campo_extra_id	Integer	Identificador único do campo extra.
nome	String: 50	Nome do campo extra.
tipo	String	(“0”) Texto livre, (“1”) data, ("2") numérico, ("3") hora, ("4") Lista e ("5") Somente leitura.
valor_texto	String: 50	Retorna um texto se o campo for do tipo texto ou somente leitura.
valor_data	String	Retorna uma data se o campo for do tipo data.
valor_decimal	Double	Retorna um Double se o campo for do tipo numérico.
valor_hora	String	Retorna uma hora o valor se o campo for do tipo texto.
valor_lista	List	Retorna uma lista de Ids e valores dos itens da lista, ex: [[1, "sp"], [2, "sc"]].
valor		O tipo deste atributo depente do tipo do campo extra como descrito na tabela abaixo.

Tipo do campo extra	Tipo	Formato
Texto simples("0")	String: 50
Data("1")	String	"yyyy-dd-mm", ex: "2018-21-02".
Numérico("2")	Double	Valor máximo: 99999999.99999.
Hora("3")	String	"HH:mm", ex: "21:56".
Lista("4")	List	Retorna uma lista de Ids e valores dos itens da lista, ex: [[1, "sp"], [2, "sc"]].
Somente leitura("5")	String: 50

Endereço de entrega: campo `endereco_entrega`

Campo	Tipo	Descrição
id	Integer	Identificador único do endereço. Este identificador é o mesmo de endereço adicional de cliente.
cep	String: 8	CEP da localização do endereço
endereco	String: 200	Endereço ou rua
numero	String: 100	Número do local
complemento	String: 200	Complementos do endereço
bairro	String: 200	Bairro do endereço
cidade	String: 200	Cidade do endereço
estado	String: 2	Estado da cidade

Tipo Pagamento

Campo	Tipo	Descrição
id	Integer	Identificador único da solicitação de pagamento.
token	String	Token único da solicitação de pagamento. Com ele é possível acessar a página de um Link de pagamento pela URL `https://app.mercos.com/pagamentos/`+`token`
data_criacao	DateTime	Data e hora que a solicitação de pagamento foi criada.
criador_id	Integer	Identificador único do usuário que criou a solicitação de pagamento.
pedido_id	Integer	Identificador único do pedido.
cliente_id	Integer	Identificador único do cliente.
valor	Decimal	Valor cobrado.
numero_parcelas	Number	Número de parcelas.
forma_pagamento	String	Formas de pagamento disponíveis: `credit` para Cartão de crédito, `boleto` para Boleto.
nota_fiscal	String	Número da Nota Fiscal, quando informada.
data_expiracao	Date	Data em que a solicitação de pagamento expira. Nos links de pagamento, o cliente ficará impedido de utilizar o link após esta data, com exceção dos links de Boletos.
ultima_alteracao	DateTime	Data e hora da última atualização na solicitação de pagamento. Alterações no status da transação também atualizam este campo.
transacoes	Objeto de transações	Lista as transações associadas a solicitação de pagamento. Em um parcelamento, cada parcela corresponde a uma transação.

Transações: campo `transacoes`

Campo	Tipo	Descrição
transacao_id	Integer	Identificador único da transação.
valor	Decimal	Valor cobrado. No caso de um parcelamento, este corresponde ao valor da parcela.
valor_liquido	Decimal	Valor líquido, descontadas as tarifas de processamento da transação ou emissão de boleto.
valor_original	Decimal	Valor da cobrança na sua criação. Este valor auxilia a identificar se houve alteração posterior no campo Valor cobrado.
data_vencimento	Date	Data de vencimento.
data_vencimento_original	Date	Data de vencimento da cobrança na sua criação. Esta data auxilia a identificar se houve alteração posterior na data de vencimento.
observacao	String	Descrição exibida no corpo do boleto. Em outras formas de pagamento será sempre `null`.
bandeira	String	Bandeira do cartão. Em outras formas de pagamento será sempre `null`.
status	String	Status dessa transação: `pendente`, `recebido`, `confirmado`, `vencida`, `estornada`, `recebido-em-dinheiro`, `estorno-solicitado`, `chargeback-recebido`, `chargeback-disputa`, `chargeback-aguardando-repasse`, `recuperacao`, `recuperada`, `aguardando-analise`
data_ultimo_status	DateTime	Data da última atualização na transação.
data_prevista_repasse	Date	Data estimada para repasse do Valor líquido.
data_repasse	Date	Data que foi realizado o repasse.

Tipo Cliente

Campo	Tipo	Descrição
id	Integer	Identificador único
razao_social	String: 100	Razão social para pessoa jurídica. Nome do cliente para pessoa física.
nome_fantasia	String: 100	Nome fantasia (pessoa jurídica) / Apelido (pessoa física).
tipo	String: 1	J para pessoa jurídica, F para pessoa física.
cnpj	String: 18	CNPJ para pessoa jurídica, CPF para pessoa física. Apenas números, sem pontuação.
inscricao_estadual	String: 30	Identificação da inscrição estadual do cliente.
suframa	String: 20	Código Suframa para clientes da Zona Franca de Manaus. Caso seja informado, todos os pedidos deste cliente terão IPI zerado (isento).
rua	String: 100	Rua do endereço do cliente
numero	String: 100	Número do endereço do cliente
complemento	String: 50	Informações adicinais do endereço do cliente.
cep	String: 9	Pode ser informado com ou sem hífen.
bairro	String: 30	Bairro do cliente
cidade	String: 50	Cidade do cliente
estado	String: 2	Sigla do Estado.
observacao	String: 500	Utilize para guardar quaisquer informações que não tenham campos específicos.
emails	List	Lista de objetos Email com os emails do cliente. - e-mail (String: 75)
telefones	List	Lista de objetos Telefone com os telefones do cliente. - numero (String: 30)
contatos	List	Lista de objetos Contato com os contatos do cliente. - nome (String: 50) - cargo (String: 30) - excluido (Boolean) - emails (List) - telefones (List)
nome_excecao_fiscal	String: 20	Exceção fiscal que identifica o(s) cliente(s) sujeito(s) a esta configuração de ICMS-ST. Ex: “SIMPLES”.
criador_id	Integer	Identificador do criador do cliente. Este campo foi introduzido em 2021, registros antigos podem não retornar criador.
segmento_id	Integer	Identificador do segmento do cliente para diferenciação em relatórios e políticas comerciais. Ex: 123.
rede_id	Integer	Identificador da rede do cliente para diferenciação em relatórios. Ex: 456.
bloqueado_b2b	Boolean	Indica se o cliente possui bloqueio de acesso ao E-commerce B2B.
excluido	Boolean	Indica se o cliente está excluído.
bloqueado	Boolean	Indica se o cliente está bloqueado.
motivo_bloqueio_id	Integer	Identificador único do motivo de bloqueio do cliente.
enderecos_adicionais	List	Lista de objetos EnderecoAdicional do cliente. - cep (String: 9) Pode ser informado com ou sem hífen. - endereco (String: 200) - numero (String: 100) - complemento (String: 200) - bairro (String: 200) - cidade (String: 200) - estado (String: 2)
limite_credito	List	Lista de objetos LimiteCreditoCliente, cada elemento da lista é um objeto no formato: {"limite_disponivel": Float, "limite_total": Float}
ultima_alteracao	DateTime	Data e hora da última modificação deste cliente no Mercos