PostalPortal/QuickSend
2
0
Wiki

Update 'Home'

Skylar Ittner 2023-11-26 00:38:14 -07:00
parent fee208e4d9
commit 3116ebfb1c
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Home.md

@ -22,7 +22,7 @@ All barcodes shall start with `QSv1` as the first field. The second field shall
## Data Fields
### Subtype `a`
### Subtype `a`: To/From Addresses
Basic to/from address data only.
@ -30,7 +30,7 @@ Position | Meaning
---------|--------
0 | Format header (`QSv1`)
1 | Subtype header (`a`)
2 | Sender/payer account number (vendor/implementation specific)
2 | Sender/payer account number. Preface with a implementation-specific code followed by a colon in case multiple implementations generate conflicting account numbers.
3 | To name
4 | To company/firm/business
5 | To street
@ -54,7 +54,7 @@ Position | Meaning
23 | Preferences field. See appendix.
### Subtype `p`
### Subtype `p`: Address and Parcel Information
Contains address data, plus parcel information and options.
@ -75,7 +75,7 @@ Position | Meaning
35 | Insurance amount, USD
36 | Signature services. 1: Signature required, 2: Adult signature required, 3: Restricted delivery signature, 4: Adult restricted signature, 5: Indirect signature.
### Subtype `ac`
### Subtype `ac`: Addresses and Customs
Address data plus customs form.
@ -92,7 +92,7 @@ Position | Meaning
31 | Customs items. See appendix for format.
### Subtype `pc`
### Subtype `pc`: Addresses, Parcel, and Customs
Address data, parcel information, and customs form.
@ -166,8 +166,14 @@ Position | Meaning
4 | Harmonized Tariff Schedule number
5 | Country of origin as two-character ISO country code
### Account Number field
This field is intended for a billing account number, to enable automatic payments and other fun things.
Data format is implementation-specific. Any format is allowed as long as the data does not include the `|` character.
The one rule for this field is to preface the data with a unique identifer for the implementation, to prevent confusion and incompatibility. The identifier shall be followed by a colon (`:`) to signal the start of the actual data. Software must read until the colon to determine compatibility with the encoded data. If the software is not compatible, the remainder of this field shall be ignored.
### Preferences field
This field allows the user's software to communicate preferences to the shipping software. Data format is implementation-specific. Any format is allowed as long as the data does not include the `|` character.
The one rule for this field is to preface the data with a unique identifer for the implementation, to prevent confusion and incompatibility. The identifier shall be followed by a colon (`:`) to signal the start of the actual data. Software must read until the colon to determine compatibility with the encoded data. If the software is not compatible, the remainder of this field shall be ignored.
This field allows the user's software to communicate preferences to the shipping software. See "Account Number field" above for the format specification.