eBay Post-Order APIVersion 2

Provide Return Shipment Info

POST /post-order/v2/casemanagement/{caseId}/provide_shipment_info

This call allows the buyer to provide shipment tracking information for the item that is being returned to the seller.

Input

See also Samples.

Resource URI (production)

POST https://api.ebay.com/post-order/v2/casemanagement/{caseId}/provide_shipment_info

URI parameters

Parameter Type Required? Meaning
caseId string Required The unique identifier of a case. This URI parameter is required in order to identify the case for which the buyer is providing return shipment tracking information to the seller. The case is identified by the caseId that is passed in as part of the call URI.


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.

{ /* ProvideShipmentInfoRequest */
"shippingCarrierName": string,
"trackingNumber": string
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
shippingCarrierName string Required The shipping carrier that is used to ship the item, such as 'FedEx', 'UPS', or 'USPS'.
trackingNumber string Required The tracking number assigned by the shipping carrier to the item shipment. This value should be passed in without hyphens or spaces. The seller is responsible for the accuracy of this value, as eBay can only validate that the format is consistent with the format that is used by the specified shipping carrier.

Output

See also Samples.

Payload model

This call has no response payload.



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: Basic Call

Buyer provides return shipment information to the seller.

Description

Now that the return request has been escalated to a case, the seller has finally agreed to issue a full refund upon receiving the returned item from the buyer. With this call, the buyer is providing the shipment tracking information to the seller.

Input

The buyer passes in the case ID value as a path parameter to identify the case for which shipment tracking details are being provided to the seller. The shippingCarriername field is used to provide the name of the shipping carrier and the trackingNumber field is used to provide the tracking number for the shipment.

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

POST https://api.ebay.com/post-order/v2/casemanagement/5002654373/provide_shipment_info
{ 
"shippingCarrierName": "FedEx",
"trackingNumber": "12141098967"
}

Output

There is no output payload with this response. A successful call contains an HTTP status code of 200.

JSON format.



Change History

Change Date Description