Order Status

Continual retrieval of the order states

Order States Changing

The Order states will be automatically changed according to the Order progress over the following;

  1. Order is Submitted; Once the Order is created the End-user can easily submit it.

  2. Assigning Driver; This is the action on which the system is seeking for the Driver to be assigned.

  3. Driver is Assigned; Certain driver has accepted the Order request so that to be assigned to it.

  4. Order is in Picking up; As soon as the Order items have been processed and ready to be delivered, the driver can get ready to pick it up (after this status the Courier cannot cancel the order).

  5. Order is in Delivering phase; While the Driver is on his/her way to the customer, the state of the Order will be updated.

  6. Order is Delivered; Once the customer receives the Order, the end-users will be informed, enabling a perfect after-sale service.

  7. Order is Cancelled; This states will be retrieved, whenever a cancellation action takes place in the order.

  8. Order is closed by system; The Order can be closed by system, in case of no updates have been enrolled over it for a certain while.

  9. Order is closed by support; All the beneficiaries have the right to express their experience to SHGARDI's support team, while actions, as order closure, can be taken over from their side.

  10. Order is cancelled by partner; the action of cancellation to be taken from the partner side

Order Status

GET env./api/{api-version}/Order/status

This endpoint allows you to get the order status.

Path Parameters

NameTypeDescription

api-version

string

The API version is "1"

id

string

The ID of the order patched onto Shgardi's

Headers

NameTypeDescription

Accept-Language

string

The Default language is "en-US"

{
  "integrationOrderId": "string",
  "orderNumber": "string",
  "currentStatusId": 0,
  "currentStatusName": "string",
  "currentStatusDateTime": "2020-09-23T18:33:02.122Z",
  "customerOrderNo": "string",
  "consignmentNo": "string",
  "remarks": "string",
  "driverInfo": {
    "fullName": "string",
    "phoneNumber": "string",
    "profilePictureUrl": "string",
    "gender": "string",
    "rate": 0
  },
  "driverLocationTrackings": [
    {
      "arriveTime": "2020-09-23T18:33:02.122Z",
      "latitude": 0,
      "longitude": 0
    }
  ]
}

The Order Status will begin to change by 15 mins. in advance of the "pickupDate" Parameter value at the "Create Order" API

Last updated