Get Return Request Draft Files

GET /post-order/v2/return/draft/{draftId}/files

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

Input

See also Samples.

Resource URI (production)

GET https://api.ebay.com/post-order/v2/return/draft/{draftId}/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.

Retrieves any files associated with a return draft.

Description

This call is used to retrieve any files associated with a return draft. If no files are associated with the specified return draft, no output payload will be returned.

Input

A draft ID value for the return draft is passed in as a path parameter. There is no request payload for this call.

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

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

Output

The response shows that two files are associated with the return draft. One of the files is related to the condition of the item, and the other file is related to the shipping label and/or shipment tracking information. Both files are in the CREATED status. The next status beyond CREATED is PUBLISHED, but this status is only possible for actual return requests and not return drafts.

JSON format.
{ 
"files": [
    { 
    "creationDate":
        { 
        "value": "2015-08-05T20:18:17.000Z"
        },
    "fileData": [47,57,106,...,81,61,61],
    "fileFormat": JPG,
    "fileId": "5********2",
    "filePurpose": ITEM_RELATED,
    "fileStatus": CREATED,
    "submitter": BUYER
    },
    { 
		"creationDate":
				{ 
				"value": "2015-08-05T20:18:17.000Z"
				},
		"fileData": [23,64,110,...,41,67,84],
		"fileFormat": BMP,
		"fileId": "5********3",
		"filePurpose": LABEL_RELATED,
		"fileStatus": CREATED,
		"submitter": BUYER
    }
  ]
}

Change History