Endpoints destinados ao registro de novos produtos na Yandeh.
Início > Cadastro de produtos
Versão: 2.0
Cadastro de produtos
Endpoint responsável por listar os produtos cadastrados a partir da solicitação do fornecedor.
Endpoint GET
URL
Parâmetros da requisição
Informe os parâmetros abaixo para realizar a consulta dos usuários.
sku: EAN ou DUN do produto a ser consultado
-
Parâmetro obrigatório.
-
Exemplo: 78985898985236
Exemplo
curl --location 'https://yandeh-seller-integration.yandeh.com.br/cadastro-produto?sku=78985898985236' \
--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:
{
"data": {
"marca": "Marca do produto",
"unidade_medida": "CX",
"fabricante": "Fabricante do produto",
"sku": "000000000002",
"quantidade_embalagem": 12,
"embalagem_produto": "CAIXA",
"descricao": "Produto...",
"gtins": [
{
"conteudo_embalagem_gtin": 1,
"tipo_embalagem_gtin": "UN",
"gtin": "000000000001"
}
]
}
}
Elementos da Resposta
marca: Marca do produto.
Tipo: String
unidade_medida: Unidade de medida do produto.
Tipo: String
fabricante: Indústria responsável pela fabricação do produto.
Tipo: String.
sku: Código de identificação do produto (EAN ou DUN).
Tipo: String.
quantidade_embalagem: Quantidade de itens contidos na embalagem do produto.
Tipo: Integer.
embalagem do produto: Descrição da embalagem do produto.
Tipo: String.
descricao: Descrição detalhada do produto.
Tipo: String.
gtins: Lista de códigos GTIN associados ao item principal.
conteudo_embalagem_gtin: Quantidade de itens na embalagem vinculada ao GTIN.
Tipo: Integer.
tipo_embalagem_gtin: Unidade de medida da embalagem vinculada ao GTIN.
Tipo: String.
gtin: Código GTIN do produto (EAN ou DUN).
Tipo: String.
Respostas para erros
400 Bad Request
Não foi informado o parâmetro de pesquisa sku
{
"message": "SKU deve ser informado"
}
{
"mensagem": [
"Produto Seller com ID Seller: 503 e SKU: 78985869857895 não encontrado."
]
}
400 Bad Request
Foi informado um sku inválido ou não cadastrado
GET Cadastro de produtos
PUT Cadastro de produtos
Endpoint responsável pelo cadastro de novos produtos na Yandeh
Endpoint PUT
URL
Sintaxe da Requisição
-
Tipo de requisição: PUT.
-
Cabeçalho (Headers):
-
Content-Type: multipart/form-data
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do form-data com os conteúdos abaixo:
-
"produto": "JSON string"
-
Json de exemplo abaixo
-
-
"imagem": "PNG, JPEG ou JPG"
-
tipo File
-
-
{
"gtins": [
{
"conteudo_embalagem_gtin": 12,
"tipo_embalagem_gtin": "CAIXA",
"gtin": "00000000001"
}
],
"marca": "Marca do produto",
"unidade_medida": "CX",
"fabricante": "Fabricante do produto",
"sku": "00000000001",
"quantidade_embalagem": 12,
"embalagem_produto": "CAIXA",
"descricao": "Produto..."
}
produto
Conteúdo do JSON da requisição com os dados do produto.
Tipo: JSON.
Imagem
Imagem nos formatos PNG, JPEG ou JPG (Max: 1024 kb, Min: 10 kb).
Tipo: File.
Os dados do produto devem ser enviados da seguinte forma:
Elementos da Requisição
gtins *
Informações associadas ao GTIN do produto. Neste campo pode ser adicionados mais de um objeto.
Tipo: Array de JSON.
conteudo_embalagem_gtin *
Quantidade da embalagem do GTIN.
Tipo: Integer.
tipo_embalagem_gtin *
Embalagem do GTIN.
Tipo: String.
gtin *
Código GTIN do produto.
Tipo: String.
marca *
Marca do produto.
Tipo: String.
unidade_medida *
Acrônimo da unidade de medida.
Tipo: String.
fabricante *
Fabricante do produto.
TIpo: String.
sku *
Código do EAN do produto, ou DUN caso o produto seja vendido em caixa.
Tipo: String.
quantidade_embalagem *
Quantidade da embalagem.
Tipo: String.
embalagem_produto *
Embalagem do produto.
TIpo: String.
descricao *
Descrição do Produto.
Tipo: String.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
data
Dados do retorno.
Tipo: JSON.
marca
Marca do produto.
Tipo: String.
unidade_medida
Acrônimo da unidade de medida.
Tipo: String.
fabricante
Fabricante do produto.
TIpo: String.
sku
Código do EAN do produto, ou DUN caso o produto seja vendido em caixa.
Tipo: String.
quantidade_embalagem
Quantidade da embalagem.
Tipo: String.
embalagem_produto
Embalagem do produto.
TIpo: String.
descricao
Descrição do Produto.
Tipo: String.
gtins
Informações associadas ao GTIN do produto. Neste campo pode ser adicionados mais de um objeto.
Tipo: Array de JSON.
conteudo_embalagem_gtin
Quantidade da embalagem do GTIN.
Tipo: Integer.
tipo_embalagem_gtin
Embalagem do GTIN.
Tipo: String.
gtin
Código GTIN do produto.
Tipo: String.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
400 Bad Requestt
404 Not Found