Cancel Order

curl --request PUT \
  --url https://api.mtn.express.ci/client/orders/{reference} \
  --header 'Authorization: Bearer <token>'

{
  "referenceNumber": "ORD0001",
  "total": 98150,
  "deliveryFee": 1500,
  "deliveryInstructions": "Livrer à midi",
  "deliveryDeadline": "2025-06-05",
  "status": "canceled",
  "statusComment": null,
  "createdAt": "2025-06-05T07:05:21.000Z",
  "updatedAt": "2025-06-05T08:04:00.000Z",
  "recipient": {
    "referenceNumber": null,
    "name": "John Doe",
    "phone": "0702029254",
    "address": {
      "name": "45 Avenue de la Paix",
      "landmark": "Terminus 81/82",
      "city": "Cocody",
      "latitude": 5.403871,
      "longitude": -3.9881079
    }
  },
  "items": [
    {
      "referenceNumber": "ITEM001",
      "orderId": 14,
      "itemName": "Samsung Galaxy A05 64Go",
      "quantity": 1,
      "total": 77900,
      "size": "S",
      "weight": 0.5,
      "itemUrl": "https://market.momo.africa/Portal/product/121731/1?tenantId=4&lang=fr",
      "status": "canceled",
      "statusComment": null,
      "createdAt": "2025-06-05T07:05:21.000Z",
      "updatedAt": "2025-06-05T08:04:00.000Z",
      "sender": {
        "referenceNumber": "0596086680",
        "name": "Samsung Store Abidjan",
        "phone": "0700000001",
        "address": {
          "name": "123 Rue Principale",
          "landmark": "Angré pétro ivoire",
          "city": "Cocody",
          "latitude": 5.359951,
          "longitude": -4.008256
        }
      }
    },
    {
      "referenceNumber": "ITEM002",
      "orderId": 14,
      "itemName": "Riz vietnamien La Rizière long grains parfumé 5kg",
      "quantity": 5,
      "total": 18750,
      "size": "S",
      "weight": 5.5,
      "itemUrl": "https://market.momo.africa/Portal/product/107465/1?tenantId=4&lang=fr",
      "status": "canceled",
      "statusComment": null,
      "createdAt": "2025-06-05T07:05:21.000Z",
      "updatedAt": "2025-06-05T08:04:00.000Z",
      "sender": {
        "referenceNumber": "0555306590",
        "name": "Tech Shop",
        "phone": "0700000002",
        "address": {
          "name": "456 Avenue Tech",
          "landmark": "Liberté",
          "city": "Adjamé",
          "latitude": 5.40387101,
          "longitude": -4.009
        }
      }
    }
  ]
}

PUT

orders

{reference}

Cancel Order

curl --request PUT \
  --url https://api.mtn.express.ci/client/orders/{reference} \
  --header 'Authorization: Bearer <token>'

{
  "referenceNumber": "ORD0001",
  "total": 98150,
  "deliveryFee": 1500,
  "deliveryInstructions": "Livrer à midi",
  "deliveryDeadline": "2025-06-05",
  "status": "canceled",
  "statusComment": null,
  "createdAt": "2025-06-05T07:05:21.000Z",
  "updatedAt": "2025-06-05T08:04:00.000Z",
  "recipient": {
    "referenceNumber": null,
    "name": "John Doe",
    "phone": "0702029254",
    "address": {
      "name": "45 Avenue de la Paix",
      "landmark": "Terminus 81/82",
      "city": "Cocody",
      "latitude": 5.403871,
      "longitude": -3.9881079
    }
  },
  "items": [
    {
      "referenceNumber": "ITEM001",
      "orderId": 14,
      "itemName": "Samsung Galaxy A05 64Go",
      "quantity": 1,
      "total": 77900,
      "size": "S",
      "weight": 0.5,
      "itemUrl": "https://market.momo.africa/Portal/product/121731/1?tenantId=4&lang=fr",
      "status": "canceled",
      "statusComment": null,
      "createdAt": "2025-06-05T07:05:21.000Z",
      "updatedAt": "2025-06-05T08:04:00.000Z",
      "sender": {
        "referenceNumber": "0596086680",
        "name": "Samsung Store Abidjan",
        "phone": "0700000001",
        "address": {
          "name": "123 Rue Principale",
          "landmark": "Angré pétro ivoire",
          "city": "Cocody",
          "latitude": 5.359951,
          "longitude": -4.008256
        }
      }
    },
    {
      "referenceNumber": "ITEM002",
      "orderId": 14,
      "itemName": "Riz vietnamien La Rizière long grains parfumé 5kg",
      "quantity": 5,
      "total": 18750,
      "size": "S",
      "weight": 5.5,
      "itemUrl": "https://market.momo.africa/Portal/product/107465/1?tenantId=4&lang=fr",
      "status": "canceled",
      "statusComment": null,
      "createdAt": "2025-06-05T07:05:21.000Z",
      "updatedAt": "2025-06-05T08:04:00.000Z",
      "sender": {
        "referenceNumber": "0555306590",
        "name": "Tech Shop",
        "phone": "0700000002",
        "address": {
          "name": "456 Avenue Tech",
          "landmark": "Liberté",
          "city": "Adjamé",
          "latitude": 5.40387101,
          "longitude": -4.009
        }
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

reference

string

required

Unique order reference in your system.

Response

200 - application/json

The canceled order

Represents the response payload for an order after it has been created, retrieved, or canceled.

referenceNumber

string

required

Unique order reference in your system.

Example:

"ORD0001"

total

number<float>

required

Total amount of the order including delivery fees.

Example:

98150

deliveryFee

number<float>

required

Fee for delivering the order.

Example:

1500

status

string

required

Current status of the order.

Example:

"pending"

createdAt

string<date-time>

required

Timestamp when the order was created.

Example:

"2025-06-05T07:05:21.000Z"

updatedAt

string<date-time>

required

Timestamp when the order was last updated.

Example:

"2025-06-05T07:05:21.000Z"

recipient

object

required

Details of the recipient receiving the order.

Show child attributes

recipient.phone

string

required

Phone number of the recipient in E.164 format (e.g., +2250702029254).

Example:

"+2250702029254"

recipient.address

object

required

Detailed address information.

Show child attributes

recipient.address.name

string

required

Name or description of the address.

Example:

"45 Avenue de la Paix"

recipient.address.city

string

required

City where the address is located.

Example:

"Cocody"

recipient.address.landmark

string | null

Nearby landmark for easy identification.

Example:

"Terminus 81/82"

recipient.address.latitude

number<float> | null

GPS latitude of the address.

Example:

5.403871

recipient.address.longitude

number<float> | null

GPS longitude of the address.

Example:

-3.9881079

recipient.name

string | null

Full name of the recipient.

Example:

"John Doe"

items

object[]

required

List of items included in the order.

Show child attributes

items.referenceNumber

string | null

required

Unique reference number for the item.

Example:

"ITEM001"

items.orderId

integer

required

Identifier of the order this item belongs to.

Example:

14

items.itemName

string

required

Name or description of the item.

Example:

"Samsung Galaxy A05 64Go"

items.quantity

integer

required

Quantity of the item.

Example:

1

items.total

number<float>

required

Total price of the item (quantity * unit price).

Example:

77900

items.status

string

required

Current status of the item.

Example:

"pending"

items.createdAt

string<date-time>

required

Timestamp when this item was added to the order.

Example:

"2025-06-05T07:05:21.000Z"

items.updatedAt

string<date-time>

required

Timestamp of the last update to this item.

Example:

"2025-06-05T07:05:21.000Z"

items.sender

object

required

Information about the sender of an item.

Show child attributes

items.sender.phone

string

required

Phone number of the sender in E.164 format (e.g., +2250700000001).

Example:

"+2250700000001"

items.sender.address

object

required

Detailed address information.

Show child attributes

items.sender.address.name

string

required

Name or description of the address.

Example:

"45 Avenue de la Paix"

items.sender.address.city

string

required

City where the address is located.

Example:

"Cocody"

items.sender.address.landmark

string | null

Nearby landmark for easy identification.

Example:

"Terminus 81/82"

items.sender.address.latitude

number<float> | null

GPS latitude of the address.

Example:

5.403871

items.sender.address.longitude

number<float> | null

GPS longitude of the address.

Example:

-3.9881079

items.sender.referenceNumber

string | null

Unique reference number for the sender.

Example:

"0596086680"

items.sender.name

string | null

Name of the sender or business.

Example:

"Samsung Store Abidjan"

items.size

string | null

Size category of the item.

Example:

"S"

items.weight

number<float> | null

Weight of the item in kilograms.

Example:

0.5

items.itemUrl

string<uri> | null

URL of the item's image.

Example:

"https://market.momo.africa/Portal/product/121731/1?tenantId=4&lang=fr"

items.statusComment

string | null

Optional comments related to the item status.

Example:

null

deliveryInstructions

string | null

Special instructions for the delivery process.

Example:

"Livrer à midi"

deliveryDeadline

string<date-time> | null

The latest date by which the delivery should be completed.

Example:

"2025-06-05"

statusComment

string | null

Optional comments related to the order status.

Example:

null

Get Order Create Webhook

⌘I

Auth

Delivery Orders

Webhooks

Cancel Order

Authorizations

Path Parameters

Response