API Vnda
Documentações de API Vnda:
Documentação mais atual:
Outras documentações:
Descontinuada:
Abaixo um exemplo de filtro de data e paginação;
Data:
/api/v2/orders?start=20191010&finish=20191011
Paginação:
As informações são disponibilizadas no header x-pagination caso exista paginação.
Ex:
x-pagination: {"total_pages":337,"total_count":33645,"current_page":1,"prev_page":false,"next_page":true}
Listando a página 2:
/api/v2/orders?page=2
Abaixo um exemplo de autenticação:
No caso de qualquer dúvida sobre integrações ou documentações de API deve ser direcionado o contato para api@vnda.com.br
Perguntas Frequentes
Integração de Produtos
Qual a diferença entre category_tags e tag_list'?
Vnda utiliza tag para agrupamento de produtos com diversos objetivos, como: promoções, listagens, exibições e outros. Neste sentido, quando funções são associadas às categorias essas devem ser tratadas como categorias tipadas, que possuem um 'tipo' associado.
`category_tags` são todas as `tags` que são tipificadas. Já a chamada de `tag_list` retorna todas as tags, com e sem `tipo`. A estrutura das duas chamadas é diferente, sendo que a `category_tags` entrega uma informação estruturada. Enquanto o tratamento da `tag_list` consiste na listagem separada por vírgulas.
Como fazer a gestão de categorias por API?
Para a gestão de tags por API utilizando origem de dados de sistemas terceiros, sugerimos a definição de um `tag_type` para gestão da categoria usada nesse sistema terceiro. Neste caso, será adotado o formato `category_tags`. Sendo que todas as tags do produto irão retornar no `tag_list`.
Quais chamadas de API permitem o controle de imagens de produtos?
/api/v2/products/{id}/images
/api/v2/products/{product_id}/variants/{variant_id}/images para listar as imagens associadas a determinado SKU
Mais detalhes:
Listar as imagens do produto
GET https://demo.vnda.com.br/api/v2/products/:product_id/images
[
{
"updated_at" : "2021-03-17T15:09:41.829-03:00",
"id" : 177,
"url" : "//b4.vnda.com.br/demo/2021/03/17/15_3_4_488_10_7_5_537_SoPureMoisturizingTreatment200ml.jpg?1616004581",
"variant_ids" : []
},
{
"variant_ids" : [
289
],
"url" : "//b0.vnda.com.br/demo/2021/03/17/15_3_4_483_11_10_1_187_SoPureMoisturizingTreatment200ml_verso.jpg?1616004572",
"updated_at" : "2021-03-17T15:09:32.412-03:00",
"id" : 176
}
]
Listar imagens atribuidas a SKUs específicos
GET https://demo.vnda.com.br/api/v2/products/:product_id/variants/:sku/images
[
{
"url" : "//b2.vnda.com.br/demo/2021/03/17/15_3_4_483_11_10_1_187_SoPureMoisturizingTreatment200ml_verso.jpg?1616004572",
"updated_at" : "2021-03-17T15:09:32.412-03:00"
}
]
Cadastrar imagem
POST https://demo.vnda.com.br/api/v2/products/:product_id/images?file_url=:url
O parâmetro :url deve ser um endereço da internet, acessível de forma pública (sem necessidade de login)
A API irá baixar uma cópia da imagem para dentro do produto
Remover imagem
DELETE https://demo.vnda.com.br/api/v2/products/:product_id/images/:image_id
Retorna HTTP 204 quando a operação for executada com sucesso
Ordenar imagem
POST https://demo.vnda.com.br/api/v2/products/:product_id/images/:image_id/reorder
O parâmetro :sorted_ids deve conter os IDs das imagens dos produtos na ordem desejava
Exemplo:
curl \
-H "Authorization: Token \"xxx\"" \
-H "Content-Type: application/json" \
-d '{"ids": [176,177]}'
-X POST "https://demo.vnda.com.br/api/v2/products/92/images/reorder"
Retorna HTTP 200 quando a operação for executada com sucesso
Associar imagem a uma variante
POST https://demo.vnda.com.br/api/v2/products/:product_id/images/:image_id/add_variant?variant_id=:variant_id
O parâmetro :variant_id deve conter o ID de uma variante previamente cadastrada no produto
Retorna HTTP 200 quando a operação for executada com sucesso
Desassociar imagem de uma variante
POST https://demo.vnda.com.br/api/v2/products/:product_id/images/:image_id/remove_variant?variant_id=:variant_id
O parâmetro :variant_id deve conter o ID de uma variante previamente cadastrada no produto
Retorna HTTP 200 quando a operação for executada com sucesso