Get Return Files

GET /post-order/v2/return/{returnId}/files

Use this method to retrieve information about the files associated with a return request.

Input

See also Samples.

Resource URI (production)

GET https://api.ebay.com/post-order/v2/return/{returnId}/files

URI parameters

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

This call has no request payload.

Output

See also Samples.

Payload model

Note: For information about the error fields and how to work with them, see Error Handling.

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

Supported response formats: application/json, application/xml

For more information:
- See GetFileResponse for a description of the response structure
- See the following table for descriptions of each of the data elements returned
- See the Samples for an example of the response format

{ /* GetFileResponse */
"files": [
    { /* ReturnFileType */
    "creationDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "fileData": string,
    "fileFormat": string,
    "fileId": string,
    "fileName": string,
    "filePurpose": string,
    "fileStatus": string,
    "resizedFileData": string,
    "secureUrl": string,
    "submitter": string
    }
    /* More ReturnFileType nodes here */
  ]
}

Response field descriptions

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.

Retrieve the files that were uploaded to support a return.

Description

This operation requests the data and supporting information for all files that are associated with the specified return.

Input

The returnId parameter is required to identify the return for which files are being retrieved. This call has no request payload.

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

GET https://api.sandbox.ebay.com/post-order/v2/return/5********1/files

Output

The response contains the identifier and the data for one JPEG file that was uploaded by the buyer to illustrate the condition of the item for which the return request was submitted. The file data is truncated for readability in this sample.

JSON format.
{
  files : [ 
  {
    fileId : "5********2",
    fileData : "/9j/4*********************D/7***Q ... G**************************P/2Q==",
    filePurpose : "ITEM_RELATED",
    fileStatus : "CREATED",
    submitter : "BUYER",
    fileFormat : "JPEG",
    creationDate : 
    {
      value : "2015/08/13 15:49:28.000.-0700"
    }
  } 
  ]
}

Change History