TrackingInformation
Query shipment tracking information including the tracking number, carrier, and status.
View-Specific Information
SELECT
The only supported filters are TransactionId and AccountId.
Filters only support the = operator. The provider processes other filters client side within the provider.
TransactionId is a required column.
For example, the following queries are processed server side:
SELECT * FROM TrackingInformation WHERE TransactionId = '5AC260196F2986240'
SELECT * FROM TrackingInformation WHERE TransactionId = '5AC260196F2986240' AND AccountId = '23577833'
Columns
| Name | Type | References | Description |
| TransactionId [KEY] | String | The PayPal transaction ID. | |
| TrackingNumber [KEY] | String | The tracking number for the shipment. | |
| TrackingNumberType | String | The type of tracking number.
The allowed values are CARRIER_PROVIDED, E2E_PARTNER_PROVIDED. | |
| AccountId | String | Encrypted PayPal Account ID of the buyer or seller. | |
| Status | String | The status of the shipment.
The allowed values are SHIPPED, DELIVERED, CANCELLED, LOCAL_PICKUP, ON_HOLD. | |
| Carrier | String | The carrier for the shipment. | |
| CarrierNameOther | String | The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. | |
| PostagePaymentId | String | The postage payment ID. | |
| NotifyBuyer | Boolean | If true , sends an email notification to the buyer of the PayPal transaction.
The default value is false. | |
| Quantity | Integer | The quantity of items shipped. | |
| TrackingNumberValidated | Boolean | Indicates whether the carrier validated the tracking number. | |
| ShipmentDirection | String | To denote whether the shipment is sent forward to the receiver or returned back.
The allowed values are FORWARD, RETURN. | |
| ShipmentUploader | String | To denote which party uploaded the shipment tracking info.
The allowed values are MERCHANT, CONSUMER, PARTNER. | |
| ShipmentDate | Date | The Shipment Date. | |
| TrackingUrl | String | Tracking Link of the shipment. | |
| FulfillmentProvider | String | Indicates the fulfillment service used to deliver an order. | |
| LastUpdatedTime | Datetime | Last Updated Time. |