top of page

Endpoints que permitem a configuração de preços personalizados para diferentes grupos de clientes

Início > Grupo de preço

Versão: 2.0

Grupo de preço

GET Grupo de preço

Endpoint para consultar os grupos de preços

Endpoint GET

URL:

Parâmetros da requisição

Informe os parâmetros abaixo para realizar a consulta dos grupos:

​

quantidade_pagina: Quantidade de grupos a serem exibidos por página. 

  • Parâmetro não obrigatório.

  • Quantidade máxima de 500 registros por página

pagina: Página a ser exibida.

  • Parâmetro não obrigatório

  • Página inicial 0

​

​

​

Exemplo:

curl --location 'https://yandeh-seller-integration.yandeh.com.br/grupo-preco?pagina=1&por_pagina=3' \
--header 'Authorization: Bearer ...'

Sintaxe da Resposta

Se os parâmetros forem informados corretamente, o endpoint retornará os dados  com status code 200.
Exemplo de retorno:

{
    "grupos": [
        {
            "id": "27708",
            "nome": "Grupo 01",
            "codigo_no_fornecedor": "Padrão 01",
            "produtos":[
          {
                    "ean_ou_dun": "17000331013055",
                    "pallet_multiplo_dun": 0,
                    "preco_embalagem": 1216.83,
                    "preco_minimo_embalagem": 1095.147,
                    "preco_maximo_embalagem": 1338.513,
                    "preco_base": null,

                    "isencao_encargo": true,
                    "impostos": {
                        "imposto": 0,
                        "icms": 0,
                        "ipi": 0,
                        "st": 0,
                        "icmsfcp": 42,
                        "stfcp": 0,
                        "pis": 0,
                        "cofins": 0
                    },
                    "alcada": 0
               
                }
           ],
            "clientes": 
          [
                "01000864000001",
                "01000864000002",
                "02400581000100",
                "02500440000004"
          ]  
   }
    ],
    "total": 5,
    "restante": 4
}

Elementos da Resposta

id: Identificador (ID) do grupo de preço.
nome: Nome do grupo de preço.
codigo_no_fornecedor: Código do grupo de preço no fornecedor.
Produtos: Lista dos produtos participantes do grupo de preços: 
ean_ou_dun: Ean ou Dun do produto
pallet_multiplo_dun: Múltiplo de venda para comercialização da embalagem.
preco_embalagem:  Preço padrão do produto.
preco_minimo_embalagem: Preço mínimo de venda do produto.
preco_maximo_embalagem: Preço máximo de venda do produto.
preco_base: Preço base do produto.

isencao_encargo: Campo utilizado para indicar se o produto possui isenção de encargos.
impostos: Impostos referentes ao produto.
clientes: Lista de clientes participantes do grupo de preço.

POST Grupo de preço

Endpoint para cadastrar novos grupos de preços.

Endpoint POST

URL:

Sintaxe da Requisição

  1. Tipo de requisição: POST.

  2. Cabeçalho (Headers):

    • Content-Type: application/json

    • Authorization: Bearer <token>

  3. Corpo da requisição:

Envio do JSON como exemplo abaixo:

  {
      "nome": "Novo nome",
      "status": "ativo",
      "embalagens": [
        {
          "ean_ou_dun": "ean1",
          "pallet_multiplo_dun": 10,
          "preco_embalagem": 10.88,
          "preco_minimo_embalagem": 10.88,
          "preco_maximo_embalagem": 10.88,
          "preco_base": 10.88,

          "isencao_encargo": true,
          "desconto": 1,
          "imposto": 1.4,
          "icms": 0.2,
          "ipi": 0.2,
          "st": 0.2,
          "icmsfcp": 0.2,
          "stfcp": 0.2,
          "pis": 0.2,
          "cofins": 0.2
        }
      ],
      "clientes": [
        "12158985000100",       

       "58158985000100"
      ],
      "codigo_no_fornecedor": "cod123"
    }

Elementos da requisição

nome:Nome do grupo de preço.

  • Campo obrigatório

Tipo: String.

status: Status do grupo de preço.

  • Informar "ativo" ou "inativo"

  • Campo obrigatório

Tipo: String.

ean_ou_dun :Código do EAN ou DUN.

  • Campo obrigatório.

  • Tipo: String.

pallet_multiplo_dun: Múltiplo de venda para comercialização da embalagem.

  • Para DUNs que não serão comercializados em múltiplos, informe o valor 0. 

  • Da mesma forma, para EANs vendidos de forma unitária (sem múltiplo), também deve ser informado o valor 0.

  • Campo obrigatório.

Tipo: Integer

preco_embalagem:  Preço padrão do produto.,

  • Campo obrigatório.

Tipo: Float.

preco_minimo_embalagem Preço mínimo de venda do produto.

  • Campo destinado para fornecedores que utilizam flutuação de preço. Informar o mesmo valor do preco_embalagem caso não utilize flutuação.

  • Campo obrigatório

Tipo: Float.

preco_maximo_embalagem: Preço máximo de venda do produto.

  • Campo destinado para fornecedores que utilizam flutuação de preço.

  • Campo não obrigatório.

Tipo: Float.

  • Os valores informados no grupo de preço sobrescrevem o preço padrão(cadastrados no endpoint de produtos) para os clientes do grupo.

preco_base: Preço base da embalagem.

  • Campo não obrigatório.

Tipo: Float.

isencao_encargo:Campo utilizado para indicar se o produto possui isenção de encargos. Valores possíveis: true ou false.

  • Se definido como true, o produto não terá acréscimos no momento do fechamento do pedido.

  • Campo não obrigatório.

Tipo: Boolean.

desconto: Desconto sobre o produto.

  • Campo não obrigatório.

Tipo: Float.

impostos: Valor do impostos sobre o produto.

  • Campo não obrigatório.

Tipo: Float.
clientes: Lista dos CNPJ dos clientes que irão pertencer ao grupo de preços

  • Campo obrigatório

Tipo: String.

codigo_no_fornecedor: Código do grupo de preço no ERP do fornecedor.

  • Campo obrigatório

Tipo: String

Sintaxe da Resposta

Se os parâmetros forem informados corretamente, o endpoint retornará os dados  com status code 200.

Para casos de sucesso na criação do grupo, porém, alguns itens não passaram na validação:

{
      "success": false,
      "message": "Grupo de Preço criado, mas ocorreram erros nas seguintes validações.",
      "errorcode": "CRIADO_PARCIALMENTE",
      "errors": [
        {
          "error_type": "cliente-nao-encontrado",
          "readable_message": "Cliente não encontrado",
          "additional_data": {
            "cnpj": "17896009301107"
          }
        },
        {
          "error_type": "cliente-ja-associado",
          "readable_message": "Cliente já associado a um grupo de preço",
          "additional_data": {
            "id": 4747,
            "cnpj": "45507851000163"
          }
        },
        {
          "ean_ou_dun": "27891150056583",
          "pallet_multiplo_dun": 0,
          "error_type": "embalagem-nao-encontrada",
          "readable_message": "Embalagem não encontrada para o estoque informado."
        }
      ]
    }

Respostas para erros

400 Bad Request

   {
      "detail": {
        "success": false,
        "message": "Já existe um grupo de preço com esse nome para este estoque.",
        "errorcode": "NOME_INVÁLIDO"
      }
    }

500 Internal Server Error

 {
      "detail": {
        "success": false,
        "message": "Erro inesperado ao criar Grupo de Preço",
        "errorcode": "INTERNAL_ERROR"
      }
    }

PATCH Grupo de preço

Endpoint para atualização de grupos de preços.

Endpoint PATCH

URL:

Sintaxe da Requisição

  1. Tipo de requisição: PATCH.

  2. Cabeçalho (Headers):

    • Content-Type: application/json

    • Authorization: Bearer <token>

  3. Corpo da requisição:

Envio do JSON como exemplo abaixo:​

​

  {
      "nome": "Novo nome",
      "status": "ativo",
      "embalagens": [
        {
          "ean_ou_dun": "ean1",
          "pallet_multiplo_dun": 10,
          "preco_embalagem": 10.88,
          "preco_minimo_embalagem": 10.88,
          "preco_maximo_embalagem": 10.88,
          "preco_base": 10.88,

          "isencao_encargo": true,
          "desconto": 1,
          "imposto": 1.4,
          "icms": 0.2,
          "ipi": 0.2,
          "st": 0.2,
          "icmsfcp": 0.2,
          "stfcp": 0.2,
          "pis": 0.2,
          "cofins": 0.2
        }
      ],
      "clientes": [
        "12158985000100",
        "58158985000100"
      ],
      "codigo_no_fornecedor": "cod123"
    }

Elementos da requisição

nome:Nome do grupo de preço.​

Tipo: String.

status: Status do grupo de preço.

  • Informar "ativo" ou "inativo"

Tipo: String.

ean_ou_dun :Código do EAN ou DUN.​

  • Tipo: String.

pallet_multiplo_dun: Múltiplo de venda para comercialização da embalagem.

  • Para DUNs que não serão comercializados em múltiplos, informe o valor 0. 

  • Da mesma forma, para EANs vendidos de forma unitária (sem múltiplo), também deve ser informado o valor 0.

Tipo: Integer

preco_embalagem:  Preço padrão do produto.,​

Tipo: Float.

preco_minimo_embalagem Preço mínimo de venda do produto.

  • Campo destinado para fornecedores que utilizam flutuação de preço. Informar o mesmo valor do preco_embalagem caso não utilize flutuação.

Tipo: Float.

preco_maximo_embalagem: Preço máximo de venda do produto.

  • Campo destinado para fornecedores que utilizam flutuação de preço.

Tipo: Float.

  • Os valores informados no grupo de preço sobrescrevem o preço padrão(cadastrados no endpoint de produtos) para os clientes do grupo.

preco_base: Preço base da embalagem.​

Tipo: Float.

isencao_encargo: Campo utilizado para indicar se o produto possui isenção de encargos. Valores possíveis: true ou false.

  • Se definido como true, o produto não terá acréscimos no momento do fechamento do pedido.

  • Campo não obrigatório.

Tipo: Boolean.

desconto: Desconto sobre o produto.​

Tipo: Float.

impostos: Valor do impostos sobre o produto.​

Tipo: Float.
clientes: Lista dos CNPJ dos clientes que irão pertencer ao grupo de preços​

Tipo: String.

codigo_no_fornecedor: Código do grupo de preço no ERP do fornecedor.

  • Campo obrigatório

Tipo: String

Sintaxe da Resposta

Se os parâmetros forem informados corretamente, o endpoint retornará os dados  com status code 200.

{

    "atualizar": {

        "status": "success"

    },

    "erros": [ ]

}

Para casos de sucesso em algumas alterações e erro em outras, o endpoint retornará  os dados com status code 200 com os erros sinalizados.

{

    "atualizar": {

        "status": "success"

    },

    "erros": [

        {

            "error_type": "cliente-ja-associado",

            "readable_message": "Cliente já associado a um grupo de preço",

            "additional_data": {

                "id": 991,

                "cnpj": "04030070000107"

            }

        }

    ]

}

DELETE Grupo de preço

Endpoint responsável por remover componentes de um grupo de preços ou inativar o próprio grupo.

Endpoint DELETE

URL:

Sintaxe da Requisição

Remover Clientes e produtos:

  1. Tipo de requisição: DELETE.

  2. Cabeçalho (Headers):

    • Content-Type: application/json

    • Authorization: Bearer <token>

  3. Corpo da requisição:

Envio de um JSON contendo os produtos ou clientes a serem removidos, conforme exemplo abaixo:​

  {
      "codigo_no_fornecedor": "12",
      "clientes": [
        "04039770000107"
      ],
      "embalagens": [
        "7898687610079"
      ]
    }

Elementos da requisição

codigo_no_fornecedor: Código do grupo de preço no ERP do fornecedor.

  • Campo obrigatório

Tipo: String
clientes: Lista dos CNPJ dos clientes que serão removidos do  grupo de preços​

Tipo: Array de String.

embalagens: Lista dos eans ou duns que serão removidos do  grupo de preços​

Tipo: Array de String.

Sintaxe da Resposta

Se os parâmetros forem informados corretamente, o endpoint retornará os dados  com status code 200.
Exemplo de retorno:

    {
      "mensagem": "Sucesso",
      "clientesRemovidos": [
        "00017829000105"
      ],
      "embalagensRemovidas": [
        "67896075910499"
      ]
    }

Remover Clientes e produtos:

  1. Tipo de requisição: DELETE.

  2. Cabeçalho (Headers):

    • Content-Type: application/json

    • Authorization: Bearer <token>

  3. Corpo da requisição:

Envio de um JSON contendo o status inativo, conforme exemplo abaixo:​

  {
      "codigo_no_fornecedor": "12",
      "status": "inativo"
    }

Elementos da requisição

codigo_no_fornecedor: Código do grupo de preço no ERP do fornecedor.

  • Campo obrigatório

Tipo: String
status: Status do grupo de preço.

  • Campo obrigatório.

  • Ao enviar o status inativo, o grupo de preço será removido.

Sintaxe da Resposta

Se os parâmetros forem informados corretamente, o endpoint retornará os dados  com status code 200.
Exemplo de retorno:

    {
      "mensagem": "Grupo de preço inativado com sucesso"
    }

bottom of page