👉 Introdução

A documentação é organizada por entidades individuais, cada uma contendo detalhes sobre os métodos disponíveis (GET, POST, PUT, DELETE) e como aproveitá-los ao máximo.

📘

Nem todas as entidade possuem todos os métodos disponíveis

Endpoints

Todos os endpoints seguem o mesmo padrão, onde a entidade ({ENTITY}) é precedida pelo domínio completo da loja acrescido de /rest.

https://your-domain.com/rest/{ENTITY}

Cada endpoint oferece um grupo de ações possíveis para a entidade em atual. Cada ação é especificada pelo HTTP Method enviado na requisição. Sendo os disponíveis:

GET

Para este método, são disponibilizados atributos para serem utilizados na filtragem de resultados que serão retornados. Os filtros disponíveis para cada requisição estarão listados na seção QUERY PARAMS da mesma.

DELETE

Para este método, é necessário especificar o ID da entidade a ser excluída através de um query parameter. Este parâmetro é, normalmente, entity_id.

PUT e POST

Para estes métodos, os parâmetros do body da requisição serão utilizados para definir os atributos de novos registros (POST) ou a atualização de atributos de registros já existentes (PUT). Os parâmetros disponíveis para cada requisição estarão listados na aba BODY PARAMS da mesma.