Loads

9 endpoints.

Paths are relative to the base URL for your environment. Unless marked otherwise, every request needs an Authorization: Bearer header.

POST/loads

Create Load

Response fields

Asserted by the API’s own test suite.

successloadIdload

GET/loads/user

Get User Loads

Response fields

Asserted by the API’s own test suite.

successloads

GET/loads/{load_id}

Get Load by ID

Path parameters

{load_id} — required

Response fields

Asserted by the API’s own test suite.

successload

PUT/loads/{load_id}

Update Load (PUT)

Path parameters

{load_id} — required

Response fields

Asserted by the API’s own test suite.

successloadIdload

PATCH/loads/{load_id}

Patch Load

Path parameters

{load_id} — required

Request body

json

{
  "rate": 2700
}

Response fields

Asserted by the API’s own test suite.

successload

GET/loads/{load_id}/documents

Get Load Documents

Path parameters

{load_id} — required

POST/loads/{load_id}/generate-invoice

Generate Invoice

Path parameters

{load_id} — required

Response fields

Asserted by the API’s own test suite.

successinvoiceNumberstoragePathpaymentDueDate

POST/loads/{load_id}/generate-settlement

Generate Settlement

Path parameters

{load_id} — required

Response fields

Asserted by the API’s own test suite.

successstoragePathsettlementDate

DELETE/loads/{load_id}

Delete Load

Path parameters

{load_id} — required

Response fields

Asserted by the API’s own test suite.

success