Get Shipment Tracking Info

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

This method can be used to retrieve all shipment tracking activity on a specific return request. The information returned includes the date, location, and scan type for each time the shipping package was scanned.

Input

See also Samples.

Resource URI (production)

GET https://api.ebay.com/post-order/v2/return/{returnId}/tracking?
  carrier_used=string&
  tracking_number=string

URI parameters

HTTP request headers

All requests made to eBay REST operations require you to provide the authorization HTTP header for authentication.
See HTTP request headers for details.

Authorization

This call uses standard authorization tokens. See Making a Call for details.

Payload model

This call has no request payload.

Output

See also Samples.

Payload model

Note: For information about the error fields and how to work with them, see Error Handling.

The following lists all fields that could be included in the response.

Supported response formats: application/json, application/xml

For more information:
- See GetTrackingHistoryResponse for a description of the response structure
- See the following table for descriptions of each of the data elements returned
- See the Samples for an example of the response format

{ /* GetTrackingHistoryResponse */
"carrierUsed": string,
"scanHistory": [
    { /* ScanDetailType */
    "eventCity": string,
    "eventCode": string,
    "eventDesc": string,
    "eventPostalCode": string,
    "eventStateOrProvince": string,
    "eventStatus": string,
    "eventTime":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        }
    }
    /* More ScanDetailType nodes here */
  ],
"trackingNumber": string,
"trackingStatus": string
}

Response field descriptions

Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Retrieve shipment tracking activity for a return.

Description

This call is used to retrieve shipment tracking activity for an item that is being returned.

Input

The seller passes in the return request ID as a path parameter in the URI. Shipment tracking activity will be returned for the return item that is associated with this return request ID.

URL format. See also the non-wrapped version of this URL.

GET https://api.ebay.com/post-order/v2/return/5********2/tracking

Output

The shipping carrier and the shipment tracking number is returned at the top of the response. The current status of shipment is DELIVERED, as shown by the trackingStatus field. Details on the two shipment scan activities are shown under the scanHistory container.

JSON format.
{ 
"carrierUsed": "USPS",
"trackingNumber": "0**************3",
"trackingStatus": DELIVERED
"scanHistory": [
    { 
    "eventStatus": DELIVERED,
    "eventDesc": "Delivered",
    "eventTime":
		   { 
			 "value": "2015-04-11T12:46:00.000-07:00"
       },
    "eventCity": "SACRAMENTO",
    "eventStateOrProvince": CA,
    "eventPostalCode": 9***4,
    "eventCode": "UNKNOWN",
    },
    { 
		"eventStatus": IN_TRANSIT,
		"eventDesc": "Arrival at Pickup point",
		"eventTime":
			 { 
			 "value": "2015-04-10T11:47:00.000-07:00"
			 },
		"eventCity": "SACRAMENTO",
		"eventStateOrProvince": CA,
		"eventPostalCode": 9***4,
		"eventCode": "UNKNOWN",
    }
  ],
}

Change History