About Job

Learn more about the job

For sending an ePostage you need to create a job first, the final stage of creating an ePostage is known as a job. Sending an ePostage can't be done without this section.

You will require to make some required data available before calling job API. For example, Address ID, recipient ID, etc.

Job Attributes

An object job could have the following attributes.

Key	Type	Length	Description
UniqueJobId	String	150	An Unique Id for every Job
CreatedDate	Datetime	150	Date and time of creation
LastModified	Datetime	150	Date and time of modification
ShipperHash	String	150	Shipper Hash, to map with a particular shipper
TopicHash	String	150	Unique Topic Hash ID, topic is a very interesting feature of DPS, to know more about this please check here
DocumentHashList	Array	150	Array of string, containing the hashes of every document
NotarizedDocumentHash	String	150	NotarizedDocumentHash is required if you want to mail a document and it should be notarized
AttachmentHash	String	150	Optional, you can provide the hash or attachment if you want to attach any attachment to ePostage
ExtraWeight	String	150	Optional, if ePostage have extra weight
ExtraInfo	String	150	Optional, if you want to provide extra information for a particular ePostage
DoubleSided	Boolean	false	Set true if ePostage is double sided
FromName	String	150	Name of sender
FromCompany	String	150	Sender's Company name
FromAddressLine1	String	150	Sender's first line address
FromAddressLine2	String	150	Sender's second line address
FromCity	String	150	Sender's city name
FromState	String	2	Sender's state code only two character
FromZip	String	6	Zip code of sender
FromCountry	String	150	Country name of sender. Note: currently supported United state only.
FromPhone	Number	10	Sender's phone number Note: Do not add any prefix like std or ISD or country code etc just use your 10 digit phone number
Provider	String	150	ePostage provider Note: currently supported USPS only.
PostageType	String	150	Type of your postage for this job, Choices can be 'FC', 'FCSig', 'ERR', 'ERRSig', 'PMAIL', 'PRIL'
Container	String	150	Possible containers for Priority (PMAIL), Express(PRIL), FC, FCSig, ERR and ERRSig mailings are this
DispatchStatus	String	150	Your ePostage dispatch status initially set to draft
IsHazardous	Boolean	150	Declaration if ePostage is containing any hazardous material
HazardousMaterial	String	150	Detailed information of hazardous material, return/set blank if IsHazardous set to false
Weight	Float	0.00	Two floating point value Note: all weights are considered ounces(oz) unit
Unit	String	2	Valid Unit for weight is Lb and Oz (Lb stands for pounds and Oz stands for ounces)
PageCount	Number	5	Total number of pages that exist in a particular ePostage.
Mode	String	150	Mode of ePostage , initially Draft.
IsDocumentVerified	Boolean	false	Return the value in form or boolean, return true if the document is verified.
Color	Boolean	false	Return whether it is a black and white or color ePostage , return false if black & white else return true if colored.
COMType	String	150	This would be the type of selected certificate of mailing.
COMCode	String	150	This is the certificate of mailing short code and valid codes are only COM.
IsCom	Boolean		Confirmation of whether is a COM included or not.
StorageClass	String	150	Type of storage class are 1Year, 2Year and 5Year, default set to "1Year"
ReturnEnvelope	Boolean	false/true	This would be boolean and true if you requested to attach a return envelope otherwise it would be false.
ProviderJobInfo	String	150	Optional
ApiService	String	150	Type of API service, Note: only ePostage is supported
JobHash	String	150	Hash id of that particular job, autogenerated

List of Postage and their valid containers

No	Postage Type	Description	Containers
1	PMAIL	Priority Mail	FLAT RATE ENVELOPE. LEGAL FLAT RATE ENVELOPE. PADDED FLAT RATE ENVELOPE. SM FLAT RATE ENVELOPE. SM FLAT RATE BOX MD FLAT RATE BOX. LG FLAT RATE BOX. REGIONALRATEBOXA. REGIONALRATEBOXB. VARIABLE.
2	PRIL	Priority Express	FLAT RATE ENVELOPE. LEGAL FLAT RATE ENVELOPE. PADDED FLAT RATE ENVELOPE. VARIABLE.
3	FC	First Class Package	VARIABLE
4	FCSig	First Class Package with Signature	VARIABLE
5	ERR	First Class Certified Mail with return Receipt	VARIABLE
6	ERRSig	First Class Certified Mail with Return Signature	VARIABLE
7	Parcel Select	Parcel Select	VARIABLE