Integratec API Platform
postageStatement

Description

Creates a USPS Postage Statement from a saved presort.

Remarks

If a postage statement is needed for a portion of the presort, use the subset property. Postage Statements can be generated on a set of (B)undles, (C)ontainers, (P)allets, or (S)treams. The following would include containers 1, 3, 4, 5 and 7:

{
...
"subset": "C1,3-5,7",
...
}

Examples

Request

This request generates a postage statement.

{
"addressTable" : "7112661645",
"presortName" : "Std Flt",
"fileType" : "PDF",
"fileName" : "C:\\PresortOutput\\PostageStatement.PDF"
}

This request generates a postage statement for the first two pallets of the presort.

{
"addressTable" : "7112661645",
"presortName" : "Std Flt",
"fileType" : "PDF",
"fileName" : "C:\\PresortOutput\\PostageStatement.PDF",
"subset" : "P1,2"
}

This request generates a postage statement for each batch of a batch presort.

{
"addressTable" : "7112661645",
"presortName" : "Std Flt Batch",
"fileType" : "PDF",
"fileName" : "C:\\PresortOutput\\PostageStatement - Batch |O.PDF",
"allBatches" : true
}

Reply

The reply for a successful postage statement request.

{
"result" : [
{
"status" : "Job completed.",
"report" : "postageStatement",
"output" : "C:\\PresortOutput\\PostageStatement.PDF"
}
]
}

The reply for a postage statement that encountered an error due to an invalid presortName.

{
"result" : [
{
"status" : "Error: Presort 'Std Flt' not found in list archive: C:\\Program Files (x86)\\Integratec\\addresstables\\example_.MPS",
"report" : "postageStatement"
}
]
}

The reply for a batch postage statement request.

{
"result" : [
{
"status" : "Job completed.",
"report" : "postageStatement",
"output" : "C:\\PresortOutput\\PostageStatement - Batch OH.PDF"
},
{
"status" : "Job completed.",
"report" : "postageStatement",
"output" : "C:\\PresortOutput\\PostageStatement - Batch NY.PDF"
}
]
}

Request Schema

{
"$schema":"http://json-schema.org/draft-04/schema#",
"title":"Postage Statement",
"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]+)$"
},
"affixedAt":{
"title":"Affixed At",
"description":"Amount of postage affixed. Including the values on the postage statement requires the 'typeOfPostage' property = 'METERED' or 'PRECANCELEDSTAMPS', or the 'permit' property = 'METERED' or 'STAMP'.",
"default":"CORRECT",
"type":"string",
"enum":[
"CORRECT",
"LOWEST",
"NEITHER",
"NONE"
],
"enumValues":[
{
"value":"CORRECT",
"displayValue":"Correct",
"description":"Correct"
},
{
"value":"LOWEST",
"displayValue":"Lowest",
"description":"Lowest"
},
{
"value":"NEITHER",
"displayValue":"Neither",
"description":"Neither"
},
{
"value":"NONE",
"displayValue":"None",
"description":"None"
}
]
},
"affixedPieces":{
"title":"Affixed Pieces",
"description":"Number of pieces postage is affixed to. Valid if AFFIXED <> NEITHER. Including the values on the postage statement requires the 'typeOfPostage' property = 'METERED' or 'PRECANCELEDSTAMPS', or the 'permit' property = 'METERED' or 'STAMP'.",
"default":0,
"type":"integer",
"minimum":0
},
"affixedRate":{
"title":"Affixed Rate",
"description":"Postage amount affixed to each piece. Valid if AFFIXED = NEITHER. Including the values on the postage statement requires the 'typeOfPostage' property = 'METERED' or 'PRECANCELEDSTAMPS', or the 'permit' property = 'METERED' or 'STAMP'.",
"default":0.0,
"type":"number",
"minimum":0.0
},
"agentAddress":{
"title":"Mailing Agent Address",
"description":"Places the mailing agent address on the PS Form.",
"default":"",
"type":"string"
},
"agentAltAddr":{
"title":"Mailing Agent Alternate Address",
"description":"Places the mailing agent alternate address on the PS Form.",
"default":"",
"type":"string"
},
"agentCityStateZip":{
"title":"Mailing Agent City/State/ZIP",
"description":"Places the mailing agent city/state/zip on the PS Form.",
"default":"",
"type":"string"
},
"agentCRID":{
"title":"Mailing Agent CRID",
"description":"Mailing agent CRID.",
"default":"",
"type":"string",
"maxLength":12,
"pattern":"^[0-9]{1,12}$"
},
"agentEmail":{
"title":"Mailing Agent Email",
"description":"Mailing agent email.",
"default":"",
"type":"string"
},
"agentExtension":{
"title":"Mailing Agent Extension",
"description":"Mailing agent extension.",
"default":"",
"type":"string"
},
"agentTelephone":{
"title":"Mailing Agent Phone",
"description":"Mailing agent phone number.",
"default":"",
"type":"string"
},
"allBatches":{
"title":"All Batches",
"description":"Sequentially generates output (tags, reports, labels) for all saved presorts associated with the batch presort.",
"default":false,
"type":"boolean"
},
"capsCustomerReferenceID":{
"title":"Publisher CAPS Customer Reference ID",
"description":"Allows input of a CAPS ID. Centralized Account Processing System (CAPS) accounts provide business mailers with expanded electronic payment options, including the ability to link accounts and access payment information. Prior USPS registration is required.",
"default":"",
"type":"string",
"minLength":0,
"maxLength":50
},
"cassDateAuto":{
"title":"CASS Date Auto",
"description":"Command type is date. Applies to the Automation Address Matching Date field on PS Forms 3600, 3602, 3605, 3541.",
"default":"",
"type":"string",
"format":"date"
},
"cassDateCR":{
"title":"CASS Date CR",
"description":"Command type is date. Applies to the Carrier Route Address Matching Date field on PS Forms 3600, 3602, 3605, 3541.",
"default":"",
"type":"string",
"format":"date"
},
"cassDateCRSeq":{
"title":"CASS Date CR Seq",
"description":"Command type is date. Applies to the Carrier Route Sequencing Address Matching Date field on the 3600, 3602, 3605, 3541.",
"default":"",
"type":"string",
"format":"date"
},
"certificationContactName":{
"title":"Certification Contact Name",
"description":"Allows the contact name to be printed with the company name on the PS Forms 3600, 3602 and 3605.",
"default":"",
"type":"string"
},
"characteristicFee":{
"title":"Characteristic Fee",
"description":"USPS fees for specific types.",
"default":"",
"type":"string",
"enum":[
"",
"CB",
"OS",
"GS",
"PP"
],
"enumValues":[
{
"value":"",
"displayValue":"",
"description":"No fee."
},
{
"value":"CB",
"displayValue":"Certificate of Bulk Mailing",
"description":"Provides a postmarked (round-dated) mailing receipt as evidence a mailer has presented a specific set of identical mailpieces to USPS on a given day and time, including recipient names and addresses."
},
{
"value":"OS",
"displayValue":"Operational Surcharge",
"description":"Operational Surcharge"
},
{
"value":"GS",
"displayValue":"Geographic Surcharge",
"description":"Geographic Surcharge"
},
{
"value":"PP",
"displayValue":"Picture Permit Indicia",
"description":"Provides an opportunity to customize the Permit Imprint Indicia First-Class and Standard Mail letters and cards."
}
]
},
"collate":{
"title":"Collate",
"description":"Collates multiple copies.",
"default":false,
"type":"boolean"
},
"comments":{
"title":"Comments",
"description":"Comments on the PS Form.",
"default":"",
"type":"string"
},
"consolidatedStatement":{
"title":"Consolidates Statement",
"description":"Checks the Consolidated Statement check box on the 3541.",
"default":false,
"type":"boolean"
},
"containerPieceLimit":{
"title":"Container Piece Limit",
"description":"Specifies the number of pieces within a container to use as a threshold or ceiling.",
"default":null,
"type":"integer",
"minimum":0
},
"containerThreshold":{
"title":"Container Threshhold",
"description":"Specifies how the Container Piece Limit value is interpreted. A value of true treats the Container Piece Limit value as a threshold and a value of false treats the Container Piece Limit value as a ceiling.",
"default":true,
"type":"boolean"
},
"contentOfMail":{
"title":"Content of Mail",
"description":"PS Forms 3600 and 3602 only.",
"default":"",
"type":"string",
"enum":[
"CT",
"NF",
"DC",
"RT",
"NP",
"PM",
"EM",
"0X"
],
"enumValues":[
{
"description":"Catalog",
"displayValue":"Catalog",
"value":"CT"
},
{
"description":"Contents NOT required to be mailed FCM",
"displayValue":"Contents NOT required to be mailed FCM",
"value":"NF"
},
{
"description":"DVD/CD or other disk",
"displayValue":"DVD/CD or other disk",
"value":"DC"
},
{
"description":"Round Trip ONLY: One DVD/CD or other disk (can be LT or FL)",
"displayValue":"Round Trip ONLY: One DVD/CD or other disk (can be LT or FL)",
"value":"RT"
},
{
"description":"PACT act",
"displayValue":"PACT act",
"value":"NP"
},
{
"description":"Political Mail",
"displayValue":"Political Mail",
"value":"PM"
},
{
"description":"Election Mail",
"displayValue":"Election Mail",
"value":"EM"
},
{
"description":"A/B testing Content",
"displayValue":"A/B testing Content",
"value":"0X"
}
]
},
"delStatDate":{
"title":"Delivery Statistics Date",
"description":"Date of the Delivery Statistics file.",
"default":"",
"type":"string",
"format":"date"
},
"detachedLabels":{
"title":"Detached Labels",
"description":"Number of Detached Address Labels (DAL) included.",
"default":"",
"type":"string",
"enum":[
"",
"DAL",
"DML"
],
"enumValues":[
{
"value":"",
"displayValue":"None",
"description":"No detached labels"
},
{
"value":"DAL",
"displayValue":"Detached Address Label",
"description":"Use detached address labels"
},
{
"value":"DML",
"displayValue":"Detached Marketing Label",
"description":"Use detached marketing labels"
}
]
},
"editionCode":{
"title":"Edition Code",
"description":"Edition Code.",
"default":"",
"type":"string"
},
"electronicLabels":{
"title":"Electronic Labels",
"description":"Used to check the DelCon or SigCon boxes in the Customer Generated Electronic Labels section, and is recorded for First-Class and Package Services.",
"default":"",
"type":"string",
"enum":[
"DELCON",
"SIGCON"
],
"enumValues":[
{
"value":"DELCON",
"displayValue":"DelCon",
"description":"DelCon"
},
{
"value":"SIGCON",
"displayValue":"SigCon",
"description":"SigCon"
}
]
},
"entryAddress1":{
"title":"Entry Address 1",
"description":"Places the entry address on PS Form 8125. If the value 'None' is used, the default address data is overwritten with a blank value.",
"default":"",
"type":"string"
},
"entryAddress2":{
"title":"Entry Address 2",
"description":"Places the entry address on PS Form 8125. If the value 'None' is used, the default address data is overwritten with a blank value.",
"default":"",
"type":"string"
},
"entryAddress3":{
"title":"Entry Address 3",
"description":"Places the entry address on PS Form 8125. If the value 'None' is used, the default address data is overwritten with a blank value.",
"default":"",
"type":"string"
},
"entryPhone":{
"title":"Entry Phone",
"description":"Places the entry phone number on PS Form 8125. If the value 'None' is used, the default address data is overwritten with a blank value.",
"default":"",
"type":"string"
},
"fedAgencyCostCode":{
"title":"Federal Agency Cost Code",
"description":"5-digit Federal Agency Cost Code number. Valid for PS Form 36xx.",
"default":"",
"type":"string"
},
"fileName":{
"title":"File Name",
"description":"Path and filename for Postage Statement output to disk file.",
"default":"",
"type":"string"
},
"fileType":{
"title":"File Type",
"description":"File type for Postage Statement output to disk file.",
"default":"",
"type":"string",
"enum":[
"PDF"
],
"enumValues":[
{
"value":"PDF",
"displayValue":"PDF",
"description":"PDF"
}
]
},
"financeNumber":{
"title":"Finance Number",
"description":"Finance Number for Post Office of mailing.",
"default":"",
"type":"string"
},
"fullServiceParticipation":{
"title":"Full Service Participation",
"description":"Includes the level of Full Service participation.",
"default":"",
"type":"string",
"enum":[
"B",
"F",
"O"
],
"enumValues":[
{
"value":"B",
"displayValue":"Basic",
"description":"Basic"
},
{
"value":"F",
"displayValue":"Full Service",
"description":"Full Service"
},
{
"value":"O",
"displayValue":"Other",
"description":"Other"
}
]
},
"holdForPickup":{
"title":"Hold for Pickup",
"description":"PS Form 3600-FCM and Package Services. Used to fill the number of pieces in the Hold for Pickup field.",
"default":0,
"type":"integer",
"minimum":0
},
"incentiveType":{
"title":"Incentive Type",
"description":"The USPS offers direct mail advertising promotions and incentives to promote best practices for integrating direct mail with mobile technology and highlight new products and other innovative mailing techniques. See https://www.usps.com/business/promotions-incentives.htm for current promotions.",
"default":"",
"type":"string",
"enum":[
"",
"ME",
"PI",
"SS",
"MI",
"CP",
"RR",
"1X",
"RG",
"CR"
],
"enumValues":[
{
"value": "",
"displayValue": "",
"description": ""
},
{
"value":"ME",
"displayValue":"Emerging and Advanced Tech",
"description":"Emerging and Advanced Tech"
},
{
"value":"PI",
"displayValue":"Informed Delivery",
"description":"Informed Delivery"
},
{
"value":"SS",
"displayValue":"Tactile Mailpiece Engagement",
"description":"Tactile Mailpiece Engagement"
},
{
"value":"MI",
"displayValue":"Mobile Shopping",
"description":"Mobile Shopping"
},
{
"value":"CP",
"displayValue":"Personalized Color Transpromo",
"description":"Personalized Color Transpromo"
},
{
"value":"RR",
"displayValue":"Earned Value Reply Mail",
"description":"Earned Value Reply Mail"
},
{
"description":"Enhanced Emerging Tech",
"displayValue":"Enhanced Emerging Tech",
"value":"1X"
},
{
"description":"Retargeted Mail",
"displayValue":"Retargeted Mail",
"value":"RG"
},
{
"description":"Color Ink with Reply",
"displayValue":"Color Ink with Reply",
"value":"CR"
}
]
},
"includeBatchCode":{
"title":"Include Batch Code",
"description":"Batch Code data is printed on all presort documentation.",
"default":false,
"type":"boolean"
},
"includeAddressTableName":{
"title":"Include Address Table Name",
"description":"Address Table name prints in the Comments section of the postage statement.",
"default":false,
"type":"boolean"
},
"includeSelectivity":{
"title":"Include Selectivity",
"description":"Displays the selection set description in the comments section of PS Forms if the list was presorted using a selection set.",
"default":false,
"type":"boolean"
},
"includeSubset":{
"title":"Include Subset",
"description":"Displays the subset in the comments section of PS Forms if a subset was used for the current postage statement.",
"default":false,
"type":"boolean"
},
"inCountyAddressedSupplements":{
"title":"In-County Addressed Supplements",
"description":"Number of In-County supplement pieces in a Periodicals presort.",
"default":0,
"type":"integer",
"minimum":0
},
"issueDate":{
"title":"Issue Date",
"description":"Issue date for Periodical. Valid for PS Form 3541.",
"default":"",
"type":"string",
"format":"date"
},
"issueFrequency":{
"title":"Issue Frequency",
"description":"Issue frequency for Periodical. Valid for PS Form 3541.",
"default":"",
"type":"string"
},
"limitedCirculationDiscount":{
"title":"Limited Circulation Discount",
"description":"Checks the Limited Circulation Discount checkbox on the PS Form 3541.",
"default":false,
"type":"boolean"
},
"mailID":{
"title":"Mail ID",
"description":"Statement sequence number on PS Form.",
"default":"",
"type":"string",
"maxLength":20
},
"mailingDate":{
"title":"Mailing Date",
"description":"Date of mailing. The default value is supplied by the presort when assigned.",
"default":"",
"type":"string",
"format":"date"
},
"moveUpdateACS":{
"title":"Move Update ACS",
"description":"Checks the 'ACS' checkbox on PS Forms 3600, 3602-R and 3602-N.",
"default":false,
"type":"boolean"
},
"moveUpdateAltAddr":{
"title":"Move Update Alternate Address",
"description":"Checks the 'N/A - Alternative Address Format' checkbox on PS Forms 3600, 3602-R and 3602-N.",
"default":false,
"type":"boolean"
},
"moveUpdateAlternate":{
"title":"Move Update Alternate",
"description":"Checks the 'Alternative' checkbox on PS Forms 3600, 3602-R and 3602-N.",
"default":false,
"type":"boolean"
},
"moveUpdateASE":{
"title":"Move Update ASE",
"description":"Checks the 'Ancillary Service Endorsement' checkbox on PS Forms 3600, 3602-R and 3602-N.",
"default":false,
"type":"boolean"
},
"moveUpdateMultiple":{
"title":"Move Update Multiple",
"description":"Checks the 'Multiple' checkbox on PS Form 3600, 3602-R and 3602-N.",
"default":false,
"type":"boolean"
},
"moveUpdateNCOA":{
"title":"Move Update NCOA",
"description":"Checks the 'NCOA' checkbox on PS Forms 3600, 3602-R and 3602-N.",
"default":false,
"type":"boolean"
},
"moveUpdateOneCode":{
"title":"Move Update OneCode",
"description":"Checks the 'OneCode ACS' checkbox on PS Forms 3600, 3602-R and 3602-N.",
"default":false,
"type":"boolean"
},
"nonProfit":{
"title":"Nonprofit",
"description":"Indicates if the presort qualifies for Nonprofit rates. For periodicals only REGULAR and NONPROFIT priceCategories are modified with this flag.",
"default":false,
"type":"boolean"
},
"originPO":{
"title":"Origin Post Office",
"description":"Entry Post Office name, state and ZIP + 4.",
"default":"",
"type":"string"
},
"outsideCountyAddressedSupplements":{
"title":"Outside-County Addressed Supplements",
"description":"Number of Outside-County supplement pieces in a Periodicals presort.",
"default":0,
"type":"integer",
"minimum":0
},
"overwrite":{
"title":"Overwrite",
"description":"Overwrites existing file if the same filename is used",
"default":true,
"type":"boolean"
},
"pendingPeriodicalsMailClass":{
"title":"Pending Periodicals Mail Class",
"description":"Identifies the corresponding mail class on a Periodicals presort while pending approval.",
"default":"",
"type":"string",
"enum":[
"Priority Mail",
"First-Class Mail - Letters",
"First-Class Mail - Flats",
"First-Class Mail - Parcels",
"STD - Letters",
"STD - Flats",
"Nonprofit STD - Letters",
"Nonprofit STD - Flats",
"Nonprofit STD - Parcels",
"Bound Printed Matter - Flats",
"Bound Printed Matter - Parcels",
"Parcel Select - Parcels"
],
"enumValues":[
{
"value":"Priority Mail",
"displayValue":"Priority Mail",
"description":"Priority Mail"
},
{
"value":"First-Class Mail - Letters",
"displayValue":"First-Class Mail - Letters",
"description":"First-Class Mail - Letters"
},
{
"value":"First-Class Mail - Flats",
"displayValue":"First-Class Mail - Flats",
"description":"First-Class Mail - Flats"
},
{
"value":"First-Class Mail - Parcels",
"displayValue":"First-Class Mail - Parcels",
"description":"First-Class Mail - Parcels"
},
{
"value":"STD - Letters",
"displayValue":"STD - Letters",
"description":"STD - Letters"
},
{
"value":"STD - Flats",
"displayValue":"STD - Flats",
"description":"STD - Flats"
},
{
"value":"Nonprofit STD - Letters",
"displayValue":"Nonprofit STD - Letters",
"description":"Nonprofit STD - Letters"
},
{
"value":"Nonprofit STD - Flats",
"displayValue":"Nonprofit STD - Flats",
"description":"Nonprofit STD - Flats"
},
{
"value":"Nonprofit STD - Parcels",
"displayValue":"Nonprofit STD - Parcels",
"description":"Nonprofit STD - Parcels"
},
{
"value":"Bound Printed Matter - Flats",
"displayValue":"Bound Printed Matter - Flats",
"description":"Bound Printed Matter - Flats"
},
{
"value":"Bound Printed Matter - Parcels",
"displayValue":"Bound Printed Matter - Parcels",
"description":"Bound Printed Matter - Parcels"
},
{
"value":"Parcel Select - Parcels",
"displayValue":"Parcel Select - Parcels",
"description":"Parcel Select - Parcels"
}
]
},
"percentAdvertising":{
"title":"Percent Advertising",
"description":"Advertising percentage in this issue. Valid for PS Form 3541.",
"default":0.0,
"type":"number",
"minimum":0.0,
"maximum":100.0
},
"percentSamples":{
"title":"Percent Samples",
"description":"Used if the Content of Mail/Piece Type is Product Sample.",
"default":0.0,
"type":"number",
"minimum":0.0,
"maximum":100.0
},
"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\\$.+)$|^$)"
},
"permitAdditional":{
"title":"Permit Additional",
"description":"Permit number in the Postage section, as an additional permit number for payment when there is net postage due. Permit number or Permit Description may be used.",
"default":"",
"type":"string",
"pattern":"((?i)^([0-9]{10}|name\\$.+)$|^$)"
},
"presortName":{
"title":"Presort Name",
"description":"Description of the saved presort file.",
"default":"",
"type":"string"
},
"priceCategory":{
"title":"PriceCategory",
"description":"Rate category for PS Form 3541. The use of a category always override a value set in the nonProfit flag when both are used in the same command.",
"default":"",
"type":"string",
"enum":[
"CLASSROOM",
"NONPROFIT",
"REGULAR",
"SCIENCEOFAGRICULTURE"
],
"enumValues":[
{
"value":"CLASSROOM",
"displayValue":"Classroom",
"description":"Classroom"
},
{
"value":"NONPROFIT",
"displayValue":"Non Profit",
"description":"Non Profit"
},
{
"value":"REGULAR",
"displayValue":"Regular",
"description":"Regular"
},
{
"value":"SCIENCEOFAGRICULTURE",
"displayValue":"Science Of Agriculture",
"description":"Science Of Agriculture"
}
]
},
"productID":{
"title":"Product ID",
"description":"Publication title if used with a Periodicals mailing. Valid for PS Form 8125.",
"default":"",
"type":"string"
},
"publication":{
"title":"Publication",
"description":"Enters the publication used in the presort. The 10-digit Publication ID or the Publication Title may be used. Valid for PS Form 3541.",
"default":"",
"type":"string",
"pattern":"(?i)^([0-9]{10}|name\\$.+)$|^$"
},
"publicationNumber":{
"title":"Publication Number",
"description":"Publication number for Periodical presorts. Valid for PS Form 3541.",
"default":"",
"type":"string"
},
"publicationTitle":{
"title":"Publication Title",
"description":"Publication title/News Agent's Name.",
"default":"",
"type":"string"
},
"publisherContact":{
"title":"Publisher Contact",
"description":"Publisher's contact. Valid for PS Form 3541.",
"default":"",
"type":"string"
},
"publisherCustNo":{
"title":"Publisher Customer Number",
"description":"Publisher's customer number (Dun & Bradstreet). Valid for PS Form 3541.",
"default":"",
"type":"string"
},
"publisherEmail":{
"title":"Publisher Email",
"description":"Publisher's email. Valid for PS Form 3541.",
"default":"",
"type":"string"
},
"publisherExt":{
"title":"Publisher Extension",
"description":"Publisher's extension. Valid for PS Form 3541.",
"default":"",
"type":"string"
},
"publisherName":{
"title":"Publisher Name",
"description":"Publisher's name. Valid for PS Form 3541.",
"default":"",
"type":"string"
},
"publisherPhone":{
"title":"Publisher Phone",
"description":"Publisher's phone number. Valid for PS Form 3541.",
"default":"",
"type":"string"
},
"rateSchedule":{
"title":"Rate Schedule",
"description":"Rate schedule used for Commercial Parcels.",
"default":"B",
"type":"string",
"enum":[
"B",
"R"
],
"enumValues":[
{
"value":"B",
"displayValue":"Commercial",
"description":"A discounted rate offered to USPS customers who buy and print shipping labels with an online postage service provider."
},
{
"value":"R",
"displayValue":"Retail",
"description":"A consumer price rather than a lower commercial price available to mailers."
}
]
},
"repositionableNotes":{
"title":"Repositionable Notes",
"description":"Uses repositionable notes. Valid for PS Forms 3600, 3602R and 3602N.",
"default":false,
"type":"boolean"
},
"rideWt":{
"title":"Ride Weight",
"description":"Ride-along piece weight in pounds. Ride-Along piece may be attached to or enclosed with an individual copy of Periodicals mail. The default value is supplied by the presort when assigned, otherwise null.",
"default":"",
"type":"number",
"minimum":0.0,
"maximum":0.20625
},
"specialServices":{
"title":"Special services",
"description":"List of special services included in this postage statement. Values can be used for J (collect on delivery), E (insurance), F (registered mail), CB (certificate of bulk mailing), and DR (data retention, where value represents years). Each service can use a unique value. If a value is not included for a specific service, then the lowest rate for that service is assumed.",
"type" : "array",
"items" : [
{
"type" : "object",
"properties" : {
"count": {"type": "integer", "minimum":0},
"fee": {"type": "number", "minimum":0.0},
"alt": {
"description": "Identifies which set of rates to use for the Premium Data Retention special service",
"type": "string",
"enum" : [
"0",
"1",
"2"
],
"enumValues":[
{
"value":"0",
"displayValue":"Not applicable",
"description":"Not applicable"
},
{
"value":"1",
"displayValue":"Without signature",
"description":"Without signature"
},
{
"value":"2",
"displayValue":"With signature",
"description":"With signature"
}
]
},
"value": {"type": "number", "minimum":0.0},
"type": {
"enum" : [
"K",
"D",
"J",
"B",
"E",
"F",
"SC",
"H",
"HM",
"C2",
"C",
"X",
"M",
"CA",
"Z1",
"Z2",
"PP",
"Y",
"CB",
"SU",
"SA",
"EX",
"NP",
"DP",
"ND",
"CD",
"HZ",
"PR",
"F2",
"E2",
"J2",
"G",
"DR"
],
"enumValues":[
{
"value":"K",
"displayValue":"Certificate of Mailing",
"description":"Certificate of Mailing"
},
{
"value":"D",
"displayValue":"Certified Mail",
"description":"Certified Mail"
},
{
"value":"J",
"displayValue":"Collect on Delivery",
"description":"Collect on Delivery"
},
{
"value":"B",
"displayValue":"USPS Tracking",
"description":"USPS Tracking"
},
{
"value":"E",
"displayValue":"Insurance",
"description":"Insurance"
},
{
"value":"F",
"displayValue":"Registered Mail",
"description":"Registered Mail"
},
{
"value":"SC",
"displayValue":"Signature Confirmation Restricted Delivery",
"description":"Signature Confirmation Restricted Delivery"
},
{
"value":"H",
"displayValue":"Return Receipt (Electronic)",
"description":"Return Receipt (Electronic)"
},
{
"value":"HM",
"displayValue":"Return Receipt (Form 3811)",
"description":"Return Receipt (Form 3811)"
},
{
"value":"C2",
"displayValue":"Certified Mail Restricted Delivery",
"description":"Certified Mail Restricted Delivery"
},
{
"value":"C",
"displayValue":"Signature Confirmation",
"description":"Signature Confirmation"
},
{
"value":"X",
"displayValue":"Parcel Airlift (PAL)",
"description":"Parcel Airlift (PAL)"
},
{
"value":"M",
"displayValue":"Fragile",
"description":"Fragile"
},
{
"value":"CA",
"displayValue":"Certified Mail Adult Signature Required",
"description":"Certified Mail Adult Signature Required"
},
{
"value":"Z1",
"displayValue":"Adult Signature Required",
"description":"Adult Signature Required"
},
{
"value":"Z2",
"displayValue":"Adult Signature Restricted Delivery",
"description":"Adult Signature Restricted Delivery"
},
{
"value":"PP",
"displayValue":"Picture Permit Imprint",
"description":"Picture Permit Imprint"
},
{
"value":"Y",
"displayValue":"Day Certain Delivery",
"description":"Day Certain Delivery"
},
{
"value":"CB",
"displayValue":"Certificate of Bulk Mailing",
"description":"Certificate of Bulk Mailing"
},
{
"value":"SU",
"displayValue":"Sunday Delivery",
"description":"Sunday Delivery"
},
{
"value":"SA",
"displayValue":"Same Day",
"description":"Same Day"
},
{
"value":"EX",
"displayValue":"Extended Coverage",
"description":"Extended Coverage"
},
{
"value":"NP",
"displayValue":"IMpb Non-Compliance Fee",
"description":"IMpb Non-Compliance Fee"
},
{
"value":"DP",
"displayValue":"Live Animal Transportation",
"description":"Live Animal Transportation"
},
{
"value":"ND",
"displayValue":"Next Day",
"description":"Next Day"
},
{
"value":"CD",
"displayValue":"Certified Mail Adult Signature Restricted Delivery",
"description":"Certified Mail Adult Signature Restricted Delivery"
},
{
"value":"HZ",
"displayValue":"Hazardous Material Transportation",
"description":"Hazardous Material Transportation"
},
{
"value":"PR",
"displayValue":"Perishables",
"description":"Perishables"
},
{
"value":"F2",
"displayValue":"Registered Mail Restricted Delivery",
"description":"Registered Mail Restricted Delivery"
},
{
"value":"E2",
"displayValue":"Insurance Restricted Delivery",
"description":"Insurance Restricted Delivery"
},
{
"value":"J2",
"displayValue":"COD HFPU Restricted Delivery",
"description":"COD HFPU Restricted Delivery"
},
{
"value":"G",
"displayValue":"Return Receipt for Merchandise",
"description":"Return Receipt for Merchandise"
},
{
"value":"DR",
"displayValue":"Premium Data Retention",
"description":"Premium Data Retention"
}
]
},
"modify": {
"enum" : [
"B",
"R"
],
"enumValues":[
{
"value":"B",
"displayValue":"Bulk",
"description":"Bulk (affects only Insurance on Priority Mail)"
},
{
"value":"R",
"displayValue":"Registered",
"description":"Registered (affects only COD on Priority Mail)"
}
]
}
},
"required" : ["type"],
"additionalProperties":false
}
]
},
"ssfTransactionID":{
"title":"SSF Transation ID",
"description":"For the Shipping Services File (SSF) ID in the Header Record.",
"default":"",
"type":"string"
},
"subset":{
"title":"Filter for creating a subset of the presort",
"description":"Creates a subset of the presorted items for Bundles, Containers, Pallets, Streams, or Versions. Must be prefaced with a single character ((B)Bundles, (C)ontainers), (P)allets, (S)treams, (V)Versions). Bundles are packs, Containers are either sacks or trays, Pallets are the physical pallets, Streams are the presorted streams, and Versions pertain to comail or manifest piece versions. May contain multiple values separated by commas. Each value must contain either an integer range specified as 'x-y', or a single integer. (e.g. 'P1-6,10' is pallets 1 thru 6, and 10)",
"default":"",
"type":"string",
"pattern":"((B|C|P|S|V)\\d+(-\\d+)?(,\\d+(-\\d+)?)*|^$)"
},
"typeOfPostage":{
"title":"Type of Postage",
"description":"Identifies a mailing as permit imprint, metered, or precanceled.",
"default":"",
"type":"string",
"enum":[
"",
"PERMITIMPRINT",
"METERED",
"PRECANCELEDSTAMPS"
],
"enumValues":[
{
"value":"",
"displayValue":"",
"description":"No Type of Postage"
},
{
"value":"PERMITIMPRINT",
"displayValue":"Permit Imprint",
"description":"Permit Imprint"
},
{
"value":"METERED",
"displayValue":"Metered",
"description":"Metered"
},
{
"value":"PRECANCELEDSTAMPS",
"displayValue":"Precanceled Stamps",
"description":"Precanceled Stamps"
}
]
},
"useAgentPhone":{
"title":"Use Agent Phone",
"description":"Prints the agent's name and phone number in the certification section.",
"default":false,
"type":"boolean"
},
"useCountyTable":{
"title":"Use County Table",
"description":"Calculates In-County rates for Periodicals.",
"default":false,
"type":"boolean"
}
},
"required":[
"addressTable",
"fileName",
"fileType",
"presortName"
],
"additionalProperties":false
}

Reply Schema

{
"$schema":"http://json-schema.org/draft-04/schema#",
"description":"Reply for the postageStatement request.",
"type":"object",
"properties":{
"results": {
"type" : "array",
"items" : {
"type" : "object",
"required": ["status"],
"properties" : {
"status": {"type": "string"},
"warning": {"type": "string"},
"report": {"type": "string"},
"output": {"type": "string"}
}
}
}
}
}