ScanDetailType

This type is used by the scanHistory container that is returned in the GET /post-order/v2/return/{returnId}/tracking response to provide details on each time a shipment is scanned by the shipping carrier. The scanHistory container will be returned if shipment tracking is active for the order line item, and at least one scan has been made on the package.

Type that uses ScanDetailType:

GetTrackingHistoryResponse

Call that uses ScanDetailType:

/post-order/v2/return/{returnId}/tracking GET

Fields

eventCity ( string )

eventCode ( string )

eventDesc ( string )

eventPostalCode ( string )

eventStateOrProvince ( string )

eventStatus ( string )

eventTime ( DateTime )

eventCity ( string ) [0..?]

This string value is the city in which the shipment event occurred. This field is always returned with the scanHistory container.

See the Field Index to learn which calls use eventCity.

eventCode ( string ) [0..?]

This enumeration value represents the shipment event that occurred. This field is returned if available.

See the Field Index to learn which calls use eventCode.

eventDesc ( string ) [0..?]

This field contains the description of the shipment event that occurred. This field is returned if available.

See the Field Index to learn which calls use eventDesc.

eventPostalCode ( string ) [0..?]

This string value is the postal code for the scan location. This field is always returned with the scanHistory container.

See the Field Index to learn which calls use eventPostalCode.

eventStateOrProvince ( string ) [0..?]

This string value is the state or province in which the shipment event occurred. This field is always returned with the scanHistory container.

See the Field Index to learn which calls use eventStateOrProvince.

eventStatus ( string ) [0..?]

This field contains shows the latest delivery status of the shipment based on the event (scan) that just occurred. This field is always returned with the scanHistory container.

See the Field Index to learn which calls use eventStatus.

eventTime ( DateTime ) [0..?]

The timestamp in this container indicates the date and time when the shipment event occurred. This field is always returned with the scanHistory container.

See the Field Index to learn which calls use eventTime.