- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- OrderreturnsCreateOrderReturnRequest
- OrderreturnsLineItem
- Try it!
Create return in your Merchant Center account.
HTTP request
POST https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/orderreturns/createOrderReturn
Path parameters
Parameters | |
---|---|
merchantId |
The ID of the account that manages the order. This cannot be a multi-client account. |
Request body
The request body contains an instance of OrderreturnsCreateOrderReturnRequest
.
Response body
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"executionStatus": string,
"orderReturn": {
object ( |
Fields | |
---|---|
executionStatus |
The status of the execution. Acceptable values are:
|
orderReturn |
Created order return. |
kind |
Identifies what kind of resource this is. Value: the fixed string " |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/content
For more information, see the OAuth 2.0 Overview.
OrderreturnsCreateOrderReturnRequest
JSON representation |
---|
{
"orderId": string,
"operationId": string,
"lineItems": [
{
object ( |
Fields | |
---|---|
orderId |
The ID of the order. |
operationId |
The ID of the operation. Unique across all operations for a given order. |
lineItems[] |
The list of line items to return. |
returnMethodType |
The way of the package being returned. |
OrderreturnsLineItem
JSON representation |
---|
{ "lineItemId": string, "productId": string, "quantity": integer } |
Fields | |
---|---|
lineItemId |
The ID of the line item. This value is assigned by Google when an order is created. Either lineItemId or productId is required. |
productId |
The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required. |
quantity |
The quantity of this line item. |