eBay Post-Order APIVersion 2

Get Return Draft

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

This call retrieves the details associated with a specific return draft.

Input

See also Samples.

Resource URI (production)

GET https://api.ebay.com/post-order/v2/return/draft/{draftId}

URI parameters

Parameter Type Required? Meaning
draftId string Required The unique identifier of the return draft. This identifier is included as part of the call URI and identifies the return draft to retrieve.


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 GetReturnCreationSessionResponse 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

{ /* GetReturnCreationSessionResponse */
"returnRequest":
    { /* ReturnRequestType */
    "carrier": token,
    "comments":
        { /* Text */
        "content": string,
        "language": string,
        "translatedFromContent": string,
        "translatedFromLanguage": string
        },
    "itemId": string,
    "reason": string,
    "requestType": token,
    "returnQuantity": integer,
    "transactionId": string,
    "type": string
    }
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
returnRequest ReturnRequestType Always This container provide details about the buyer's return draft, including the order line item (and quantity) that is being returned, the reason for the return, and the buyer's preference to either get money back for item or to get a replacement item from the seller.
returnRequest.carrier token Conditionally This value indicates the shipping carrier that will be used to ship the return item. ShippingCarrierEnum contains some popular shipping carriers for the US, UK, Germany, Canada, and Australia, but it is not a complete list.

Applicable values: See ShippingCarrierEnum
returnRequest.comments Text Conditionally This optional container allows the buyer to provide more information to the seller about why the item is being returned.
returnRequest.comments.content string Conditionally 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.
returnRequest.comments
  .language
string Conditionally 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.
Code so that your app gracefully handles any future changes to this list.
returnRequest.comments
  .translatedFromContent
string Conditionally 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.
returnRequest.comments
  .translatedFromLanguage
string Conditionally 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.
Code so that your app gracefully handles any future changes to this list.
returnRequest.itemId string Conditionally The unique identifier of a listing. The itemID and transactionId fields are required to identify the order line item for which a return (or return draft) is being requested by the buyer.
returnRequest.reason string Conditionally This enumerated value indicates the buyer's reason for creating a return request or draft.

Applicable values are from ReturnReasonEnum:See reason.
Code so that your app gracefully handles any future changes to this list.
returnRequest.requestType token Conditionally This enumeration value indicates if the return request is an actual return request or a return draft.

Applicable values: See RequestTypeEnum
returnRequest.returnQuantity integer Conditionally This integer value indicates the quantity of the line item being returned. This number is generally '1', unless the buyer bought multiple quantity of the item in a multiple-quantity, fixed-price listing. This value defaults to '1' if this field is omitted when a return is created.
returnRequest.transactionId string Conditionally The unique identifier of a transaction. The itemID and transactionId fields are required to identify the order line item for which a return (or return draft) is being requested by the buyer.
returnRequest.type string Conditionally This enumeration value indicates the buyer's desired outcome - money back for the order or a replacement item (in the case of a SNAD item). MONEY_BACK is the default value.

Applicable values are from ReturnTypeEnum:

CANCEL
This enumerated value is passed into the type field of the request when the buyer wants to cancel a return request (or draft).
MONEY_BACK
This enumerated value is passed into the type field of the request when the buyer is creating a return request (or draft), and wants a full refund after returning the item.
REPLACEMENT
This enumerated value is passed into the type field of the request when the buyer is creating a return request (or draft), but wants a replacement item instead of a refund.
UNKNOWN
This is the default value if the return type is unknown.

Code so that your app gracefully handles any future changes to this list.
null



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.

Sample: Basic Call

Retrieve a return draft.

Description

A buyer wants to retrieve the basic details of a specific return draft, including the order line item associated with the return draft and the reason given for wanting to return the item.

Input

The draftId value is passed in to the call as a path parameter. There is no request payload.

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

GET https://api.ebay.com/post-order/v2/return/draft/500877800

Output

Use the itemId and transactionId fields identify the order line item in the return draft. According to the reason value, the buyer is returning the item because he/she no longer needs the item, and the buyer is looking for a refund, as opposed to a replacement item.

JSON format.
{
"returnRequest":
    {
    "itemId": "330005959274",
    "transactionId": "8905715014",
    "returnQuantity": "1",
    "reason": "NO_LONGER_NEED_ITEM",
    "type": "MONEY_BACK",
    "carrier": "USPS",
    "comments":
        {
        "content": "I accidentally purchased the same product twice"
        }
    }
}



Change History

Change Date Description
1.0
2015-06-30
  • Call (added): New call.