Schedule a freight pickup / dispatch. In response the carrier will supply a confirmation number and possibly a PRO number as well. If a confirmation number is not returned but the request succeeded the user will need to follow up with the carrier directly to ensure that they received the request. If a PRO number is not returned then one will be assigned by the carrier at the time of pickup. Additionally some carriers might not support specifying a delivery date for pickup requests. If that is the case the user will again need to coordinate that directly with the carrier.
Pickup requests differ from quotes in that they require more specificity in terms of addresses and shipment details. The accessorials supplied in a pickup request pertain to the pickup itself - lift gate, etc... The quote is where the shipment-related accessorials are specified - i.e. what is required to transport and deliver the shipment.
In order to send test pickup requests you can set carrier.test = true
, however if a carrier does not support that functionality it is up to the integration app to handle that flag appropriately by returning an error to the user explaining it's not supported instead of scheduling a pickup with the carrier.
OK
Bad Request
Too Many Requests
Internal Server Error
External Server Error
{- "transaction_id": "string",
- "scac": "string",
- "auth": { },
- "service_level": {
- "code": "string"
}, - "pickup": {
- "date": "2019-08-24",
- "earliest_time": "14:15:22Z",
- "latest_time": "14:15:22Z",
- "closing_time": "14:15:22Z"
}, - "delivery": {
- "date": "2019-08-24"
}, - "containers": [
- {
- "code": "string",
- "freight_class": 50,
- "nmfc_code": "string",
- "description": "Windows",
- "dimensions": {
- "width": 0,
- "height": 0,
- "length": 0,
- "unit": "inches"
}, - "weight": {
- "value": 0,
- "unit": "grams"
}, - "quantity": 0,
- "stackable": true,
- "hazardous_materials": true
}
], - "accessorials": [
- {
- "code": "string",
- "attributes": { }
}
], - "reference_identifiers": [
- {
- "type": "bill_of_lading",
- "value": "string"
}
], - "ship_from": {
- "address": {
- "company_name": "string",
- "address_lines": [
- "string"
], - "city_locality": "string",
- "state_province": "string",
- "postal_code": "string",
- "country_code": "string",
- "residential": false
}, - "contact": {
- "name": "string",
- "phone_number": "string",
- "email": "string"
}
}, - "ship_to": {
- "address": {
- "company_name": "string",
- "address_lines": [
- "string"
], - "city_locality": "string",
- "state_province": "string",
- "postal_code": "string",
- "country_code": "string",
- "residential": false
}, - "contact": {
- "name": "string",
- "phone_number": "string",
- "email": "string"
}
}, - "bill_to": {
- "type": "consignee",
- "payment_terms": "collect",
- "account": "string",
- "address": {
- "company_name": "string",
- "address_lines": [
- "string"
], - "city_locality": "string",
- "state_province": "string",
- "postal_code": "string",
- "country_code": "string",
- "residential": false
}, - "contact": {
- "name": "string",
- "phone_number": "string",
- "email": "string"
}
}, - "requested_by": {
- "company_name": "string",
- "contact": {
- "name": "string",
- "phone_number": "string",
- "email": "string"
}
}, - "carrier": {
- "instructions": "string",
- "test": false
}
}
{- "transaction_id": "string",
- "scac": "string",
- "confirmation_number": "string",
- "pro_number": "string",
- "message": "string",
- "warnings": [
- {
- "external_code": "string",
- "message": "string"
}
]
}