Endpoints destinados à configuração e gerenciamento das restrições de produtos por cliente.
Início > Restrição de produtos
Versão: 2.0
Restrição de produtos
GET Restrição de produtos
Endpoint para consulta das restrições de produtos.
Endpoint GET
URL:
Parâmetros da requisição
Informe os parâmetros abaixo para realizar a consulta de clientes.
ean_ou_dun: EAN ou DUN do produto a ser consultado.
-
Aceita um ou mais produtos.
-
Parâmetro obrigatório quando o filtro cnpj_clientes não for informado.
cnpj_clientes: CNPJ do cliente a ser consultado.
-
Aceita um ou mais clientes.
-
Parâmetro obrigatório quando o filtro ean_ou_dun não for informado.
Exemplo
curl --location 'https://yandeh-seller-integration.yandeh.com.br/restricao-produtos?ean_ou_dun=17896058000403&cnpj_clientes=04039770000107' \
--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:
Consulta por cnpj_clientes:
{
"busca-cnpj": [
{
"cnpj": "04039770000107",
"produtos": [
{
"id": 195560,
"nome": "PIRULITO MORANGO OU CEREJA 10 G",
"ean_ou_dun": "7798040460035",
"pallet_multiplo_dun": 0,
"status": "bloqueado",
"marca": {
"id": 8818,
"nome": "RING POP"
},
"industria": {
"id": 2577,
"nome": "BENEVIA"
}
},
{
"id": 195554,
"nome": "PIRULITO SABORES SORTIDOS 10G ",
"ean_ou_dun": "7798040469600",
"pallet_multiplo_dun": 0,
"status": "bloqueado",
"marca": {
"id": 8818,
"nome": "RING POP"
},
"industria": {
"id": 2577,
"nome": "BENEVIA"
}
}
]
}
],
"busca-ean": []
}
Consulta por ean_ou_dun:
{
"busca-cnpj": [],
"busca-ean": [
{
"eans": "17896058000403",
"pallet_multiplo_dun": 0,
"clientes": [
{
"nome": "YANDEH S.A.",
"cnpj": "04039770000107",
"status": "indisponivel"
}
]
}
]
}
Consulta por ean_ou_dun e cnpj_clientes:
{
"busca-cnpj": [
{
"cnpj": "04039770000107",
"produtos": [
{
"id": 195329,
"nome": "BISCOITO SALGADO TRIUNFO ",
"ean_ou_dun": "17896058000403",
"pallet_multiplo_dun": 0,
"status": "indisponivel",
"marca": {
"id": 420,
"nome": "TRIUNFO"
},
"industria": {
"id": 8061,
"nome": "BAGLEY"
}
}
]
}
],
"busca-ean": [
{
"eans": "17896058250003",
"pallet_multiplo_dun": 0,
"clientes": [
{
"nome": "YANDEH S.A.",
"cnpj": "04039770000107",
"status": "indisponivel"
}
]
}
]
}
PATCH Restrição de produtos
Endpoint responsável por criar e atualizar restrições de produtos.
Endpoint PATCH
URL:
Sintaxe da Requisição
-
Tipo de requisição: PATCH.
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
Restrição por EAN ou DUN
{
"clientes":
[
"04039770000107"
],
"ean_ou_dun":
[
{
"codigo": "17895879555123",
"status": "bloqueado"
},
{
"codigo": "78985889102545",
"status": "indisponível"
},
{
"codigo": "78985889102015",
"status": "remover"
}
]
}
Restrição por Marca
{
"clientes":
[
"04039770000107"
],
"marca":
[
{
"codigo": "1188",
"status": "bloqueado"
},
{
"codigo": "7467",
"status": "indisponível"
}
]
}
Restrição por Indústria
{
"clientes":
[
"04039770000107"
],
"industria":
[
{
"codigo": "2067",
"status": "bloqueado"
},
{
"codigo": "451",
"status": "bloqueado"
}
]
}
Restrição por EAN ou DUN, marca e indústria
Pode ser enviado no mesmo payload restrição por ean_ou_dun, marca e indústria.
Segue abaixo exemplo:
{
"clientes": [
"04039770000107"
],
"ean_ou_dun":
[
{
"codigo": "78987985678998",
"status": "bloqueado"
}
],
"marca":
[
{
"codigo": 1188,
"status": "bloqueado"
}
],
"industria":
[
{
"codigo": 569,
"status": "bloqueado"
},
{
"codigo": 7467,
"status": "indisponivel"
}
]
}
Exemplo
curl --location --request PATCH 'https://yandeh-seller-integration.yandeh.com.br/restricao-produtos' \
--header 'Authorization: Bearer ...' \
--header 'Content-Type: application/json' \
--data '{
"clientes": [
"04039770000107"
],
"ean_ou_dun": [
{
"codigo": "7622210500038",
"status": "bloqueado"
},
{
"codigo": "7702094190000",
"status": "indisponivel"
}
]
}'
Elementos da Requisição
clientes : CNPJs dos clientes a serem restringidos.
-
Aceita um ou mais clientes.
-
Campo obrigatório.
Tipo: String
ean_ou_dun: Restrições aplicadas no nível de EAN ou DUN.
código: Código de identificação do produto. Pode assumir o formato:
-
EAN: utilizado para identificação de unidades individuais de produtos no varejo.
-
DUN: utilizado para identificação de unidades logísticas, como caixas ou pallets.
-
Campo obrigatório.
Tipo: String
status: Status do produto.
Status permitidos:
-
"indisponível " - O produto será exibido na plataforma, mas ficará indisponível para compra.
-
"bloqueado" - O produto não será exibido na plataforma.
-
"remover" - O produto será excluído da lista de restrições para os clientes selecionados.
-
Campo obrigatório.
Tipo: String.
marca: Restrições aplicadas no nível da marca.
código: Identificador interno da Yandeh para a marca do produto.
-
Campo obrigatório.
Tipo: String
status: Status do produto.
Status permitidos:
-
"indisponível " - Os produtos da marca informada serão exibidos na plataforma, porém não estarão disponíveis para compra.
-
"bloqueado" - Os produtos da marca informada não serão exibidos na plataforma.
-
"remover" -Os produtos da marca informada serão excluídos da lista de restrições para os clientes selecionados.
-
Campo obrigatório.
Tipo: String.
industria: Restrições aplicadas no nível de indústria.
código: Identificador interno da Yandeh para a indústria do produto.
-
Campo obrigatório.
Tipo: String
status: Status do produto.
Status permitidos:
-
"indisponível " - Os produtos da indústria informada serão exibidos na plataforma, porém não estarão disponíveis para compra.
-
"bloqueado" - Os produtos da indústria informada não serão exibidos na plataforma.
-
"remover" -Os produtos da indústria informada serão excluídos da lista de restrições para os clientes selecionados.
-
Campo obrigatório.
Tipo: String.
Sintaxe da resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados
com status code 200. Exemplo de retorno:
{
"detail": {
"success": true,
"message": "success"
},
"data": {
"clientes": [
"04039770000107"
],
"ean_ou_dun": [
{
"codigo": "7622210565000",
"status": "bloqueado",
"status_operacao": "Processado com sucesso"
},
{
"codigo": "7702094190000",
"status": "indisponivel",
"status_operacao": "Processado com sucesso"
}
],
"industria": [],
"marca": [],
"clientes_nao_encontrados": []
}
}
Respostas para erros
400 Bad Request - Nenhum cliente válido foi identificado na requisição.
{
"detail": {
"success": false,
"message": "Nenhum cliente válido encontrado"
}
}
{
"detail": {
"success": false,
"message": "Falha ao adicionar/atualizar restrição de produtos"
},
"data": {
"clientes": [
"04039770000107"
],
"ean_ou_dun": [
{
"codigo": "7622210565900",
"status": "bloqueado",
"status_operacao": "Não encontrado"
}
],
"industria": [],
"marca": [],
"clientes_nao_encontrados": []
}
}
400 Bad Request - Nenhum produto válido foi identificado na requisição.
{
"detail": {
"success": false,
"message": "Campo 'codigo' é obrigatório para cada indústria e deve ser um número"
}
}
400 Bad Request - Campo código no formato inválido.
207 Multi-Status - Um ou mais clientes são inválidos.
{
"detail": {
"success": true,
"message": "Sucesso parcial ao adicionar/atualizar restrição de produtos"
},
"data": {
"clientes": [
"04039770000100",
"04039770000107"
],
"ean_ou_dun": [
{
"codigo": "7622210565000",
"status": "bloqueado",
"status_operacao": "Nenhum atualização processada"
},
{
"codigo": "7702094190000",
"status": "indisponivel",
"status_operacao": "Nenhum atualização processada"
}
],
"industria": [],
"marca": [],
"clientes_nao_encontrados": [
"04039770000100"
]
}
}
207 Multi-Status - Um ou mais produtos são inválidos.
{
"detail": {
"success": true,
"message": "success"
},
"data": {
"clientes": [
"04039770000107"
],
"ean_ou_dun": [
{
"codigo": "7622210565000",
"status": "bloqueado",
"status_operacao": "Não encontrado"
}
],
"industria": [],
"marca": [],
"clientes_nao_encontrados": []
}
}
DELETE Restrição de produtos
Endpoint responsável por remover todas as restrições de produtos associadas ao cliente.
Endpoint DELETE
URL:
Sintaxe da Requisição
-
Tipo de requisição: DELETE.
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
{
"cnpj_clientes":
[
"04039770000107","04039770000100"
]
}
Exemplo
curl --location --request DELETE 'https://yandeh-seller-integration.yandeh.com.br/restricao-produtos' \
--header 'Authorization: Bearer ...' \
--header 'Content-Type: application/json' \
--data '
{
"cnpj_clientes":
[
"04039770000107","04039770000100"
]
}
'
Elementos da Requisição
cnpj_clientes : CNPJ do cliente para o qual a restrição deve ser removida.
-
Aceita um ou mais clientes.
-
Campo obrigatório.
Tipo: String
.
Sintaxe da resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados
com status code 200. Exemplo de retorno:
{
"detail": {
"success": true,
"message": "Deleção de restrições de produtos realizada com sucesso"
},
"data": {}
}
Respostas para erros
400 Bad Request - Nenhum cliente válido foi identificado na requisição.
{
"detail": {
"success": false,
"message": "Falha ao deletar restrição de produtos"
},
"data": {
"success": false,
"message": "Nenhum dos clientes informados possuem vinculo com o fornecedor"
}
}
{
"detail": {
"success": true,
"message": "Sucesso parcial ao deletar restrição de produtos"
},
"data": {
"success": true,
"message": "Informações parcialmente deletadas, outras apresentaram erro",
"erros": [
{
"cnpj": "04039770000100",
"message": "O cliente não possui vinculo com o fornecedor"
}
]
}
}
207 Multi-Status - Um ou mais clientes são inválidos.