Method: orders.list

Lists the orders in your Merchant Center account.

HTTP request

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

Path parameters

Parameters
merchantId

string

The ID of the account that manages the order. This cannot be a multi-client account.

Query parameters

Parameters
maxResults

integer (uint32 format)

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.

pageToken

string

The token returned by the previous request.

statuses

enum (Statuses)

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

.

placedDateStart

string

Obtains orders placed after this date (inclusively), in ISO 8601 format.

placedDateEnd

string

Obtains orders placed before this date (exclusively), in ISO 8601 format.

orderBy

string

Order results by placement date in descending or ascending order.

Acceptable values are:

  • placedDateAsc
  • placedDateDesc

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.

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 (Order)
    }
  ]
}
Fields
nextPageToken

string

The token for the retrieval of the next page of orders.

kind

string

Identifies what kind of resource this is. Value: the fixed string

"content#ordersListResponse"

.

resources[]

object (Order)

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/content
  • https://www.googleapis.com/auth/structuredcontent

For more information, see the OAuth 2.0 Overview.

Statuses

Enums
ACTIVE
COMPLETED
CANCELED
IN_PROGRESS
PENDING_SHIPMENT
PARTIALLY_SHIPPED
SHIPPED
PARTIALLY_DELIVERED
DELIVERED
PARTIALLY_RETURNED
RETURNED