Neste artigo, explicaremos sobre a Request de status. Acompanhe a explicação para manter um controle organizado dos seus status dentro da Ideris.
Request Status
Este artigo detalha como utilizar o endpoint de Status na API Ideris. Este recurso oferece um CRUD completo para gerenciar status personalizados, permitindo que você acompanhe e controle processos internos em fluxos operacionais até o status final, como a entrega ao comprador.
Endpoints Disponíveis
1. Buscar lista de status personalizados
- Requisição: GET https://apiv3.ideris.com.br/status/search
- Objetivo: Obter uma lista das últimas atualizações realizadas na API Ideris.
2. Buscar status pelo ID
- Requisição: GET https://apiv3.ideris.com.br/status/{statusId}
- Objetivo: Buscar um status personalizado existente, especificando o ID na URL.
3. Criar um novo status personalizado
- Requisição: POST https://apiv3.ideris.com.br/status
- Objetivo: Adicionar um novo status personalizado na base Ideris.
4. Atualizar um status existente
- Requisição: PUT https://apiv3.ideris.com.br/status
- Objetivo: Atualizar um status personalizado já cadastrado na base.
5. Deletar um status personalizado
- Requisição: DELETE https://apiv3.ideris.com.br/status/{statusId}
- Objetivo: Deletar um status personalizado existente, especificando o ID na URL.
Atenção:
Certifique-se de que o status a ser excluído é o correto, pois, uma vez deletado, ele não pode ser recuperado.
Orientações Importantes
- Para todas as requisições, é necessário incluir o Content-Type: application/json e o token de autenticação obtido pelo endpoint de Login no Header da requisição.
- O gerenciamento de status personalizados pode ser utilizado para otimizar o fluxo de trabalho interno, adaptando-se às necessidades específicas da sua operação.
Documentação Eletrônica
A documentação completa da API está disponível em um ambiente eletrônico no endereço Swagger.
-
Acesso: Não é necessário token para consultar essa documentação.
-
Objetivo: Retornar exemplos de objetos padrão, permitindo que você teste as integrações sem precisar de credenciais de acesso.
Se precisar de mais ajuda com este processo, nossa equipe de suporte está pronta para atender você. É só clicar no ícone do whatsapp no canto inferior direito de qualquer página do seu painel Ideris ou abrir um ticket.
Conte sempre conosco. Até a próxima!