GoDeep - Documentação
HomeB2BB2CHUBAplicativoAPIs
HomeB2BB2CHUBAplicativoAPIs
  1. CLIENTES
  • GoDeep
    • Quem Somos
    • Meios de pagamento - B2C
  • ERPs
    • Integração Sankhya
    • ERPs integrados com a GoDeep
  • Documentação Funcional
    • Deep B2B
      • Fretes
      • Configurações gerais
      • Promoções
        • Cupons de Desconto
      • Pedidos
        • Cobrança de taxa em cima do valor do pedido
      • Meios de Pagamento
        • Itaú
    • Deep B2C
      • Produtos
        • Marcas
        • Seletor Mix
        • Importador manual de listas de preço
      • Pedidos
        • Pedidos - Status
        • Endpoint Compras por WhatsApp
      • Fretes
        • Fretes
        • Correios
        • Data Frete
        • Dedalog
        • Frenet
        • Melhor Envio
        • TransPaulo
        • Total Express
        • Intelipost
        • Jadlog
        • Jamef
      • Meios de Pagamento
        • Itaú
      • Promoções
        • Cupons de Desconto
      • Institucionais
        • Páginas institucionais
      • Configurações gerais
        • Importação manual de produtos
    • Deep HUB
      • Marketplaces
        • Marketplace F1
        • Amazon
        • Mercado Livre
      • Configurações gerais
        • Erro ao criar produto no Mercado Livre – B2C
    • Deep Sales
      • Aplicativo Deep Sales
  • APIs
    • Deep B2B
      • Produtos
        • Informações sobre o endpoint
        • cadastrar produtos e relacionamentos (completo)
        • cadastrar produto
        • cadastrar produto kit
        • cadastrar produto com garantia extendida
        • atualizar produto
        • atualizar estoque do produto
        • atualizar listas de preço do produto
        • listar produtos
        • listar identificadores dos produtos
        • obter produto
        • listagem simples (codigo produto e dados de estoque)
      • Produtos Relacionados
        • obter produtos relacionados
        • obter produtos similares
        • obter produtos complementares
        • cadastrar produtos similares
        • cadastrar produtos complementares
        • cadastrar produtos relacionados
      • PRODUTOS CONCEITOS
        • cadastrar conceito
        • atualizar conceito
        • listar conceitos
        • obter conceito
      • PRODUTOS PREÇO
        • Informações sobre o endpoint
        • cadastrar preco para um produto existente
        • atualizar preco de um produto existente
        • listar precos de um produto existente
        • obter o preco de um produto existente por segmentacao
        • atualizar precos por lista de preco
        • consultar processos de atualizacao de lista
      • PRODUTOS ESTOQUE
        • cadastrar estoque para um produto existente
        • atualizar estoque de um produto existente
        • deletar o estoque de um produto existente por segmentacao (Não Usar)
        • listar os estoques de um produto existente
        • obter o estoque de um produto existente por segmentacao
      • PRODUTOS ATRIBUTOS
        • cadastrar atributo
        • atualizar atributo
        • deletar atributo (Não Usar)
        • deletar atributo de uma classe existente (Não Usar)
        • listar atributos
        • obter atributo
      • PRODUTOS VALORES DE ATRIBUTOS
        • cadastrar valor de atributo para um produto existente
        • cadastrar multiplos atributos para um produto existente
        • cadastrar multiplos valores para um atributo especifico e um produto existente
        • atualizar valor de atributo de um produto existente
        • deletar o valor do atributo de um produto existente (Não Usar)
      • PRODUTOS CATEGORIA
        • cadastrar categoria
        • cadastrar vinculo cliente e categoria
        • atualizar categoria
        • deletar categoria (Não Usar)
        • listar categorias
        • obter categoria
      • PRODUTOS CLASSE
        • cadastrar classe
        • cadastrar classe com classe pai
        • cadastrar atributo para uma classe existente
        • cadastrar multiplos atributos para uma classe existente
        • atualizar classe
        • deletar classe (Não Usar)
        • listar classes
        • obter classe
      • PRODUTOS RESERVA DE ESTOQUE
        • consultar reservas de estoque
      • IMPOSTOS REGIME TRIBUTÁRIO
        • cadastrar regime tributario
        • atualizar regime tributario
        • deletar regime tributario (Não Usar)
        • listar regime tributario
        • obter regime tributario
      • IMPOSTOS MATRIZ TRIBUTÁRIA
        • Informações sobre o endpoint
        • cadastrar ou atualizar matriz tributaria
        • listar matriz tributaria
        • obter matriz tributaria
      • IMPOSTOS (IPI) MATRIZ TRIBUTÁRIA DE IPI
        • cadastrar matriz tributaria IPI
        • listar matriz tributaria IPI
        • obter matriz tributaria IPI
      • VENDEDORES / REPRESENTANTES
        • Informações sobre o endpoint
        • cadastar vendedores
        • atualizar vendedores
        • listar vendedores
        • obter vendedores
        • remover vendedor (Não Usar)
      • CARTEIRAS
        • Informações sobre o endpoint
        • cadastrar carteira
        • atualizar carteira
        • obter carteira
        • listar carteiras
        • remover carteira (Não Usar)
      • CLIENTES
        • Informações sobre o endpoint
          INFO
        • cadastrar cliente
          POST
        • atualizar cliente
          PUT
        • obter cliente
          GET
        • listar cliente
          GET
        • remover cliente (Não Usar)
          DELETE
      • CLIENTES SEGMENTOS
        • listar segmentos
        • obter segmento
        • cadastrar segmentos
        • atualizar segmentos
      • CLIENTES CONTATOS
        • listar crm contatos
        • cadastrar crm contatos
        • obter crm contatos
        • atualizar crm contatos
        • remover crm contato (Não Usar)
      • PEDIDOS
        • listar pedidos
        • obter pedido
        • atualizar pedido
        • atualizar pedido com cancelamento parcial de itens
      • PEDIDOS NOTAS
        • Informações sobre o endpoint de notas
        • cadastrar notas
        • listar notas
        • obter nota
        • atualizar nota
        • remover nota (Não Usar)
      • CHECAGEM DE EXISTÊNCIA
        • CRM
        • not existing data entities
      • ARQUIVOS
        • cadastrar arquivo
      • DESCONTO PROGRESSIVO
        • listar
        • obter
        • atualizar
        • cadastrar
        • remover (Não Usar)
      • RELATÓRIOS COMISSÕES
        • Informações sobre o endpoint de comissões
        • Listar Comissões
        • Cadastrar
      • CONDIÇÕES DE PAGAMENTO
        • Informações sobre o endpoint de condições de pagamento
        • listar
        • obter
        • cadastrar
        • atualizar
        • remover (Não Usar)
      • PEDIDOS EXTERNOS
        • cadastrar
        • atualizar
        • obter
      • CONSULTA PRODUTOS (LOJA)
        • Informações sobre o endpoint de consulta de produtos na loja
        • Consulta Produtos Geral
        • Consulta Produtos por Código
  1. CLIENTES

cadastrar cliente

POST
http://apidatain-prod.f1ws.com.br/crm
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://apidatain-prod.f1ws.com.br/crm' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": [
        {
            "cgc": "05005501000184",
            "code": "PM05",
            "person_type": "J",
            "tax_regime": "CONTRIBUTOR",
            "name_fancy": "RONSY COMERCIAL DE FERRAGENS LTDA",
            "name_corporate": "RONSY COMERCIAL DE FERRAGENS LTDA",
            "registration_state": "0103557300119",
            "registration_municipal": "",
            "suframa_code": "200405721",
            "suframa_expiration_date": "2019-04-30",
            "phone_number": "683546501068",
            "cell_phone_number": "",
            "email_invoice": "[email protected]",
            "external_segment_code": "009",
            "price_list": "",
            "credit": 0,
            "average_payment_period": "1140",
            "allow_post_payment": 0,
            "default_order_type": null,
            "default_operation_type": "REVE",
            "exclusive_payment_method_condition_installment": null,
            "simples_code": null,
            "block_card_payment": null,
            "moderated": 1,
            "wallets": [
                {
                    "code": "4",
                    "sellers": [
                        {
                            "code": "60"
                        }
                    ]
                },
                {
                    "code": "5",
                    "sellers": [
                        {
                            "code": "60"
                        }
                    ]
                }
            ],
            "customfields": [
                {
                    "identification": "ramo_atividade",
                    "label": "Rade de Atividade",
                    "value": "Teste PostMan"
                }
            ],
            "concepts": [
                {
                    "code": "001"
                },
                {
                    "code": "002"
                }
            ],
            "ordertypes": [
                {
                    "code": "IDENTIFICADOR_TIPO_PEDIDO",
                    "name": "Nome tipo de pedido",
                    "price_list_external_code": "IDENTIFICADOR_LISTA_PRECO",
                    "price_list_name": "Nome lista de preco"
                }
            ],
            "distributioncenters": [
                {
                    "code": "IDENTIFICADOR_CENTRO_DISTRIBUICAO",
                    "name": "Nome do centro de distribuição"
                }
            ],
            "productlines": [
                {
                    "code": "IDENTIFICADOR_BANDEIRA"
                }
            ],
            "created": "2024-04-25",
            "address_ibge_code": "",
            "address_street": "AVENIDA AMAZONAS",
            "address_number": "390",
            "address_complement": "",
            "address_state": "AC",
            "address_city": "EPITACIOLANDIA",
            "address_neighborhood": "LIBERDADE",
            "address_country": "BR",
            "address_reference": "",
            "address_zipcode": "69934000",
            "delivery_address_ibge_code": "",
            "delivery_address_street": "AVENIDA AMAZONAS",
            "delivery_address_number": "390",
            "delivery_address_complement": "",
            "delivery_address_state": "AC",
            "delivery_address_city": "EPITACIOLANDIA",
            "delivery_address_neighborhood": "LIBERDADE",
            "delivery_address_country": "BR",
            "delivery_address_reference": "",
            "delivery_address_zipcode": "69934000",
            "charge_address_ibge_code": "",
            "charge_address_street": "AVENIDA AMAZONAS",
            "charge_address_number": "390",
            "charge_address_complement": "",
            "charge_address_state": "AC",
            "charge_address_city": "EPITACIOLANDIA",
            "charge_address_neighborhood": "LIBERDADE",
            "charge_address_country": "BR",
            "charge_address_reference": "",
            "charge_address_zipcode": "69934000",
            "active": 1
        }
    ]
}'
Response Response Example
{}

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Header
Content-Type
string 
requerido
Exemplo:
application/json
Parâmetros Bodyapplication/json
data
array [object {62}] 
requerido
cgc
string 
opcional
code
string 
opcional
person_type
string 
opcional
tax_regime
string 
opcional
name_fancy
string 
opcional
name_corporate
string 
opcional
registration_state
string 
opcional
registration_municipal
string 
opcional
suframa_code
string 
opcional
suframa_expiration_date
string 
opcional
phone_number
string 
opcional
cell_phone_number
string 
opcional
email_invoice
string 
opcional
external_segment_code
string 
opcional
price_list
string 
opcional
credit
integer 
opcional
average_payment_period
string 
opcional
allow_post_payment
integer 
opcional
default_order_type
null 
opcional
default_operation_type
string 
opcional
exclusive_payment_method_condition_installment
null 
opcional
simples_code
null 
opcional
block_card_payment
null 
opcional
moderated
integer 
opcional
wallets
array [object {2}] 
opcional
customfields
array [object {3}] 
opcional
concepts
array [object {1}] 
opcional
ordertypes
array [object {4}] 
opcional
distributioncenters
array [object {2}] 
opcional
productlines
array [object {1}] 
opcional
created
string 
opcional
address_ibge_code
string 
opcional
address_street
string 
opcional
address_number
string 
opcional
address_complement
string 
opcional
address_state
string 
opcional
address_city
string 
opcional
address_neighborhood
string 
opcional
address_country
string 
opcional
address_reference
string 
opcional
address_zipcode
string 
opcional
delivery_address_ibge_code
string 
opcional
delivery_address_street
string 
opcional
delivery_address_number
string 
opcional
delivery_address_complement
string 
opcional
delivery_address_state
string 
opcional
delivery_address_city
string 
opcional
delivery_address_neighborhood
string 
opcional
delivery_address_country
string 
opcional
delivery_address_reference
string 
opcional
delivery_address_zipcode
string 
opcional
charge_address_ibge_code
string 
opcional
charge_address_street
string 
opcional
charge_address_number
string 
opcional
charge_address_complement
string 
opcional
charge_address_state
string 
opcional
charge_address_city
string 
opcional
charge_address_neighborhood
string 
opcional
charge_address_country
string 
opcional
charge_address_reference
string 
opcional
charge_address_zipcode
string 
opcional
active
integer 
opcional
Examples

Respostas

🟢200Success
application/json
Body
object {0}
Modificado em 2025-06-23 20:17:41
Página anterior
Informações sobre o endpoint
Próxima página
atualizar cliente
Built with