API docs by Redocly

Blue Truck Shipper API (1.9.0)

Endpoints for quoting, booking, and retrieving shipments

job

Quoting, booking, and retrieving jobs

Books a new job

Authorizations:
TokenAuthentication
Request Body schema: application/json
pickupName
string

Name of the pickup point of contact. This field is optional and will overwrite the existing value if the address object exists. When using pickupAddressId, it is not recommended unless you are deliberately trying to overwrite the existing value.

pickupPhone
string

Phone number of the pickup point of contact. This field is optional and will overwrite the existing value if the address object exists. When using pickupAddressId, it is not recommended unless you are deliberately trying to overwrite the existing value.

pickupEmail
string

Email of the pickup point of contact. This field is optional and will overwrite the existing value if the address object exists. When using pickupAddressId, it is not recommended unless you are deliberately trying to overwrite the existing value.

pickupAddressId
string

BTL place id for the pickup location. Either this or the pickupAddress must be specified, but not both.

object (Address)
customerName
required
string

Full name of the customer receiving the delivery

customerPhone
required
string

Phone number of the customer receiving the delivery

customerEmail
string

Email address of the customer receiving the delivery. Required when billingMethod is "customer".

required
object (Address)
required
Array of objects (ItemArray)
billingMethod
required
string
Enum: "store" "customer"

Who to bill for this job

salesOrder
string

Sales order (generated by shipper)

notes
string

Notes to BTL team for this delivery

fieldNotes
string

Notes to the delivery crew

isThreshold
boolean

Whether the job is a threshold job or white-glove job

holdPickupUntil
string <date>

Date until which the pickup should be held. Job will not be picked up before this date.

Responses

Request samples

Content type
application/json
{
  • "pickupName": "John Doe",
  • "pickupPhone": "(510) 767-2676",
  • "pickupEmail": "john.doe@example.com",
  • "pickupAddressId": "AaBbCc1234567890",
  • "pickupAddress": {
    },
  • "customerName": "John Doe",
  • "customerPhone": "(510) 767-2676",
  • "customerEmail": "john.doe@example.com",
  • "deliveryAddress": {
    },
  • "items": [
    ],
  • "billingMethod": "store",
  • "salesOrder": "ABC12345",
  • "notes": "Crate is heavy (400 lbs)",
  • "fieldNotes": "Please visit example.com for assembly instructions",
  • "isThreshold": true,
  • "holdPickupUntil": "2024-12-20"
}

Response samples

Content type
application/json
{
  • "trackingNumber": 12345678901,
  • "dashboardUrl": "string",
  • "trackingUrl": "string",
  • "label4x6Url": "string",
  • "labelLetterUrl": "string",
  • "invoice": {
    }
}

Returns a specific job

Authorizations:
TokenAuthentication
path Parameters
id
required
integer <int64>

Tracking number for a job

Responses

Response samples

Content type
application/json
{
  • "trackingNumber": 12345678901,
  • "pickupLocationId": "abcdefgh1234",
  • "progressStage": "booked",
  • "pickupStatus": "pending",
  • "deliveryStatus": "pending",
  • "customerName": "John Doe",
  • "customerPhone": "(510) 767-2676",
  • "customerEmail": "john.doe@example.com",
  • "deliveryAddress": "1234 Main St., Anywhere, NY 10001",
  • "items": [
    ],
  • "numPieces": 2,
  • "billingMethod": "store",
  • "salesOrder": "ABC12345",
  • "notes": "Crate is heavy (400 lbs)",
  • "fieldNotes": "Please visit example.com for assembly instructions",
  • "invoice": {
    },
  • "scheduledDate": "2021-01-01",
  • "dashboardUrl": "string",
  • "trackingUrl": "string",
  • "label4x6Url": "string",
  • "labelLetterUrl": "string",
  • "isThreshold": true
}

Deletes a specific job

Deletes a job if it's within 48 hours of creation and hasn't been processed by Blue Truck

Authorizations:
TokenAuthentication
path Parameters
id
required
integer <int64>

Tracking number for a job

Responses

Response samples

Content type
application/json
{
  • "detail": "This job cannot be deleted."
}

Returns a price estimate for a job

Calculates an estimate for the cost of a job. Returns individual line items as well as a total summation of price.

Authorizations:
TokenAuthentication
Request Body schema: application/json
pickupAddressId
string

BTL place id for the pickup location. Either this or the pickupAddress must be specified, but not both.

object (Address)
object (Address)
Array of objects (ItemArray)

Responses

Request samples

Content type
application/json
{
  • "pickupAddressId": "AaBbCc1234567890",
  • "pickupAddress": {
    },
  • "deliveryAddress": {
    },
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "totalPrice": 47000,
  • "lineItems": [
    ]
}

place

Returns a list of pickup places associated with the account

Authorizations:
TokenAuthentication

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a specific place

Authorizations:
TokenAuthentication

Responses

Response samples

Content type
application/json
{
  • "id": "AaBbCc1234567890",
  • "street": "123 Main St.",
  • "street2": "Apt 1",
  • "city": "Anywhere",
  • "state": "CA",
  • "zip": 90001
}