Get Return Draft Files
GET /post-order/v2/return/draft/{draftId}/files
Use this call to retrieve information about the files associated with a return draft.
Output Samples Change History |
Input
See also Samples.
Resource URI (production)
GET https://api.ebay.com/post-order/v2/return/draft/{draftId}/files
URI parameters
Parameter | Type | Required? | Meaning |
---|---|---|---|
draftId | string | Required | The unique eBay-assigned ID of the return draft. The draftId value is required to identify the return draft for which associated files will be retrieved. |
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.
Input Samples Change History |
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": token, "fileId": string, "fileName": string, "filePurpose": token, "fileStatus": token, "resizedFileData": string, "secureUrl": string, "submitter": token } /* More ReturnFileType nodes here */ ] }
Response field descriptions
Output Container/Field | Type | Occurrence | Meaning |
---|---|---|---|
files | array of ReturnFileType | Conditionally | This container holds an array of one or more files associated with the return request or return draft specified in the request. If there are no files associated with the specified return request or return draft, this container will not be returned. |
files.creationDate | DateTime | Conditionally | This timestamp indicates when the file was attached to the return request or draft. |
files.creationDate .formattedValue |
string | Conditionally | Reserved for future use. |
files.creationDate.value | datetime | Conditionally |
The date and time defining the start or end of an action or event. 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: 2020-08-20T00:00:00.000Z
|
files.fileData | string | Conditionally | This field is the base64-encoded binary representation of the file associated with the return request. This field is always returned for each file that is attached to a return request or draft. |
files.fileFormat | token | Conditionally |
Indicates the file type (like .GIF or .JPG). This field is always returned for each file that is attached to a return request or draft. Applicable values: See FileFormatEnum |
files.fileId | string | Conditionally | This is the unique eBay-assigned ID of a file that is associated with the return request. This field is always returned for each file that is attached to a return request or draft. |
files.fileName | string | Conditionally | This field contains the name of the uploaded file. |
files.filePurpose | token | Conditionally |
Indicates whether the file's purpose is to provide more information about the condition of the item, about the refund, or about shipment tracking or shipping label. This field is always returned for each file that is attached to a return request or draft. Applicable values: See FilePurposeEnum |
files.fileStatus | token | Conditionally |
Indicates the current status of the file. This field is always returned for each file that is attached to a return request or draft. Applicable values: See FileStatusEnum |
files.resizedFileData | string | Conditionally | This field is the base64-encoded binary representation of the file associated with the return request. This field is always returned for each file that is attached to a return request or draft. This field is only returned if the file has been resized. |
files.secureUrl | string | Conditionally | This field contains the URL location of the uploaded file. |
files.submitter | token | Conditionally |
Indicates which party (like buyer or seller) submitted the file. This field is always returned for each file that is attached to a return request or draft. Applicable values: See ReturnUserRoleEnum |
Input Output Change History |
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
}
]
}
Input Output Samples |
Change History
Change Date | Description |
---|