SwiftGoma.SwiftGoma

Search endpoints

Jump to any API endpoint by name, method, or path

Rider Delivery

Mark on the way

POST/api/v1/orders/:id/on-the-way

Rider marks the order as en route to the buyer. This is also when order messaging opens up.

Requires Authorization
RIDER only
Session

Path parameters

idstringrequired
Must be assigned to the authenticated rider.
Request
curl --request POST \
  --url https://api.swiftgoma.com/api/v1/orders/:id/on-the-way \
  --header 'Authorization: Bearer <access_token>'
200Example response
{
  "success": true,
  "data": {
    "id": "ord_5e6f7a",
    "buyerId": "3f2a1c9e",
    "shopId": "shop_2b3c4d",
    "status": "ON_THE_WAY",
    "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"
  }
}