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. Liasettings
  8. Orderinvoices
  9. Orderpayments
  10. Orderreports
  11. Orderreturns
  12. Orders
  13. Pos
  14. Products
  15. Productstatuses
  16. 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.
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.
get GET  /merchantId/accounts/accountId Retrieves a Merchant Center account.
insert POST  /merchantId/accounts Creates a Merchant Center sub-account.
link POST  /merchantId/accounts/accountId/link Performs an action on a link between a Merchant Center account and another account.
list GET  /merchantId/accounts Lists the sub-accounts in your Merchant Center account.
patch PATCH  /merchantId/accounts/accountId Updates a Merchant Center account. This method supports patch semantics.
update PUT  /merchantId/accounts/accountId Updates a Merchant Center 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. Multi-client accounts can only call this method for sub-accounts.
list GET  /merchantId/accountstatuses Lists the statuses of the sub-accounts in your Merchant Center account.

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.
list GET  /merchantId/accounttax Lists the tax settings of the sub-accounts in your Merchant Center account.
patch PATCH  /merchantId/accounttax/accountId Updates the tax settings of the account. This method supports patch semantics.
update PUT  /merchantId/accounttax/accountId Updates the tax settings of the 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.
fetchnow POST  /merchantId/datafeeds/datafeedId/fetchNow Invokes a fetch for the datafeed in your Merchant Center account.
get GET  /merchantId/datafeeds/datafeedId Retrieves a datafeed configuration from your Merchant Center account.
insert POST  /merchantId/datafeeds Registers a datafeed configuration with your Merchant Center account.
list GET  /merchantId/datafeeds Lists the configurations for datafeeds in your Merchant Center account.
patch PATCH  /merchantId/datafeeds/datafeedId Updates a datafeed configuration of your Merchant Center account. This method supports patch semantics.
update PUT  /merchantId/datafeeds/datafeedId Updates a datafeed configuration of your Merchant Center account.

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.
list GET  /merchantId/datafeedstatuses Lists the statuses of the datafeeds in your Merchant Center account.

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.
set POST  /merchantId/inventory/storeCode/products/productId Updates price and availability of a product in your Merchant Center account.

Liasettings

For Liasettings 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  /liasettings/batch Retrieves and/or updates the LIA settings of multiple accounts in a single request.
get GET  /merchantId/liasettings/accountId Retrieves the LIA settings of the account.
getaccessiblegmbaccounts GET  /merchantId/liasettings/accountId/accessiblegmbaccounts Retrieves the list of accessible Google My Business accounts.
list GET  /merchantId/liasettings Lists the LIA settings of the sub-accounts in your Merchant Center account.
listposdataproviders GET  /liasettings/posdataproviders Retrieves the list of POS data providers that have active settings for the all eiligible countries.
patch PATCH  /merchantId/liasettings/accountId Updates the LIA settings of the account. This method supports patch semantics.
requestgmbaccess POST  /merchantId/liasettings/accountId/requestgmbaccess Requests access to a specified Google My Business account.

Required query parameters: gmbEmail

requestinventoryverification POST  /merchantId/liasettings/accountId/requestinventoryverification/country Requests inventory validation for the specified country.
setinventoryverificationcontact POST  /merchantId/liasettings/accountId/setinventoryverificationcontact Sets the inventory verification contract for the specified country.

Required query parameters: contactEmail, contactName, country, language

setposdataprovider POST  /merchantId/liasettings/accountId/setposdataprovider Sets the POS data provider for the specified country.

Required query parameters: country

update PUT  /merchantId/liasettings/accountId Updates the LIA settings of the account.

Orderinvoices

For Orderinvoices Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/content/v2, unless otherwise noted
createchargeinvoice POST  /merchantId/orderinvoices/orderId/createChargeInvoice Creates a charge invoice for a shipment group, and triggers a charge capture for non-facilitated payment orders.
createrefundinvoice POST  /merchantId/orderinvoices/orderId/createRefundInvoice Creates a refund invoice for one or more shipment groups, and triggers a refund for non-facilitated payment orders. This can only be used for line items that have previously been charged using createChargeInvoice. All amounts (except for the summary) are incremental with respect to the previous invoice.

Orderpayments

For Orderpayments Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/content/v2, unless otherwise noted
notifyauthapproved POST  /merchantId/orderpayments/orderId/notifyAuthApproved Notify about successfully authorizing user's payment method for a given amount.
notifyauthdeclined POST  /merchantId/orderpayments/orderId/notifyAuthDeclined Notify about failure to authorize user's payment method.
notifycharge POST  /merchantId/orderpayments/orderId/notifyCharge Notify about charge on user's selected payments method.
notifyrefund POST  /merchantId/orderpayments/orderId/notifyRefund Notify about refund on user's selected payments method.

Orderreports

For Orderreports Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/content/v2, unless otherwise noted
listdisbursements GET  /merchantId/orderreports/disbursements Retrieves a report for disbursements from your Merchant Center account.

Required query parameters: disbursementStartDate

listtransactions GET  /merchantId/orderreports/disbursements/disbursementId/transactions Retrieves a list of transactions for a disbursement from your Merchant Center account.

Required query parameters: transactionStartDate

Orderreturns

For Orderreturns Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/content/v2, unless otherwise noted
get GET  /merchantId/orderreturns/returnId Retrieves an order return from your Merchant Center account.
list GET  /merchantId/orderreturns Lists order returns in your Merchant Center account.

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.
advancetestorder POST  /merchantId/testorders/orderId/advance Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment".
cancel POST  /merchantId/orders/orderId/cancel Cancels all line items in an order, making a full refund.
cancellineitem POST  /merchantId/orders/orderId/cancelLineItem Cancels a line item, making a full refund.
canceltestorderbycustomer POST  /merchantId/testorders/orderId/cancelByCustomer Sandbox only. Cancels a test order for customer-initiated cancellation.
createtestorder POST  /merchantId/testorders Sandbox only. Creates a test order.
createtestreturn POST  /merchantId/orders/orderId/testreturn Sandbox only. Creates a test return.
custombatch POST  /orders/batch Retrieves or modifies multiple orders in a single request.
get GET  /merchantId/orders/orderId Retrieves an order from your Merchant Center account.
getbymerchantorderid GET  /merchantId/ordersbymerchantid/merchantOrderId Retrieves an order using merchant order id.
gettestordertemplate GET  /merchantId/testordertemplates/templateName Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.
instorerefundlineitem POST  /merchantId/orders/orderId/inStoreRefundLineItem Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store).
list GET  /merchantId/orders Lists the orders in your Merchant Center account.
refund POST  /merchantId/orders/orderId/refund Initiates a full or partial reversal on the payment instrument.
rejectreturnlineitem POST  /merchantId/orders/orderId/rejectReturnLineItem Rejects return on an line item.
returnlineitem POST  /merchantId/orders/orderId/returnLineItem Returns a line item.
returnrefundlineitem POST  /merchantId/orders/orderId/returnRefundLineItem Returns and refunds a line item. Note that this method can only be called on fully shipped orders.
setlineitemmetadata POST  /merchantId/orders/orderId/setLineItemMetadata Sets (overrides) merchant provided annotations on the line item.
shiplineitems POST  /merchantId/orders/orderId/shipLineItems Marks line item(s) as shipped.
updatelineitemshippingdetails POST  /merchantId/orders/orderId/updateLineItemShippingDetails Updates ship by and delivery by dates for a line item.
updatemerchantorderid POST  /merchantId/orders/orderId/updateMerchantOrderId Updates the merchant order ID for a given order.
updateshipment POST  /merchantId/orders/orderId/updateShipment Updates a shipment's status, carrier, and/or tracking ID.

Pos

For Pos 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  /pos/batch Batches multiple POS-related calls in a single request.
delete DELETE  /merchantId/pos/targetMerchantId/store/storeCode Deletes a store for the given merchant.
get GET  /merchantId/pos/targetMerchantId/store/storeCode Retrieves information about the given store.
insert POST  /merchantId/pos/targetMerchantId/store Creates a store for the given merchant.
inventory POST  /merchantId/pos/targetMerchantId/inventory Submit inventory for the given merchant.
list GET  /merchantId/pos/targetMerchantId/store Lists the stores of the target merchant.
sale POST  /merchantId/pos/targetMerchantId/sale Submit a sale event for the given merchant.

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.
delete DELETE  /merchantId/products/productId Deletes a product from your Merchant Center account.
get GET  /merchantId/products/productId Retrieves a product from your Merchant Center account.
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.
list GET  /merchantId/products Lists the products in your Merchant Center account.

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.
get GET  /merchantId/productstatuses/productId Gets the status of a product from your Merchant Center account.
list GET  /merchantId/productstatuses Lists the statuses of the products in your Merchant Center account.

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.
getsupportedcarriers GET  /merchantId/supportedCarriers Retrieves supported carriers and carrier services for an account.
getsupportedholidays GET  /merchantId/supportedHolidays Retrieves supported holidays for an account.
list GET  /merchantId/shippingsettings Lists the shipping settings of the sub-accounts in your Merchant Center account.
patch PATCH  /merchantId/shippingsettings/accountId Updates the shipping settings of the account. This method supports patch semantics.
update PUT  /merchantId/shippingsettings/accountId Updates the shipping settings of the account.

Send feedback about...

Content API for Shopping