DELETE /shipments/{version}/void/cancel/{shipmentidentificationnumber}
The Void Shipping API is used to cancel the previously scheduled shipment
Servers
- https://wwwcie.ups.com/api
- https://onlinetools.ups.com/api
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
shipmentidentificationnumber |
String | Yes |
The shipment's identification number Alpha-numeric. Must pass 1Z rules. Must be upper case. Length 18 |
version |
String | Yes |
API Version Valid values:
Default value: "v2409" |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
transactionSrc |
String | No |
An identifier of the client/source application that is making the request.Length 512 Default value: "testing" |
transId |
String | No |
An identifier unique to the request. Length 32 |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
trackingnumber |
String | No |
The package's tracking number. You may have up to 20 different tracking numbers listed. If more than one tracking number, pass this value as: trackingnumber= ["1ZISUS010330563105","1ZISUS01033056310 8"] with a coma separating each number. Alpha-numeric. Must pass 1Z rules. Must be upper case. Length 18 |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.