1. Shipments
Flype Order API Gulf
  • UAE API Integration Guide
    • Shipments
      • Shipments Count
        GET
      • All Shipments
        POST
      • Bulk Order
        POST
      • Schedule Pickup
        POST
      • Shipment Details
        GET
      • Shipment Last Status
        GET
      • Cancel Shipment
        GET
      • Get AirwayBill
        GET
    • Locations
      • Get Cities
      • Get All Countries
    • Webhook
      • Shipment Status Updates Webhook
    • Schemas
      • Error
      • ServiceType
      • TrackingStatusName
      • PickupLocation
      • RecipientAddress
  1. Shipments

Cancel Shipment

GET
/api/order/{trackingNumber}/CancelShipment

CancelShipment - Cancel shipment before pickup#

Use this endpoint to cancel a shipment using its trackingNumber.
A shipment can only be cancelled before it has been picked up. Once the shipment has been picked up or has moved into the delivery process, it can no longer be cancelled through this endpoint.

Important rules#

  • Only one shipment can be cancelled per request.
  • The shipment must not have been picked up yet.
  • After pickup, cancellation is no longer allowed.

Required URL parameter#

  • trackingNumber - Public tracking number of the shipment to cancel.

Summary#

Use CancelShipment only when you need to cancel a single shipment before pickup.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/order//CancelShipment' \
--header 'Authorization: Bearer <token>'

Responses

🟢200
application/json
Successful response
Body

Example
{
    "data": true
}
🟠401
🟠409
Previous
Shipment Last Status
Next
Get AirwayBill
Built with