eBay Post-Order APIVersion 2

removeReturnFile

DELETE /post-order/v2/return/{returnId}/file/{fileId}

Use this call to delete a file that is currently associated with a return request.

Input

Request model

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

See also Samples.

Resource URI (production)

DELETE https://api.ebay.com/post-order/v2/return/{returnId}/file/{fileId}

URI parameters

Parameter Type Required? Meaning
fileId string Required The unique identifier of a file associated with a return. This identifier can be retrieved by using a getFiles call. The fileId value is required to identify the file to delete.
returnId string Required The unique identifier of the return. The returnId value is required to identify the return for which a file is being deleted.


Supported HTTP request headers

Header Description Applicable Values
Accept The media type for the response. Defaults to JSON (the only supported media type). application/json
Authorization The Authentication Token that is used to validate the caller has permission to access the eBay servers. Prefix a valid eBay token with the word "TOKEN".
For more details, see Getting Tokens.
Required
TOKEN <authorization-token-value>
Content-Type The MIME type of the body of the request. Must be JSON.
Required
application/json
X-EBAY-C-MARKETPLACE-ID The global ID of the eBay site on which the transaction took place.
Required
Currently, the marketplaces are limited to:
EBAY-US, EBAY-UK, and EBAY-DE


Authorization

This call uses standard authorization tokens. See Making a Call for details.

Payload model

This call has no request payload.


Output

Response model

A successful call contains an HTTP status code of 200. See the HTTP Status Code Registry for a complete overview of HTTP status codes.

Note: The response information on this page applies to successful requests only. For information about the error fields and how to work with them, see Error Handling.

See also Samples.

Payload model

This call has no response payload.




Samples

New to making API calls? Please see Making an API 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: Delete a File

This operation deletes a previously uploaded file.

Description

If you have previously uploaded and associated a particular supporting file with a specific return request, use this operation to delete the file if you have determined that it is not relevant to the return request after all.

Input

The returnId parameter is required to identify the return request from which the file is being deleted, and the fileId parameter identifies the file. This call has no request payload.

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

DELETE https://api.ebay.com/post-order/v2/return/5000116809/file/5000013622

Output

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

JSON format. Also available is the .txt version of this JSON.




Change History

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