Skip to content

Update Courier Information

Request

This endpoint allows merchants to update courier information for merchant self-delivery orders, including courier name, phone number, vehicle information, and other delivery-related details.

Notes:

  1. This API is exclusively for merchant self-delivery orders where the merchant manages their own delivery service.
  2. Updated courier information helps customers track their delivery and contact the delivery person.
  3. This API can be called multiple times to update different courier details as needed.
  4. At least one courier information field must be provided in the request.
  5. This API can only be called after the order has been accepted by the merchant. It cannot be used to update orders that have been completed or cancelled,
Bodyapplication/jsonrequired
orderViewIdinteger, (int64)required

Unique identifier for orders on Keeta platform

Example:123456789
shopIdinteger, (int64)required

Unique identifier of the Keeta store

Example:987654321
courierInfoobject(CourierInfo)required

Comprehensive courier information for self-delivery orders, including personal details, contact information, and vehicle specifications.

curl -i -X POST \
  https://open.mykeeta.com/api/open/order/updateCourierInfo \
  -H 'Content-Type: application/json' \
  -d '{
    "orderViewId": 123456789,
    "shopId": 987654321,
    "courierInfo": {
      "courierId": 123456,
      "courierName": "أحمد محمد",
      "courierPhone": "501234567",
      "courierVehicle": 3,
      "courierPhoneInterCode": "966",
      "vehiclePlateNumber": "DXB-A-12345",
      "courierLastName": "محمد",
      "courierFirstName": "أحمد"
    }
  }'

Responses

Courier information update successful

Bodyapplication/json
codeintegerrequired

A numeric status identifier indicating the result of the interface call, used to determine whether the operation executed successfully.

Enum ValueDescription
0

The request was executed successfully.

Non-zero value

The request execution failed. Specific error details can be viewed in the message field.

Example:0
messagestringrequired

Text description corresponding to the status code, explaining the operation result or error cause to users.

Example:"Success"
Response
{ "code": 0, "message": "Success" }