Download OpenAPI specification:
Technical API Reference for the LTL Connect product's rates redirect, Bill of Lading, and reports endpoints. To obtain an API key, visit uShip API Key Generation.
Allows integrator to generate a prefilled listing creation page or send user directly to uShip rates
| cache-control required | string Set this value to no-cache |
| x-uship-affiliate-id required | string Your uShip Affiliate ID provided by uShip. Ensures all P44 customizations are preserved. |
| commodity | string Enum: "NewCommercialGoods" "UsedCommercialGoods" Valid commodities are NewCommercialGoods and UsedCommercialGoods |
| title | string The title for your listing |
| referrer | string |
| earliestPickupDate | string Earliest pickup date in the ISO 8601 format. NOTE - the timezone is assumed to be in the pickup location's timezone. Offsets will be disregarded. For example, 2022-07-01T11:00-0700 will be interpreted as 2022-07-01T11:00 |
| latestPickupDate | string Latest pickup date in the ISO 8601 format. NOTE - the timezone is assumed to be in the pickup location's timezone. Offsets will be disregarded. For example, 2022-07-01T11:00-0700 will be interpreted as 2022-07-01T11:00 |
| destinationLocationType | string (PostRedirectRequestModelDestinationLocationType) Enum: "Residence" "BusinessWithLoadingDockOrForklift" "BusinessWithoutLoadingDockOrForklift" "ConstructionSite" "TradeShowOrConvention" "Port" "StorageFacility" "MilitaryBase" "Airport" "OtherSecuredLocation" "School" "GovernmentLocation" "FarmRanchEstate" "ReligiousInstitution" "GolfCourseResortPark" "DistributionCenter" "Auction" Valid locations are Residence, BusinessWithLoadingDockOrForklift, BusinessWithoutLoadingDockOrForklift, ConstructionSite, TradeShowOrConvention, Port, StorageFacility, MilitaryBase, Airport, OtherSecuredLocation, School, GovernmentLocation, FarmRanchEstate, ReligiousInstitution, GolfCourseResortPark, DistributionCenter, or Auction |
| destinationAddress | string <= 255 characters The address for the delivery location |
| destinationAddress2 | string <= 255 characters Additional address detail field for the delivery address |
| destinationState | string <= 255 characters The state of the delivery location |
| destinationCity | string <= 255 characters The city for the delivery location |
| destinationPostalCode | string <= 20 characters The zip code for the delivery location |
object (PostRedirectRequestModelDestinationContact) | |
| originLocationType | string (PostRedirectRequestModelDestinationLocationType) Enum: "Residence" "BusinessWithLoadingDockOrForklift" "BusinessWithoutLoadingDockOrForklift" "ConstructionSite" "TradeShowOrConvention" "Port" "StorageFacility" "MilitaryBase" "Airport" "OtherSecuredLocation" "School" "GovernmentLocation" "FarmRanchEstate" "ReligiousInstitution" "GolfCourseResortPark" "DistributionCenter" "Auction" Valid locations are Residence, BusinessWithLoadingDockOrForklift, BusinessWithoutLoadingDockOrForklift, ConstructionSite, TradeShowOrConvention, Port, StorageFacility, MilitaryBase, Airport, OtherSecuredLocation, School, GovernmentLocation, FarmRanchEstate, ReligiousInstitution, GolfCourseResortPark, DistributionCenter, or Auction |
| originAddress | string <= 255 characters The address for the shipping location |
| originAddress2 | string <= 255 characters Additional address detail field for the shipping address |
| originCity | string <= 255 characters The city for the shipping location |
object (PostRedirectRequestModelDestinationContact) | |
| originPostalCode | string <= 20 characters The zip code for the shipping location |
| originState | string <= 255 characters The state for the shipping location |
| pickupInstructions | string <= 1000 characters Optional information for the driver or carrier regarding pickup, e.g., hours of operation, details on parking, etc. |
| deliveryInstructions | string <= 1000 characters Optional information for the driver or carrier regarding delivery, e.g., hours of operation, details on parking, etc. |
| quoteRequestAccessorials | Array of strings Items Enum: "PickupLiftgateRequired" "PickupInside" "DeliveryLiftgateRequired" "DeliveryInside" "DeliveryAppointmentRequired" "DeliveryCallAhead" "ProtectFromFreezing" "SortAndSegregate" "BlindShipmentCoordination" Selected checkboxes for pickup, delivery and additional options. Valid options are: PickupLiftgateRequired, PickupInside, DeliveryLiftgateRequired, DeliveryInside, DeliveryAppointmentRequired, DeliveryCallAhead, ProtectFromFreezing, SortAndSegregate, BlindShipmentCoordination |
| page | string Enum: "freightInfo" "rates" Opt to redirect requests to the freight information page or directly to the rates page if all required fields are supplied |
Array of objects | |
Array of objects (PostRedirectRequestModelItemsItem) |
{- "commodity": "NewCommercialGoods",
- "title": "string",
- "referrer": "string",
- "earliestPickupDate": "string",
- "latestPickupDate": "string",
- "destinationLocationType": "Residence",
- "destinationAddress": "string",
- "destinationAddress2": "string",
- "destinationState": "string",
- "destinationCity": "string",
- "destinationPostalCode": "string",
- "destinationContact": {
- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "companyName": "string",
- "email": "string"
}, - "originLocationType": "Residence",
- "originAddress": "string",
- "originAddress2": "string",
- "originCity": "string",
- "originContact": {
- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "companyName": "string",
- "email": "string"
}, - "originPostalCode": "string",
- "originState": "string",
- "pickupInstructions": "string",
- "deliveryInstructions": "string",
- "quoteRequestAccessorials": [
- "PickupLiftgateRequired"
], - "page": "freightInfo",
- "referenceNumbers": [
- {
- "number": "string",
- "type": "Pickup"
}
], - "items": [
- {
- "quantity": 0,
- "width": 0,
- "length": 0,
- "weight": 0,
- "handlingUnit": "None",
- "title": "string",
- "height": 0,
- "description": "string",
- "listingContents": [
- {
- "quantity": 0,
- "description": "string",
- "handlingUnit": "None"
}
]
}
]
}{ }Allows integrator to retrieve data on shipments booked, including bolID
| startDateTime required | string Report start date in IS0-8601 format |
| endDateTime required | string Report end date in IS0-8601 format |
| x-uship-affiliate-id required | string Your uShip Affiliate ID provided by uShip. Ensures all P44 customizations are preserved. |
{- "count": 0,
- "items": [
- {
- "bolNumber": 0,
- "carrier": {
- "displayName": "string"
}, - "deliveryAddress": {
- "streetAddress": "string"
}, - "deliveryContact": {
- "phone": "string",
- "name": "string",
- "email": "user@example.com"
}, - "estimatedDeliveryDate": "string",
- "finalCost": 0,
- "id": 0,
- "items": [
- {
- "count": 0,
- "title": "string"
}
], - "listingStatus": {
- "status": "Booked"
}, - "orginalCost": 0,
- "pickupId": "string",
- "proNumber": "string",
- "referenceNumbers": [
- {
- "number": "string",
- "type": "Pickup"
}
], - "title": "string",
- "transitStatus": {
- "status": "ReadyForDispatch"
}
}
]
}