File format

Below is a detailed breakdown of the file format:

Table 2. PTS File Format

Column Number

Column Name

Column Length

Mandatory (Y/N)?

Data Type

Description

1

ParcelStatusName

255

Y

Text

Metapack generic parcel status.

Refer to Metapack's parcel status codes.

2

ParcelStatusID

11

Y

Numeric

Metapack generic parcel status ID (internal use only).

Refer to Metapack's parcel status codes.

3

StatusText

255

N

Text/Numeric

Additional text provided by the carrier, e.g. 'Out for Delivery'.

4

CarrierStatusCode

255

N

Text/Numeric

Carrier status code.

5

CarrierReasonCode

255

N

Text/Numeric

Carrier reason code.

6

DepotAchievingStatus

255

N

Text/Numeric

Carrier depot that reported the status.

7

ParcelCode

255

Y

Text/Numeric

Metapack parcel code.

8

SystemCorrelationCode

255

Y

Numeric

ID of parcel in Metapack system (internal use only).

9

Custom1

255

N

Text/Numeric

Custom1 field from the consignment.

10

CarrierConsignmentCode

255

Y

Text/Numeric

Metapack carrier consignment code.

11

CarrierCode

255

Y

Text/Numeric

Metapack internal carrier code.

12

ConMatchingCode

255

Y

Text/Numeric

Matching code of the consignment (internal use only).

13

AchievedDateTime

Y

Date/Time (yyyy-mm-dd hh:mm:ss)

The date and time of the status in the time zone specified in column 25.

14

MatchedDateTime

Y

Date/Time (yyyy-mm-dd hh:mm:ss)

Performance metric (internal use only).

15

NotifiedBySourceDateTime

Y

Date/Time (yyyy-mm-dd hh:mm:ss)

Date/time when the status was initially processed.

16

ProcessedDateTIme

Y

Date/Time (yyyy-mm-dd hh:mm:ss)

Date/time when the status was initially processed.

17

Postcode

255

N

Text/Numeric

Destination postcode of the consignment.

18

TransactionTypeID

11

Y

Numeric

Transaction type of the consignment (e.g. delivery/pickup).

19

DestinationCountryCode

255

Y

Text

Destination country code of the consignment.

20

SystemCode

255

Y

Text/Numeric

System code (internal use only).

21

RetailerID

11

Y

Numeric

Metapack retailer ID.

22

RetailerKey

255

Y

Text/Numeric

Retailer key (internal use only).

23

MetapackCarrierServiceCode

255

Y

Text/Numeric

Metapack internal carrier service code.

24

OrderRef

255

Y

Text/Numeric

Order reference for the consignment.

25

AchievedTimeZone

255

Y

Text

Time zone in which the status was achieved.

26

TrackableItemCompletedDate

N

Date/Time (yyyy-mm-dd hh:mm:ss)

Completed date and time of the consignment (i.e. when the final status is achieved in the time zone specified in column 25).


Notes
  • Each PTS file is generated with a header record.

  • The information provided can vary by carrier - e.g. DepotAchievingStatus could be either a numeric or text value.

  • Empty fields should be expected - e.g. a carrier may not provide Metapack with a DepotAchievingStatus.

  • MatchedDateTime, NotifiedBySourceDateTime and ProcessedDateTime are always provided in the London/Europe time zone.

  • AchievedDateTime and TrackableItemCompletedDate are linked to the AchievedTimeZone where provided. If the carrier does not provide the AchievedTimeZone, then PTS assumes that the time zone is the same as that of the origin or destination of the shipment, depending on the status. For example, a “Delivered” status will always cause the time zone of the destination to be used, whereas an “In transit” status will always cause the time zone of the origin to be used (regardless of where the actual scan took place).