Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Roadsync loads API

The loads API from Roadsync — 2 operation(s) for loads.

Roadsync loads API is one of 18 APIs that Roadsync publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include loads. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 2 paths, and defines 21 schemas. It is described by OpenAPI 3.0.1, at version 1.8.45.

Requests are made against a single base URL, https://client-api.staging.roadsync.com/{basePath}.

3 operations 2 paths 21 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.8.45
Base URL
https://api.roadsync.app/rspay/v1
Authentication
API Key, HTTP Bearer
License
Copyright (c) 2020, RoadSync Inc.
Resource Areas
1

Authentication & Security 2

Roadsync loads API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (api_key). It accepts HTTP bearer tokens (JWT) (session_token). By default, every request must be authenticated.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

loads 3
GET
/loads
Get a List of All Loads
get-loads 3 params → 200
POST
/loads
Create a Load
post-loads 1 param body → 201400409
GET
/loads/{load_id}
Get a single Load
get-load 2 params → 200

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are load (8 properties), payeeShort (3 properties). Each schema is shown below with its type and property counts.

id
integer
The id number of the object being returned.
payeeId
integer
The unique identifier of the Payee who will receive the funds. It could be a Carrier or a Factoring Company.
mcNumber
string
Motor Carrier Number is a a nine-digit identifier assigned by the FMCSA to moving companies operating in interstate commerce. If inserted, it will be validated.
isFactoringCompany
boolean
Send "true" if this Payee is a Factoring Company, "false" otherwise.
amount
number
Money in USD to transfer or has been transferred.
externalId
string
A unique identifier you have for the item.
updatedDatetime
string
Indicates the last time the entity was updated in ISO 8601 format.
paymentTarget
A valid Payee payment target.
paymentMethod
The method used to settle a payable.
availablePaymentTypes
array
A list of the availablepayment methods a Payee is able to receive. Possible values are PAPERCHECK, ACH, RTP
createdDatetime
string
Indicates the datetime when the object was created in ISO 8601 format.
payableId
integer
The Payable's ID
payeeShort
object
Details of the Payee receiving the funds. It could be a Carrier or Factoring Company.
3 properties
loadId
integer
The Load's ID
brokerId
integer
The identifier of a Broker to which the Payee will be assigned or has already been assigned.
payeeName
string
The name of the Carrier or Factoring Company.
dotNumber
string
U.S. Department of Transportation Number is an up to ten-digit assigned by the FMCSA to moving companies operating in interstate commerce. If inserted, it will…
load
object
8 properties
status
The current status of the payable. UNKNOWN is returned when the status value is not recognized.
loadNumber
string
The Load Number
isVerified
boolean
A verified Payee is visible to all brokers in the RoadSync Pay environment. Some partners are allowed to verify a Payee by setting the isverified flag to true…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

roadsync-loads-api-openapi.yml Raw ↑

Other APIs Roadsync publishes across the network.

Roadsync authenticated API
Roadsync brokers API
Roadsync department API
Roadsync directory API
Roadsync eta API
Roadsync funding sources API
Roadsync invoice API
Roadsync location API
Roadsync payables API
Roadsync payees API
Roadsync payment API
Roadsync ping API