Informações sobre o endpoint de pedidos
INFO
/
Campos:
| Campo | Descrição |
|---|---|
| id | ID interno da aplicação |
| code | Campo com o valor atual para o código do pedido no ERP (preenchido com "f1_idpedido" por padrão). |
| f1_id | ID do pedido na Loja. |
| marketplace_id | Código do marketplace. |
| marketplace_prefix | Prefixo do marketplace. |
| marketplace_origin | Origem do marketplace. |
| client_id | Código único do cliente. |
| marketplace_order_id | Código do pedido no marketplace. |
| client_name | Nome completo ou razão social do cliente. |
| client_cpf_cnpj | CPF ou CNPJ do cliente, somente números. |
| client_ie_rg | Inscrição estadual ou RG do cliente. Caso isento apresentará "ISENTO". |
| client_responsible | Responsável pelo cliente |
| E-mail do cliente. | |
| phone1 | Telefone primário do cliente. Somente números. |
| phone2 | Telefone secundário do cliente. Somente números. |
| fax | Telefone FAX do cliente. Somente números. |
| cellphone | Telefone celular do cliente. Somente números. |
| receiver | Nome do destinatário, se preenchido pelo usuário. |
| order_date | Data de criação do pedido. No formato YYYY-MM-DD HH:MM:SS. |
| approved_date | Data de aprovação do pedido. No formato YYYY-MM-DD HH:MM:SS. |
| date_last_change | Data de ultima alteração do pedido. No formato YYYY-MM-DD HH:MM:SS. |
| state | Sigla do estado, em caracteres maiúsculos. |
| city | Nome da cidade. |
| neighborhood | Nome do bairro. |
| street | Nome do logradouro. |
| number | Número do logradouro. |
| complement | Complemento do endereço, se preenchido pelo usuário. |
| zipcode | CEP do destinatário. Somente números. |
| ibge | Código IBGE correspondente ao CEP do destinatário. |
| invoice_number | Número da Nota Fiscal. |
| transport_name | Nome da transportadora. Ex.: Correios Sedex, Sedex 10, etc. Consulte as transportadoras configuradas no painel administrativo da loja para obter os nomes disponíveis. |
| transport_code | Código da transportadora na loja virtual. Estes códigos são fixos na plataforma. |
| free_shipping_id | Identificação do frete grátis na loja virtual. |
| tracking_code | Código de rastreio. |
| estimated_delivery_time | Prazo estimado para a entrega. |
| estimated_delivery_date | Data estimada para entrega. No formato YYYY-MM-DD HH:MM:SS. |
| freight_price_id | Identificação da cotação do frete. |
| tid_cielo | Código TID da Cielo. |
| tid | Código TID. |
| status_id | ID do status atual do pedido. Estes IDs podem ser obtidos pelo painel administrativo da Loja (menu Configurações>Status de pedidos) |
| status_name | Descrição (nome) do status atual do pedido. Assim como o ID, todos os status podem ser obtidos pelo painel administrativo da Loja (menu Configurações>Status de pedidos, nome de status Administrativo). |
| status_code | Código do status no ERP. |
| ip_origin | IP do cliente no momento em que o pedido foi criado. |
| erp_code | Campo com o valor atual para o código do pedido no ERP (não preenchido por padrão). |
| agreement_name | Nome do convênio. |
| agreement_id | ID do convênio. |
| analyst_responsible_for_approval | Nome do analista responsável pela aprovação do pedido. Este parâmetro só é preenchido se o módulo de análise de pedidos estiver ativo no momento da aprovação do pedido. |
| analyst_responsible | Nome do analista responsável pelo pedido. Este parâmetro só é preenchido se o módulo de análise de pedidos estiver ativo no momento da análise do pedido. |
| installments | Número de parcelas do pedido. |
| installment_value | Valor da parcela do pedido. |
| payment_protocol | Protocolo do pagamento. |
| payment_method | Nome da forma de pagamento utilizada. Verifique com a equipe de suporte quais são as formas de pagamento disponíveis e ativas em sua loja. |
| payment_method_f1_code | Código interno da forma de pagamento. |
| payment_method_f1_id | ID interno da forma de pagamento. |
| payment_method_code | Código externo da forma de pagamento cadastrada no site. |
| telesale_seller_id | ID do vendedor na loja. |
| total_value_items | Valor total dos itens do pedido. |
| total_value_freight | Valor total do frete, sem contar o desconto do frete. |
| total_value_fees | Valor dos juros. |
| freight_discount_value | Valor do desconto do frete, se houver. |
| total_discount_value | Valor do desconto total do pedido. Considera todos os descontos possíveis: frete, cupom de desconto, forma de pagamento. |
| discount_coupon_value | Valor do desconto concedido pelo cupom de desconto. |
| prog_discount_value | Valor do desconto concedido pelo desconto progressivo. |
| discount_method_value | Valor do desconto concedido pela forma de pagamento. |
| order_final_value | Valor final do pedido. Este valor corresponde ao total pago pelo cliente. |
| channel | Canal onde o pedido foi realizado. |
| packaging_value | Valor da embalagem. |
| filial_url_code | Código da filial informada no ato da compra. |
| seller_cpf | CPF do vendedor do televendas. |
| seller_code | Código do vendedor do televendas. |
| resale_segment_id | ID do segmento da revenda. |
| external_client_code | Código externo do cliente. |
| marketplace_pickup_shop | Informa se foi selecionado que será resgatado na loja, onde 1 para sim e 0 para não. |
| marketplace_order_reference | Referencia do pedido no marketplace. |
| mercado_livre_announcement_type | Tipo de anuncio do Mercado Livre. |
| note | Observações. |
| invoice_file | Arquivo da nota fiscal. |
| shipping_label_pdf | Arquivo .pdf da etiqueta do envio. |
| shipping_label_plp | Arquivo .plp da etiqueta do envio. |
| authorization_number | Número de autorização. |
| cv_nsu_number | Número de NSU CV. |
| authentication_number | Número da autenticação. |
| sqn_number | Númedo do SQN. |
| whatsapp_tracking | Identifica se o rastreamento por whatsapp foi ativado nesse pedido (valores possiveis 0 ou 1). |
| student_name | Nome do aluno. |
| student_school | Escola do aluno. |
| student_class | Classe do aluno. |
| student_grade | Grade do aluno. |
| student_registration | Registro do aluno. |
| freight_export_code | Código de exportação do frete. |
| payment_export_code | Código de exportação da forma de pagamento. |
| distribution_center_code | Código do centro de distribuição. |
| move_items | Campo que indica se os itens do pedido devem ser movidos. |
| order_parent_id_recurrence | ID de pedido pai de recorrência. |
| partner_code | Código do parceiro. |
| partner_name | Nome do parceiro. |
| partner_comission | Valor da comissão do parceiro. |
| mkp_external_code | Código externo para identificação do marketplace. |
| shipping_mode | Informação do modo de envio utilizado no pedido. |
| coupon_code | Código do cupom aplicado no carrinho pelo cliente. |
| updated_for | Identifica o responsável pela ultima modificação do pedido na API, onde o valor "APISYNC" indica uma atualização realizada pela loja e "EXTERNAL" uma atualização realizada pelo cliente via requisição |
| created_at | Data da criação do pedido na API no formato YYYY-MM-DD HH:MM:SS. |
| updated_at | Data da ultima atualização do pedido na API no formato YYYY-MM-DD HH:MM:SS. |
| deleted_at | Data da remoção do pedido na API no formato YYYY-MM-DD HH:MM:SS. |
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request INFO '/'Response Response Example
{}Requisição
Nenhum
Respostas
Modificado em 2025-07-07 14:44:01