Order API

Cancel order

Cancels an existing delivery order. Only orders that are Pending Pickup can be cancelled.

Note: The names of the parameters in this endpoint differ from the order creation endpoint. This is because the two endpoints use different specification versions.

delete/{countryCode}/2.2/orders/{trackingNo}

Request

  • Base URL
    https://api-sandbox.ninjavan.co
  • URL
    https://api-sandbox.ninjavan.co/{countryCode}/2.2/orders/{trackingNo}
  • Auth
    none declared. Required headers: Authorization

Path parameters

countryCode'SG' | 'MY' | 'TH' | 'ID' | 'VN' | 'PH' | 'MM' required

Country code.

trackingNostring required

The tracking_number that our API returned in the order creation response.

Headers

Authorizationstring required

Your Bearer token.

Response

Order successfully cancelled.

trackingIdstring

Tracking ID of the order that was cancelled.

statusstring

Status of the order.

updatedAtstring datetime

Date on which the order was cancelled.

Changes

No recorded changes to this operation across all 1 revision of this API.