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.

Content API for Shopping

Manage your product listings and accounts for Google Shopping

Service: shoppingcontent.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://shoppingcontent.googleapis.com

v2.accounts

Methods
authinfo GET /content/v2/accounts/authinfo
Returns information about the authenticated user.
claimwebsite POST /content/v2/{merchantId}/accounts/{accountId}/claimwebsite
Claims the website of a Merchant Center sub-account.
custombatch POST /content/v2/accounts/batch
Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.
delete DELETE /content/v2/{merchantId}/accounts/{accountId}
Deletes a Merchant Center sub-account.
get GET /content/v2/{merchantId}/accounts/{accountId}
Retrieves a Merchant Center account.
insert POST /content/v2/{merchantId}/accounts
Creates a Merchant Center sub-account.
link POST /content/v2/{merchantId}/accounts/{accountId}/link

Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.
list GET /content/v2/{merchantId}/accounts
Lists the sub-accounts in your Merchant Center account.
update PUT /content/v2/{merchantId}/accounts/{accountId}
Updates a Merchant Center account.

v2.accountstatuses

Methods
custombatch POST /content/v2/accountstatuses/batch
Retrieves multiple Merchant Center account statuses in a single request.
get GET /content/v2/{merchantId}/accountstatuses/{accountId}
Retrieves the status of a Merchant Center account.
list GET /content/v2/{merchantId}/accountstatuses
Lists the statuses of the sub-accounts in your Merchant Center account.

v2.accounttax

Methods
custombatch POST /content/v2/accounttax/batch
Retrieves and updates tax settings of multiple accounts in a single request.
get GET /content/v2/{merchantId}/accounttax/{accountId}
Retrieves the tax settings of the account.
list GET /content/v2/{merchantId}/accounttax
Lists the tax settings of the sub-accounts in your Merchant Center account.
update PUT /content/v2/{merchantId}/accounttax/{accountId}
Updates the tax settings of the account.

v2.datafeeds

Methods
custombatch POST /content/v2/datafeeds/batch
Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.
delete DELETE /content/v2/{merchantId}/datafeeds/{datafeedId}
Deletes a datafeed configuration from your Merchant Center account.
fetchnow POST /content/v2/{merchantId}/datafeeds/{datafeedId}/fetchNow
Invokes a fetch for the datafeed in your Merchant Center account.
get GET /content/v2/{merchantId}/datafeeds/{datafeedId}
Retrieves a datafeed configuration from your Merchant Center account.
insert POST /content/v2/{merchantId}/datafeeds
Registers a datafeed configuration with your Merchant Center account.
list GET /content/v2/{merchantId}/datafeeds
Lists the configurations for datafeeds in your Merchant Center account.
update PUT /content/v2/{merchantId}/datafeeds/{datafeedId}
Updates a datafeed configuration of your Merchant Center account.

v2.datafeedstatuses

Methods
custombatch POST /content/v2/datafeedstatuses/batch
Gets multiple Merchant Center datafeed statuses in a single request.
get GET /content/v2/{merchantId}/datafeedstatuses/{datafeedId}
Retrieves the status of a datafeed from your Merchant Center account.
list GET /content/v2/{merchantId}/datafeedstatuses
Lists the statuses of the datafeeds in your Merchant Center account.

v2.inventory

Methods
custombatch POST /content/v2/inventory/batch
Updates price and availability for multiple products or stores in a single request.
set POST /content/v2/{merchantId}/inventory/{storeCode}/products/{productId}
Updates price and availability of a product in your Merchant Center account.

v2.liasettings

Methods
custombatch POST /content/v2/liasettings/batch
Retrieves and/or updates the LIA settings of multiple accounts in a single request.
get GET /content/v2/{merchantId}/liasettings/{accountId}
Retrieves the LIA settings of the account.
getaccessiblegmbaccounts GET /content/v2/{merchantId}/liasettings/{accountId}/accessiblegmbaccounts
Retrieves the list of accessible Google My Business accounts.
list GET /content/v2/{merchantId}/liasettings
Lists the LIA settings of the sub-accounts in your Merchant Center account.
listposdataproviders GET /content/v2/liasettings/posdataproviders
Retrieves the list of POS data providers that have active settings for the all eiligible countries.
requestgmbaccess POST /content/v2/{merchantId}/liasettings/{accountId}/requestgmbaccess
Requests access to a specified Google My Business account.
requestinventoryverification POST /content/v2/{merchantId}/liasettings/{accountId}/requestinventoryverification/{country}
Requests inventory validation for the specified country.
setinventoryverificationcontact POST /content/v2/{merchantId}/liasettings/{accountId}/setinventoryverificationcontact
Sets the inventory verification contract for the specified country.
setposdataprovider POST /content/v2/{merchantId}/liasettings/{accountId}/setposdataprovider
Sets the POS data provider for the specified country.
update PUT /content/v2/{merchantId}/liasettings/{accountId}
Updates the LIA settings of the account.

v2.orderinvoices

Methods
createchargeinvoice POST /content/v2/{merchantId}/orderinvoices/{orderId}/createChargeInvoice
Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.
createrefundinvoice POST /content/v2/{merchantId}/orderinvoices/{orderId}/createRefundInvoice
Creates a refund invoice for one or more shipment groups, and triggers a refund for orderinvoice enabled orders.

v2.orderreports

Methods
listdisbursements GET /content/v2/{merchantId}/orderreports/disbursements
Retrieves a report for disbursements from your Merchant Center account.
listtransactions GET /content/v2/{merchantId}/orderreports/disbursements/{disbursementId}/transactions
Retrieves a list of transactions for a disbursement from your Merchant Center account.

v2.orderreturns

Methods
get GET /content/v2/{merchantId}/orderreturns/{returnId}
Retrieves an order return from your Merchant Center account.
list GET /content/v2/{merchantId}/orderreturns
Lists order returns in your Merchant Center account.

v2.orders

Methods
acknowledge POST /content/v2/{merchantId}/orders/{orderId}/acknowledge
Marks an order as acknowledged.
advancetestorder POST /content/v2/{merchantId}/testorders/{orderId}/advance
Sandbox only.
cancel POST /content/v2/{merchantId}/orders/{orderId}/cancel
Cancels all line items in an order, making a full refund.
cancellineitem POST /content/v2/{merchantId}/orders/{orderId}/cancelLineItem
Cancels a line item, making a full refund.
canceltestorderbycustomer POST /content/v2/{merchantId}/testorders/{orderId}/cancelByCustomer
Sandbox only.
createtestorder POST /content/v2/{merchantId}/testorders
Sandbox only.
createtestreturn POST /content/v2/{merchantId}/orders/{orderId}/testreturn
Sandbox only.
custombatch POST /content/v2/orders/batch
Retrieves or modifies multiple orders in a single request.
get GET /content/v2/{merchantId}/orders/{orderId}
Retrieves an order from your Merchant Center account.
getbymerchantorderid GET /content/v2/{merchantId}/ordersbymerchantid/{merchantOrderId}
Retrieves an order using merchant order ID.
gettestordertemplate GET /content/v2/{merchantId}/testordertemplates/{templateName}
Sandbox only.
instorerefundlineitem POST /content/v2/{merchantId}/orders/{orderId}/inStoreRefundLineItem
Deprecated.
list GET /content/v2/{merchantId}/orders
Lists the orders in your Merchant Center account.
refund POST /content/v2/{merchantId}/orders/{orderId}/refund
Deprecated, please use returnRefundLineItem instead.
rejectreturnlineitem POST /content/v2/{merchantId}/orders/{orderId}/rejectReturnLineItem
Rejects return on an line item.
returnlineitem POST /content/v2/{merchantId}/orders/{orderId}/returnLineItem
Returns a line item.
returnrefundlineitem POST /content/v2/{merchantId}/orders/{orderId}/returnRefundLineItem
Returns and refunds a line item.
setlineitemmetadata POST /content/v2/{merchantId}/orders/{orderId}/setLineItemMetadata
Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs.
shiplineitems POST /content/v2/{merchantId}/orders/{orderId}/shipLineItems
Marks line item(s) as shipped.
updatelineitemshippingdetails POST /content/v2/{merchantId}/orders/{orderId}/updateLineItemShippingDetails
Updates ship by and delivery by dates for a line item.
updatemerchantorderid POST /content/v2/{merchantId}/orders/{orderId}/updateMerchantOrderId
Updates the merchant order ID for a given order.
updateshipment POST /content/v2/{merchantId}/orders/{orderId}/updateShipment
Updates a shipment's status, carrier, and/or tracking ID.

v2.pos

Methods
custombatch POST /content/v2/pos/batch
Batches multiple POS-related calls in a single request.
delete DELETE /content/v2/{merchantId}/pos/{targetMerchantId}/store/{storeCode}
Deletes a store for the given merchant.
get GET /content/v2/{merchantId}/pos/{targetMerchantId}/store/{storeCode}
Retrieves information about the given store.
insert POST /content/v2/{merchantId}/pos/{targetMerchantId}/store
Creates a store for the given merchant.
inventory POST /content/v2/{merchantId}/pos/{targetMerchantId}/inventory
Submit inventory for the given merchant.
list GET /content/v2/{merchantId}/pos/{targetMerchantId}/store
Lists the stores of the target merchant.
sale POST /content/v2/{merchantId}/pos/{targetMerchantId}/sale
Submit a sale event for the given merchant.

v2.products

Methods
custombatch POST /content/v2/products/batch
Retrieves, inserts, and deletes multiple products in a single request.
delete DELETE /content/v2/{merchantId}/products/{productId}
Deletes a product from your Merchant Center account.
get GET /content/v2/{merchantId}/products/{productId}
Retrieves a product from your Merchant Center account.
insert POST /content/v2/{merchantId}/products
Uploads a product to your Merchant Center account.
list GET /content/v2/{merchantId}/products
Lists the products in your Merchant Center account.

v2.productstatuses

Methods
custombatch POST /content/v2/productstatuses/batch
Gets the statuses of multiple products in a single request.
get GET /content/v2/{merchantId}/productstatuses/{productId}
Gets the status of a product from your Merchant Center account.
list GET /content/v2/{merchantId}/productstatuses
Lists the statuses of the products in your Merchant Center account.

v2.shippingsettings

Methods
custombatch POST /content/v2/shippingsettings/batch
Retrieves and updates the shipping settings of multiple accounts in a single request.
get GET /content/v2/{merchantId}/shippingsettings/{accountId}
Retrieves the shipping settings of the account.
getsupportedcarriers GET /content/v2/{merchantId}/supportedCarriers
Retrieves supported carriers and carrier services for an account.
getsupportedholidays GET /content/v2/{merchantId}/supportedHolidays
Retrieves supported holidays for an account.
getsupportedpickupservices GET /content/v2/{merchantId}/supportedPickupServices
Retrieves supported pickup services for an account.
list GET /content/v2/{merchantId}/shippingsettings
Lists the shipping settings of the sub-accounts in your Merchant Center account.
update PUT /content/v2/{merchantId}/shippingsettings/{accountId}
Updates the shipping settings of the account.