This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.
Resource types
- Accounts
- Accountstatuses
- Accounttax
- Datafeeds
- Datafeedstatuses
- Liasettings
- Orderinvoices
- Orderreports
- Orderreturns
- Orders
- Pos
- Products
- Productstatuses
- Regionalinventory
- Returnaddress
- Returnpolicy
- Shippingsettings
Accounts
For Accounts Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/content/v2.1, 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 two Merchant Center accounts, namely accountId and linkedAccountId. |
| list |
GET /merchantId/accounts
|
Lists the sub-accounts in your Merchant Center account. |
| listlinks |
GET /merchantId/accounts/accountId/listlinks
|
Returns the list of accounts linked to your Merchant Center account. |
| 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.1, unless otherwise noted | ||
| custombatch |
POST /accountstatuses/batch
|
Retrieves multiple Merchant Center account statuses in a single request. |
| get |
GET /merchantId/accountstatuses/accountId
|
Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client 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.1, 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. |
| 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.1, unless otherwise noted | ||
| custombatch |
POST /datafeeds/batch
|
Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request. |
| 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. |
| 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.1, unless otherwise noted | ||
| custombatch |
POST /datafeedstatuses/batch
|
Gets multiple Merchant Center datafeed statuses in a single request. |
| 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. |
Liasettings
For Liasettings Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/content/v2.1, 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. |
| 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.1, unless otherwise noted | ||
| createchargeinvoice |
POST /merchantId/orderinvoices/orderId/createChargeInvoice
|
Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders. |
| createrefundinvoice |
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 previously been charged using createChargeInvoice. All amounts (except for the summary) are incremental with respect to the previous invoice.
|
Orderreports
For Orderreports Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/content/v2.1, 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.1, 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.1, 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. |
| 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
|
Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return. |
| list |
GET /merchantId/orders
|
Lists the orders in your Merchant Center account. |
| rejectreturnlineitem |
POST /merchantId/orders/orderId/rejectReturnLineItem
|
Rejects return on an 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 (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource. |
| 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.1, 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.1, 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.1, 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. |
Regionalinventory
For Regionalinventory Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/content/v2.1, unless otherwise noted | ||
| custombatch |
POST /regionalinventory/batch
|
Updates regional inventory for multiple products or regions in a single request. |
| insert |
POST /merchantId/products/productId/regionalinventory
|
Update the regional inventory of a product in your Merchant Center account. If a regional inventory with the same region ID already exists, this method updates that entry. |
Returnaddress
For Returnaddress Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/content/v2.1, unless otherwise noted | ||
| custombatch |
POST /returnaddress/batch
|
Batches multiple return address related calls in a single request. |
| delete |
DELETE /merchantId/returnaddress/returnAddressId
|
Deletes a return address for the given Merchant Center account. |
| get |
GET /merchantId/returnaddress/returnAddressId
|
Gets a return address of the Merchant Center account. |
| insert |
POST /merchantId/returnaddress
|
Inserts a return address for the Merchant Center account. |
| list |
GET /merchantId/returnaddress
|
Lists the return addresses of the Merchant Center account. |
Returnpolicy
For Returnpolicy Resource details, see the resource representation page.
| Method | HTTP request | Description |
|---|---|---|
| URIs relative to https://www.googleapis.com/content/v2.1, unless otherwise noted | ||
| custombatch |
POST /returnpolicy/batch
|
Batches multiple return policy related calls in a single request. |
| delete |
DELETE /merchantId/returnpolicy/returnPolicyId
|
Deletes a return policy for the given Merchant Center account. |
| get |
GET /merchantId/returnpolicy/returnPolicyId
|
Gets a return policy of the Merchant Center account. |
| insert |
POST /merchantId/returnpolicy
|
Inserts a return policy for the Merchant Center account. |
| list |
GET /merchantId/returnpolicy
|
Lists the return policies of the 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.1, 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. |
| getsupportedpickupservices |
GET /merchantId/supportedPickupServices
|
Retrieves supported pickup services for an account. |
| list |
GET /merchantId/shippingsettings
|
Lists the shipping settings of the sub-accounts in your Merchant Center account. |
| update |
PUT /merchantId/shippingsettings/accountId
|
Updates the shipping settings of the account. |