Use this call to activate the associated file(s) on the return request. A file is associated to a return request with the POST /post-order/v2/return/{returnId}/file/upload call.
Output Samples Change History |
See also Samples.
POST https://api.ebay.com/post-order/v2/return/{returnId}/file/submit
Parameter | Type | Required? | Meaning |
---|---|---|---|
returnId | string | Required | The unique identifier of the return. The returnId value is required to identify the return for which files are being activated. |
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.
{ /* SubmitFileRequest */ "filePurpose": token }
Input Container/Field | Type | Occurrence | Meaning |
---|---|---|---|
filePurpose | token | Optional |
This value is used to indicate if the file(s) are being used to provide more information about the condition of the item, or intended to provide more information about shipment tracking or about the shipping label. This field is optional, because it is also possible for the user to set the file's purpose when using POST /post-order/v2/return/{returnId}/file/upload call. Applicable values: See FilePurposeEnum |
Input Samples Change History |
See also Samples.
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 SubmitFileResponse 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
{ /* SubmitFileResponse */ "removedFileIds": [ string /* More string nodes here */ ] }
Output Container/Field | Type | Occurrence | Meaning |
---|---|---|---|
removedFileIds | array of string | Conditionally | This container is an array of one or more associated files that were removed from a return request or return draft. |
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.
Activate a proof file on a return request
Description
This call is used to activate a proof file that is associated with the return request. Proof files may included a picture of a damaged or 'not as described' item, or an image file of a shipment tracking number.
Input
The user passes in the returnId as a path parameter in the URI of the call. In the request payload, the seller passes in ITEM_RELATED
in the filePurpose field to indicated that the proof file is related to the condition of the item.
URL format. See also the non-wrapped version of this URL. POST https://api.ebay.com/post-order/v2/return/{returnId}/file/submit { "filePurpose": ITEM_RELATED }
Output
A successful call contains an HTTP status code of 200.
JSON format.
SAMPLE COMING SOON
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.