Create Return Draft

POST /post-order/v2/return/draft

This method is used to create a return request draft. This method is very similar to the POST /post-order/v2/return method except a live return request is not actually created. The PUT /post-order/v2/return/draft/{draftId} method is used to update a return request draft, and the POST /post-order/v2/return method is used to convert the draft into an actual return request, with the added requirement of passing in the draftId value in the request payload of that method.

Input

See also Samples.

Resource URI (production)

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

This call has no path or query 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

The following lists all fields that could be included in the request.

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

Request field descriptions

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

{ /* SetReturnCreationSessionResponse */
"draftId": integer
}

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.

This operation creates a return draft.

Description

This buyer-facing call creates a return draft. Return drafts are converted to return requests using the POST /post-order/v2/return call.

Input

Use the itemId and transactionId fields to specify the order line item to be returned. Specify a reason as well as the action (the returnRequest.type) to inform the seller of the details of the return.

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

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

{ 
"returnRequest":
    { 
    "itemId": "3**********4",
    "transactionId": "8********4",
    "returnQuantity": "1",
    "reason": "NO_LONGER_NEED_ITEM",
    "type": "MONEY_BACK",
    "carrier": "USPS",
    "comments":
        { 
        "content": "I accidentally purchased the same product twice"
        }
    }
}

Output

The call returns a draftId that you use to reference the return draft in other calls.

JSON format.
{
  "draftId": "5*******0"
}

Change History