From 3116ebfb1cbb32a86a3340eba0b388e5932d640b Mon Sep 17 00:00:00 2001 From: Skylar Ittner Date: Sun, 26 Nov 2023 00:38:14 -0700 Subject: [PATCH] Update 'Home' --- Home.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/Home.md b/Home.md index e3057cb..1c50ccb 100644 --- a/Home.md +++ b/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. \ No newline at end of file +This field allows the user's software to communicate preferences to the shipping software. See "Account Number field" above for the format specification. \ No newline at end of file