Checkout & Orders

Cancel order

POST/api/v1/orders/:id/cancel

Cancels an order — buyer-initiated. Only allowed while the order is still in a cancellable state.

Requires Authorization

Session

Path parameters

idstringrequired

Order ID.

Body parameters

reasonstring

Shown to the seller.

Possible errors

409

CONFLICT

Transition de statut invalide : "ON_THE_WAY" → "CANCELLED".

Notes

Cancellable from AWAITING_PAYMENT, PENDING_SELLER_REVIEW, ACCEPTED, PREPARING, READY_FOR_PICKUP, or RIDER_ASSIGNED — not once a rider has picked up the order.

Request

curl --request POST \
  --url https://api.swiftgoma.com/api/v1/orders/:id/cancel \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reason": "<reason>"
}'

200Example response

{
  "success": true,
  "data": {
    "id": "ord_5e6f7a",
    "buyerId": "3f2a1c9e",
    "shopId": "shop_2b3c4d",
    "status": "CANCELLED",
    "fulfillmentMethod": "DELIVERY",
    "paymentMethod": "MOBILE_MONEY",
    "currency": "USD",
    "deliveryAddress": "12 Avenue du Lac, Goma",
    "deliveryFee": "2.00",
    "subtotal": "25.00",
    "total": "27.00",
    "items": [
      {
        "id": "oitem_1a2b3c",
        "productId": "prod_7c8d9e",
        "variantId": "var_4d5e6f",
        "name": "Riz parfumé 25kg",
        "quantity": 2,
        "unitPrice": "12.50",
        "lineTotal": "25.00"
      }
    ],
    "createdAt": "2026-02-15T09:00:00.000Z",
    "updatedAt": "2026-02-15T09:00:00.000Z"
  }
}