Order Tracker Request

The tracking details of an order.

Structure

OrderTrackerRequest

Fields

Name	Type	Tags	Description	Getter	Setter
TrackingNumber	String	Optional	The tracking number for the shipment. This property supports Unicode. Constraints: Minimum Length: 1, Maximum Length: 64	String getTrackingNumber()	setTrackingNumber(String trackingNumber)
Carrier	ShipmentCarrier	Optional	The carrier for the shipment. 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. Constraints: Minimum Length: 1, Maximum Length: 64, Pattern: ^[0-9A-Z_]+$	ShipmentCarrier getCarrier()	setCarrier(ShipmentCarrier carrier)
CarrierNameOther	String	Optional	The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. This property supports Unicode. Constraints: Minimum Length: 1, Maximum Length: 64	String getCarrierNameOther()	setCarrierNameOther(String carrierNameOther)
CaptureId	String	Required	The PayPal capture ID. Constraints: Minimum Length: 1, Maximum Length: 50, Pattern: ^[a-zA-Z0-9]*$	String getCaptureId()	setCaptureId(String captureId)
NotifyPayer	Boolean	Optional	If true, PayPal will send an email notification to the payer of the PayPal transaction. The email contains the tracking details provided through the Orders tracking API request. Independent of any value passed for notify_payer, the payer may receive tracking notifications within the PayPal app, based on the user's notification preferences. Default: false	Boolean getNotifyPayer()	setNotifyPayer(Boolean notifyPayer)
Items	List<OrderTrackerItem>	Optional	An array of details of items in the shipment.	List getItems()	setItems(List items)

Example (as JSON)

{
  "capture_id": "capture_id0",
  "notify_payer": false,
  "tracking_number": "tracking_number6",
  "carrier": "ACS_GR",
  "carrier_name_other": "carrier_name_other0",
  "items": [
    {
      "name": "name8",
      "quantity": "quantity4",
      "sku": "sku6",
      "url": "url2",
      "image_url": "image_url4"
    },
    {
      "name": "name8",
      "quantity": "quantity4",
      "sku": "sku6",
      "url": "url2",
      "image_url": "image_url4"
    }
  ]
}