Schedule an LTL Pickup
This API endpoint allows to you schedule a pickup from an LTL quote by passing the quote_id in the request
URL.
Bill of Lading
This endpoint will create a bill of lading using the data you included when you created the quote and include it in the response returned.
You will need to print this and give it to the carrier at the time of pickup.
Request Body
To see a sample of a full request, see the Example Request section below.
Properties
This table lists the properties this endpoint.
| Name | Type | Required | Description |
|---|---|---|---|
pickup_date | string | ✔ | The requested pickup date. |
pickup_window | Pickup Object | ✔ | The preferred pickup window. |
delivery_date | string | ✔ | The requested delivery date. |
carrier | Carrier Object | Any additional instructions to the carrier. | |
options[] | Options Object | Optional accessorial services associated with this pickup. |
Pickup Window Object
This object represents information about the pickup window.
| Name | Type | Required | Description | Format |
|---|---|---|---|---|
start_at | string | ✔ | The earliest time that the freight will be ready for pickup. | 24 Hour Format: HH:MM:SS, HH:MM:SSZ, HH:MM:SS+/-HH:MM |
end_at | string | ✔ | The latest desired pickup time. | 24 Hour Format: HH:MM:SS, HH:MM:SSZ, HH:MM:SS+/-HH:MM |
closing_at | string | ✔ | The time that the pickup facility closes for business. | 24 Hour Format: HH:MM:SS, HH:MM:SSZ, HH:MM:SS+/-HH:MM |
Carrier Object
This object represents optional instructions for the carrier.
| Name | Type | Required | Description |
|---|---|---|---|
instructions | string | Optional instructions for the carrier. | |
test | boolean | Indicates whether or not this is a test call. |
Response Body
The response object returned from sucessful requests to this endpoint will contain the parameters listed in the table below. To see a sample of a full response, see the Example Response section below.
| Name | Type | Required | Description |
|---|---|---|---|
confirmation_number | string | ✔ | A number returned by the carrier to indicate the request was received. |
documents[] | object | ✔ | An array of document objects. For pickup requests this documents array will only include the bill_of_lading. |
documents.type | string | ✔ | The type will always be bill_of_lading in the pickup response. |
documents.image | string | ✔ | The base64-encoded bill of lading document. |
documents.format | string | ✔ | The format of the document which will always be pdf for pickup responses. The base64-encoded image string will be in this format once decoded. |
message | string | ✔ | This optional message includes notes about the pickup if provided by the carrier. |
pickup_id | string | ✔ | A unique ID used by ShipEngine to reference this pickup. |
pro_number | string | ✔ | The PRO number for the pickup assigned by the carrier. If a number is not returned here the carrier will issue one at the time of pickup. |
quote_id | string | ✔ | A unique ID used to identify the quote created to schedule this pickup. This may be used to create a BOL |
shipment_id | string | ✔ | A unique ID used by ShipEngine to reference this pickup. |
warnings | object | This object represents any warnings returned by the carrier when the pickup was scheduled. | |
warnings.external_code | string | The code associated with the warning if provided by the carrier. | |
warnings.message | string | A warning about the pickup if provided by the carrier. |
Example Request
POST /v-beta/ltl/quotes/:quote_id/pickup
123456789101112131415161718192021222324252627
Example Response
123456789101112131415161718192021