Skip to main content

Update Order

PUT/orders/
Updates an order’s status. Use this to mark orders as shipped, delivered, completed, cancelled, or refunded.

Authentication

Headers

HeaderValueRequired
AuthorizationBearer YOUR_API_TOKENYes
Content-Typeapplication/jsonYes

Path Parameters

ParameterTypeRequiredDescription
idintegerYesThe order ID

Request Body

ParameterTypeRequiredDescription
statusintegerNoNew status code (1-6)

Status Codes

CodeStatus
1Awaiting Payment
2Under Review
3In Progress
4Completed
5Cancelled
6Refunded

Example Request

curl -X PUT "https://merchant-api.rmz.gg/shawarma/orders/78901" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status": 3}'

Success Response

{
  "message": "Order Has Been Updates",
  "data": null,
  "api": "rmz.shawarma",
  "timestamp": 1699999999
}

Error Responses

CodeDescription
400Invalid status transition
401Unauthorized — invalid or missing token
404Order not found
422Validation error — invalid status value