Schedule Freight Pickup

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.

SecurityFreightApiCode
Request
Request Body schema: application/json
transaction_id
required
string
scac
required
string

The NMFTA Standard Carrier Alpha Code is used to identify a freight carrier within the transportation industry.

auth
object

The carrier authorization information needed to fulfill this request.

required
object
required
object
object
required
Array of objects (Container)
Array of objects (AccessorialService)

Accessorial services required for pickup

Array of objects
required
object
required
object
required
object (BillingParty)
required
object (RequestingParty)
object
Responses
200

OK

400

Bad Request

429

Too Many Requests

500

Internal Server Error

520

External Server Error

post/schedule-freight-pickup
Request samples
application/json
{
  • "transaction_id": "string",
  • "scac": "string",
  • "auth": { },
  • "service_level": {
    },
  • "pickup": {
    },
  • "delivery": {
    },
  • "containers": [
    ],
  • "accessorials": [
    ],
  • "reference_identifiers": [
    ],
  • "ship_from": {
    },
  • "ship_to": {
    },
  • "bill_to": {
    },
  • "requested_by": {
    },
  • "carrier": {
    }
}
Response samples
application/json
{
  • "transaction_id": "string",
  • "scac": "string",
  • "confirmation_number": "string",
  • "pro_number": "string",
  • "message": "string",
  • "warnings": [
    ]
}