Public
Documentation Settings
No Environment
Double Column
cURL - cURL
API Delivery
Introduction
GET
Get Orders
POST
Set Next Order Status
POST
Cancel Order
GET
Get list of payments methods
POST
Send to motoboy service
GET
Get List Webhook Failed Events

API Delivery

Introdução

A API de integração de pedidos permite o acesso aos pedidos realizados pela plataforma de delivery e alteração dos status dos pedidos para notificação dos clientes responsáveis pelos pedidos feitos.

Overview

Os endpoints para a integração de pedidos são bem simples e fáceis de integrar.
Todas as respostas são feitas no formato JSON.

Token

A Autenticação das requisições é feita utilizando um token no Header gerado pelo painel do parceiro na plataforma (veja como fazer).

Error Codes

400 - Erro nas informações enviadas
429 - Limite de requisições excedido
401 - Autenticação falhou

Integração

Todas as requisições necessárias para a integração com os pedidos feitos plataforma de delivery.

Como integrar um pedido

A sequência necessária para a integração de um pedido é:

  • Consulta dos pedidos pendentes para a integração.
  • Percorrer o array de pedidos pendentes e avançar o status deles para confirmado, notificando que o pedido foi recebido pela loja para o cliente.
  • Avançar novamente o status do pedido quando o mesmo estiver pronto na operação de delivery.
  • Consumir a lista de pedidos pendentes periodicamente a confirmá-los.