Integratec API Platform
modifyPresorted

Description

Modifies an address table using data from a presort.

Example

Request

{
"addressTable":"7112661645",
"presortName":"ConnerStdLtr",
"streamList":"ALL;ALL ALL",
"absoluteContainerNumbers":true,
"fields":{
"imbDigits":{
"mailerID":"000944",
"service":[
"FLS",
"DCM",
"TCS",
"ASE"
],
"confirmLocation":"ALL"
},
"pSeqNum":{
},
"oel":{
"location":"ALL"
},
"packInd":{
},
"sackInd":{
},
"palletInd":{
}
}
}

Reply

{
"result" : "modifyPresorted: Job completed."
}

Request Schema

{
"$schema":"http://json-schema.org/draft-04/schema#",
"title":"ModifyPresorted",
"type":"object",
"properties":{
"addressTable":{
"title":"Address Table",
"description":"Group of records used for processing.",
"type":"string",
"pattern":"(?i)^([0-9]{10}|name\\$.+|file\\$[a-z]+)$"
},
"absoluteContainerNumbers":{
"title":"Absolute Container Numbers",
"description":"Uses continuous container numbers (i.e., does not reset to 1 at the beginning of each stream).",
"default":false,
"type":"boolean"
},
"allBatches":{
"title":"All Batches",
"description":"Sequentially generates output (tags, reports, labels) for all saved presorts associated with the batch presort.",
"default":false,
"type":"boolean"
},
"consecutiveBatchNumbers":{
"title":"Consecutive Batch Numbers",
"description":"Maintains the sequence number on the Manifest Report across all batches in a Batch presort.",
"default":false,
"type":"boolean"
},
"containerPieceLimit":{
"title":"Container Piece Limit",
"description":"Specifies the number of pieces within a container to use as a threshold or ceiling.",
"default":0,
"type":"integer",
"minimum":0
},
"containerThreshold":{
"title":"Container Threshold",
"description":"Specifies how the value specified for the Container Piece Limit command is interpreted. A value of true will treat the Container Piece Limit value as a threshold and a value of false will treat the Container Piece Limit value as a ceiling.",
"default":true,
"type":"boolean"
},
"fields":{
"title":"Fields",
"description":"Description for the saved modification settings.",
"default":"",
"type": "object",
"properties":{
"adc":{
"title":"ADC Number",
"description":"Denotes which ADC services the piece. The number is a unique index of the ADC list.",
"default":null,
"type":"object"
},
"adcLabel":{
"title":"ADC Label",
"description":"Name of the ADC servicing the piece. (i.e. ADC ROCHESTER NY 144)",
"default":null,
"type":"object"
},
"beginOfSack":{
"title":"Begin of Sack",
"description":"Denotes the first piece in a Sack or Tray",
"default":null,
"type":"object",
"properties":{
"fieldName":{
"title":"Field Name",
"description":"Name of the field to mark",
"default":null,
"type":"string"
},
"markingSymbol":{
"title":"Marking Symbol",
"description":"Symbol(s) used to mark the records",
"default":"**",
"type":"string"
}
}
},
"bmc":{
"title":"NDC Number",
"description":"Denotes which NDC services the piece. The number is a unique index of the NDC list.",
"default":null,
"type":"object"
},
"bmcLabel":{
"title":"NDC Label",
"description":"Name of the NDC servicing the piece. (i.e. NDC PITTSBURGH PA 151)",
"default":null,
"type":"object"
},
"imbChars":{
"title":"IMB Chars",
"description":"Intelligent Mail Barcode Characters",
"default":null,
"type": "object",
"properties":{
"alternateCase":{
"title":"Alternate Case",
"description":"Alternate case (22 bars per inch on Kodak Versamark printers)",
"default":false,
"type":"boolean"
},
"confirmLocation":{
"title":"Confirm Location",
"description":"Confirm Location for Destination IMb Tracing / Informed Visibility.",
"default":null,
"type":"string",
"enum":[
"PACKFIRST",
"SACKFIRST",
"ALL"
],
"enumValues":[
{
"value":"PACKFIRST",
"displayValue":"First piece of each pack",
"description":"First piece of each pack"
},
{
"value":"SACKFIRST",
"displayValue":"First piece of each container",
"description":"First piece of each container"
},
{
"value":"ALL",
"displayValue":"All pieces",
"description":"All pieces"
}
]
},
"downgradeNonAuto":{
"title":"Downgrade NonAuto",
"description":"Allows using a Basic Service Type ID (STID) on NonAutomated pieces when the `serviceTypeID` evaluates to a Full Service STID. Only used when `serviceTypeID` is used.",
"default":false,
"type":"boolean"
},
"mailerID":{
"title":"Mailer ID",
"description":"Six or nine-digit number that identifies the mailer or subscriber, provided by the USPS. If it is 9 digits, it must start with a 9; if it is 6 digits, it cannot start with a 9. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]).",
"default":null,
"type":"string",
"pattern":"^[0-8][0-9]{5}$|^[9][0-9]{8}$|^\\[.+\\]$"
},
"includeOnNonValid5D":{
"title":"Include on Non-Valid 5-Digit",
"description":"Include barcode on pieces without a valid 5-Digit ZIP Code",
"default":false,
"type":"boolean"
},
"includeOnAllPieces":{
"title":"Include on All Pieces",
"description":"Include this barcode on all pieces (even those with no IMb Tracing service)",
"default":false,
"type":"boolean"
},
"originID":{
"title":"Origin ID",
"description":"15 digit number combining the Mailer ID and the Sequence Number for Origin Confirm Service. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]). Values less than 15 digits will be padded on the left with zeros.",
"default":null,
"type":"string",
"pattern":"[0-9]+|^\\[.+\\]$"
},
"serial":{
"title":"Serial Number",
"description":"Unique number embedded in barcode used to uniquely identify each piece. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]).",
"default":null,
"type":"string",
"pattern":"[0-9]+|^\\[.+\\]$"
},
"serviceTypeID":{
"title":"Service Type ID",
"description":"Three digit number representing the barcode services. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]). If present takes precedence over service.",
"type":"string",
"pattern":"^\\[.+\\]$|[0-9]{3}"
},
"service":{
"title":"Service",
"description":"Enhancements that, for a fee in addition to postage, provide greater security and accountability for mail, convenience to the sender, or improved handling. Not all extra services are available for all classes of mail and only certain services may be combined for the same mailpiece.",
"default":null,
"type":"array",
"items":{
"enum":[
"ANC",
"ASE",
"ASR",
"BLR",
"BLT",
"BRM",
"CSR",
"DCM",
"FA1",
"FAS",
"FC1",
"FCS",
"FLS",
"FR2",
"FT2",
"OA1",
"OC1",
"OCM",
"OR2",
"OT2",
"PLM",
"SCD",
"TA1",
"TAS",
"TC1",
"TCS",
"TR2",
"TT2"
],
"enumValues":[
{
"value":"ANC",
"displayValue":"Alternative Address No Corrections",
"description":"Alternative Address No Corrections"
},
{
"value":"ASE",
"displayValue":"Ancillary Service Endorsement",
"description":"Ancillary Service Endorsement"
},
{
"value":"ASR",
"displayValue":"OneCode ACS with Address Service Requested, Option 2",
"description":"OneCode ACS with Address Service Requested, Option 2"
},
{
"value":"BLR",
"displayValue":"Ballot Reply Mail",
"description":"Ballot Reply Mail"
},
{
"value":"BLT",
"displayValue":"Ballot Mail",
"description":"Ballot Mail"
},
{
"value":"BRM",
"displayValue":"Business Reply Mail",
"description":"Business Reply Mail"
},
{
"value":"CSR",
"displayValue":"OneCode ACS with Change Service Requested, Option 2",
"description":"OneCode ACS with Change Service Requested, Option 2"
},
{
"value":"DCM",
"displayValue":"Destination IMb Tracing",
"description":"Destination IMb Tracing"
},
{
"value":"FA1",
"displayValue":"Full Service ACS with Address Service Requested, Option 1",
"description":"Full Service ACS with Address Service Requested, Option 1"
},
{
"value":"FAS",
"displayValue":"Full Service ACS with Address Service Requested, Option 2",
"description":"Full Service ACS with Address Service Requested, Option 2"
},
{
"value":"FC1",
"displayValue":"Full Service ACS with Change Service Requested, Option 1",
"description":"Full Service ACS with Change Service Requested, Option 1"
},
{
"value":"FCS",
"displayValue":"Full Service ACS with Change Service Requested, Option 2",
"description":"Full Service ACS with Change Service Requested, Option 2"
},
{
"value":"FLS",
"displayValue":"Full Service",
"description":"Full Service"
},
{
"value":"FR2",
"displayValue":"Full Service ACS with Return Service Requested, Option 2",
"description":"Full Service ACS with Return Service Requested, Option 2"
},
{
"value":"FT2",
"displayValue":"Full Service ACS with Temp Service Requested, Option 2",
"description":"Full Service ACS with Temp Service Requested, Option 2"
},
{
"value":"OA1",
"displayValue":"OneCode ACS with Address Service Requested, Option 1",
"description":"OneCode ACS with Address Service Requested, Option 1"
},
{
"value":"OC1",
"displayValue":"OneCode ACS with Change Service Requested, Option 1",
"description":"OneCode ACS with Change Service Requested, Option 1"
},
{
"value":"OCM",
"displayValue":"Origin IMb Tracing",
"description":"Origin IMb Tracing"
},
{
"value":"OR2",
"displayValue":"OneCode ACS with Return Service Requested, Option 2",
"description":"OneCode ACS with Return Service Requested, Option 2"
},
{
"value":"OT2",
"displayValue":"OneCode ACS with Temp Service Requested, Option 2",
"description":"OneCode ACS with Temp Service Requested, Option 2"
},
{
"value":"PLM",
"displayValue":"Political Mail",
"description":"Political Mail"
},
{
"value":"SCD",
"displayValue":"Secure Destruction",
"description":"Secure Destruction"
},
{
"value":"TA1",
"displayValue":"Traditional ACS with Address Service Requested, Option 1",
"description":"Traditional ACS with Address Service Requested, Option 1"
},
{
"value":"TAS",
"displayValue":"Traditional ACS with Address Service Requested, Option 2",
"description":"Traditional ACS with Address Service Requested, Option 2"
},
{
"value":"TC1",
"displayValue":"Traditional ACS with Change Service Requested, Option 1",
"description":"Traditional ACS with Change Service Requested, Option 1"
},
{
"value":"TCS",
"displayValue":"Traditional ACS with Change Service Requested, Option 2",
"description":"Traditional ACS with Change Service Requested, Option 2"
},
{
"value":"TR2",
"displayValue":"Traditional ACS with Return Service Requested, Option 2",
"description":"Traditional ACS with Return Service Requested, Option 2"
},
{
"value":"TT2",
"displayValue":"Traditional ACS with Temp Service Requested, Option 2",
"description":"Traditional ACS with Temp Service Requested, Option 2"
}
]
}
}
}
},
"imbDigits":{
"title":"IMB Digits",
"description":"Prints human-readable digits representing the bars above the barcode.",
"default":null,
"type": "object",
"properties":{
"confirmLocation":{
"title":"Confirm Location",
"description":"Confirm Location for Destination IMb Tracing.",
"default":null,
"type":"string",
"enum":[
"PACKFIRST",
"SACKFIRST",
"ALL"
],
"enumValues":[
{
"value":"PACKFIRST",
"displayValue":"First piece of each pack",
"description":"First piece of each pack"
},
{
"value":"SACKFIRST",
"displayValue":"First piece of each container",
"description":"First piece of each container"
},
{
"value":"ALL",
"displayValue":"All pieces",
"description":"All pieces"
}
]
},
"downgradeNonAuto":{
"title":"Downgrade NonAuto",
"description":"Allows using a Basic Service Type ID (STID) on NonAutomated pieces when the `serviceTypeID` evaluates to a Full Service STID. Only used when `serviceTypeID` is used.",
"default":false,
"type":"boolean"
},
"mailerID":{
"title":"Mailer ID",
"description":"Six or nine-digit number that identifies the mailer or subscriber, provided by the USPS. If it is 9 digits, it must start with a 9; if it is 6 digits, it cannot start with a 9. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]).",
"default":null,
"type":"string",
"pattern":"^[0-8][0-9]{5}$|^[9][0-9]{8}$|^\\[.+\\]$"
},
"includeOnNonValid5D":{
"title":"Include on Non-Valid 5-Digit",
"description":"Include barcode on pieces without a valid 5-Digit ZIP Code",
"default":false,
"type":"boolean"
},
"includeOnAllPieces":{
"title":"Include on All Pieces",
"description":"Include this barcode on all pieces (even those with no IMb Tracing service)",
"default":false,
"type":"boolean"
},
"originID":{
"title":"Origin ID",
"description":"15 digit number combining the Mailer ID and the Sequence Number for Origin Confirm Service. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]). Values less than 15 digits will be padded on the left with zeros.",
"default":null,
"type":"string",
"pattern":"[0-9]+|^\\[.+\\]$"
},
"serial":{
"title":"Serial Number",
"description":"Unique number embedded in barcode used to uniquely identify each piece. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]).",
"default":null,
"type":"string",
"pattern":"[0-9]+|^\\[.+\\]$"
},
"serviceTypeID":{
"title":"Service Type ID",
"description":"Three digit number representing the barcode services. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]). If present takes precedence over service.",
"type":"string",
"pattern":"^\\[.+\\]$|[0-9]{3}"
},
"service":{
"title":"Service",
"description":"Enhancements that, for a fee in addition to postage, provide greater security and accountability for mail, convenience to the sender, or improved handling. Not all extra services are available for all classes of mail and only certain services may be combined for the same mailpiece.",
"default":null,
"type":"array",
"items":{
"enum":[
"ANC",
"ASE",
"ASR",
"BLR",
"BLT",
"BRM",
"CSR",
"DCM",
"FA1",
"FAS",
"FC1",
"FCS",
"FLS",
"FR2",
"FT2",
"OA1",
"OC1",
"OCM",
"OR2",
"OT2",
"PLM",
"SCD",
"TA1",
"TAS",
"TC1",
"TCS",
"TR2",
"TT2"
],
"enumValues":[
{
"value":"ANC",
"displayValue":"Alternative Address No Corrections",
"description":"Alternative Address No Corrections"
},
{
"value":"ASE",
"displayValue":"Ancillary Service Endorsement",
"description":"Ancillary Service Endorsement"
},
{
"value":"ASR",
"displayValue":"OneCode ACS with Address Service Requested, Option 2",
"description":"OneCode ACS with Address Service Requested, Option 2"
},
{
"value":"BLR",
"displayValue":"Ballot Reply Mail",
"description":"Ballot Reply Mail"
},
{
"value":"BLT",
"displayValue":"Ballot Mail",
"description":"Ballot Mail"
},
{
"value":"BRM",
"displayValue":"Business Reply Mail",
"description":"Business Reply Mail"
},
{
"value":"CSR",
"displayValue":"OneCode ACS with Change Service Requested, Option 2",
"description":"OneCode ACS with Change Service Requested, Option 2"
},
{
"value":"DCM",
"displayValue":"Destination IMb Tracing",
"description":"Destination IMb Tracing"
},
{
"value":"FA1",
"displayValue":"Full Service ACS with Address Service Requested, Option 1",
"description":"Full Service ACS with Address Service Requested, Option 1"
},
{
"value":"FAS",
"displayValue":"Full Service ACS with Address Service Requested, Option 2",
"description":"Full Service ACS with Address Service Requested, Option 2"
},
{
"value":"FC1",
"displayValue":"Full Service ACS with Change Service Requested, Option 1",
"description":"Full Service ACS with Change Service Requested, Option 1"
},
{
"value":"FCS",
"displayValue":"Full Service ACS with Change Service Requested, Option 2",
"description":"Full Service ACS with Change Service Requested, Option 2"
},
{
"value":"FLS",
"displayValue":"Full Service",
"description":"Full Service"
},
{
"value":"FR2",
"displayValue":"Full Service ACS with Return Service Requested, Option 2",
"description":"Full Service ACS with Return Service Requested, Option 2"
},
{
"value":"FT2",
"displayValue":"Full Service ACS with Temp Service Requested, Option 2",
"description":"Full Service ACS with Temp Service Requested, Option 2"
},
{
"value":"OA1",
"displayValue":"OneCode ACS with Address Service Requested, Option 1",
"description":"OneCode ACS with Address Service Requested, Option 1"
},
{
"value":"OC1",
"displayValue":"OneCode ACS with Change Service Requested, Option 1",
"description":"OneCode ACS with Change Service Requested, Option 1"
},
{
"value":"OCM",
"displayValue":"Origin IMb Tracing",
"description":"Origin IMb Tracing"
},
{
"value":"OR2",
"displayValue":"OneCode ACS with Return Service Requested, Option 2",
"description":"OneCode ACS with Return Service Requested, Option 2"
},
{
"value":"OT2",
"displayValue":"OneCode ACS with Temp Service Requested, Option 2",
"description":"OneCode ACS with Temp Service Requested, Option 2"
},
{
"value":"PLM",
"displayValue":"Political Mail",
"description":"Political Mail"
},
{
"value":"SCD",
"displayValue":"Secure Destruction",
"description":"Secure Destruction"
},
{
"value":"TA1",
"displayValue":"Traditional ACS with Address Service Requested, Option 1",
"description":"Traditional ACS with Address Service Requested, Option 1"
},
{
"value":"TAS",
"displayValue":"Traditional ACS with Address Service Requested, Option 2",
"description":"Traditional ACS with Address Service Requested, Option 2"
},
{
"value":"TC1",
"displayValue":"Traditional ACS with Change Service Requested, Option 1",
"description":"Traditional ACS with Change Service Requested, Option 1"
},
{
"value":"TCS",
"displayValue":"Traditional ACS with Change Service Requested, Option 2",
"description":"Traditional ACS with Change Service Requested, Option 2"
},
{
"value":"TR2",
"displayValue":"Traditional ACS with Return Service Requested, Option 2",
"description":"Traditional ACS with Return Service Requested, Option 2"
},
{
"value":"TT2",
"displayValue":"Traditional ACS with Temp Service Requested, Option 2",
"description":"Traditional ACS with Temp Service Requested, Option 2"
}
]
}
}
}
},
"impbBannerText":{
"title":"IMpb Banner Text",
"description":"Text displayed above the IMpb barcode, defined by the combination of services used.",
"default":null,
"type": "object",
"properties":{
"includeOnNonValid5D":{
"title":"Include on Non-Valid 5-Digit",
"description":"Include barcode on pieces without a valid 5-Digit ZIP Code",
"default":false,
"type":"boolean"
},
"mailerID":{
"title":"Mailer ID",
"description":"Six or nine-digit number that identifies the mailer or subscriber, provided by the USPS. If it is 9 digits, it must start with a 9; if it is 6 digits, it cannot start with a 9. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]).",
"default":null,
"type":"string",
"pattern":"^[0-8][0-9]{5}$|^[9][0-9]{8}$|^\\[.+\\]$"
},
"serial":{
"title":"Serial Number",
"description":"Unique number embedded in barcode used to uniquely identify each piece. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]).",
"default":null,
"type":"string",
"pattern":"[0-9]+|^\\[.+\\]$"
},
"serviceTypeID":{
"title":"Service Type ID",
"description":"Three digit number representing the barcode services. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]). If present takes precedence over service.",
"type":"string",
"pattern":"^\\[.+\\]$|[0-9]{3}"
},
"service":{
"title":"Service",
"description":"Enhancements that, for a fee in addition to postage, provide greater security and accountability for mail, convenience to the sender, or improved handling. Not all extra services are available for all classes of mail and only certain services may be combined for the same mailpiece.",
"default":null,
"type":"array",
"items":{
"enum":[
"ASR",
"ARD",
"CRM",
"CAS",
"CAR",
"CRR",
"COD",
"COR",
"HFP",
"IGR",
"MCR",
"ODS",
"RGS",
"RER",
"RRC",
"RRE",
"RSV",
"RTN",
"SGC",
"SCR",
"DVC",
"SBP",
"INL",
"ING"
],
"enumValues":[
{
"value":"ASR",
"displayValue":"Adult Signature Required",
"description":"Adult Signature Required"
},
{
"value":"ARD",
"displayValue":"Adult Signature Restricted Delivery",
"description":"Adult Signature Restricted Delivery"
},
{
"value":"CRM",
"displayValue":"Certified Mail",
"description":"Certified Mail"
},
{
"value":"CAS",
"displayValue":"Certified Mail Adult Signature Required",
"description":"Certified Mail Adult Signature Required"
},
{
"value":"CAR",
"displayValue":"Certified Mail Adult Signature Restricted Delivery",
"description":"Certified Mail Adult Signature Restricted Delivery"
},
{
"value":"CRR",
"displayValue":"Certified Mail Restricted Delivery",
"description":"Certified Mail Restricted Delivery"
},
{
"value":"COD",
"displayValue":"Collect on Delivery",
"description":"Collect on Delivery"
},
{
"value":"COR",
"displayValue":"Collect on Delivery",
"description":"Collect on Delivery"
},
{
"value":"HFP",
"displayValue":"Hold For Pickup",
"description":"Hold For Pickup"
},
{
"value":"IGR",
"displayValue":"Insurance > $500 Restricted Delivery",
"description":"Insurance > $500 Restricted Delivery"
},
{
"value":"MCR",
"displayValue":"Merchandise Return Service",
"description":"Merchandise Return Service"
},
{
"value":"ODS",
"displayValue":"Open and Distribute",
"description":"Open and Distribute"
},
{
"value":"RGS",
"displayValue":"Registered Mail",
"description":"Registered Mail"
},
{
"value":"RER",
"displayValue":"Registered Mail Restricted Delivery",
"description":"Registered Mail Restricted Delivery"
},
{
"value":"RRC",
"displayValue":"Return Receipt",
"description":"Return Receipt"
},
{
"value":"RRE",
"displayValue":"Return Receipt Electronic",
"description":"Return Receipt Electronic"
},
{
"value":"RSV",
"displayValue":"Return Service Flats",
"description":"Return Service Flats"
},
{
"value":"RTN",
"displayValue":"Returns",
"description":"Returns"
},
{
"value":"SGC",
"displayValue":"Signature Confirmation",
"description":"Signature Confirmation"
},
{
"value":"SCR",
"displayValue":"Signature Confirmation Restricted Delivery",
"description":"Signature Confirmation Restricted Delivery"
},
{
"value":"DVC",
"displayValue":"USPS Tracking",
"description":"USPS Tracking"
},
{
"value":"SBP",
"displayValue":"USPS Tracking with SBP",
"description":"USPS Tracking with SBP"
},
{
"value":"INL",
"displayValue":"USPS Tracking, Insurance <= $500",
"description":"USPS Tracking, Insurance <= $500"
},
{
"value":"ING",
"displayValue":"USPS Tracking, Insurance > $500",
"description":"USPS Tracking, Insurance > $500"
}
]
}
},
"zipCodeFormat":{
"title":"ZIP Code Format",
"description":"Defines the number of ZIP Code digits to be used within the barcode data. Choose 9-Digit, 5-Digit, or None (zero digits = no routing information). Use the �Custom:� value to create a user-defined expression that evaluates to 9, 5, or 0.",
"default":9,
"type":"string",
"enum":[
"0",
"5",
"9",
"C"
],
"enumValues":[
{
"value":"0",
"displayValue":"None",
"description":"None"
},
{
"value":"5",
"displayValue":"5-Digit",
"description":"5-Digit ZIP Code"
},
{
"value":"9",
"displayValue":"9-Digit",
"description":"9-Digit ZIP Code"
},
{
"value":"C",
"displayValue":"Custom",
"description":"Custom Expression"
}
]
}
}
},
"impbCharacters":{
"title":"IMpb Characters",
"description":"Intelligent Mail Package Barcode Characters",
"default":null,
"type": "object",
"properties":{
"includeOnNonValid5D":{
"title":"Include on Non-Valid 5-Digit",
"description":"Include barcode on pieces without a valid 5-Digit ZIP Code",
"default":false,
"type":"boolean"
},
"mailerID":{
"title":"Mailer ID",
"description":"Six or nine-digit number that identifies the mailer or subscriber, provided by the USPS. If it is 9 digits, it must start with a 9; if it is 6 digits, it cannot start with a 9. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]).",
"default":null,
"type":"string",
"pattern":"^[0-8][0-9]{5}$|^[9][0-9]{8}$|^\\[.+\\]$"
},
"serial":{
"title":"Serial Number",
"description":"Unique number embedded in barcode used to uniquely identify each piece. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]).",
"default":null,
"type":"string",
"pattern":"[0-9]+|^\\[.+\\]$"
},
"serviceTypeID":{
"title":"Service Type ID",
"description":"Three digit number representing the barcode services. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]). If present takes precedence over service.",
"type":"string",
"pattern":"^\\[.+\\]$|[0-9]{3}"
},
"service":{
"title":"Service",
"description":"Enhancements that, for a fee in addition to postage, provide greater security and accountability for mail, convenience to the sender, or improved handling. Not all extra services are available for all classes of mail and only certain services may be combined for the same mailpiece.",
"default":null,
"type":"array",
"items":{
"enum":[
"ASR",
"ARD",
"CRM",
"CAS",
"CAR",
"CRR",
"COD",
"COR",
"HFP",
"IGR",
"MCR",
"ODS",
"RGS",
"RER",
"RRC",
"RRE",
"RSV",
"RTN",
"SGC",
"SCR",
"DVC",
"SBP",
"INL",
"ING"
],
"enumValues":[
{
"value":"ASR",
"displayValue":"Adult Signature Required",
"description":"Adult Signature Required"
},
{
"value":"ARD",
"displayValue":"Adult Signature Restricted Delivery",
"description":"Adult Signature Restricted Delivery"
},
{
"value":"CRM",
"displayValue":"Certified Mail",
"description":"Certified Mail"
},
{
"value":"CAS",
"displayValue":"Certified Mail Adult Signature Required",
"description":"Certified Mail Adult Signature Required"
},
{
"value":"CAR",
"displayValue":"Certified Mail Adult Signature Restricted Delivery",
"description":"Certified Mail Adult Signature Restricted Delivery"
},
{
"value":"CRR",
"displayValue":"Certified Mail Restricted Delivery",
"description":"Certified Mail Restricted Delivery"
},
{
"value":"COD",
"displayValue":"Collect on Delivery",
"description":"Collect on Delivery"
},
{
"value":"COR",
"displayValue":"Collect on Delivery",
"description":"Collect on Delivery"
},
{
"value":"HFP",
"displayValue":"Hold For Pickup",
"description":"Hold For Pickup"
},
{
"value":"IGR",
"displayValue":"Insurance > $500 Restricted Delivery",
"description":"Insurance > $500 Restricted Delivery"
},
{
"value":"MCR",
"displayValue":"Merchandise Return Service",
"description":"Merchandise Return Service"
},
{
"value":"ODS",
"displayValue":"Open and Distribute",
"description":"Open and Distribute"
},
{
"value":"RGS",
"displayValue":"Registered Mail",
"description":"Registered Mail"
},
{
"value":"RER",
"displayValue":"Registered Mail Restricted Delivery",
"description":"Registered Mail Restricted Delivery"
},
{
"value":"RRC",
"displayValue":"Return Receipt",
"description":"Return Receipt"
},
{
"value":"RRE",
"displayValue":"Return Receipt Electronic",
"description":"Return Receipt Electronic"
},
{
"value":"RSV",
"displayValue":"Return Service Flats",
"description":"Return Service Flats"
},
{
"value":"RTN",
"displayValue":"Returns",
"description":"Returns"
},
{
"value":"SGC",
"displayValue":"Signature Confirmation",
"description":"Signature Confirmation"
},
{
"value":"SCR",
"displayValue":"Signature Confirmation Restricted Delivery",
"description":"Signature Confirmation Restricted Delivery"
},
{
"value":"DVC",
"displayValue":"USPS Tracking",
"description":"USPS Tracking"
},
{
"value":"SBP",
"displayValue":"USPS Tracking with SBP",
"description":"USPS Tracking with SBP"
},
{
"value":"INL",
"displayValue":"USPS Tracking, Insurance <= $500",
"description":"USPS Tracking, Insurance <= $500"
},
{
"value":"ING",
"displayValue":"USPS Tracking, Insurance > $500",
"description":"USPS Tracking, Insurance > $500"
}
]
}
},
"zipCodeFormat":{
"title":"ZIP Code Format",
"description":"Defines the number of ZIP Code digits to be used within the barcode data. Choose 9-Digit, 5-Digit, or None (zero digits = no routing information). Use the �Custom:� value to create a user-defined expression that evaluates to 9, 5, or 0.",
"default":9,
"type":"string",
"enum":[
"0",
"5",
"9",
"C"
],
"enumValues":[
{
"value":"0",
"displayValue":"None",
"description":"None"
},
{
"value":"5",
"displayValue":"5-Digit",
"description":"5-Digit ZIP Code"
},
{
"value":"9",
"displayValue":"9-Digit",
"description":"9-Digit ZIP Code"
},
{
"value":"C",
"displayValue":"Custom",
"description":"Custom Expression"
}
]
}
}
},
"impbDigits":{
"title":"IMpb Digits",
"description":"Intelligent Mail Package Barcode Digits",
"default":null,
"type": "object",
"properties":{
"includeOnNonValid5D":{
"title":"Include on Non-Valid 5-Digit",
"description":"Include barcode on pieces without a valid 5-Digit ZIP Code",
"default":false,
"type":"boolean"
},
"mailerID":{
"title":"Mailer ID",
"description":"Six or nine-digit number that identifies the mailer or subscriber, provided by the USPS. If it is 9 digits, it must start with a 9; if it is 6 digits, it cannot start with a 9. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]).",
"default":null,
"type":"string",
"pattern":"^[0-8][0-9]{5}$|^[9][0-9]{8}$|^\\[.+\\]$"
},
"serial":{
"title":"Serial Number",
"description":"Unique number embedded in barcode used to uniquely identify each piece. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]).",
"default":null,
"type":"string",
"pattern":"[0-9]+|^\\[.+\\]$"
},
"serviceTypeID":{
"title":"Service Type ID",
"description":"Three digit number representing the barcode services. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]). If present takes precedence over service.",
"type":"string",
"pattern":"^\\[.+\\]$|[0-9]{3}"
},
"service":{
"title":"Service",
"description":"Enhancements that, for a fee in addition to postage, provide greater security and accountability for mail, convenience to the sender, or improved handling. Not all extra services are available for all classes of mail and only certain services may be combined for the same mailpiece.",
"default":null,
"type":"array",
"items":{
"enum":[
"ASR",
"ARD",
"CRM",
"CAS",
"CAR",
"CRR",
"COD",
"COR",
"HFP",
"IGR",
"MCR",
"ODS",
"RGS",
"RER",
"RRC",
"RRE",
"RSV",
"RTN",
"SGC",
"SCR",
"DVC",
"SBP",
"INL",
"ING"
],
"enumValues":[
{
"value":"ASR",
"displayValue":"Adult Signature Required",
"description":"Adult Signature Required"
},
{
"value":"ARD",
"displayValue":"Adult Signature Restricted Delivery",
"description":"Adult Signature Restricted Delivery"
},
{
"value":"CRM",
"displayValue":"Certified Mail",
"description":"Certified Mail"
},
{
"value":"CAS",
"displayValue":"Certified Mail Adult Signature Required",
"description":"Certified Mail Adult Signature Required"
},
{
"value":"CAR",
"displayValue":"Certified Mail Adult Signature Restricted Delivery",
"description":"Certified Mail Adult Signature Restricted Delivery"
},
{
"value":"CRR",
"displayValue":"Certified Mail Restricted Delivery",
"description":"Certified Mail Restricted Delivery"
},
{
"value":"COD",
"displayValue":"Collect on Delivery",
"description":"Collect on Delivery"
},
{
"value":"COR",
"displayValue":"Collect on Delivery",
"description":"Collect on Delivery"
},
{
"value":"HFP",
"displayValue":"Hold For Pickup",
"description":"Hold For Pickup"
},
{
"value":"IGR",
"displayValue":"Insurance > $500 Restricted Delivery",
"description":"Insurance > $500 Restricted Delivery"
},
{
"value":"MCR",
"displayValue":"Merchandise Return Service",
"description":"Merchandise Return Service"
},
{
"value":"ODS",
"displayValue":"Open and Distribute",
"description":"Open and Distribute"
},
{
"value":"RGS",
"displayValue":"Registered Mail",
"description":"Registered Mail"
},
{
"value":"RER",
"displayValue":"Registered Mail Restricted Delivery",
"description":"Registered Mail Restricted Delivery"
},
{
"value":"RRC",
"displayValue":"Return Receipt",
"description":"Return Receipt"
},
{
"value":"RRE",
"displayValue":"Return Receipt Electronic",
"description":"Return Receipt Electronic"
},
{
"value":"RSV",
"displayValue":"Return Service Flats",
"description":"Return Service Flats"
},
{
"value":"RTN",
"displayValue":"Returns",
"description":"Returns"
},
{
"value":"SGC",
"displayValue":"Signature Confirmation",
"description":"Signature Confirmation"
},
{
"value":"SCR",
"displayValue":"Signature Confirmation Restricted Delivery",
"description":"Signature Confirmation Restricted Delivery"
},
{
"value":"DVC",
"displayValue":"USPS Tracking",
"description":"USPS Tracking"
},
{
"value":"SBP",
"displayValue":"USPS Tracking with SBP",
"description":"USPS Tracking with SBP"
},
{
"value":"INL",
"displayValue":"USPS Tracking, Insurance <= $500",
"description":"USPS Tracking, Insurance <= $500"
},
{
"value":"ING",
"displayValue":"USPS Tracking, Insurance > $500",
"description":"USPS Tracking, Insurance > $500"
}
]
}
},
"zipCodeFormat":{
"title":"ZIP Code Format",
"description":"Defines the number of ZIP Code digits to be used within the barcode data. Choose 9-Digit, 5-Digit, or None (zero digits = no routing information). Use the �Custom:� value to create a user-defined expression that evaluates to 9, 5, or 0.",
"default":9,
"type":"string",
"enum":[
"0",
"5",
"9",
"C"
],
"enumValues":[
{
"value":"0",
"displayValue":"None",
"description":"None"
},
{
"value":"5",
"displayValue":"5-Digit",
"description":"5-Digit ZIP Code"
},
{
"value":"9",
"displayValue":"9-Digit",
"description":"9-Digit ZIP Code"
},
{
"value":"C",
"displayValue":"Custom",
"description":"Custom Expression"
}
]
}
}
},
"impbFontCharacters":{
"title":"IMpb Font Characters",
"description":"Intelligent Mail Package Barcode Font Characters",
"default":null,
"type": "object",
"properties":{
"includeOnNonValid5D":{
"title":"Include on Non-Valid 5-Digit",
"description":"Include barcode on pieces without a valid 5-Digit ZIP Code",
"default":false,
"type":"boolean"
},
"mailerID":{
"title":"Mailer ID",
"description":"Six or nine-digit number that identifies the mailer or subscriber, provided by the USPS. If it is 9 digits, it must start with a 9; if it is 6 digits, it cannot start with a 9. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]).",
"default":null,
"type":"string",
"pattern":"^[0-8][0-9]{5}$|^[9][0-9]{8}$|^\\[.+\\]$"
},
"serial":{
"title":"Serial Number",
"description":"Unique number embedded in barcode used to uniquely identify each piece. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]).",
"default":null,
"type":"string",
"pattern":"[0-9]+|^\\[.+\\]$"
},
"serviceTypeID":{
"title":"Service Type ID",
"description":"Three digit number representing the barcode services. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]). If present takes precedence over service.",
"type":"string",
"pattern":"^\\[.+\\]$|[0-9]{3}"
},
"service":{
"title":"Service",
"description":"Enhancements that, for a fee in addition to postage, provide greater security and accountability for mail, convenience to the sender, or improved handling. Not all extra services are available for all classes of mail and only certain services may be combined for the same mailpiece.",
"default":null,
"type":"array",
"items":{
"enum":[
"ASR",
"ARD",
"CRM",
"CAS",
"CAR",
"CRR",
"COD",
"COR",
"HFP",
"IGR",
"MCR",
"ODS",
"RGS",
"RER",
"RRC",
"RRE",
"RSV",
"RTN",
"SGC",
"SCR",
"DVC",
"SBP",
"INL",
"ING"
],
"enumValues":[
{
"value":"ASR",
"displayValue":"Adult Signature Required",
"description":"Adult Signature Required"
},
{
"value":"ARD",
"displayValue":"Adult Signature Restricted Delivery",
"description":"Adult Signature Restricted Delivery"
},
{
"value":"CRM",
"displayValue":"Certified Mail",
"description":"Certified Mail"
},
{
"value":"CAS",
"displayValue":"Certified Mail Adult Signature Required",
"description":"Certified Mail Adult Signature Required"
},
{
"value":"CAR",
"displayValue":"Certified Mail Adult Signature Restricted Delivery",
"description":"Certified Mail Adult Signature Restricted Delivery"
},
{
"value":"CRR",
"displayValue":"Certified Mail Restricted Delivery",
"description":"Certified Mail Restricted Delivery"
},
{
"value":"COD",
"displayValue":"Collect on Delivery",
"description":"Collect on Delivery"
},
{
"value":"COR",
"displayValue":"Collect on Delivery",
"description":"Collect on Delivery"
},
{
"value":"HFP",
"displayValue":"Hold For Pickup",
"description":"Hold For Pickup"
},
{
"value":"IGR",
"displayValue":"Insurance > $500 Restricted Delivery",
"description":"Insurance > $500 Restricted Delivery"
},
{
"value":"MCR",
"displayValue":"Merchandise Return Service",
"description":"Merchandise Return Service"
},
{
"value":"ODS",
"displayValue":"Open and Distribute",
"description":"Open and Distribute"
},
{
"value":"RGS",
"displayValue":"Registered Mail",
"description":"Registered Mail"
},
{
"value":"RER",
"displayValue":"Registered Mail Restricted Delivery",
"description":"Registered Mail Restricted Delivery"
},
{
"value":"RRC",
"displayValue":"Return Receipt",
"description":"Return Receipt"
},
{
"value":"RRE",
"displayValue":"Return Receipt Electronic",
"description":"Return Receipt Electronic"
},
{
"value":"RSV",
"displayValue":"Return Service Flats",
"description":"Return Service Flats"
},
{
"value":"RTN",
"displayValue":"Returns",
"description":"Returns"
},
{
"value":"SGC",
"displayValue":"Signature Confirmation",
"description":"Signature Confirmation"
},
{
"value":"SCR",
"displayValue":"Signature Confirmation Restricted Delivery",
"description":"Signature Confirmation Restricted Delivery"
},
{
"value":"DVC",
"displayValue":"USPS Tracking",
"description":"USPS Tracking"
},
{
"value":"SBP",
"displayValue":"USPS Tracking with SBP",
"description":"USPS Tracking with SBP"
},
{
"value":"INL",
"displayValue":"USPS Tracking, Insurance <= $500",
"description":"USPS Tracking, Insurance <= $500"
},
{
"value":"ING",
"displayValue":"USPS Tracking, Insurance > $500",
"description":"USPS Tracking, Insurance > $500"
}
]
}
},
"zipCodeFormat":{
"title":"ZIP Code Format",
"description":"Defines the number of ZIP Code digits to be used within the barcode data. Choose 9-Digit, 5-Digit, or None (zero digits = no routing information). Use the �Custom:� value to create a user-defined expression that evaluates to 9, 5, or 0.",
"default":9,
"type":"string",
"enum":[
"0",
"5",
"9",
"C"
],
"enumValues":[
{
"value":"0",
"displayValue":"None",
"description":"None"
},
{
"value":"5",
"displayValue":"5-Digit",
"description":"5-Digit ZIP Code"
},
{
"value":"9",
"displayValue":"9-Digit",
"description":"9-Digit ZIP Code"
},
{
"value":"C",
"displayValue":"Custom",
"description":"Custom Expression"
}
]
}
}
},
"impbHumanReadable":{
"title":"IMpb Human Readable",
"description":"Intelligent Mail Package Barcode Human Readable",
"default":null,
"type": "object",
"properties":{
"includeOnNonValid5D":{
"title":"Include on Non-Valid 5-Digit",
"description":"Include barcode on pieces without a valid 5-Digit ZIP Code",
"default":false,
"type":"boolean"
},
"mailerID":{
"title":"Mailer ID",
"description":"Six or nine-digit number that identifies the mailer or subscriber, provided by the USPS. If it is 9 digits, it must start with a 9; if it is 6 digits, it cannot start with a 9. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]).",
"default":null,
"type":"string",
"pattern":"^[0-8][0-9]{5}$|^[9][0-9]{8}$|^\\[.+\\]$"
},
"serial":{
"title":"Serial Number",
"description":"Unique number embedded in barcode used to uniquely identify each piece. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]).",
"default":null,
"type":"string",
"pattern":"[0-9]+|^\\[.+\\]$"
},
"serviceTypeID":{
"title":"Service Type ID",
"description":"Three digit number representing the barcode services. Can be specified numerically or by referencing a field that contains the number (e.g. [Field Name]). If present takes precedence over service.",
"type":"string",
"pattern":"^\\[.+\\]$|[0-9]{3}"
},
"service":{
"title":"Service",
"description":"Enhancements that, for a fee in addition to postage, provide greater security and accountability for mail, convenience to the sender, or improved handling. Not all extra services are available for all classes of mail and only certain services may be combined for the same mailpiece.",
"default":null,
"type":"array",
"items":{
"enum":[
"ASR",
"ARD",
"CRM",
"CAS",
"CAR",
"CRR",
"COD",
"COR",
"HFP",
"IGR",
"MCR",
"ODS",
"RGS",
"RER",
"RRC",
"RRE",
"RSV",
"RTN",
"SGC",
"SCR",
"DVC",
"SBP",
"INL",
"ING"
],
"enumValues":[
{
"value":"ASR",
"displayValue":"Adult Signature Required",
"description":"Adult Signature Required"
},
{
"value":"ARD",
"displayValue":"Adult Signature Restricted Delivery",
"description":"Adult Signature Restricted Delivery"
},
{
"value":"CRM",
"displayValue":"Certified Mail",
"description":"Certified Mail"
},
{
"value":"CAS",
"displayValue":"Certified Mail Adult Signature Required",
"description":"Certified Mail Adult Signature Required"
},
{
"value":"CAR",
"displayValue":"Certified Mail Adult Signature Restricted Delivery",
"description":"Certified Mail Adult Signature Restricted Delivery"
},
{
"value":"CRR",
"displayValue":"Certified Mail Restricted Delivery",
"description":"Certified Mail Restricted Delivery"
},
{
"value":"COD",
"displayValue":"Collect on Delivery",
"description":"Collect on Delivery"
},
{
"value":"COR",
"displayValue":"Collect on Delivery",
"description":"Collect on Delivery"
},
{
"value":"HFP",
"displayValue":"Hold For Pickup",
"description":"Hold For Pickup"
},
{
"value":"IGR",
"displayValue":"Insurance > $500 Restricted Delivery",
"description":"Insurance > $500 Restricted Delivery"
},
{
"value":"MCR",
"displayValue":"Merchandise Return Service",
"description":"Merchandise Return Service"
},
{
"value":"ODS",
"displayValue":"Open and Distribute",
"description":"Open and Distribute"
},
{
"value":"RGS",
"displayValue":"Registered Mail",
"description":"Registered Mail"
},
{
"value":"RER",
"displayValue":"Registered Mail Restricted Delivery",
"description":"Registered Mail Restricted Delivery"
},
{
"value":"RRC",
"displayValue":"Return Receipt",
"description":"Return Receipt"
},
{
"value":"RRE",
"displayValue":"Return Receipt Electronic",
"description":"Return Receipt Electronic"
},
{
"value":"RSV",
"displayValue":"Return Service Flats",
"description":"Return Service Flats"
},
{
"value":"RTN",
"displayValue":"Returns",
"description":"Returns"
},
{
"value":"SGC",
"displayValue":"Signature Confirmation",
"description":"Signature Confirmation"
},
{
"value":"SCR",
"displayValue":"Signature Confirmation Restricted Delivery",
"description":"Signature Confirmation Restricted Delivery"
},
{
"value":"DVC",
"displayValue":"USPS Tracking",
"description":"USPS Tracking"
},
{
"value":"SBP",
"displayValue":"USPS Tracking with SBP",
"description":"USPS Tracking with SBP"
},
{
"value":"INL",
"displayValue":"USPS Tracking, Insurance <= $500",
"description":"USPS Tracking, Insurance <= $500"
},
{
"value":"ING",
"displayValue":"USPS Tracking, Insurance > $500",
"description":"USPS Tracking, Insurance > $500"
}
]
}
},
"zipCodeFormat":{
"title":"ZIP Code Format",
"description":"Defines the number of ZIP Code digits to be used within the barcode data. Choose 9-Digit, 5-Digit, or None (zero digits = no routing information). Use the �Custom:� value to create a user-defined expression that evaluates to 9, 5, or 0.",
"default":9,
"type":"string",
"enum":[
"0",
"5",
"9",
"C"
],
"enumValues":[
{
"value":"0",
"displayValue":"None",
"description":"None"
},
{
"value":"5",
"displayValue":"5-Digit",
"description":"5-Digit ZIP Code"
},
{
"value":"9",
"displayValue":"9-Digit",
"description":"9-Digit ZIP Code"
},
{
"value":"C",
"displayValue":"Custom",
"description":"Custom Expression"
}
]
}
}
},
"manifestKeyline":{
"title":"Manifest Keyline",
"description":"Each piece in a Manifest presort must contain a properly formatted keyline. Refer to USPS Publication 401 for details.",
"default":null,
"type":"object"
},
"oel":{
"title":"OEL",
"description":"Optional Endorsement Line. A line of data identifying the sortation level of a package or mail piece.",
"default":null,
"type": "object",
"properties":{
"location":{
"title":"Location",
"description":"Location",
"default":null,
"type":"string",
"enum":[
"ALL",
"FIRSTPIECE",
"LASTPIECE",
"ALLCARRIER",
"ALLSINGLE"
],
"enumValues":[
{
"value":"ALL",
"displayValue":"All pieces",
"description":"All pieces"
},
{
"value":"FIRSTPIECE",
"displayValue":"First piece of each pack",
"description":"First piece of every package"
},
{
"value":"LASTPIECE",
"displayValue":"Last piece of each pack",
"description":"Last piece of every package"
},
{
"value":"ALLCARRIER",
"displayValue":"All Carrier Route pieces",
"description":"All Carrier Route rate pieces"
},
{
"value":"ALLSINGLE",
"displayValue":"All Single pieces",
"description":"All Single Piece rate pieces"
}
]
}
}
},
"packInd":{
"title":"Pack Number",
"description":"Pack Number",
"default":null,
"type":"object"
},
"packType":{
"title":"Pack Level",
"description":"Pack Level",
"default":null,
"type":"object"
},
"palletInd":{
"title":"Pallet Number",
"description":"Pallet Number",
"default":null,
"type":"object"
},
"palletType":{
"title":"Pallet Level",
"description":"Pallet Level",
"default":null,
"type":"object"
},
"pSeqNum":{
"title":"Presort Sequence",
"description":"Presort Sequence Number",
"default":null,
"type":"object"
},
"sackInd":{
"title":"Sack Number",
"description":"Sack Number",
"default":null,
"type":"object"
},
"sackType":{
"title":"Container Level",
"description":"Container Level",
"default":null,
"type":"object"
},
"scf":{
"title":"SCF Number",
"description":"Denotes which SCF services the piece. The number is a unique index of the SCF list.",
"default":null,
"type":"object"
},
"scfLabel":{
"title":"SCF Label",
"description":"Name of the SCF servicing the piece. (i.e. SCF ROCHESTER NY 144)",
"default":null,
"type":"object"
},
"streamCode":{
"title":"Stream Code",
"description":"Denotes which stream the label belongs to. The first letter indicates stream (E=ECR, A=Auto, N=NonAuto, M=Merged, S=Single Piece, U=Machinable, X=Non USPS); the second letter indicates destination, if applicable (N=NDC, S=SCF, D=DDU); and the last three to five digits indicate destination ZIP",
"default":null,
"type":"object"
}
}
},
"firstContainer":{
"title":"First Container",
"description":"Specifies the first container within the first stream selected. The DEFAULT value will select the first container within the first stream.",
"default":1,
"type":"integer",
"minimum":1
},
"firstPiece":{
"title":"First Piece",
"description":"Specifies the first piece within the first stream selected. The DEFAULT value will select the first piece within the first stream.",
"default":1,
"type":"integer",
"minimum":1
},
"lastContainer":{
"title":"Last Container",
"description":"Specifies the last container within the last stream selected. The DEFAULT value will select the last container within the last stream selected. The container number is with respect to the last stream selected.",
"default":null,
"type":"integer",
"minimum":1
},
"lastPiece":{
"title":"Last PIECE",
"description":"Specifies the last piece within the last stream selected. The DEFAULT value will select the last piece within the last stream selected.",
"default":null,
"type":"integer",
"minimum":1
},
"nonSimplifiedOnly":{
"title":"Non Simplified Only",
"description":"Includes only non-simplified containers. Valid only with ECR presorts.",
"default":false,
"type":"boolean"
},
"palletSackOrder":{
"title":"Pallet Sack Order",
"description":"Produces output with records on pallets first, followed by records in sacks.",
"default":false,
"type":"boolean"
},
"presortName":{
"title":"Presort Name",
"description":"Description of the saved presort file.",
"default":"",
"type":"string"
},
"simplifiedOnly":{
"title":"Simplified Only",
"description":"Includes only simplified containers. Valid only with ECR presorts.",
"default":false,
"type":"boolean"
},
"streamList":{
"title":"Stream List",
"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).",
"default":"ALL;ALL ALL",
"type":"string"
},
"streamOrder":{
"title":"Stream Order",
"description":"Defines the order streams are output.",
"default":"",
"type":"string",
"enum":[
"CONTAINERS",
"DESTINATION",
"LASTSAVED",
"PIECES",
"STREAM",
"ZIP"
],
"enumValues":[
{
"value":"CONTAINERS",
"displayValue":"Containers",
"description":"Containers"
},
{
"value":"DESTINATION",
"displayValue":"Destination",
"description":"Destination"
},
{
"value":"LASTSAVED",
"displayValue":"Last Saved",
"description":"Last Saved"
},
{
"value":"PIECES",
"displayValue":"Pieces",
"description":"Pieces"
},
{
"value":"STREAM",
"displayValue":"Stream",
"description":"Stream"
},
{
"value":"ZIP",
"displayValue":"ZIP",
"description":"ZIP"
}
]
},
"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+)?)*|^$)"
},
"useCountyTable":{
"title":"Use County Table",
"description":"Calculates In-County rates for Periodicals.",
"default":false,
"type":"boolean"
}
},
"required":[
"addressTable",
"presortName"
],
"additionalProperties":false
}

Reply Schema

{
"$schema":"http://json-schema.org/draft-04/schema#",
"description":"Reply for the modifyPresorted request.",
"type":"object",
"required":[
"result"
],
"additionalProperties":false,
"properties":{
"result":{
"type":"string",
"description":"modifyPresorted return description"
}
}
}