{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["carrierMetadata"]},"type":"markdown"},"seo":{"title":"ROADIE","description":"itney Bowes Shipping API, developers can integrate features such as comparing shipping rates from multiple carriers, creating and purchasing shipping labels, tracking packages, scheduling pickups, managing returns, and accessing other shipping features. These APIs also offers a variety of shipping services, including international shipping and multi-carrier rate shopping, which allows developers to choose the best carrier and rate for each shipment.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"roadie","__idx":0},"children":["ROADIE"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Roadie is a crowdsourced delivery platform that enables local same-day delivery of just about anything, anywhere in the United States."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"onboarding-of-a-roadie-carrier-account","__idx":2},"children":["Onboarding of a Roadie Carrier Account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To onboard an Roadie carrier account with Roadie, the following pre-requisite is required:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Security Credential Password"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The onboarding process involves making an API request that includes all necessary details for account setup. Below is a sample API request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"roadie-sample-request","__idx":3},"children":["Roadie Sample Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"{\n   \"description\": \"Roadie\"\n   \"carrierAccountId\": \"2bYbb4BJrgj6RYX\",\n   \"carrierAccounts\": [\n    {\n      \"parameters\": [\n        {\n          \"name\": \"USER_PASSWORD\",\n          \"value\": \"70648d01fcb90bae08e2be4f2b95ab1dbfd8520b\"\n        }\n      ]\n    }\n  ]\n}\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"roadie-sample-response","__idx":4},"children":["Roadie Sample Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"{\n    \"carrierAccountID\": \"2bYbb4BJrgj6RYX\",\n    \"description\": \"Roadie\",\n    \"carrierID\": \"Roadie\",\n    \"parameters\": {\n          \"name\": \"USER_PASSWORD\",\n          \"value\": \"70648d01fcb90bae08e2be4f2b95ab1dbfd8520b\"\n        },\n    \"carrierAccountType\": \"Shipping\",\n    \"provisioningType\": \"API\"\n}\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-operations-for-shipping-with-roadie","__idx":5},"children":["API Operations for Shipping with Roadie"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The APIs integrate with roadie through the following operations:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operations"},"children":["Operations"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resource Path"},"children":["Resource Path"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve Country List"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v1/countries"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get Carrier Account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v1/carrierAccounts"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get Services"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v1/services"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get Parcel Types"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v1/parcelTypes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get Special Services"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v1/specialServices"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a Shipping Label"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v1/shipments"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Void a Label"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PUT"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v1/shipments/{{shipmentId}}/cancel"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reprint a Label"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v1/shipments/{{shipmentId}}/reprint"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get Tracking Information"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v1/tracking/{{trackingNumber}}"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create Multipiece Label"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v1/multipiece/shipments"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reprint Multipiece Label"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v1/multipiece/shipments/{shipmentId}/reprint"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rate Multipiece Shipment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v1/multipiece/rates"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cancel Multipiece Label"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PUT"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v1/multipiece/shipments/{shipmentId}/cancel"]}]}]}]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"metadata","__idx":6},"children":["Metadata"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"CarrierMetadata","attributes":{"carrierID":"ROADIE"},"children":[]}]},"headings":[{"value":"ROADIE","id":"roadie","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Onboarding of a Roadie Carrier Account","id":"onboarding-of-a-roadie-carrier-account","depth":2},{"value":"Roadie Sample Request","id":"roadie-sample-request","depth":5},{"value":"Roadie Sample Response","id":"roadie-sample-response","depth":5},{"value":"API Operations for Shipping with Roadie","id":"api-operations-for-shipping-with-roadie","depth":2},{"value":"Metadata","id":"metadata","depth":2}],"frontmatter":{"title":"Roadie","description":"Roadie carrier description","tocMaxDepth":3,"seo":{"title":"ROADIE"}},"lastModified":"2026-05-15T13:59:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/shipping/carriers/overview/roadie","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}