SchedulePickup

This method is used to schedule a pickup with a carrier.

Request
Request Body schema: application/json

An object containing information about the pickup being scheduled.

object (PickupLocationDetails)

This model represents the place where the pickup should occur

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
object (PickupWindow)

This model represents a window of time a pickup could be made.

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
connection_name
string or null

The name of the connection to use, if this app has connection names defined

Responses
200

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

post/SchedulePickup
Request samples
application/json
{
  • "location": {
    },
  • "contact": {
    },
  • "pickup_details": {
    },
  • "requested_pickup_window": {
    },
  • "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
  • "authorization": {
    },
  • "metadata": {
    },
  • "connection_name": "string"
}
Response samples
application/json
{
  • "confirmation": {
    },
  • "pickup_windows": [
    ],
  • "remarks": "string",
  • "custom_properties": {
    },
  • "billing_line_items": [
    ],
  • "metadata": {
    }
}