2025-05-28
▼ ▲ merchantapi.accounts.gbpAccounts.list
Path : accounts/v1beta/{+parent}/gbpAccounts
Flat Path : accounts/v1beta/accounts/{accountsId}/gbpAccounts
HTTP Method : GET
Parameters :
parent
Description : Required. The name of the parent resource under which the GBP accounts are listed. Format: `accounts/{account}`.
Pattern : ^accounts/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of `GbpAccount` resources to return. The service returns fewer than this value if the number of gbp accounts is less that than the `pageSize`. The default value is 50. The maximum value is 1000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListGbpAccounts` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListGbpAccounts` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/content
Description : List the GBP accounts for a given merchant.
▼ ▲ merchantapi.accounts.gbpAccounts.linkGbpAccount
Path : accounts/v1beta/{+parent}/gbpAccounts:linkGbpAccount
Flat Path : accounts/v1beta/accounts/{accountsId}/gbpAccounts:linkGbpAccount
HTTP Method : POST
Parameters :
parent
Description : Required. The name of the parent resource to which the GBP account is linked. Format: `accounts/{account}`.
Pattern : ^accounts/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/content
Description : Link the specified merchant to a GBP account for all countries.
▼ ▲ merchantapi.accounts.omnichannelSettings.get
Path : accounts/v1beta/{+name}
Flat Path : accounts/v1beta/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the omnichannel setting to retrieve. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`
Pattern : ^accounts/[^/]+/omnichannelSettings/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/content
Description : Get the omnichannel settings for a given merchant.
▼ ▲ merchantapi.accounts.omnichannelSettings.list
Path : accounts/v1beta/{+parent}/omnichannelSettings
Flat Path : accounts/v1beta/accounts/{accountsId}/omnichannelSettings
HTTP Method : GET
Parameters :
parent
Description : Required. The parent, which owns this collection of omnichannel settings. Format: `accounts/{account}`
Pattern : ^accounts/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of omnichannel settings to return. The service may return fewer than this value. If unspecified, at most 50 omnichannel settings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListOmnichannelSettings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOmnichannelSettings` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/content
Description : List all the omnichannel settings for a given merchant.
▼ ▲ merchantapi.accounts.omnichannelSettings.create
Path : accounts/v1beta/{+parent}/omnichannelSettings
Flat Path : accounts/v1beta/accounts/{accountsId}/omnichannelSettings
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource where this omnichannel setting will be created. Format: `accounts/{account}`
Pattern : ^accounts/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/content
Description : Create the omnichannel settings for a given merchant.
▼ ▲ merchantapi.accounts.omnichannelSettings.patch
Path : accounts/v1beta/{+name}
Flat Path : accounts/v1beta/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The resource name of the omnichannel setting. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`
Pattern : ^accounts/[^/]+/omnichannelSettings/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The list of fields to be updated. The following fields are supported in snake_case only: - `lsf_type` - `in_stock` - `pickup` - `odo` - `about` - `inventory_verification` Full replacement with wildcard `*`is supported, while empty/implied update mask is not.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/content
Description : Update the omnichannel setting for a given merchant in a given country.
▼ ▲ merchantapi.accounts.omnichannelSettings.requestInventoryVerification
Path : accounts/v1beta/{+name}:requestInventoryVerification
Flat Path : accounts/v1beta/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}:requestInventoryVerification
HTTP Method : POST
Parameters :
name
Description : Required. The name of the omnichannel setting to request inventory verification. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`
Pattern : ^accounts/[^/]+/omnichannelSettings/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/content
Description : Requests inventory verification for a given merchant in a given country.
▼ ▲ merchantapi.accounts.omnichannelSettings.lfpProviders.find
Path : accounts/v1beta/{+parent}/lfpProviders:find
Flat Path : accounts/v1beta/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}/lfpProviders:find
HTTP Method : GET
Parameters :
parent
Description : Required. The name of the parent resource under which the LFP providers are found. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`.
Pattern : ^accounts/[^/]+/omnichannelSettings/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of `LfpProvider` resources to return. The service returns fewer than this value if the number of lfp providers is less that than the `pageSize`. The default value is 50. The maximum value is 1000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `FindLfpProviders` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `FindLfpProviders` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/content
Description : Find the LFP provider candidates in a given country.
▼ ▲ merchantapi.accounts.omnichannelSettings.lfpProviders.linkLfpProvider
Path : accounts/v1beta/{+name}:linkLfpProvider
Flat Path : accounts/v1beta/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}/lfpProviders/{lfpProvidersId}:linkLfpProvider
HTTP Method : POST
Parameters :
name
Description : Required. The name of the LFP provider resource to link. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}`. The `lfp_provider` is the LFP provider ID.
Pattern : ^accounts/[^/]+/omnichannelSettings/[^/]+/lfpProviders/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/content
Description : Link the specified merchant to a LFP provider for the specified country.
▼ ▲ merchantapi.accounts.onlineReturnPolicies.create
Path : accounts/v1beta/{+parent}/onlineReturnPolicies
Flat Path : accounts/v1beta/accounts/{accountsId}/onlineReturnPolicies
HTTP Method : POST
Parameters :
parent
Description : Required. The Merchant Center account for which the return policy will be created. Format: `accounts/{account}`
Pattern : ^accounts/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/content
Description : Creates a new return policy for a given business.
▼ ▲ merchantapi.accounts.onlineReturnPolicies.patch
Path : accounts/v1beta/{+name}
Flat Path : accounts/v1beta/accounts/{accountsId}/onlineReturnPolicies/{onlineReturnPoliciesId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The name of the `OnlineReturnPolicy` resource. Format: `accounts/{account}/onlineReturnPolicies/{return_policy}`
Pattern : ^accounts/[^/]+/onlineReturnPolicies/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `accept_defective_only` - `accept_exchange` - `item_conditions` - `policy` - `process_refund_days` - `restocking_fee` - `return_methods` - `return_policy_uri` - `return_shipping_fee`
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/content
Description : Updates an existing return policy for a given business.
▼ ▲ merchantapi.accounts.onlineReturnPolicies.delete
Path : accounts/v1beta/{+name}
Flat Path : accounts/v1beta/accounts/{accountsId}/onlineReturnPolicies/{onlineReturnPoliciesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the return policy to delete. Format: `accounts/{account}/onlineReturnPolicies/{return_policy}`
Pattern : ^accounts/[^/]+/onlineReturnPolicies/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/content
Description : Deletes an existing return policy.