Content API for Shopping API

by googleapis.com

Overview

Manage your product listings and accounts for Google Shopping

Content API for Shopping is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 178 endpoints.

At a glance

Authentication: OAuth
HTTPS: Yes
CORS: Unknown
Category: Analytics
Base URL: https://shoppingcontent.googleapis.com/content/v2.1
Version: v2.1
Endpoints: 178
OpenAPI: Specification ↗
Spec updated: 2023-04-04

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://shoppingcontent.googleapis.com/content/v2.1/accounts/authinfo" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript

const response = await fetch("https://shoppingcontent.googleapis.com/content/v2.1/accounts/authinfo", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://shoppingcontent.googleapis.com/content/v2.1/accounts/authinfo",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/accounts/authinfo`	Returns information about the authenticated user.
POST	`/accounts/batch`	Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.
POST	`/accounts/{accountId}/credentials`	Uploads credentials for the Merchant Center account. If credentials already exist for this Merchant Center account and purpose, this method updates them.
GET	`/accounts/{accountId}/labels`	Lists the labels assigned to an account.
POST	`/accounts/{accountId}/labels`	Creates a new label, not assigned to any account.
PATCH	`/accounts/{accountId}/labels/{labelId}`	Updates a label.
DELETE	`/accounts/{accountId}/labels/{labelId}`	Deletes a label and removes it from all accounts to which it was assigned.
GET	`/accounts/{accountId}/returncarrier`	Lists available return carriers in the merchant account.
POST	`/accounts/{accountId}/returncarrier`	Links return carrier to a merchant account.
PATCH	`/accounts/{accountId}/returncarrier/{carrierAccountId}`	Updates a return carrier in the merchant account.
DELETE	`/accounts/{accountId}/returncarrier/{carrierAccountId}`	Delete a return carrier in the merchant account.
POST	`/accountstatuses/batch`	Retrieves multiple Merchant Center account statuses in a single request.
POST	`/accounttax/batch`	Retrieves and updates tax settings of multiple accounts in a single request.
POST	`/datafeeds/batch`	Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.
POST	`/datafeedstatuses/batch`	Gets multiple Merchant Center datafeed statuses in a single request.
POST	`/liasettings/batch`	Retrieves and/or updates the LIA settings of multiple accounts in a single request.
GET	`/liasettings/posdataproviders`	Retrieves the list of POS data providers that have active settings for the all eiligible countries.
POST	`/localinventory/batch`	Updates local inventory for multiple products or stores in a single request.
POST	`/pos/batch`	Batches multiple POS-related calls in a single request.
POST	`/products/batch`	Retrieves, inserts, and deletes multiple products in a single request.
POST	`/productstatuses/batch`	Gets the statuses of multiple products in a single request.
POST	`/regionalinventory/batch`	Updates regional inventory for multiple products or regions in a single request.
POST	`/returnaddress/batch`	Batches multiple return address related calls in a single request.
POST	`/returnpolicy/batch`	Batches multiple return policy related calls in a single request.
POST	`/shippingsettings/batch`	Retrieves and updates the shipping settings of multiple accounts in a single request.
GET	`/{cssGroupId}/csses`	Lists CSS domains affiliated with a CSS group.
GET	`/{cssGroupId}/csses/{cssDomainId}`	Retrieves a single CSS domain by ID.
POST	`/{cssGroupId}/csses/{cssDomainId}/updatelabels`	Updates labels that are assigned to a CSS domain by its CSS group.
GET	`/{merchantId}/accounts`	Lists the sub-accounts in your Merchant Center account.
POST	`/{merchantId}/accounts`	Creates a Merchant Center sub-account.
GET	`/{merchantId}/accounts/{accountId}`	Retrieves a Merchant Center account.
PUT	`/{merchantId}/accounts/{accountId}`	Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.
DELETE	`/{merchantId}/accounts/{accountId}`	Deletes a Merchant Center sub-account.
POST	`/{merchantId}/accounts/{accountId}/claimwebsite`	Claims the website of a Merchant Center sub-account. Merchant accounts with approved third-party CSSs aren't required to claim a website.
POST	`/{merchantId}/accounts/{accountId}/link`	Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.
GET	`/{merchantId}/accounts/{accountId}/listlinks`	Returns the list of accounts linked to your Merchant Center account.
POST	`/{merchantId}/accounts/{accountId}/requestphoneverification`	Request verification code to start phone verification.
POST	`/{merchantId}/accounts/{accountId}/updatelabels`	Updates labels that are assigned to the Merchant Center account by CSS user.
POST	`/{merchantId}/accounts/{accountId}/verifyphonenumber`	Validates verification code to verify phone number for the account. If successful this will overwrite the value of `accounts.businessinformation.phoneNumber`. O
GET	`/{merchantId}/accountstatuses`	Lists the statuses of the sub-accounts in your Merchant Center account.
GET	`/{merchantId}/accountstatuses/{accountId}`	Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.
GET	`/{merchantId}/accounttax`	Lists the tax settings of the sub-accounts in your Merchant Center account.
GET	`/{merchantId}/accounttax/{accountId}`	Retrieves the tax settings of the account.
PUT	`/{merchantId}/accounttax/{accountId}`	Updates the tax settings of the account. Any fields that are not provided are deleted from the resource.
GET	`/{merchantId}/buyongoogleprograms/{regionCode}`	Retrieves a status of the BoG program for your Merchant Center account.
PATCH	`/{merchantId}/buyongoogleprograms/{regionCode}`	Updates the status of the BoG program for your Merchant Center account.
POST	`/{merchantId}/buyongoogleprograms/{regionCode}/activate`	Reactivates the BoG program in your Merchant Center account. Moves the program to the active state when allowed, for example, when paused. This method is only a
POST	`/{merchantId}/buyongoogleprograms/{regionCode}/onboard`	Onboards the BoG program in your Merchant Center account. By using this method, you agree to the [Terms of Service](https://merchants.google.com/mc/termsofservi
POST	`/{merchantId}/buyongoogleprograms/{regionCode}/pause`	Pauses the BoG program in your Merchant Center account. This method is only available to selected merchants.
POST	`/{merchantId}/buyongoogleprograms/{regionCode}/requestreview`	Requests review and then activates the BoG program in your Merchant Center account for the first time. Moves the program to the REVIEW_PENDING state. This metho
GET	`/{merchantId}/collections`	Lists the collections in your Merchant Center account. The response might contain fewer items than specified by page_size. Rely on next_page_token to determine
POST	`/{merchantId}/collections`	Uploads a collection to your Merchant Center account. If a collection with the same collectionId already exists, this method updates that entry. In each update,
GET	`/{merchantId}/collections/{collectionId}`	Retrieves a collection from your Merchant Center account.
DELETE	`/{merchantId}/collections/{collectionId}`	Deletes a collection from your Merchant Center account.
GET	`/{merchantId}/collectionstatuses`	Lists the statuses of the collections in your Merchant Center account.
GET	`/{merchantId}/collectionstatuses/{collectionId}`	Gets the status of a collection from your Merchant Center account.
GET	`/{merchantId}/conversionsources`	Retrieves the list of conversion sources the caller has access to.
POST	`/{merchantId}/conversionsources`	Creates a new conversion source.
GET	`/{merchantId}/conversionsources/{conversionSourceId}`	Fetches a conversion source.
PATCH	`/{merchantId}/conversionsources/{conversionSourceId}`	Updates information of an existing conversion source.
DELETE	`/{merchantId}/conversionsources/{conversionSourceId}`	Archives an existing conversion source. It will be recoverable for 30 days. This archiving behavior is not typical in the Content API and unique to this service
POST	`/{merchantId}/conversionsources/{conversionSourceId}:undelete`	Re-enables an archived conversion source.
GET	`/{merchantId}/datafeeds`	Lists the configurations for datafeeds in your Merchant Center account.
POST	`/{merchantId}/datafeeds`	Registers a datafeed configuration with your Merchant Center account.
GET	`/{merchantId}/datafeeds/{datafeedId}`	Retrieves a datafeed configuration from your Merchant Center account.
PUT	`/{merchantId}/datafeeds/{datafeedId}`	Updates a datafeed configuration of your Merchant Center account. Any fields that are not provided are deleted from the resource.
DELETE	`/{merchantId}/datafeeds/{datafeedId}`	Deletes a datafeed configuration from your Merchant Center account.
POST	`/{merchantId}/datafeeds/{datafeedId}/fetchNow`	Invokes a fetch for the datafeed in your Merchant Center account. If you need to call this method more than once per day, we recommend you use the [Products ser
GET	`/{merchantId}/datafeedstatuses`	Lists the statuses of the datafeeds in your Merchant Center account.
GET	`/{merchantId}/datafeedstatuses/{datafeedId}`	Retrieves the status of a datafeed from your Merchant Center account.
GET	`/{merchantId}/freelistingsprogram`	Retrieves the status and review eligibility for the free listing program. Returns errors and warnings if they require action to resolve, will become disapproval
POST	`/{merchantId}/freelistingsprogram/requestreview`	Requests a review of free listings in a specific region. This method is only available to selected merchants.
GET	`/{merchantId}/liasettings`	Lists the LIA settings of the sub-accounts in your Merchant Center account.
GET	`/{merchantId}/liasettings/{accountId}`	Retrieves the LIA settings of the account.
PUT	`/{merchantId}/liasettings/{accountId}`	Updates the LIA settings of the account. Any fields that are not provided are deleted from the resource.
GET	`/{merchantId}/liasettings/{accountId}/accessiblegmbaccounts`	Retrieves the list of accessible Business Profiles.
POST	`/{merchantId}/liasettings/{accountId}/requestgmbaccess`	Requests access to a specified Business Profile.
POST	`/{merchantId}/liasettings/{accountId}/requestinventoryverification/{country}`	Requests inventory validation for the specified country.
POST	`/{merchantId}/liasettings/{accountId}/setinventoryverificationcontact`	Sets the inventory verification contract for the specified country.
POST	`/{merchantId}/liasettings/{accountId}/setposdataprovider`	Sets the POS data provider for the specified country.
POST	`/{merchantId}/orderinvoices/{orderId}/createChargeInvoice`	Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.
POST	`/{merchantId}/orderinvoices/{orderId}/createRefundInvoice`	Creates a refund invoice for one or more shipment groups, and triggers a refund for orderinvoice enabled orders. This can only be used for line items that have
GET	`/{merchantId}/orderreports/disbursements`	Retrieves a report for disbursements from your Merchant Center account.
GET	`/{merchantId}/orderreports/disbursements/{disbursementId}/transactions`	Retrieves a list of transactions for a disbursement from your Merchant Center account.
GET	`/{merchantId}/orderreturns`	Lists order returns in your Merchant Center account.
POST	`/{merchantId}/orderreturns/createOrderReturn`	Create return in your Merchant Center account.
GET	`/{merchantId}/orderreturns/{returnId}`	Retrieves an order return from your Merchant Center account.
POST	`/{merchantId}/orderreturns/{returnId}/acknowledge`	Acks an order return in your Merchant Center account.
POST	`/{merchantId}/orderreturns/{returnId}/labels`	Links a return shipping label to a return id. You can only create one return label per return id. Since the label is sent to the buyer, the linked return label
POST	`/{merchantId}/orderreturns/{returnId}/process`	Processes return in your Merchant Center account.
GET	`/{merchantId}/orders`	Lists the orders in your Merchant Center account.
GET	`/{merchantId}/orders/{orderId}`	Retrieves an order from your Merchant Center account.
POST	`/{merchantId}/orders/{orderId}/acknowledge`	Marks an order as acknowledged.
POST	`/{merchantId}/orders/{orderId}/cancel`	Cancels all line items in an order, making a full refund.
POST	`/{merchantId}/orders/{orderId}/cancelLineItem`	Cancels a line item, making a full refund.
POST	`/{merchantId}/orders/{orderId}/captureOrder`	Capture funds from the customer for the current order total. This method should be called after the merchant verifies that they are able and ready to start ship
POST	`/{merchantId}/orders/{orderId}/inStoreRefundLineItem`	Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (for example, cash refund done in store)
POST	`/{merchantId}/orders/{orderId}/refunditem`	Issues a partial or total refund for items and shipment.
POST	`/{merchantId}/orders/{orderId}/refundorder`	Issues a partial or total refund for an order.
POST	`/{merchantId}/orders/{orderId}/rejectReturnLineItem`	Rejects return on an line item.

Showing the first 100 of 178 endpoints; the full list is in the documentation.

Questions

Does the Content API for Shopping API need an API key?

Yes. The Content API for Shopping API uses OAuth authentication; the documentation explains how to get credentials.

Does the Content API for Shopping API support HTTPS?

Yes, the Content API for Shopping API is served over HTTPS.

How many endpoints does the Content API for Shopping API have?

Its OpenAPI description lists 178 endpoints in version v2.1. The first 100 are shown on this page.

What are alternatives to the Content API for Shopping API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).

Overview

At a glance

Make a first request

Endpoints

Questions

Similar analytics APIs

Google Play Integrity API

versionhistory.googleapis.com API

Doc Converter

Perspective Comment Analyzer API

Safe Browsing API

Web Fonts Developer API