Informações referente a Request Pedido API V3

Neste artigo, mostraremos como realizar a gestão dos seus pedidos através da API V3. Acompanhe o passo a passo e descubra como realizar de forma prática.

Request Pedido (Order)

No Hub Ideris, a gestão de pedidos envolve três tipos principais de requisições: GET, POST e PUT. A função DELETE não está disponível por questões de segurança e infraestrutura. Para corrigir um pedido irregular, basta alterar seu status para "cancelado".

Endpoints Disponíveis

1. Buscar a Lista de Pedidos

• Método: GET
• URL: https://apiv3.ideris.com.br/order/search 
• Objetivo: Buscar todos os pedidos existentes no sistema, sem filtros aplicados.

2. Buscar Pedido pelo ID

• Método: GET
• URL: https://apiv3.ideris.com.br/order/{orderId} 
• Objetivo: Buscar informações de um pedido específico usando o ID do pedido.

3. Buscar Pedidos por Status

• Método: GET
• URL: https://apiv3.ideris.com.br/order/status/search 
• Objetivo: Buscar uma lista de pedidos filtrados por status.

4. Buscar Pedidos por Status e ID

• Método: GET
• URL: https://apiv3.ideris.com.br/order/{orderId}/status 
• Objetivo: Buscar pedidos filtrados por ID e status.

5. Buscar Pedido pelo ID (Alternativa)

• Método: GET
• URL: https://apiv3.ideris.com.br/order 
• Objetivo: Buscar pedido pelo ID.

6. Cadastrar Pedido Manualmente

• Método: PUT
• URL: https://apiv3.ideris.com.br/order 
• Objetivo: Cadastrar um pedido manual na base Ideris. Essa opção pode ser utilizada para inserir pedidos feitos na frente de caixa ou externamente aos marketplaces.

7. Atualizar Pedido na Base Ideris

• Método: POST
  
• URL: https://apiv3.ideris.com.br/order
• Objetivo: Atualizar um pedido já registrado, como modificar seu status, código de rastreamento ou informar entrega ao cliente ou ao marketplace.

Importante:

• • Não é possível realizar alterações em pedidos com status ‘Entregue’ (ID 1012), ‘Cancelado’ (ID 1015) ou ‘Pagamento Cancelado’ (ID 1017).
  • Retornos:
    • 200 (Ok): Todos os processos do pedido foram concluídos corretamente.
    • 400 (Bad Request): Se houver problema de validação das informações.
    • 207 (Multi-status): Se ocorrer algum problema em um ou mais pedidos da lista.

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!