Informações sobre o endpoint
INFO
/
Dependências
Campos
| Campo | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| f1_code | Identificador único do cliente na loja. | varchar | Sim |
| code | Código do cliente no ERP. | varchar | Sim |
| person_type | Tipo de pessoa, informar "J" para pessoa jurídica e "F" para pessoa física | varchar | Sim |
| cgc | CPF/CNPJ do cliente, somente números. | varchar | Sim |
| name_fancy | Nome fantasia. | varchar | Não |
| name_corporate | Razão Social. | varchar | Não |
| registration_state | Inscrição estadual. | varchar | Não |
| registration_municipal | Inscrição municipal. | varchar | Não |
| phone_number | Telefone do cliente, informar apenas números. | varchar | Sim |
| cell_phone_number | Telefone celular do cliente, informar apenas números. | varchar | Não |
| date_of_birth | Data de nascimento | date | Não |
| email_invoice | E-mail do cliente, será o e-mail utilizado para que o cliente faça o login na loja. Deve ser enviado apenas um e-mail e não pode conter caracteres especiais no e-mail ou ao final do mesmo | varchar | Sim |
| external_segment_code | Código externo do segmento (O campo deve ser preenchido com null caso não exista segmento no cliente). | varchar | Sim |
| price_list | Código da lista de preço do cliente. | varchar | Não |
| credit | Valor do crédito do cliente. | decimal | Sim |
| allow_post_payment | Indica se permite pós pagamento. 0 para não permite e 1 para permite | bool | Sim |
| average_payment_period | Prazo médio de pagamento, em dias. | int | Sim |
| tax_regime | Código do regime tributário do cliente. | varchar | Não |
| icms_taxpayer | Indica se o cliente é contribuinte de ICMS. | int | Não |
| suframa_code | Código suframa. | varchar | Não |
| suframa_expiration_date | Data de expiração do código suframa. | date | Não |
| created | Data da criação do cliente. | date | Não |
| default_order_type | Tipo de pedido padrão. | varchar | Não |
| default_operation_type | Tipo de operação padrão, informar a string "REVE" fixamente. | varchar | Sim |
| exclusive_payment_method_condition_installment | Código da condição de pagamento padrão. | varchar | Não |
| simples_code | Código do tipo de simples nacional do cliente na loja. | varchar | Não |
| minimum_order_value | Valor minimo para os pedidos do cliente. | decimal | Não |
| maximum_order_value | Valor máximo para os pedidos do cliente. | decimal | Não |
| moderated | Indica se o cliente está moderado. 1 para sim e 0 para não | bool | Não |
| integrated | Campo onde é possível realizar o controle se o cliente foi integrado ao não. 1 para sim e 0 para não | bool | Não |
| integrated_message | Campo para informar possíveis problemas que o ERP não está permitindo que o cliente seja integrado | varchar | Não |
| billing_distribution_center | Informação do código de centro para faturamento dos pedidos do cliente, quando aplicável | varchar | Não |
| cnae | CNAE do cliente. | varchar | Não |
| secondary_cnaes | CNAE secondarios para o cliente. | varchar | Não |
| block_card_payment | Define se o cliente pode ou não realizar compras com cartão. (1 = Sim e 0 = Não) | bool | Não |
| responsible_crm_user_id | ID do usuário responsável pela criação do cliente. | int | Não |
| responsible_crm_user_type | Tipo do usuário responsável pela criação do cliente. | varchar | Não |
| responsible_crm_user_name | Nome do usuário responsável pela criação do cliente. | varchar | Não |
| responsible_crm_user_mail | Email do usuário responsável pela criação do cliente. | varchar | Não |
| responsible_crm_user_external_code | Código externo do responsável pela criação do cliente. | varchar | Não |
| responsible_crm_client_external_code | Código externo do cliente criado pelo responsável. | varchar | Não |
| address_ibge_code | Código do IBGE referente ao CEP do cliente | varchar | Não |
| address_street | Rua. | varchar | Sim |
| address_number | Número. | varchar | Sim |
| address_complement | Complemento. | varchar | Não |
| address_state | UF. | varchar | Sim |
| address_city | Cidade. | varchar | Sim |
| address_neighborhood | Bairro. | varchar | Sim |
| address_country | País. | varchar | Não |
| address_reference | Referência. | varchar | Não |
| address_zipcode | CEP. | varchar | Sim |
| delivery_address_ibge_code | Código do IBGE referente ao CEP do cliente | varchar | Não |
| delivery_address_street | Rua do endereço de entrega. | varchar | Sim |
| delivery_address_number | Número do endereço de entrega. | varchar | Sim |
| delivery_address_complement | Complemento do endereço de entrega. | varchar | Não |
| delivery_address_state | UF do endereço de entrega. | varchar | Sim |
| delivery_address_city | Cidade do endereço de entrega. | varchar | Sim |
| delivery_address_neighborhood | Bairro do endereço de entrega. | varchar | Sim |
| delivery_address_country | País do endereço de entrega. | varchar | Não |
| delivery_address_reference | Referência do endereço de entrega. | varchar | Não |
| delivery_address_zipcode | CEP do endereço de entrega. | varchar | Sim |
| charge_address_ibge_code | Código do IBGE referente ao CEP do cliente | varchar | Não |
| charge_address_street | Rua do endereço de cobrança. | varchar | Sim |
| charge_address_number | Número do endereço de cobrança. | varchar | Sim |
| charge_address_complement | Complemento do endereço de cobrança. | varchar | Não |
| charge_address_state | UF do endereço de cobrança. | varchar | Sim |
| charge_address_city | Cidade do endereço de cobrança. | varchar | Sim |
| charge_address_neighborhood | Bairro do endereço de cobrança. | varchar | Sim |
| charge_address_country | País do endereço de cobrança. | varchar | Não |
| charge_address_reference | Referência do endereço de cobrança. | varchar | Não |
| charge_address_zipcode | CEP do endereço de cobrança. | varchar | Sim |
| active | Indica se o cliente está ativo ou inativo. 1 para ativo e 0 para inativo | bool | Sim |
| export_date | Data da exportação do cliente | date | Não |
| modified | Campo onde é possível indicar se houve modificações no cliente pelo ERP | int | Não |
| wallets | Conjunto de carteiras vinculadas ao cliente. | conjunto | Não |
| customfields | Conjunto de campos customizaveis vinculados ao cliente. | conjunto | Não |
| concepts | Conjunto de conceitos vinculados ao cliente. | conjunto | Não |
| distributioncenters | Conjunto de centros de distribuição que o cliente pode realizar compras. | conjunto | Não |
Informações do conjunto wallets
| Campo | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| code | Código externo da carteira que será vinculada ao cliente. | varchar | Sim |
| sellers | Conjunto de vendedores a serem vinculados a carteira sendo informada. | conjunto | Não |
Informações do conjunto sellers
| Campo | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| code | Código externo do vendedor a ser vinculado a carteira. | varchar | Sim |
Informações do conjunto customfields
| Campo | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| identification | Código externo do campo customizável na loja. | varchar | Sim |
| label | Label do campo para exibição. | varchar | Sim |
| value | Valor do campo. | varchar | Sim |
Informações do conjunto concepts
| Campo | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| code | Código externo do conceito. | varchar | Sim |
Informações do conjunto distributioncenters
| Campo | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| code | Código externo do centro de distribuição. | varchar | Sim |
| name | Nome do centro de distribuição. | varchar | Sim |
Informações do conjunto productlines (Bandeiras)
Importante: Essa funcionalidade só pode ser utilizada via ativação do modulo necessário
| Campo | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| code | Código externo da linha de produto (Bandeira) permitida. | varchar | Sim |
Requisição
Nenhum
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request INFO '/'Response Response Example
{}Modificado em 2025-06-23 20:17:41