This call is used by the seller to reject the buyer's order cancellation request. A seller will often reject the cancellation request if one or more line items in the order have already been shipped to the buyer, making the order ineligible to be canceled. If the seller has shipped the order line item, it is good practice to pass shipmentDate and trackingNumber in the request payload.
Important! The shipmentDate and trackingNumber fields are optional in the request payload. If you do not include either field, you must submit a payload consisting of just the opening and closing braces: {}
.
Output Samples Change History |
See also Samples.
POST https://api.ebay.com/post-order/v2/cancellation/{cancelId}/reject
Parameter | Type | Required? | Meaning |
---|---|---|---|
cancelId | string | Required | The unique identifier of the cancellation request to be rejected. |
All requests made to eBay REST operations require you to provide the authorization
HTTP header for authentication.
See HTTP request headers for details.
This call uses standard authorization tokens. See Making a Call for details.
The following lists all fields that could be included in the request.
{ /* RejectCancelRequest */ "shipmentDate": { /* DateTime */ "value": datetime }, "trackingNumber": string }
Input Container/Field | Type | Occurrence | Meaning |
---|---|---|---|
shipmentDate | DateTime | Optional |
The date and time that a package in the order was shipped by the seller. Although not a required container, the shipment date should be provided if the seller has indeed shipped the order. |
shipmentDate.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. |
trackingNumber | string | Optional | The shipment tracking number for the package that is en route to the buyer. Although not a required field, the tracking number should be provided if the seller has indeed shipped the order. |
Input Samples Change History |
See also Samples.
This call has no response payload.
Input Output Change History |
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.
The seller rejects the buyers request for an order cancellation.
Description
The seller can reject a cancellation request for a number of reasons, but the most likely reason is because at least one line item in the order has already been shipped. If this is the reason, the seller provides shipment tracking information to the buyer.
Input
Supply the cancellation ID as a path parameter in the call. In the request payload, the seller passes in the shipment date and a shipment tracking number. This indirectly lets the buyer know that the cancellation request was rejected because the order is already en route to the buyer.
URL format. See also the non-wrapped version of this URL. POST https://api.ebay.com/post-order/v2/cancellation/5000021218/reject { "shipmentDate": { "value": "2015-08-22T23:29:11.000Z" }, "trackingNumber": "4205690192023901007105000020336250" }
Output
A successful call returns an HTTP code of 200; there is no payload for the response.
JSON format.
Input Output Samples |
Change Date | Description |
---|
Copyright © 2015–2018 eBay Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.