API docs by Redocly

Pickup Request and Visibility Service (1.0.0)

Download OpenAPI specification:Download

This document provides the API specification for the Pickup Request and Visibility Service.

Pickup Requests

Create a new Pickup

This operation creates a new Pickup Request.

Request Body schema: application/json
required
isTest
required
string

Indicates whether the submitted request is indended to be a test (True/False)

required
Array of objects

An array to hold addresses (origin is required, destination zip required, other fields optional)

customer
required
string or null

The name (or code) of the customer from which the bill of lading information originated. Typically, the shipper of the freight. Similar to EDI trading partner, sender of the information.

required
Array of objects or null

An array to hold emergency contact information

grossPickupWeight
required
integer

The gross weight (in pounds) of the pickup request of all BOLs on PU Request

weightUofM
required
string

Future proofing for KG in Canada and Mexico - applies to entire document

handlingUnitCount
required
integer

Total handling units across all BOLs on PU Request

cubicFeet
required
integer or null

The total cubic feet of the shipment

linearFeet
required
integer or null

The total linear feet required for the pickup

trailerNumber
required
string or null

Number of the trailer

loadedBy
required
string or null

Loaded by either shipper or driver

sealNumber
required
string or null

Number(s) of seals

warehouseName
string or null

Warehouse that goods are located

readyDate
required
string or null <date-time>

Date entire pickup request is ready. (format ISO-8601)

readyTime
required
string or null <date-time>

Time entire pickup request is ready. (format ISO-8601). Time the freight is ready, earliest time the driver can show up.

closeTime
required
string or null <date-time>

Time shipper location closes. Time the shipper closes, latest time the driver can show up.

openDate
string or null <date-time>

Informational only. (format ISO-8601)

openTime
string or null <date-time>

Informational only. (format ISO-8601)

pickupLocationTimeZone
required
string or null

UTC+# timezone

dockDoorNumber
required
string or null

Dock door for the pickup

dockContactEmail
required
string or null

Shipping department contact email

dockContactName
required
string or null

Shipping department contact name

dockContactPhone
required
string or null

Shipping department contact phone

confirmationEmail
required
string or null

Address to email pickup response to (in addition to API accept/reject/etc)

required
Array of objects or null

An array to hold information about what's being picked up

required
Array of objects or null

An array to hold addresses

required
Array of objects or null

An array to hold addresses

requestFunction
required
string

NewPickup, ModifyExisting

carrierPickupNumber
required
string or null

Carrier's pickup number

Responses

Request samples

Content type
application/json
{
  • "isTest": false,
  • "pickupAddress": [
    ],
  • "customer": "string",
  • "emergencyContact": [
    ],
  • "grossPickupWeight": 0,
  • "weightUofM": "string",
  • "handlingUnitCount": 0,
  • "cubicFeet": 0,
  • "linearFeet": 0,
  • "trailerNumber": "string",
  • "loadedBy": "string",
  • "sealNumber": "string",
  • "warehouseName": "string",
  • "readyDate": "2019-08-24T14:15:22Z",
  • "readyTime": "2019-08-24T14:15:22Z",
  • "closeTime": "2019-08-24T14:15:22Z",
  • "openDate": "2019-08-24T14:15:22Z",
  • "openTime": "2019-08-24T14:15:22Z",
  • "pickupLocationTimeZone": "string",
  • "dockDoorNumber": "string",
  • "dockContactEmail": "string",
  • "dockContactName": "string",
  • "dockContactPhone": "string",
  • "confirmationEmail": "string",
  • "shipmentDetails": [
    ],
  • "destinationAddress": [
    ],
  • "billToAddress": [
    ],
  • "requestFunction": "string",
  • "carrierPickupNumber": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Update an existing Pickup

This operation updates an existing Pickup Request.

path Parameters
pickupId
required
string

The ID of the Pickup Request to update

Request Body schema: application/json
required
isTest
required
string

Indicates whether the submitted request is indended to be a test (True/False)

required
Array of objects

An array to hold addresses (origin is required, destination zip required, other fields optional)

customer
required
string or null

The name (or code) of the customer from which the bill of lading information originated. Typically, the shipper of the freight. Similar to EDI trading partner, sender of the information.

required
Array of objects or null

An array to hold emergency contact information

grossPickupWeight
required
integer

The gross weight (in pounds) of the pickup request of all BOLs on PU Request

weightUofM
required
string

Future proofing for KG in Canada and Mexico - applies to entire document

handlingUnitCount
required
integer

Total handling units across all BOLs on PU Request

cubicFeet
required
integer or null

The total cubic feet of the shipment

linearFeet
required
integer or null

The total linear feet required for the pickup

trailerNumber
required
string or null

Number of the trailer

loadedBy
required
string or null

Loaded by either shipper or driver

sealNumber
required
string or null

Number(s) of seals

warehouseName
string or null

Warehouse that goods are located

readyDate
required
string or null <date-time>

Date entire pickup request is ready. (format ISO-8601)

readyTime
required
string or null <date-time>

Time entire pickup request is ready. (format ISO-8601). Time the freight is ready, earliest time the driver can show up.

closeTime
required
string or null <date-time>

Time shipper location closes. Time the shipper closes, latest time the driver can show up.

openDate
string or null <date-time>

Informational only. (format ISO-8601)

openTime
string or null <date-time>

Informational only. (format ISO-8601)

pickupLocationTimeZone
required
string or null

UTC+# timezone

dockDoorNumber
required
string or null

Dock door for the pickup

dockContactEmail
required
string or null

Shipping department contact email

dockContactName
required
string or null

Shipping department contact name

dockContactPhone
required
string or null

Shipping department contact phone

confirmationEmail
required
string or null

Address to email pickup response to (in addition to API accept/reject/etc)

required
Array of objects or null

An array to hold information about what's being picked up

required
Array of objects or null

An array to hold addresses

required
Array of objects or null

An array to hold addresses

requestFunction
required
string

NewPickup, ModifyExisting

carrierPickupNumber
required
string or null

Carrier's pickup number

Responses

Request samples

Content type
application/json
{
  • "isTest": false,
  • "pickupAddress": [
    ],
  • "customer": "string",
  • "emergencyContact": [
    ],
  • "grossPickupWeight": 0,
  • "weightUofM": "string",
  • "handlingUnitCount": 0,
  • "cubicFeet": 0,
  • "linearFeet": 0,
  • "trailerNumber": "string",
  • "loadedBy": "string",
  • "sealNumber": "string",
  • "warehouseName": "string",
  • "readyDate": "2019-08-24T14:15:22Z",
  • "readyTime": "2019-08-24T14:15:22Z",
  • "closeTime": "2019-08-24T14:15:22Z",
  • "openDate": "2019-08-24T14:15:22Z",
  • "openTime": "2019-08-24T14:15:22Z",
  • "pickupLocationTimeZone": "string",
  • "dockDoorNumber": "string",
  • "dockContactEmail": "string",
  • "dockContactName": "string",
  • "dockContactPhone": "string",
  • "confirmationEmail": "string",
  • "shipmentDetails": [
    ],
  • "destinationAddress": [
    ],
  • "billToAddress": [
    ],
  • "requestFunction": "string",
  • "carrierPickupNumber": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete an existing Pickup

This operation deletes an existing Pickup Request.

path Parameters
pickupId
required
string

The ID of the Pickup Request to delete

Responses

Response samples

Content type
application/json
{
  • "message": "Pickup Request could not be deleted"
}

Pickup Visibility

Get a Pickup

This operation provides visibility into a Pickup Request.

query Parameters
lookupValue
required
string

The value to look up

lookupType
required
string
Enum: "PickupConfirmationID" "PRO"

The type of value to look up

requestType
required
string

The type of request to make

isTest
required
string
Enum: "true" "false"

Indicates whether the submitted request is intended to be a test

Responses

Response samples

Content type
application/json
{
  • "pickupConfirmationId": 12345678232,
  • "status": "En Route",
  • "informationCode": {
    },
  • "stopEta": "2024-11-20T00:00:00.000",
  • "stopEtaTimeZone": "string",
  • "equipmentInformation": {
    },
  • "shipmentArray": [
    ]
}