Shipping Partner Event File 5.0 Layout
The Shipping Partner Event File 5.0 record layout from Publication 199 Version 35, July 2, 2026: 2 records and 69 fields, in the order the file holds them.
Header Record
9 fields, pages 333–334
PositionFieldFormat
- Description
- A two-character system constant, which identifies a Shipping Partner Event File Header Record.
- Example
- EH
- Content rules
- ‘EH’ is required.
- Page
- Publication 199, page 333
- Description
- Shipping Partner’s Mailer ID Field
- Example
- 912345678 or 212345
- Content rules
- Must be the Mailer ID of the consolidator. Can be a six or nine digit MID. If a six digit MID, left justified, trailing spaces. Must be a Valid Mailer ID.
- Page
- Publication 199, page 333
- Description
- Total number of all records in this file. Count to include Header Record and all Detail Records.
- Example
- 000001517
- Content rules
- Leading zeroes required.
- Page
- Publication 199, page 333
- Description
- Valid Values: 1 - Inbound 2 - Outbound
- Example
- 1
- Content rules
- Required Left Justified, trailing spaces
- Page
- Publication 199, page 333
- Description
- Date mail is tendered to USPS.
- Example
- 2015-04-10 Entered as: 20150410
- Content rules
- YYYYMMDD, date shall be valid. Numeric values (0-9) only.
- Page
- Publication 199, page 333
- Description
- Filler
- Content rules
- Must be spaces.
- Page
- Publication 199, page 333
- Description
- File Version Number
- Example
- 050
- Content rules
- Entered as: 050
- Page
- Publication 199, page 333
- Description
- Unique number assigned to identify the Shipping Partner File Number. Commercial Mailer 2-digits - AI (92 or 93) 3-digits - ‘753’ 6- or 9-digits - MID If six-digit MID, 10- or 14-digit serial # If nine-digit MID, 7- or 11-digit serial # 1-digit - check digit Online Mailer 2-digits - AI 94 3-digits - ‘753’ 2-digits - source identifier for your system 6- or 9-digits - MID 5 or 8-digits- serial number depending on construct used 1-digit - check digit
- Example
- 9275312345678 912345678
- Content rules
- Mailer ID must be that of the company transmitting the file. (all file types) Must be unique for 120 days from first use. Left justified trailing spaces. Commercial Mailers must use the following valid barcode constructs: C04, C08, C09 or C10. Online Mailers must use the following valid barcode constructs: N01 – N10. AI 91 is not acceptable in this field. Valid for IMpb format only. Use Service Type Code “753” for Shipping Partner Event File Version 5.0 Only.
- Page
- Publication 199, page 334
- Description
- Kept the filler so the other field positions are not disturbed.
- Content rules
- Must be spaces.
- Page
- Publication 199, page 334
Detail Record
60 fields, pages 335–350, 1 unchecked
PositionFieldFormat
- Description
- Shipping Partner Event Detail Record ID
- Example
- ED
- Content rules
- ‘ED’ is required.
- Page
- Publication 199, page 335
- Description
- IMpb Tracking number used on package. May include routing information and Package Identification Code (PIC). Commercial Mailer 3-digits - ‘420’ 5-digits - Routing ZIP Code 4-digits - Routing +4 2-digits - AI (92 or 93) 3-digits - STC 6- or 9-digits - MID If six-digit MID, 10- or 14-digit serial # If nine-digit MID, 7- or 11-digit serial # 1-digit - check digit Online Mailer 3-digits - ‘420’ 5-digits - Routing ZIP Code 4-digits - Routing +4 2-digits - AI 94 3-digits - STC 2-digits - source identifier for your system 6- or 9-digits - MID 5 or 8-digits, serial number depending on construct used 1-digit - check digit Legacy Tracking number use on package. 2-digits -“91” AI 2-digits - STC 9-digits - MID 8-digits - Variable- length serial number from 2 to 8-digits. 1-digit - check digit
- Example
- 92321234567891234567 80 Refer to Publication 199, Appendix J, Table 1 for the complete list of label examples.
- Content rules
- Tracking number must be unique for 120 days from first use for domestic, 365 days for international. 3-digits ‘420’ are the routing application identifier. Used only when including a Routing ZIP Code. 5-digits Routing ZIP Code and 4-digits Routing +4 are optional. Left justified trailing spaces. Must use a 9-digit ZIP Code in the IMpb for Hold for Pickup. MRS piece (any piece with extra service 980) must use a Barcode Construct of C01, C05, N02 or N05 – a 9-digit ZIP code. IMpb required for domestic shipments, but “S10” type barcode is allowed for international shipments
- Page
- Publication 199, page 335
- Description
- Event Code
- Example
- 81
- Content rules
- Valid values for inbound are ‘AL,’GX’,’80’,’81’,’82’,’8 3’, and ‘89’Valid values for outbound are ‘84’, ‘85’, ‘86’, and ‘87’ – Mailer ID must be a Certified PRS customer.
- Page
- Publication 199, page 336
- Description
- 5-digit ZIP Code of event location.
- Example
- 22201
- Page
- Publication 199, page 336
- Description
- ZIP + 4 add on of domestic ZIP Code.
- Example
- 2804
- Content rules
- Default is spaces, if not available.
- Page
- Publication 199, page 336
- Description
- Date associated with movement of shipments by shipping partner.
- Example
- 20160131
- Content rules
- Format is YYYYMMDD
- Page
- Publication 199, page 336
- Description
- Time associated with movement of shipments by shipping partner.
- Example
- 131500
- Content rules
- Format is HHMMSS (24-hour time format.)
- Page
- Publication 199, page 336
- Description
- Client Mailer ID
- Example
- 912345678 or 612345
- Content rules
- This field is the same as the Client Mailer ID in Shipping Services file Version 1.3 and Version 1.4. The MID must be registered in Business Customer Gateway. 1. Customers that are considered Mail Owners must complete certification processes to obtain a MID for inclusion in a Shipping Services file. The mail owner will also receive the scan event extract if the Mail Owner Mailer ID is populated in the corresponding Mail Owner Mailer ID field in the Shipping Services file.
- Page
- Publication 199, page 336
- Description
- CRID of Mail Owner
- Content rules
- Used by mailing agent to identify mail owner. Default is spaces.
- Page
- Publication 199, page 337
- Description
- Ship to name of Recipient.
- Example
- JOHN DOE
- Content rules
- Required for all signature products. Recommended for all products. Default is spaces.
- Page
- Publication 199, page 337
- Description
- Delivery Street Address of the destination address.
- Example
- 123 Main Street
- Content rules
- Delivery Point Validated Destination Delivery Address and/or the 11-digit Destination Delivery Point are required. May be provided in Shipping Partner File. Required for Accountable mail and international mail. (May contain secondary unit designator, such as APT or SUITE, for Accountable mail.) The following Special Characters (hyphen, forward slash and period) are allowed. This field is not to be used for the city or state. Default is spaces
- Page
- Publication 199, page 337
- Description
- City Name of the destination address.
- Example
- Fairfax
- Content rules
- Default is spaces
- Page
- Publication 199, page 337
- Description
- Two Character state code of the destination address.
- Example
- VA
- Content rules
- Default is spaces
- Page
- Publication 199, page 337
- Description
- Destination 5-digit ZIP Code for domestic shipments including APO/FPO/DPO and territories.
- Example
- 20540
- Content rules
- Must be 5 digits. Numeric values (0-9)
- Page
- Publication 199, page 337
- Description
- Destination ZIP + 4
- Example
- 1234
- Content rules
- Either the Destination Delivery address or the additional 2-digit DPV must be included. Numeric value (0-9) Default is spaces if not available.
- Page
- Publication 199, page 338
- Description
- Destination Delivery Point – completes the 11-digit Delivery Point ZIP Code.
- Example
- 02
- Content rules
- Numeric values (0-9) only. Default is spaces if not available.
- Page
- Publication 199, page 338
- Description
- List of valid action codes. ‘P0’ – PC Postage ‘S0’ – Service Provider ‘M0’ – Mail Owner ‘V1” – Cancelled Label - Only applicable for GX Event “V2” - Package Delivered by Shipping Partner – Only applicable for GX Event
- Example
- PP
- Content rules
- Must be a valid code (spaces are not a valid code). If Pick Up and Return address is same then use code for shipment type “PC Postage”, “Mail Owner”, ”Service Provider”. Must populate Pick Up address. If Pick Up and Return address is different then all fields in both Pick Up and Return address must be populated.
- Page
- Publication 199, page 338
- Description
- Date Partner or customer expects to tender the package to USPS
- Example
- 20140508
- Content rules
- Format is CCYYMMDD Null value is valid.
- Page
- Publication 199, page 338
- Description
- Date merchant communicated to customer to expect the delivery
- Example
- 20140508
- Content rules
- Format is CCYYMMDD Null value is valid
- Page
- Publication 199, page 338
- Description
- Type of USPS facility where mail is tendered: ‘A’ – ADC ‘B’ – NDC/RPDC ‘S’ – SCF/LPC/RPDC ‘D’ – DDU/S&DC ‘F’ – ASF ‘I’ – ISC 'O' – Origin Post Office ‘H’ - HUB
- Example
- A
- Content rules
- For origin or destination entry facilities. Required for Drop Ship Mailers. Required for Parcel Return Service mailers to note pick-up facility type. Default is spaces.
- Page
- Publication 199, page 339
- Description
- 5-digit ZIP Code of postal facility where the mail is tendered.
- Example
- 22201
- Content rules
- Numeric only (0-9)
- Page
- Publication 199, page 339
- Description
- Customer Delivery Preference
- Example
- A
- Content rules
- Default is spaces. Future Use only.
- Page
- Publication 199, page 339
- Description
- Customer’s Internal Reference Number
- Example
- 123456
- Content rules
- If the "Customer Reference Number 1" is provided in Shipping Partner Event file 5.0 and later this field is provided in Shipping Services File then value from Shipping Services File will overwrite the value from Shipping Partner Event file 5.0.
- Page
- Publication 199, page 339
- Description
- One digit value usage defined by USPS
- Example
- 2
- Content rules
- Required for designated postage price types Valid values are 1 through 5 Default is null.
- Page
- Publication 199, page 339
- Description
- Two digits denotes payment vs refund
- Example
- 07 – Payment 99 – Refund
- Content rules
- Required only for PC Postage. Not required if Return and Pick up address is different. 07 – Payment 97, 98, 99 – Refund. Only valid when action code ='V1' for PC Postage
- Page
- Publication 199, page 340
- Description
- Date IBI was created
- Example
- 2008-01-27 Entered as: 20080127
- Content rules
- Required for PC Postage, metered and IMI PC Compliant customers
- Page
- Publication 199, page 340
- Description
- The Vendor ID is unique for each PC Postage and Meter Vendor.
- Example
- 05
- Content rules
- Required. The 2 digit number USPS assigned vendor ID. Default is spaces if not PC Postage or Meter Vendor
- Page
- Publication 199, page 340
- Description
- Serial number of meter used for postage.
- Example
- 05
- Content rules
- Required for following Payment type, system used for mailing: ‘04’ PC Postage ‘05’ Smart Meter ‘06’ Other Meter
- Page
- Publication 199, page 340
- Description
- Two digit model number of the Meter
- Example
- 1V
- Content rules
- Default is spaces if not available. PC-Postage models are 1 numeric followed by 1 alpha.
- Page
- Publication 199, page 340
- Description
- Address for the pick-up point where the package is located
- Example
- 123 MAIN ST
- Content rules
- Required for PC Postage and Meter Vendor This field is not to be used for the city or state Default is spaces if not PC Postage or Vendor
- Page
- Publication 199, page 341
- Description
- City Name for the pick-up point address where the package is located
- Example
- Fairfax
- Content rules
- Required for PC Postage and Meter Vendor This field is not to be used for the city or state Default is spaces if not PC Postage or Vendor
- Page
- Publication 199, page 341
- Description
- Two Character state code for the pick-up point address where the package is located
- Example
- VA
- Content rules
- Required for PC Postage and Meter Vendor This field is not to be used for the city or state Default is spaces if not PC Postage or Vendor
- Page
- Publication 199, page 341
- Description
- 5-digit ZIP Code for the pick-up point address where the package is located
- Example
- 131500
- Content rules
- Required for PC Postage and Meter Vendor Must be 5 digits. Numeric values (0-9)
- Page
- Publication 199, page 342
- Description
- ZIP+4 add on of domestic ZIP Code for the pick-up point where the package is located
- Example
- 2804
- Content rules
- Required for PC Postage and Meter Vendor Default is spaces, if not provided
- Page
- Publication 199, page 342
- Description
- 2 digit Delivery Point Code that completes the 11-digit ZIP Code for the Pick-up Point address where the package is located
- Example
- 02
- Content rules
- Required for PC Postage and Meter Vendor Numeric values (0-9) only. Default is spaces if not available.
- Page
- Publication 199, page 342
- Description
- Name of Sender(Customer or Company)
- Example
- JOHN DOE
- Content rules
- Required for all signature products. Recommended for all products.
- Page
- Publication 199, page 342
- Description
- Address of the sender or for the address where the package is to be returned if undeliverable
- Example
- 123 MAIN ST
- Content rules
- Required This field is not to be used for the city or state Default is spaces
- Page
- Publication 199, page 342
- Description
- City Name of the sender's address.
- Example
- Fairfax
- Content rules
- Default is spaces
- Page
- Publication 199, page 342
- Description
- Two Character state code of the sender's address or for the address where the package is to be returned if undeliverable
- Example
- VA
- Content rules
- Default is spaces
- Page
- Publication 199, page 342
- Description
- 5-digit ZIP Code of the sender's address or for the address where the package is to be returned if undeliverable.
- Example
- 131500
- Content rules
- Must be 5 digits. Numeric values (0-9)
- Page
- Publication 199, page 343
- Description
- ZIP+4 add on of domestic ZIP Code of the sender or for the address where the package is to be returned if undeliverable.
- Example
- 2804
- Content rules
- Default is spaces, if not provided
- Page
- Publication 199, page 343
- Description
- 2 digit Delivery Point Code that completes the 11-digit ZIP Code of the sender or for the address where the package is to be returned if undeliverable
- Example
- 02
- Content rules
- Numeric values (0-9) only. Default is spaces if not available.
- Page
- Publication 199, page 343
- Description
- Two character standardized ISO International country codes as listed in the International Mail Manual (IMM).
- Example
- JP
- Content rules
- Required for International.
- Page
- Publication 199, page 343
- Description
- Four digit value denotes Product / Rate Category(As defined by the IBI data dictionary)
- Example
- 1234
- Content rules
- 1234 – Commercial Package Return Service. Refer to the IBI data dictionary for list of categories.
- Page
- Publication 199, page 343
- Description
- Refer to Publication 199, Appendix J, Table 11 for the complete list of Rate Indicator codes
- Example
- FR
- Content rules
- For Standard Post with Destination Rates, use ‘Single Piece’ for the Rate Indicator. For PMEOD the rate indicator “PA” is required. For PMOD the rate indicator “SP” is required. For Commercial Plus Pricing the rate indicator of “UA”, “U3”, or “U5” is required.
- Page
- Publication 199, page 343
- Description
- Refer to Publication 199, Appendix J, Table 12 for the complete list of Processing Category codes.
- Example
- 3
- Content rules
- ▪ For Open and Distribute, the processing category “O” is required. ▪ For Returns, the processing category “R” is required.
- Page
- Publication 199, page 344
- Description
- Cost of article
- Example
- Defined as: 99999.99 $500.00 Entered as: 0050000
- Content rules
- Mandatory if insurance is being included as an Extra Service. Required if insured. Default is zeroes.
- Page
- Publication 199, page 344
- Description
- Postage paid (base postage only, excluding Extra Service fees and surcharges) less any work share discount.
- Example
- Defined as: 9999v999 $5.69 Entered as: 0005690
- Content rules
- Leading zeroes required, when populated. Default to zeroes, when not applicable. Numeric values (0-9) only. In unit of dollars and rounded to the nearest tenth of cent.
- Page
- Publication 199, page 344
- Description
- Refer to Publication 199, Appendix J, Table 14 for the complete list of ZONE codes.
- Example
- 03
- Content rules
- Required for products with rates based on zones. Leading zeroes required if numeric. Default is zeroes for non- applicable products. Local Zone Entered as: LC
- Page
- Publication 199, page 344
- Description
- Barcode on container. This may be a valid IMpb, IM Container Barcode, IM Tray Barcode, or a Trailer Placard Barcode.
- Example
- 99M2006431200042583 61
- Content rules
- The IM Container Barcode shall consist of a 21-character data string encoded in a barcode The IM™ Container barcode uniquely identifies the mail owner, mail preparer, or consolidator by way of the Mailer ID field. Furthermore, the IM Container barcode establishes a unique “serial number” for each container. Left justified with trailing spaces if applicable. Used to nest packages to the container Container IDs containing alpha characters should be upper case only. Refer to Publication 199, Appendix J – Table 1 – for appropriate container IDs by customer type
- Page
- Publication 199, page 345
- Description
- Describes type of container for Container ID
- Example
- SK
- Content rules
- Refer to Publication 199, Appendix J, Table 3 for the complete list of Container Type IDs.
- Page
- Publication 199, page 346
- Description
- Unit of measurement for mailpiece weight: ‘1’ - LBS ‘2’ - OZ ‘3’ - KILOS
- Example
- 1
- Content rules
- Field shall contain a USPS defined valid code. Default is ‘1’ – LBS
- Page
- Publication 199, page 346
- Description
- Mailpiece weight. In unit of measure and significant to 4 decimal positions. (Exclude weight of non-incidental enclosure Pos. 489- 497)
- Example
- Defined as: 99999v9999 14.3 lbs. Entered as 000143250
- Content rules
- Required for PC Postage and Meter Vendor Leading zeroes required, when populated. Default to zeroes, when not applicable. Numeric values (0-9) only
- Page
- Publication 199, page 346
- Description
- Dimensional Weight
- Example
- Defined as: 9999v99 7.88 Entered as: 000788
- Content rules
- Leading zeroes required, when populated. Default to zeroes, when not applicable. For GXG and domestic Priority Mail to Local and Zones 1-9 only. For GXG: (LL*WW*HH)/166194 (zero-0 filled from left) – space-filled if calculated value of DW rate < or = value of rate of actual weight. Rectangular: (LLL*WW*HH)/166 (zero-filled from left) Non-Rectangular: ((LLL*WW*HH)*0.785)/ 166 -Space-filled if calculated value of DW rate < or = value of rate of actual weight. File Types 1 and 2 (see rules)
- Page
- Publication 199, page 347
- Description
- Dimensional Length
- Example
- Defined as: 999v99 30.25 Entered as: 03025
- Content rules
- ▪ ▪ Leading zeroes required, when populated ▪ The length is the measurement of the longest dimension. Length in inches. Required for GXG and domestic Priority Mail Local and Zones 1-9 ▪ Required for any rate indicator for Cubic Tier pricing ▪ Zero-filled if not applicable. ▪ Required when rate indicator = DR or DN. If DR or DN is not populated in Rate Indicator, but dimensions (LxWxH) are provided then parcel will be assessed as dimensional.
- Page
- Publication 199, page 348
Unchecked: a cell isn’t in the page’s text, or a second reading of the page doesn’t agree with the row.
- Description
- Dimensional Width or Girth
- Example
- Defined as: 999v99 12.75 Entered as: 01275
- Content rules
- Leading zeroes required, when populated. Default to zeroes, when not applicable. ▪ Width in inches. Required for GXG and domestic Priority Mail Local and Zones 1-9 ▪ Required for any rate indicator
- Page
- Publication 199, page 348
- Description
- Dimensional Height
- Example
- Defined as: 999v99 2.50 Entered as:00250
- Content rules
- Leading zeroes required, when populated. Default to zeroes, when not applicable. ▪ Height in inches. Required for GXG and domestic Priority Mail Local and Zones 1-9 ▪ Required for any rate indicator Cubic Tier pricing. ▪ Zero-filled if not applicable. ▪ Required when rate indicator = DR or DN. ▪ If DR or DN is not populated in Rate Indicator, but dimensions (LxWxH) are provided then parcel will be assessed as dimensional.
- Page
- Publication 199, page 349
- Description
- This is a dual purpose field in which to store IBI information or Delivery Address Information Information-Based Indicia (IBI) - Refers to a secure postage evidencing standard used by the United States Postal Service (USPS) to indicate electronic postage payment. The barcode data contains such information as amount of postage, origin zip code, destination, mail class, weight, confirmation/tracking numbers, and a cryptographic signature. The human-readable information shows at a minimum the information required by the USPS Domestic Mail Manual (DMM). Secondary Address Unit Designator or Urbanization (up to 48 characters). Populate the supplemental address information in positions 632-679, left justified, trailing spaces
- Example
- Example IBI: AAFlBkAMDI0UJAweAA 4lJHEAPwrAEp5MwGVc wEA9wsAAAAAAAAAA AAQhKwANzUwMFgo/A FctgtL06vQQxBOBo5lVk cnjgbyufrCw+wefRANHl 6//sMR6oYIBKV8AAAIA AAAAAA= Urbanization Four Line Address: Mrs Jane Doe URB Las Gladio 150 Calle A San Juan PR 00926
- Content rules
- Required for PC Postage and Meter Vendor .
- Page
- Publication 199, page 350
- Description
- The foreign postal code is a 7 character field. Mailers may submit the destination foreign postal code for international shipments.
- Example
- A0C 9Z9
- Content rules
- Spaces are required.
- Page
- Publication 199, page 350
- Content rules
- Spaces are required.
- Page
- Publication 199, page 350