Creates a Mail.dat file from a saved presort.
This request generates a Mail.dat file set for a basic mailing.
This request generates a Mail.dat file set for each batch of a batch presort.
{
"$schema":"http://json-schema.org/draft-04/schema#",
"additionalProperties":false,
"properties":{
"absoluteContainerNumbers":{
"default":false,
"description":"Uses continuous container numbers (i.e., does not reset to 1 at the beginning of each stream).",
"title":"Absolute Container Numbers",
"type":"boolean"
},
"acceptMisshipped":{
"default":false,
"description":"USPS field for eInduction misshipped processing support.",
"title":"Accept Misshipped",
"type":"boolean"
},
"acsKeyline":{
"default":" ",
"description":"Optional keyline included by Address Change Service participants.",
"enum":[
"E",
"F",
"N"
],
"enumValues":[
{
"description":"Expression",
"displayValue":"Expression",
"value":"E"
},
{
"description":"Field",
"displayValue":"Field",
"value":"F"
},
{
"description":"None",
"displayValue":"None",
"value":"N"
}
],
"title":"ACS Keyline",
"type":"string"
},
"acsKeylineExpression":{
"default":"",
"description":"Populates the ACR Keyline Data field in the .pdr using the ACS keyline field in the address table.",
"title":"ACS Keyline Expression",
"type":"string"
},
"actualEntryLocaleKey":{
"default":"",
"description":"Locale key of the building receiving the mail,",
"title":"Actual Entry Locale Key",
"type":"string"
},
"actualEntryZip":{
"default":"",
"description":"ZIP Code of the actual entry point of the building receiving the mail.",
"pattern":"^[0-9]{5}$|[0-9]{9}$",
"title":"Actual Entry ZIP",
"type":"string"
},
"addAcsKeylineCheckDigit":{
"default":false,
"description":"Includes the calculated ACS Keyline check digit. For more information regarding the Address Change Service, refer to Publication 8, available from the United States Postal Service.",
"title":"Add ACS Keyline Check Digit",
"type":"boolean"
},
"addressTable":{
"description":"Group of records used for processing.",
"pattern":"(?i)^([0-9]{10}|name\\$.+|file\\$[a-z]+)$",
"title":"Address Table",
"type":"string"
},
"affixedRate":{
"default":0,
"description":"Postage amount affixed to each piece. Valid if AFFIXED=NEITHER.",
"minimum":0,
"title":"Affixed Rate",
"type":"number"
},
"allBatches":{
"default":false,
"description":"Sequentially generates output (tags, reports, labels) for all saved presorts associated with the batch presort.",
"title":"All Batches",
"type":"boolean"
},
"approvedPieceDesign":{
"default":0,
"description":"USPS approval ruling number for the mail piece design.",
"maximum":9999999,
"minimum":0,
"title":"Approved Piece Design Number",
"type":"number"
},
"approvedPieceDesignType":{
"default":"",
"description":"USPS code for piece approval ruling type.",
"enum":[
"",
"C",
"P"
],
"enumValues":[
{
"description":"None",
"displayValue":"None",
"value":""
},
{
"description":"Customer Support Ruling.",
"displayValue":"CSR",
"value":"C"
},
{
"description":"Pricing Classification Service Center.",
"displayValue":"PCSC",
"value":"P"
}
],
"title":"Approved Piece Design Type",
"type":"string"
},
"batchSize":{
"default":0,
"description":"Sets the number of pieces in each batch. Only used when the report style is set to FIXED.",
"minimum":0,
"title":"Batch Size",
"type":"integer"
},
"bulkInsurance":{
"default":false,
"description":"Indicates if all mail pieces sharing this Component are insured",
"title":"Bulk Insurance",
"type":"boolean"
},
"bypassSeamlessAcceptance":{
"default":false,
"description":"Seamless Acceptance is a service of the USPS that streamlines the acceptance process. Mailers must opt in with the USPS to use this service.",
"title":"Bypass Seamless Acceptance",
"type":"boolean"
},
"campaignCode":{
"default":"",
"description":"Informed Delivery: User-defined text or expression identifying subsets of a campaign that may have multiple campaigns per Campaign Title. Constant text must be enclosed in single quotes ('') and expressions referencing fields must be enclosed in brackets ([]).",
"title":"Campaign Code",
"type":"string"
},
"campaignDisplayName":{
"default":"",
"description":"Informed Delivery: Campaign name for the consumer portal and consumer emails. Constant text must be enclosed in single quotes ('') and expressions referencing fields must be enclosed in brackets ([]).",
"title":"Campaign Display Name",
"type":"string"
},
"campaignEndDate":{
"default":"",
"description":"Informed Delivery: Campaign End Date.",
"format":"date",
"title":"Campaign End Date",
"type":"string"
},
"campaignGrouping":{
"default":"",
"description":"Informed Delivery: Campaign Grouping.",
"enum":[
"",
"C"
],
"enumValues":[
{
"description":"IMBs in continuous serial range, used with non-personalized campaigns.",
"displayValue":"Continuous",
"value":"C"
},
{
"description":"IMBs not in continuous serial range; creates single piece campaigns.",
"displayValue":"None",
"value":""
}
],
"title":"Campaign Grouping",
"type":"string"
},
"campaignSharingIndicator":{
"default":false,
"description":"Enables the mailer to determine wheStrToBoolther to display sharing options to consumer recipients.",
"title":"Campaign Sharing Indicator",
"type":"boolean"
},
"campaignStartDate":{
"default":"",
"description":"Informed Delivery: Campaign Start Date.",
"format":"date",
"title":"Campaign Start Date",
"type":"string"
},
"campaignTargetURLParamsIndicator":{
"default":false,
"description":"Enables the mailer to determine whether to add tracking parameters to the Informed Delivery campaign’s target URL.",
"title":"Campaign Target URL Parameters Indicator",
"type":"boolean"
},
"campaignTitle":{
"default":"",
"description":"Informed Delivery: User-defined campaign title. Enter constant text or an expression to evaluate to the desired description. Constant text must be enclosed in single quotes ('') and expressions referencing fields must be enclosed in brackets ([]).",
"title":"Campaign Title",
"type":"string"
},
"characteristicFee":{
"default":" ",
"description":"Identifies the Fee Type.",
"enum":[
"CB",
"GS",
"OS",
"PP"
],
"enumValues":[
{
"description":"",
"displayValue":"",
"value":"CB"
},
{
"description":"Geographic Surcharge",
"displayValue":"Geographic Surcharge",
"value":"GS"
},
{
"description":"Operational Surcharge",
"displayValue":"Operational Surcharge",
"value":"OS"
},
{
"description":"Picture Permit",
"displayValue":"Picture Permit",
"value":"PP"
}
],
"title":"Characteristic Fee",
"type":"string"
},
"componentADPercent":{
"default":0,
"description":"Percentage of advertising per issue.",
"maximum":100,
"minimum":0,
"title":"Component Ad Percent",
"type":"number"
},
"componentADStatus":{
"default":" ",
"description":"Status of the advertising percentage calculation.",
"enum":[
"F",
"N",
"P"
],
"enumValues":[
{
"description":"Final",
"displayValue":"Final",
"value":"F"
},
{
"description":"None",
"displayValue":"None",
"value":"N"
},
{
"description":"Pending",
"displayValue":"Pending",
"value":"P"
}
],
"title":"Component Ad Status",
"type":"string"
},
"componentDescription":{
"default":"",
"description":"Defines the mailpiece principal components. The CPT.Component Description field is populated with the Component Description.",
"title":"Component Description",
"type":"string"
},
"componentRateType":{
"default":" ",
"description":"Rate category for PS Form 3541.",
"enum":[
"B",
"C",
"D",
"E",
"E1",
"E2",
"E7",
"F",
"G",
"H",
"I",
"J",
"K",
"L",
"M",
"N",
"O",
"P",
"R",
"S",
"T",
"T1",
"T2",
"T3",
"T4",
"T5",
"W",
"X",
"Y",
"Z"
],
"enumValues":[
{
"description":"Bound Printed Matter",
"displayValue":"Bound Printed Matter",
"value":"B"
},
{
"description":"Classroom",
"displayValue":"Classroom",
"value":"C"
},
{
"description":"Parcel Select",
"displayValue":"Parcel Select",
"value":"D"
},
{
"description":"Priority Fixed Rate Envelope",
"displayValue":"Priority Fixed Rate Envelope",
"value":"E"
},
{
"description":"Priority Fixed Rate Legal Envelope",
"displayValue":"Priority Fixed Rate Legal Envelope",
"value":"E1"
},
{
"description":"Priority Fixed Rate Padded Envelope",
"displayValue":"Priority Fixed Rate Padded Envelope",
"value":"E2"
},
{
"description":"Priority Fixed Rate Medium Box",
"displayValue":"Priority Fixed Rate Medium Box",
"value":"E7"
},
{
"description":"Media Mail",
"displayValue":"Media Mail",
"value":"F"
},
{
"description":"Priority Fixed Rate Box",
"displayValue":"Priority Fixed Rate Box",
"value":"G"
},
{
"description":"Ride-Along",
"displayValue":"Ride-Along",
"value":"H"
},
{
"description":"First Class Permit Reply Mail",
"displayValue":"First Class Permit Reply Mail",
"value":"I"
},
{
"description":"Priority Fixed Rate Large Box",
"displayValue":"Priority Fixed Rate Large Box",
"value":"J"
},
{
"description":"Priority Fixed Rate APO/FPO Large Box",
"displayValue":"Priority Fixed Rate APO/FPO Large Box",
"value":"K"
},
{
"description":"Library Mail",
"displayValue":"Library Mail",
"value":"L"
},
{
"description":"Repositionable Component",
"displayValue":"Repositionable Component",
"value":"M"
},
{
"description":"Nonprofit",
"displayValue":"Nonprofit",
"value":"N"
},
{
"description":"Priority Fixed Rate Small Box",
"displayValue":"Priority Fixed Rate Small Box",
"value":"O"
},
{
"description":"Parcel Post",
"displayValue":"Parcel Post",
"value":"P"
},
{
"description":"Regular (US/MEX/CAN)",
"displayValue":"Regular (US/MEX/CAN)",
"value":"R"
},
{
"description":"Science of Agriculture",
"displayValue":"Science of Agriculture",
"value":"S"
},
{
"description":"Priority",
"displayValue":"Priority",
"value":"T"
},
{
"description":"Priority Cubic Tier 1",
"displayValue":"Priority Cubic Tier 1",
"value":"T1"
},
{
"description":"Priority Cubic Tier 2",
"displayValue":"Priority Cubic Tier 2",
"value":"T2"
},
{
"description":"Priority Cubic Tier 3",
"displayValue":"Priority Cubic Tier 3",
"value":"T3"
},
{
"description":"Priority Cubic Tier 4",
"displayValue":"Priority Cubic Tier 4",
"value":"T4"
},
{
"description":"Priority Cubic Tier 5",
"displayValue":"Priority Cubic Tier 5",
"value":"T5"
},
{
"description":"Science of Agriculture Limited Circulation",
"displayValue":"Science of Agriculture Limited Circulation",
"value":"W"
},
{
"description":"Other",
"displayValue":"Other",
"value":"X"
},
{
"description":"Regular limited Circulation",
"displayValue":"Regular limited Circulation",
"value":"Y"
},
{
"description":"Included in Host Postage",
"displayValue":"Included in Host Postage",
"value":"Z"
}
],
"title":"Component Rate Type",
"type":"string"
},
"componentWeightSource":{
"default":" ",
"description":"Source of weight data. Select Agent (realtime), Postal (clerk), Calculated (USPS formula), or Logical (implied from rate).",
"enum":[
"A",
"C",
"L",
"P"
],
"enumValues":[
{
"description":"Agent",
"displayValue":"Agent",
"value":"A"
},
{
"description":"Calculated",
"displayValue":"Calculated",
"value":"C"
},
{
"description":"Logical",
"displayValue":"Logical",
"value":"L"
},
{
"description":"Postal",
"displayValue":"Postal",
"value":"P"
}
],
"title":"Component Weight Source",
"type":"string"
},
"componentWeightStatus":{
"default":" ",
"description":"Status of the weight information.",
"enum":[
"F",
"M",
"N",
"P"
],
"enumValues":[
{
"description":"Final",
"displayValue":"Final",
"value":"F"
},
{
"description":"Manifest",
"displayValue":"Manifest",
"value":"M"
},
{
"description":"None",
"displayValue":"None",
"value":"N"
},
{
"description":"Pending",
"displayValue":"Pending",
"value":"P"
}
],
"title":"Component Weight Status",
"type":"string"
},
"confirm14DigitPlanetBarcode":{
"default":false,
"description":"Length of PLANET barcode used on the mail piece.",
"title":"Confirm 14-Digit Planet Barcode",
"type":"boolean"
},
"confirmCustomerIDExpression":{
"default":"",
"description":"User-defined expression identifying the Confirm customer",
"title":"Confirm Customer ID Expression",
"type":"string"
},
"confirmMailingIDExpression":{
"default":"",
"description":"User-defined expression identifying the mailing.",
"title":"Confirm Mailing ID Expression",
"type":"string"
},
"confirmSamplingCriteria":{
"default":"",
"description":"User-defined expression identifying pieces to be sampled",
"title":"Confirm Sampling Criteria",
"type":"string"
},
"confirmService":{
"default":"",
"description":"Indicates type of CONFIRM service, Destination or Origin.",
"title":"Confirm Service",
"type":"string"
},
"confirmShipmentID":{
"default":"",
"description":"For the CONFIRM Shipment ID number, used when printing the PS Form 3152A.",
"title":"Confirm Shipment ID",
"type":"string"
},
"confirmSubscriberID":{
"default":"",
"description":"For the CONFIRM Subscriber ID number, used when printing the PS Form 3152A.",
"title":"Confirm Subscriber ID",
"type":"string"
},
"consecutiveBatchNumbers":{
"default":false,
"description":"Maintains the sequence number on the Manifest Report across all batches in a Batch presort.",
"title":"Consecutive Batch Numbers",
"type":"boolean"
},
"contactEmail":{
"default":"",
"description":"Job preparer's email address.",
"title":"Contact Email",
"type":"string"
},
"contactName":{
"default":"",
"description":"Allows the contact name to be printed with the company name on the PS Forms 3600, 3602, and 3605",
"title":"Contact Name",
"type":"string"
},
"contactPhone":{
"default":"",
"description":"Job preparer's phone number",
"title":"Contact Phone",
"type":"string"
},
"containerPieceLimit":{
"default":0,
"description":"Specifies the number of pieces within a container to use as a threshold or ceiling.",
"minimum":0,
"title":"Container Piece Limit",
"type":"integer"
},
"containerStatus":{
"default":" ",
"description":"Indicates the postage staus of the mailing.",
"enum":[
"A",
"C",
"D",
"P",
"R",
"T",
"X"
],
"enumValues":[
{
"description":"Cancel",
"displayValue":"Cancel",
"value":"C"
},
{
"description":"Delete",
"displayValue":"Delete",
"value":"D"
},
{
"description":"Paid",
"displayValue":"Paid",
"value":"X"
},
{
"description":"Preliminary Postage Statement",
"displayValue":"Preliminary Postage Statement",
"value":"P"
},
{
"description":"Ready to Accept, Periodicals under CPP",
"displayValue":"Ready to Accept, Periodicals under CPP",
"value":"A"
},
{
"description":"Ready to Pay",
"displayValue":"Ready to Pay",
"value":"R"
},
{
"description":"Transportation Information Update",
"displayValue":"Transportation Information Update",
"value":"T"
}
],
"title":"Container Status",
"type":"string"
},
"containerTags":{
"default":false,
"description":"Generates container tags.",
"title":"Container Tags",
"type":"boolean"
},
"containerThreshold":{
"default":true,
"description":"Specifies how the Container Threshold value is interpreted. A value of 'true' treats the Container Threshold value as a threshold, and a value of 'false' treats the Container Threshold value as a ceiling.",
"title":"Container Threshold",
"type":"boolean"
},
"contentOfMail":{
"default":" ",
"description":"PS Forms 3600-FCM and 3602 only.",
"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"
}
],
"title":"Content of Mail",
"type":"string"
},
"csaID":{
"default":"",
"description":"Customer/Supplier Agreement ID. Mailers must be preapproved by the USPS.",
"title":"CSA ID",
"type":"string"
},
"csaTripID":{
"default":"",
"description":"Each scheduled USPS trailer will have an associated trip number defined in the CSA.",
"title":"CSA Trip ID",
"type":"string"
},
"customerReferenceNumber":{
"default":"",
"description":"Customer ID",
"title":"Customer Reference Number",
"type":"string"
},
"defOrder":{
"default":"",
"description":"Allows a custom DEFORDER.TXT file.",
"pattern":"^.*\\.(txt)$",
"title":"Def Order",
"type":"string"
},
"deleteDatabaseAfterZipping":{
"default":false,
"description":"Deletes the Mail.dat database after the files are zipped.",
"title":"Delete Database After Zipping",
"type":"boolean"
},
"delStatDate":{
"default":"",
"description":"Date of the Delivery Statistics file.",
"format":"date",
"title":"Delivery Statistics Date",
"type":"string"
},
"detachedAddressLabels":{
"default":false,
"description":"Indicates detached address labels (DALs) are used for the mailing. Saturation mailings of unaddressed Periodicals or Standard Mail flats may be mailed with DALs.",
"title":"Detached Address Labels",
"type":"boolean"
},
"detachedMailingLabel":{
"default":" ",
"description":"Indicates detached address labels were used for the mailing. Only valid for Walk Sequence presorts.",
"enum":[
"A",
"B"
],
"enumValues":[
{
"description":"Address",
"displayValue":"Address",
"value":"A"
},
{
"description":"Marketing",
"displayValue":"Marketing",
"value":"B"
}
],
"title":"Detached Mailing Label",
"type":"string"
},
"edocSenderCrid":{
"default":"",
"description":"This USPS-assigned id (CRID), used by the USPS to uniquely identify the submitter of electronic documentation to the PostalOne! system. This field is used to identify the eDoc submitter, which may be different from the mail preparer, mail owner, mail transporter, and scheduler roles.",
"title":"E-Doc Sender CRID",
"type":"string"
},
"eInduction":{
"default":false,
"description":"Flags whether an e8125/e8017 needs to be generated for eInduction.",
"title":"E-Induction",
"type":"boolean"
},
"enclosure":{
"default":false,
"description":"Indicates an enclosure is included.",
"title":"Enclosure",
"type":"boolean"
},
"enclosureBulkInsurance":{
"default":false,
"description":"Indicates if all mail pieces sharing this component are insured.",
"title":"Enclosure Bulk Insurance",
"type":"boolean"
},
"enclosureDescription":{
"default":"",
"description":"User-defined description of the enclosure piece.",
"title":"Enclosure Description",
"type":"string"
},
"enclosureProcessingCategory":{
"default":" ",
"description":"Piece type of the enclosure.",
"enum":[
"CD",
"CM",
"FL",
"IR",
"LT",
"MP",
"OS",
"PF"
],
"enumValues":[
{
"description":"Card",
"displayValue":"Card",
"value":"CD"
},
{
"description":"Customized MarketMail",
"displayValue":"Customized MarketMail",
"value":"CM"
},
{
"description":"Flat",
"displayValue":"Flat",
"value":"FL"
},
{
"description":"Irregular Parcel",
"displayValue":"Irregular Parcel",
"value":"IR"
},
{
"description":"Letter",
"displayValue":"Letter",
"value":"LT"
},
{
"description":"Machinable Parcel",
"displayValue":"Machinable Parcel",
"value":"MP"
},
{
"description":"Outside Parcel",
"displayValue":"Outside Parcel",
"value":"OS"
},
{
"description":"Parcel - First Class",
"displayValue":"Parcel - First Class",
"value":"PF"
}
],
"title":"Enclosure Processing Category",
"type":"string"
},
"enclosureRateType":{
"default":" ",
"description":"Rate applied to the enclosure piece.",
"enum":[
"B",
"C",
"D",
"E",
"E1",
"E2",
"E4",
"E5",
"E6",
"E7",
"F",
"G",
"H",
"I",
"J",
"K",
"L",
"M",
"N",
"O",
"P",
"R",
"S",
"T",
"T1",
"T2",
"T3",
"T4",
"T5",
"W",
"X",
"Y",
"Z"
],
"enumValues":[
{
"description":"Bound Printed Matter",
"displayValue":"Bound Printed Matter",
"value":"B"
},
{
"description":"Classroom",
"displayValue":"Classroom",
"value":"C"
},
{
"description":"First Class Permit Reply Mail",
"displayValue":"First Class Permit Reply Mail",
"value":"I"
},
{
"description":"Included in Host Postage",
"displayValue":"Included in Host Postage",
"value":"Z"
},
{
"description":"Library Mail",
"displayValue":"Library Mail",
"value":"L"
},
{
"description":"Media Mail",
"displayValue":"Media Mail",
"value":"F"
},
{
"description":"Nonprofit",
"displayValue":"Nonprofit",
"value":"N"
},
{
"description":"Other",
"displayValue":"Other",
"value":"X"
},
{
"description":"Parcel Post",
"displayValue":"Parcel Post",
"value":"P"
},
{
"description":"Parcel Select",
"displayValue":"Parcel Select",
"value":"D"
},
{
"description":"Priority Cubic Tier 1",
"displayValue":"Priority Cubic Tier 1",
"value":"T1"
},
{
"description":"Priority Cubic Tier 2",
"displayValue":"Priority Cubic Tier 2",
"value":"T2"
},
{
"description":"Priority Cubic Tier 3",
"displayValue":"Priority Cubic Tier 3",
"value":"T3"
},
{
"description":"Priority Cubic Tier 4",
"displayValue":"Priority Cubic Tier 4",
"value":"T4"
},
{
"description":"Priority Cubic Tier 5",
"displayValue":"Priority Cubic Tier 5",
"value":"T5"
},
{
"description":"Priority Fixed Rate APO/FPO Large Box",
"displayValue":"Priority Fixed Rate APO/FPO Large Box",
"value":"K"
},
{
"description":"Priority Fixed Rate Box",
"displayValue":"Priority Fixed Rate Box",
"value":"G"
},
{
"description":"Priority Fixed Rate Envelope",
"displayValue":"Priority Fixed Rate Envelope",
"value":"E"
},
{
"description":"Priority Fixed Rate Large Box",
"displayValue":"Priority Fixed Rate Large Box",
"value":"J"
},
{
"description":"Priority Fixed Rate Legal Envelope",
"displayValue":"Priority Fixed Rate Legal Envelope",
"value":"E1"
},
{
"description":"Priority Fixed Rate Medium Box",
"displayValue":"Priority Fixed Rate Medium Box",
"value":"E7"
},
{
"description":"Priority Fixed Rate Padded Envelope",
"displayValue":"Priority Fixed Rate Padded Envelope",
"value":"E2"
},
{
"description":"Priority Fixed Rate Small Box",
"displayValue":"Priority Fixed Rate Small Box",
"value":"O"
},
{
"description":"Priority Regional Rate Box A",
"displayValue":"Priority Regional Rate Box A",
"value":"E6"
},
{
"description":"Priority Regional Rate Box B",
"displayValue":"Priority Regional Rate Box B",
"value":"E5"
},
{
"description":"Priority Regional Rate Box C",
"displayValue":"Priority Regional Rate Box C",
"value":"E4"
},
{
"description":"Priority",
"displayValue":"Priority",
"value":"T"
},
{
"description":"Regular (US/MEX/CAN)",
"displayValue":"Regular (US/MEX/CAN)",
"value":"R"
},
{
"description":"Regular limited Circulation",
"displayValue":"Regular limited Circulation",
"value":"Y"
},
{
"description":"Repositionable Component",
"displayValue":"Repositionable Component",
"value":"M"
},
{
"description":"Ride-Along",
"displayValue":"Ride-Along",
"value":"H"
},
{
"description":"Science of Agriculture Limited Circulation",
"displayValue":"Science of Agriculture Limited Circulation",
"value":"W"
},
{
"description":"Science of Agriculture",
"displayValue":"Science of Agriculture",
"value":"S"
}
],
"title":"Enclosure Rate Type",
"type":"string"
},
"enclosureThickness":{
"default":0,
"description":"Thickness of the enclosure in inches.",
"minimum":0,
"title":"Enclosure Thickness",
"type":"number"
},
"enclosureType":{
"default":" ",
"description":"Defines the piece used as an enclosure with Periodicals presorts.",
"enum":[
"A",
"B",
"C",
"D",
"E",
"F",
"N"
],
"enumValues":[
{
"description":"First Class Mail, Enclosure",
"displayValue":"First Class Mail, Enclosure",
"value":"D"
},
{
"description":"N/A",
"displayValue":"N/A",
"value":"N"
},
{
"description":"Periodical As First Class",
"displayValue":"Periodical As First Class",
"value":"A"
},
{
"description":"Periodical As Periodical",
"displayValue":"Periodical As Periodical",
"value":"B"
},
{
"description":"Periodical As Standard",
"displayValue":"Periodical As Standard",
"value":"C"
},
{
"description":"Periodicals, Supplement",
"displayValue":"Periodicals, Supplement",
"value":"F"
},
{
"description":"Standard Mail, Enclosure",
"displayValue":"Standard Mail, Enclosure",
"value":"E"
}
],
"title":"Enclosure Type",
"type":"string"
},
"enclosureUserOptionCompany":{
"default":" ",
"description":"Provides a unique value at the company level, for third-party products to identify the Mail Owner.",
"enum":[
"1",
"2",
"3"
],
"enumValues":[
{
"description":"Mail Owner",
"displayValue":"Mail Owner",
"value":"2"
},
{
"description":"Mailing Agent",
"displayValue":"Mailing Agent",
"value":"3"
},
{
"description":"Permit Holder",
"displayValue":"Permit Holder",
"value":"1"
}
],
"title":"Enclosure User Option Company",
"type":"string"
},
"enclosureUserOptionCompanyAdditional":{
"default":0,
"description":"Used if a permit other than the permit used for the regular postage is used with a Periodical presort.",
"minimum":0,
"title":"Enclosure User Option Company Additional",
"type":"integer"
},
"enclosureWeight":{
"default":0,
"description":"Enclosure Piece Weight in ounces.",
"minimum":0,
"title":"Enclosure Weight",
"type":"number"
},
"enclosureWeightSource":{
"default":" ",
"description":"Source of weight data.",
"enum":[
"A",
"C",
"L",
"P"
],
"enumValues":[
{
"description":"Agent",
"displayValue":"Agent",
"value":"A"
},
{
"description":"Calculated",
"displayValue":"Calculated",
"value":"C"
},
{
"description":"Logical",
"displayValue":"Logical",
"value":"L"
},
{
"description":"Postal",
"displayValue":"Postal",
"value":"P"
}
],
"title":"Enclosure Weight Source",
"type":"string"
},
"enclosureWeightStatus":{
"default":" ",
"description":"Status of the weight information.",
"enum":[
"F",
"M",
"N",
"P"
],
"enumValues":[
{
"description":"Final",
"displayValue":"Final",
"value":"F"
},
{
"description":"Manifest",
"displayValue":"Manifest",
"value":"M"
},
{
"description":"None",
"displayValue":"None",
"value":"N"
},
{
"description":"Pending",
"displayValue":"Pending",
"value":"P"
}
],
"title":"Enclosure Weight Status",
"type":"string"
},
"fastContentID":{
"default":"",
"description":"Provided by FAST. Alphanumeric, user-defined ID.",
"title":"FAST Content ID",
"type":"string"
},
"fastSchedulerID":{
"default":"",
"description":"USPS supplied. Scheduler ID can represent a location, a department, or a person in your company.",
"title":"FAST Scheduler ID",
"type":"string"
},
"fileSetName":{
"default":"",
"description":"A code generated automatically to uniquely identify the database. The User License Code, File Set ID, and file type are combined to make up the file name for each file in the Mail.dat database. The File Set Name can be defined to allow easily identifiable Mail.dat file names.",
"title":"File Set Name",
"type":"string"
},
"fileSetStatus":{
"default":" ",
"description":"Status of the current Mail.dat file set.",
"enum":[
"C",
"D",
"N",
"O",
"R",
"U"
],
"enumValues":[
{
"description":"Change Individual Records",
"displayValue":"Change Individual Records",
"value":"C"
},
{
"description":"Delete Entire File",
"displayValue":"Delete Entire File",
"value":"D"
},
{
"description":"None Transmitted",
"displayValue":"None Transmitted",
"value":"N"
},
{
"description":"Original",
"displayValue":"Original",
"value":"O"
},
{
"description":"Replace Entire File",
"displayValue":"Replace Entire File",
"value":"R"
},
{
"description":"Update Individual Records",
"displayValue":"Update Individual Records",
"value":"U"
}
],
"title":"File Set Status",
"type":"string"
},
"fileSource":{
"default":"",
"description":"The company creating the Mail.dat database.",
"title":"File Source",
"type":"string"
},
"firstContainer":{
"default":1,
"description":"Specifies the first container within the first stream selected. The DEFAULT value selects the first container within the first stream.",
"minimum":1,
"title":"First Container",
"type":"integer"
},
"fixedBatch":{
"default":false,
"description":"The pieces in each required (or authorized optional) destination sortation level are divided into batches of a specified size",
"title":"Fixed Batch",
"type":"boolean"
},
"frequency":{
"default":0,
"description":"Number of times per year the mail piece is published.",
"minimum":0,
"title":"Frequency",
"type":"number"
},
"fullServiceParticipation":{
"default":" ",
"description":"Includes the level of Full Service participation.",
"enum":[
"B",
"F",
"O"
],
"enumValues":[
{
"description":"Basic",
"displayValue":"Basic",
"value":"B"
},
{
"description":"Full Service",
"displayValue":"Full Service",
"value":"F"
},
{
"description":"Other",
"displayValue":"Other",
"value":"O"
}
],
"title":"Full Service Participation",
"type":"string"
},
"groupingID":{
"default":"",
"description":"Groups multiple containers for convenience.",
"title":"Grouing ID",
"type":"string"
},
"headerInformationExchange":{
"default":"",
"description":"Allows the exchange of information between the mailer and another party; for example, the mail owner or logistic provider.",
"title":"Header Information Exchange",
"type":"string"
},
"headerUserOption":{
"default":"",
"description":"An optional setting used to populate the .hdr with internal tracking information, beginning in pos. 739.",
"title":"Header User Option",
"type":"string"
},
"imbConfirmSampling":{
"default":false,
"description":"Sampling data used to monitor postage accuracy; captured after the mailing arrives at the destination entry Post Office.",
"title":"IMB Confirm Sampling",
"type":"boolean"
},
"imbConfirmSamplingExpression":{
"default":"",
"description":"User-defined expression to define sampling criteria.",
"title":"IMB Confirm Sampling Expression",
"type":"string"
},
"imbDowngradeNonAuto":{
"default":false,
"description":"Allows using a Basic Service Type ID (STID) on NonAutomated pieces when the `imbServicesExpression` evaluates to a Full Service STID. Only used when `imbUseServicesExpression` is true.",
"title":"IMB Downgrade NonAuto",
"type":"boolean"
},
"imbMailerIDExpression":{
"default":"",
"description":"Evaluates to a six or nine-digit number, issued by the USPS, to identify the mailer as a subscriber.",
"pattern":"^[0-8][0-9]{5}$|^[9][0-9]{8}$|^\\[.+\\]$",
"title":"IMB Mailer ID Expression",
"type":"string"
},
"imbNonUspsValid":{
"default":false,
"description":"Includes the IMb on pieces without a valid 5-digit ZIP Code.",
"title":"IMB Non USPS Valid",
"type":"boolean"
},
"imbSerialNumberExpression":{
"default":"",
"description":"User-defined expression to uniquely identify individual mail pieces.",
"title":"IMB Serial Number Expression",
"type":"string"
},
"imbServices":{
"default":"",
"description":"USPS services supported by the Intelligent Mail barcode",
"title":"IMB Services",
"type":"string"
},
"imbServicesExpression":{
"default":"",
"description":"User-defined expression to identify services.",
"title":"IMB Services Expression",
"type":"string"
},
"imbUseServicesExpression":{
"default":false,
"description":"",
"title":"IMB Use Services Expression",
"type":"boolean"
},
"imContainerTags":{
"default":false,
"description":"Intelligent Mail Container Tags. Populates 24-character CSM Label: IM™ Container or IM™ Tray Barcode",
"title":"IM Container Tags",
"type":"boolean"
},
"imContainerTagsMailerID":{
"default":"",
"description":"Mailer ID used on barcoded container tags.",
"pattern":"^[0-8][0-9]{5}$|^[9][0-9]{8}$",
"title":"IM Container Tags Mailer ID",
"type":"string"
},
"impbMailerIDExpression":{
"default":"",
"description":"Expression evaluates to six or nine-digit number that identifies the mailer or subscriber.",
"pattern":"^[0-8][0-9]{5}$|^[9][0-9]{8}$|^\\[.+\\]$",
"title":"IMpb Mailer ID Expression",
"type":"string"
},
"impbNonUspsValid":{
"default":false,
"description":"Prints an IMpb on pieces not having a valid 5-digit ZIP Code.",
"title":"IMpb Non Usps Valid",
"type":"boolean"
},
"impbSerialNumberExpression":{
"default":"",
"description":"Enter a user-defined expression that evaluates to the IMpb serial number.",
"title":"IMpb Serial Number Expression",
"type":"string"
},
"impbServices":{
"default":"",
"description":"USPS-provided services for parcel presorts",
"title":"IMpb Services",
"type":"string"
},
"impbServicesExpression":{
"default":"",
"description":"Enter a user-defined expression that evaluates to the IMpb services.",
"title":"IMpb Services Expression",
"type":"string"
},
"impbUseServicesExpression":{
"default":false,
"description":"",
"title":"IMpb Use Services Expression",
"type":"boolean"
},
"impbZipFormat":{
"default":"",
"description":"Defines the ZIP Code length.",
"enum":[
"0",
"5",
"9",
"C"
],
"enumValues":[
{
"description":"5-Digit",
"displayValue":"5-Digit",
"value":"5"
},
{
"description":"9-Digit",
"displayValue":"9-Digit",
"value":"9"
},
{
"description":"Custom Expression",
"displayValue":"Custom",
"value":"C"
},
{
"description":"None",
"displayValue":"None",
"value":"0"
}
],
"title":"IMpb ZIP Format",
"type":"string"
},
"impbZipFormatExpression":{
"default":"",
"description":"Expression evaluates to the ZIP Code length",
"title":"IMpb Zip Format Expression",
"type":"string"
},
"imrTable":{
"default":false,
"description":"Produces a Mail.dat IMR file",
"title":"IMR Table",
"type":"boolean"
},
"inductionActualDateTime":{
"default":"",
"description":"Date and time the mail is presented to the Post Office",
"format":"date-time",
"title":"Induction Actual Date Time",
"type":"string"
},
"inductionEndDateTime":{
"default":"",
"description":"The end date and time on which the mail is transferred to the consignee for processing.",
"format":"date-time",
"title":"Induction End Date and Time",
"type":"string"
},
"inductionStartDateTime":{
"default":"",
"description":"The start date and time on which the mail is transferred to the consignee for processing.",
"format":"date-time",
"title":"Induction Start Date and Time",
"type":"string"
},
"informedAddressIndicator":{
"default":false,
"description": "Indicates mailing has Informed Address",
"title":"Informed Address Indicator",
"type":"boolean"
},
"informedAddressExpirationDate":{
"default":"",
"description": "Last date the Informed Address is valid",
"format":"date-time",
"title":"Informed Address Expiration Date",
"type":"string"
},
"inHomeDate":{
"default":"",
"description":"Date when the mail piece should be delivered.",
"format":"date",
"title":"In Home Date",
"type":"string"
},
"inHomeRange":{
"default":0,
"description":"Number of days earlier or later than the Scheduled In-Home date when the mail piece should be delivered.",
"minimum":0,
"title":"In Home Range",
"type":"integer"
},
"inputFileSet":{
"default":"",
"description":"Adds an additional .hdr file.",
"title":"Input File Set",
"type":"string"
},
"inputMode":{
"default":"",
"description":"How the Mail.dat file set is generated.",
"enum":[
"APPEND",
"OVERWRITE"
],
"enumValues":[
{
"description":"Append",
"displayValue":"Append",
"value":"APPEND"
},
{
"description":"Overwrite",
"displayValue":"Overwrite",
"value":"OVERWRITE"
}
],
"title":"Input Mode",
"type":"string"
},
"issueDate":{
"default":"",
"description":"Issue date for Periodical. Valid for PS Form 3541.",
"format":"date",
"title":"Issue Date",
"type":"string"
},
"issueNumber":{
"default":"",
"description":"Issue number of the periodical.",
"title":"Issue Number",
"type":"string"
},
"jobIDUser":{
"default":"",
"description":"User-defined job identifier.",
"title":"Job ID User",
"type":"string"
},
"jobName":{
"default":"",
"description":"User-defined job name.",
"title":"Job Name",
"type":"string"
},
"jobNumber":{
"default":"",
"description":"User-defined job number.",
"title":"Job Number",
"type":"string"
},
"lastContainer":{
"default":null,
"description":"Specifies the last container within the last stream selected. The DEFAULT value selects the last container within the last stream selected. The container number is with respect to the last stream selected.",
"minimum":1,
"title":"Last Container",
"type":"integer"
},
"location":{
"default":null,
"description":"The folder where the Mail.dat files are stored. A trailing delimiter must be included.",
"minLength":1,
"title":"Location",
"type":"string"
},
"machineID":{
"default":"",
"description":"ID of the machine used to manufacture pieces in the container",
"title":"Machine ID",
"type":"string"
},
"mailerMailerLocation":{
"default":"",
"description":"Mailer name and city.",
"title":"Mailer Mailer Location",
"type":"string"
},
"mailingFacility":{
"default":"",
"description":"USPS location where the mail is dropped for verification.",
"title":"Mailing Facility",
"type":"string"
},
"mailingFacilityZip4":{
"default":"",
"description":"ZIP Code of the USPS location where the mail is dropped for verification.",
"title":"Mailing Facility ZIP4",
"type":"string",
"pattern":"^[0-9]{5}$|[0-9]{9}$"
},
"mailPieceADPercent":{
"default":0,
"description":"Uses the advertising percentage defined in the presort.",
"maximum":100,
"minimum":0,
"title":"Mail Piece Ad Percent",
"type":"number"
},
"mailPieceADStatus":{
"default":" ",
"description":"Status of the advertising percentage calculation",
"enum":[
"F",
"M",
"N",
"P"
],
"enumValues":[
{
"description":"Final",
"displayValue":"Final",
"value":"F"
},
{
"description":"Manifest",
"displayValue":"Manifest",
"value":"M"
},
{
"description":"None",
"displayValue":"None",
"value":"N"
},
{
"description":"Pending",
"displayValue":"Pending",
"value":"P"
}
],
"title":"Mail Piece Ad Status",
"type":"string"
},
"mailPieceDescription":{
"default":"",
"description":"Describes the mailpiece. The MPU Piece Description field is populated with the mailpiece description.",
"title":"Mail Piece Description",
"type":"string"
},
"mailPieceName":{
"default":"",
"description":"Defines the mailpiece. The MPU Piece Name field is populated with the mailpiece name.",
"title":"Mail Piece Name",
"type":"string"
},
"mailPieceSampleGroupID":{
"default":"",
"description":"Identifies a group of mailpiece samples loaded to USPS Business Customer Gateway for promotion eligibility.",
"title":"Mail Piece Sample Group ID",
"type":"string"
},
"mailPieceStatus":{
"default":false,
"description":"Includes the Mail Piece Status in the .pdr, if the field exists in the address table.",
"title":"Mail Piece Status",
"type":"boolean"
},
"mirTable":{
"default":false,
"description":"Produces a Mail.dat MIR file",
"title":"MIR Table",
"type":"boolean"
},
"misshippedContainerPayer":{
"default":"",
"description":"Used for eInduction misshipped processing support.",
"title":"Misshipped Container Payer",
"type":"string"
},
"moveUpdateDate":{
"default":"",
"description":"Date the address table underwent MOVE update processing.",
"format":"date",
"title":"Move Update Date",
"type":"string"
},
"moveUpdateMethod":{
"default":" ",
"description":"Method used to update address moves.",
"enum":[
"0",
"1",
"2",
"4",
"5",
"6",
"7",
"8"
],
"enumValues":[
{
"description":"ACS",
"displayValue":"ACS",
"value":"1"
},
{
"description":"Endorsements",
"displayValue":"Endorsements",
"value":"5"
},
{
"description":"Mailer",
"displayValue":"Mailer",
"value":"4"
},
{
"description":"Multiple",
"displayValue":"Multiple",
"value":"6"
},
{
"description":"NCOALink",
"displayValue":"NCOALink",
"value":"2"
},
{
"description":"None",
"displayValue":"None",
"value":"0"
},
{
"description":"OneCodeACS",
"displayValue":"OneCodeACS",
"value":"8"
},
{
"description":"Simpliefied",
"displayValue":"Simplified",
"value":"7"
}
],
"title":"Move Update Method",
"type":"string"
},
"mppParcelsOnly":{
"default":false,
"description":"Includes only multipiece parcels in the output.",
"title":"MPP Parcels Only",
"type":"boolean"
},
"msrTable":{
"default":false,
"description":"Produces a Mail.dat MSR file",
"title":"MSR Table",
"type":"boolean"
},
"newspaper":{
"default":false,
"description":"Indicates the publication is published weekly or more often and should receive newspaper treatment by the USPS.",
"title":"Newspaper",
"type":"boolean"
},
"nonSimplifiedOnly":{
"default":false,
"description":"Includes only non-simplified containers. Valid only with ECR presorts.",
"title":"Non Simplified Only",
"type":"boolean"
},
"numericDisplayContainerID":{
"default":false,
"description":"The ‘Display Container ID’ field in the CSM is populated without a leading character to identify the container type.",
"title":"Numeric Display Container ID",
"type":"boolean"
},
"ownersReferenceID":{
"default":"",
"description":"A unique identification meaningful to the mail owner.",
"title":"Owners Reference ID",
"type":"string"
},
"palletSackOrder":{
"default":false,
"description":"Produces output with records on pallets first, followed by records in sacks.",
"title":"Pallet Sack Order",
"type":"boolean"
},
"pbcTable":{
"default":"",
"description":"Produces a Mail.dat PBC file",
"title":"PBC Table",
"type":"boolean"
},
"pdrTable":{
"default":false,
"description":"Produces a Mail.dat PDR file",
"title":"PDR Table",
"type":"boolean"
},
"pendingPeriodical":{
"default":" ",
"description":"Status of the advertising percentage calculation.",
"enum":[
"A",
"B",
"C",
"D",
"E",
"F",
"N"
],
"enumValues":[
{
"description":"First Class Mail, Enclosure",
"displayValue":"First Class Mail, Enclosure",
"value":"D"
},
{
"description":"N/A",
"displayValue":"N/A",
"value":"N"
},
{
"description":"Periodical As First Class",
"displayValue":"Periodical As First Class",
"value":"A"
},
{
"description":"Periodical As Periodical",
"displayValue":"Periodical As Periodical",
"value":"B"
},
{
"description":"Periodical As Standard",
"displayValue":"Periodical As Standard",
"value":"C"
},
{
"description":"Periodicals, Supplement",
"displayValue":"Periodicals, Supplement",
"value":"F"
},
{
"description":"Standard Mail, Enclosure",
"displayValue":"Standard Mail, Enclosure",
"value":"E"
}
],
"title":"Pending Periodical",
"type":"string"
},
"periodUserOptionCompany":{
"default":" ",
"description":"Provides a unique value at the company level, for other (third party) products to identify the Mail Owner.",
"enum":[
"1",
"2"
],
"enumValues":[
{
"description":"Mailer",
"displayValue":"Mailer",
"value":"2"
},
{
"description":"Publisher",
"displayValue":"Publisher",
"value":"1"
}
],
"title":"Period User Option Company",
"type":"string"
},
"permit":{
"default":"",
"description":"Selects the permit used for the mailing. The 10-digit Permit ID or the Permit Description may be used.",
"title":"Permit",
"type":"string"
},
"permitAdditional":{
"default":"",
"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.",
"title":"Permit Additional",
"type":"string"
},
"physicalEntryZip":{
"default":"",
"description":"Building ZIP Code of the building receiving the mail ",
"pattern":"^[0-9]{5}$|[0-9]{9}$",
"title":"Physical Entry ZIP",
"type":"string"
},
"pickupDateTime":{
"default":"",
"description":"Acutal Date and time when the mailing is picked up from the mailing or agent’s facility",
"format":"date",
"title":"Pickup Date Time",
"type":"string"
},
"pickupScheduledDateTime":{
"default":"",
"description":"Date and time when the mailing is scheduled for pick up from the mailing or agent’s facility.",
"format":"date",
"title":"Pickup Scheduled Date Time",
"type":"string"
},
"postageGroupingID":{
"default":"",
"description":"Identifies the group of containers for which a single Postage Payment was made.",
"title":"Postage Grouping ID",
"type":"string"
},
"postagePaymentMethod":{
"default":"",
"description":"Describes the method used to pay the postage.",
"enum":[
"S",
"P",
"L",
"C",
"M",
"A",
"H",
"I",
"G",
"T"
],
"enumValues":[
{
"description":"Stamp",
"displayValue":"Stamp",
"value":"S"
},
{
"description":"Permit",
"displayValue":"Permit",
"value":"P"
},
{
"description":"Metered: Lowest",
"displayValue":"Metered: Lowest",
"value":"L"
},
{
"description":"Metered: Correct",
"displayValue":"Metered: Correct",
"value":"C"
},
{
"description":"Metered: Neither",
"displayValue":"Metered: Neither",
"value":"M"
},
{
"description":"Alternate Address",
"displayValue":"Alternate Address",
"value":"A"
},
{
"description":"Cash",
"displayValue":"Cash",
"value":"H"
},
{
"description":"Partial Permit Imprint",
"displayValue":"Partial Permit Imprint",
"value":"I"
},
{
"description":"Government Permit",
"displayValue":"Government Permit",
"value":"G"
},
{
"description":"Periodicals Pending Permit",
"displayValue":"Periodicals Pending Permit",
"value":"T"
}
],
"title":"Postage Payment Method",
"type":"string"
},
"postagePaymentOption":{
"default":" ",
"description":"How the postage is paid.",
"enum":[
"B",
"C",
"D",
"O",
"T",
"V"
],
"enumValues":[
{
"description":"Billing",
"displayValue":"Billing",
"value":"B"
},
{
"description":"CAPS",
"displayValue":"CAPS",
"value":"T"
},
{
"description":"CPP",
"displayValue":"CPP",
"value":"C"
},
{
"description":"Debit",
"displayValue":"Debit",
"value":"D"
},
{
"description":"Other",
"displayValue":"Other",
"value":"O"
},
{
"description":"PVDS",
"displayValue":"PVDS",
"value":"V"
}
],
"title":"Postage Payment Option",
"type":"string"
},
"incentiveType":{
"default":"",
"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.",
"enum":[
"",
"ME",
"PI",
"SS",
"MI",
"CP",
"RR",
"1X",
"RG",
"CR"
],
"enumValues":[
{
"description":"",
"displayValue":"",
"value":""
},
{
"description":"Emerging and Advanced Tech",
"displayValue":"Emerging and Advanced Tech",
"value":"ME"
},
{
"description":"Informed Delivery",
"displayValue":"Informed Delivery",
"value":"PI"
},
{
"description":"Tactile Mailpiece Engagement",
"displayValue":"Tactile Mailpiece Engagement",
"value":"SS"
},
{
"description":"Mobile Shopping",
"displayValue":"Mobile Shopping",
"value":"MI"
},
{
"description":"Personalized Color Transpromo",
"displayValue":"Personalized Color Transpromo",
"value":"CP"
},
{
"description":"Earned Value Reply Mail",
"displayValue":"Earned Value Reply Mail",
"value":"RR"
},
{
"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"
}
],
"title":"Incentive Type",
"type":"string"
},
"presortName":{
"default":"",
"description":"Description of the saved presort file.",
"title":"Presort Name",
"type":"string"
},
"PTSFTPLoginID":{
"default":"",
"description":"FTP Login ID used for PTS when doing Shipping Services Files",
"title":"PTS FTP Login ID",
"type":"string"
},
"publicationNumber":{
"default":"",
"description":"Publication number. Valid for PS Form 3541.",
"title":"Publication Number",
"type":"string"
},
"repositionableNote":{
"default":false,
"description":"Mailing includes a repositionable note.",
"title":"Repositionable Note",
"type":"boolean"
},
"reservationNumber":{
"default":"",
"description":"Appointment number for the container.",
"title":"Reservation Number",
"type":"string"
},
"resetPackageID":{
"default":false,
"description":"When adding a presort to an existing Mail.dat file set, and a sequential number is used for the Package ID field, the values used for the presort being added will begin with a value based on the last value written to the PQT.",
"title":"Reset Package ID",
"type":"boolean"
},
"resetUserInformationSackNumber":{
"default":false,
"description":"",
"title":"Reset user Information Sack Number",
"type":"boolean"
},
"rideAlong":{
"default":false,
"description":"Indicates the mailpiece is attached to a Periodical mailing as a Ride-Along piece.",
"title":"Ride-Along",
"type":"boolean"
},
"rideAlongDescription":{
"default":"",
"description":"Describes the Ride-Along piece included with the main mailpiece. For example, if the mailpiece is a Periodical with an enclosed First-Class Mail renewal notice, the Ride-Along component is the renewal notice.",
"title":"Ride-Along Description",
"type":"string"
},
"rideAlongLength":{
"default":0,
"description":"The length of the Ride-Along piece.",
"minimum":0,
"title":"Ride-Along Length",
"type":"number"
},
"rideAlongProcessingCategory":{
"default":" ",
"description":"Describes the main component of the mail piece. For example, if the mail piece is a Periodical with an enclosed First-Class Mail renewal notice, the ride-along component is the renewal notice.",
"enum":[
"CD",
"CM",
"FL",
"IR",
"LT",
"MP",
"OS",
"PF"
],
"enumValues":[
{
"description":"Card",
"displayValue":"Card",
"value":"CD"
},
{
"description":"Customized MarketMail",
"displayValue":"Customized MarketMail",
"value":"CM"
},
{
"description":"Flat",
"displayValue":"Flat",
"value":"FL"
},
{
"description":"Irregular Parcel",
"displayValue":"Irregular Parcel",
"value":"IR"
},
{
"description":"Letter",
"displayValue":"Letter",
"value":"LT"
},
{
"description":"Machinable Parcel",
"displayValue":"Machinable Parcel",
"value":"MP"
},
{
"description":"Outside Parcel",
"displayValue":"Outside Parcel",
"value":"OS"
},
{
"description":"Parcel - First Class",
"displayValue":"Parcel - First Class",
"value":"PF"
}
],
"title":"Ride-Along Processing Category",
"type":"string"
},
"rideAlongThickness":{
"default":0,
"description":"The thickness of the Ride-Along piece.",
"minimum":0,
"title":"Ride-Along Thickness",
"type":"number"
},
"rideAlongWeight":{
"default":0,
"description":"The weight of the Ride-Along piece.",
"minimum":0,
"title":"Ride-Along Weight",
"type":"number"
},
"rideAlongWeightSource":{
"default":" ",
"description":"Source of weight data.",
"enum":[
"A",
"C",
"L",
"P"
],
"enumValues":[
{
"description":"Agent",
"displayValue":"Agent",
"value":"A"
},
{
"description":"Calculated",
"displayValue":"Calculated",
"value":"C"
},
{
"description":"Logical",
"displayValue":"Logical",
"value":"L"
},
{
"description":"Postal",
"displayValue":"Postal",
"value":"P"
}
],
"title":"Ride-Along Weight Source",
"type":"string"
},
"rideAlongWeightStatus":{
"default":" ",
"description":"Status of Ride-along piece calculation,",
"enum":[
"F",
"M",
"N",
"P"
],
"enumValues":[
{
"description":"Final",
"displayValue":"Final",
"value":"F"
},
{
"description":"Manifest",
"displayValue":"Manifest",
"value":"M"
},
{
"description":"None",
"displayValue":"None",
"value":"N"
},
{
"description":"Pending",
"displayValue":"Pending",
"value":"P"
}
],
"title":"Ride-Along Weight Status",
"type":"string"
},
"rideAlongWidth":{
"default":0,
"description":"Width of the Ride-Along piece.",
"minimum":0,
"title":"Ride-Along Width",
"type":"number"
},
"RMAdditionalImageURL":{
"default":"",
"description":"Informed Delivery: Location of a second image displayed. Constant text must be enclosed in single quotes ('') and expressions referencing fields must be enclosed in brackets ([]).",
"title":"Referenceable Mail Additional Image URL",
"type":"string"
},
"RMAdditionalTargetURL":{
"default":"",
"description":"Informed Delivery: Link to a company website or other Internet page. Constant text must be enclosed in single quotes ('') and expressions referencing fields must be enclosed in brackets ([]).",
"title":"Referenceable Mail Additional Target URL",
"type":"string"
},
"RMIDType":{
"default":"",
"description":"Informed Delivery: Type of record representing the referenceable mail.",
"enum":[
"B",
"C",
"P"
],
"enumValues":[
{
"description":"Component",
"displayValue":"Component",
"value":"C"
},
{
"description":"Piece Barcode",
"displayValue":"Piece Barcode",
"value":"B"
},
{
"description":"Piece Detail",
"displayValue":"Piece Detail",
"value":"P"
}
],
"title":"Referenceable Mail ID Type",
"type":"string"
},
"RMReplacementImageURL":{
"default":"",
"description":"Informed Delivery: Location of image displayed in place of the scanned mailpiece. Participating mailers can replace or supplement the grayscale image from their letter-sized mailing with an interactive (clickable) color image, allowing users to take immediate action on a mailpiece. Constant text must be enclosed in single quotes ('') and expressions referencing fields must be enclosed in brackets ([]).",
"title":"Referenceable Mail Replacement Image URL",
"type":"string"
},
"RMTemplateCode":{
"default":"",
"description":"Informed Delivery: One of the many templates provided by the USPS (A-Z).",
"title":"Referenceable Mail Template Code",
"type":"string"
},
"seedNameIDExpression":{
"default":"",
"description":"Expression to uniquely identify the seed records in the address table.",
"title":"Seed Name ID Expression",
"type":"string"
},
"seedType":{
"default":" ",
"description":"Defines the services used with the seed mail piece.",
"enum":[
"B",
"C",
"R",
"S"
],
"enumValues":[
{
"description":"Smart Confirm",
"displayValue":"Smart Confirm",
"value":"S"
},
{
"description":"Standard Confirm",
"displayValue":"Standard Confirm",
"value":"C"
},
{
"description":"Traditional Standard",
"displayValue":"Traditional Standard",
"value":"B"
},
{
"description":"Traditional",
"displayValue":"Traditional",
"value":"R"
}
],
"title":"Seed Type",
"type":"string"
},
"segmentDescription":{
"default":"",
"description":"Description at single mail stream level. Describes string, list, mail-stream characteristics.",
"title":"Segment Description",
"type":"string"
},
"segmentInformationExchange":{
"default":"",
"description":"Allows the exchange of information between the mailer and another party; for example, the mail owner or logistic provider.",
"title":"Segment Information Exchange",
"type":"string"
},
"segmentingCriteria":{
"default":"",
"description":"Criteria used to segment the mailing. A mailing should only be segmented if portions require different types of processing",
"title":"Segmenting Criteria",
"type":"string"
},
"segmentUserOption":{
"default":"",
"description":"Include for custom data for unique user applications.",
"title":"Segment User Option",
"type":"string"
},
"sequentialPieceID":{
"default":false,
"description":"Writes a sequential number to the PDR Piece ID field and the MIR Piece ID field. The sequential number begins at one for the first record in the PDR and MIR tables, and increments by one for each additional record.",
"title":"Sequential Piece ID",
"type":"boolean"
},
"serviceAmountDue":{
"default":0,
"description":"COD amount due",
"minimum":0,
"title":"Service Amount Due",
"type":"number"
},
"serviceSet":{
"default":"",
"description":"Space delimited string made up of letter codes, to identify Service Types in the Mail.dat .sfr file. Refer to the IDEAlliance mail.dat specification for definitions of the letter codes.",
"title":"Service Set",
"type":"string"
},
"serviceValue":{
"default":0,
"description":"Value, in whole dollars, of a single mail piece.",
"minimum":0,
"title":"Service Value",
"type":"number"
},
"setupCode":{
"default":"",
"description":"User-defined code to identify production criteria for a mailing",
"title":"Setup Code",
"type":"string"
},
"sfrTable":{
"default":false,
"description":"Produces a Mail.dat SFR file",
"title":"SFR Table",
"type":"boolean"
},
"shipDate":{
"default":"",
"description":"Date and time when the mailing is released from the mailing or agent’s facility.",
"format":"date",
"title":"Ship Date",
"type":"string"
},
"shipScheduledDateTime":{
"default":"",
"description":"Date and time when the mailing is scheduled from the mailing or agent’s facility.",
"format":"date-time",
"title":"Ship Schedule Date Time",
"type":"string"
},
"simplifiedOnly":{
"default":false,
"description":"Includes only simplified containers. Valid only with ECR presorts.",
"title":"Simplified Only",
"type":"boolean"
},
"snrTable":{
"default":false,
"description":"Produces a Mail.dat SNR file",
"title":"SNR Table",
"type":"boolean"
},
"ssFile":{
"default":false,
"description":"Shipping Services File, required for all mailing using the IMpb. Mailers must first pass the USPS Certification process.",
"title":"SS File",
"type":"boolean"
},
"ssfImpbAmountDue":{
"default":0,
"description":"COD amount due, when using COD for the IMpbServices.",
"minimum":0,
"title":"SSF IMpb Amount Due",
"type":"number"
},
"ssfImpbValueOfArticle":{
"default":0,
"description":"Value of an insured package. Used when an Insurance service is used with an IMpb Commercial package.",
"minimum":0,
"title":"SSF IMpb Value of Article",
"type":"number"
},
"statementDateTime":{
"default":"",
"description":"Postage Statement date and time.",
"format":"date-time",
"title":"Statement Date Time",
"type":"string"
},
"stopDesignator":{
"default":"",
"description":"Transportation information, if available.",
"title":"Stop Designator",
"type":"string"
},
"streamList":{
"default":"ALL;ALL ALL",
"description":"Mail streams to use for the job. It is displayed as Stream, NDC, NDC Number. The stream name may be specified without a destination or with a destination and ZIP Code™. Additionally, any word of the stream name may be specified as ALL or omitted to indicate that all streams present in the presort, that match other specified criteria, should be selected. When using the command ALL;ALL ALL, presort streams will be processed in the order: Destination (alphabetical) / ZIP (3-digit followed by 5-digit) / Stream (by type).",
"title":"Stream List",
"type":"string"
},
"streamOrder":{
"default":"",
"description":"Defines the order streams are output.",
"enum":[
"CONTAINERS",
"DESTINATION",
"LASTSAVED",
"PIECES",
"STREAM",
"ZIP"
],
"enumValues":[
{
"description":"Containers",
"displayValue":"Containers",
"value":"CONTAINERS"
},
{
"description":"Destination",
"displayValue":"Destination",
"value":"DESTINATION"
},
{
"description":"Last Saved",
"displayValue":"Last Saved",
"value":"LASTSAVED"
},
{
"description":"Pieces",
"displayValue":"Pieces",
"value":"PIECES"
},
{
"description":"Stream",
"displayValue":"Stream",
"value":"STREAM"
},
{
"description":"ZIP",
"displayValue":"ZIP",
"value":"ZIP"
}
],
"title":"Stream Order",
"type":"string"
},
"subset":{
"title":"Filter for creating a subset of the presort",
"description":"Creates a subset of the presorted items for Containers, Pallets, or Streams. Must be prefaced with a single character ((C)ontainers), (P)allets, (S)treams). Containers are either sacks or trays, Pallets are the physical pallets and streams are the presorted streams. May contain multiple values separated by commas. Each value must contain either an integer range specified as 'x-y', or a single integer. (i.e. 'P1-6,10' is pallets 1 thru 6, and 10) If specified the following commands will be ignored: firstContainer, lastContainer and streamList.",
"default":"",
"type":"string",
"pattern":"((C|P|S)\\d+(-\\d+)?(,\\d+(-\\d+)?)*|^$)"
},
"substitutedContainerPrep":{
"default":" ",
"description":"Allows for container substitution",
"enum":[
"S",
"T"
],
"enumValues":[
{
"description":"Sacks for Trays",
"displayValue":"Sacks for Trays",
"value":"S"
},
{
"description":"Trays for Sacks",
"displayValue":"Trays for Sacks",
"value":"T"
}
],
"title":"Substituted Container Prep",
"type":"string"
},
"transportationDunsNumber":{
"default":"",
"description":"Dun & Bradstreet unique nine-digit sequence for identifying businesses.",
"title":"Transportation DUNS Number",
"type":"string"
},
"transShip":{
"default":"",
"description":"Bill of lading from transportation information, if available",
"title":"Trans Ship",
"type":"string"
},
"truckNumber":{
"default":"",
"description":"Transportation information, if available.",
"title":"Truck Number",
"type":"string"
},
"upaTable":{
"default":false,
"description":"Produces a Mail.dat UPA file",
"title":"UPA Table",
"type":"boolean"
},
"useCountyTable":{
"default":false,
"description":"Calculates In-County rates for Periodicals.",
"title":"Use County Table",
"type":"boolean"
},
"useJobNumber":{
"default":false,
"description":"Uses the Mail.dat job number for the folder name.",
"title":"Use Job Number",
"type":"boolean"
},
"useMailDatFolder":{
"default":false,
"description":"Saves the Mail.dat output into a unique folder",
"title":"Use Mail.dat Folder",
"type":"boolean"
},
"usePresortADPercent":{
"default":false,
"description":"Uses the Advertising % defined in the presort settings.",
"title":"Use Presort Ad Percent",
"type":"boolean"
},
"userInformationLine":{
"default":"",
"description":"Optionally uses a user-defined information line on container tags.",
"title":"User Information Line",
"type":"string"
},
"userInformationLine2":{
"default":"",
"description":"Optionally uses a user-second defined information line on container tags",
"title":"User Information Line 2",
"type":"string"
},
"userLicenseCode":{
"default":"",
"description":"A four-character alphanumeric identification code that must be obtained from IDEAlliance before processing mailings using Mail.dat.",
"minLength":1,
"title":"User License Code",
"type":"string"
},
"userOptionCompany":{
"default":"",
"description":"Provides a unique value at the company level, for other (third party) products to identify the Mail Owner.",
"enum":[
"1",
"2",
"3"
],
"enumValues":[
{
"description":"Mail Owner",
"displayValue":"Mail Owner",
"value":"2"
},
{
"description":"Mailing Agent",
"displayValue":"Mailing Agent",
"value":"3"
},
{
"description":"Permit Holder",
"displayValue":"Permit Holder",
"value":"1"
}
],
"title":"User Option Company",
"type":"string"
},
"userOptionCompanyAdditional":{
"default":0,
"description":"Used if a permit other than the permit used for the regular postage is used.",
"minimum":0,
"title":"User Option Company Additional",
"type":"integer"
},
"uspsPickup":{
"default":" ",
"description":"The USPS picks up the mail at the mailer's facility.",
"enum":[
"N",
"Y"
],
"enumValues":[
{
"description":"No",
"displayValue":"No",
"value":"N"
},
{
"description":"Yes",
"displayValue":"Yes",
"value":"Y"
}
],
"title":"USPS Pickup",
"type":"string"
},
"uspsPickupMailing":{
"default":" ",
"description":"Applied to the entire mailing unless overridden at the container level.",
"enum":[
"N",
"Y"
],
"enumValues":[
{
"description":"No",
"displayValue":"No",
"value":"N"
},
{
"description":"Yes",
"displayValue":"Yes",
"value":"Y"
}
],
"title":"USPS Pickup Mailing",
"type":"string"
},
"version":{
"default":"",
"description":"Mail.dat Version",
"enum":[
"22-1",
"23-1"
],
"enumValues":[
{
"description":"Mail.dat Version 22-1",
"displayValue":"Version 22-1",
"value":"22-1"
},
{
"description":"Mail.dat Version 23-1",
"displayValue":"Version 23-1",
"value":"23-1"
}
],
"title":"Version",
"type":"string"
},
"versionKeyCodeExpression":{
"default":"",
"description":"Expression used to identify the mailing in which the seed name was used.",
"title":"version Key Code Expression",
"type":"string"
},
"volumeNumber":{
"default":"",
"description":"Mail piece volume number.",
"title":"Volume Number",
"type":"string"
},
"walkSequenceDate":{
"default":"",
"description":"Indicates the date that the list was walk sequenced or DSF processed. Required only for Walk Sequence presorts",
"format":"date",
"title":"Walk Sequence Date",
"type":"string"
},
"wsrTable":{
"default":false,
"description":"Produces a Mail.dat WSR file",
"title":"WSR Table",
"type":"boolean"
},
"zip4EncodingDate":{
"default":"",
"description":"Date the address table was ZIP+4 encoded",
"format":"date",
"title":"ZIP4 Encoding Date",
"type":"string"
},
"zipDatabase":{
"default":false,
"description":"Create a zipped database from the Mail.dat output.",
"title":"ZIP Database",
"type":"boolean"
}
},
"required":[
"addressTable",
"contactEmail",
"contactName",
"contactPhone",
"edocSenderCrid",
"fileSetStatus",
"fileSource",
"inputMode",
"jobName",
"jobNumber",
"location",
"mailPieceName",
"mailingFacility",
"mailingFacilityZip4",
"postagePaymentMethod",
"presortName",
"userLicenseCode"
],
"title":"MailDat",
"type":"object"
}
