If you're still using v2 of the Content API for Shopping, please migrate to v2.1 immediately to avoid disruptions with your integration.

For more information, see Migrating to v2.1 and this blog post.

Method: orders.getbymerchantorderid

Retrieves an order using merchant order ID.

HTTP request

GET https://shoppingcontent.googleapis.com/content/v2/{merchantId}/ordersbymerchantid/{merchantOrderId}

Path parameters

Parameters
merchantId

string

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

merchantOrderId

string

The merchant order ID to be looked for.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "order": {
    object (Order)
  },
  "kind": string
}
Fields
order

object (Order)

The requested order.

kind

string

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

"content#ordersGetByMerchantOrderIdResponse"

.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the OAuth 2.0 Overview.