Orders API

Last modified: 05 August 2024

YUMBI Gateway Orders API enables integrators to manage the lifecycle of an order, from receipt (via webhook notifications) to acceptance or rejection based on operational criteria. This API offers endpoints for real-time order updates, retrieval of detailed order information, and order status updates.

tip

The Orders API includes the following key features:

  • Webhook Notifications: Instantly receive notifications about new orders.

  • Fetch Order Details: Retrieve specific details of an order using provided identifiers.

  • Order Management: Accept or Reject orders based on availability or operational constraints.

  • List Created Orders: Access a list of recently created orders directly, useful in scenarios where webhooks may fail.

This diagram shows the workflow for handling orders through the YUMBI Gateway API.

IntegratorIntegratorWebhook ServiceWebhook ServiceAPI ServerAPI ServerWebhook Notificationalt[Webhook Success]Event notification including order_id[In Case Webhook Not Received]GET /ordersQuery orders by status and dateFetch Order DetailsGET /orders/{order_id}Order details responseDecision ProcessCheck with storeto accept or rejectAccept or Reject Orderalt[Accept Order]POST /orders/{order_id}/acceptOrder accepted response[Reject Order]POST /orders/{order_id}/rejectOrder rejected response