### ProductInstallment Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.products.v1 Represents installment payment details for a product. ```APIDOC ## ProductInstallment A message that represents installment. Fields --- `months` | `int64` The number of installments the buyer has to pay. `amount` | `Price` The amount the buyer has to pay per month. `downpayment` | `Price` The up-front down payment amount the buyer has to pay. `credit_type` | `CreditType` Type of installment payments. `annual_percentage_rate` | `double` Optional. Annual percentage rate for `credit_type` finance `total_amount` | `Price` Optional. Total amount the buyer has to pay, including interest. ``` -------------------------------- ### LocalInventoryService (v1beta) Source: https://developers.google.com/merchant/api/reference/rpc Provides methods for managing local inventory for products. ```APIDOC ## `google.shopping.merchant.inventories.v1beta.LocalInventoryService` ### Methods - **DeleteLocalInventory**: Deletes the specified `LocalInventory` from the given product in your merchant account. - **InsertLocalInventory**: Inserts a `LocalInventory` resource to a product in your merchant account. - **ListLocalInventories**: Lists the `LocalInventory` resources for the given product in your merchant account. ``` -------------------------------- ### GetLfpMerchantState Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.lfp.v1beta Gets the LFP state of a merchant. This is useful for understanding the onboarding status and other relevant information about a merchant's local feed setup. ```APIDOC ## GetLfpMerchantState ### Description Gets the LFP state of a merchant. ### Method `rpc GetLfpMerchantState(GetLfpMerchantStateRequest) returns (LfpMerchantState)` ### Authorization Requires the following OAuth scope: `https://www.googleapis.com/auth/content` ``` -------------------------------- ### GenerateProductImageBackground Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.productstudio.v1alpha Generates a new background for a given product image based on provided descriptions. ```APIDOC ## GenerateProductImageBackground ### Description Generates a new background for a given product image based on provided descriptions. ### Method POST ### Endpoint /v1/productStudio/imageBackgrounds:generate ### Request Body - **name** (string) - Required. The account for which to generate an image. Format: accounts/{account} - **output_config** (OutputImageConfig) - Optional. Configuration for how the output image should be returned. - **input_image** (InputImage) - Required. The input image. - **config** (GenerateImageBackgroundConfig) - Required. Configuration parameters for the generation of the background. ### Response #### Success Response (200) - **generated_image** (GeneratedImage) - The generated output image. ``` -------------------------------- ### ListPromotions Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.promotions.v1beta Lists all available promotions for a given account, with options for pagination. ```APIDOC ## ListPromotions ### Description Lists all available promotions for a given account, with options for pagination. ### Method GET ### Endpoint /accounts/{account}/promotions ### Parameters #### Path Parameters - **parent** (string) - Required. The account to list processed promotions for. Format: `accounts/{account}` #### Query Parameters - **page_size** (int32) - Optional. The maximum number of promotions to return. The service may return fewer than this value. The maximum value is 250; values above 250 will be coerced to 250. If unspecified, the maximum number of promotions will be returned. - **page_token** (string) - Optional. A page token, received from a previous `ListPromotions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPromotions` must match the call that provided the page token. ### Response #### Success Response (200) - **promotions[]** (Promotion) - The processed promotions from the specified account. - **next_page_token** (string) - A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. ``` -------------------------------- ### google.shopping.merchant.lfp.v1.LfpMerchantStateService Source: https://developers.google.com/merchant/api/reference/rpc Provides methods for getting the LFP state of a merchant. ```APIDOC ## `GetLfpMerchantState` ### Description Gets the LFP state of a merchant. ### Method GET ### Endpoint `/lfpMerchantState/{name}` ### Parameters #### Path Parameters - **name** (string) - Required - The name of the LFP merchant state to retrieve. Format: `accounts/{accountId}` ``` -------------------------------- ### Get Data Source Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.datasources.v1beta Retrieves a specific data source by its resource name. ```APIDOC ## GetDataSource Retrieves a specific data source. ### Request #### Parameters ##### Path Parameters - **name** (string) - Required. The name of the data source to retrieve. Format: `accounts/{account}/dataSources/{datasource}` ### Response #### Success Response (200) - **DataSource** (object) - The retrieved data source. ### Request Example ```json { "name": "accounts/12345/dataSources/myDataSource" } ``` ### Response Example ```json { "name": "accounts/12345/dataSources/myDataSource", "dataSourceId": "67890", "processingState": "SUCCEEDED", "itemsTotal": 100, "itemsCreated": 90, "itemsUpdated": 10, "uploadTime": "2023-10-27T10:00:00Z" } ``` ``` -------------------------------- ### Get File Upload Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.datasources.v1beta Retrieves the latest file upload for a specific data source. ```APIDOC ## GetFileUpload Retrieves the latest file upload of a specific data source. ### Request #### Parameters ##### Path Parameters - **name** (string) - Required. The name of the data source file upload to retrieve. Format: `accounts/{account}/dataSources/{datasource}/fileUploads/latest` ### Response #### Success Response (200) - **FileUpload** (object) - The retrieved file upload details. ### Request Example ```json { "name": "accounts/12345/dataSources/myDataSource/fileUploads/latest" } ``` ### Response Example ```json { "name": "accounts/12345/dataSources/myDataSource/fileUploads/1698397200", "dataSourceId": "67890", "processingState": "SUCCEEDED", "itemsTotal": 100, "itemsCreated": 90, "itemsUpdated": 10, "uploadTime": "2023-10-27T10:00:00Z" } ``` ``` -------------------------------- ### CreateAndConfigureAccount Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.accounts.v1alpha Creates and configures a new merchant account. This method allows for setting up the account with initial users, services, and relationship aliases. ```APIDOC ## CreateAndConfigureAccount ### Description Creates and configures a new merchant account, optionally adding users and specifying services and relationship aliases. ### Request Body - **account** (Account) - Required. The account to be created. - **user** (AddUser[]) - Optional. Users to be added to the account. - **service** (AddAccountService[]) - Required. Services to be initialized for the account. Must include at least one of `account_aggregation` or `account_management`. - **set_alias** (SetAliasForRelationship[]) - Optional. Aliases for relationships created with a provider. ### Request Example ```json { "account": { "displayName": "My New Account", "country": "US" }, "user": [ { "userId": "user@example.com", "verificationMailSettings": { "sendVerificationMail": true } } ], "service": [ { "accountAggregation": {}, "provider": "providers/123" }, { "productsManagement": {}, "provider": "providers/456" } ], "set_alias": [ { "provider": "providers/123", "accountIdAlias": "provider-specific-id-123" } ] } ``` ### Response #### Success Response (200) - **name** (string) - The resource name of the created account. - **displayName** (string) - The display name of the account. - **country** (string) - The country of the account. - **currency** (string) - The currency of the account. - **language** (string) - The language of the account. - **createTime** (Timestamp) - The creation time of the account. - **updateTime** (Timestamp) - The last update time of the account. - **accountStatus** (AccountStatus) - The status of the account. - **parentAccounts** (string[]) - The parent accounts of the account. - **businessIdentity** (BusinessIdentity) - The business identity of the account. - **homepageUri** (string) - The homepage URI of the account. - **googleMerchantId** (string) - The Google Merchant ID of the account. - **accountType** (AccountType) - The type of the account. - **users** (User[]) - The users associated with the account. - **services** (AccountService[]) - The services associated with the account. - **labels** (Label[]) - The labels associated with the account. - **accountUri** (string) - The URI of the account. - **accountManager** (string) - The account manager of the account. - **linkedAdAccounts** (LinkedAdAccounts) - The linked ad accounts. - **dataSafety** (DataSafety) - The data safety information for the account. - **accountState** (AccountState) - The state of the account. - **paymentProgram** (PaymentProgram) - The payment program of the account. - **accountTaxonomy** (AccountTaxonomy) - The account taxonomy. - **accountTaxonomyVersion** (string) - The version of the account taxonomy. - **accountStatusV2** (AccountStatusV2) - The V2 status of the account. - **accountStateV2** (AccountStateV2) - The V2 state of the account. - **accountStateV3** (AccountStateV3) - The V3 state of the account. - **accountStateV4** (AccountStateV4) - The V4 state of the account. - **accountStateV5** (AccountStateV5) - The V5 state of the account. - **accountStateV6** (AccountStateV6) - The V6 state of the account. - **accountStateV7** (AccountStateV7) - The V7 state of the account. - **accountStateV8** (AccountStateV8) - The V8 state of the account. - **accountStateV9** (AccountStateV9) - The V9 state of the account. - **accountStateV10** (AccountStateV10) - The V10 state of the account. - **accountStateV11** (AccountStateV11) - The V11 state of the account. - **accountStateV12** (AccountStateV12) - The V12 state of the account. - **accountStateV13** (AccountStateV13) - The V13 state of the account. - **accountStateV14** (AccountStateV14) - The V14 state of the account. - **accountStateV15** (AccountStateV15) - The V15 state of the account. - **accountStateV16** (AccountStateV16) - The V16 state of the account. - **accountStateV17** (AccountStateV17) - The V17 state of the account. - **accountStateV18** (AccountStateV18) - The V18 state of the account. - **accountStateV19** (AccountStateV19) - The V19 state of the account. - **accountStateV20** (AccountStateV20) - The V20 state of the account. - **accountStateV21** (AccountStateV21) - The V21 state of the account. - **accountStateV22** (AccountStateV22) - The V22 state of the account. - **accountStateV23** (AccountStateV23) - The V23 state of the account. - **accountStateV24** (AccountStateV24) - The V24 state of the account. - **accountStateV25** (AccountStateV25) - The V25 state of the account. - **accountStateV26** (AccountStateV26) - The V26 state of the account. - **accountStateV27** (AccountStateV27) - The V27 state of the account. - **accountStateV28** (AccountStateV28) - The V28 state of the account. - **accountStateV29** (AccountStateV29) - The V29 state of the account. - **accountStateV30** (AccountStateV30) - The V30 state of the account. - **accountStateV31** (AccountStateV31) - The V31 state of the account. - **accountStateV32** (AccountStateV32) - The V32 state of the account. - **accountStateV33** (AccountStateV33) - The V33 state of the account. - **accountStateV34** (AccountStateV34) - The V34 state of the account. - **accountStateV35** (AccountStateV35) - The V35 state of the account. - **accountStateV36** (AccountStateV36) - The V36 state of the account. - **accountStateV37** (AccountStateV37) - The V37 state of the account. - **accountStateV38** (AccountStateV38) - The V38 state of the account. - **accountStateV39** (AccountStateV39) - The V39 state of the account. - **accountStateV40** (AccountStateV40) - The V40 state of the account. - **accountStateV41** (AccountStateV41) - The V41 state of the account. - **accountStateV42** (AccountStateV42) - The V42 state of the account. - **accountStateV43** (AccountStateV43) - The V43 state of the account. - **accountStateV44** (AccountStateV44) - The V44 state of the account. - **accountStateV45** (AccountStateV45) - The V45 state of the account. - **accountStateV46** (AccountStateV46) - The V46 state of the account. - **accountStateV47** (AccountStateV47) - The V47 state of the account. - **accountStateV48** (AccountStateV48) - The V48 state of the account. - **accountStateV49** (AccountStateV49) - The V49 state of the account. - **accountStateV50** (AccountStateV50) - The V50 state of the account. - **accountStateV51** (AccountStateV51) - The V51 state of the account. - **accountStateV52** (AccountStateV52) - The V52 state of the account. - **accountStateV53** (AccountStateV53) - The V53 state of the account. - **accountStateV54** (AccountStateV54) - The V54 state of the account. - **accountStateV55** (AccountStateV55) - The V55 state of the account. - **accountStateV56** (AccountStateV56) - The V56 state of the account. - **accountStateV57** (AccountStateV57) - The V57 state of the account. - **accountStateV58** (AccountStateV58) - The V58 state of the account. - **accountStateV59** (AccountStateV59) - The V59 state of the account. - **accountStateV60** (AccountStateV60) - The V60 state of the account. - **accountStateV61** (AccountStateV61) - The V61 state of the account. - **accountStateV62** (AccountStateV62) - The V62 state of the account. - **accountStateV63** (AccountStateV63) - The V63 state of the account. - **accountStateV64** (AccountStateV64) - The V64 state of the account. - **accountStateV65** (AccountStateV65) - The V65 state of the account. - **accountStateV66** (AccountStateV66) - The V66 state of the account. - **accountStateV67** (AccountStateV67) - The V67 state of the account. - **accountStateV68** (AccountStateV68) - The V68 state of the account. - **accountStateV69** (AccountStateV69) - The V69 state of the account. - **accountStateV70** (AccountStateV70) - The V70 state of the account. - **accountStateV71** (AccountStateV71) - The V71 state of the account. - **accountStateV72** (AccountStateV72) - The V72 state of the account. - **accountStateV73** (AccountStateV73) - The V73 state of the account. - **accountStateV74** (AccountStateV74) - The V74 state of the account. - **accountStateV75** (AccountStateV75) - The V75 state of the account. - **accountStateV76** (AccountStateV76) - The V76 state of the account. - **accountStateV77** (AccountStateV77) - The V77 state of the account. - **accountStateV78** (AccountStateV78) - The V78 state of the account. - **accountStateV79** (AccountStateV79) - The V79 state of the account. - **accountStateV80** (AccountStateV80) - The V80 state of the account. - **accountStateV81** (AccountStateV81) - The V81 state of the account. - **accountStateV82** (AccountStateV82) - The V82 state of the account. - **accountStateV83** (AccountStateV83) - The V83 state of the account. - **accountStateV84** (AccountStateV84) - The V84 state of the account. - **accountStateV85** (AccountStateV85) - The V85 state of the account. - **accountStateV86** (AccountStateV86) - The V86 state of the account. - **accountStateV87** (AccountStateV87) - The V87 state of the account. - **accountStateV88** (AccountStateV88) - The V88 state of the account. - **accountStateV89** (AccountStateV89) - The V89 state of the account. - **accountStateV90** (AccountStateV90) - The V90 state of the account. - **accountStateV91** (AccountStateV91) - The V91 state of the account. - **accountStateV92** (AccountStateV92) - The V92 state of the account. - **accountStateV93** (AccountStateV93) - The V93 state of the account. - **accountStateV94** (AccountStateV94) - The V94 state of the account. - **accountStateV95** (AccountStateV95) - The V95 state of the account. - **accountStateV96** (AccountStateV96) - The V96 state of the account. - **accountStateV97** (AccountStateV97) - The V97 state of the account. - **accountStateV98** (AccountStateV98) - The V98 state of the account. - **accountStateV99** (AccountStateV99) - The V99 state of the account. - **accountStateV100** (AccountStateV100) - The V100 state of the account. ### Response Example ```json { "name": "accounts/12345", "displayName": "My New Account", "country": "US", "currency": "USD", "language": "en", "createTime": "2023-10-27T10:00:00Z", "updateTime": "2023-10-27T10:00:00Z", "accountStatus": "ACCOUNT_STATUS_ENABLED", "accountType": "ACCOUNT_TYPE_MERCHANT", "users": [ { "userId": "user@example.com", "accessRole": "ADMIN" } ], "services": [ { "accountAggregation": {}, "provider": "providers/123" } ] } ``` ``` -------------------------------- ### Create Test Account Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.accounts.v1alpha Creates a new test account under a specified account resource. ```APIDOC ## CreateTestAccountRequest Request message for CreateTestAccount RPC ### Parameters #### Request Body - **parent** (string) - Required. The account resource name to create the test account under. Format: accounts/{account} - **account** (Account) - Required. The account to be created. ``` -------------------------------- ### GetAccountServiceRequest Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.accounts.v1alpha Request to get an account service. Specifies the resource name of the account service to retrieve. ```APIDOC ## GetAccountServiceRequest ### Description Request to get an account service. Specifies the resource name of the account service to retrieve. ### Fields * `name` (string) - Required. The resource name of the account service to get. Format: `accounts/{account}/services/{service}`. ``` -------------------------------- ### SizeSystem Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.products.v1 Defines the system used for specifying product sizes, recommended for apparel. ```APIDOC ## SizeSystem System in which the size is specified. Recommended for apparel items. For more information, see Size system. ### Enums * **SIZE_SYSTEM_UNSPECIFIED** - Unspecified size system. * **AU** - AU. * **BR** - BR. * **CN** - CN. * **DE** - DE. * **EU** - EU. * **FR** - FR. * **IT** - IT. * **JP** - JP. * **MEX** - MEX. * **UK** - UK. * **US** - US. ``` -------------------------------- ### GetAccountRelationshipRequest Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.accounts.v1alpha Request to get an account relationship. Specifies the resource name of the account relationship to retrieve. ```APIDOC ## GetAccountRelationshipRequest ### Description Request to get an account relationship. Specifies the resource name of the account relationship to retrieve. ### Fields * `name` (string) - Required. The resource name of the account relationship to get. Format: `accounts/{account}/relationships/{relationship}`. ``` -------------------------------- ### ShippingSettingsService Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.accounts.v1alpha Service to get method call shipping setting information per Merchant API method. ```APIDOC ## GetShippingSettings ### Description Retrieve shipping setting information. ### Method RPC ### Endpoint GetShippingSettings ### Parameters #### Request Body - **request** (GetShippingSettingsRequest) - Required - The request object for GetShippingSettings. ### Response #### Success Response (200) - **response** (ShippingSettings) - The shipping settings information. ``` ```APIDOC ## InsertShippingSettings ### Description Replace the shipping setting of a business with the request shipping setting. ### Method RPC ### Endpoint InsertShippingSettings ### Parameters #### Request Body - **request** (InsertShippingSettingsRequest) - Required - The request object for InsertShippingSettings. ### Response #### Success Response (200) - **response** (ShippingSettings) - The updated shipping settings. ``` -------------------------------- ### Return Method Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.accounts.v1alpha Defines the available methods for returning products, such as by mail, in-store, or at a kiosk. ```APIDOC ## Enum: ReturnMethod ### Description The available return methods. ### Values * `RETURN_METHOD_UNSPECIFIED` - Default value. This value is unused. * `BY_MAIL` - Return by mail. * `IN_STORE` - Return in store. * `AT_A_KIOSK` - Return at a kiosk. ``` -------------------------------- ### FetchSettings Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.datasources.v1beta Details for fetching data sources, including schedule and URI. ```APIDOC ## FetchSettings Fetch details to deliver the data source. Fields --- `enabled` | `bool` Optional. Enables or pauses the fetch schedule. `day_of_month` | `int32` 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. `time_of_day` | `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. `day_of_week` | `DayOfWeek` Optional. The day of the week when the data source file should be fetched. This field can only be set for weekly frequency. `time_zone` | `string` Optional. Time zone used for schedule. UTC by default. For example, "America/Los_Angeles". `frequency` | `Frequency` Required. The frequency describing fetch schedule. `fetch_uri` | `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 `fetch_uri`. Used for submitting data sources through SFTP. `password` | `string` Optional. An optional password for `fetch_uri`. Used for submitting data sources through SFTP. ``` -------------------------------- ### GetOnlineReturnPolicy Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.accounts.v1alpha Gets an existing return policy for a given business. Requires the `https://www.googleapis.com/auth/content` OAuth scope. ```APIDOC ## GetOnlineReturnPolicy ### Description Gets an existing return policy for a given business. ### Method RPC ### Request `GetOnlineReturnPolicyRequest` ### Response `OnlineReturnPolicy` ### Authorization Requires the following OAuth scope: `https://www.googleapis.com/auth/content` ``` -------------------------------- ### google.shopping.merchant.lfp.v1.LfpStoreService Source: https://developers.google.com/merchant/api/reference/rpc Provides methods for managing LFP stores. ```APIDOC ## `DeleteLfpStore` ### Description Deletes a store for a target merchant. ### Method DELETE ### Endpoint `/lfpStores/{name}` ### Parameters #### Path Parameters - **name** (string) - Required - The name of the store to delete. Format: `accounts/{accountId}/lfpStores/{storeId}` ``` ```APIDOC ## `GetLfpStore` ### Description Retrieves information about a store. ### Method GET ### Endpoint `/lfpStores/{name}` ### Parameters #### Path Parameters - **name** (string) - Required - The name of the store to retrieve. Format: `accounts/{accountId}/lfpStores/{storeId}` ``` ```APIDOC ## `InsertLfpStore` ### Description Inserts a store for the target merchant. ### Method POST ### Endpoint `/lfpStores` ### Parameters #### Request Body - **lfpStore** (object) - Required - The store to insert. ``` ```APIDOC ## `ListLfpStores` ### Description Lists the stores of the target merchant, specified by the filter in `ListLfpStoresRequest`. ### Method GET ### Endpoint `/lfpStores` ### Parameters #### Query Parameters - **filter** (string) - Optional - The filter to apply to the list of stores. - **pageSize** (integer) - Optional - The maximum number of stores to return. - **pageToken** (string) - Optional - A page token, received from a previous `ListLfpStores` call. ``` -------------------------------- ### GetFileUpload Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.datasources.v1beta Gets the latest data source file upload. Only the `latest` alias is accepted for a file upload. ```APIDOC ## GetFileUpload ### Description Gets the latest data source file upload. Only the `latest` alias is accepted for a file upload. ### Authorization Requires the following OAuth scope: `https://www.googleapis.com/auth/content` ``` -------------------------------- ### CreateCheckoutSettings Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.accounts.v1alpha Creates checkout settings for a given merchant account. ```APIDOC ## CreateCheckoutSettings ### Description Creates checkout settings for a specified merchant account. ### Parameters #### Path Parameters - **parent** (string) - Required. The merchant account for which the `CheckoutSettings` will be created. Format: `accounts/{account}`. ### Request Body - **checkout_settings** (CheckoutSettings) - Required. The `CheckoutSettings` object to create. ### Request Example ```json { "checkout_settings": { "enabled": true, "merchant_id": "12345" } } ``` ### Response #### Success Response (200) - **enabled** (boolean) - Indicates if checkout settings are enabled. - **merchant_id** (string) - The ID of the merchant. - **checkout_settings_id** (string) - The ID of the checkout settings. - **create_time** (Timestamp) - The creation time of the checkout settings. - **update_time** (Timestamp) - The last update time of the checkout settings. ### Response Example ```json { "enabled": true, "merchant_id": "12345", "checkout_settings_id": "cs-123", "create_time": "2023-10-27T10:00:00Z", "update_time": "2023-10-27T10:00:00Z" } ``` ``` -------------------------------- ### Seasonal Override Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.accounts.v1alpha Defines seasonal overrides for return policies, including display name, start date, and end date. ```APIDOC ## Type: SeasonalOverride ### Description Seasonal overrides for return policies. ### Fields * `label` (`string`) - Required. Display name of this seasonal override in Merchant Center. * `start_date` (`Date`) - Required. Defines the date range when this seasonal override applies. Both start_date and end_date are inclusive. The dates of the seasonal overrides should not overlap. * `end_date` (`Date`) - Required. Seasonal override end date (inclusive). * `return_window` - Union field. Can be one of the following: * `return_days` (`int32`) - Number of days (from the delivery date) that the product can be returned. * `return_until_date` (`Date`) - Fixed end date until which the product can be returned. ``` -------------------------------- ### TriggerAction Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.issueresolution.v1beta 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. ```APIDOC ## 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 `rpc TriggerAction(TriggerActionRequest) returns (TriggerActionResponse)` ### Authorization Requires the following OAuth scope: `https://www.googleapis.com/auth/content` ``` -------------------------------- ### ListLocalInventories Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.inventories.v1beta Lists all local inventory for a given product. ```APIDOC ## ListLocalInventories ### Description Lists all local inventory for a given product. ### Method GET ### Endpoint /v1beta/inventories:listLocalInventories ### Parameters #### Path Parameters - **parent** (string) - Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account}/products/{product}`. The `{product}` segment can be in encoded or plain format. #### Query Parameters - **pageSize** (int32) - Optional. The maximum number of `LocalInventory` resources to return. Defaults to 25000. Maximum value is 25000. - **pageToken** (string) - Optional. A page token, received from a previous `ListLocalInventories` call, to retrieve the subsequent page. ### Response #### Success Response (200) - **localInventories** (array) - A list of `LocalInventory` resources. - **nextPageToken** (string) - A token to retrieve the next page of results. ``` -------------------------------- ### DataSourcesService (v1beta) Source: https://developers.google.com/merchant/api/reference/rpc Provides methods for managing data source configurations. ```APIDOC ## `google.shopping.merchant.datasources.v1beta.DataSourcesService` ### Methods - **CreateDataSource**: Creates the new data source configuration for the given account. - **DeleteDataSource**: Deletes a data source from your Merchant Center account. - **FetchDataSource**: Performs the data fetch immediately (even outside fetch schedule) on a data source from your Merchant Center Account. - **GetDataSource**: Retrieves the data source configuration for the given account. - **ListDataSources**: Lists the configurations for data sources for the given account. - **UpdateDataSource**: Updates the existing data source configuration. ``` -------------------------------- ### ListDataSources Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.datasources.v1beta Lists the configurations for data sources for the given account. ```APIDOC ## ListDataSources ### Description Lists the configurations for data sources for the given account. ### Authorization Requires the following OAuth scope: `https://www.googleapis.com/auth/content` ``` -------------------------------- ### google.shopping.merchant.lfp.v1.LfpInventoryService Source: https://developers.google.com/merchant/api/reference/rpc Provides methods for inserting LFP inventory. ```APIDOC ## `InsertLfpInventory` ### Description Inserts a `LfpInventory` resource for the given target merchant account. ### Method POST ### Endpoint `/lfpInventories` ### Parameters #### Request Body - **lfpInventory** (object) - Required - The LFP inventory to insert. ``` -------------------------------- ### CreateContract Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.youtube.v1alpha Creates a new contract for the YouTube Shopping Affiliate Program. ```APIDOC ## CreateContract ### Description Creates a new contract. ### Method `rpc CreateContract(CreateContractRequest) returns (Contract)` ### Authorization Requires the following OAuth scope: `https://www.googleapis.com/auth/content` ``` -------------------------------- ### CreateAndConfigureAccount Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.accounts.v1alpha Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account. ```APIDOC ## CreateAndConfigureAccount ### Description Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account. ### RPC Method `CreateAndConfigureAccount(CreateAndConfigureAccountRequest) returns (Account)` ### Authorization Requires the following OAuth scope: `https://www.googleapis.com/auth/content` ``` -------------------------------- ### LocalInventoryService (v1) Source: https://developers.google.com/merchant/api/reference/rpc Provides methods for managing local inventory for products. ```APIDOC ## `google.shopping.merchant.inventories.v1.LocalInventoryService` ### Methods - **DeleteLocalInventory**: Deletes the specified `LocalInventory` from the given product in your merchant account. - **InsertLocalInventory**: Inserts a `LocalInventory` resource to a product in your merchant account. - **ListLocalInventories**: Lists the `LocalInventory` resources for the given product in your merchant account. ``` -------------------------------- ### ImageService.GenerateProductImageBackground Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.productstudio.v1alpha Generates a new image with an AI-generated background based on product information and a text prompt. ```APIDOC ## GenerateProductImageBackground ### Description 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 rpc ### Endpoint `GenerateProductImageBackground(GenerateProductImageBackgroundRequest)` returns (`GenerateProductImageBackgroundResponse`) ### Authorization Requires the following OAuth scope: `https://www.googleapis.com/auth/content` ``` -------------------------------- ### google.shopping.merchant.issueresolution.v1.IssueResolutionService Source: https://developers.google.com/merchant/api/reference/rpc Provides methods for rendering account and product issues, and triggering actions. ```APIDOC ## `RenderAccountIssues` ### Description Provide a list of business's account issues with an issue resolution content and available actions. ### Method GET ### Endpoint `/accountIssues:render` ### Parameters #### Query Parameters - **issueType** (string) - Optional - The type of issue to render. - **languageCode** (string) - Optional - The language code for the issue description. ``` ```APIDOC ## `RenderProductIssues` ### Description Provide a list of issues for business's product with an issue resolution content and available actions. ### Method GET ### Endpoint `/productIssues:render` ### Parameters #### Query Parameters - **productName** (string) - Required - The name of the product for which to render issues. - **issueType** (string) - Optional - The type of issue to render. - **languageCode** (string) - Optional - The language code for the issue description. ``` ```APIDOC ## `TriggerAction` ### Description Start an action. ### Method POST ### Endpoint `/actions:trigger` ### Parameters #### Request Body - **action** (object) - Required - The action to trigger. ``` -------------------------------- ### ConversionSourcesService (v1beta) Source: https://developers.google.com/merchant/api/reference/rpc Provides methods for managing conversion sources. ```APIDOC ## `google.shopping.merchant.conversions.v1beta.ConversionSourcesService` ### Methods - **CreateConversionSource**: Creates a new conversion source. - **DeleteConversionSource**: Archives an existing conversion source. - **GetConversionSource**: Fetches a conversion source. - **ListConversionSources**: Retrieves the list of conversion sources the caller has access to. - **UndeleteConversionSource**: Re-enables an archived conversion source. - **UpdateConversionSource**: Updates information of an existing conversion source. ``` -------------------------------- ### InsertPromotion Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.promotions.v1beta Inserts a new promotion into a specified account. ```APIDOC ## InsertPromotion ### Description Inserts a new promotion into a specified account. ### Method POST ### Endpoint /accounts/{account}/promotions ### Parameters #### Path Parameters - **parent** (string) - Required. The account where the promotion will be inserted. Format: `accounts/{account}` #### Request Body - **promotion** (Promotion) - Required. The promotion to insert. - **data_source** (string) - Required. The data source of the promotion. Format: `accounts/{account}/dataSources/{datasource}`. ``` -------------------------------- ### ProductSustainabilityIncentive Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.products.v1 Provides information about sustainability-related incentive programs. ```APIDOC ## ProductSustainabilityIncentive Information regarding sustainability-related incentive programs such as rebates or tax relief. Fields --- Union field `value`. Sustainability incentive value. `value` can be only one of the following: `amount` | `Price` The fixed amount of the incentive. `percentage` | `double` The percentage of the sale price that the incentive is applied to. `type` | `Type` Sustainability incentive program. ``` -------------------------------- ### ListLocalInventories Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.inventories.v1beta Lists local inventories for a given product. Supports pagination. ```APIDOC ## ListLocalInventories ### Description Lists local inventories for the specified product. This method supports pagination to retrieve all available local inventory data. ### Method GET ### Endpoint `accounts/{account}/products/{product}:listLocalInventories` ### Parameters #### Path Parameters - **account** (string) - Required - The merchant account ID. - **product** (string) - Required - The product ID. Format: `content_language~feed_label~offer_id` or its base64url encoded version. #### Query Parameters - **pageSize** (int32) - Optional - The maximum number of `LocalInventory` resources to return. Defaults to 25000, maximum is 100000. - **pageToken** (string) - Optional - A page token, received from a previous `ListLocalInventories` call, to retrieve the next page. ### Response #### Success Response (200) - **local_inventories** (`array` of `LocalInventory`) - The list of local inventories for the product. - **nextPageToken** (string) - A token to retrieve the next page of results. Omitted if there are no subsequent pages. ### Response Example ```json { "local_inventories": [ { "name": "accounts/123/products/en~US~sku123/localInventories/us-ca-store1", "storeCode": "us-ca-store1", "price": { "value": "25.50", "currencyCode": "USD" }, "availability": "IN_STOCK", "pickupMethod": "BUY", "pickupSla": "1-2 days", "quantity": 10 } ], "nextPageToken": "CAEQARgC" } ``` ``` -------------------------------- ### ListPrograms Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.accounts.v1alpha Retrieves all programs for the account. Requires the `https://www.googleapis.com/auth/content` OAuth scope. ```APIDOC ## ListPrograms ### Description Retrieves all programs for the account. ### Method RPC ### Request `ListProgramsRequest` ### Response `ListProgramsResponse` ### Authorization Requires the following OAuth scope: `https://www.googleapis.com/auth/content` ``` -------------------------------- ### List Data Sources Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.datasources.v1beta Lists all data sources for a given account, with support for pagination. ```APIDOC ## ListDataSources Lists all data sources for the specified account. ### Request #### Parameters ##### Path Parameters - **parent** (string) - Required. The account to list data sources for. Format: `accounts/{account}` ##### Query Parameters - **pageSize** (int32) - 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 `ListDataSources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataSources` must match the call that provided the page token. ### Response #### Success Response (200) - **dataSources[]** (array) - 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. ### Request Example ```json { "parent": "accounts/12345", "pageSize": 50 } ``` ### Response Example ```json { "dataSources": [ { "name": "accounts/12345/dataSources/dataSource1", "dataSourceId": "11111" }, { "name": "accounts/12345/dataSources/dataSource2", "dataSourceId": "22222" } ], "nextPageToken": "CAEQARgB" } ``` ``` -------------------------------- ### RenderProductIssues Source: https://developers.google.com/merchant/api/reference/rpc/google.shopping.merchant.issueresolution.v1beta Retrieves issue resolution content and actions for a specific product. ```APIDOC ## RenderProductIssues ### Description This method allows you to retrieve detailed information and suggested actions for resolving issues associated with a specific product in your Google Merchant Center account. It can render the content in a pre-rendered HTML format or as plain text, and offers options for handling user input actions. ### Method POST ### Endpoint `https://shopping.googleapis.com/merchant/v1beta/products/{name}:renderIssues` ### Parameters #### Path Parameters - **name** (string) - Required. The name of the product. Format: `accounts/{account}/products/{product}`. The `{product}` segment can be in either Encoded Format (base64url encoded) or Plain Format (tilde-separated). #### Query Parameters - **language_code** (string) - Optional. The IETF BCP-47 language code for localizing the issue resolution content. Defaults to `en-US`. - **time_zone** (string) - Optional. The IANA timezone for localizing times in the issue resolution content. Defaults to UTC. #### Request Body - **payload** (`RenderIssuesRequestPayload`) - Optional. Configuration for rendering the issue content. - **content_option** (`ContentOption`) - Optional. Specifies how the detailed content should be returned. Defaults to pre-rendered HTML. - **user_input_action_option** (`UserInputActionRenderingOption`) - Optional. Defines how actions requiring user input should be handled. Defaults to returning links to Merchant Center. ### Request Example ```json { "payload": { "content_option": "HTML_CONTENT", "user_input_action_option": "RENDER_AS_LINK" } } ``` ### Response #### Success Response (200) - **rendered_issues** (array of `RenderedIssue`) - A list of issues for the given product. Each issue can be displayed in a compressed form (showing title and impact) or expanded to reveal detailed `content` and available `actions`. ``` -------------------------------- ### HomepageService Methods Source: https://developers.google.com/merchant/api/reference/rpc Methods for claiming, retrieving, unclaiming, and updating a store's homepage. ```APIDOC ## `google.shopping.merchant.accounts.v1alpha.HomepageService` ### Description Manages the claiming and configuration of a store's homepage. ### Methods - `ClaimHomepage`: Claims a store's homepage. - `GetHomepage`: Retrieves a store's homepage. - `UnclaimHomepage`: Unclaims a store's homepage. - `UpdateHomepage`: Updates a store's homepage. ```