Integratec API Platform
eSubmission

Description

Creates a Mail.xml job from a saved presort and transmits to PostalOne!

Example

Request

{
"addressTable" : "7112661645",
"accountPassword" : "password",
"accountUserID" : "userID",
"cassDateAuto" : "2017-09-07",
"fullServiceParticipation" : "BASIC",
"imbMailerIDExpression" : "000944",
"imContainerTagsMailerID" : "000944",
"inductionDateTime" : "2017-109-30T12:00:00Z",
"mailingDate" : "2017-09-30",
"moveUpdateMethod" : "NCOALINK",
"postagePaymentOption" : "O",
"presortName" : "std flat",
"rates" : "REGULAR",
"serverEnvironment" : "TEM",
"streamList" : "ALL;ALL ALL",
"verificationFacilityZip4" : "146929998",
"version" : "190"
}

Reply

{
"result" : "eSubmission: StdFlt Job completed."
}

Request Schema

{
"$schema":"http://json-schema.org/draft-04/schema#",
"title":"eSubmission",
"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]+)$"
},
"acceptMisshipped":{
"title":"Accept Misshipped",
"description":"USPS field for eInduction misshipped processing support.",
"default":false,
"type":"boolean"
},
"accountPassword":{
"title":"Account Password",
"description":"PostalOne! Account Password.",
"default":"",
"type":"string"
},
"accountUserID":{
"title":"Account User ID",
"description":"PostalOne! Account User ID",
"default":"",
"type":"string"
},
"affixedRate":{
"title":"Affixed Rate",
"description":"Postage amount affixed to each piece. Valid if AFFIXED=NEITHER.",
"default":"",
"type":"number",
"minimum":0
},
"allBatches":{
"title":"All Batches",
"description":"Sequentially generates output (tags, reports, labels) for all saved presorts associated with the batch presort.",
"default":false,
"type":"boolean"
},
"bypassSeamlessAcceptance":{
"title":"Bypass Seamless Acceptance",
"description":"Seamless Acceptance is a service of the USPS that streamlines the acceptance process. Mailers must opt in with the USPS to use this service.",
"default":false,
"type":"boolean"
},
"cassDateAuto":{
"title":"CASS Date Auto",
"description":"Command type is date. Applies to the Automation Address Matching Date field on PS Forms 3600, 3602, 3605, 3541.",
"default":"",
"type":"string",
"format":"date"
},
"cassDateCRSeq":{
"title":"CASS Date CR Seq",
"description":"Command type is date. Applies to the Carrier Route Sequencing Address Matching Date field on the 3600, 3602, 3605, 3541.",
"default":"",
"type":"string",
"format":"date"
},
"componentADStatus":{
"title":"Component Ad Status",
"description":"Status of the advertising percentage calculation.",
"default":" ",
"type":"string",
"enum":[
"F",
"P"
],
"enumValues":[
{
"value":"F",
"displayValue":"Final",
"description":"Final"
},
{
"value":"P",
"displayValue":"Pending",
"description":"Pending"
}
]
},
"componentIssueNumber":{
"title":"Component Issue Number",
"description":"Issue number of the periodical.",
"default":"",
"type":"string"
},
"componentVolumeNumber":{
"title":"Component Volume Number",
"description":"Volume number of the periodical.",
"default":"",
"type":"string"
},
"containerPieceLimit":{
"title":"Container Piece Limit",
"description":"Specifies the number of pieces within a container to use as a threshold or ceiling.",
"default":null,
"type":"integer",
"minimum":0
},
"containerThreshold":{
"title":"Container Threshhold",
"description":"Specifies how the Container Threshold value is interpreted. A value of 'true' treats the Container Threshold value as a threshold, and a value of 'false' treats the Container Threshold value as a ceiling.",
"default":false,
"type":"boolean"
},
"contentOfMail":{
"title":"Content of Mail",
"description":"PS Forms 3600-FCM and 3602 only.",
"default":" ",
"type":"string",
"enum":[
"CT",
"NF",
"DC",
"RT",
"NP",
"PM",
"EM",
"0X"
],
"enumValues":[
{
"description":"Catalog",
"displayValue":"Catalog",
"value":"CT"
},
{
"description":"Contents NOT required to be mailed FCM",
"displayValue":"Contents NOT required to be mailed FCM",
"value":"NF"
},
{
"description":"DVD/CD or other disk",
"displayValue":"DVD/CD or other disk",
"value":"DC"
},
{
"description":"Round Trip ONLY: One DVD/CD or other disk (can be LT or FL)",
"displayValue":"Round Trip ONLY: One DVD/CD or other disk (can be LT or FL)",
"value":"RT"
},
{
"description":"PACT act",
"displayValue":"PACT act",
"value":"NP"
},
{
"description":"Political Mail",
"displayValue":"Political Mail",
"value":"PM"
},
{
"description":"Election Mail",
"displayValue":"Election Mail",
"value":"EM"
},
{
"description":"A/B testing Content",
"displayValue":"A/B testing Content",
"value":"0X"
}
]
},
"defOrder":{
"title":"Def Order",
"description":"Allows a custom DEFORDER.TXT file.",
"default":"",
"type":"string",
"pattern":"^.*\\.(txt)$"
},
"detachedLabels":{
"title":"Detached Labels",
"description":"Number of Detached Address Labels (DAL) included.",
"default":" ",
"type":"string",
"enum":[
"DAL",
"DML",
"NONE"
],
"enumValues":[
{
"value":"DAL",
"displayValue":"Detached Address Labels",
"description":"Detached Address Labels"
},
{
"value":"DML",
"displayValue":"Detached Mailing Labels",
"description":"Detached Mailing Labels"
},
{
"value":"NONE",
"displayValue":"None",
"description":"None"
}
]
},
"eInduction":{
"title":"E-Induction",
"description":"Flags whether an e8125/e8017 needs to be generated for eInduction.",
"default":false,
"type":"boolean"
},
"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
},
"fullServiceParticipation":{
"title":"Full Service Participation",
"description":"Includes the level of participation on the Job Setup report.",
"default":"",
"type":"string",
"enum":[
"B",
"F",
"O"
],
"enumValues":[
{
"value":"B",
"displayValue":"Basic",
"description":"Basic"
},
{
"value":"F",
"displayValue":"Full Service",
"description":"Full Service"
},
{
"value":"O",
"displayValue":"Other",
"description":"Other"
}
]
},
"imbDowngradeNonAuto":{
"default":false,
"description":"Allows using a Basic Service Type ID (STID) on NonAutomated pieces when the `imbServicesExpression` evaluates to a Full Service STID. Only used when `imbUseServicesExpression` is true.",
"title":"IMB Downgrade NonAuto",
"type":"boolean"
},
"imbMailerIDExpression":{
"title":"IMB Mailer ID Expression",
"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}$|^\\[.+\\]$"
},
"imbNonUspsValid":{
"title":"IMB Non USPS Valid",
"description":"Includes the IMb on pieces without a valid 5-digit ZIP Code.",
"default":false,
"type":"boolean"
},
"imbSerialNumberExpression":{
"title":"IMB Serial Number Expression",
"description":"User defined expression to uniquely identify individual mail pieces.",
"default":"",
"type":"string"
},
"imbServicesExpression":{
"title":"IMB Services Expression",
"description":"User defined expression to identify services.",
"default":"",
"type":"string"
},
"imbUseServicesExpression":{
"default":false,
"description":"",
"title":"IMB Use Services Expression",
"type":"boolean"
},
"imContainerTagsMailerID":{
"title":"IM Container Tags Mailer ID",
"description":"Mailer ID used on barcoded container tags.",
"default":null,
"type":"string",
"pattern":"^[0-8][0-9]{5}$|^[9][0-9]{8}$|^\\[.+\\]$"
},
"incentiveType":{
"title":"Incentive Type",
"description":"The USPS offers direct mail advertising promotions and incentives to promote best practices for integrating direct mail with mobile technology and highlight new products and other innovative mailing techniques. See https://www.usps.com/business/promotions-incentives.htm for current promotions.",
"default":" ",
"type":"string",
"enum":[
"",
"ME",
"PI",
"SS",
"MI",
"CP",
"RR",
"1X",
"RG",
"CR"
],
"enumValues":[
{
"value": "",
"displayValue": "",
"description": ""
},
{
"value":"ME",
"displayValue":"Emerging and Advanced Tech",
"description":"Emerging and Advanced Tech"
},
{
"value":"PI",
"displayValue":"Informed Delivery",
"description":"Informed Delivery"
},
{
"value":"SS",
"displayValue":"Tactile Mailpiece Engagement",
"description":"Tactile Mailpiece Engagement"
},
{
"value":"MI",
"displayValue":"Mobile Shopping",
"description":"Mobile Shopping"
},
{
"value":"CP",
"displayValue":"Personalized Color Transpromo",
"description":"Personalized Color Transpromo"
},
{
"value":"RR",
"displayValue":"Earned Value Reply Mail",
"description":"Earned Value Reply Mail"
},
{
"description":"Enhanced Emerging Tech",
"displayValue":"Enhanced Emerging Tech",
"value":"1X"
},
{
"description":"Retargeted Mail",
"displayValue":"Retargeted Mail",
"value":"RG"
},
{
"description":"Color Ink with Reply",
"displayValue":"Color Ink with Reply",
"value":"CR"
}
]
},
"inductionDateTime":{
"title":"Induction Date Time",
"description":"Date and time the mail is presented to the Post Office.",
"default":"",
"type":"string",
"format":"date-time"
},
"informedAddressIndicator":{
"default":false,
"description": "Indicates mailing has Informed Address",
"title":"Informed Address Indicator",
"type":"boolean"
},
"informedAddressExpirationDate":{
"default":"",
"description": "Last date the Informed Address is valid",
"format":"date-time",
"title":"Informed Address Expiration Date",
"type":"string"
},
"issueDate":{
"title":"Issue Date",
"description":"Issue date for Periodical. Valid for PS Form 3541.",
"default":"",
"type":"string",
"format":"date"
},
"issueFrequency":{
"title":"Issue Frequency",
"description":"Issue frequency for Periodical. Valid for PS Form 3541.",
"default":0.0,
"type":"integer",
"minimum":0
},
"jobIDUser":{
"title":"Job ID",
"description":"User-defined job identifier.",
"default":"",
"type":"string"
},
"jobName":{
"title":"Job Name",
"description":"User-defined job name.",
"default":"",
"type":"string"
},
"lastContainer":{
"title":"Last Container",
"description":"Specifies the last container within the last stream selected. The DEFAULT value selects the last container within the last stream selected. The container number is with respect to the last stream selected.",
"default":null,
"type":"integer",
"minimum":1
},
"mailingDate":{
"title":"Mailing Date",
"description":"Date of mailing. Use the value NONE to specify an empty date.",
"default":"",
"type":"string",
"format":"date"
},
"moveUpdateMethod":{
"title":"Move Update Method",
"description":"Method used to update addresses.",
"default":"",
"type":"string",
"enum":[
"ACS",
"ENDORSEMENTS",
"MAILER",
"MULTIPLE",
"NCOALINK",
"NONE",
"ONECODEACS",
"SIMPLIFIED/OCCUPANT/EXCEPTIONALADDRESS"
],
"enumValues":[
{
"value":"ACS",
"displayValue":"ACS",
"description":"ACS"
},
{
"value":"ENDORSEMENTS",
"displayValue":"Endorsements",
"description":"Endorsements"
},
{
"value":"MAILER",
"displayValue":"Mailer",
"description":"Mailer"
},
{
"value":"MULTIPLE",
"displayValue":"Multiple",
"description":"Multiple"
},
{
"value":"NCOALINK",
"displayValue":"NCOALink",
"description":"NCOALink"
},
{
"value":"NONE",
"displayValue":"None",
"description":"None"
},
{
"value":"ONECODEACS",
"displayValue":"OneCode ACS",
"description":"OneCode ACS"
},
{
"value":"SIMPLIFIED/OCCUPANT/EXCEPTIONALADDRESS",
"displayValue":"Simplified/Occupant/Exceptional Address",
"description":"Simplified/Occupant/Exceptional Address"
}
]
},
"news":{
"title":"News",
"description":"Prints 'News' on the second line of container tags for a Periodical presort.",
"default":false,
"type":"boolean"
},
"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":"",
"default":false,
"type":"boolean"
},
"pcWt":{
"title":"Piece Weight",
"description":"Piece weight in ounces.",
"default":0.0,
"type":"number",
"minimum":0
},
"percentAdvertising":{
"title":"Percent Advertising",
"description":"Advertising percentage in this issue. Valid for PS Form 3541.",
"default":0.0,
"type":"integer",
"minimum":0,
"maximum":100
},
"permit":{
"title":"Permit",
"description":"Selects the permit used for the mailing. The 10-digit Permit ID or the Permit Description may be used.",
"default":"",
"type":"string"
},
"permitAdditional":{
"title":"Permit Additional",
"description":"Permit number in the Postage section, as an additional permit number for payment when there is net postage due. Permit number or Permit Description may be used.",
"default":"",
"type":"string"
},
"postagePaymentMethod":{
"title":"Postage Payment Method",
"description":"",
"default":"",
"type":"string",
"enum":[
"A",
"C",
"G",
"H",
"I",
"L",
"M",
"P",
"S",
"T"
],
"enumValues":[
{
"value":"A",
"displayValue":"Alternate Delivery",
"description":"Alternate Delivery"
},
{
"value":"C",
"displayValue":"Metered, Correct",
"description":"Metered, Correct"
},
{
"value":"G",
"displayValue":"Government Permit",
"description":"Government Permit"
},
{
"value":"H",
"displayValue":"Cash",
"description":"Cash"
},
{
"value":"I",
"displayValue":"Partial Permit Imprint",
"description":"Partial Permit Imprint"
},
{
"value":"L",
"displayValue":"Metered, Lowest",
"description":"Metered, Lowest"
},
{
"value":"M",
"displayValue":"Metered, Neither",
"description":"Metered, Neither"
},
{
"value":"P",
"displayValue":"Permit",
"description":"Permit"
},
{
"value":"S",
"displayValue":"Stamp",
"description":"Stamp"
},
{
"value":"T",
"displayValue":"Periodicals Pending Permit",
"description":"Periodicals Pending Permit"
}
]
},
"postagePaymentOption":{
"title":"Postage Payment Option",
"description":"How the postage is paid.",
"default":"",
"type":"string",
"enum":[
"C",
"V",
"T",
"D",
"O",
"B"
],
"enumValues":[
{
"value":"C",
"displayValue":"CPP",
"description":"CPP"
},
{
"value":"V",
"displayValue":"PVDS",
"description":"PVDS"
},
{
"value":"T",
"displayValue":"CAPS",
"description":"CAPS"
},
{
"value":"D",
"displayValue":"Debit",
"description":"Debit"
},
{
"value":"O",
"displayValue":"Other",
"description":"Other"
},
{
"value":"B",
"displayValue":"Billing",
"description":"Billing"
}
]
},
"presortName":{
"title":"Presort Name",
"description":"",
"default":"",
"type":"string"
},
"publicationNumber":{
"title":"Publication Number",
"description":"Publication number. Valid for PS Form 3541.",
"default":"",
"type":"string"
},
"rates":{
"title":"Rates",
"description":"Rate category for PS Form 3541.",
"default":"",
"type":"string",
"enum":[
"CLASSROOM",
"NONPROFIT",
"REGULAR",
"SCIENCEOFAGRICULTURE"
],
"enumValues":[
{
"value":"CLASSROOM",
"displayValue":"Classroom",
"description":"Classroom"
},
{
"value":"NONPROFIT",
"displayValue":"Non Profit",
"description":"Non Profit"
},
{
"value":"REGULAR",
"displayValue":"Regular",
"description":"Regular"
},
{
"value":"SCIENCEOFAGRICULTURE",
"displayValue":"Science Of Agriculture",
"description":"Science Of Agriculture"
}
]
},
"serverEnvironment":{
"title":"Server Environment",
"description":"Identifies which PostalOne! server is targeted.",
"default":"",
"type":"string",
"enum":[
"CAT",
"PREPROD",
"PRODUCTION",
"TEM"
],
"enumValues":[
{
"value":"CAT",
"displayValue":"Customer Acceptance Testing",
"description":"Customer Acceptance Testing"
},
{
"value":"PREPROD",
"displayValue":"Pre-Production Testing",
"description":"Pre-Production Testing"
},
{
"value":"PRODUCTION",
"displayValue":"Production",
"description":"Production"
},
{
"value":"TEM",
"displayValue":"Test Environment for Mailer",
"description":"Test Environment for Mailer"
}
]
},
"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"
},
"usePresortADPercent":{
"title":"Use Presort Ad Percent",
"description":"Uses the Advertising % definedin the presort settings.",
"default":false,
"type":"boolean"
},
"verificationFacilityZip4":{
"title":"Verification Facility ZIP4",
"description":"ZIP+4 of the facility where the mail is dropped.",
"default":"",
"type":"string",
"pattern":"^[0-9]{5}$|[0-9]{9}$"
},
"version":{
"title":"Version",
"description":"Mail.XML version number.",
"default":"",
"type":"string",
"enum":[
"260"
],
"enumValues":[
{
"value":"26.0",
"displayValue":"26.0",
"description":"26.0"
}
]
}
},
"required":[
"addressTable",
"accountPassword",
"accountUserID",
"cassDateAuto",
"imbMailerIDExpression",
"imContainerTagsMailerID",
"inductionDateTime",
"mailingDate",
"moveUpdateMethod",
"postagePaymentOption",
"presortName",
"rates",
"serverEnvironment",
"verificationFacilityZip4",
"version"
],
"additionalProperties":false
}

Reply Schema

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