eBay Post-Order APIVersion 2.6

Update Shipment Tracking Info

PUT /post-order/v2/return/{returnId}/update_tracking

This call allows buyer or seller to override the current shipping carrier and/or shipment tracking number for the return item or replacement item, respectively.

Input

See also Samples.

Resource URI (production)

PUT https://api.ebay.com/post-order/v2/return/{returnId}/update_tracking

URI parameters

Parameter Type Required? Meaning
returnId string Required The unique eBay-assigned ID of the return request. The returnId value is required to identify the return request for which shipment tracking information is being updated.


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

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

{ /* UpdateTrackingRequest */
"newCarrierEnum": token,
"newCarrierName": string,
"newTrackingNumber": string,
"usedCarrierEnum": token,
"usedCarrierName": string,
"usedTrackingNumber": string
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
newCarrierEnum token Conditional This enumeration value represents a new shipping carrier that will replace the enumeration value specified in the usedCarrierEnumfield. To update the shipping carrier, either the usedCarrierEnum and newCarrierEnum fields can be used, or the usedCarrierName and newCarrierName fields.

Applicable values: See ShippingCarrierEnum
newCarrierName string Conditional This string value represents a new shipping carrier that will replace the string value specified in the usedCarrierNamefield. To update the shipping carrier, either the usedCarrierName and newCarrierName fields can be used, or the usedCarrierEnum and newCarrierEnum fields.
newTrackingNumber string Conditional This string value represents a new tracking number that will replace the tracking number value specified in the usedTrackingNumber field. This field, along with the usedTrackingNumber field is required if the shipment tracking number is being updated.
usedCarrierEnum token Conditional This enumeration value represents the current shipping carrier being used to ship the item. To update the shipping carrier, either the usedCarrierEnum and newCarrierEnum fields can be used, or the usedCarrierName and newCarrierName fields. This enumeration value must be accurate or the shipping carrier will not be updated to the new value specified in the newCarrierEnum field.

Applicable values: See ShippingCarrierEnum
usedCarrierName string Conditional This string value represents the current shipping carrier being used to ship the item. To update the shipping carrier, either the usedCarrierName and newCarrierName fields can be used, or the usedCarrierEnum and newCarrierEnum fields. This value must be accurate or the shipping carrier will not be updated to the new value specified in the newCarrierName field.
usedTrackingNumber string Conditional This string value represents the current tracking number of the item. This field, along with the newTrackingNumber field is required if the shipment tracking number is being updated. This tracking number must be accurate or the shipment tracking number will not be updated to the new value specified in the newTrackingNumber field.

Output

See also Samples.

Payload model

This call has no response payload.

null



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.

Sample: Update shipment tracking information

This call updates shipment tracking information

Description

This call allows buyer or seller to override the current shipping carrier and/or shipment tracking number for the return item or replacement item, respectively.

Input

For this call, the seller is switching shipping carriers from FedEx to USPS, so the seller must pass in the FedEx information in the usedCarrierEnum and in the usedTrackingNumber fields, and the USPS information in the newCarrierEnum and in the newTrackingNumber fields. The USPS information will override the FedEx information.

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

PUT https://api.ebay.com/post-order/v2/return/{returnId}/update_tracking
{ 
	"newCarrierEnum": "USPS",
	"newTrackingNumber": "9301920128700000562780",
	"usedCarrierEnum": "FEDEX",
	"usedTrackingNumber": "139202705344"
}

Output

There is no response payload for this call, but only an HTTP status code that indicates success.

JSON format.
No response payload



Change History

Change Date Description