API Reference
  1. Shipping API
  2. Pickup

Cancel a Pickup

post
https://rps-sandbox.speedx.io/rps-api/pickup/cancel

This API will cancel a pickup request

Environments

EnvironmentURL
Sandboxhttps://rps-sandbox.speedx.io/rps-api/pickup/cancel
Productionhttps://rps.speedx.io/rps-api/pickup/cancel

Notes

  • Fields marked as Required are essential for certain services. Ensure the correct fields are included by checking the "Required" column in each section.
  • Many field values are provided by the Account Manager. Please consult with them to obtain valid, customer-specific values.

Response Code

CodeCategoryDescription
200SUCCESSSuccess
1000ERRORUnauthorized
2001ERROROperation error
Body Params
string

The bookingCode returned from the Pickup Request API
Either "bookingCode' Or "customerRefId" must be provided.

string

The customerRefId provided to the Pickup Request API
Either "bookingCode' Or "customerRefId" must be provided.

string

Reason for cancelling the pickup.
Max-length: 255
Example: Shipment delayed

Headers
string
required

API key

Response

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?