Creates a miscellaneous postal report, such as PS3606-D.
This request generates a PS3606-D report without a presort.
This request generates a PS3606-D report with a presort. Note that all pieces must be of identical weight and postage.
{
"$schema":"http://json-schema.org/draft-04/schema#",
"title":"Misc Postal Form Request",
"type":"object",
"properties":{
"addressTable":{
"title":"Address Table",
"description":"Group of records used for processing.",
"type":"string",
"pattern":"(?i)^([0-9]{10}|name\\$.+|file\\$[a-z]+)$"
},
"duplicateCopy":{
"title":"Duplicate Copy",
"description":"Checks the 'Duplicate Copy' check box on the form.",
"default":false,
"type":"boolean"
},
"fileName":{
"title":"File Name",
"description":"Path and filename for form output to disk file.",
"default":"",
"type":"string"
},
"fileType":{
"title":"File Type",
"description":"File type for form output to disk file.",
"default":"",
"type":"string",
"enum":[
"PDF"
],
"enumValues":[
{
"value":"PDF",
"displayValue":"PDF",
"description":"PDF"
}
]
},
"form":{
"title":"Form",
"description":"Misc Postal Form.",
"default":"",
"type":"string",
"enum":[
"PS3606D"
],
"enumValues":[
{
"value":"PS3606D",
"displayValue":"PS3606D",
"description":"PS3606D"
}
]
},
"identicalWtPieces":{
"title":"identicalWtPieces",
"description":"Number of identical weight peices.",
"default":0,
"type":"integer",
"minimum":1
},
"mailClass":{
"title":"Mail Class",
"description":"The Postal Service divides mail into different services, called 'classes.' Each class of mail has different features, service levels, postage prices, and presort requirements.",
"type":"string",
"enum":[
"FIRST",
"PERIOD",
"STANDARD",
"PARCELPOST",
"BOUNDPRINTED",
"LIBRARYMAIL",
"MEDIAMAIL",
"PSLIGHTWEIGHT",
"PRIORITY"
],
"enumValues":[
{
"value":"FIRST",
"displayValue":"First-Class",
"description":"Sorts pieces as First-Class Mail. This class consists of stamped cards, postcards, letters, and sealed parcels weighing 13 ounces or less. Personal correspondence, including bills and statements of account, must be mailed in this class. The minimum for a First-Class mailing is 500 pieces."
},
{
"value":"PERIOD",
"displayValue":"Periodical",
"description":"Consists of newspapers, magazines, and other publications issued regularly (at least 4 times per year). All periodical publications must be authorized by the USPS."
},
{
"value":"STANDARD",
"displayValue":"Standard",
"description":"Standard Mail is mail matter not required to be mailed as First-Class Mail or Periodicals. Lower nonprofit prices are available for Standard Mail but require specific authorization."
},
{
"value":"PARCELPOST",
"displayValue":"Parcel Select",
"description":"Mail class used for ground delivery service at very low rates for large or heavy packages."
},
{
"value":"BOUNDPRINTED",
"displayValue":"Bound Printed Matter",
"description":"Consist of advertising, promotional, directory, or editorial material (or any combination of such material)."
},
{
"value":"LIBRARYMAIL",
"displayValue":"Library Mail",
"description":"Mail class used by qualifying institutions like libraries, universities, zoos, and research institutions to mail educational and research material."
},
{
"value":"MEDIAMAIL",
"displayValue":"Media Mail",
"description":"Mail class used for books (at least eight pages), film, printed music, printed test materials, sound recordings, etc. "
},
{
"value":"PSLIGHTWEIGHT",
"displayValue":"Parcel Select Lightweight",
"description":"Mail class used for packages weighing less than 1 lb. and used for order fulfillment."
},
{
"value":"PRIORITY",
"displayValue":"Priority",
"description":"First-Class Mail with expedited delivery."
}
]
},
"permit":{
"title":"Permit",
"description":"Selects the permit used for the mailing. The 10-digit Permit ID or the Permit Description may be used.",
"default":"",
"type":"string",
"pattern":"((?i)^([0-9]{10}|name\\$.+)$|^$)"
},
"piecesPerPound":{
"title":"piecesPerPound",
"description":"Number of pieces to the pound.",
"default":0,
"type":"number",
"minimum":0
},
"postagePerMailpiece":{
"title":"postagePerMailpiece",
"description":"Postage for each mailpiece.",
"default":0,
"type":"number",
"minimum":0
},
"presortName":{
"title":"Presort Name",
"description":"Description of the saved presort file.",
"default":"",
"type":"string"
},
"totalPostage":{
"title":"totalPostage",
"description":"Total postage paid for mailpieces.",
"default":0,
"type":"number",
"minimum":0
},
"totalPounds":{
"title":"totalPounds",
"description":"Total number of pounds.",
"default":0,
"type":"number",
"minimum":0
}
},
"required":[
"duplicateCopy",
"fileName",
"fileType",
"form"
],
"oneOf":[
{
"required":[
"addressTable",
"presortName"
]
},
{
"required":[
"identicalWtPieces",
"mailClass",
"permit",
"piecesPerPound",
"postagePerMailpiece",
"totalPostage",
"totalPounds"
]
}
],
"additionalProperties": false
}
