Overview

Documents are important items in your Rose Rocket workflow. Documents contain reference information to share throughout the logistics process. These can be uploaded through the platform user interface as well as through the driver mobile app.

In the Rose Rocket user interface, you can view the document on the platform as well as download a PDF. You can download the documents in these formats for your reference.

About Documents in Rose Rocket

Rose Rocket has both system-generated documents and support for uploading user documents.

Documents generated by Rose Rocket

Generated documents are based on Rose Rocket objects and the object’s ID value. All generated documents are based on and connected to the parent object module.

Rose Rocket generates documents for each of the object modules. These files are visible within the UI and also available to download through the API. Documents are based on Rose Rocket objects in the list below.

Manifests*
Orders
Bills
Quotes
Invoices
Pay stubs

*NOTE: Manifests also provides JSON formatting.

Documents uploaded by users

Uploaded documents are from users sharing documents through the Rose Rocket platform. These contained the presignedUrl value in the externalUrl field for all responses.

Uploading driver documents

Rose Rocket supports document uploads for drivers within your organization. The proofOfPickup and proofOfDropoff documents are typed within Rose Rocket for drivers. These documents are uploaded through the driver mobile application and can be viewed using the API.

Retrieving documents using the Rose Rocket API

All documents in Rose Rocket are available through the object’s ID path. The example URL below works as a strategy to view all of the related documents in a specific object module. Replace the objectId value and view that object’s documents. View the documents in the supported object list below.

Quotes
Orders
Manifests
Customers
Partners
Invoice (Receivables)

https://sample.roserocket.com/api/v2/platformModel/objects/{objectId}?paths=documents.file,documents.externalUrl

The sample response below also contains an array of objects for the available documents. This example invoice has two documents, an uploaded document and a system-generated PDF.

{
    "id": "000ad688-feb4-4752-b7d6-544708a657ff",
    "objectKey": "invoice",
    "orgId": "2c39fa07-b82c-493f-8ec8-996cd0618612",
    ...
    "documents": [
        {
            "id": "b840c00f-88d3-4c81-9644-0b927b1a11dd",
            "objectKey": "document",
            "orgId": "2c39fa07-b82c-493f-8ec8-996cd0618612",
            "source": "manual",
            "file": {
                "id": "86f05eee-8618-4fa9-867c-e1b08afe08ac",
                "objectKey": "file",
                "orgId": "2c39fa07-b82c-493f-8ec8-996cd0618612",
                "source": "manual"
            },
            "externalUrl": "/api/v2/platformModel/documents/presignedUrl/b840c00f-88d3-4c81-9644-0b927b1a11dd"
        },
        {
            "id": "b870dc59-c26e-46cf-a4c8-f1503d1016b5",
            "objectKey": "document",
            "orgId": "2c39fa07-b82c-493f-8ec8-996cd0618612",
            "source": "manual",
            "file": null,
            "externalUrl": "/api/v2/platformModel/documents/invoice/fd8715df-17f4-4c4f-a174-b7155bf639e3/pdf"
        }
    ]
  }

Retrieving uploaded documents

View any specific document, either uploaded or system-generated, using the Rose Rocket API. The file API and the external URL both provide the object document.

File ID

With the endpoint base URL below, use the document ID to replace the {fileId} value in the request. Find the document ID value within the documents array from the Retrieving documents response.

https://sample.roserocket.com/api/v2/platformModel/file/url?fileId={fileId}

The sample response for this method of requesting the document is the JSON information for the presigned URL.

  {
    "presignedUrl": "https://sample-presigned-url-link"
  }

External URL

Use the endpoint below with the externalUrl value from the Retrieving documents response. The field is within the documents array as a key value pair. This sample base URL replaces {externalUrl} with that value.

https://sample.roserocket.com/{externalUrl}

The response results in a download or a loaded web page with the requested document.

Using the Rose Rocket API to request documents

Rose Rocket documents generated from the objects are also available to download through the API. With valid access, use the information below for the configuration to request documents. The information below covers the values for the base URL and specific object requirements. View the base URL below.

https://sample.roserocket.com/api/v2/platformModel/documents/{{object}}/{{objectId}}

Object	URL Path	Description
Manifest	`/manifest/{{manifestId}}/rate_con` `/manifest/{{manifestId}}/rate_con/pdf` `/manifest/{{manifestId}}/rate_con/json`	Manifest documents for HTML, PDF, and JSON formatting NOTE: The rate_con path includes the rate confirmation information for the manifest.
Order	`/order/{{orderId}}/bol` `/order/{{orderId}}/bol/pdf`	Order documents for HTML and PDF NOTE: The bol path includes the bill of lading information for the order.
Bill	`/bill/{{billId}}/html` `/bill/{{billId}}/pdf`	Bill documents for HTML and PDF
Quote	`/quote/{{quoteId}}/html` `/quote/{{quoteId}}/pdf`	Quote documents for HTML and PDF
Invoice	`/invoice/{{invoiceId}}/html` `/invoice/{{invoiceId}}/pdf`	Invoice documents for HTML and PDF
Pay stub	`/payStub/{{payStubId}}/html` `/payStub/{{payStubId}}/pdf`	Pay stub documents for HTML and PDF

Summary

Documents are resources to help you with your transportation logistics. Manage any documents throughout your Rose Rocket organization through both the user interface platform and the API.

Rose Rocket generates documents for your reference when viewing object modules. Both the user interface platform as well as the API are available to view HTML and PDF documents for the objects. In addition, uploaded documents can be typed for your reference to use within your workflow.