eBay Post-Order APIVersion 2.7.2
 

Confirm Cancellation Refund

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

This is a buyer-side method that you can use to indicate that the buyer received a refund for the specified order cancellation.

In the case of an unpaid order, this method can also be used by the buyer to acknowledge 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 eBay-assigned identifier of the cancellation request for which to confirm refund. The cancellation ID value 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.

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

Request field descriptions



Input Container/Field Type Occurrence Meaning
refundDate DateTime Conditional A timestamp is supplied here to indicate the date and time when the buyer received a refund. This container is conditionally required if the buyer has received a refund.
refundDate.formattedValue string Optional Reserved for future use.
refundDate.value datetime Conditional This timestamp indicates the date and time when an action or event occurred.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2022-03-20T00:00:00.000Z
unpaidOrder boolean Conditional This boolean field is supplied here and set to true to indicate that the buyer never paid for the order that is being cancelled, so the buyer is not eligible for a refund.

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/5********7/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