FM_APIs

/ShipmentCancellation/markCancellation

POST

Shipment Processing

The API allows marking shipment as cancelled

Request

Body Params application/json

data

object

optional

Object containing shipment reference details.

clientShipmentReferenceNumber

string

optional

The unique reference number for the client shipment.

cancellationReason

string

optional

Reason code for cancellation.

cancellationRequestTime

integer

optional

The timestamp when the cancellation is requested.

Example

{
    "data": {
        "clientShipmentReferenceNumber": "240905-a0e0-15b7"
    },
    "cancellationReason": "CNC",
    "cancellationRequestTime": 1725591741302
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/ShipmentCancellation/markCancellation' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": {
        "clientShipmentReferenceNumber": "240905-a0e0-15b7"
    },
    "cancellationReason": "CNC",
    "cancellationRequestTime": 1725591741302
}'

Responses

🟢200OK

application/json

Successful response indicating shipment cancellation details were updated.

Body

msg

string

optional

Example:

Shipment Cancellation details updated successfully

status

boolean

optional

Example:

true

statusCode

integer

optional

Example:

1004

Example

{
    "msg": "Shipment Cancellation details updated successfully",
    "status": true,
    "statusCode": 1004
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

/RTS/bulkMarkRTS

/orderProcessing/printLabel