Skip to main content

Cancel Order

curl -X GET \
'https://apistg.ahamove.com/v1/order/cancel?token=<TOKEN_STG>&order_id=ABCDEF&comment=User changes pick up&cancel_code=user_incorrect_pickup' \
-H 'cache-control: no-cache'

This API is used to cancel an order

Can cancel an order which has one of statuses below:

  • ASSIGNING, ACCEPTED, CONFIRMING, PAYING, IDLE
  • comment and cancel_code parameters have been standardized by Ahamove at Cancel Reason. Partners only need to use the reasons for User, the comment corresponding to the En or Vi column and the corresponding cancel_code with column Ahamove's Cancel Reason Code when Partners needs to cancel the order

HTTP Request

GET https://apistg.ahamove.com/v1/order/cancel

Query Parameters

ParameterTypeRequiredDescription
tokenStringYesThe user Token.
order_idStringYesThe order ID.
commentStringYes if order in ACCEPTED statusThe cancel reason for User (En/Vi column).
cancel_codeStringYes if order in ACCEPTED statusThe cancel code reason for User (Ahamove's Cancel Reason Code column)(Optional).

Response

JSON response example:

{}

Status-Code: 200 OK

Errors

CodeTextDescription
404Not Found- Token not found
- Order not found
402Not allowedNot authorized.
406Not AcceptableOrder not in valid status.
500Internal Server ErrorWe had a problem with our server. Try again later.
503Service UnavailableWe're temporarily offline for maintenance. Please try again later.