Orders: list

Requires authorization

Lists the orders in your Merchant Center account. Try it now.

A common use case for this call is to list the orders that have not yet been acknowledged.

Request

HTTP request

GET https://www.googleapis.com/content/v2/merchantId/orders

Parameters

Parameter name Value Description
Path parameters
merchantId unsigned long The ID of the account that manages the order. This cannot be a multi-client account.
Optional query parameters
acknowledged boolean Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged.

We recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned.

maxResults unsigned integer The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.

Known issue: All List calls will return all Orders without limit regardless of the value of this field.

orderBy string The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. "placedDate desc" stands for listing orders by placement date, from oldest to most recent. "placedDate asc" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria.

Acceptable values are:
  • "placedDate asc"
  • "placedDate desc"
pageToken string The token returned by the previous request.
placedDateEnd string Obtains orders placed before this date (exclusively), in ISO 8601 format.
placedDateStart string Obtains orders placed after this date (inclusively), in ISO 8601 format.
statuses string Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled.

Acceptable values are:
  • "active"
  • "canceled"
  • "completed"
  • "delivered"
  • "inProgress"
  • "partiallyDelivered"
  • "partiallyReturned"
  • "partiallyShipped"
  • "pendingShipment"
  • "returned"
  • "shipped"

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/content

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "content#ordersListResponse",
  "nextPageToken": string,
  "resources": [
    orders Resource
  ]
}
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "content#ordersListResponse".
nextPageToken string The token for the retrieval of the next page of orders.
resources[] list

Try it!

Use the APIs Explorer below to call this method on the Sandbox environment and see the response.
Alternatively, test this on live data.

Send feedback about...

Content API for Shopping