ROADIE

Overview

Roadie is a crowdsourced delivery platform that enables local same-day delivery of just about anything, anywhere in the United States.

Onboarding of a Roadie Carrier Account

To onboard an Roadie carrier account with Roadie, the following pre-requisite is required:

Security Credential Password

The onboarding process involves making an API request that includes all necessary details for account setup. Below is a sample API request.

Roadie Sample Request

Copy

Copied

{
   "description": "Roadie"
   "carrierAccountId": "2bYbb4BJrgj6RYX",
   "carrierAccounts": [
    {
      "parameters": [
        {
          "name": "USER_PASSWORD",
          "value": "70648d01fcb90bae08e2be4f2b95ab1dbfd8520b"
        }
      ]
    }
  ]
}

Roadie Sample Response

Copy

Copied

{
    "carrierAccountID": "2bYbb4BJrgj6RYX",
    "description": "Roadie",
    "carrierID": "Roadie",
    "parameters": {
          "name": "USER_PASSWORD",
          "value": "70648d01fcb90bae08e2be4f2b95ab1dbfd8520b"
        },
    "carrierAccountType": "Shipping",
    "provisioningType": "API"
}

API Operations for Shipping with Roadie

The APIs integrate with roadie through the following operations:

Operations	Method	Resource Path
Retrieve Country List	GET	/api/v1/countries
Get Carrier Account	GET	/api/v1/carrierAccounts
Get Services	GET	/api/v1/services
Get Parcel Types	GET	/api/v1/parcelTypes
Get Special Services	GET	/api/v1/specialServices
Create a Shipping Label	POST	/api/v1/shipments
Void a Label	PUT	/api/v1/shipments/{{shipmentId}}/cancel
Reprint a Label	GET	/api/v1/shipments/{{shipmentId}}/reprint
Get Tracking Information	GET	/api/v1/tracking/{{trackingNumber}}

Metadata

Metadata provides information about roadie carrier services, including origin and destination countries, supported carrier services, supported package types, and supported special services. Users can select specific origin and destination countries from the provided dropdown menu to dynamically view relevant metadata specific to those countries.

Metadata information not available