About Document
PDF documents submitted when creating a job can be reused for other jobs.
User can upload their document multiple times but it is advisable to upload the document once and then reuse the existing document and map that document in your API, this act will save a lot of time and effort in making multiple API requests for document upload.
Important
Please note document upload is a sequence of multiple API calls you need to run when you want to upload a new document.
Document Attribute
Document could have the following attributes
Key | Type | Length | Description |
---|---|---|---|
DocumentHash | String | 150 | An unique Hash for the document. |
CreatedDate | Datetime | 150 | Date and time of document creation. |
LastModified | Datetime | 150 | Date and time of document modification. |
ShipperHash | String | 150 | An unique Hash for the shipper. |
FileHash | String | 150 | Unique ID of file known as FileHash. |
FileName | String | 150 | Original Filename of the document. |
Tags | String | 150 | You can add multiple tags to your document, tags are separated by comma "," |
Description | String | 150 | Detailed description about the Document. |
Path | String | 150 | File system path of document. |
PageCount | Number | 1 | Tell the total no of pages of a document. |
DocSize | Float | 150 | Two floating point value, tell the size of a document in ounces. |
DocType | String | 150 | Type of document. |
IsEncrypted | Boolean | false | Return true if a document is set to encrypted. |
Status | String | 150 | Give the status of your document whether it is ready to use or not. |
Weight | Float | NA | Two floating point value, for weight in ounces. |
DocumentName | String | 150 | Name of your Document (Document Title). |
DocInfo | Object | NA | Detailed information about the document, please ref to following table for more details. |
Category | String | 150 | Document Category. |
UniqueDocumentId | String | 150 | Unique Document ID is separated by '-' |
DocInfo object details
Key | Type | Default/Length | Description |
---|---|---|---|
Dimension | String | 150 | Length * Width |
Pages | Number | 1 | Number of pages exist in particular document. |