Orders: list

Retrieves a list of orders, possibly filtered. This method supports paging. Try it now.


HTTP request

GET https://www.googleapis.com/dfareporting/v3.4/userprofiles/profileId/projects/projectId/orders


Parameter name Value Description
Path parameters
profileId long User profile ID associated with this request.
projectId long Project ID for orders.
Optional query parameters
ids long Select only orders with these IDs.
maxResults integer Maximum number of results to return. Acceptable values are 0 to 1000, inclusive. (Default: 1000)
pageToken string Value of the nextPageToken from the previous result page.
searchString string Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order".
siteId long Select only orders that are associated with these site IDs.
sortField string Field by which to sort the list.

Acceptable values are:
  • "ID" (default)
  • "NAME"
sortOrder string Order of sorted results.

Acceptable values are:
  • "ASCENDING" (default)


This request requires authorization with the following scope:


For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.


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

  "kind": "dfareporting#ordersListResponse",
  "nextPageToken": string,
  "orders": [
    orders Resource
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse".
nextPageToken string Pagination token to be used for the next list operation.
orders[] list Order collection.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.