Overview

The Address object represents physical addresses and is linked to other objects within the Rose Rocket platform.

For example, in the Stop object, the Address is utilized as the stop’s physical address. The Address object will continue to be used in future objects whenever a physical address is needed.

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 address objects.

Object Key Name: address

Fields	Label	DataType	Description
`id`	Address ID	`String`	Unique identifier of the address. NOTE: Automatically assigned by System
`name`	Auto-Generated Customer ID	`String`	Derived name from formattedAddress to support display in dropdowns. See Read Only section
`addressBookId`	Address Book	`String`	Identifies the address book to which this address belongs.
`companyName`	Company name	`String`	Specifies the name of the company associated with the address.
`address1`	Address line 1	`String`	Indicates the primary street address for the location, such as street number and name.
`address2`	Address line 2	`String`	Indicates additional address details, such as suite or apartment number.
`city`	City	`String`	Specifies the city where the pickup or delivery location is situated.
`state`	State / Province	`String`	Specifies the state or province of the address.
`stateCode`	State Code	`String`	Provides the abbreviated code for the state or province.
`country`	Country	`String`	Specifies the country of the address.
`countryCode`	Country Code	`String`	Specifies the official country code.
`postalCode`	ZIP / Postal code	`String`	Specifies the postal code for the address’s area.
`latitude`	Latitude	`Number`	Specifies the latitude coordinate of the address.
`longitude`	Longitude	`Number`	Specifies the longitude coordinate of the address.
`googlePlaceId`	Google Place ID	`String`	Specifies the Google Place ID associated with the address.
`timezone`	Timezone	`String`	Specifies the timezone of the address.
`hoursStartAt`	Hours Start At	`Number`	The time of day that the location opens, measured in seconds from midnight.
`hoursEndAt`	Hours End At	`Number`	The time of day that the location closes, measured in seconds from midnight.
`contactName`	Contact Name	`String`	Specifies the contact name associated with the address.
`phoneNumber`	Phone Number	`String`	Specifies the phone number associated with the address.
`phoneExtension`	Phone Extension	`String`	Specifies the phone extension associated with the address.
`email`	Email	`String`	Specifies the email associated with the address.