Orders: list

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

Request

HTTP request

GET https://www.googleapis.com/content/v2.1/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.
orderBy string Order results by placement date in descending or ascending order.

Acceptable values are:
  • placedDateAsc
  • placedDateDesc
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. 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:

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

Enviar comentarios sobre…

Content API for Shopping