FlavorCloud Partner API Documentation

Cancel Shipments

PUT

/CancelShipment

Shipments

Cancel an existing shipment using the ShipmentID.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

CustomerKey

string

optional

Customer key

ShipmentID

string

required

ShipmentID

Example

{
  "ShipmentID": "m1jlce8egkf"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://partnerapi.flavorcloud.com/CancelShipment' \
--header 'Content-Type: application/json' \
--data-raw '{
  "ShipmentID": "m1jlce8egkf"
}'

Responses

🟢200Cancel Shipment Response

application/json

Body

ShipmentID

string

required

The unique id for the shipment that can be used to retrieve it later

Example

{
  "ShipmentID": "string"
}

🟠401Authentication Error

🟠422Validation Error

🔴500Error Response

Modified at 2025-04-28 20:49:09

Get Shipments

Get Tracking Detail