- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- OrderBy
- Try it!
Lists order returns in your Merchant Center account.
HTTP request
GET https://shoppingcontent.googleapis.com/content/v2/{merchantId}/orderreturns
Path parameters
Parameters | |
---|---|
merchantId |
The ID of the account that manages the order. This cannot be a multi-client account. |
Query parameters
Parameters | |
---|---|
maxResults |
The maximum number of order returns to return in the response, used for paging. The default value is 25 returns per page, and the maximum allowed value is 250 returns per page. |
orderBy |
Return the results in the specified order. |
createdStartDate |
Obtains order returns created after this date (inclusively), in ISO 8601 format. |
createdEndDate |
Obtains order returns created before this date (inclusively), in ISO 8601 format. |
pageToken |
The token returned by the previous request. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{
"nextPageToken": string,
"kind": string,
"resources": [
{
object ( |
Fields | |
---|---|
nextPageToken |
The token for the retrieval of the next page of returns. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
resources[] |
|
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/content
For more information, see the OAuth 2.0 Overview.
OrderBy
Enums | |
---|---|
RETURN_CREATION_TIME_DESC |
|
RETURN_CREATION_TIME_ASC |