GoDeep - Documentação
HomeB2BB2CHUBAplicativoAPIs
HomeB2BB2CHUBAplicativoAPIs
  1. Convênios e Instituições
  • Deep B2B
    • Introdução
    • 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
      • listar os estoques de um produto existente
      • obter o estoque de um produto existente por segmentacao
    • PRODUTOS ATRIBUTOS
      • cadastrar atributo
      • atualizar atributo
      • 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
    • PRODUTOS CATEGORIA
      • cadastrar categoria
      • cadastrar vinculo cliente e categoria
      • atualizar categoria
      • 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
      • listar classes
      • obter classe
    • PRODUTOS RESERVA DE ESTOQUE
      • consultar reservas de estoque
    • IMPOSTOS REGIME TRIBUTÁRIO
      • cadastrar regime tributario
      • atualizar regime tributario
      • 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
    • CARTEIRAS
      • Informações sobre o endpoint
      • cadastrar carteira
      • atualizar carteira
      • obter carteira
      • listar carteiras
    • CLIENTES
      • Informações sobre o endpoint
      • cadastrar cliente
      • atualizar cliente
      • obter cliente
      • listar cliente
    • CLIENTES SEGMENTOS
      • listar segmentos
      • obter segmento
      • cadastrar segmentos
      • atualizar segmentos
    • CLIENTES CONTATOS
      • listar crm contatos
      • cadastrar crm contatos
      • obter crm contatos
      • atualizar crm contatos
    • 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
    • CHECAGEM DE EXISTÊNCIA
      • CRM
      • not existing data entities
    • ARQUIVOS
      • cadastrar arquivo
    • DESCONTO PROGRESSIVO
      • listar
      • obter
      • atualizar
      • cadastrar
    • 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
    • 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
  • Deep B2C e HUB
    • Produtos
      • Informações sobre o endpoint de produtos
      • Cadastrar Produto (Normal)
      • Atualizar Produto
      • Atualizar Estoque Multi-CD
      • Atualizar Estoque Normal
      • Atualizar Lista de Preço
      • Atualizar Preço
      • Listar Produto
      • Obter Produto
    • Produtos (Grade ou Variação)
      • Informações sobre o endpoint de produtos com Grade ou Variação
      • Cadastrar Tipos de Grade
      • Cadastrar Produto (Grade)
      • Cadastrar Produto (Modelo e Variação)
      • Listar Tipos de Grade
    • Categorias de Produtos
      • Informações sobre o endpoint de categorias
      • Cadastrar Categorias
      • Atualizar Categorias
      • Listar Categorias
      • Obter Categorias
    • Atributos Personalizados de produtos
      • Informações sobre o endpoint de atributos
      • Cadastrar Atributos
      • Atualizar Atributo
    • Pedidos
      • Informações sobre o endpoint de pedidos
      • Obter Pedido
      • Listar
      • Atualizar Status Pedido
      • Adicionar XML Danfe
    • Consultar Dados Produtos (Loja)
      • Informações sobre o endpoint de consulta de produtos na loja
      • Consulta Produtos Geral
      • Consulta Produtos por Código
    • Convênios e Instituições
      • Informações sobre o endpoint de convênios
        INFO
      • Cadastrar
        POST
      • Atualizar
        PUT
      • Obter
        GET
      • Listar
        GET
    • Etiquetas de Pedidos Gateway Frete
      • Informações sobre o endpoint de etiquetas de pedidos
      • Obter Etiqueta Loja
    • Etiquetas de Pedidos Marketplace
      • Informações sobre o endpoint de etiquetas de pedidos
      • Obter Etiqueta Marketplace
  1. Convênios e Instituições

Cadastrar

POST
/agreements
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/agreements' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": [
        {
            "code": "1",
            "name": "Convênio 1",
            "token": "1",
            "description": "a",
            "logo": "https://logo_convenio.png",
            "phone": "5199999999",
            "automatic_freight": "1",
            "automatic_freight_option": "rapido",
            "active": "1",
            "payment": {
                "discount_percent": "1",
                "discount_all_items_percent": "2",
                "comission_percent": "3",
                "min_installment": "4"
            },
            "delivery_method": {
                "enable_institution_delivery": "1",
                "enable_exclusive_institution_delivery": "1",
                "shipping_description": "teste",
                "shipping_value": "10",
                "delivery_time": "5",
                "free_shipping_minimum_value": "0.0",
                "freight_code": "123",
                "zipcode": "93220250",
                "street": "logradouro",
                "number": "123",
                "complement": "complemento",
                "neighborhood": "bairro",
                "city": "cidade",
                "state": "estado",
                "country": "país"                
            },
            "categories": [
                {
                    "code": "categoria_1",
                    "parent_code": "",
                    "name": "categoria 1",
                    "token": "",
                    "start_date": "",
                    "end_date": "",
                    "products": [
                        {
                            "product_code": "32",
                            "quantity": "1",
                            "discount_percent": "5.00",
                            "product_value": "120.00"
                        },
                        {
                            "product_code": "33",
                            "quantity": "2",
                            "discount_percent": "10.00",
                            "product_value": 0
                        },
                        {
                            "product_code": "36",
                            "quantity": "3",
                            "discount_percent": "15.00",
                            "product_value": 0
                        }
                    ]
                },
                {
                    "code": "categoria_1_filho_1",
                    "parent_code": "categoria_1",
                    "name": "categoria 1 filho 1",
                    "token": "",
                    "start_date": "",
                    "end_date": "",
                    "products": [
                        {
                            "product_code": "41",
                            "quantity": "4",
                            "discount_percent": "5.00",
                            "product_value": 0
                        },
                        {
                            "product_code": "51",
                            "quantity": "5",
                            "discount_percent": "10.00",
                            "product_value": "120.00"
                        },
                        {
                            "product_code": "44",
                            "quantity": "6",
                            "discount_percent": "15.00",
                            "product_value": 0
                        }
                    ]
                },
                {
                    "code": "categoria_1_filho_2",
                    "parent_code": "categoria_1",
                    "name": "categoria 1 filho 2",
                    "token": "",
                    "start_date": "",
                    "end_date": "",
                    "products": [
                        {
                            "product_code": "41",
                            "quantity": "4",
                            "discount_percent": "5.00",
                            "product_value": 0
                        },
                        {
                            "product_code": "51",
                            "quantity": "5",
                            "discount_percent": "10.00",
                            "product_value": 0
                        },
                        {
                            "product_code": "44",
                            "quantity": "6",
                            "discount_percent": "15.00",
                            "product_value": 0
                        }
                    ]
                },
                {
                    "code": "categoria_1_filho_3",
                    "parent_code": "categoria_1",
                    "name": "categoria 1 filho 3",
                    "token": "",
                    "start_date": "",
                    "end_date": "",
                    "products": [
                        {
                            "product_code": "13",
                            "quantity": "2",
                            "discount_percent": "5.00",
                            "product_value": 0
                        }
                    ]
                },
                {
                    "code": "categoria_1_neto_1",
                    "parent_code": "categoria_1_filho_1",
                    "name": "categoria 1 neto 1",
                    "token": "",
                    "start_date": "",
                    "end_date": "",
                    "products": [
                        {
                            "product_code": "23",
                            "quantity": "11",
                            "discount_percent": "25.00",
                            "product_value": 0
                        },
                        {
                            "product_code": "24",
                            "quantity": "12",
                            "discount_percent": "27.00",
                            "product_value": 0
                        }
                    ]
                }
            ]
        }
    ]
}'
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 Bodyapplication/json

Examples

Respostas

🟢200Success
application/json
Body

Modificado em 2025-07-07 14:44:01
Página anterior
Informações sobre o endpoint de convênios
Próxima página
Atualizar
Built with