Overview

Manage key partner and carrier information for your processes.

Partners, also known as carriers, are third parties responsible for pickup and delivery of goods. In Rose Rocket, you can manage and organize partner information to help streamline your business operations.

The partner object contains all of the information from within the user interface on the Rose Rocket platform. Add and modify basic details as well as include identifiers populated from the Federal Motor Carrier Safety Administration (FMCSA) database integrated within the platform.

In Rose Rocket, the partner object also has functionality for documents, contacts, and compliance information. These are also connected objects and aren’t shared across other modules. View the list below for examples of these.

Documents - contracts
Contacts - dispatchers, customer service representatives (CSRs)
Compliance - includes encompass insurance, license details with expiration dates

API configuration

When using the API to make requests, see the pages below for the process. These guides walk through the requirements and setup to access the Rose Rocket API with your application.

Authentication - Access Rose Rocket with OAuth 2.0
Object operations - Configure your requests

Object structure

Use the table below for information about the partner objects.

Fields	Label	Type	Description
`name`	Name	string	Partner name
`fullId`	Full ID	string	Human-readable identifier for partner
`logoUrl`	Logo URL	string	Optional logo URL for partner
`contacts`	Contacts	Contact connected object array *See Connected object section	People in partners organization
`address`	Address	Address connected object *See Connected object section	Partner address
`defaultCurrency`	Default currency	string	Partner default currency
`compliances`	Compliances	Compliance connected object array *See Connected object section	Government-issued compliance identifiers, MCDID and DOT
`status`	Status	string, enumerated	Partner active status
`shortCode`	Short code	string	Partner short code
`remitToAddress`	Remittance address	Address connected object *See Connected object section	Address to send remittance
`lanes`	Lanes	Lane connected object array *See Connected object section	Combination of origin and destination zones where partners can operate
`assetTypes`	Asset types	AssetType connected object array *See Connected object section	Partner asset types
`serviceTypes`	Service types	PartnerService connected object array *See Connected object section	Partner-supported service types
`officeLocation`	Office location	string	Partner's office location NOTE: This field is derived from the `remitToAddress.city`, and `remitToAddress.state` attributes. *See Read-only fields.
`primaryContactEmail`	Primary contact email	string	Partner primary email NOTE: This field is derived from the `firstContact`, and `email` attributes in the `contacts` array. *See Read-only fields.
`primaryContactPhone`	Primary contact phone number	string	Partner primary phone number NOTE: This field is derived from the `firstContact`, and `phoneNumber` attributes in the `contacts` array. *See Read-only fields.
`dotId`	Department of Transportation ID	string	Department of Transportation ID for partner
`mcId`	MC ID (Motor Carrier Number)	string	Unique identifier assigned by Federal Motor Carrier Safety Administration (FMCSA)
`mapMarkers`	Map markers	string	Partner address map markers using latitude and longitude NOTE: This field is derived from the `id`, `name`, `address.latitude`, `address.longitude`, and `address.formattedAddress` attributes. *See Read-only fields.
`companyEmail`	Company email	string	Partner company email
`companyPhone`	Company phone number	string	Partner company phone number
`provincialAuthorityNum`	Provincial authority number	string	Partner company Authority Number
`documents`	Documents	Document connected object array *See Connected object section	Partner-associated documents