Mark Return Received
POST /post-order/v2/return/{returnId}/mark_as_received
This call allows a buyer or seller to mark a return or replacement item as 'received'.
Output Samples Change History |
Input
See also Samples.
Resource URI (production)
POST https://api.ebay.com/post-order/v2/return/{returnId}/mark_as_received
URI parameters
Parameter | Type | Required? | Meaning |
---|---|---|---|
returnId | string | Required | The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which an item is being marked as 'received'. |
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
The following lists all fields that could be included in the request.
{ /* MarkAsReceivedRequest */ "comments": { /* Text */ "content": string, "language": string, "translatedFromContent": string, "translatedFromLanguage": string } }
Request field descriptions
Input Container/Field | Type | Occurrence | Meaning |
---|---|---|---|
comments | Text | Optional | This optional container allows the user to add any related comments about marking the line item as received. |
comments.content | string | Conditional | This field displays the actual textual content in the language specified in the language field. This field is always used for containers using the Text type. |
comments.language | string | Conditional |
This two-letter code indicates the language used to display the content in the content field. The language will default to the language used on the eBay site if a specific language is not specified through the Accept-Language HTTP header. This field is always used for containers using the Text type.
Applicable values are from LanguageEnum:See language. |
comments.translatedFromContent | string | Conditional | If language translation/localization is required, this field displays the actual textual content in the language specified in the translatedFromLanguage field. If language translation was not required, this field is not applicable. |
comments .translatedFromLanguage |
string | Conditional |
If language translation/localization is required, this two-letter code indicates the language used to display the content in the translatedFromContent field. If language translation was not required, this field is not applicable.
Applicable values are from LanguageEnum:See translatedFromLanguage. |
Input Samples Change History |
Output
See also Samples.
Payload model
This call has no response payload.
nullInput 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.
A seller or buyer marks a return or replacement item as received.
Description
This operation confirms that the seller has received a returned item, or that the buyer has received a replacement item.
Input
The returnId parameter is required to identify the return request for which the item is being marked as received. This call has no request payload.
URL format. See also the non-wrapped version of this URL. POST https://api.ebay.com/post-order/v2/return/5********9/mark_as_received
Output
A successful call returns an HTTP code of 200
; there is no payload for the response.
JSON format.
Input Output Samples |
Change History
Change Date | Description |
---|