Sign in
ltl

Schedule a pickup

Create a bill of lading and schedule a pickup with the carrier in one request. The BOL must be printed and given to the carrier at pickup.

post/v-beta/ltl/pickups

Request body

carrier_idstring uuid required

The carrier to use for this pickup

Example request

{
  "carrier_id": "aed2a8c0-7998-4fef-9a82-2cab5f527dc2",
  "carrier": {
    "instructions": "Call 30 minutes before arrival"
  },
  "options": [
    {
      "code": "lftp"
    }
  ],
  "shipment": {
    "service_code": "stnd",
    "pickup_date": "2021-10-01",
    "pickup_window": {
      "start_at": "08:00:00",
      "end_at": "12:00:00",
      "closing_at": "17:00:00"
    },
    "ship_from": {
      "name": "John Doe",
      "phone": "+1 204-253-9411 ext. 123",
      "email": "example@example.com",
      "company_name": "The Home Depot",
      "address_line1": "1999 Bishop Grandin Blvd.",
      "address_line2": "Unit 408",
      "address_line3": "Building #7",
      "city_locality": "Winnipeg",
      "state_province": "Manitoba",
      "postal_code": "78756-3717",
      "country_code": "CA"
    },
    "ship_to": {
      "name": "John Doe",
      "phone": "+1 204-253-9411 ext. 123",
      "email": "example@example.com",
      "company_name": "The Home Depot",
      "address_line1": "1999 Bishop Grandin Blvd.",
      "address_line2": "Unit 408",
      "address_line3": "Building #7",
      "city_locality": "Winnipeg",
      "state_province": "Manitoba",
      "postal_code": "78756-3717",
      "country_code": "CA"
    }
  }
}

Response

Pickup successfully scheduled

confirmation_numberstring

Carrier confirmation number

pickup_idstring

Unique pickup identifier

quote_idstring

Associated quote ID

pro_numberstring

PRO number assigned by carrier

shipment_idstring

ShipEngine shipment ID

messagestring

Optional carrier message

Example response

{
  "confirmation_number": "CONF123456",
  "pickup_id": "se-pickup-123",
  "quote_id": "se-quote-456",
  "pro_number": "PRO789012",
  "shipment_id": "se-shipment-789",
  "message": "Pickup scheduled successfully",
  "documents": [
    {
      "type": "bill_of_lading",
      "format": "pdf",
      "image": "JVBERi0xLjQKJeLjz9M..."
    }
  ],
  "warnings": [
    {
      "external_code": "W001",
      "message": "Residential delivery may require additional fees"
    }
  ]
}

Changes