Customer
Overview
A customer object within Rose Rocket represents various entities in logistics organizations. These entities may include shippers, receivers, brokers, or other organizations involved in the supply chain.
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 customer objects.
Fields | Label | DataType | Description |
---|---|---|---|
id | Customer ID | string | Unique identifier for the customer. |
fullID | Auto-Generated Customer ID | string | An auto-generated identifier for the customer record. |
name | Customer Name | string | Customer name or the associated company name. |
status | Status | string, enumerated | Status of the Customer, valid values:active inactive |
customerType | Customer Type | string, enumerated | The type associated with the Customer, valid values: Shipper , Broker , Receiver , Other |
companyEmail | Company Email ID | string | Email address associated with the Customer |
companyPhone | Company Contact | string | Phone number associated with the Customer |
busHoursMonStartAt | Business Hours Monday Start At | number | The time the business opens on Mondays, measured in seconds from midnight |
busHoursMonEndAt | Business Hours Monday End At | number | The time the business closes on Mondays, measured in seconds from midnight |
busHoursTuesStartAt | Business Hours Tuesday Start At | number | The time the business opens on Tuesdays, measured in seconds from midnight |
busHoursTuesEndAt | Business Hours Tuesday End At | number | The time the business closes on Tuesdays, measured in seconds from midnight |
busHoursWedStartAt | Business Hours Wednesday Start At | number | The time the business opens on Wednesdays, measured in seconds from midnight |
busHoursWedEndAt | Business Hours Wednesday End At | number | The time the business closes on Wednesdays, measured in seconds from midnight |
busHoursThursStartAt | Business Hours Thursday Start At | number | The time the business opens on Thursdays, measured in seconds from midnight |
busHoursThursEndAt | Business Hours Thursday End At | number | The time the business opens on Thursdays, measured in seconds from midnight |
busHoursFriStartAt | Business Hours Friday Start At | number | The time the business opens on Fridays, measured in seconds from midnight |
busHoursFriEndAt | Business Hours Friday End At | number | The time the business closes on Fridays, measured in seconds from midnight |
busHoursSatStartAt | Business Hours Saturday Start At | number | The time the business opens on Saturdays, measured in seconds from midnight |
busHoursSatEndAt | Business Hours Saturday End At | number | The time the business closes on Saturdays, measured in seconds from midnight |
busHoursSunStartAt | Business Hours Sunday Start At | number | The time the business opens on Sundays, measured in seconds from midnight |
busHoursSunEndAt | Business Hours Saturday End At | number | The time the business closes on Sundays, measured in seconds from midnight |
contacts | Contacts | Contact connected object *See Connected object section` | A list of contacts associated with the customer |
locations | Locations | Locations connected object *See Connected object section | Locations at which the customer operates |
defaultOrderNotes | Default order notes | String | Default notes or comments associated with the customer’s profile. |
defaultTags | Tags | Tags connected object *See Connected object section | Tags associated with the customer. |
classicAccessorials | Accessorials | accessorials | Accessorials that belong to the customer. |
documents | Documents | Documents connected object *See Connected object section | Documents specific to the customer. |
commissionedUsers | Commissioned users | User connected object *See Connected object section | Users who receiving commission from revenue generated from this customer |
Updated 26 days ago