CancelPickup

Request
Request Body schema: application/json
object (PickupConfirmation)

This model contains the confirmation information for a scheduled pickup.

object (PickupLocationDetails)

This model represents the place where the pickup should occur

object (CancellationDetails)

This model contains the explanation of why a user is cancelling a pickup.

object (PickupContactDetails)

Contact information for the person who will be present for the pickup.

object (PickupShipmentDetails)

Contains information regarding the service code for the pickup request and the packages that will be picked up

required
Array of objects or null (PickupWindow)

The time windows that the carrier returned in the Schedule Pickup Response

object or null

The grab bag of properties necessary to cancel the pickup

transaction_id
required
string <uuid>

The transaction ID uniquely represents this request. If the request is retried then this transaction ID will be the same. You should only perform the requested action once per given transaction ID.

object (Authorization)
object or null
Responses
200

This object model represents the response from a successful cancel pickup request.

post/CancelPickup
Request samples
application/json
{
  • "confirmation": {
    },
  • "location": {
    },
  • "cancellation_details": {
    },
  • "contact": {
    },
  • "pickup_details": {
    },
  • "pickup_windows": [
    ],
  • "custom_properties": {
    },
  • "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
  • "authorization": {
    },
  • "metadata": {
    }
}
Response samples
application/json
{
  • "confirmation_id": "string",
  • "successful": true,
  • "status": "Your pickup was cancelled. Unable to cancel over the network, please call ### ### ####.",
  • "custom_properties": {
    },
  • "metadata": {
    }
}