eBay Post-Order APIVersion 2

Confirm Cancellation Refund

POST /post-order/v2/cancellation/{cancelId}/confirm

This call is used on behalf of the buyer to confirm that a refund has been received for the specified order cancellation. In the case of unpaid order, this call can also be used by the buyer just to acknowledge that the order has been cancelled, and that the cancellation request has been closed.

Input

See also Samples.

Resource URI (production)

POST https://api.ebay.com/post-order/v2/cancellation/{cancelId}/confirm

URI parameters

Parameter Type Required? Meaning
cancelId string Required The unique identifier of the cancellation/refund being confirmed.


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.

{ /* ConfirmRefundRequest */
"refundDate":
    { /* DateTime */
    "value": datetime
    },
"unpaidOrder": boolean
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
refundDate DateTime Conditional The date and time that the refund was received. This container is ignored if the unpaidOrder field is used and set to true. This container must be provided if a refund was issued.
refundDate.value datetime Conditional This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
unpaidOrder boolean Conditional The buyer will include this field and pass in a value of true if the cancelled order was never paid for by the buyer, hence the buyer is not eligible for a refund. If this value is passed in as true, the refundDate field is not applicable.

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: Confirm a refund

Buyer confirms receipt of a refund.

Description

The buyer uses this call to confirm they received the refund associated with a cancellation request.

Input

There is no payload with this request. Supply the cancellation ID as a path parameter in the call.

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

POST https://api.ebay.com/post-order/v2/cancellation/5000021217/confirm

Output

A successful call returns an HTTP code of 200; there is no payload for the response.

JSON format.



Change History

Change Date Description
1.0
2015-06-30
  • Call (added): New call.