Arrive Logistics Logo
Documentation Powered by ReDoc

Arrive API (2.0.0)

Download OpenAPI specification:Download

Introduction

This document describes the authentication, request, and response for the Arrive APIs. It includes the Rate API (customer rating and quoting) and Carrier API (e.g. Load Search). All endpoints require Bearer token authentication via Okta; contact Arrive support at apisupport@arrivelogistics.com for access.

Authentication

bearerAuth

Arrive uses Okta for authentication. Please contact Arrive support at apisupport@arrivelogistics.com .

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

Customer Rating

Rate and quote APIs for customer rating.

GetRates

Authentication

This endpoint requires Bearer token authentication (Okta). Include the token in the Authorization header as Bearer <token>.

Required Fields

  • Identifier
  • CustomerQuoteID
  • EquipmentType
  • Lane:
    • Stop (Origin):
      • City And State, Or Postal Code
      • CountryCode2
      • StopDateTime
      • StopType (Pickup)
    • Stop (Destination):
      • City And State, Or Postal Code
      • CountryCode2
      • StopDateTime
      • StopType (Delivery)
Authorizations:
bearerAuth
Request Body schema: application/json

Rate request body object

Identifier
required
string

The identifier of the Customer

CustomerQuoteId
required
string

The value assigned by the customer for the current quote request

OrderValue
number or null <decimal>

Customer-assigned value of the Load in US dollars. (** OrderValue will be default to "$100,000" if provided as Null. Please exclude "$" in OrderValue.**)

Weight
number or null <decimal>

Total weight of the Load. (** Weight will be defaulted to "45,000" if provided as Null**)

WeightUnit
string or null
Enum: "Pounds" "Kilograms"

Unit of measure for weight parameters. (** WeightUnit will default to "Pounds" if provided as Null**)

TotalLoadMiles
string

The load miles of the Load assigned by the customer

EquipmentLength
string

Lenght of the equpment needed for the load

EquipmentType
required
string
Enum: "V" "R"

Identifies the type of equipment type needed for the Load.

IsHazmat
boolean or null

Indicates if the item is hazmat

IsTeamRequired
boolean or null

Indicates if a Team is required not

TemperatureRequirements
string or null
Enum: "Deep Frozen" "Frozen" "Chilled" "Refrigerated"

Indicates if temperature control is needed, and at what level. Deep Frozen (-20 to -10 degrees) - Frozen (-10 to 0 degrees) - Chilled (0 to 30 degrees) - Refrigerated (30 to 90 degrees). Required if isProtectFromFreezeRequired or isProtectFromMeltRequired is True

TemperatureUnit
string or null
Enum: "F" "C"

Unit of measure for temperature parameters. (** TemperatureUnit will be defaulted to "F" if provided as Null**)

required
Array of objects (Stop) >= 2 items

Lane is described by a minimum number of stops (being first the origin and last the destination)

object

Aditional properties. (** All Boolean Load Properties will be defaulted to False if provided as Null**)

Responses

Response Schema: application/json
One of
Errors
object
Message
string
object (Rates)

Request samples

Content type
application/json
{
  • "identifier": "CUSTOMER",
  • "customerQuoteId": "21154545AZ-ASD3",
  • "orderValue": 100000,
  • "weight": 45000,
  • "weightUnit": "Pounds",
  • "totalLoadMiles": 2500,
  • "equipmentType": "V",
  • "isHazmat": true,
  • "isTeamRequired": true,
  • "equipmentLength": 53,
  • "temperatureRequirements": "Frozen",
  • "temperatureUnit": "F",
  • "lane": [
    ],
  • "isSealRequired": true,
  • "isPermitRequired": true,
  • "isTankerEndorsement": true,
  • "isFoodGrade": true,
  • "isPlateTrailerRequired": true,
  • "isPalletExchange": true,
  • "isProtectFromFreezeRequired": true,
  • "isProtectFromMeltRequired": true,
  • "isBonded": true,
  • "tailgateRequired": true,
  • "customsBroker": true,
  • "chainsRequired": true,
  • "tarpsRequired": true,
  • "loadBarsRequired": true,
  • "strapsRequired": true,
  • "sideKitsRequired": true,
  • "blanketsRequired": true,
  • "eTrackRequired": true,
  • "isAirRide": true,
  • "floorRequirement": "METAL",
  • "isBlockingBracingRequired": true,
  • "isRollDoorsRequired": true
}

Response samples

Content type
application/json
{
  • "Errors": null,
  • "Message": null,
  • "Result": {
    }
}

Carrier - AvailableLoads

Carrier-facing APIs including load search.

Search

Authentication

This endpoint requires Bearer token authentication (Okta). Include the token in the Authorization header as Bearer <token>.

Overview

Search for loads by origin, destination, equipment type, and mode. Origin and destination support location (city/state), deadhead radius, and appointment windows (ISO 8601).

Authorizations:
bearerAuth
Request Body schema: application/json
required
object (Location)

A location (city/state) with deadhead radius and optional appointment window.

object (Location)

A location (city/state) with deadhead radius and optional appointment window.

EquipmentType
required
string
Enum: "V" "R" "F"

Type of equipment required for the load.

Mode
required
string
Value: "TL"

Mode of transport..

required
object

Pagination for the search results.

Responses

Response Schema: application/json
Array of objects (Load)
TotalRecordCount
integer

Total number of items available.

Request samples

Content type
application/json
{
  • "Origin": {
    },
  • "Destination": {
    },
  • "EquipmentType": "V",
  • "Mode": "TL",
  • "Pagination": {
    }
}

Response samples

Content type
application/json
{
  • "Results": [
    ],
  • "TotalRecordCount": 1
}