Endpoints responsáveis pela inclusão e atualização dos produtos do fornecedor na plataforma Yandeh.
Início > Produtos
Versão: 2.0
Produtos
GET Produtos
Endpoint para consulta dos produtos do fornecedor na plataforma.
Endpoint GET
URL:
Parâmetros da requisição
Exemplo
curl --location 'https://yandeh-seller-integration.yandeh.com.br/v2/produtos?pagina=1&por_pagina=200&ean_ou_dun=17506339326038' \
--header 'Authorization: Bearer ...'
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados dos produtos com status code 200.
Exemplo de retorno:
[
{
"pallet_multiplo_dun": 0,
"ean_ou_dun": "27000635640052",
"data_vencimento": "2026-01-16",
"nome": "AÇAFRÃO QUERO DA TERRA",
"quantidade": 0,
"valida_estoque": "S",
"codigo_no_fornecedor": "21108",
"preco_minimo": 580.50,
"preco_normal": 580.50,
"preco_maximo": 580.50,
"isencao_encargos": true,
"id_marca": 197,
"nome_marca": "QUERO",
"id_industria": 153,
"nome_industria": "KRAFT HEINZ"
},
{
"pallet_multiplo_dun": 0,
"ean_ou_dun": "20070000144501",
"data_vencimento": "2029-12-30",
"nome": "ARROZ CAMIL TIPO 1",
"quantidade": 1035,
"valida_estoque": "S",
"codigo_no_fornecedor": "83540",
"preco_minimo": 222.615,
"preco_normal": 247.35,
"preco_maximo": 272.085,
"isencao_encargos": false,
"id_marca": 158,
"nome_marca": "CAMIL",
"id_industria": 200,
"nome_industria": "CAMIL ALIMENTOS"
}
]
Elementos da Resposta
pallet_multiplo_dun: Múltiplo de venda para comercialização da embalagem.
Tipo: Integer
ean_ou_dun: Código ean ou dun do produto
Tipo: String
data_vencimento :Data de vencimento do produto
Tipo: String no formato AAAA-MM-DD
quantidade: Quantidade do produto no estoque
Tipo: Integer
valida_estoque: Validação se terá controle de estoque do produto.
Tipo: String.
codigo_no_fornecedor: Código interno do produto no fornecedor.
Tipo: String.
preco_minimo: Preço mínimo de venda do produto.
Tipo: Float.
preco_embalagem: Preço padrão do produto.
Tipo: Float.
preco_maximo: Preço máximo de venda do produto
Tipo: Float.
isencao_encargo: Campo utilizado para indicar se o produto possui isenção de encargos.
Tipo: Boolean.
id_marca: Identificador (ID) da marca do produto.
Tipo: Integer.
nome_marca: Descrição da marca do produto.
Tipo: String.
id_industria: Identificador (ID) da indústria responsável pelo produto.
Tipo: Integer.
nome_industria: Nome da indústria responsável pelo produto.
Tipo: String.
PATCH Produtos
Endpoint para incluir e atualizar o produto no estoque.
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:
{
"produtos": [
{
"ean_ou_dun": "7896787654564",
"pallet_multiplo_dun": 0,
"codigo_no_fornecedor": 1010,
"valida_estoque": "S ou N",
"status": "ativo ou inativo",
"preco_maximo_embalagem": 100,
"preco_embalagem": 100,
"preco_minimo_embalagem": 100,
"quantidade": 30,
"data_vencimento": "2026-12-20",
"isencao_encargo": true
}
]
}
Exemplo:
curl --location --request PATCH 'https://yandeh-seller-integration.yandeh.com.br/v2/produtos' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data '{
"produtos": [
{
"preco_maximo_embalagem": 84,
"preco_minimo_embalagem": 84,
"codigo_no_fornecedor": "0008636",
"ean_ou_dun": "7896787654123",
"valida_estoque": "N",
"pallet_multiplo_dun": 20,
"quantidade": 0,
"status": "ativo",
"preco_embalagem": 84,
"isencao_encargo": true
},
{
"preco_maximo_embalagem": 130.0,
"preco_minimo_embalagem": 130.0,
"codigo_no_fornecedor": "0008638",
"ean_ou_dun": "7896787654564",
"valida_estoque": "S",
"pallet_multiplo_dun": 20,
"quantidade": 100,
"status": "ativo",
"preco_embalagem": 130.0,
"data_vencimento":"2026-05-30",
"isencao_encargo": true
}
]
}'
Elementos da Requisição
ean_ou_dun : Código ean ou dun do produto
-
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
codigo_no_fornecedor: Código interno do produto no Fornecedor.
-
Campo obrigatório na inclusão do novo produto.
Tipo: String.
valida_estoque: Validação se terá controle de estoque do produto.
-
Informar "S" ou "N"
-
Caso esteja preenchido com "N" o produto estará disponível para venda mesmo com a quantidade 0 no estoque.
-
Campo obrigatório na inclusão do novo produto.
Tipo: String.
status: Status do produto.
-
Informar "ativo" ou "inativo"
-
Obrigatório na inclusão ou remoção do produto no estoque.
Tipo: String.
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.
preco_embalagem: Preço padrão do produto.
-
Campo obrigatório quando for inclusão ou atualização de preço do produto no estoque.
Tipo: Float.
preco_minimo_embalagem: Preço mínimo de venda do produto.
-
Campo destinado para fornecedores que utilizam flutuação de preço.
-
Campo obrigatório quando for inclusão ou atualização de preço do produto no estoque. Informar o mesmo valor do preco_embalagem caso não utilize flutuação.
Tipo: Float.
quantidade: Quantidade do produto no estoque.
-
Campo obrigatório na inclusão ou atualização de preço do produto no estoque
Tipo: Integer.
data_vencimento: Data de vencimento do produto.
-
Campo não obrigatório.
Tipo: String de data no formato: AAAA-MM-DD ou "" (string vazia) para limpar os dados de data.
isencao_encargo: Campo utilizado para indicar se o produto possui isenção de encargos. Valores possíveis: true ou false.
-
Campo não obrigatório.
-
Se definido como true, o produto não terá acréscimos no momento do fechamento do pedido.
Tipo: Boolean.
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará sucesso com status code 200.
Exemplo de retorno:
{
"sucesso": {
"atualizado-preco": [
{
"ean_ou_dun": "7896787654564",
"pallet_multiplo_dun": 20,
"valida_estoque": "S",
"status": "ativo",
"preco_embalagem": 130.0,
"quantidade": 100,
"preco_minimo_embalagem": 130.0,
"preco_maximo_embalagem": 130.0
}
],
"atualizado-quantidade": [
{
"ean_ou_dun": "7896787654564",
"pallet_multiplo_dun": 30,
"valida_estoque": "N",
"status": "ativo",
"preco_embalagem": 130.0,
"quantidade": 100,
"preco_minimo_embalagem": 130.0,
"preco_maximo_embalagem": 130.0
}
]
},
"invalidos": []
}
Os campos "sucesso" e "inválidos" armazenam, respectivamente, os retornos de alterações realizadas com êxito e aquelas que falharam.
Exemplos de retorno de sucesso:
Adição de produto ao estoque do fornecedor.
{
"sucesso": {
"adicionado-ao-estoque": [
{
"ean_ou_dun": "27702018072211",
"pallet_multiplo_dun": 0,
"data_vencimento": "2024-12-20",
"codigo_no_fornecedor": "2001479",
"valida_estoque": "S",
"isencao_encargo": false
}
]
}
}
Atualização de preço.
Caso seja atualizado algum dos campos:
preco_embalagem, preco_maximo_embalagem e preco_minimo_embalagem
{
"sucesso": {
"atualizado-preco": [
{
"ean_ou_dun": "27891150037452",
"pallet_multiplo_dun": 1,
"data_vencimento": "2024-12-20",
"preco_maximo_embalagem": 100,
"preco_embalagem": 100,
"preco_minimo_embalagem": 100
}
]
}
}
Atualização de quantidade.
Caso o campo quantidade seja atualizado.
{
"sucesso": {
"atualizado-quantidade": [
{
"ean_ou_dun": "27891150037452",
"pallet_multiplo_dun": 1,
"data_vencimento": "2024-12-20",
"codigo_no_fornecedor": "2003266",
"valida_estoque": "S",
"status": "ativo",
"preco_maximo_embalagem": null,
"preco_embalagem": 100,
"preco_minimo_embalagem": null,
"quantidade": 999
}
]
}
}
Remoção de produto do estoque.
Caso o campo status seja alterado para "inativo".
{
"sucesso": {
"removido-do-estoque": [
{
"ean_ou_dun": "17500435115350",
"pallet_multiplo_dun": 0,
"data_vencimento": "2024-12-20",
"codigo_no_fornecedor": "2000022",
"valida_estoque": "S",
"status": "inativo",
"preco_maximo_embalagem": null,
"preco_embalagem": null,
"preco_minimo_embalagem": null,
"quantidade": null
}
]
}
}
Exemplos de retorno para o campo "inválidos":
Ean_ou_dun não cadastrado na Yandeh
{
"invalidos": [
{
"ean_ou_dun": "17500435115821",
"pallet_multiplo_dun": 1,
"status": "Combinação ean_ou_dun + Pallet Multiplo de Dun não encontrada."
}
]
}
Data_vencimento inválida.
{
"invalidos": [
{
"ean_ou_dun": "17500435115821",
"pallet_multiplo_dun": 1,
"status": [
"Data de vencimento deve estar no formato YYYY-MM-DD. "
]
}
]
}
GET Indústrias
Endpoint para consulta das Indústrias responsáveis pelos produtos do fornecedor.
Endpoint GET
URL:
Parâmetros da requisição
Informe os parâmetros abaixo para realizar a consulta do portfólio.
nome: Nome da indústria.
-
Parâmetro não obrigatório.
pagina: Página a ser exibida.
-
Página inicial 1
-
Parâmetro não obrigatório.
por_pagina: Quantidade de registros a serem exibidas por página.
-
Default 100 registros por página.
-
Parâmetro não obrigatório.
Exemplo
curl --location 'https://yandeh-seller-integration.yandeh.com.br/industrias?pagina=1&por_pagina=3&nome=BENEVIA' \
--header 'Authorization: Bearer ...' \
--header 'Content-Type: application/json'
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados das indústrias com status code 200.
Exemplo de retorno:
{
"data": [
{
"iid": 2228,
"nome": "BAGLEY"
},
{
"id": 2239,
"nome": "BENEVIA"
},
{
"id": 2252,
"nome": "BIC"
}
],
"paginacao": {
"pagina_atual": 1,
"itens_por_pagina": 3,
"total_itens": 528
}
}
Elementos da Resposta
data: Lista das indústrias responsáveis pelos produtos do fornecedor.
Tipo: array de objetos JSON
id: Identificador (ID) da indústria.
Tipo: Integer
nome: Nome da indústria.
Tipo: String
paginação: Informações referente a paginação.
Tipo: Array de jsons.
pagina_atual: Número da página atualmente retornada na requisição.
Tipo: Integer.
itens_por_pagina: Quantidade de itens retornados por página na requisição.
Tipo: Integer.
total_itens: Quantidade total de registros disponíveis para a requisição.
Tipo: Integer.
GET Marcas
Endpoint para consulta das marcas dos produtos do fornecedor.
Endpoint GET
URL:
Parâmetros da requisição
Informe os parâmetros abaixo para realizar a consulta do portfólio.
nome: Nome da marca.
-
Parâmetro não obrigatório.
pagina: Página a ser exibida.
-
Página inicial 1
-
Parâmetro não obrigatório.
por_pagina: Quantidade de registros a serem exibidas por página.
-
Default 100 registros por página.
-
Parâmetro não obrigatório.
Exemplo
curl --location 'https://yandeh-seller-integration.yandeh.com.br/marcas?pagina=1&por_pagina=3&nome=BENEVIA' \
--header 'Authorization: Bearer ...' \
--header 'Content-Type: application/json'
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados dos produtos com status code 200.
Exemplo de retorno:
{
"data": [
{
"id": 2228,
"nome": "BAGLEY"
},
{
"id": 2239,
"nome": "BENEVIA"
},
{
"id": 2252,
"nome": "BIC"
}
],
"paginacao": {
"pagina_atual": 1,
"itens_por_pagina": 3,
"total_itens": 528
}
}
Elementos da Resposta
data: Lista das marcas dos produtos do fornecedor.
Tipo: array de objetos JSON
id: Identificador (ID) da marca.
Tipo: Integer
nome: Nome da marca.
Tipo: String
paginação: Informações referente a paginação.
Tipo: Array de jsons.
pagina_atual: Número da página atualmente retornada na requisição.
Tipo: Integer.
itens_por_pagina: Quantidade de itens retornados por página na requisição.
Tipo: Integer.
total_itens: Quantidade total de registros disponíveis para a requisição.
Tipo: Integer.