Overview

Documents are generated by Rose Rocket for object modules. They can also be material uploaded to Rose Rocket for specific uses. See the list below for information as well as any additional connections.

Order, also requires Bill of lading
Manifest, also requires Rate confirmation
Bills
Invoices
Pay stubs

System-generated documents use the ID value of the object for that document type. To reference these, the request must have the correct ID in the document.

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

Fields	Label	Type	Description
id	ID	string	Global unique identifier
objectKey	Object Key	string, enumerated	Document object key, valid values: `manifest`, `order`, `bill`, `invoice`, `payStub`, `presignedUrl`
fileName	File Name	string	Name of file
mimeType	Mime Type	string	Mime type of file
description	Description	string	Document description
url	Url	string	Document URL
isDeletable	Is Deletable	Boolean	Status if document is deletable
isSystemGenerated	Is System Generated	Boolean	Status of document as generated by system
documentType	Document Type	string, enumerated	Document type information, valid values: `ace`, `aci`, `billOfLading`, `commercialInvoice`, `complianceWSIP`, `complianceDriver`, `complianceAuto`, `complianceCargo`, `labels`, `bill`, `invoice`, `offloadManifest`, `preloadManifest`, `paps`, `payStub`, `proofOfPickup`, `proofOfDelivery`, `quoteSheet`, `rateConfirmation`, `ucc128`, `other`