POST /pickupRequests/cancel

Cancels a pickup request in the Maven system

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Cancels an existing pickup request in the Maven system. This endpoint can be used to automate pickup request cancelations that originate from outside of the Maven system. A canceled pickup request will be assigned a generic completion status of 'Canceled by TMS'.

If a shipment cannot be found with the refNumber specified, or if the shipment has already been assigned a completion status within the Maven system, then this request will fail with a BAD_REQUEST error response.

Body Params
string
required

TMS-assigned shipment reference for pickup

string
required

Terminal code associated with this pickup request

int32

For fleets that associate more than one shipment to a pickup request, the pickupSequenceNumber can be used to differentiate shipments. The combination of refNumber and pickupSequenceNumber must be unique.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json