Guides

Updating Orders via API

Suggest Edits

Welcome to the guide on updating orders in our platform via API. This functionality enables you to manage the lifecycle of orders seamlessly, from creation to completion and beyond. In this guide, we'll explore the various statuses allowed for orders and provide brief explanations for each stage in the life of an order and its delivery.

Introduction

Our platform's API allows you to update orders dynamically, reflecting changes in status, progress, and delivery details. Whether you're updating the order status, assigning resources, or tracking delivery milestones, our API provides the flexibility and control you need to manage orders effectively.

Allowed Statuses

  • PENDING: The initial status of an order when it is first created.
  • ACCEPTED: The order has been accepted by the system and is awaiting further processing.
  • BRANCH_ACCEPTED: The branch has accepted the order and is preparing for fulfillment.
  • BRANCH_IN_PROGRESS: The order is currently being processed by the branch.
  • BRANCH_DISPATCH: The order has been dispatched from the branch for delivery.
  • DRIVER_IN_BRANCH: The driver is present at the branch to pick up the order.
  • SUPPLIED: The order has been supplied by the branch and is ready for delivery.
  • ORDER_WAITING: The order is waiting for pickup or delivery.
  • TRANSIT: The order is in transit to the delivery location.
  • ONSITE: The order has arrived at the delivery location and is awaiting handoff.
  • COMPLETED: The order has been successfully delivered and completed.
  • CANCEL_REQUEST: A request to cancel the order has been initiated.
  • CANCELED: The order has been canceled.
  • COMPLETED_REQUEST: The order has been successfully delivered, and a completion request has been initiated.

Conclusion

By utilizing our platform's API for order updates, you can efficiently manage the lifecycle of orders and ensure smooth delivery processes. Whether you're tracking order progress, handling cancellations, or initiating completion requests, our API offers the tools and flexibility you need to streamline your operations and enhance the customer experience.

If you have any questions or require assistance with order updates via API, please don't hesitate to reach out to our support team. We're here to help you make the most of our platform's capabilities and optimize your order management workflows.

Happy order updating!

Update Order!

Updated 10 months ago