### Product Methods Source: https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products This section covers the methods available for the Product resource, including 'get' and 'list'. ```APIDOC ## Product Methods This section details the methods available for the Product resource. ### Methods * `get`: Retrieves a specific product. * `list`: Lists all products. ``` -------------------------------- ### ProductInstallment Object Source: https://developers.google.com/merchant/api/reference/rest/products_v1/ProductAttributes Represents installment payment details for a product, including months, amount, downpayment, credit type, APR, and total amount. ```APIDOC ## ProductInstallment A message that represents installment. JSON representation --- ```json { "months": string, "amount": { object (Price) }, "downpayment": { object (Price) }, "creditType": enum (CreditType), "annualPercentageRate": number, "totalAmount": { object (Price) } } ``` Fields --- `months` | `string (int64 format)` The number of installments the buyer has to pay. `amount` | `object (Price)` The amount the buyer has to pay per month. `downpayment` | `object (Price)` The up-front down payment amount the buyer has to pay. `creditType` | `enum (CreditType)` Type of installment payments. `annualPercentageRate` | `number` Optional. Annual percentage rate for `creditType` finance. `totalAmount` | `object (Price)` Optional. Total amount the buyer has to pay, including interest. ``` -------------------------------- ### ProductInstallment JSON Structure Source: https://developers.google.com/merchant/api/reference/rest/products_v1/ProductAttributes Defines the JSON structure for representing product installment information, including payment terms and amounts. ```json { "months": string, "amount": { object (Price) }, "downpayment": { object (Price) }, "creditType": enum (CreditType), "annualPercentageRate": number, "totalAmount": { object (Price) } } ``` -------------------------------- ### Trigger Action (v1beta) Source: https://developers.google.com/merchant/api/reference/rest Starts an action for a business account using the v1beta API. ```APIDOC ## POST /issueresolution/v1beta/{name=accounts/*}:triggeraction ### Description Start an action. ### Method POST ### Endpoint /issueresolution/v1beta/{name=accounts/*}:triggeraction ``` -------------------------------- ### Trigger Action (v1) Source: https://developers.google.com/merchant/api/reference/rest Starts an action for a business account using the v1 API. ```APIDOC ## POST /issueresolution/v1/{name=accounts/*}:triggeraction ### Description Start an action. ### Method POST ### Endpoint /issueresolution/v1/{name=accounts/*}:triggeraction ``` -------------------------------- ### HTTP Request for Products List Source: https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products/list This is the base HTTP GET request to list processed products for a given account. The URL uses gRPC Transcoding syntax. ```http GET https://merchantapi.googleapis.com/products/v1/{parent=accounts/*}/products ``` -------------------------------- ### get Source: https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.termsOfServiceAgreementStates Returns the state of a terms of service agreement for a specific account and region. ```APIDOC ## GET accounts.termsOfServiceAgreementStates.get ### Description Retrieves the state of a terms of service agreement for a given account and terms of service kind. ### Endpoint accounts.termsOfServiceAgreementStates.get ### Parameters #### Path Parameters - **name** (string) - Required - The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` ``` -------------------------------- ### HTTP Request for accounts.limits.list Source: https://developers.google.com/merchant/api/reference/rest/quota_v1/accounts.limits/list This is the base HTTP GET request to list account limits. Ensure you replace `{parent=accounts/*}` with the correct account identifier. ```http GET https://merchantapi.googleapis.com/quota/v1/{parent=accounts/*}/limits ``` -------------------------------- ### get Source: https://developers.google.com/merchant/api/reference/rest/notifications_v1/accounts.notificationsubscriptions Gets notification subscriptions for an account. ```APIDOC ## GET accounts.notificationsubscriptions/{notificationSubscription} ### Description Gets notification subscriptions for an account. ### Method GET ### Endpoint `accounts/{account}/notificationsubscriptions/{notificationSubscription}` ### Parameters #### Path Parameters - **notificationSubscription** (string) - Required - The name of the notification subscription to retrieve. Format: `accounts/{account}/notificationsubscriptions/{notificationSubscription}`. ### Response #### Success Response (200) - **name** (string) - Output only. The `name` of the notification configuration. - **registeredEvent** (enum (NotificationEventType)) - The event that the merchant wants to be notified about. - **callBackUri** (string) - URL to be used to push the notification to the merchant. - **allManagedAccounts** (boolean) - If true, the requesting account is notified of the specified event for all managed accounts. - **targetAccount** (string) - The `name` of the account you want to receive notifications for. ``` -------------------------------- ### Get Data Source Source: https://developers.google.com/merchant/api/reference/rest/datasources_v1/accounts.dataSources Retrieves details of a specific data source. Use this to get information about an existing data source configuration. ```APIDOC ## GET /accounts.dataSources/{dataSourceId} ### Description Retrieves a data source. ### Method GET ### Endpoint `/accounts.dataSources/{dataSourceId}` ### Parameters #### Path Parameters - **dataSourceId** (string) - Required - The ID of the data source to retrieve. ``` -------------------------------- ### Product Identifier Formats Source: https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.regionalInventories/list Demonstrates the two formats for specifying the product identifier in the `parent` path parameter: Encoded Format (recommended for special characters) and Plain Format. ```text 1. **Encoded Format** : The `{product}` segment is an **unpadded base64url** encoded string (RFC 4648 Section 5). The decoded string must result in the `contentLanguage~feedLabel~offerId` structure. This encoding MUST be used if any part of the product identifier (like `offerId`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format** : The `{product}` segment is the tilde-separated string `contentLanguage~feedLabel~offerId`. This format is suitable only when `contentLanguage`, `feedLabel`, and `offerId` do not contain URL-problematic characters like `/`, `%`, or `~`. ``` -------------------------------- ### accounts.programs.get Source: https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.programs/get Retrieves the specified program for the account. Stay organized with collections. Save and categorize content based on your preferences. ```APIDOC ## GET accounts.programs.get ### Description Retrieves the specified program for the account. Stay organized with collections. Save and categorize content based on your preferences. ### Method GET ### Endpoint `https://merchantapi.googleapis.com/accounts/v1/{name=accounts/*/programs/*}` ### Path Parameters * **name** (string) - Required. The name of the program to retrieve. Format: `accounts/{account}/programs/{program}`. For example, `accounts/123456/programs/free-listings`. ### Request Body The request body must be empty. ### Response Body If successful, the response body contains an instance of `Program`. ### Authorization Scopes * `https://www.googleapis.com/auth/content` ``` -------------------------------- ### Get LFP Merchant State Source: https://developers.google.com/merchant/api/reference/rest/lfp_v1/accounts.lfpMerchantStates/get Retrieves the LFP state of a specific merchant. This method requires authentication and uses a GET request to the specified endpoint. ```APIDOC ## GET accounts.lfpMerchantStates.get ### Description Gets the LFP state of a merchant. ### Method GET ### Endpoint `https://merchantapi.googleapis.com/lfp/v1/{name=accounts/*/lfpMerchantStates/*}` ### Parameters #### Path Parameters - **name** (string) - Required. The name of the state to retrieve. Format: `accounts/{account}/lfpMerchantStates/{target_merchant}`. For example, `accounts/123456/lfpMerchantStates/567890`. ### Request Body The request body must be empty. ### Response #### Success Response (200) Returns an instance of `LfpMerchantState`. ### Authorization scopes Requires the following OAuth scope: - `https://www.googleapis.com/auth/content` ``` -------------------------------- ### lfp_v1beta.accounts.lfpMerchantStates.get Source: https://developers.google.com/merchant/api/reference/rest Gets the LFP state of a merchant. ```APIDOC ## GET /lfp/v1beta/{name=accounts/*/lfpMerchantStates/*} ### Description Gets the LFP state of a merchant. ### Method GET ### Endpoint /lfp/v1beta/{name=accounts/*/lfpMerchantStates/*} ``` -------------------------------- ### notifications_v1.accounts.notificationsubscriptions.list Source: https://developers.google.com/merchant/api/reference/rest Gets all the notification subscriptions for a merchant. ```APIDOC ## GET /notifications/v1/{parent=accounts/*}/notificationsubscriptions ### Description Gets all the notification subscriptions for a merchant. ### Method GET ### Endpoint /notifications/v1/{parent=accounts/*}/notificationsubscriptions ``` -------------------------------- ### accounts.dataSources.list Source: https://developers.google.com/merchant/api/reference/rest/datasources_v1/accounts.dataSources/list Lists the configurations for data sources for the given account. Stay organized with collections. Save and categorize content based on your preferences. ```APIDOC ## GET https://merchantapi.googleapis.com/datasources/v1/{parent=accounts/*}/dataSources ### Description Lists the configurations for data sources for the given account. ### Method GET ### Endpoint https://merchantapi.googleapis.com/datasources/v1/{parent=accounts/*}/dataSources ### Parameters #### Path Parameters - **parent** (string) - Required. The account to list data sources for. Format: `accounts/{account}` #### Query Parameters - **pageSize** (integer) - Optional. The maximum number of data sources to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of data sources will be returned. - **pageToken** (string) - Optional. A page token, received from a previous `dataSources.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `dataSources.list` must match the call that provided the page token. ### Request Body The request body must be empty. ### Response #### Success Response (200) - **dataSources** (array of DataSource objects) - The data sources from the specified account. - **nextPageToken** (string) - A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. ### Response Example ```json { "dataSources": [ { "object (DataSource)" } ], "nextPageToken": "string" } ``` ### Authorization scopes Requires the following OAuth scope: - `https://www.googleapis.com/auth/content` ``` -------------------------------- ### notifications_v1.accounts.notificationsubscriptions.get Source: https://developers.google.com/merchant/api/reference/rest Gets notification subscriptions for an account. ```APIDOC ## GET /notifications/v1/{name=accounts/*/notificationsubscriptions/*} ### Description Gets notification subscriptions for an account. ### Method GET ### Endpoint /notifications/v1/{name=accounts/*/notificationsubscriptions/*} ``` -------------------------------- ### create Source: https://developers.google.com/merchant/api/reference/rest/ordertracking_v1/accounts.orderTrackingSignals Creates a new order tracking signal. ```APIDOC ## create ### Description Creates new order tracking signal. ### Method POST ### Endpoint /orderTrackingSignals ### Request Body - **trackingId** (string) - Required - The tracking ID for the order. - **carrier** (string) - Required - The carrier of the shipment. - **shipmentInfo** (object) - Required - Information about the shipment. - **packageName** (string) - Optional - The name of the package. - **packageWeight** (object) - Optional - The weight of the package. - **value** (number) - Required - The weight value. - **unit** (string) - Required - The unit of weight (e.g., "kg", "lb"). - **shipmentEvents** (array) - Optional - A list of shipment events. - **eventTime** (string) - Required - The time the event occurred (ISO 8601 format). - **eventDescription** (string) - Required - A description of the event. - **eventLocation** (object) - Optional - The location of the event. - **country** (string) - Optional - The country where the event occurred. - **state** (string) - Optional - The state or province where the event occurred. - **city** (string) - Optional - The city where the event occurred. - **zipCode** (string) - Optional - The zip or postal code where the event occurred. ### Response #### Success Response (200) - **trackingId** (string) - The tracking ID for the order. - **carrier** (string) - The carrier of the shipment. - **status** (string) - The current status of the shipment. - **estimatedDelivery** (string) - The estimated delivery date. #### Response Example ```json { "trackingId": "1Z999AA10123456784", "carrier": "UPS", "status": "IN_TRANSIT", "estimatedDelivery": "2023-10-27T10:00:00Z" } ``` ``` -------------------------------- ### notifications_v1beta.accounts.notificationsubscriptions.list Source: https://developers.google.com/merchant/api/reference/rest Gets all the notification subscriptions for a merchant. ```APIDOC ## GET /notifications/v1beta/{parent=accounts/*}/notificationsubscriptions ### Description Gets all the notification subscriptions for a merchant. ### Method GET ### Endpoint `/notifications/v1beta/{parent=accounts/*}/notificationsubscriptions` ``` -------------------------------- ### accounts_v1.accounts.createAndConfigure Source: https://developers.google.com/merchant/api/reference/rest Creates a Merchant Center account with additional configuration. ```APIDOC ## POST /accounts/v1/accounts:createAndConfigure ### Description Creates a Merchant Center account with additional configuration. ### Method POST ### Endpoint /accounts/v1/accounts:createAndConfigure ``` -------------------------------- ### notifications_v1beta.accounts.notificationsubscriptions.get Source: https://developers.google.com/merchant/api/reference/rest Gets notification subscriptions for an account. ```APIDOC ## GET /notifications/v1beta/{name=accounts/*/notificationsubscriptions/*} ### Description Gets notification subscriptions for an account. ### Method GET ### Endpoint `/notifications/v1beta/{name=accounts/*/notificationsubscriptions/*}` ``` -------------------------------- ### get (youtube_v1alpha.accounts.contracts) Source: https://developers.google.com/merchant/api/reference/rest Retrieves the specified contract. ```APIDOC ## GET /youtube/v1alpha/{name=accounts/*/contracts/*} ### Description Retrieves the specified contract. ### Method GET ### Endpoint /youtube/v1alpha/{name=accounts/*/contracts/*} ``` -------------------------------- ### accounts_v1beta.accounts.createAndConfigure Source: https://developers.google.com/merchant/api/reference/rest Creates a Merchant Center account with additional configuration. ```APIDOC ## POST /accounts/v1beta/accounts:createAndConfigure ### Description Creates a Merchant Center account with additional configuration. ### Method POST ### Endpoint `/accounts/v1beta/accounts:createAndConfigure` ``` -------------------------------- ### Product Inputs Resource (v1beta) Source: https://developers.google.com/merchant/api/reference/rest Details the 'productInputs' resource for managing product inputs in the products API, v1beta. ```APIDOC ## REST Resource: products_v1beta.accounts.productInputs ### Description Manages product input data for a merchant account. ### Endpoint `/products_v1beta/accounts/{accountId}/productInputs` ``` -------------------------------- ### accounts.notificationsubscriptions.list Source: https://developers.google.com/merchant/api/reference/rest/notifications_v1/accounts.notificationsubscriptions/list Gets all the notification subscriptions for a merchant. ```APIDOC ## GET https://merchantapi.googleapis.com/notifications/v1/{parent=accounts/*}/notificationsubscriptions ### Description Gets all the notification subscriptions for a merchant. ### Method GET ### Endpoint https://merchantapi.googleapis.com/notifications/v1/{parent=accounts/*}/notificationsubscriptions ### Parameters #### Path Parameters - **parent** (string) - Required. The merchant account who owns the notification subscriptions. Format: `accounts/{account}` #### Query Parameters - **pageSize** (integer) - Optional. The maximum number of notification subscriptions to return in a page. The default value for `pageSize` is 100. The maximum value is `200`. Values above `200` will be coerced to `200`. - **pageToken** (string) - Optional. Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token. ### Request Body The request body must be empty. ### Response #### Success Response (200) - **notificationSubscriptions** (array of objects) - The list of notification subscriptions requested by the merchant. - **nextPageToken** (string) - A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. #### Response Example ```json { "notificationSubscriptions": [ { "object (NotificationSubscription)" } ], "nextPageToken": "string" } ``` ### Authorization scopes Requires the following OAuth scope: - `https://www.googleapis.com/auth/content` ``` -------------------------------- ### list Source: https://developers.google.com/merchant/api/reference/rest/notifications_v1/accounts.notificationsubscriptions Gets all the notification subscriptions for a merchant. ```APIDOC ## GET accounts.notificationsubscriptions ### Description Gets all the notification subscriptions for a merchant. ### Method GET ### Endpoint `accounts/{account}/notificationsubscriptions` ### Response #### Success Response (200) - **name** (string) - Output only. The `name` of the notification configuration. - **registeredEvent** (enum (NotificationEventType)) - The event that the merchant wants to be notified about. - **callBackUri** (string) - URL to be used to push the notification to the merchant. - **allManagedAccounts** (boolean) - If true, the requesting account is notified of the specified event for all managed accounts. - **targetAccount** (string) - The `name` of the account you want to receive notifications for. ``` -------------------------------- ### HTTP Request for Inserting a Promotion Source: https://developers.google.com/merchant/api/reference/rest/promotions_v1/accounts.promotions/insert This snippet shows the HTTP POST request structure for inserting a promotion. It includes the endpoint and the required `parent` path parameter format. ```http POST https://merchantapi.googleapis.com/promotions/v1/{parent=accounts/*}/promotions:insert ``` -------------------------------- ### triggeraction Source: https://developers.google.com/merchant/api/reference/rest/issueresolution_v1/issueresolution Starts an action to resolve an issue. ```APIDOC ## triggeraction ### Description Starts an action that needs to be performed to solve a problem represented by a reason. ### Method POST (assumed, as it initiates an action) ### Endpoint /v1/issueresolution/actions/trigger (assumed) ### Parameters #### Request Body - **actionId** (string) - Required - The identifier of the action to trigger. - **context** (object) - Optional - Additional context for the action. ### Request Example ```json { "actionId": "some_action_id", "context": { "productId": "some_product_id" } } ``` ### Response #### Success Response (200) - `status` (string) - Indicates the status of the triggered action. #### Response Example ```json { "status": "success" } ``` ``` -------------------------------- ### accounts.programs.checkoutSettings.create Source: https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.programs.checkoutSettings/create Creates CheckoutSettings for the given merchant. This operation requires the `https://www.googleapis.com/auth/content` OAuth scope. ```APIDOC ## POST accounts.programs.checkoutSettings.create ### Description Creates `CheckoutSettings` for the given merchant. ### Method POST ### Endpoint `https://merchantapi.googleapis.com/accounts/v1/{parent=accounts/*/programs/*}/checkoutSettings` ### Parameters #### Path Parameters - **parent** (string) - Required. The merchant account for which the `CheckoutSettings` will be created. #### Request Body The request body contains an instance of `CheckoutSettings`. ### Response Body If successful, the response body contains a newly created instance of `CheckoutSettings`. ### Authorization Scopes - `https://www.googleapis.com/auth/content` ``` -------------------------------- ### get (youtube_v1alpha.accounts.contracts.commissionGroups) Source: https://developers.google.com/merchant/api/reference/rest Retrieves the specified commission group. ```APIDOC ## GET /youtube/v1alpha/{name=accounts/*/contracts/*/commissionGroups/*} ### Description Retrieves the specified commission group. ### Method GET ### Endpoint /youtube/v1alpha/{name=accounts/*/contracts/*/commissionGroups/*} ``` -------------------------------- ### reviews_v1beta.accounts.productReviews.insert Source: https://developers.google.com/merchant/api/reference/rest Inserts a new product review using the v1beta API. ```APIDOC ## POST /reviews/v1beta/{parent=accounts/*}/productReviews:insert ### Description Inserts a product review. ### Method POST ### Endpoint /reviews/v1beta/{parent=accounts/*}/productReviews:insert ``` -------------------------------- ### Get Conversion Source Source: https://developers.google.com/merchant/api/reference/rest/conversions_v1/accounts.conversionSources Fetches a conversion source. ```APIDOC ## GET /conversions/v1/accounts/{accountId}/conversionSources/{conversionSourceId} ### Description Fetches a conversion source. ### Method GET ### Endpoint /conversions/v1/accounts/{accountId}/conversionSources/{conversionSourceId} ### Response (Schema not provided in source) ``` -------------------------------- ### productstudio_v1alpha.accounts.textSuggestions.generateProductTextSuggestions Source: https://developers.google.com/merchant/api/reference/rest Generates a set of candidate text completions for product titles and descriptions based on provided product information. ```APIDOC ## POST /productstudio/v1alpha/{name=accounts/*}:generateProductTextSuggestions ### Description GenerateProductTextSuggestions generates a set of candidate text completions (e.g., product titles, descriptions) based on provided product information. ### Method POST ### Endpoint /productstudio/v1alpha/{name=accounts/*}:generateProductTextSuggestions ``` -------------------------------- ### accounts.createAndConfigure Source: https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts/createAndConfigure Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account. ```APIDOC ## POST https://merchantapi.googleapis.com/accounts/v1/accounts:createAndConfigure ### Description Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account. ### Method POST ### Endpoint https://merchantapi.googleapis.com/accounts/v1/accounts:createAndConfigure ### Request Body - **account** (object) - Required. The account to be created. - **user[]** (object) - Optional. Users to be added to the account. - **service[]** (object) - Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently exactly one of these needs to be `accountAggregation` and `accounts.createAndConfigure` method can be used to create a sub-account under an existing advanced account through this method. Additional `accountManagement` or `productsManagement` services may be provided. - **setAlias[]** (object) - Optional. If a relationship is created with a provider, you can set an alias for it with this field. The calling user must be an admin on the provider to be able to set an alias. ### Request Example ```json { "account": {}, "user": [ { "userId": "string", "user": {}, "verificationMailSettings": {} } ], "service": [ {} ], "setAlias": [ {} ] } ``` ### Response #### Success Response (200) - **Account** (object) - If successful, the response body contains an instance of `Account`. ### Authorization scopes - https://www.googleapis.com/auth/content ``` -------------------------------- ### accounts.omnichannelSettings.get Source: https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings/get Get the omnichannel settings for a given merchant. ```APIDOC ## GET accounts.omnichannelSettings.get ### Description Get the omnichannel settings for a given merchant. ### Method GET ### Endpoint `https://merchantapi.googleapis.com/accounts/v1/{name=accounts/*/omnichannelSettings/*}` ### Path Parameters - **name** (string) - Required. The name of the omnichannel setting to retrieve. Format: `accounts/{account}/omnichannelSettings/{omnichannelSetting}` ### Request Body The request body must be empty. ### Response Body If successful, the response body contains an instance of `OmnichannelSetting`. ### Authorization Scopes - `https://www.googleapis.com/auth/content` ``` -------------------------------- ### lfp_v1.accounts.lfpMerchantStates.get Source: https://developers.google.com/merchant/api/reference/rest Gets the LFP state of a merchant using the lfp_v1 API. ```APIDOC ## GET /lfp/v1/{name=accounts/*/lfpMerchantStates/*} ### Description Gets the LFP state of a merchant. ### Method GET ### Endpoint /lfp/v1/{name=accounts/*/lfpMerchantStates/*} ``` -------------------------------- ### List Data Sources Source: https://developers.google.com/merchant/api/reference/rest/datasources_v1/accounts.dataSources Lists all data source configurations for the specified account. ```APIDOC ## list ### Description Lists the configurations for data sources for the given account. ### Method GET ### Endpoint /accounts/{accountId}/dataSources ``` -------------------------------- ### get Source: https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products Retrieves a specific processed product from your Merchant Center account. ```APIDOC ## GET /products/{productId} ### Description Retrieves the processed product from your Merchant Center account. ### Method GET ### Endpoint /products/{productId} ``` -------------------------------- ### create (youtube_v1alpha.accounts.contracts) Source: https://developers.google.com/merchant/api/reference/rest Creates a new contract. ```APIDOC ## POST /youtube/v1alpha/{parent=accounts/*}/contracts ### Description Creates a new contract. ### Method POST ### Endpoint /youtube/v1alpha/{parent=accounts/*}/contracts ``` -------------------------------- ### Get Account Limit Source: https://developers.google.com/merchant/api/reference/rest/quota_v1/accounts.limits Retrieves a specific account limit by its identifier. ```APIDOC ## GET /accounts/{accountId}/limits/{limitId} ### Description Retrieves a specific account limit. ### Method GET ### Endpoint `/accounts/{accountId}/limits/{limitId}` ### Parameters #### Path Parameters - **accountId** (string) - Required - The ID of the account. - **limitId** (string) - Required - The ID of the limit to retrieve. ### Response #### Success Response (200) - **name** (string) - Identifier for the limit. - **products** (object) - The limit for products. - **scope** (enum Scope) - Required. The scope of the product limit. - **limit** (string (int64 format)) - Required. The maximum number of products allowed. ``` -------------------------------- ### CreditType Enum Source: https://developers.google.com/merchant/api/reference/rest/products_v1/ProductAttributes Defines the type of installment payments available for a product. ```APIDOC ## CreditType Type of installment payments. Enums --- `CREDIT_TYPE_UNSPECIFIED` | Default value. This value is unused. `FINANCE` | Finance. `LEASE` | Lease. ``` -------------------------------- ### accounts.programs.list Source: https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.programs/list Retrieves all programs for the account. Stay organized with collections. Save and categorize content based on your preferences. ```APIDOC ## GET accounts.programs.list ### Description Retrieves all programs for the account. ### Method GET ### Endpoint `https://merchantapi.googleapis.com/accounts/v1/{parent=accounts/*}/programs` ### Path parameters #### Path Parameters - **parent** (string) - Required. The name of the account for which to retrieve all programs. Format: `accounts/{account}` ### Query parameters #### Query Parameters - **pageSize** (integer) - Optional. The maximum number of programs to return in a single response. If unspecified (or 0), a default size of 1000 is used. The maximum value is 1000; values above 1000 will be coerced to 1000. - **pageToken** (string) - Optional. A continuation token, received from a previous `programs.list` call. Provide this to retrieve the next page. ### Request Body The request body must be empty. ### Response Body #### Success Response (200) - **programs** (array) - The programs for the given account. Each element is an object of type `Program`. - **nextPageToken** (string) - A token that can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. ### Authorization scopes Requires the following OAuth scope: - `https://www.googleapis.com/auth/content` ``` -------------------------------- ### productstudio_v1alpha.accounts.generatedImages.generateProductImageBackground Source: https://developers.google.com/merchant/api/reference/rest Generates a new product image with an AI-generated background based on product information and a text prompt. ```APIDOC ## POST /productstudio/v1alpha/{name=accounts/*}/generatedImages:generateProductImageBackground ### Description GenerateProductImageBackground generates a new image where the background of the original image is replaced by an AI generated scene based on provided product information and a text prompt. ### Method POST ### Endpoint /productstudio/v1alpha/{name=accounts/*}/generatedImages:generateProductImageBackground ``` -------------------------------- ### Get Data Source Source: https://developers.google.com/merchant/api/reference/rest/datasources_v1/accounts.dataSources Retrieves the data source configuration for the specified account. ```APIDOC ## get ### Description Retrieves the data source configuration for the given account. ### Method GET ### Endpoint /accounts/{accountId}/dataSources/{dataSourceId} ``` -------------------------------- ### Products Resource (v1beta) Source: https://developers.google.com/merchant/api/reference/rest Details the 'products' resource for managing products in the products API, v1beta. ```APIDOC ## REST Resource: products_v1beta.accounts.products ### Description Manages product information for a merchant account. ### Endpoint `/products_v1beta/accounts/{accountId}/products` ``` -------------------------------- ### reviews_v1beta.accounts.productReviews.list Source: https://developers.google.com/merchant/api/reference/rest Lists all product reviews for an account using the v1beta API. ```APIDOC ## GET /reviews/v1beta/{parent=accounts/*}/productReviews ### Description Lists product reviews. ### Method GET ### Endpoint /reviews/v1beta/{parent=accounts/*}/productReviews ``` -------------------------------- ### Get Online Return Policy Source: https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.onlineReturnPolicies/get Retrieves an existing return policy for a given business. ```APIDOC ## GET accounts.onlineReturnPolicies.get ### Description Gets an existing return policy for a given business. ### Method GET ### Endpoint `https://merchantapi.googleapis.com/accounts/v1/{name=accounts/*/onlineReturnPolicies/*}` ### Path Parameters #### name (string) - Required The name of the return policy to retrieve. Format: `accounts/{account}/onlineReturnPolicies/{return_policy}` ### Request Body The request body must be empty. ### Response Body If successful, the response body contains an instance of `OnlineReturnPolicy`. ### Authorization Scopes Requires the following OAuth scope: * `https://www.googleapis.com/auth/content` ``` -------------------------------- ### conversions_v1.accounts.conversionSources.create Source: https://developers.google.com/merchant/api/reference/rest Creates a new conversion source for a given account. ```APIDOC ## POST /conversions/v1/{parent=accounts/*}/conversionSources ### Description Creates a new conversion source. ### Method POST ### Endpoint `/conversions/v1/{parent=accounts/*}/conversionSources` ``` -------------------------------- ### FetchSettings Source: https://developers.google.com/merchant/api/reference/rest/datasources_v1/accounts.dataSources Defines the settings for fetching data source files, including schedule, frequency, and credentials. ```APIDOC ## FetchSettings ### Description Fetch details to deliver the data source. This includes configuration for scheduling, frequency, and the source location. ### JSON Representation ```json { "enabled": boolean, "dayOfMonth": integer, "timeOfDay": { object (TimeOfDay) }, "dayOfWeek": enum (DayOfWeek), "timeZone": string, "frequency": enum (Frequency), "fetchUri": string, "username": string, "password": string } ``` ### Fields `enabled` | `boolean` Optional. Enables or pauses the fetch schedule. `dayOfMonth` | `integer` Optional. The day of the month when the data source file should be fetched (1-31). This field can only be set for monthly frequency. `timeOfDay` | `object (TimeOfDay)` Optional. The hour of the day when the data source file should be fetched. Minutes and seconds are not supported and will be ignored. `dayOfWeek` | `enum (DayOfWeek)` Optional. The day of the week when the data source file should be fetched. This field can only be set for weekly frequency. `timeZone` | `string` Optional. Time zone used for schedule. UTC by default. For example, "America/Los_Angeles". `frequency` | `enum (Frequency)` Required. The frequency describing fetch schedule. `fetchUri` | `string` Optional. The URL where the data source file can be fetched. Google Merchant Center supports automatic scheduled uploads using the HTTP, HTTPS or SFTP protocols, so the value will need to be a valid link using one of those three protocols. Immutable for Google Sheets files. `username` | `string` Optional. An optional user name for `fetchUri`. Used for submitting data sources through SFTP. `password` | `string` Optional. An optional password for `fetchUri`. Used for submitting data sources through SFTP. ``` -------------------------------- ### create Source: https://developers.google.com/merchant/api/reference/rest/notifications_v1/accounts.notificationsubscriptions Creates a notification subscription for a business. ```APIDOC ## POST accounts.notificationsubscriptions ### Description Creates a notification subscription for a business. ### Method POST ### Endpoint `accounts/{account}/notificationsubscriptions` ### Request Body - **registeredEvent** (enum (NotificationEventType)) - Required - The event that the merchant wants to be notified about. - **callBackUri** (string) - Required - URL to be used to push the notification to the merchant. - **allManagedAccounts** (boolean) - Optional - If true, the requesting account is notified of the specified event for all managed accounts. - **targetAccount** (string) - Optional - The `name` of the account you want to receive notifications for. Format: `accounts/{account}`. ### Response #### Success Response (200) - **name** (string) - Output only. The `name` of the notification configuration. - **registeredEvent** (enum (NotificationEventType)) - The event that the merchant wants to be notified about. - **callBackUri** (string) - URL to be used to push the notification to the merchant. - **allManagedAccounts** (boolean) - If true, the requesting account is notified of the specified event for all managed accounts. - **targetAccount** (string) - The `name` of the account you want to receive notifications for. ``` -------------------------------- ### Get Terms of Service Agreement State Source: https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.termsOfServiceAgreementStates/get Retrieves the state of a specific terms of service agreement for an account. ```APIDOC ## GET accounts.termsOfServiceAgreementStates.get ### Description Returns the state of a terms of service agreement. ### Method GET ### Endpoint `https://merchantapi.googleapis.com/accounts/v1/{name=accounts/*/termsOfServiceAgreementStates/*}` ### Path Parameters * **name** (string) - Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementStates/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` ### Request Body The request body must be empty. ### Response Body If successful, the response body contains an instance of `TermsOfServiceAgreementState`. ### Authorization Scopes Requires the following OAuth scope: * `https://www.googleapis.com/auth/content` ``` -------------------------------- ### Create Data Source Source: https://developers.google.com/merchant/api/reference/rest/datasources_v1/accounts.dataSources Creates a new data source configuration for the specified account. ```APIDOC ## create ### Description Creates the new data source configuration for the given account. ### Method POST ### Endpoint /accounts/{accountId}/dataSources ``` -------------------------------- ### products_v1beta.accounts.productInputs.insert Source: https://developers.google.com/merchant/api/reference/rest Uploads a product input to your Merchant Center account. ```APIDOC ## POST /products/v1beta/{parent=accounts/*}/productInputs:insert ### Description Uploads a product input to your Merchant Center account. ### Method POST ### Endpoint /products/v1beta/{parent=accounts/*}/productInputs:insert ``` -------------------------------- ### Trigger Action Source: https://developers.google.com/merchant/api/reference/rest/issueresolution_v1/issueresolution/triggeraction Starts an action that can be requested by a business in a third-party application. Access to this method is restricted to an allowlist. ```APIDOC ## POST issueresolution.triggeraction ### Description Start an action. The action can be requested by a business in third-party application. Before the business can request the action, the third-party application needs to show them action specific content and display a user input form. Access to the `triggeraction` method is restricted to an allowlist. You can submit an allowlist request in the Shopping API Support Form under "What is the issue/question?" to get access to this feature. The action can be successfully started only once all `required` inputs are provided. If any `required` input is missing, or invalid value was provided, the service will return 400 error. Validation errors will contain `Ids` for all problematic field together with translated, human readable error messages that can be shown to the user. ### Method POST ### Endpoint https://merchantapi.googleapis.com/issueresolution/v1/{name=accounts/*}:triggeraction ### Parameters #### Path Parameters - **name** (string) - Required. The business's account that is triggering the action. Format: `accounts/{account}` #### Query Parameters - **languageCode** (string) - Optional. Language code IETF BCP 47 syntax used to localize the response. If not set, the result will be in default language `en-US`. ### Request Body The request body contains an instance of `TriggerActionPayload`. ### Response Body Response informing about the started action. If successful, the response body contains data with the following structure: ```json { "message": string } ``` #### Success Response (200) - **message** (string) - The message for the business. ### Authorization Scopes Requires the following OAuth scope: - `https://www.googleapis.com/auth/content` ``` -------------------------------- ### CloudExportAdditionalProperties Source: https://developers.google.com/merchant/api/reference/rest/products_v1/ProductAttributes Represents a product property for the Cloud Retail API. Examples include 'Screen-Resolution' or 'Screen-Size' for a TV product. ```APIDOC ## CloudExportAdditionalProperties Product property for the Cloud Retail API. For example, properties for a TV product could be "Screen-Resolution" or "Screen-Size". ### JSON Representation ```json { "textValue": [ string ], "intValue": [ string ], "floatValue": [ number ], "propertyName": string, "boolValue": boolean, "minValue": number, "maxValue": number, "unitCode": string } ``` ### Fields `textValue[]` | `string` Text value of the given property. For example, "8K(UHD)" could be a text value for a TV product. Maximum repeatedness of this value is 400. Values are stored in an arbitrary but consistent order. Maximum string size is 256 characters. `intValue[]` | `string (int64 format)` Integer values of the given property. For example, 1080 for a TV product's Screen Resolution. Maximum repeatedness of this value is 400. Values are stored in an arbitrary but consistent order. `floatValue[]` | `number` Float values of the given property. For example for a TV product 1.2345. Maximum repeatedness of this value is 400. Values are stored in an arbitrary but consistent order. `boolValue` | `boolean` Boolean value of the given property. For example for a TV product, "True" or "False" if the screen is UHD. `minValue` | `number` Minimum float value of the given property. For example for a TV product 1.00. `maxValue` | `number` Maximum float value of the given property. For example for a TV product 100.00. `unitCode` | `string` Unit of the given property. For example, "Pixels" for a TV product. Maximum string size is 256B. `propertyName` | `string` Name of the given property. For example, "Screen-Resolution" for a TV product. Maximum string size is 256 characters. ``` -------------------------------- ### accounts_v1beta.accounts.programs.list Source: https://developers.google.com/merchant/api/reference/rest Retrieves all programs available for an account. ```APIDOC ## GET /accounts/v1beta/{parent=accounts/*}/programs ### Description Retrieves all programs for the account. ### Method GET ### Endpoint /accounts/v1beta/{parent=accounts/*}/programs ``` -------------------------------- ### accounts_v1alpha.accounts.createAndConfigure Source: https://developers.google.com/merchant/api/reference/rest Creates a Merchant Center account with additional configuration. ```APIDOC ## POST /accounts/v1alpha/accounts:createAndConfigure ### Description Creates a Merchant Center account with additional configuration. ### Method POST ### Endpoint /accounts/v1alpha/accounts:createAndConfigure ``` -------------------------------- ### Get Promotion Source: https://developers.google.com/merchant/api/reference/rest/promotions_v1/accounts.promotions Retrieves a specific promotion from your Merchant Center account. This method allows you to fetch the details of an existing promotion. ```APIDOC ## GET /accounts/{accountId}/promotions/{promotionId} ### Description Retrieves the promotion from your Merchant Center account. ### Method GET ### Endpoint `/accounts/{accountId}/promotions/{promotionId}` ### Parameters #### Path Parameters - **accountId** (string) - Required - The ID of the Merchant Center account. - **promotionId** (string) - Required - The ID of the promotion to retrieve. ### Response #### Success Response (200) - **promotion** (object) - Details of the retrieved promotion. ``` -------------------------------- ### Get File Upload Source: https://developers.google.com/merchant/api/reference/rest/datasources_v1/accounts.dataSources.fileUploads/get Retrieves the latest data source file upload. Only the `latest` alias is accepted for a file upload. ```APIDOC ## GET accounts.dataSources.fileUploads.get ### Description Retrieves the latest data source file upload. Only the `latest` alias is accepted for a file upload. ### Method GET ### Endpoint `https://merchantapi.googleapis.com/datasources/v1/{name=accounts/*/dataSources/*/fileUploads/*}` ### Path Parameters * **name** (string) - Required. The name of the data source file upload to retrieve. Format: `accounts/{account}/dataSources/{datasource}/fileUploads/latest` ### Request Body The request body must be empty. ### Response Body If successful, the response body contains an instance of `FileUpload`. ### Authorization Scopes Requires the following OAuth scope: * `https://www.googleapis.com/auth/content` ``` -------------------------------- ### Get Homepage Source: https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.homepage/getHomepage Retrieves a store's homepage. This operation allows users to fetch homepage details for a given account. ```APIDOC ## GET https://merchantapi.googleapis.com/accounts/v1/{name=accounts/*/homepage} ### Description Retrieves a store's homepage. ### Method GET ### Endpoint https://merchantapi.googleapis.com/accounts/v1/{name=accounts/*/homepage} ### Parameters #### Path Parameters - **name** (string) - Required. The name of the homepage to retrieve. Format: `accounts/{account}/homepage` ### Request Body The request body must be empty. ### Response #### Success Response (200) If successful, the response body contains an instance of `Homepage`. ### Authorization Scopes Requires the following OAuth scope: - `https://www.googleapis.com/auth/content` ``` -------------------------------- ### products_v1.accounts.productInputs.insert Source: https://developers.google.com/merchant/api/reference/rest Uploads a product input to your Merchant Center account. ```APIDOC ## POST /products/v1/{parent=accounts/*}/productInputs:insert ### Description Uploads a product input to your Merchant Center account. ### Method POST ### Endpoint /products/v1/{parent=accounts/*}/productInputs:insert ``` -------------------------------- ### lfp_v1beta.accounts.lfpStores.get Source: https://developers.google.com/merchant/api/reference/rest Retrieves information about a store using the lfp_v1beta API. ```APIDOC ## GET /lfp/v1beta/{name=accounts/*/lfpStores/*} ### Description Retrieves information about a store. ### Method GET ### Endpoint /lfp/v1beta/{name=accounts/*/lfpStores/*} ``` -------------------------------- ### Create Checkout Settings Source: https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.programs.checkoutSettings Creates CheckoutSettings for a given merchant, enrolling them in the Checkout program. ```APIDOC ## create ### Description Creates `CheckoutSettings` for the given merchant. ### Method POST ### Endpoint /accounts.programs/checkout/settings ### Request Body - **merchantId** (string) - Required - The ID of the merchant. ### Response #### Success Response (200) - **checkoutSettings** (object) - The created checkout settings. #### Response Example ```json { "checkoutSettings": { "merchantId": "12345" } } ``` ``` -------------------------------- ### Get GCP Registration Account Source: https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.developerRegistration/getAccountForGcpRegistration Use this method to retrieve the merchant account ID that a GCP is registered with. The request body must be empty. ```http GET https://merchantapi.googleapis.com/accounts/v1/accounts:getAccountForGcpRegistration ``` ```json { "name": string } ``` -------------------------------- ### accounts_v1beta.termsOfService.accept Source: https://developers.google.com/merchant/api/reference/rest Accepts a TermsOfService. ```APIDOC ## POST /accounts/v1beta/{name=termsOfService/*}:accept ### Description Accepts a `TermsOfService`. ### Method POST ### Endpoint /accounts/v1beta/{name=termsOfService/*}:accept ``` -------------------------------- ### HTTP Request for accounts.list Source: https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts/list This is the basic HTTP GET request to list accounts. Ensure you have the necessary OAuth scope (`https://www.googleapis.com/auth/content`) for authorization. ```http GET https://merchantapi.googleapis.com/accounts/v1/accounts ``` -------------------------------- ### reviews_v1beta.accounts.productReviews.get Source: https://developers.google.com/merchant/api/reference/rest Retrieves a specific product review using the v1beta API. ```APIDOC ## GET /reviews/v1beta/{name=accounts/*/productReviews/*} ### Description Gets a product review. ### Method GET ### Endpoint /reviews/v1beta/{name=accounts/*/productReviews/*} ``` -------------------------------- ### accounts.omnichannelSettings.create Source: https://developers.google.com/merchant/api/reference/rest/accounts_v1/accounts.omnichannelSettings/create Creates the omnichannel settings for a given merchant. This allows for better organization and categorization of content based on user preferences. ```APIDOC ## POST accounts.omnichannelSettings.create ### Description Create the omnichannel settings for a given merchant. ### Method POST ### Endpoint `https://merchantapi.googleapis.com/accounts/v1/{parent=accounts/*}/omnichannelSettings` ### Path Parameters * **parent** (string) - Required. The parent resource where this omnichannel setting will be created. Format: `accounts/{account}` ### Request Body The request body should contain an instance of `OmnichannelSetting`. ### Response Body If successful, the response body contains a newly created instance of `OmnichannelSetting`. ### Authorization Scopes Requires the following OAuth scope: * `https://www.googleapis.com/auth/content` ```