Skip to main content

Update Order Status API

The Update Order Status API endpoint allows you to change the status of a specific order in your EasyOrders store.

You Must have API Key​

You must get an API key from previous docs and the API key should have permission to orders:update

Endpoint​

  • Method: PATCH
  • URL: https://api.easy-orders.net/api/v1/external-apps/orders/:order_id/status

Request Headers​

  • Api-Key: string

Replace string with your API key.

Available Statuses​

The following statuses are available for updating an order:

  • pending: The order has been placed but not yet processed.
  • confirmed: The order has been confirmed and is ready to be processed.
  • pending_payment: The order is awaiting payment confirmation.
  • paid: The payment for the order has been received.
  • paid_failed: The payment attempt for the order has failed.
  • processing: The order is being prepared for shipment.
  • waiting_for_pickup: The order has been processed and is awaiting pickup.
  • in_delivery: The order has been shipped and is in transit.
  • delivered: The order has been successfully delivered to the customer.
  • canceled: The order has been canceled.
  • returning_from_delivery: The order has been returning from delivery.
  • request_refund: The customer has requested a refund for the order.
  • refund_in_progress: The refund for the order is in progress.
  • refunded: The refund for the order has been completed.

Request Body (JSON)​

const requestBody = {
  status: "processing", // new status of the order
};