|
Tag Name
|
Occurs
|
Description
|
Type
|
Validation
|
|
OpenDistributePriorityRequest
|
required
once
|
API=OpenDistributePriority
This API produces a Priority Mail Open and Distribute label complete with
barcode and receipt, with optional Permit imprint. Contact ICCC for
permission to invoke this API.
Internet Customer Care Center (ICCC)
E-mail: icustomercare@usps.com
Telephone: 1-800-344-7779 (7:00AM to 11:00PM ET)
|
(group)
|
|
|
OpenDistributePriorityRequest
/ @USERID
|
required
|
This
attribute specifies your Web Tools ID. See the Developer's Guide for
information on obtaining your USERID.
|
NMTOKEN
|
|
|
OpenDistributePriorityRequest
/ @PASSWORD
|
optional
|
For
backward compatibility; not validated.
|
NMTOKEN
|
|
|
OpenDistributePriorityRequest
/ Option
|
optional
|
For
future use. There is only one label option.
|
empty
|
|
|
OpenDistributePriorityRequest
/ ImageParameters
|
optional
|
For
future use. There are no image parameters; see "ImageType" tag.
|
empty
|
|
|
OpenDistributePriorityRequest
/ PermitNumber
|
optional
|
Input
Permit number provided by your local post office.
|
string
|
whiteSpace=collapse
pattern=\d{1,15}
|
|
OpenDistributePriorityRequest
/ PermitIssuingPOZip5
|
optional
|
ZIP Code
of post office that issued your permit. REQUIRED when PermitNumber is
specified. Must be valid within Address Matching System. City and State for
Permit imprint are obtained from this ZIP code.
|
string
|
whiteSpace=collapse
pattern=\d{5}
|
|
OpenDistributePriorityRequest
/ FromName
|
required
once
|
Name of
sender.
|
string
|
minLength=1
maxLength=32
whiteSpace=collapse
|
|
OpenDistributePriorityRequest
/ FromFirm
|
required
once
|
Company
name.
|
string
|
minLength=0
maxLength=32
whiteSpace=collapse
|
|
OpenDistributePriorityRequest
/ FromAddress1
|
required
once
|
Secondary
address unit designator and number (such as an apartment or suite number (APT 202, STE 100)).
|
string
|
minLength=0
maxLength=32
whiteSpace=collapse
|
|
OpenDistributePriorityRequest
/ FromAddress2
|
required
once
|
Street
number and name. Includes predirectional, suffix, and postdirectional for the
address or rural route and box number (RR 5 BOX 10), highway contract route
and box number (HC 4 BOX 45), or post office box number (PO BOX 458).
|
string
|
minLength=1
maxLength=32
whiteSpace=collapse
|
|
OpenDistributePriorityRequest
/ FromCity
|
required
once
|
The city
is any acceptable mailing name for the 5-digit ZIP code serving the intended
recipient.
|
string
|
minLength=1
maxLength=21
whiteSpace=collapse
|
|
OpenDistributePriorityRequest
/ FromState
|
required
once
|
Use only
official USPS state name abbreviations.
|
string
|
whiteSpace=collapse
pattern=\w{2}
|
|
OpenDistributePriorityRequest
/ FromZip5
|
required
once
|
Correct
5-digit ZIP Code.
|
string
|
whiteSpace=collapse
pattern=\d{5}
|
|
OpenDistributePriorityRequest
/ FromZip4
|
required
once
|
Last four
digits of a complete ZIP+4 code.
|
string
|
minLength=0
whiteSpace=collapse
pattern=\d{4}
pattern=
|
|
OpenDistributePriorityRequest
/ POZipCode
|
optional
|
When the
ZIP Code of a collection point for a given package is different from the Zip
Code of the person mailing the package (their return address), this tag must
be used to convey this difference to the USPS. Enter the ZIP Code of the post
office or collection box where the item is mailed. May be different than
"FromZip5."
|
string
|
minLength=0
whiteSpace=collapse
pattern=\d{5}
pattern=
|
|
OpenDistributePriorityRequest
/ ToFacilityName
|
required
once
|
Drop
Shipment destination facility name. Required for
OpenDistributePriorityRequest[FacilityType='DDU']. Truncated to 26 characters
on label.
|
string
|
minLength=0
maxLength=38
whiteSpace=collapse
|
|
OpenDistributePriorityRequest
/ ToFacilityAddress1
|
required
once
|
Drop
Shipment destination facility secondary address unit designator and number.
Truncated to 32 characters after address standardization for label.
|
string
|
minLength=0
maxLength=38
whiteSpace=collapse
|
|
OpenDistributePriorityRequest
/ ToFacilityAddress2
|
required
once
|
Drop
Shipment destination facility street number and name.
OpenDistributePriorityRequest[FacilityType='DDU']. Truncated to 32 characters
after address standardization for label.
|
string
|
minLength=0
maxLength=38
whiteSpace=collapse
|
|
OpenDistributePriorityRequest
/ ToFacilityCity
|
required
once
|
Drop
Shipment destination facility city. When
OpenDistributePriorityRequest[FacilityType ='DDU'], either City and State, or
ZIP code is REQUIRED. Truncated to 15 characters after address standardization
for label.
|
string
|
minLength=0
maxLength=21
whiteSpace=collapse
|
|
OpenDistributePriorityRequest
/ ToFacilityState
|
required
once
|
Drop
Shipment destination facility state abbreviation. When
OpenDistributePriorityRequest[FacilityType='DDU'], either City and State, or
ZIP code is REQUIRED.
|
string
|
minLength=0
whiteSpace=collapse
pattern=\w{2}
pattern=
|
|
OpenDistributePriorityRequest
/ ToFacilityZip5
|
required
once
|
Drop
Shipment destination facility 5-digit ZIP code. When OpenDistributePriorityRequest[FacilityType='DDU'],
either City and State, or ZIP code is REQUIRED. For all other FacilityType
values, always REQUIRED and must be valid ZIP code.
|
string
|
minLength=0
whiteSpace=collapse
pattern=\d{5}
pattern=
|
|
OpenDistributePriorityRequest
/ ToFacilityZip4
|
required
once
|
Drop
Shipment destination facility last four digits of ZIP+4. May be REQUIRED to
obtain exact address match when
OpenDistributePriorityRequest[FacilityType='DDU'].
|
string
|
minLength=0
whiteSpace=collapse
pattern=\d{4}
pattern=
|
|
OpenDistributePriorityRequest
/ FacilityType
|
required
once
|
Drop
Shipment destination facility type. Has values: "DDU",
"SCF", "BMC", "ADC", "ASF".
|
string
|
whiteSpace=collapse
enumeration=DDU
enumeration=SCF
enumeration=BMC
enumeration=ADC
enumeration=ASF
|
|
OpenDistributePriorityRequest
/ MailClassEnclosed
|
required
once
|
Mail
Class and Processing Category, displays on label as: Letters: Standard Mail
Letters; Flats: Standard Mail Flats; Parcels: Standard Mail Parcels; Mixed:
Standard Mail Mixed; Other: explanation from
OpenDistributePriorityRequest/MailClassOther tag.
|
string
|
whiteSpace=collapse
enumeration=Letters
enumeration=Flats
enumeration=Parcels
enumeration=Mixed
enumeration=Other
|
|
OpenDistributePriorityRequest
/ MailClassOther
|
optional
|
Explanation,
REQUIRED when OpenDistributePriorityRequest[MailClassEnclosed='Other']. Is
displayed on the label as provided.
|
string
|
minLength=0
maxLength=21
whiteSpace=collapse
|
|
OpenDistributePriorityRequest
/ WeightInPounds
|
optional
|
(Estimated)
weight of package in pounds. Number must be represented using at most eight
characters.
|
decimal
|
minInclusive=0
maxInclusive=70
whiteSpace=collapse
|
|
OpenDistributePriorityRequest
/ WeightInOunces
|
optional
|
(Estimated)
weight of package in ounces. Number must be represented using at most eight
characters.
|
integer
|
maxInclusive=1120
minInclusive=0
whiteSpace=collapse
|
|
OpenDistributePriorityRequest
/ ImageType
|
required
once
|
The type
of label image desired.
|
string
|
whiteSpace=collapse
enumeration=TIF
enumeration=PDF
enumeration=NONE
|
|
OpenDistributePriorityRequest
/ SeparateReceiptPage
|
optional
|
Enter
"true" for the shipping label and the online customer record to be
printed on two separate pages or "false" for both printed on the
same page.
|
boolean
|
default=false
whiteSpace=collapse
|
|
OpenDistributePriorityRequest
/ LabelDate
|
optional
|
This tag
allows the end-user to post-date the label up to four days in advance. The
package should not be shipped until the ship date requested.
|
string
|
minLength=0
whiteSpace=collapse
pattern=\d{1,2}/\d{1,2}/\d\d(\d\d)?
pattern=
|
|
OpenDistributePriorityRequest
/ CustomerRefNo
|
optional
|
For
future use.
|
empty
|
|
|
OpenDistributePriorityCertifyRequest
|
required
once
|
API=OpenDistributePriorityCertify
The "Certify" form of the request is used for integrator testing.
It produces a label that is not suitable for mailing and must not be entered
into the US Postal System. Certify requests do not require additional
permissions to invoke.
|
(alias)
|
|
