Propriedade Tipo Descrição

transaction_code string Código de transação da venda.

registration_date datetime Data de registro da venda.
customer object Conjunto de dados do cliente.
customer.name string(50) Nome do cliente.
customer.email string(100) E-mail do cliente.
customer.phone string(15) Telefone do cliente.
customer.doc_type string(4) Tipo de documento do cliente (CPF/CNPJ)
customer.doc string(30) Documento do cliente.
customer.state_doc string(30) Inscrição estadual quando pessoa jurídica.
address object Conjunto de dados do endereço do cliente.
address.zipcode string(9) CEP do endereço do cliente.
address.address string(100) Logradouro do cliente.
address.number string(20) Número do endereço do cliente.
address.complement string(50) Complemento do endereço do cliente.
address.neighborhood string(50) Bairro do endereço do cliente.
address.city string(50) Cidade do endereço do cliente.
address.state string(2) Estado do endereço do cliente.
transaction object Informações da transação.
transaction.sale_value float Preço de venda total dos itens.
transaction.discount_value float Valor do desconto concedido.
transaction.shipping_value float Valor do frete.
transaction.total_value float Valor total da venda, com desconto e frete.
transaction.transaction_fee float Taxa de transação.
transaction.doppus_fee float Taxa Doppus.
transaction.affiliate_fee float Valor total de comissões para afiliados.
transaction.coproducers_fee float Valor total de comissões para co-produtores.
transaction.producer_fee float Comissão do produtor.
payment object Conjunto de dados de pagamento da venda.
payment.payment_type string Tipo de pagamento (CREDITCARD / BILLET / PIX).
payment.due_date date Data de vencimento do boleto bancário.
payment.digitable_line string(55) Linha digitável para pagamento via boleto bancário.
payment.qrcode string(250) Imagem do QRCode para pagamento via PIX.
payment.brcode string(250) Código BRCode para pagamento via PIX.
payment.plots integer Número de parcelas de pagamento.
payment.value float Valor da parcela.
items array Conjunto de dados dos itens da venda.
items[].code string(32) Código do item.
items[].description string(100) Descrição do item.
items[].options string(200) Variações do item. Ex.: Cor: Azul / Tamanho: G.
items[].image string(150) Endereço da imagem do item.
items[].type string Tipo de produto (PHYSICAL_PRODUCT / INFOPRODUCT / DROPSHIPPING)
items[].amount integer Quantidade de itens.
items[].item_value float Preço de venda do item.
items[].sale_value float Preço de venda total do item.
items[].discount_value float Desconto total do item.
items[].affiliate_fee float Comissão do afiliado.
items[].affiliate_code string(10) Código do afiliado.
items[].affiliate_name string(50) Nome do afiliado.
items[].affiliate_email string(100) E-mail do afiliado.
items[].coproducers_fee float Comissão dos co-produtores.
shipping object Conjunto de dados de frete.
shipping.method string(50) Método de envio.
shipping.deadline integer Prazo de entrega.
tracking object Conjunto de dados de traqueamento.
tracking.discount_coupon string(20) Cupom de desconto utilizado.
tracking.ip_address string(100) IP de origem da transação.
tracking.src string(100) Informações de rastreamento, origem.
tracking.utm_source string(100) Informações de rastreamento, recurso.
tracking.utm_medium string(100) Informações de rastreamento, mídia.
tracking.utm_campaign string(100) Informações de rastreamento, campanha.
tracking.utm_term string(100) Informações de rastreamento, termos.
tracking.utm_content string(100) Informações de rastreamento, conteúdo.
links object Conjunto de dados dos links de retorno.
links.url_billet string(150) Link para exibição do boleto bancário.
links.url_reprocess string(150) Link para reprocessar o pagamento.
links.url_checkout string(150) Link do checkout quando abandono de checkout.
last_status_date datetime Data da última alteração de status.
status string Status da venda (EXIT_CHECKOUT / WAITING / REFUSED / NOT_COMPLETED / ANALYSIS / APPROVED / COMPLETED / REVERSED / CONTESTED / CLAIMED / CHARGEBACK).
status_log array Conjunto de dados do histórico de status.
status_log[].registration_date datetime Data de registro do status.
status_log[].status string Status da venda.
status_log[].message string(100) Mensagem descritiva do status.