Presorts an address table and creates an archive for reporting.
This request presorts First Class Mail letter using a selectivity that filters by State.
This request presorts Periodical flat Carrier Route using pallets of packages.
This request runs the same Periodical flat Carrier Route presort, only using pallets of sacks instead of packages.
The reply for presort that encountered an error contains a non-zero error code and a description:
{
"$schema":"http://json-schema.org/draft-04/schema#",
"description":"Presort an address list based on specified parameters and produce a saved presort archive for reporting purposes.",
"type":"object",
"required":[
"addressTable",
"mailClass",
"origZip",
"pcThick",
"pcWt",
"pieceType"
],
"additionalProperties":false,
"properties":{
"addressTable":{
"title":"Address Table",
"description":"Group of records used for processing.",
"type":"string",
"pattern":"(?i)^([0-9]{10}|name\\$.+|file\\$[a-z]+)$"
},
"mailClass":{
"title":"Mail Class",
"description":"The Postal Service divides mail into different services, called 'classes.' Each class of mail has different features, service levels, postage prices, and presort requirements.",
"type":"string",
"enum":[
"FIRST",
"PERIOD",
"STANDARD",
"PARCELPOST",
"BOUNDPRINTED",
"LIBRARYMAIL",
"MEDIAMAIL",
"PSLIGHTWEIGHT",
"PRIORITY"
],
"enumValues":[
{
"value":"FIRST",
"displayValue":"First-Class",
"description":"Sorts pieces as First-Class Mail. This class consists of stamped cards, postcards, letters, and sealed parcels weighing 13 ounces or less. Personal correspondence, including bills and statements of account, must be mailed in this class. The minimum for a First-Class mailing is 500 pieces."
},
{
"value":"PERIOD",
"displayValue":"Periodical",
"description":"Consists of newspapers, magazines, and other publications issued regularly (at least 4 times per year). All periodical publications must be authorized by the USPS."
},
{
"value":"STANDARD",
"displayValue":"Standard",
"description":"Standard Mail is mail matter not required to be mailed as First-Class Mail or Periodicals. Lower nonprofit prices are available for Standard Mail but require specific authorization."
},
{
"value":"PARCELPOST",
"displayValue":"Parcel Select",
"description":"Mail class used for ground delivery service at very low rates for large or heavy packages."
},
{
"value":"BOUNDPRINTED",
"displayValue":"Bound Printed Matter",
"description":"Consist of advertising, promotional, directory, or editorial material (or any combination of such material)."
},
{
"value":"LIBRARYMAIL",
"displayValue":"Library Mail",
"description":"Mail class used by qualifying institutions like libraries, universities, zoos, and research institutions to mail educational and research material."
},
{
"value":"MEDIAMAIL",
"displayValue":"Media Mail",
"description":"Mail class used for books (at least eight pages), film, printed music, printed test materials, sound recordings, etc. "
},
{
"value":"PSLIGHTWEIGHT",
"displayValue":"Parcel Select Lightweight",
"description":"Mail class used for packages weighing less than 1 lb. and used for order fulfillment."
},
{
"value":"PRIORITY",
"displayValue":"Priority",
"description":"First-Class Mail with expedited delivery."
}
]
},
"origZip":{
"title":"Origin ZIP Code",
"description":"Indicates the 5-digit ZIP Code of the Post Office where the mail will be deposited.",
"type":"integer",
"minimum":1,
"maximum":99999
},
"pcThick":{
"title":"Piece Thickness (inches)",
"description":"Used in conjunction with Piece Weight to calculates the number of containers to make.",
"type":"number",
"minimum":0.001
},
"pcWt":{
"title":"Piece Weight (ounces)",
"description":"Used in conjunction with Piece Thickness to calculates the number of containers to make.",
"type":"number",
"minimum":0.001
},
"pieceType":{
"title":"Piece Type",
"description":"Type of mail piece, as defined by the USPS. May be Letter, Card, Flat, Parcel, Machinable Parcel, Nonmachinable Parcel, Irregular Parcel or Marketing Parcel.",
"type":"string",
"enum":[
"LETTER",
"CARD",
"CATALOG",
"FLAT",
"PARCEL",
"MACHINABLEPARCEL",
"NONMACHINABLEPARCEL",
"IRREGULARPARCEL",
"MARKETINGPARCEL"
],
"enumValues":[
{
"value":"LETTER",
"displayValue":"Letter",
"description":"Letters must be rectangular and dimensions must fall in the following ranges (in inches): height 3.5 to 6.125, length 5 to 11.5, and thickness 0.007 to 0.250."
},
{
"value":"CARD",
"displayValue":"Card",
"description":"First-Class pieces must be rectangular and dimensions must fall in the following ranges (in inches): height 3.5 to 4.25, length 5 to 6, and thickness 0.007 to 0.016."
},
{
"value":"CATALOG",
"displayValue":"Catalog",
"description":"Mail piece used for Standard Mail. Dimensions must meet the mail processing category of flat-size mail."
},
{
"value":"FLAT",
"displayValue":"Flat",
"description":"Flat pieces must be rectangular and must exceed at least one of the dimensions for letter-sized mail."
},
{
"value":"PARCEL",
"displayValue":"Parcel",
"description":"Mail piece not meeting the mail processing category of letter-size or flat-size mail."
},
{
"value":"MACHINABLEPARCEL",
"displayValue":"Machinable Parcel",
"description":"Mail piece used for Standard Mail and Package Services. Dimensions must fall in the following ranges: weight 8 ounces to 35 pounds, (in inches) length 6 to 34, height 3 to 17, and thickness 0.25 to 17."
},
{
"value":"NONMACHINABLEPARCEL",
"displayValue":"Nonmachinable Parcel",
"description":"A parcel exceeding any of the maximum dimensions for a machinable parcel."
},
{
"value":"IRREGULARPARCEL",
"displayValue":"Irregular Parcel",
"description":"Irregular parcels include parcels that do not meet the dimensional criteria of machinable parcels and other parcels that cannot be processed by parcel sorters, including: Rolls and tubes up to 26 inches long and merchandise samples not individually addressed; unwrapped, paper-wrapped, or sleeve-wrapped articles that are not letter-size or flat-size (e.g., catalogs, directories). Articles enclosed in envelopes that are not letter-size, flat-size, or machinable parcels."
},
{
"value":"MARKETINGPARCEL",
"displayValue":"Marketing Parcel",
"description":"Marketing Parcels contain information and/or product samples whose purpose is encouraging recipients to purchase a product or service, or provide information to recipients. Marketing parcels have a maximum size of 12 by 9 by 2 inches thick."
}
]
},
"adcOrig":{
"title":"ADC Origin",
"description":"The 5-digit ZIP Code of the Post Office where the mail will be deposited is an ADC facility.",
"default":false,
"type":"boolean"
},
"adcSelectAll":{
"title":"ADC Select All",
"description":"Selects or clears all ADC destinations.",
"default":"N",
"type":"string",
"enum":[
"S",
"C",
"N"
],
"enumValues":[
{
"value":"S",
"displayValue":"Select All",
"description":"Selects all ADC destinations."
},
{
"value":"C",
"displayValue":"Clear All",
"description":"Clears all ADC destinations."
},
{
"value":"N",
"displayValue":"No Action",
"description":"Does not select or clear ADC destinations."
}
]
},
"adcThresholdPieces":{
"title":"ADC Threshold Pieces",
"description":"Specifies the minimum number of pieces required to create an ADC destination stream, when drop shipping to destination facilities.",
"default":-1,
"type":"integer",
"minimum":-1
},
"addressedSupplement":{
"title":"Address Supplement",
"description":"Indicates a supplement is included with the Periodical presort.",
"default":false,
"type":"boolean"
},
"addressGroup":{
"title":"Address Group",
"description":"Records may require more than one address group. For example, a single record may include Headquarters, Shipping, and Invoice addresses.",
"default":"MAIN",
"type":"string",
"enum":[
"MAIN",
"ALT1",
"ALT2"
],
"enumValues":[
{
"value":"MAIN",
"displayValue":"Main Address Group",
"description":"Uses the primary address for the presort."
},
{
"value":"ALT1",
"displayValue":"Alternate Address Group 1",
"description":"Uses the secondary address group for the presort."
},
{
"value":"ALT2",
"displayValue":"Alternate Address Group 2",
"description":"Uses the third available address group for the presort."
}
]
},
"angledBack":{
"title":"Angled Back",
"description":"Used with Optional 1-foot MM trays, to automatically adjust the tray minimum and maximum values, based on Piece Height.",
"default":false,
"type":"boolean"
},
"asfWithParent":{
"title":"ASF With Parent",
"description":"Combines ASF pieces with the parent Destination NDC (DNDC), rather than making a separate ASF stream.",
"default":false,
"type":"boolean"
},
"autoCR":{
"title":"",
"description":"Automated Carrier Route option used for Periodicals mail.",
"default":false,
"type":"boolean"
},
"autoGenerateJobID":{
"title":"",
"description":"Automatically adds the address table name to the presort.",
"default":false,
"type":"boolean"
},
"balanceNonLetterPackSize":{
"title":"",
"description":"Balances the packages of an automated flat sort when packaging is required.",
"default":false,
"type":"boolean"
},
"balancePackSize":{
"title":"",
"description":"Balances the packages of an automated letter sort when packaging is required.",
"default":false,
"type":"boolean"
},
"balancePallets":{
"title":"",
"description":"Balances pallets to a given destination to minimize the occurrence of overflow pieces flowing down to the non-pallet portion of the presort.",
"default":false,
"type":"boolean"
},
"batchExpression":{
"title":"",
"description":"Allows a user-defined expression to specify batch presort parameters.",
"default":"",
"type":"string",
"minLength":0,
"maxLength":255
},
"batchMinimum":{
"title":"",
"description":"Sets a minimum value that must be met for the batch to be made.",
"default":0,
"type":"integer",
"minimum":0
},
"batchSettings":{
"title":"",
"description":"Uses a settings file to create batch presorts. The section name in the Presort Batch Settings file must begin with the name BATCH.",
"default":"",
"type":"string",
"minLength":0,
"maxLength":255
},
"borrowFirstAuto":{
"title":"",
"description":"Automatically moves First-Class Mail pieces from the automated stream to the Machinable or Nonauto stream, based on the presort settings. There must be at least 380 pieces that do not have a ZIP+4 and the number of pieces borrowed will not drop the ZIP+4 number below 500 pieces.",
"default":false,
"type":"boolean"
},
"bundleSizeAndWeight":{
"title":"",
"description":"Allows both the Maximum Pack Size and Maximum Pack Size Pounds to be taken into account when the maximum number of pieces for a package is determined.",
"default":false,
"type":"boolean"
},
"bypassSmallWSPacks":{
"title":"",
"description":"Skips the creation of small Walk Sequence packages when the pack size is less than the minimum for the Mail Class selected.",
"default":false,
"type":"boolean"
},
"capsCustomerReferenceID":{
"title":"",
"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
},
"characteristicFee":{
"title":"Characteristic Fee",
"description":"USPS fees for specific types.",
"default":" ",
"type":"string",
"enum":[
" ",
"CB",
"GS",
"OS",
"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":"GS",
"displayValue":"Geographic Surcharge",
"description":""
},
{
"value":"OS",
"displayValue":"Operational Surcharge",
"description":""
},
{
"value":"PP",
"displayValue":"Picture Permit",
"description":"Provides an opportunity to customize the Permit Imprint Indicia First-Class and Standard Mail letters and cards."
}
]
},
"cmmSort":{
"title":"",
"description":"Option for mailing non-rectangular or irregular-shaped Standard Mail and Nonprofit Standard Mail pieces weighing 3.3 ounces or less",
"default":false,
"type":"boolean"
},
"combineDestinations":{
"title":"",
"description":"Combines all streams for a single destination onto the same postage statement.",
"default":false,
"type":"boolean"
},
"commingle":{
"title":"",
"description":"Packages all batches separately. Intended for large mailers that run multiple simultaneous production lines and co-mail.",
"default":false,
"type":"boolean"
},
"commingleExpression":{
"title":"",
"description":"Enter an expression to create Bindery Sets. This feature is intended for large mailers that run multiple simultaneous production lines and co-mail. Bindery Sets can control which versions are mingled or whether versions are mingled at all. Mailers must have USPS approval to co-mail.",
"default":"",
"type":"string",
"minLength":0,
"maxLength":255
},
"containerType":{
"title":"Container Type",
"description":"Containers used for transporting sorted mail. The default value is dependent on Piece Type.",
"default":"",
"type":"string",
"enum":[
"TRAY",
"EMMTRAY",
"NO2SACK",
"NO3SACK",
"PALLET",
"01VSACK",
"03VSACK",
"CARTON"
],
"enumValues":[
{
"value":"TRAY",
"displayValue":"Tray",
"description":"USPS provided trays, available in 2-foot managed mail (MM) trays; 1-foot MM trays; 2-foot extended MM (EMM) trays and Flat trays. See DMM 203 for dimensions."
},
{
"value":"EMMTRAY",
"displayValue":"EMM Tray",
"description":"2-foot extended MM (EMM) trays."
},
{
"value":"NO2SACK",
"displayValue":"No2 Sack",
"description":"USPS provided canvas sack that holds up to 70 pounds."
},
{
"value":"NO3SACK",
"displayValue":"No3 Sack",
"description":"USPS provided canvas sack that holds up to 45 pounds."
},
{
"value":"PALLET",
"displayValue":"Pallet",
"description":""
},
{
"value":"01VSACK",
"displayValue":"01V Sack",
"description":"USPS provided semi-clear plastic sacks, 44 x 31, using Velcro straps to secure the contents."
},
{
"value":"03VSACK",
"displayValue":"03V Sack",
"description":"USPS provided semi-clear plastic sacks 34 x 31, using Velcro straps to secure the contents."
},
{
"value":"CARTON",
"displayValue":"Carton",
"description":"USPS provided carton for Product Sample mailing."
}
]
},
"contentOfMail":{
"title":"Content Of Mail",
"description":"Identifies the mail piece and corresponding services being submitted on the PS Forms. Also used in Mail.dat and Mail.XML.",
"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"
}
]
},
"coPack":{
"title":"",
"description":"Allows for combining Automation and Presorted flat pieces into the same package for First-Class, Periodical, and Standard Mail Classes.",
"default":true,
"type":"boolean"
},
"cr3DG":{
"title":"Overrides 3-Digit Carrier Route trays",
"description":"",
"default":false,
"type":"boolean"
},
"crMinPack":{
"title":"",
"description":"Indicates a minimum threshold in order to make a CR Pack.",
"default":10,
"type":"integer",
"minimum":0
},
"crUseOriginDdu":{
"title":"",
"description":"Does not automatically include the Origin Entry ZIP Code in the DDU discounts.",
"default":false,
"type":"boolean"
},
"crZipOrder":{
"title":"",
"description":"Places presort output in order by ZIP Code (rather than by ECR level).",
"default":false,
"type":"boolean"
},
"csa":{
"title":"",
"description":"The USPS Customer Supplier/Agreement (CSA) is a negotiated agreement between the Postal Service and the mailer. The CSA file format is specified by the USPS, and will have a one or more records in the file for each CSA pallet destination.",
"default":false,
"type":"boolean"
},
"csaFilename":{
"title":"",
"description":"Specifies the path and filename of the CSA file.",
"default":"",
"type":"string",
"minLength":0,
"maxLength":255
},
"dduSelectAll":{
"title":"DDU Select All",
"description":"Selects or clears all DDU destinations.",
"default":"N",
"type":"string",
"enum":[
"S",
"C",
"N"
],
"enumValues":[
{
"value":"S",
"displayValue":"Select All",
"description":"Selects all DDU destinations."
},
{
"value":"C",
"displayValue":"Clear All",
"description":"Clears all DDU destinations."
},
{
"value":"N",
"displayValue":"No Action",
"description":"Does not select or clear DDU destinations."
}
]
},
"dduThresholdPieces":{
"title":"",
"description":"Specifies the piece threshold for each DDU destination.",
"default":-1,
"type":"integer",
"minimum":-1
},
"destFile":{
"title":"Dest File",
"description":"Activates or deactivates the list of destination entries.",
"default":"",
"type":"string",
"minLength":0,
"maxLength":255
},
"destinationSettings":{
"title":"",
"description":"Allows destination entries to be specified.",
"default":"",
"type":"string",
"minLength":0,
"maxLength":255
},
"dests":{
"title":"",
"description":"Use the Dest File.",
"default":false,
"type":"boolean"
},
"double":{
"title":"",
"description":"Indicates Double Card piece type.",
"default":false,
"type":"boolean"
},
"doubleStacked":{
"title":"",
"description":"Allows multiple columns or stacks of mail pieces to fit in trays.",
"default":false,
"type":"boolean"
},
"ecr":{
"title":"",
"description":"Enhanced Carrier Route, a level of sortation for a mailing where addresses contain a carrier route and either walk sequence or line-of-travel information.",
"default":false,
"type":"boolean"
},
"ecrBC":{
"title":"",
"description":"Used with Walk Sequence to specify barcoded pieces.",
"default":false,
"type":"boolean"
},
"ecrMach":{
"title":"",
"description":"Used with Walk Sequence to specify machinable pieces.",
"default":false,
"type":"boolean"
},
"emmMaxLinearFeet":{
"title":"EMM Max Linear Feet",
"description":"Defines the maximum linear feet of EMM trays on a pallet.",
"default":144,
"type":"integer",
"minimum":0
},
"emmMinLinearFeet":{
"title":"EMM Min Linear Feet",
"description":"Defines the minimum linear feet of EMM trays on a pallet.",
"default":72,
"type":"integer",
"minimum":0
},
"fcmFullTraysOnly":{
"title":"",
"description":"Makes tray levels for First-Class Mail letters and cards only when the tray is full.",
"default":false,
"type":"boolean"
},
"fcmTrayBased":{
"title":"",
"description":"Makes trays of First-Class Mail flats without bundles.",
"default":false,
"type":"boolean"
},
"firm":{
"title":"",
"description":"Firm Packages can be for Periodical presorts if multiple records contain the same ZIP Code, Carrier Route, eLOT and Delivery Point. For example, multiple issues of a magazine being delivered to an office could be made into a Firm Package. This can result in substantial postage savings since the single piece rate is charged for the entire package, plus total poundage.",
"default":false,
"type":"boolean"
},
"firmExpression":{
"title":"",
"description":"Allows a user-defined value used to create firm packages.",
"default":"",
"type":"string",
"minLength":0,
"maxLength":255
},
"firmThreshold":{
"title":"",
"description":"Defines the minimum pieces allowed for Firm Packages.",
"default":2,
"type":"integer",
"minimum":0
},
"firmThresholdMax":{
"title":"",
"description":"Defines the maximum pieces allowed for Firm Packages.",
"default":0,
"type":"integer",
"minimum":0
},
"flatMaxLinearFeet":{
"title":"Flat Max Linear Feet",
"description":"Defines the maximum linear feet of Flat trays on a pallet.",
"default":144,
"type":"integer",
"minimum":0
},
"flatMinLinearFeet":{
"title":"Flat Min Linear Feet",
"description":"Defines the minimum linear feet of Flat trays on a pallet.",
"default":72,
"type":"integer",
"minimum":0
},
"forceSaturation":{
"title":"",
"description":"Allows bypassing the Delivery Statistics file for Computerized Delivery Sequence (CDS) lists. Computerized Delivery Sequence files can be obtained from the USPS. The files provide updated address information and Walk Sequence data.",
"default":false,
"type":"boolean"
},
"forceSinglePieceRate":{
"title":"",
"description":"Forces all pieces to the Single Piece rate, regardless of how many pieces are in the address table.",
"default":false,
"type":"boolean"
},
"fullServiceParticipation":{
"title":"Full Service Participation",
"description":"",
"default":"Level of USPS Full Service Participation, Full, Basic or Other.",
"type":"string",
"enum":[
"F",
"B",
"O"
],
"enumValues":[
{
"value":"F",
"displayValue":"Full Service",
"description":"In addition to using Intelligent Mail barcodes on mailpieces, mailers are required to use the Intelligent Mail tray labels on their handling units (trays, sacks), and the Intelligent Mail container labels on their container placards."
},
{
"value":"B",
"displayValue":"Basic",
"description":"Mailers use the Intelligent Mail barcode for their mailpieces (uniqueness not required), and the use of IMb tray labels or container placards are not required."
},
{
"value":"O",
"displayValue":"Other",
"description":""
}
]
},
"fullTraysOnBottom":{
"title":"",
"description":"Outputs presort in a sequence supporting a more practical, stable approach to loading pallets. The sequence this option supports is full two-foot (bottom), full one-foot, less than full two-foot, and less than full one-foot (top).",
"default":false,
"type":"boolean"
},
"ignoreMin":{
"title":"",
"description":"Allows small DDU pallets (less than 200 pieces).",
"default":false,
"type":"boolean"
},
"incentiveType":{
"title":"Incentive Type",
"description":"Identifies USPS promotions and incentives used to create awareness of innovative uses of mail. The promotions typically are in effect for a 6-month period, and require prior registration.",
"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"
},
{
"value":"1X",
"displayValue":"Enhanced Emerging Tech",
"description":"Enhanced Emerging Tech"
},
{
"description":"Retargeted Mail",
"displayValue":"Retargeted Mail",
"value":"RG"
},
{
"description":"Color Ink with Reply",
"displayValue":"Color Ink with Reply",
"value":"CR"
}
]
},
"includeOffshore":{
"title":"",
"description":"Permits offshore pieces to sort to the appropriate NDCs.",
"default":false,
"type":"boolean"
},
"inCountyOverrides":{
"title":"",
"description":"Allows the 'In-County Indicator' value to indicate if a piece should receive an in-county discount.",
"default":false,
"type":"boolean"
},
"jobID":{
"title":"",
"description":"Allows creating a user-defined ID to identify the presort.",
"default":"",
"type":"string",
"minLength":0,
"maxLength":50
},
"lowVolumeOriginOnly":{
"title":"",
"description":"Limits Low Volume Pallet creation to origin mail streams.",
"default":false,
"type":"boolean"
},
"lowVolumePallets":{
"title":"",
"description":"Allows the last pallet to a destination SCF or NDC to be collected on a pallet, regardless of the volume.",
"default":false,
"type":"boolean"
},
"mailingDateEnd":{
"title":"",
"description":"Date USPS induction ends. Enter in the 'yyyy-mm-dd' format.",
"default":"<current date>",
"type":"string",
"minLength":10,
"maxLength":10
},
"mailingDateStart":{
"title":"",
"description":"Date the mail is dropped and USPS verification begins. Enter in the 'yyyy-mm-dd' format.",
"default":"<current date>",
"type":"string",
"minLength":10,
"maxLength":10
},
"mailStream":{
"title":"Mail Stream",
"description":"The total live mail in USPS custody, from point of acceptance to point of delivery.",
"default":"AUTO",
"type":"string",
"enum":[
"AUTO",
"MACH",
"NONAUTO",
"BARCODED"
],
"enumValues":[
{
"value":"AUTO",
"displayValue":"Auto",
"description":"Produces an Automation-compatible mailing for pieces that contain a ZIP+4 Code and valid Delivery Point, and sorts the remainder according to the setting specified in the nonZip4 setting."
},
{
"value":"MACH",
"displayValue":"Machinable",
"description":"Sorts card or letter-sized mail as Machinable (Standard or First-Class only). Machinable mail must not have any of the characteristics attributed to nonmachinable pieces as described in DMM 201.02.01."
},
{
"value":"NONAUTO",
"displayValue":"Nonauto",
"description":"Sorts pieces that do not have a barcode and cannot go through the automated process."
},
{
"value":"BARCODED",
"displayValue":"Barcoded",
"description":"Sorts mail as Barcoded. Mail must have Pkg Svc Bound Printed, Flat/Machinable, Pkg Svc Parcel Select, Machinable or First-Class Parcels characteristics."
}
]
},
"manifestSettings":{
"title":"",
"description":"User-defined settings file that defines the format, location, access and the editor for the manifest settings.",
"default":"",
"type":"string",
"minLength":0,
"maxLength":255
},
"max01VSack":{
"title":"",
"description":"Maximum allowed size for 01V sacks (lbs).",
"default":70.0,
"type":"number",
"minimum":0.0
},
"max03VSack":{
"title":"",
"description":"Maximum allowed size for 03V sacks (lbs).",
"default":70.0,
"type":"number",
"minimum":0.0
},
"max1Ft":{
"title":"",
"description":"Maximum allowed size for 1 foot trays (inches).",
"default":10.25,
"type":"number",
"minimum":0.0
},
"max2Ft":{
"title":"",
"description":"Maximum allowed size for 1 foot trays (inches).",
"default":21.0,
"type":"number",
"minimum":0.0
},
"max3DGPallet":{
"title":"",
"description":"Maximum weight for pallets of packages.",
"default":2200,
"type":"integer",
"minimum":0
},
"max3DGPalTray":{
"title":"",
"description":"Maximum weight for 3-Digit trays on pallets.",
"default":2200,
"type":"integer",
"minimum":0
},
"max3DGTray":{
"title":"",
"description":"Maximum tiers for 3-Digit trays on pallets.",
"default":12,
"type":"integer",
"minimum":0
},
"max5DGCRTray":{
"title":"",
"description":"Maximum tiers for 5-Digit Carrier Route trays on pallets.",
"default":12,
"type":"integer",
"minimum":0
},
"max5DGPallet":{
"title":"",
"description":"Maximum weight for 5-Digit pallets.",
"default":2200,
"type":"integer",
"minimum":0
},
"max5DGPalTray":{
"title":"",
"description":"Maximum weight for 5-Digit trays on pallets.",
"default":2200,
"type":"integer",
"minimum":0
},
"max5DGTray":{
"title":"",
"description":"Maximum tiers for 5-Digit trays on pallets.",
"default":12,
"type":"integer",
"minimum":0
},
"maxAsfTray":{
"title":"",
"description":"Maximum tiers for ASF trays on pallets.",
"default":12,
"type":"integer",
"minimum":0
},
"maxCsaAir":{
"title":"",
"description":"Maximum tiers for CSA Air trays on pallets.",
"default":12,
"type":"integer",
"minimum":0
},
"maxCsaLocal":{
"title":"",
"description":"Maximum tiers for CSA Local trays on pallets.",
"default":12,
"type":"integer",
"minimum":0
},
"maxCsaMixedAir":{
"title":"",
"description":"Maximum tiers for CSA Mixed Air trays on pallets.",
"default":12,
"type":"integer",
"minimum":0
},
"maxCsaMixedSurface":{
"title":"",
"description":"Maximum tiers for CSA Mixed Surface trays on pallets.",
"default":12,
"type":"integer",
"minimum":0
},
"maxCsaSinglePiece":{
"title":"",
"description":"Maximum tiers for CSA Single Piece trays on pallets.",
"default":12,
"type":"integer",
"minimum":0
},
"maxCsaSurface":{
"title":"",
"description":"Maximum tiers for CSA Surface trays on pallets.",
"default":12,
"type":"integer",
"minimum":0
},
"maxCsaWorking":{
"title":"",
"description":"Maximum tiers for CSA Working trays on pallets.",
"default":12,
"type":"integer",
"minimum":0
},
"maxEmm":{
"title":"",
"description":"Maximum allowed size for EMM trays (inches).",
"default":21.75,
"type":"number",
"minimum":0.0
},
"maxFlatTub":{
"title":"",
"description":"Maximum allowed size for flat tray tubs on pallets (inches).",
"default":11.25,
"type":"number",
"minimum":0.0
},
"maxHt3DGPallet":{
"title":"",
"description":"Maximum height, in feet, for 3-Digit pallets.",
"default":72,
"type":"integer",
"minimum":0
},
"maxHt5DGPallet":{
"title":"",
"description":"Maximum height, in feet, for 5-Digit pallets.",
"default":72,
"type":"integer",
"minimum":0
},
"maxHtMndcPallet":{
"title":"",
"description":"Maximum height, in feet, for Mixed NDC pallets.",
"default":72,
"type":"integer",
"minimum":0
},
"maxHtNdcPallet":{
"title":"",
"description":"Maximum height, in feet, for NDC pallets.",
"default":72,
"type":"integer",
"minimum":0
},
"maxHtScfPallet":{
"title":"",
"description":"Maximum height, in feet, for SCF pallets.",
"default":72,
"type":"integer",
"minimum":0
},
"maxMndcPallet":{
"title":"",
"description":"Maximum weight for Mixed NDC pallets.",
"default":2200,
"type":"integer",
"minimum":0
},
"maxMndcPalTray":{
"title":"",
"description":"Maximum weight for Mixed NDC trays on pallets.",
"default":2200,
"type":"integer",
"minimum":0
},
"maxMndcTray":{
"title":"",
"description":"Maximum tiers for Mixed NDC trays on pallets.",
"default":12,
"type":"integer",
"minimum":0
},
"maxNdcPallet":{
"title":"",
"description":"Maximum weight for NDC pallets.",
"default":2200,
"type":"integer",
"minimum":0
},
"maxNdcPalTray":{
"title":"",
"description":"Maximum weight for NDC trays on pallets.",
"default":2200,
"type":"integer",
"minimum":0
},
"maxNdcTray":{
"title":"",
"description":"Maximum tiers for NDC pallets.",
"default":12,
"type":"integer",
"minimum":0
},
"maxNo2Sack":{
"title":"",
"description":"Maximum allowed size for #2 sacks (lbs).",
"default":70.0,
"type":"number",
"minimum":0.0
},
"maxNo3Sack":{
"title":"",
"description":"Maximum allowed size for #3 sacks (lbs).",
"default":45.0,
"type":"number",
"minimum":0.0
},
"maxPallet":{
"title":"",
"description":"Maximum pallet weight.",
"default":2200.0,
"type":"number",
"minimum":0.0
},
"maxScfPallet":{
"title":"",
"description":"Maximum SCF pallet weight.",
"default":2200,
"type":"integer",
"minimum":0
},
"maxScfPalTray":{
"title":"",
"description":"Maximum weight for SCF trays on pallets.",
"default":2200,
"type":"integer",
"minimum":0
},
"maxScfTray":{
"title":"",
"description":"Maximum tiers for SCF trays on pallets.",
"default":12,
"type":"integer",
"minimum":0
},
"maxTubWt":{
"title":"",
"description":"Maximum weight for flat tray tubs on pallets. Used for Periodicals only.",
"default":70.0,
"type":"number",
"minimum":0
},
"min01VSack":{
"title":"",
"description":"Minimum allowed size for 01V sacks (lbs).",
"default":15.0,
"type":"number",
"minimum":0.0
},
"min03VSack":{
"title":"",
"description":"Minimum allowed size for 03V sacks (lbs).",
"default":15.0,
"type":"number",
"minimum":0.0
},
"min1Ft":{
"title":"",
"description":"Minimum allowed size for 1 foot trays (inches).",
"default":8.71,
"type":"number",
"minimum":0.0
},
"min2Ft":{
"title":"",
"description":"Minimum allowed size for 2 foot trays (inches).",
"default":17.85,
"type":"number",
"minimum":0.0
},
"min3DGPallet":{
"title":"",
"description":"Minimum weight for pallets of packages.",
"default":250,
"type":"integer",
"minimum":0
},
"min3DGPaltray":{
"title":"",
"description":"Maximum weight for pallets of packages.",
"default":250,
"type":"integer",
"minimum":0
},
"min3DGTray":{
"title":"",
"description":"Minimum weight for 3-Digit trays on pallets.",
"default":6,
"type":"integer",
"minimum":0
},
"min5DGCRTray":{
"title":"",
"description":"Minimum tiers for 5-Digit Carrier Route trays on pallets.",
"default":6,
"type":"integer",
"minimum":0
},
"min5DGPallet":{
"title":"",
"description":"Minimum weight for 5-Digit pallets.",
"default":250,
"type":"integer",
"minimum":0
},
"min5DGPalTray":{
"title":"",
"description":"Minimum weight for 5-Digit trays on pallets.",
"default":250,
"type":"integer",
"minimum":0
},
"min5DGTray":{
"title":"",
"description":"Minimum tiers for 5-Digit trays on pallets.",
"default":6,
"type":"integer",
"minimum":0
},
"minAsfTray":{
"title":"",
"description":"Minimum tiers for ASF trays on pallets.",
"default":6,
"type":"integer",
"minimum":0
},
"minEmm":{
"title":"",
"description":"Minimum allowed size for EMM trays (inches).",
"default":18.49,
"type":"number",
"minimum":0.0
},
"minFlatTub":{
"title":"",
"description":"Minimum allowed size for flat tray tubs on pallets (inches).",
"default":8.0,
"type":"number",
"minimum":0.0
},
"minMndcPallet":{
"title":"",
"description":"Minimum weight for Mixed NDC pallets.",
"default":250,
"type":"integer",
"minimum":0
},
"minMndcPalTray":{
"title":"",
"description":"Minimum weight for Mixed NDC trays on pallets.",
"default":250,
"type":"integer",
"minimum":0
},
"minMndcTray":{
"title":"",
"description":"Minimum tiers for Mixed NDC trays on pallets.",
"default":6,
"type":"integer",
"minimum":0
},
"minNdcPallet":{
"title":"",
"description":"Minimum weight for NDC pallets.",
"default":250,
"type":"integer",
"minimum":0
},
"minNdcPalTray":{
"title":"",
"description":"Minimum weight for NDC trays on pallets.",
"default":250,
"type":"integer",
"minimum":0
},
"minNdcTray":{
"title":"",
"description":"Minimum tiers for NDC trays on pallets.",
"default":6,
"type":"integer",
"minimum":0
},
"minNo2Sack":{
"title":"",
"description":"Minimum allowed size for #2 sacks (lbs).",
"default":15.0,
"type":"number",
"minimum":0.0
},
"minNo3Sack":{
"title":"",
"description":"Minimum allowed size for #3 sacks (lbs).",
"default":15.0,
"type":"number",
"minimum":0.0
},
"minPallet":{
"title":"",
"description":"Minimum weight for pallets.",
"default":250.0,
"type":"number",
"minimum":0.0
},
"minScfPallet":{
"title":"",
"description":"Minimum weight for SCF pallets.",
"default":250,
"type":"integer",
"minimum":0
},
"minScfPalTray":{
"title":"",
"description":"Minimum weight for SCF trays on pallets.",
"default":250,
"type":"integer",
"minimum":0
},
"minScfTray":{
"title":"",
"description":"Minimum tiers for SCF trays on pallets.",
"default":250,
"type":"integer",
"minimum":0
},
"mppFirmExpr":{
"title":"",
"description":"Set the Firm expression for Multi-Piece Parcels.",
"default":"",
"type":"string",
"minLength":0,
"maxLength":255
},
"mppMaxPc":{
"title":"",
"description":"Maximum pieces in the Multi-Piece Parcel.",
"default":3,
"type":"integer",
"minimum":0
},
"mppMaxThickness":{
"title":"",
"description":"Maximum Multi-Piece Parcel thickness (inches).",
"default":1.1,
"type":"number",
"minimum":0.0
},
"mppMaxWeight":{
"title":"",
"description":"Maximum Multi-Piece Parcel weight (pounds).",
"default":1.0,
"type":"number",
"minimum":0.0
},
"mppMinPc":{
"title":"",
"description":"Minimum pieces in the Multi-Piece Parcel.",
"default":2,
"type":"integer",
"minimum":0
},
"mppMinThickness":{
"title":"",
"description":"Minimum Multi-Piece Parcel thickness.",
"default":0.1,
"type":"number",
"minimum":0.0
},
"mppMinWeight":{
"title":"",
"description":"Minimum Multi-Piece Parcel weight (pounds).",
"default":0.0,
"type":"number",
"minimum":0.0
},
"mppRepeat":{
"title":"",
"description":"Specifies the simplified repeats expression.",
"default":"",
"type":"string",
"minLength":0,
"maxLength":255
},
"multiPieceParcel":{
"title":"",
"description":"Presort Multi-Piece Parcels.",
"default":false,
"type":"boolean"
},
"ndcOrig":{
"title":"",
"description":"Specifies that the Origin Post Office is an NDC facility and the NDC discount will be applied to pieces that are in that facilities service area.",
"default":false,
"type":"boolean"
},
"ndcSelectAll":{
"title":"NDC Select All",
"description":"Selects or clears all NDC destinations.",
"default":"N",
"type":"string",
"enum":[
"S",
"C",
"N"
],
"enumValues":[
{
"value":"S",
"displayValue":"Select All",
"description":"Selects all NDC destinations."
},
{
"value":"C",
"displayValue":"Clear All",
"description":"Clears all NDC destinations."
},
{
"value":"N",
"displayValue":"No Action",
"description":"Does not select or clear NDC destinations."
}
]
},
"ndcThresholdPieces":{
"title":"",
"description":"The minimum number of pieces needed to create an NDC destination stream for drop shipping.",
"default":-1,
"type":"integer",
"minimum":-1
},
"news":{
"title":"",
"description":"Indicates the publication is published weekly or more often and should receive newspaper treatment by the USPS. Prints 'News' on the second line of container tags for a Periodicals presort.",
"default":false,
"type":"boolean"
},
"no2Tare":{
"title":"",
"description":"Set the tare weight for a 70 lb. sack in lbs.",
"default":2.2,
"type":"number",
"minimum":0.0
},
"no2Volume":{
"title":"",
"description":"Set the volume for a 70 lb. sack in cubic feet.",
"default":3.0,
"type":"number",
"minimum":0.0
},
"no3Tare":{
"title":"",
"description":"Set the tare weight for a 45 lb. sack in lbs.",
"default":1.2,
"type":"number",
"minimum":0.0
},
"no3Volume":{
"title":"",
"description":"Set the volume for a 45 lb. sack in cubic feet.",
"default":1.5,
"type":"number",
"minimum":0.0
},
"nonProfit":{
"title":"",
"description":"Presort qualifies as an authorized Nonprofit mailing.",
"default":false,
"type":"boolean"
},
"nonUspsInSingle":{
"title":"",
"description":"Combines non-USPS First-Class mail pieces into the SINGLE PC stream. The NON USPS stream is not created.",
"default":false,
"type":"boolean"
},
"nonZip4":{
"title":"Sort Non-ZIP+4 as",
"description":"Identifies how pieces lacking a ZIP Code are processed.",
"default":"MACH",
"type":"string",
"enum":[
"AUTONONAUTO",
"MACH",
"NONAUTO",
"OMIT"
],
"enumValues":[
{
"value":"AUTONONAUTO",
"displayValue":"Combine with Auto",
"description":"Allows packages of automation rate and packages of non-automation rate pieces to be combined in the same container."
},
{
"value":"MACH",
"displayValue":"Machinable",
"description":"Sorts pieces that do not have a 9-digit ZIP Code as machinable mail."
},
{
"value":"NONAUTO",
"displayValue":"Nonmachinable",
"description":"Sorts pieces that do not have a barcode and cannot go through the automated process."
},
{
"value":"OMIT",
"displayValue":"Omit",
"description":"Excludes pieces that do not have a 9-digit ZIP Code from the mailing."
}
]
},
"noRepeats":{
"title":"",
"description":"Allows use of a Firm Repeats expression to make individual Firm packages, without combining them with other eligible pieces.",
"default":false,
"type":"boolean"
},
"optional1FtEmmTrays":{
"title":"",
"description":"Supports the use of 1-ft trays with optional EMM trays.",
"default":false,
"type":"boolean"
},
"optional6PcCrd":{
"title":"",
"description":"Creates 6 piece Carrier Route Direct containers where all pieces are going to the same ZIP Code and same Carrier Route. Only available to Periodical, Letters, Non-auto sorts.",
"default":false,
"type":"boolean"
},
"optionalTrays":{
"title":"",
"description":"Allows letter trays when palletizing certain sizes of Standard Mail flat-size pieces.",
"default":false,
"type":"boolean"
},
"optionalTubs":{
"title":"",
"description":"Available for Periodicals Flats only. The Maximum sack size is adjusted for ADC, OMX and MADC containers to the number of pieces that will fit into a Flat Tray.",
"default":false,
"type":"boolean"
},
"originScfPallets":{
"title":"",
"description":"Allows you to 'pull out' all of the local mail and not have it included in a drop shipment elsewhere. Only used for Trays and Sacks on pallets, it creates an Origin SCF pallet of all mail within the SCF region.",
"default":false,
"type":"boolean"
},
"pack_max":{
"title":"",
"description":"Maximum pack size (inches).",
"default":6.0,
"type":"number",
"minimum":1.0,
"maximum":100.0
},
"packMax":{
"title":"",
"description":"Maximum number of pieces to include in a package.",
"default":201,
"type":"integer",
"minimum":0
},
"packMaxLB":{
"title":"",
"description":"Maximum pack size (pounds).",
"default":20.0,
"type":"number",
"minimum":10.0,
"maximum":20.0
},
"packMin":{
"title":"",
"description":"Minimum number of pieces to include in a package.",
"default":10,
"type":"integer",
"minimum":0
},
"packOrd":{
"title":"Pack Order",
"description":"The order in which the packs are sorted by ZIP Code during a presort.",
"default":"LOWTOHIGH",
"type":"string",
"enum":[
"LOWTOHIGH",
"HIGHTOLOW"
],
"enumValues":[
{
"value":"LOWTOHIGH",
"displayValue":"Low To High",
"description":"Low to High sorts the ZIP Codes within the pack from the lowest to highest ZIP Code."
},
{
"value":"HIGHTOLOW",
"displayValue":"High To Low",
"description":"High to Low sorts the ZIP codes within the pack from highest to lowest ZIP Code."
}
]
},
"palletMax":{
"title":"",
"description":"Maximum pieces per pallet.",
"default":0,
"type":"integer",
"minimum":0
},
"palletMin":{
"title":"",
"description":"Minimum pieces per pallet.",
"default":0,
"type":"integer",
"minimum":0
},
"palletSettings":{
"title":"Pallet Settings",
"description":"Enables customized palletization settings.",
"default":false,
"type":"boolean"
},
"palletTare":{
"title":"",
"description":"Set the tare weight for a pallet in lbs.",
"default":10.0,
"type":"number",
"minimum":0.0
},
"pcHeight":{
"title":"",
"description":"Mail piece height (inches).",
"default":4.125,
"type":"number",
"minimum":0.001
},
"pcLength":{
"title":"",
"description":"Mail piece length (inches).",
"default":9.5,
"type":"number",
"minimum":0.001
},
"percentAdvertising":{
"title":"",
"description":"Percentage of advertising included in a periodical.",
"default":0.0,
"type":"number",
"minimum":0.0
},
"perCRMinPack":{
"title":"",
"description":"Allows bundles of fewer than 6 pieces to be mailed as CR packages for Periodicals presorts only.",
"default":6,
"type":"integer",
"minimum":0
},
"perMadcPallets":{
"title":"",
"description":"Prepare ADC pallets with no minimum volume threshold.",
"default":false,
"type":"boolean"
},
"permit":{
"title":"",
"description":"The permit used for the mailing. The 10-digit Permit ID or the Permit Description may be used.",
"default":"",
"type":"string",
"minLength":0,
"maxLength":255
},
"permitAdditional":{
"title":"",
"description":"Specifies an additional permit when presorting. Permit Number or Description may be used.",
"default":"",
"type":"string",
"minLength":0,
"maxLength":255
},
"perOmxPallets":{
"title":"",
"description":"Prepare Periodicals OMX pallets with no minimum volume threshold.",
"default":false,
"type":"boolean"
},
"placeSinglePieceOnOscf":{
"title":"",
"description":"Allows residual/single piece trays to be included on an origin SCF pallet.",
"default":false,
"type":"boolean"
},
"prefer3DGAuto":{
"title":"",
"description":"Skips the ECR basic level if there are enough qualifying 3-Digit pieces at the automated level.",
"default":true,
"type":"boolean"
},
"prefer5DGAuto":{
"title":"",
"description":"Skips Basic ECR level packages if there are enough to qualify for the 5-Digit Auto level (at least 150 5-Digit pieces not in a selected DDU), which is a cheaper rate than the Basic ECR rate. If DDU selections have been specified, then these DDU packages will not be skipped since the DDU rate is less than the 5-Digit Auto rate.",
"default":true,
"type":"boolean"
},
"preferDduOverPallets":{
"title":"",
"description":"Skips DDU qualifying bundles when preparing pallets that are ineligible for the DDU discount.",
"default":false,
"type":"boolean"
},
"presortLimit":{
"title":"",
"description":"Limits the number of pieces up to the value entered.",
"default":0,
"type":"integer",
"minimum":0
},
"presortName":{
"title":"",
"description":"Description of the saved presort file.",
"default":"",
"type":"string",
"minLength":0,
"maxLength":255
},
"presortRepeat":{
"title":"",
"description":"Specifies the non-simplified repeats expression setting.",
"default":"",
"type":"string",
"minLength":0,
"maxLength":255
},
"priorityType":{
"title":"Priority Mail Piece Type",
"description":"Specifies the Priority Mail piece type.",
"default":"",
"type":"string",
"enum":[
"PMFLAT",
"PMPADDED",
"PMLEGAL",
"PMSMBOX",
"PMMEDBOX",
"PMLRGBOX",
"PMAFDBOX",
"PMZONED",
"PMCUBIC"
],
"enumValues":[
{
"value":"PMFLAT",
"displayValue":"Flat Rate Envelope",
"description":"Mail using Priority Mail Express or Priority Mail mailing envelope; charged a single predetermined price regardless of the delivery destination or the actual weight of the contents."
},
{
"value":"PMPADDED",
"displayValue":"Padded Flat Rate Envelope",
"description":"Mail using a padded variation of the Flat Rate Envelope."
},
{
"value":"PMLEGAL",
"displayValue":"Legal Flat Rate Envelope",
"description":"Mail using a Legal-size variation of the Flat Rate Envelope."
},
{
"value":"PMSMBOX",
"displayValue":"Small Flat Rate Box",
"description":"Mail using a USPS-provided Priority Mail mailing container, charged a single predetermined price regardless of the delivery destination or the actual weight of the contents placed inside the box."
},
{
"value":"PMMEDBOX",
"displayValue":"Medium Flat Rate Box",
"description":"Mail using a USPS-provided Priority Mail mailing container that is charged a single predetermined price regardless of the delivery destination or the actual weight of the contents placed inside the box."
},
{
"value":"PMLRGBOX",
"displayValue":"Large Flat Rate Box",
"description":"Mail using a USPS-provided Priority Mail mailing container that is charged a single predetermined price regardless of the delivery destination or the actual weight of the contents placed inside the box."
},
{
"value":"PMAFDBOX",
"displayValue":"Large Flat Rate Box APO/FPO/DPO",
"description":"Mail using a USPS-provided Priority Mail mailing container that is charged a single predetermined price regardless of the delivery destination or the actual weight of the contents placed inside the box."
},
{
"value":"PMZONED",
"displayValue":"Zoned Mail",
"description":"Price structure for certain Priority Mail Express, Priority Mail, Periodicals, Package Services, and Parcel Select products; based on weight and distance traveled (or zones crossed)."
},
{
"value":"PMCUBIC",
"displayValue":"Cubic",
"description":"A discounted price schedule for Priority Mail that consists of five price tiers, based on zone and package size (cubic volume) rather than weight. Packages can range in size up to one half cubic foot and weigh up to 20 pounds."
}
]
},
"psCubic":{
"title":"",
"description":"Flag that indicates use of parcel select cubic during presort.",
"default":false,
"type":"boolean"
},
"publication":{
"title":"",
"description":"Defines the publication used in the presort. The 10-digit Publication ID or the Publication Title may be used.",
"default":"",
"type":"string",
"minLength":0,
"maxLength":255
},
"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."
}
]
},
"reducedOverflow":{
"title":"",
"description":"Eliminates overflow trays for letter presorts.",
"default":false,
"type":"boolean"
},
"repeat":{
"title":"",
"description":"User-defined expression to determine the number of copies for firm bundles.",
"default":"",
"type":"string",
"minLength":0,
"maxLength":255
},
"repositionableNotes":{
"title":"",
"description":"3 by 3 (inches) removable, paper notes are an optional feature for commercial First-Class Mail, Periodicals, and Standard Mail.",
"default":false,
"type":"boolean"
},
"rideWt":{
"title":"",
"description":"Ride-along piece weight in pounds. Ride-Along piece may be attached to or enclosed with an individual copy of Periodicals mail.",
"default":0.0,
"type":"number",
"minimum":0.0,
"maximum":0.20625
},
"sackMax":{
"title":"",
"description":"Maximum number of pieces to place in a sack or tray.",
"default":700,
"type":"integer",
"minimum":0
},
"sackMin":{
"title":"",
"description":"Minimum number of pieces to place in a sack or tray",
"default":595,
"type":"integer",
"minimum":0
},
"sackOrd":{
"title":"Sack Order",
"description":"Defines the residual piece container order.",
"default":"NORMAL",
"type":"string",
"enum":[
"NORMAL",
"RESIDUALSFIRST"
],
"enumValues":[
{
"value":"NORMAL",
"displayValue":"Normal",
"description":"Outputs low level (MADC, ADC, etc.) containers at the end of each mail stream."
},
{
"value":"RESIDUALSFIRST",
"displayValue":"Residuals First",
"description":"Outputs low level (MADC, ADC, etc.) containers at the beginning of each mail stream."
}
]
},
"sackPal":{
"title":"",
"description":"Set to true for presorting Pallets of Sacks. The Container Type must be set to 'PALLET'.",
"default":false,
"type":"boolean"
},
"scfOrig":{
"title":"",
"description":"Set the value to true to specify that the Origin Post Office is an SCF facility and the SCF discount is applied to pieces that are in that facility's service area.",
"default":false,
"type":"boolean"
},
"scfSelectAll":{
"title":"SCF Select All",
"description":"Selects or clears all SCF destinations.",
"default":"N",
"type":"string",
"enum":[
"S",
"C",
"N"
],
"enumValues":[
{
"value":"S",
"displayValue":"Select All",
"description":"Selects all SCF destinations."
},
{
"value":"C",
"displayValue":"Clear All",
"description":"Clears all SCF destinations."
},
{
"value":"N",
"displayValue":"No Action",
"description":"Does not select or clear SCF destinations."
}
]
},
"scfThresholdPieces":{
"title":"",
"description":"This specifies the minimum number of pieces for which an SCF destination stream is created.",
"default":-1,
"type":"integer",
"minimum":-1
},
"selectivity":{
"title":"Selectivity",
"default":null,
"oneOf":[
{
"description":"Resource item identifying the selectivity to use.",
"type":"string",
"pattern":"(?i)^([0-9]{10}|name\\$.+|default\\$)$"
},
{
"description":"Indicates that no selectivity is to be used.",
"type":"null"
},
{
"description":"Defines a selectivity to use by its object representation, excluding the 'id' and 'name' properties.",
"type":"object",
"properties":{
"expression":{
"title":"Expression",
"description":"Expression defining the condition that a record must satisfy to be sampled.",
"default":null,
"oneOf":[
{
"type":"string",
"minLength":1
},
{
"type":"null"
}
]
},
"sampleInterval":{
"title":"Interval Sample",
"description":"Interval at which to sample records; if negative, the sample is inverted.",
"default":null,
"oneOf":[
{
"type":"integer"
},
{
"type":"null"
}
]
},
"sampleRandom":{
"title":"Random Sample",
"description":"Probability of a record being sampled at random.",
"default":null,
"oneOf":[
{
"type":"number",
"minimum":0,
"maximum":1
},
{
"type":"null"
}
]
},
"sampleMaximum":{
"title":"Maximum Sample",
"description":"The maximum number of records to be sampled.",
"default":null,
"oneOf":[
{
"type":"integer",
"minimum":0
},
{
"type":"null"
}
]
}
},
"additionalProperties":false
}
]
},
"separateFirms":{
"title":"",
"description":"Does not combine Repeat firms with other firms.",
"default":false,
"type":"boolean"
},
"simplifiedPackSize":{
"title":"Simplified Pack Size",
"description":"Used in conjunction with Use Simplified Pack Size to calculate the appropriate size for simplified packs based on the Piece Thickness.",
"default":4.0,
"type":"number",
"minimum":0.0
},
"simplifiedRepeat":{
"title":"",
"description":"Used for simplified mail presorts, in conjunction with Use Simplified Pack Size, to calculate the appropriate size for simplified packs based on the Piece Thickness.",
"default":false,
"type":"boolean"
},
"skip5":{
"title":"",
"description":"Skips 5-Digit containers.",
"default":false,
"type":"boolean"
},
"skipDestOrigin":{
"title":"",
"description":"Less-than-full origin containers will not be made for any of the selected destinations.",
"default":false,
"type":"boolean"
},
"skipDimensions":{
"title":"",
"description":"Ignores the dimensions set in the settings and creates EMM trays. If set to false, regular trays are created.",
"default":false,
"type":"boolean"
},
"skipEcrBasic":{
"title":"",
"description":"Optimizes preparation for postage by not selecting using ECR preparation.",
"default":false,
"type":"boolean"
},
"skipFcmOriginPallets":{
"title":"",
"description":"Skips First-Class Mail Origin pallets. The Origin SCF pallet are not made unless there are enough pieces to meet the SCF pallet threshold minimum.",
"default":false,
"type":"boolean"
},
"skipOrigin3Digit":{
"title":"",
"description":"Allows letter pieces in AADC trays to be eligible for DSCF rates.",
"default":false,
"type":"boolean"
},
"smallDduPallets":{
"title":"",
"description":"Creates pallets when there are eligible DDUs with less than the minimum pallet level.",
"default":false,
"type":"boolean"
},
"smallEcrPallets":{
"title":"Small ECR Pallets",
"description":"Allows creation of ECR pallets of packages on Standard and Periodical Flat presorts with less than the normal minimum pallet level.",
"default":false,
"type":"boolean"
},
"smallEcrPalMin":{
"title":"Small ECR Pallet Minimum (lbs)",
"description":"Specifies the minimum pallet level for Small ECR Pallets, in pounds.",
"default":100,
"type":"integer",
"minimum":0,
"maximum":9999
},
"stackablePallets":{
"title":"",
"description":"Indicates that the pallets prepared are stackable.",
"default":false,
"type":"boolean"
},
"comail":{
"title":"Comail",
"description":"Allows the combining of multiple versions of mail pieces to achieve the finest presort level possible.",
"default":false,
"type":"boolean"
},
"tare01V":{
"title":"",
"description":"Set the tare weight for a 01V sack in lbs.",
"default":0.37,
"type":"number",
"minimum":0.0
},
"tare03V":{
"title":"",
"description":"Set the tare weight for a 03V sack in lbs.",
"default":0.27,
"type":"number",
"minimum":0.0
},
"tray3DGMin":{
"title":"3 Digit",
"description":"",
"default":150,
"type":"integer",
"minimum":0,
"maximum":9999
},
"tray5DGMin":{
"title":"5 Digit",
"description":"",
"default":150,
"type":"integer",
"minimum":0,
"maximum":9999
},
"trayAdcMin":{
"title":"ADC/AADC",
"description":"",
"default":150,
"type":"integer",
"minimum":0,
"maximum":9999
},
"trayMaxLinearFeet":{
"title":"Tray Max Linear Feet",
"description":"Defines the maximum linear feet of trays on a pallet.",
"default":144,
"type":"integer",
"minimum":0
},
"trayMinLinearFeet":{
"title":"Tray Min Linear Feet",
"description":"Defines the minimum linear feet of trays on a pallet.",
"default":72,
"type":"integer",
"minimum":0
},
"trayMinOverride":{
"title":"Use Tray Min Overrides",
"description":"",
"default":false,
"type":"boolean"
},
"trayMxdMin":{
"title":"Mixed",
"description":"",
"default":0,
"type":"integer",
"minimum":0,
"maximum":9999
},
"trayPal":{
"title":"",
"description":"Set to true for presorting Pallets of Trays. The Container Type must be 'PALLET'.",
"default":false,
"type":"boolean"
},
"ufsm1000":{
"title":"",
"description":"The mail qualifies for automation rates under the dimensions and characteristics for upgraded flat sorting machine (UFSM) 1000 processing.",
"default":false,
"type":"boolean"
},
"unsacked":{
"title":"",
"description":"Allows unsacked Periodical flats.",
"default":false,
"type":"boolean"
},
"use3DigitFullTray":{
"title":"",
"description":"",
"default":false,
"type":"boolean"
},
"use5DigitFullTray":{
"title":"",
"description":"",
"default":false,
"type":"boolean"
},
"useAadcFullTray":{
"title":"",
"description":"",
"default":false,
"type":"boolean"
},
"useCountyTable":{
"title":"",
"description":"Uses in-county rates for Periodicals presorts.",
"default":false,
"type":"boolean"
},
"useExceptionalDispatch":{
"title":"",
"description":"The provision for exceptional dispatch is intended for short-haul local distribution (zones 1 and 2) of publications with total circulation of no more than 25,000. The publisher must file an application at the office of original or additional entry where the postage is paid on the copies to be transported. Use the ExceptionalDispatch.txt text file to identify Exceptional Dispatch areas.",
"default":false,
"type":"boolean"
},
"useJobIDForCaps":{
"title":"",
"description":"Uses the Job ID for the CAPS customer reference number.",
"default":false,
"type":"boolean"
},
"usePalHt":{
"title":"",
"description":"Allows the height of the pallet to be specified and/or adjusted. Pallet Settings must be set to true.",
"default":false,
"type":"boolean"
},
"usePvds":{
"title":"",
"description":"Specifies that the presort is a Plant Verified Drop Shipment. When set to true, a destination stream is created for each facility listed in the Dest File.",
"default":false,
"type":"boolean"
},
"useRRInFirm":{
"title":"",
"description":"Includes pieces with addresses having Rural Route information in Firm Bundles for Periodicals or a Bound Printed Matter presort. The firm command value must be true.",
"default":false,
"type":"boolean"
},
"userSortOrderExpr":{
"title":"",
"description":"Allows an expression to refine the order of pieces within a bundle.",
"default":"",
"type":"string",
"minLength":0,
"maxLength":255
},
"useSimplifiedPackSize":{
"title":"Use Simplified Pack Size",
"description":"Used in conjunction with Simplified Pack Size to calculate the appropriate size for simplified packs based on the Piece Thickness.",
"default":false,
"type":"boolean"
},
"useVariablePiece":{
"title":"",
"description":"",
"default":false,
"type":"boolean"
},
"validateMinMax":{
"title":"",
"description":"All presort min/max values are adjusted according to the piece dimensions entered.",
"default":true,
"type":"boolean"
},
"validateOrigin":{
"title":"",
"description":"",
"default":false,
"type":"boolean"
},
"variablePieceExpression":{
"title":"",
"description":"",
"default":"",
"type":"string",
"minLength":0,
"maxLength":255
},
"verify5DGZipCodes":{
"title":"",
"description":"Validates the ZIP Code. A Non-USPS mail stream is created for all records that do not have a valid ZIP Code.",
"default":true,
"type":"boolean"
},
"volume01v":{
"title":"",
"description":"Set the volume for a 70 lb. 01V sack in cubic feet.",
"default":4.83,
"type":"number",
"minimum":0.0
},
"volume03v":{
"title":"",
"description":"Set the volume for a 70 lb. 03V sack in cubic feet.",
"default":2.93,
"type":"number",
"minimum":0.0
},
"ws":{
"title":"Walk Sequence",
"description":"Use the Walk Sequence number for a Carrier Route presort (ECR or USECR).",
"default":false,
"type":"boolean"
}
}
}
