On this page
No Headings
An array of tracking information for shipments.
arrayitemsobjectThe tracking information for a shipment.
transaction_idrequiredstring^[a-zA-Z0-9]*$The PayPal transaction ID.
tracking_numberstring^.*$The tracking number for the shipment. This property supports only ASCII characters and does not allow URL, phone number, or email formats. Carrier information (carrier) is required if a tracking number is provided.
tracking_number_typestring"CARRIER_PROVIDED", "E2E_PARTNER_PROVIDED"^[0-9A-Z_]+$The type of tracking number.
statusrequiredstring"CANCELLED", "DELIVERED", "LOCAL_PICKUP", "ON_HOLD", "SHIPPED", "SHIPMENT_CREATED", "DROPPED_OFF", "IN_TRANSIT", "RETURNED", "LABEL_PRINTED", "ERROR", "UNCONFIRMED", "PICKUP_FAILED", "DELIVERY_DELAYED", "DELIVERY_SCHEDULED", "DELIVERY_FAILED", "INRETURN", "IN_PROCESS", "NEW", "VOID", "PROCESSED", "NOT_SHIPPED", "COMPLETED"^[A-Z_]+$The status of the item shipment. For allowed values, see Shipping Statuses.
shipment_datestringppaas_date_notime_v2^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The date when the shipment occurred, in Internet date and time format.
carrierstring^.*$The carrier for the shipment. Carrier information is required when tracking_number is provided. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set carrier to OTHER and set carrier name in carrier_name_other. For allowed values, see Carriers.
carrier_name_otherstring^.*$The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER.
postage_payment_idstring^.*$The postage payment ID.
notify_buyerbooleanfalseIf true , sends an email notification to the buyer of the PayPal transaction. The email contains the tracking information that was uploaded through the API.
quantityintegerThe quantity of items shipped.
tracking_number_validatedbooleanIndicates whether the carrier validated the tracking number.
last_updated_timestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time when the tracking information was last updated, in Internet date and time format.
shipment_directionstring"FORWARD", "RETURN"^[A-Z]*$To denote whether the shipment is sent forward to the receiver or returned back.
shipment_uploaderstring"MERCHANT", "CONSUMER", "PARTNER"^[A-Z]*$To denote which party uploaded the shipment tracking info.
account_idstring^[2-9A-HJ-NP-Z]{13}$Encrypted PayPal Account ID of the buyer or seller.
tracking_urlstringuri^.*$Tracking Link of the shipment.
fulfillment_providerstring^.*$Indicates the fulfillment service used to deliver an order.
linksarrayAn array of request-related HATEOAS links.
itemsobjectA request-related HATEOAS link.
hrefrequiredstringThe complete target URL. To make the related call, combine the method with this link, in URI template format. Include the $, (, and ) characters for pre-processing. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstringThe link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"The HTTP method required to make the related call.