2022-05-11
▼ ▲ content.orders.gettestordertemplate
Flat Path: {merchantId}/testordertemplates/{templateName}
HTTP Method: GET
Parameters:
templateName
Enum Descriptions:
Type: string
Required: Yes
Enum:
Description: The name of the template to retrieve.
Location: path
country
Type: string
Description: The country of the template to retrieve. Defaults to `US`.
Location: query
merchantId
Format: uint64
Required: Yes
Type: string
Location: path
Description: The ID of the account that should manage the order. This cannot be a multi-client account.
Scopes: https://www.googleapis.com/auth/content
Path: {merchantId}/testordertemplates/{templateName}
Parameter Order:
Description: Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.
▼ ▲ content.orders.rejectreturnlineitem
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/content
Parameters:
merchantId
Type: string
Required: Yes
Format: uint64
Location: path
Description: The ID of the account that manages the order. This cannot be a multi-client account.
orderId
Location: path
Description: The ID of the order.
Type: string
Required: Yes
Path: {merchantId}/orders/{orderId}/rejectReturnLineItem
Description: Rejects return on an line item.
Flat Path: {merchantId}/orders/{orderId}/rejectReturnLineItem
Parameter Order:
▼ ▲ content.orders.acknowledge
Parameter Order:
Flat Path: {merchantId}/orders/{orderId}/acknowledge
HTTP Method: POST
Path: {merchantId}/orders/{orderId}/acknowledge
Parameters:
merchantId
Type: string
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Format: uint64
Location: path
Required: Yes
orderId
Description: The ID of the order.
Location: path
Type: string
Required: Yes
Description: Marks an order as acknowledged.
▼ ▲ content.orders.updateshipment
HTTP Method: POST
Flat Path: {merchantId}/orders/{orderId}/updateShipment
Scopes: https://www.googleapis.com/auth/content
Path: {merchantId}/orders/{orderId}/updateShipment
Parameters:
orderId
Required: Yes
Description: The ID of the order.
Type: string
Location: path
merchantId
Type: string
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Format: uint64
Required: Yes
Description: Updates a shipment's status, carrier, and/or tracking ID.
Parameter Order:
▼ ▲ content.orders.canceltestorderbycustomer
Parameters:
orderId
Required: Yes
Type: string
Description: The ID of the test order to cancel.
Location: path
merchantId
Format: uint64
Location: path
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Required: Yes
Type: string
Flat Path: {merchantId}/testorders/{orderId}/cancelByCustomer
Path: {merchantId}/testorders/{orderId}/cancelByCustomer
HTTP Method: POST
Description: Sandbox only. Cancels a test order for customer-initiated cancellation.
Parameter Order:
▼ ▲ content.orders.createtestorder
Path: {merchantId}/testorders
HTTP Method: POST
Flat Path: {merchantId}/testorders
Scopes: https://www.googleapis.com/auth/content
Parameter Order: merchantId
Description: Sandbox only. Creates a test order.
Parameters:
merchantId
Format: uint64
Type: string
Description: The ID of the account that should manage the order. This cannot be a multi-client account.
Location: path
Required: Yes
▼ ▲ content.orders.custombatch
Flat Path: orders/batch
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves or modifies multiple orders in a single request.
Path: orders/batch
▼ ▲ content.orders.cancellineitem
Parameters:
orderId
Required: Yes
Location: path
Type: string
Description: The ID of the order.
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Format: uint64
Type: string
Location: path
Required: Yes
Flat Path: {merchantId}/orders/{orderId}/cancelLineItem
Path: {merchantId}/orders/{orderId}/cancelLineItem
Scopes: https://www.googleapis.com/auth/content
HTTP Method: POST
Description: Cancels a line item, making a full refund.
Parameter Order:
▼ ▲ content.orders.returnlineitem
HTTP Method: POST
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Description: Returns a line item.
Flat Path: {merchantId}/orders/{orderId}/returnLineItem
Parameters:
orderId
Type: string
Description: The ID of the order.
Required: Yes
Location: path
merchantId
Type: string
Required: Yes
Location: path
Format: uint64
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Path: {merchantId}/orders/{orderId}/returnLineItem
▼ ▲ content.orders.instorerefundlineitem
Scopes: https://www.googleapis.com/auth/content
Flat Path: {merchantId}/orders/{orderId}/inStoreRefundLineItem
Parameters:
orderId
Type: string
Description: The ID of the order.
Required: Yes
Location: path
merchantId
Format: uint64
Type: string
Required: Yes
Location: path
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Path: {merchantId}/orders/{orderId}/inStoreRefundLineItem
HTTP Method: POST
Parameter Order:
Description: 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.
▼ ▲ content.orders.createtestreturn
Parameter Order:
Path: {merchantId}/orders/{orderId}/testreturn
Description: Sandbox only. Creates a test return.
Flat Path: {merchantId}/orders/{orderId}/testreturn
Scopes: https://www.googleapis.com/auth/content
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Type: string
Location: path
Format: uint64
Required: Yes
orderId
Type: string
Required: Yes
Description: The ID of the order.
Location: path
HTTP Method: POST
▼ ▲ content.orders.get
Path: {merchantId}/orders/{orderId}
Flat Path: {merchantId}/orders/{orderId}
Description: Retrieves an order from your Merchant Center account.
HTTP Method: GET
Parameters:
orderId
Description: The ID of the order.
Location: path
Required: Yes
Type: string
merchantId
Location: path
Format: uint64
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Type: string
Required: Yes
Scopes: https://www.googleapis.com/auth/content
Parameter Order:
▼ ▲ content.orders.shiplineitems
Path: {merchantId}/orders/{orderId}/shipLineItems
HTTP Method: POST
Description: Marks line item(s) as shipped.
Parameter Order:
Flat Path: {merchantId}/orders/{orderId}/shipLineItems
Scopes: https://www.googleapis.com/auth/content
Parameters:
orderId
Description: The ID of the order.
Type: string
Required: Yes
Location: path
merchantId
Location: path
Format: uint64
Required: Yes
Type: string
Description: The ID of the account that manages the order. This cannot be a multi-client account.
▼ ▲ content.orders.setlineitemmetadata
HTTP Method: POST
Path: {merchantId}/orders/{orderId}/setLineItemMetadata
Description: 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.
Parameters:
merchantId
Type: string
Format: uint64
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Required: Yes
Location: path
orderId
Description: The ID of the order.
Required: Yes
Location: path
Type: string
Scopes: https://www.googleapis.com/auth/content
Flat Path: {merchantId}/orders/{orderId}/setLineItemMetadata
Parameter Order:
▼ ▲ content.orders.refund
Parameters:
merchantId
Required: Yes
Location: path
Type: string
Format: uint64
Description: The ID of the account that manages the order. This cannot be a multi-client account.
orderId
Required: Yes
Description: The ID of the order to refund.
Type: string
Location: path
Path: {merchantId}/orders/{orderId}/refund
Parameter Order:
HTTP Method: POST
Description: Deprecated, please use returnRefundLineItem instead.
Flat Path: {merchantId}/orders/{orderId}/refund
▼ ▲ content.orders.updatelineitemshippingdetails
Path: {merchantId}/orders/{orderId}/updateLineItemShippingDetails
Flat Path: {merchantId}/orders/{orderId}/updateLineItemShippingDetails
HTTP Method: POST
Parameters:
merchantId
Location: path
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Required: Yes
Format: uint64
Type: string
orderId
Description: The ID of the order.
Type: string
Required: Yes
Location: path
Scopes: https://www.googleapis.com/auth/content
Description: Updates ship by and delivery by dates for a line item.
Parameter Order:
▼ ▲ content.orders.list
Path: {merchantId}/orders
Description: Lists the orders in your Merchant Center account.
Scopes: https://www.googleapis.com/auth/content
Parameter Order: merchantId
Parameters:
placedDateStart
Location: query
Description: Obtains orders placed after this date (inclusively), in ISO 8601 format.
Type: string
merchantId
Location: path
Required: Yes
Format: uint64
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Type: string
statuses
Enum Descriptions:
Description: Obtains orders that match any of the specified statuses. Please note that `active` is a shortcut for `pendingShipment` and `partiallyShipped`, and `completed` is a shortcut for `shipped`, `partiallyDelivered`, `delivered`, `partiallyReturned`, `returned`, and `canceled`.
Repeated: Yes
Type: string
Enum:
Location: query
pageToken
Location: query
Description: The token returned by the previous request.
Type: string
acknowledged
Location: query
Type: boolean
Description: Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged orders are returned.
maxResults
Format: uint32
Description: The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.
Type: integer
Location: query
placedDateEnd
Description: Obtains orders placed before this date (exclusively), in ISO 8601 format.
Location: query
Type: string
orderBy
Description: Order results by placement date in descending or ascending order. Acceptable values are: - placedDateAsc - placedDateDesc
Type: string
Location: query
Flat Path: {merchantId}/orders
HTTP Method: GET
▼ ▲ content.orders.updatemerchantorderid
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Format: uint64
Type: string
Location: path
Required: Yes
orderId
Required: Yes
Description: The ID of the order.
Type: string
Location: path
Path: {merchantId}/orders/{orderId}/updateMerchantOrderId
Flat Path: {merchantId}/orders/{orderId}/updateMerchantOrderId
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
HTTP Method: POST
Description: Updates the merchant order ID for a given order.
▼ ▲ content.orders.advancetestorder
Path: {merchantId}/testorders/{orderId}/advance
Scopes: https://www.googleapis.com/auth/content
Flat Path: {merchantId}/testorders/{orderId}/advance
Description: Sandbox only. Moves a test order from state "`inProgress`" to state "`pendingShipment`".
HTTP Method: POST
Parameter Order:
Parameters:
orderId
Description: The ID of the test order to modify.
Required: Yes
Location: path
Type: string
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Location: path
Type: string
Format: uint64
Required: Yes
▼ ▲ content.orders.getbymerchantorderid
HTTP Method: GET
Parameters:
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Type: string
Required: Yes
Format: uint64
Location: path
merchantOrderId
Description: The merchant order ID to be looked for.
Required: Yes
Type: string
Location: path
Scopes: https://www.googleapis.com/auth/content
Parameter Order:
Description: Retrieves an order using merchant order ID.
Flat Path: {merchantId}/ordersbymerchantid/{merchantOrderId}
Path: {merchantId}/ordersbymerchantid/{merchantOrderId}
▼ ▲ content.orders.returnrefundlineitem
Description: Returns and refunds a line item. Note that this method can only be called on fully shipped orders. Please also note that the Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund.
Parameter Order:
Path: {merchantId}/orders/{orderId}/returnRefundLineItem
Parameters:
orderId
Type: string
Description: The ID of the order.
Required: Yes
Location: path
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Format: uint64
Location: path
Type: string
Required: Yes
Scopes: https://www.googleapis.com/auth/content
Flat Path: {merchantId}/orders/{orderId}/returnRefundLineItem
HTTP Method: POST
▼ ▲ content.orders.cancel
Parameters:
orderId
Required: Yes
Location: path
Type: string
Description: The ID of the order to cancel.
merchantId
Required: Yes
Location: path
Format: uint64
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Type: string
HTTP Method: POST
Path: {merchantId}/orders/{orderId}/cancel
Flat Path: {merchantId}/orders/{orderId}/cancel
Description: Cancels all line items in an order, making a full refund.
Parameter Order:
▼ ▲ content.datafeedstatuses.custombatch
Description: Gets multiple Merchant Center datafeed statuses in a single request.
Flat Path: datafeedstatuses/batch
Path: datafeedstatuses/batch
HTTP Method: POST
▼ ▲ content.datafeedstatuses.list
Flat Path: {merchantId}/datafeedstatuses
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/content
Description: Lists the statuses of the datafeeds in your Merchant Center account.
Parameters:
maxResults
Type: integer
Format: uint32
Location: query
Description: The maximum number of products to return in the response, used for paging.
pageToken
Location: query
Type: string
Description: The token returned by the previous request.
merchantId
Format: uint64
Location: path
Description: The ID of the account that manages the datafeeds. This account cannot be a multi-client account.
Required: Yes
Type: string
Parameter Order: merchantId
Path: {merchantId}/datafeedstatuses
▼ ▲ content.datafeedstatuses.get
Flat Path: {merchantId}/datafeedstatuses/{datafeedId}
Parameter Order:
Path: {merchantId}/datafeedstatuses/{datafeedId}
Description: Retrieves the status of a datafeed from your Merchant Center account.
HTTP Method: GET
Parameters:
merchantId
Location: path
Format: uint64
Description: The ID of the account that manages the datafeed. This account cannot be a multi-client account.
Required: Yes
Type: string
country
Location: query
Type: string
Description: The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.
datafeedId
Description: The ID of the datafeed.
Format: uint64
Type: string
Required: Yes
Location: path
language
Description: The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.
Type: string
Location: query
▼ ▲ content.liasettings.listposdataproviders
Flat Path: liasettings/posdataproviders
Path: liasettings/posdataproviders
Description: Retrieves the list of POS data providers that have active settings for the all eiligible countries.
HTTP Method: GET
▼ ▲ content.liasettings.requestinventoryverification
Parameters:
accountId
Type: string
Required: Yes
Format: uint64
Location: path
Description: The ID of the account that manages the order. This cannot be a multi-client account.
merchantId
Required: Yes
Location: path
Format: uint64
Description: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.
Type: string
country
Description: The country for which inventory validation is requested.
Location: path
Type: string
Required: Yes
Scopes: https://www.googleapis.com/auth/content
HTTP Method: POST
Path: {merchantId}/liasettings/{accountId}/requestinventoryverification/{country}
Parameter Order:
Flat Path: {merchantId}/liasettings/{accountId}/requestinventoryverification/{country}
Description: Requests inventory validation for the specified country.
▼ ▲ content.liasettings.getaccessiblegmbaccounts
Flat Path: {merchantId}/liasettings/{accountId}/accessiblegmbaccounts
Parameter Order:
Description: Retrieves the list of accessible Google My Business accounts.
Scopes: https://www.googleapis.com/auth/content
Parameters:
accountId
Format: uint64
Required: Yes
Location: path
Type: string
Description: The ID of the account for which to retrieve accessible Google My Business accounts.
merchantId
Location: path
Format: uint64
Description: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.
Required: Yes
Type: string
HTTP Method: GET
Path: {merchantId}/liasettings/{accountId}/accessiblegmbaccounts
▼ ▲ content.liasettings.setposdataprovider
Description: Sets the POS data provider for the specified country.
Path: {merchantId}/liasettings/{accountId}/setposdataprovider
Scopes: https://www.googleapis.com/auth/content
Flat Path: {merchantId}/liasettings/{accountId}/setposdataprovider
Parameter Order:
HTTP Method: POST
Parameters:
accountId
Required: Yes
Description: The ID of the account for which to retrieve accessible Google My Business accounts.
Format: uint64
Type: string
Location: path
posExternalAccountId
Location: query
Type: string
Description: The account ID by which this merchant is known to the POS data provider.
country
Required: Yes
Location: query
Type: string
Description: The country for which the POS data provider is selected.
merchantId
Required: Yes
Format: uint64
Location: path
Type: string
Description: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.
posDataProviderId
Type: string
Location: query
Format: uint64
Description: The ID of POS data provider.
▼ ▲ content.liasettings.setinventoryverificationcontact
Scopes: https://www.googleapis.com/auth/content
Flat Path: {merchantId}/liasettings/{accountId}/setinventoryverificationcontact
Parameters:
accountId
Format: uint64
Type: string
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Required: Yes
Location: path
contactEmail
Description: The email of the inventory verification contact.
Type: string
Location: query
Required: Yes
merchantId
Required: Yes
Type: string
Description: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.
Location: path
Format: uint64
language
Location: query
Description: The language for which inventory verification is requested.
Required: Yes
Type: string
country
Location: query
Required: Yes
Type: string
Description: The country for which inventory verification is requested.
contactName
Description: The name of the inventory verification contact.
Required: Yes
Type: string
Location: query
Path: {merchantId}/liasettings/{accountId}/setinventoryverificationcontact
HTTP Method: POST
Parameter Order:
Description: Sets the inventory verification contract for the specified country.
▼ ▲ content.liasettings.list
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/content
Flat Path: {merchantId}/liasettings
Description: Lists the LIA settings of the sub-accounts in your Merchant Center account.
Path: {merchantId}/liasettings
Parameter Order: merchantId
Parameters:
maxResults
Location: query
Type: integer
Format: uint32
Description: The maximum number of LIA settings to return in the response, used for paging.
merchantId
Description: The ID of the managing account. This must be a multi-client account.
Type: string
Location: path
Format: uint64
Required: Yes
pageToken
Description: The token returned by the previous request.
Location: query
Type: string
▼ ▲ content.liasettings.get
Description: Retrieves the LIA settings of the account.
Parameters:
accountId
Type: string
Required: Yes
Description: The ID of the account for which to get or update LIA settings.
Format: uint64
Location: path
merchantId
Required: Yes
Format: uint64
Description: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.
Location: path
Type: string
Scopes: https://www.googleapis.com/auth/content
Parameter Order:
Flat Path: {merchantId}/liasettings/{accountId}
Path: {merchantId}/liasettings/{accountId}
HTTP Method: GET
▼ ▲ content.liasettings.custombatch
Flat Path: liasettings/batch
Parameters:
dryRun
Location: query
Type: boolean
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
HTTP Method: POST
Path: liasettings/batch
Description: Retrieves and/or updates the LIA settings of multiple accounts in a single request.
▼ ▲ content.liasettings.requestgmbaccess
Parameters:
gmbEmail
Required: Yes
Description: The email of the Google My Business account.
Type: string
Location: query
merchantId
Location: path
Description: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.
Required: Yes
Format: uint64
Type: string
accountId
Required: Yes
Type: string
Location: path
Description: The ID of the account for which GMB access is requested.
Format: uint64
Description: Requests access to a specified Google My Business account.
Path: {merchantId}/liasettings/{accountId}/requestgmbaccess
HTTP Method: POST
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Flat Path: {merchantId}/liasettings/{accountId}/requestgmbaccess
▼ ▲ content.liasettings.update
Description: Updates the LIA settings of the account. Any fields that are not provided are deleted from the resource.
Parameters:
accountId
Description: The ID of the account for which to get or update LIA settings.
Required: Yes
Format: uint64
Type: string
Location: path
merchantId
Type: string
Format: uint64
Description: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.
Location: path
Required: Yes
dryRun
Type: boolean
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Location: query
HTTP Method: PUT
Parameter Order:
Path: {merchantId}/liasettings/{accountId}
Flat Path: {merchantId}/liasettings/{accountId}
▼ ▲ content.accountstatuses.custombatch
Path: accountstatuses/batch
Flat Path: accountstatuses/batch
HTTP Method: POST
Description: Retrieves multiple Merchant Center account statuses in a single request.
▼ ▲ content.accountstatuses.list
Flat Path: {merchantId}/accountstatuses
HTTP Method: GET
Description: Lists the statuses of the sub-accounts in your Merchant Center account.
Parameters:
maxResults
Type: integer
Location: query
Description: The maximum number of account statuses to return in the response, used for paging.
Format: uint32
pageToken
Type: string
Location: query
Description: The token returned by the previous request.
destinations
Repeated: Yes
Type: string
Location: query
Description: If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.
merchantId
Format: uint64
Required: Yes
Description: The ID of the managing account. This must be a multi-client account.
Location: path
Type: string
Parameter Order: merchantId
Path: {merchantId}/accountstatuses
▼ ▲ content.accountstatuses.get
HTTP Method: GET
Parameters:
merchantId
Required: Yes
Format: uint64
Description: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.
Location: path
Type: string
accountId
Description: The ID of the account.
Location: path
Format: uint64
Required: Yes
Type: string
destinations
Location: query
Description: If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.
Type: string
Repeated: Yes
Flat Path: {merchantId}/accountstatuses/{accountId}
Scopes: https://www.googleapis.com/auth/content
Parameter Order:
Path: {merchantId}/accountstatuses/{accountId}
Description: Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.
▼ ▲ content.orderreports.listdisbursements
Path: {merchantId}/orderreports/disbursements
Flat Path: {merchantId}/orderreports/disbursements
Parameter Order: merchantId
Description: Retrieves a report for disbursements from your Merchant Center account.
Parameters:
disbursementEndDate
Description: The last date which disbursements occurred. In ISO 8601 format. Default: current date.
Location: query
Type: string
maxResults
Format: uint32
Type: integer
Location: query
Description: The maximum number of disbursements to return in the response, used for paging.
pageToken
Location: query
Description: The token returned by the previous request.
Type: string
disbursementStartDate
Description: The first date which disbursements occurred. In ISO 8601 format.
Location: query
Type: string
merchantId
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Required: Yes
Location: path
Type: string
Format: uint64
Scopes: https://www.googleapis.com/auth/content
HTTP Method: GET
▼ ▲ content.orderreports.listtransactions
Path: {merchantId}/orderreports/disbursements/{disbursementId}/transactions
Parameters:
maxResults
Location: query
Format: uint32
Type: integer
Description: The maximum number of disbursements to return in the response, used for paging.
disbursementId
Type: string
Location: path
Required: Yes
Description: The Google-provided ID of the disbursement (found in Wallet).
pageToken
Type: string
Location: query
Description: The token returned by the previous request.
transactionStartDate
Location: query
Type: string
Description: The first date in which transaction occurred. In ISO 8601 format.
transactionEndDate
Description: The last date in which transaction occurred. In ISO 8601 format. Default: current date.
Type: string
Location: query
merchantId
Location: path
Format: uint64
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Type: string
Required: Yes
Description: Retrieves a list of transactions for a disbursement from your Merchant Center account.
Scopes: https://www.googleapis.com/auth/content
Parameter Order:
HTTP Method: GET
Flat Path: {merchantId}/orderreports/disbursements/{disbursementId}/transactions
▼ ▲ content.productstatuses.get
Flat Path: {merchantId}/productstatuses/{productId}
Description: Gets the status of a product from your Merchant Center account.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/content
Parameters:
merchantId
Format: uint64
Location: path
Description: The ID of the account that contains the product. This account cannot be a multi-client account.
Type: string
Required: Yes
productId
Type: string
Description: The REST ID of the product.
Required: Yes
Location: path
includeAttributes
Type: boolean
Location: query
Description: Flag to include full product data in the result of this get request. The default value is false.
destinations
Type: string
Description: If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.
Repeated: Yes
Location: query
Path: {merchantId}/productstatuses/{productId}
Parameter Order:
▼ ▲ content.productstatuses.list
HTTP Method: GET
Description: Lists the statuses of the products in your Merchant Center account.
Parameters:
merchantId
Description: The ID of the account that contains the products. This account cannot be a multi-client account.
Required: Yes
Type: string
Format: uint64
Location: path
maxResults
Description: The maximum number of product statuses to return in the response, used for paging.
Location: query
Format: uint32
Type: integer
includeAttributes
Description: Flag to include full product data in the results of the list request. The default value is false.
Location: query
Type: boolean
includeInvalidInsertedItems
Type: boolean
Description: Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false).
Location: query
pageToken
Type: string
Description: The token returned by the previous request.
Location: query
destinations
Location: query
Type: string
Repeated: Yes
Description: If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.
Path: {merchantId}/productstatuses
Scopes: https://www.googleapis.com/auth/content
Flat Path: {merchantId}/productstatuses
Parameter Order: merchantId
▼ ▲ content.productstatuses.custombatch
Path: productstatuses/batch
Flat Path: productstatuses/batch
Parameters:
includeAttributes
Description: Flag to include full product data in the results of this request. The default value is false.
Location: query
Type: boolean
Scopes: https://www.googleapis.com/auth/content
HTTP Method: POST
Description: Gets the statuses of multiple products in a single request.
▼ ▲ content.accounttax.update
Flat Path: {merchantId}/accounttax/{accountId}
Parameter Order:
Description: Updates the tax settings of the account. Any fields that are not provided are deleted from the resource.
Scopes: https://www.googleapis.com/auth/content
HTTP Method: PUT
Path: {merchantId}/accounttax/{accountId}
Parameters:
accountId
Required: Yes
Format: uint64
Description: The ID of the account for which to get/update account tax settings.
Type: string
Location: path
dryRun
Type: boolean
Location: query
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
merchantId
Format: uint64
Location: path
Required: Yes
Type: string
Description: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.
▼ ▲ content.accounttax.list
Parameters:
merchantId
Required: Yes
Format: uint64
Type: string
Location: path
Description: The ID of the managing account. This must be a multi-client account.
maxResults
Type: integer
Location: query
Description: The maximum number of tax settings to return in the response, used for paging.
Format: uint32
pageToken
Type: string
Location: query
Description: The token returned by the previous request.
Flat Path: {merchantId}/accounttax
Path: {merchantId}/accounttax
Description: Lists the tax settings of the sub-accounts in your Merchant Center account.
HTTP Method: GET
Parameter Order: merchantId
▼ ▲ content.accounttax.custombatch
Description: Retrieves and updates tax settings of multiple accounts in a single request.
HTTP Method: POST
Parameters:
dryRun
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Location: query
Type: boolean
Scopes: https://www.googleapis.com/auth/content
Path: accounttax/batch
Flat Path: accounttax/batch
▼ ▲ content.accounttax.get
Parameters:
accountId
Type: string
Location: path
Required: Yes
Description: The ID of the account for which to get/update account tax settings.
Format: uint64
merchantId
Type: string
Location: path
Required: Yes
Description: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.
Format: uint64
Description: Retrieves the tax settings of the account.
Parameter Order:
Path: {merchantId}/accounttax/{accountId}
Scopes: https://www.googleapis.com/auth/content
Flat Path: {merchantId}/accounttax/{accountId}
HTTP Method: GET
▼ ▲ content.accounts.insert
Description: Creates a Merchant Center sub-account.
Flat Path: {merchantId}/accounts
Scopes: https://www.googleapis.com/auth/content
HTTP Method: POST
Parameter Order: merchantId
Path: {merchantId}/accounts
Parameters:
dryRun
Type: boolean
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Location: query
merchantId
Location: path
Type: string
Format: uint64
Required: Yes
Description: The ID of the managing account. This must be a multi-client account.
▼ ▲ content.accounts.update
Scopes: https://www.googleapis.com/auth/content
Description: Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.
HTTP Method: PUT
Parameter Order:
Parameters:
accountId
Description: The ID of the account.
Location: path
Required: Yes
Type: string
Format: uint64
merchantId
Location: path
Type: string
Format: uint64
Description: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.
Required: Yes
dryRun
Type: boolean
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Location: query
Path: {merchantId}/accounts/{accountId}
Flat Path: {merchantId}/accounts/{accountId}
▼ ▲ content.accounts.claimwebsite
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Flat Path: {merchantId}/accounts/{accountId}/claimwebsite
HTTP Method: POST
Parameters:
merchantId
Required: Yes
Description: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.
Type: string
Location: path
Format: uint64
accountId
Format: uint64
Description: The ID of the account whose website is claimed.
Location: path
Type: string
Required: Yes
overwrite
Location: query
Description: Only available to selected merchants. When set to `True`, this flag removes any existing claim on the requested website by another account and replaces it with a claim from this account.
Type: boolean
Description: Claims the website of a Merchant Center sub-account.
Path: {merchantId}/accounts/{accountId}/claimwebsite
▼ ▲ content.accounts.authinfo
Flat Path: accounts/authinfo
Path: accounts/authinfo
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/content
Description: Returns information about the authenticated user.
▼ ▲ content.accounts.list
HTTP Method: GET
Flat Path: {merchantId}/accounts
Description: Lists the sub-accounts in your Merchant Center account.
Path: {merchantId}/accounts
Parameter Order: merchantId
Scopes: https://www.googleapis.com/auth/content
Parameters:
pageToken
Type: string
Description: The token returned by the previous request.
Location: query
merchantId
Format: uint64
Location: path
Type: string
Description: The ID of the managing account. This must be a multi-client account.
Required: Yes
maxResults
Format: uint32
Description: The maximum number of accounts to return in the response, used for paging.
Location: query
Type: integer
▼ ▲ content.accounts.custombatch
Flat Path: accounts/batch
Path: accounts/batch
Parameters:
dryRun
Location: query
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Type: boolean
Scopes: https://www.googleapis.com/auth/content
HTTP Method: POST
Description: Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.
▼ ▲ content.accounts.link
Path: {merchantId}/accounts/{accountId}/link
Flat Path: {merchantId}/accounts/{accountId}/link
Description: Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.
Parameter Order:
Parameters:
merchantId
Description: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.
Format: uint64
Required: Yes
Type: string
Location: path
accountId
Description: The ID of the account that should be linked.
Location: path
Required: Yes
Type: string
Format: uint64
Scopes: https://www.googleapis.com/auth/content
HTTP Method: POST
▼ ▲ content.accounts.delete
Description: Deletes a Merchant Center sub-account.
Parameters:
dryRun
Type: boolean
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Location: query
force
Description: Flag to delete sub-accounts with products. The default value is false.
Location: query
Default: false
Type: boolean
accountId
Type: string
Location: path
Format: uint64
Required: Yes
Description: The ID of the account.
merchantId
Required: Yes
Description: The ID of the managing account. This must be a multi-client account, and accountId must be the ID of a sub-account of this account.
Location: path
Format: uint64
Type: string
Flat Path: {merchantId}/accounts/{accountId}
Parameter Order:
HTTP Method: DELETE
Path: {merchantId}/accounts/{accountId}
▼ ▲ content.accounts.get
Parameter Order:
Description: Retrieves a Merchant Center account.
Parameters:
merchantId
Required: Yes
Location: path
Type: string
Format: uint64
Description: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.
accountId
Format: uint64
Type: string
Description: The ID of the account.
Location: path
Required: Yes
Path: {merchantId}/accounts/{accountId}
HTTP Method: GET
Flat Path: {merchantId}/accounts/{accountId}
▼ ▲ content.orderinvoices.createrefundinvoice
Flat Path: {merchantId}/orderinvoices/{orderId}/createRefundInvoice
Description: 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.
Scopes: https://www.googleapis.com/auth/content
Parameter Order:
Parameters:
orderId
Type: string
Required: Yes
Location: path
Description: The ID of the order.
merchantId
Type: string
Location: path
Format: uint64
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Required: Yes
HTTP Method: POST
Path: {merchantId}/orderinvoices/{orderId}/createRefundInvoice
▼ ▲ content.orderinvoices.createchargeinvoice
Parameters:
orderId
Location: path
Required: Yes
Description: The ID of the order.
Type: string
merchantId
Type: string
Required: Yes
Location: path
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Format: uint64
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/content
Description: Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.
Flat Path: {merchantId}/orderinvoices/{orderId}/createChargeInvoice
Parameter Order:
Path: {merchantId}/orderinvoices/{orderId}/createChargeInvoice
▼ ▲ content.pos.custombatch
Path: pos/batch
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/content
Description: Batches multiple POS-related calls in a single request.
Parameters:
dryRun
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Type: boolean
Location: query
Flat Path: pos/batch
▼ ▲ content.pos.inventory
Flat Path: {merchantId}/pos/{targetMerchantId}/inventory
Scopes: https://www.googleapis.com/auth/content
Parameter Order:
Path: {merchantId}/pos/{targetMerchantId}/inventory
Description: Submit inventory for the given merchant.
HTTP Method: POST
Parameters:
dryRun
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Location: query
Type: boolean
merchantId
Format: uint64
Description: The ID of the POS or inventory data provider.
Type: string
Required: Yes
Location: path
targetMerchantId
Location: path
Description: The ID of the target merchant.
Required: Yes
Type: string
Format: uint64
▼ ▲ content.pos.sale
Description: Submit a sale event for the given merchant.
Scopes: https://www.googleapis.com/auth/content
Parameter Order:
Path: {merchantId}/pos/{targetMerchantId}/sale
Flat Path: {merchantId}/pos/{targetMerchantId}/sale
Parameters:
targetMerchantId
Type: string
Description: The ID of the target merchant.
Format: uint64
Required: Yes
Location: path
merchantId
Format: uint64
Location: path
Type: string
Description: The ID of the POS or inventory data provider.
Required: Yes
dryRun
Location: query
Type: boolean
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
HTTP Method: POST
▼ ▲ content.pos.insert
Description: Creates a store for the given merchant.
HTTP Method: POST
Parameters:
merchantId
Format: uint64
Type: string
Description: The ID of the POS or inventory data provider.
Required: Yes
Location: path
targetMerchantId
Required: Yes
Description: The ID of the target merchant.
Format: uint64
Type: string
Location: path
dryRun
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Type: boolean
Location: query
Path: {merchantId}/pos/{targetMerchantId}/store
Scopes: https://www.googleapis.com/auth/content
Parameter Order:
Flat Path: {merchantId}/pos/{targetMerchantId}/store
▼ ▲ content.pos.list
Flat Path: {merchantId}/pos/{targetMerchantId}/store
HTTP Method: GET
Path: {merchantId}/pos/{targetMerchantId}/store
Scopes: https://www.googleapis.com/auth/content
Description: Lists the stores of the target merchant.
Parameters:
targetMerchantId
Format: uint64
Required: Yes
Description: The ID of the target merchant.
Location: path
Type: string
merchantId
Location: path
Type: string
Description: The ID of the POS or inventory data provider.
Required: Yes
Format: uint64
Parameter Order:
▼ ▲ content.pos.get
Flat Path: {merchantId}/pos/{targetMerchantId}/store/{storeCode}
Parameters:
targetMerchantId
Format: uint64
Description: The ID of the target merchant.
Location: path
Required: Yes
Type: string
merchantId
Required: Yes
Type: string
Location: path
Format: uint64
Description: The ID of the POS or inventory data provider.
storeCode
Required: Yes
Description: A store code that is unique per merchant.
Type: string
Location: path
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/content
Parameter Order:
Description: Retrieves information about the given store.
Path: {merchantId}/pos/{targetMerchantId}/store/{storeCode}
▼ ▲ content.pos.delete
Parameter Order:
Parameters:
merchantId
Type: string
Description: The ID of the POS or inventory data provider.
Format: uint64
Location: path
Required: Yes
dryRun
Type: boolean
Location: query
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
targetMerchantId
Format: uint64
Type: string
Required: Yes
Location: path
Description: The ID of the target merchant.
storeCode
Location: path
Required: Yes
Type: string
Description: A store code that is unique per merchant.
Description: Deletes a store for the given merchant.
Flat Path: {merchantId}/pos/{targetMerchantId}/store/{storeCode}
HTTP Method: DELETE
Path: {merchantId}/pos/{targetMerchantId}/store/{storeCode}
▼ ▲ content.shippingsettings.getsupportedholidays
Path: {merchantId}/supportedHolidays
Scopes: https://www.googleapis.com/auth/content
Parameter Order: merchantId
Flat Path: {merchantId}/supportedHolidays
Parameters:
merchantId
Required: Yes
Description: The ID of the account for which to retrieve the supported holidays.
Type: string
Location: path
Format: uint64
HTTP Method: GET
Description: Retrieves supported holidays for an account.
▼ ▲ content.shippingsettings.get
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves the shipping settings of the account.
HTTP Method: GET
Path: {merchantId}/shippingsettings/{accountId}
Flat Path: {merchantId}/shippingsettings/{accountId}
Parameter Order:
Parameters:
merchantId
Description: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.
Required: Yes
Type: string
Location: path
Format: uint64
accountId
Required: Yes
Location: path
Description: The ID of the account for which to get/update shipping settings.
Format: uint64
Type: string
▼ ▲ content.shippingsettings.list
HTTP Method: GET
Path: {merchantId}/shippingsettings
Scopes: https://www.googleapis.com/auth/content
Parameters:
pageToken
Type: string
Description: The token returned by the previous request.
Location: query
merchantId
Format: uint64
Location: path
Required: Yes
Description: The ID of the managing account. This must be a multi-client account.
Type: string
maxResults
Description: The maximum number of shipping settings to return in the response, used for paging.
Location: query
Format: uint32
Type: integer
Flat Path: {merchantId}/shippingsettings
Parameter Order: merchantId
Description: Lists the shipping settings of the sub-accounts in your Merchant Center account.
▼ ▲ content.shippingsettings.getsupportedpickupservices
Flat Path: {merchantId}/supportedPickupServices
Parameter Order: merchantId
HTTP Method: GET
Parameters:
merchantId
Location: path
Format: uint64
Description: The ID of the account for which to retrieve the supported pickup services.
Required: Yes
Type: string
Path: {merchantId}/supportedPickupServices
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves supported pickup services for an account.
▼ ▲ content.shippingsettings.getsupportedcarriers
Parameter Order: merchantId
HTTP Method: GET
Flat Path: {merchantId}/supportedCarriers
Scopes: https://www.googleapis.com/auth/content
Path: {merchantId}/supportedCarriers
Description: Retrieves supported carriers and carrier services for an account.
Parameters:
merchantId
Format: uint64
Type: string
Description: The ID of the account for which to retrieve the supported carriers.
Required: Yes
Location: path
▼ ▲ content.shippingsettings.custombatch
Scopes: https://www.googleapis.com/auth/content
Flat Path: shippingsettings/batch
Path: shippingsettings/batch
Parameters:
dryRun
Location: query
Type: boolean
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Description: Retrieves and updates the shipping settings of multiple accounts in a single request.
HTTP Method: POST
▼ ▲ content.shippingsettings.update
Scopes: https://www.googleapis.com/auth/content
Parameter Order:
Parameters:
accountId
Location: path
Description: The ID of the account for which to get/update shipping settings.
Required: Yes
Format: uint64
Type: string
dryRun
Location: query
Type: boolean
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
merchantId
Type: string
Format: uint64
Location: path
Required: Yes
Description: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.
HTTP Method: PUT
Path: {merchantId}/shippingsettings/{accountId}
Description: Updates the shipping settings of the account. Any fields that are not provided are deleted from the resource.
Flat Path: {merchantId}/shippingsettings/{accountId}
▼ ▲ content.products.insert
Scopes: https://www.googleapis.com/auth/content
HTTP Method: POST
Description: 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.
Path: {merchantId}/products
Parameters:
dryRun
Type: boolean
Location: query
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
merchantId
Location: path
Description: The ID of the account that contains the product. This account cannot be a multi-client account.
Type: string
Required: Yes
Format: uint64
Flat Path: {merchantId}/products
Parameter Order: merchantId
▼ ▲ content.products.delete
Flat Path: {merchantId}/products/{productId}
Scopes: https://www.googleapis.com/auth/content
Description: Deletes a product from your Merchant Center account.
Parameter Order:
Path: {merchantId}/products/{productId}
HTTP Method: DELETE
Parameters:
dryRun
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Type: boolean
Location: query
merchantId
Location: path
Description: The ID of the account that contains the product. This account cannot be a multi-client account.
Type: string
Required: Yes
Format: uint64
productId
Description: The REST ID of the product.
Required: Yes
Type: string
Location: path
▼ ▲ content.products.get
Description: Retrieves a product from your Merchant Center account.
Parameter Order:
Path: {merchantId}/products/{productId}
Scopes: https://www.googleapis.com/auth/content
Parameters:
productId
Location: path
Description: The REST ID of the product.
Required: Yes
Type: string
merchantId
Description: The ID of the account that contains the product. This account cannot be a multi-client account.
Type: string
Location: path
Required: Yes
Format: uint64
HTTP Method: GET
Flat Path: {merchantId}/products/{productId}
▼ ▲ content.products.custombatch
Scopes: https://www.googleapis.com/auth/content
Parameters:
dryRun
Type: boolean
Location: query
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
HTTP Method: POST
Path: products/batch
Flat Path: products/batch
Description: Retrieves, inserts, and deletes multiple products in a single request.
▼ ▲ content.products.list
Parameter Order: merchantId
Description: Lists the products in your Merchant Center account. The response might contain fewer items than specified by maxResults. Rely on nextPageToken to determine if there are more items to be requested.
Parameters:
pageToken
Location: query
Type: string
Description: The token returned by the previous request.
includeInvalidInsertedItems
Location: query
Description: Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false).
Type: boolean
maxResults
Format: uint32
Description: The maximum number of products to return in the response, used for paging.
Type: integer
Location: query
merchantId
Required: Yes
Format: uint64
Description: The ID of the account that contains the products. This account cannot be a multi-client account.
Type: string
Location: path
Path: {merchantId}/products
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/content
Flat Path: {merchantId}/products
▼ ▲ content.datafeeds.get
Description: Retrieves a datafeed configuration from your Merchant Center account.
Parameter Order:
Path: {merchantId}/datafeeds/{datafeedId}
Scopes: https://www.googleapis.com/auth/content
HTTP Method: GET
Parameters:
merchantId
Location: path
Type: string
Description: The ID of the account that manages the datafeed. This account cannot be a multi-client account.
Format: uint64
Required: Yes
datafeedId
Required: Yes
Location: path
Format: uint64
Description: The ID of the datafeed.
Type: string
Flat Path: {merchantId}/datafeeds/{datafeedId}
▼ ▲ content.datafeeds.custombatch
Scopes: https://www.googleapis.com/auth/content
Flat Path: datafeeds/batch
Parameters:
dryRun
Type: boolean
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Location: query
HTTP Method: POST
Description: Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.
Path: datafeeds/batch
▼ ▲ content.datafeeds.delete
HTTP Method: DELETE
Path: {merchantId}/datafeeds/{datafeedId}
Parameters:
datafeedId
Required: Yes
Description: The ID of the datafeed.
Format: uint64
Type: string
Location: path
dryRun
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Location: query
Type: boolean
merchantId
Type: string
Format: uint64
Description: The ID of the account that manages the datafeed. This account cannot be a multi-client account.
Required: Yes
Location: path
Description: Deletes a datafeed configuration from your Merchant Center account.
Parameter Order:
Scopes: https://www.googleapis.com/auth/content
Flat Path: {merchantId}/datafeeds/{datafeedId}
▼ ▲ content.datafeeds.insert
Description: Registers a datafeed configuration with your Merchant Center account.
Parameters:
merchantId
Description: The ID of the account that manages the datafeed. This account cannot be a multi-client account.
Location: path
Format: uint64
Type: string
Required: Yes
dryRun
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Location: query
Type: boolean
Parameter Order: merchantId
Scopes: https://www.googleapis.com/auth/content
Path: {merchantId}/datafeeds
HTTP Method: POST
Flat Path: {merchantId}/datafeeds
▼ ▲ content.datafeeds.list
Flat Path: {merchantId}/datafeeds
Parameter Order: merchantId
Path: {merchantId}/datafeeds
Parameters:
merchantId
Format: uint64
Description: The ID of the account that manages the datafeeds. This account cannot be a multi-client account.
Required: Yes
Type: string
Location: path
maxResults
Location: query
Type: integer
Description: The maximum number of products to return in the response, used for paging.
Format: uint32
pageToken
Description: The token returned by the previous request.
Type: string
Location: query
HTTP Method: GET
Description: Lists the configurations for datafeeds in your Merchant Center account.
▼ ▲ content.datafeeds.update
HTTP Method: PUT
Flat Path: {merchantId}/datafeeds/{datafeedId}
Parameter Order:
Parameters:
datafeedId
Location: path
Description: The ID of the datafeed.
Required: Yes
Type: string
Format: uint64
merchantId
Required: Yes
Location: path
Description: The ID of the account that manages the datafeed. This account cannot be a multi-client account.
Format: uint64
Type: string
dryRun
Location: query
Type: boolean
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Path: {merchantId}/datafeeds/{datafeedId}
Scopes: https://www.googleapis.com/auth/content
Description: Updates a datafeed configuration of your Merchant Center account. Any fields that are not provided are deleted from the resource.
▼ ▲ content.datafeeds.fetchnow
Scopes: https://www.googleapis.com/auth/content
Path: {merchantId}/datafeeds/{datafeedId}/fetchNow
Parameters:
merchantId
Format: uint64
Description: The ID of the account that manages the datafeed. This account cannot be a multi-client account.
Required: Yes
Location: path
Type: string
dryRun
Type: boolean
Location: query
Description: Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
datafeedId
Description: The ID of the datafeed to be fetched.
Format: uint64
Location: path
Required: Yes
Type: string
Flat Path: {merchantId}/datafeeds/{datafeedId}/fetchNow
HTTP Method: POST
Description: 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 service to update your product data.
Parameter Order:
▼ ▲ content.orderreturns.get
Parameters:
returnId
Location: path
Type: string
Required: Yes
Description: Merchant order return ID generated by Google.
merchantId
Required: Yes
Format: uint64
Type: string
Location: path
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Scopes: https://www.googleapis.com/auth/content
HTTP Method: GET
Description: Retrieves an order return from your Merchant Center account.
Parameter Order:
Path: {merchantId}/orderreturns/{returnId}
Flat Path: {merchantId}/orderreturns/{returnId}
▼ ▲ content.orderreturns.list
Scopes: https://www.googleapis.com/auth/content
Parameters:
maxResults
Format: uint32
Type: integer
Location: query
Description: The maximum number of order returns to return in the response, used for paging. The default value is 25 returns per page, and the maximum allowed value is 250 returns per page.
orderBy
Description: Return the results in the specified order.
Type: string
Enum:
Location: query
Enum Descriptions:
merchantId
Format: uint64
Location: path
Description: The ID of the account that manages the order. This cannot be a multi-client account.
Required: Yes
Type: string
pageToken
Location: query
Description: The token returned by the previous request.
Type: string
createdEndDate
Type: string
Location: query
Description: Obtains order returns created before this date (inclusively), in ISO 8601 format.
createdStartDate
Location: query
Description: Obtains order returns created after this date (inclusively), in ISO 8601 format.
Type: string
HTTP Method: GET
Path: {merchantId}/orderreturns
Description: Lists order returns in your Merchant Center account.
Flat Path: {merchantId}/orderreturns
Parameter Order: merchantId