API Reference

This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.

Resource types

  1. Accounts
  2. Accountstatuses
  3. Accounttax
  4. Datafeeds
  5. Datafeedstatuses
  6. Inventory
  7. Orders
  8. Products
  9. Productstatuses
  10. Shippingsettings

Accounts

For Accounts Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/content/v2, unless otherwise noted
authinfo GET  /accounts/authinfo Returns information about the authenticated user.
claimwebsite POST  /merchantId/accounts/accountId/claimwebsite Claims the website of a Merchant Center sub-account. This method can only be called for multi-client accounts.
custombatch POST  /accounts/batch Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.
delete DELETE  /merchantId/accounts/accountId Deletes a Merchant Center sub-account. This method can only be called for multi-client accounts.
get GET  /merchantId/accounts/accountId Retrieves a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.
insert POST  /merchantId/accounts Creates a Merchant Center sub-account. This method can only be called for multi-client accounts.
list GET  /merchantId/accounts Lists the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.
patch PATCH  /merchantId/accounts/accountId Updates a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account. This method supports patch semantics.
update PUT  /merchantId/accounts/accountId Updates a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.

Accountstatuses

For Accountstatuses Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/content/v2, unless otherwise noted
custombatch POST  /accountstatuses/batch
get GET  /merchantId/accountstatuses/accountId Retrieves the status of a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.
list GET  /merchantId/accountstatuses Lists the statuses of the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.

Accounttax

For Accounttax Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/content/v2, unless otherwise noted
custombatch POST  /accounttax/batch Retrieves and updates tax settings of multiple accounts in a single request.
get GET  /merchantId/accounttax/accountId Retrieves the tax settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.
list GET  /merchantId/accounttax Lists the tax settings of the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.
patch PATCH  /merchantId/accounttax/accountId Updates the tax settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account. This method supports patch semantics.
update PUT  /merchantId/accounttax/accountId Updates the tax settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.

Datafeeds

For Datafeeds Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/content/v2, unless otherwise noted
custombatch POST  /datafeeds/batch
delete DELETE  /merchantId/datafeeds/datafeedId Deletes a datafeed configuration from your Merchant Center account. This method can only be called for non-multi-client accounts.
get GET  /merchantId/datafeeds/datafeedId Retrieves a datafeed configuration from your Merchant Center account. This method can only be called for non-multi-client accounts.
insert POST  /merchantId/datafeeds Registers a datafeed configuration with your Merchant Center account. This method can only be called for non-multi-client accounts.
list GET  /merchantId/datafeeds Lists the datafeeds in your Merchant Center account. This method can only be called for non-multi-client accounts.
patch PATCH  /merchantId/datafeeds/datafeedId Updates a datafeed configuration of your Merchant Center account. This method can only be called for non-multi-client accounts. This method supports patch semantics.
update PUT  /merchantId/datafeeds/datafeedId Updates a datafeed configuration of your Merchant Center account. This method can only be called for non-multi-client accounts.

Datafeedstatuses

For Datafeedstatuses Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/content/v2, unless otherwise noted
custombatch POST  /datafeedstatuses/batch
get GET  /merchantId/datafeedstatuses/datafeedId Retrieves the status of a datafeed from your Merchant Center account. This method can only be called for non-multi-client accounts.
list GET  /merchantId/datafeedstatuses Lists the statuses of the datafeeds in your Merchant Center account. This method can only be called for non-multi-client accounts.

Inventory

For Inventory Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/content/v2, unless otherwise noted
custombatch POST  /inventory/batch Updates price and availability for multiple products or stores in a single request. This operation does not update the expiration date of the products. This method can only be called for non-multi-client accounts.
set POST  /merchantId/inventory/storeCode/products/productId Updates price and availability of a product in your Merchant Center account. This operation does not update the expiration date of the product. This method can only be called for non-multi-client accounts.

Orders

For Orders Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/content/v2, unless otherwise noted
acknowledge POST  /merchantId/orders/orderId/acknowledge Marks an order as acknowledged. This method can only be called for non-multi-client accounts.
advancetestorder POST  /merchantId/testorders/orderId/advance Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment". This method can only be called for non-multi-client accounts.
cancel POST  /merchantId/orders/orderId/cancel Cancels all line items in an order, making a full refund. This method can only be called for non-multi-client accounts.
cancellineitem POST  /merchantId/orders/orderId/cancelLineItem Cancels a line item, making a full refund. This method can only be called for non-multi-client accounts.
createtestorder POST  /merchantId/testorders Sandbox only. Creates a test order. This method can only be called for non-multi-client accounts.
custombatch POST  /orders/batch Retrieves or modifies multiple orders in a single request. This method can only be called for non-multi-client accounts.
get GET  /merchantId/orders/orderId Retrieves an order from your Merchant Center account. This method can only be called for non-multi-client accounts.
getbymerchantorderid GET  /merchantId/ordersbymerchantid/merchantOrderId Retrieves an order using merchant order id. This method can only be called for non-multi-client accounts.
gettestordertemplate GET  /merchantId/testordertemplates/templateName Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox. This method can only be called for non-multi-client accounts.
list GET  /merchantId/orders Lists the orders in your Merchant Center account. This method can only be called for non-multi-client accounts.
refund POST  /merchantId/orders/orderId/refund Initiates a full or partial reversal on the payment instrument.
returnlineitem POST  /merchantId/orders/orderId/returnLineItem Returns a line item. This method can only be called for non-multi-client accounts.
shiplineitems POST  /merchantId/orders/orderId/shipLineItems Marks line item(s) as shipped. This method can only be called for non-multi-client accounts.
updatemerchantorderid POST  /merchantId/orders/orderId/updateMerchantOrderId Updates the merchant order ID for a given order. This method can only be called for non-multi-client accounts.
updateshipment POST  /merchantId/orders/orderId/updateShipment Updates a shipment's status, carrier, and/or tracking ID. This method can only be called for non-multi-client accounts.

Products

For Products Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/content/v2, unless otherwise noted
custombatch POST  /products/batch Retrieves, inserts, and deletes multiple products in a single request. This method can only be called for non-multi-client accounts.
delete DELETE  /merchantId/products/productId Deletes a product from your Merchant Center account. This method can only be called for non-multi-client accounts.
get GET  /merchantId/products/productId Retrieves a product from your Merchant Center account. This method can only be called for non-multi-client accounts.
insert POST  /merchantId/products Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry. This method can only be called for non-multi-client accounts.
list GET  /merchantId/products Lists the products in your Merchant Center account. This method can only be called for non-multi-client accounts.

Productstatuses

For Productstatuses Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/content/v2, unless otherwise noted
custombatch POST  /productstatuses/batch Gets the statuses of multiple products in a single request. This method can only be called for non-multi-client accounts.
get GET  /merchantId/productstatuses/productId Gets the status of a product from your Merchant Center account. This method can only be called for non-multi-client accounts.
list GET  /merchantId/productstatuses Lists the statuses of the products in your Merchant Center account. This method can only be called for non-multi-client accounts.

Shippingsettings

For Shippingsettings Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/content/v2, unless otherwise noted
custombatch POST  /shippingsettings/batch Retrieves and updates the shipping settings of multiple accounts in a single request.
get GET  /merchantId/shippingsettings/accountId Retrieves the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.
getsupportedcarriers GET  /merchantId/supportedCarriers Retrieves supported carriers and carrier services for an account.
list GET  /merchantId/shippingsettings Lists the shipping settings of the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.
patch PATCH  /merchantId/shippingsettings/accountId Updates the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account. This method supports patch semantics.
update PUT  /merchantId/shippingsettings/accountId Updates the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.

Send feedback about...

Content API for Shopping