- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- OrderBy
- ShipmentTypes
- ShipmentStatus
- ShipmentStates
- Try it!
Lists order returns in your Merchant Center account.
HTTP request
GET https://shoppingcontent.googleapis.com/content/v2.1/{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. |
shipmentTypes[] |
Obtains order returns that match any shipment type provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment types. |
shipmentStatus[] |
Obtains order returns that match any shipment status provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment statuses. |
shipmentStates[] |
Obtains order returns that match any shipment state provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment states. |
acknowledged |
Obtains order returns that match the acknowledgement status. When set to true, obtains order returns that have been acknowledged. When false, obtains order returns that have not been acknowledged. When not provided, obtains order returns regardless of their acknowledgement status. We recommend using this filter set to |
googleOrderIds[] |
Obtains order returns with the specified order ids. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number. |
shipmentTrackingNumbers[] |
Obtains order returns with the specified tracking numbers. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number. |
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 results in descending order. |
RETURN_CREATION_TIME_ASC |
Return results in ascending order. |
ShipmentTypes
Enums | |
---|---|
BY_MAIL |
Return shipments with type byMail only. |
RETURNLESS |
Return shipments with type returnless only. |
CONTACT_CUSTOMER_SUPPORT |
Return shipments with type contactCustomerSupport only. |
ShipmentStatus
Enums | |
---|---|
NEW |
Return shipments with new status only. |
IN_PROGRESS |
Return shipments with inProgress status only. |
PROCESSED |
Return shipments with processed status only. |
ShipmentStates
Enums | |
---|---|
NEW |
Return shipments with new state only. |
SHIPPED |
Return shipments with shipped state only. |
COMPLETED |
Return shipments with completed state only. |
UNDELIVERABLE |
Return shipments with undeliverable state only. |
PENDING |
Return shipments with pending state only. |