Como realizar requisições pela Referência de API

Você pode fazer as requisições dos nossos endpoints utilizando nossa Referência de API. Confira a seguir como utilizar nossa referência para suas requisições:

  1. Selecione a linguagem desejada no canto superior esquerdo:
Language

Language

  1. Configure a autenticação para requisição:
    1. Preencha o campo token com seu token gerado no Admin.
    2. Preencha o campo X-Shop-Host com o domínio da sua loja.
Authentication

Authentication

  1. Selecione o servidor que deseja realizar a requisição:
    1. URLs que iniciam com https://api.vnda.com.br/api/v2a fazem requisições no ambiente de produção;
    2. URLs que iniciam https://api.sandbox.vnda.com.br/api/v2 fazem requisições no ambiente de teste.
URLs

URLs

  1. Preencha os parâmetros necessários para a requisição (Body Params e Metada);
  2. Clique em Try it;
  3. Confira o Response da requisição.

Exemples

Você pode visualizar os exemplos de resposta no canto inferior direito:

Examples

Examples

Responses

Entenda os parâmetros da resposta da requisição expandindo o código de resposta na seção Responses:

Descrição dos parâmetros de resposta

Descrição dos parâmetros de resposta

Histórico de requisições

Acompanhe o histórico das suas requisições pela seção Your Request History:

📘

Confira também como fazer uma requisição via Postman.