Creates a Manifest Report from a saved presort.
This request generates a manifest report.
This request generates a manifest report for each batch of a batch presort.
{
"$schema":"http://json-schema.org/draft-04/schema#",
"title":"Manifest Report",
"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 for all saved presorts associated with the batch presort.",
"default":false,
"type":"boolean"
},
"batchSize":{
"title":"Batch Size",
"description":"Sets the number of pieces in each batch. Only used when the report style is set to FIXED.",
"default":null,
"type":"integer",
"minimum":0
},
"collate":{
"title":"Collate",
"description":"Collates multiple copies.",
"default":false,
"type":"boolean"
},
"consecutiveBatchNumbers":{
"title":"Consecutive Batch Numbers",
"description":"Maintains the container numbers 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":null,
"type":"integer",
"minimum":0
},
"containerThreshold":{
"title":"Container Threshold",
"description":"Specifies how the value specified for the Container Piece Limit value 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. The value DEFAULT is interpreted as true.",
"default":false,
"type":"boolean"
},
"copies":{
"title":"Copies",
"description":"Number of copies of the Manifest Report to output.",
"default":0,
"type":"integer",
"minimum":0
},
"defOrder":{
"title":"Def Order",
"description":"Allows a custom DEFORDER.TXT file.",
"default":"",
"type":"string",
"pattern":"^.*\\.(txt)$"
},
"doRateSummary":{
"title":"Do Rate Summary",
"description":"Includes the rate summary on the Manifest Report.",
"default":false,
"type":"boolean"
},
"fileName":{
"title":"File Name",
"description":"Path and file name for Manifest Report output to disk file.",
"default":"",
"type":"string"
},
"fileType":{
"title":"File Type",
"description":"File type for Manifest Report output to disk file.",
"default":"",
"type":"string",
"enum":[
"PDF"
],
"enumValues":[
{
"value":"PDF",
"displayValue":"PDF",
"description":"PDF"
}
]
},
"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 selected.",
"default":1,
"type":"integer",
"minimum":1
},
"fromPage":{
"title":"From Page",
"description":"Page of Manifest Report to begin printing from, when printing a range of pages.",
"default":1,
"type":"integer"
},
"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
},
"mailId":{
"title":"Mail ID",
"description":"Mail ID",
"default":"",
"type":"string"
},
"nonSimplifiedOnly":{
"title":"Non Simplified Only",
"description":"Includes only non-simplified containers. Valid only with ECR presorts.",
"default":false,
"type":"boolean"
},
"overwrite":{
"title":"Overwrite",
"description":"Overwrites existing file if the same file name is used",
"default":true,
"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"
},
"reportStyle":{
"title":"Report Style",
"description":"Prints the report using Floating or Fixed batch style. Floating is not available for USPS Marketing Mail using piece/pound prices.",
"default":"Floating",
"type":"string",
"enum":[
"FLOATING",
"FIXED"
],
"enumValues":[
{
"value":"FLOATING",
"displayValue":"Floating",
"description":"Floating"
},
{
"value":"FIXED",
"displayValue":"Fixed",
"description":"Fixed"
}
]
},
"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+)?)*|^$)"
},
"toPage":{
"title":"To Page",
"description":"Page of Manifest Report to end printing on, when printing a range of pages.",
"default":1,
"type":"integer"
}
},
"required":[
"addressTable",
"fileName",
"fileType",
"presortName"
],
"additionalProperties":false
}
