Skip to main content

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

KeyTypeLengthDescription
DocumentHashString150An unique Hash for the document.
CreatedDateDatetime150Date and time of document creation.
LastModifiedDatetime150Date and time of document modification.
ShipperHashString150An unique Hash for the shipper.
FileHashString150Unique ID of file known as FileHash.
FileNameString150Original Filename of the document.
TagsString150You can add multiple tags to your document, tags are separated by comma ","
DescriptionString150Detailed description about the Document.
PathString150File system path of document.
PageCountNumber1Tell the total no of pages of a document.
DocSizeFloat150Two floating point value, tell the size of a document in ounces.
DocTypeString150Type of document.
IsEncryptedBooleanfalseReturn true if a document is set to encrypted.
StatusString150Give the status of your document whether it is ready to use or not.
WeightFloatNATwo floating point value, for weight in ounces.
DocumentNameString150Name of your Document (Document Title).
DocInfoObjectNADetailed information about the document, please ref to following table for more details.
CategoryString150Document Category.
UniqueDocumentIdString150Unique Document ID is separated by '-'

DocInfo object details

KeyTypeDefault/LengthDescription
DimensionString150Length * Width
PagesNumber1Number of pages exist in particular document.