We will sunset v2 of the Content API on March 29th, 2021. To avoid disruptions with your integration, please migrate to v2.1 as soon as possible. For more information, see Migrating to v2.1.

Method: orders.updatemerchantorderid

Updates the merchant order ID for a given order.

HTTP request

POST https://shoppingcontent.googleapis.com/content/v2/{merchantId}/orders/{orderId}/updateMerchantOrderId

Path parameters

Parameters
merchantId

string

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

orderId

string

The ID of the order.

Request body

The request body contains an instance of OrdersUpdateMerchantOrderIdRequest.

Response body

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

JSON representation
{
  "executionStatus": string,
  "kind": string
}
Fields
executionStatus

string

The status of the execution.

Acceptable values are:

  • "duplicate"
  • "executed"

kind

string

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

"content#ordersUpdateMerchantOrderIdResponse"

.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the OAuth 2.0 Overview.

OrdersUpdateMerchantOrderIdRequest

JSON representation
{
  "operationId": string,
  "merchantOrderId": string
}
Fields
operationId

string

The ID of the operation. Unique across all operations for a given order.

merchantOrderId

string

The merchant order id to be assigned to the order. Must be unique per merchant.