Index
AccountIssueService
(interface)AccountTaxService
(interface)AccountsService
(interface)BusinessIdentityService
(interface)BusinessInfoService
(interface)EmailPreferencesService
(interface)HomepageService
(interface)OnlineReturnPolicyService
(interface)ProgramsService
(interface)RegionsService
(interface)ShippingSettingsService
(interface)TermsOfServiceAgreementStateService
(interface)TermsOfServiceService
(interface)UserService
(interface)AcceptTermsOfServiceRequest
(message)Accepted
(message)AccessRight
(enum)Account
(message)AccountIssue
(message)AccountIssue.ImpactedDestination
(message)AccountIssue.ImpactedDestination.Impact
(message)AccountIssue.Severity
(enum)AccountTax
(message)Address
(message)BusinessDayConfig
(message)BusinessDayConfig.Weekday
(enum)BusinessIdentity
(message)BusinessIdentity.IdentityAttribute
(message)BusinessIdentity.IdentityAttribute.IdentityDeclaration
(enum)BusinessIdentity.PromotionsConsent
(enum)BusinessInfo
(message)CarrierRate
(message)ClaimHomepageRequest
(message)CreateAndConfigureAccountRequest
(message)CreateAndConfigureAccountRequest.AcceptTermsOfService
(message)CreateAndConfigureAccountRequest.AddAccountService
(message)CreateRegionRequest
(message)CreateUserRequest
(message)CustomerService
(message)CutoffTime
(message)DeleteAccountRequest
(message)DeleteRegionRequest
(message)DeleteUserRequest
(message)DeliveryTime
(message)DisableProgramRequest
(message)Distance
(message)Distance.Unit
(enum)EmailPreferences
(message)EmailPreferences.OptInState
(enum)EnableProgramRequest
(message)GetAccountRequest
(message)GetAccountTaxRequest
(message)GetBusinessIdentityRequest
(message)GetBusinessInfoRequest
(message)GetEmailPreferencesRequest
(message)GetHomepageRequest
(message)GetOnlineReturnPolicyRequest
(message)GetProgramRequest
(message)GetRegionRequest
(message)GetShippingSettingsRequest
(message)GetTermsOfServiceAgreementStateRequest
(message)GetTermsOfServiceRequest
(message)GetUserRequest
(message)Headers
(message)Homepage
(message)InsertShippingSettingsRequest
(message)ListAccountIssuesRequest
(message)ListAccountIssuesResponse
(message)ListAccountsRequest
(message)ListAccountsResponse
(message)ListOnlineReturnPoliciesRequest
(message)ListOnlineReturnPoliciesResponse
(message)ListProgramsRequest
(message)ListProgramsResponse
(message)ListRegionsRequest
(message)ListRegionsResponse
(message)ListSubAccountsRequest
(message)ListSubAccountsResponse
(message)ListUsersRequest
(message)ListUsersResponse
(message)LocationIdSet
(message)MinimumOrderValueTable
(message)MinimumOrderValueTable.StoreCodeSetWithMov
(message)OnlineReturnPolicy
(message)OnlineReturnPolicy.ItemCondition
(enum)OnlineReturnPolicy.Policy
(message)OnlineReturnPolicy.Policy.Type
(enum)OnlineReturnPolicy.RestockingFee
(message)OnlineReturnPolicy.ReturnMethod
(enum)OnlineReturnPolicy.ReturnShippingFee
(message)OnlineReturnPolicy.ReturnShippingFee.Type
(enum)PhoneVerificationState
(enum)Program
(message)Program.Requirement
(message)Program.State
(enum)RateGroup
(message)Region
(message)Region.GeoTargetArea
(message)Region.PostalCodeArea
(message)Region.PostalCodeArea.PostalCodeRange
(message)Required
(message)RetrieveForApplicationTermsOfServiceAgreementStateRequest
(message)RetrieveLatestTermsOfServiceRequest
(message)Row
(message)Service
(message)Service.LoyaltyProgram
(message)Service.LoyaltyProgram.LoyaltyProgramTiers
(message)Service.ShipmentType
(enum)Service.StoreConfig
(message)Service.StoreConfig.CutoffConfig
(message)Service.StoreConfig.CutoffConfig.LocalCutoffTime
(message)Service.StoreConfig.StoreServiceType
(enum)ShippingSettings
(message)Table
(message)TaxRule
(message)TaxRule.TaxPostalCodeRange
(message)TermsOfService
(message)TermsOfServiceAgreementState
(message)TermsOfServiceKind
(enum)TransitTable
(message)TransitTable.TransitTimeRow
(message)TransitTable.TransitTimeRow.TransitTimeValue
(message)UnclaimHomepageRequest
(message)UpdateAccountRequest
(message)UpdateAccountTaxRequest
(message)UpdateBusinessIdentityRequest
(message)UpdateBusinessInfoRequest
(message)UpdateEmailPreferencesRequest
(message)UpdateHomepageRequest
(message)UpdateRegionRequest
(message)UpdateUserRequest
(message)User
(message)User.State
(enum)Value
(message)Warehouse
(message)WarehouseBasedDeliveryTime
(message)WarehouseCutoffTime
(message)
AccountIssueService
Service to support AccountIssueService
API.
ListAccountIssues |
---|
Lists all account issues of a Merchant Center account.
|
AccountTaxService
Manages account level tax setting data.
This API defines the following resource model:
AccountTax
GetAccountTax |
---|
Returns the tax rules that match the conditions of GetAccountTaxRequest
|
UpdateAccountTax |
---|
Updates the tax settings of the account.
|
AccountsService
Service to support Accounts API.
CreateAndConfigureAccount |
---|
Creates a standalone Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account.
|
DeleteAccount |
---|
Deletes the specified account regardless of its type: standalone, MCA or sub-account. Deleting an MCA leads to the deletion of all of its sub-accounts. Executing this method requires admin access.
|
GetAccount |
---|
Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.
|
ListAccounts |
---|
Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on.
|
ListSubAccounts |
---|
List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful
|
UpdateAccount |
---|
Updates an account regardless of its type: standalone, MCA or sub-account. Executing this method requires admin access.
|
BusinessIdentityService
Service to support business identity API.
GetBusinessIdentity |
---|
Retrieves the business identity of an account.
|
UpdateBusinessIdentity |
---|
Updates the business identity of an account. Executing this method requires admin access.
|
BusinessInfoService
Service to support business info API.
GetBusinessInfo |
---|
Retrieves the business info of an account.
|
UpdateBusinessInfo |
---|
Updates the business info of an account. Executing this method requires admin access.
|
EmailPreferencesService
Service to support the EmailPreferences
API.
This service only permits retrieving and updating email preferences for the authenticated user.
GetEmailPreferences |
---|
Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.
|
UpdateEmailPreferences |
---|
Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.
|
HomepageService
Service to support an API for a store's homepage.
ClaimHomepage |
---|
Claims a store's homepage. Executing this method requires admin access. If the homepage is already claimed, this will recheck the verification (unless the merchant is exempted from claiming, which also exempts from verification) and return a successful response. If ownership can no longer be verified, it will return an error, but it won't clear the claim. In case of failure, a canonical error message will be returned: * PERMISSION_DENIED: user doesn't have the necessary permissions on this MC account; * FAILED_PRECONDITION: - The account is not a Merchant Center account; - MC account doesn't have a homepage; - claiming failed (in this case the error message will contain more details).
|
GetHomepage |
---|
Retrieves a store's homepage.
|
UnclaimHomepage |
---|
Unclaims a store's homepage. Executing this method requires admin access.
|
UpdateHomepage |
---|
Updates a store's homepage. Executing this method requires admin access.
|
OnlineReturnPolicyService
The service facilitates the management of a merchant's remorse return policy configuration, encompassing return policies for both ads and free listings
programs. This API defines the following resource model:
[OnlineReturnPolicy][google.shopping.merchant.accounts.v1.OnlineReturnPolicy]
GetOnlineReturnPolicy |
---|
Gets an existing return policy.
|
ListOnlineReturnPolicies |
---|
Lists all existing return policies.
|
ProgramsService
Service for program management.
Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the Free product listings program, which enables products from a merchant's store to be shown across Google for free.
This service exposes methods to retrieve a merchant's participation in all available programs, in addition to methods for explicitly enabling or disabling participation in each program.
DisableProgram |
---|
Disable participation in the specified program for the account. Executing this method requires admin access.
|
EnableProgram |
---|
Enable participation in the specified program for the account. Executing this method requires admin access.
|
GetProgram |
---|
Retrieves the specified program for the account.
|
ListPrograms |
---|
Retrieves all programs for the account.
|
RegionsService
Manages regions configuration.
This API defines the following resource model:
Region
CreateRegion |
---|
Creates a region definition in your Merchant Center account. Executing this method requires admin access.
|
DeleteRegion |
---|
Deletes a region definition from your Merchant Center account. Executing this method requires admin access.
|
GetRegion |
---|
Retrieves a region defined in your Merchant Center account.
|
ListRegions |
---|
Lists the regions in your Merchant Center account.
|
UpdateRegion |
---|
Updates a region definition in your Merchant Center account. Executing this method requires admin access.
|
ShippingSettingsService
Service to get method call shipping setting information per Merchant API method.
GetShippingSettings |
---|
Retrieve shipping setting information.
|
InsertShippingSettings |
---|
Replace the shipping setting of a merchant with the request shipping setting. Executing this method requires admin access.
|
TermsOfServiceAgreementStateService
Service to support TermsOfServiceAgreementState
API.
GetTermsOfServiceAgreementState |
---|
Returns the state of a terms of service agreement.
|
RetrieveForApplicationTermsOfServiceAgreementState |
---|
Retrieves the state of the agreement for the application terms of service.
|
TermsOfServiceService
Service to support TermsOfService
API.
AcceptTermsOfService |
---|
Accepts a
|
GetTermsOfService |
---|
Retrieves the
|
RetrieveLatestTermsOfService |
---|
Retrieves the latest version of the
|
UserService
Service to support user API.
CreateUser |
---|
Creates a Merchant Center account user. Executing this method requires admin access.
|
DeleteUser |
---|
Deletes a Merchant Center account user. Executing this method requires admin access.
|
GetUser |
---|
Retrieves a Merchant Center account user.
|
ListUsers |
---|
Lists all users of a Merchant Center account.
|
UpdateUser |
---|
Updates a Merchant Center account user. Executing this method requires admin access.
|
AcceptTermsOfServiceRequest
Request message for the AcceptTermsOfService
method.
Fields | |
---|---|
name |
Required. The resource name of the terms of service version. Format: |
account |
Required. The account for which to accept the ToS. |
region_code |
Required. Region code as defined by CLDR. This is either a country when the ToS applies specifically to that country or 001 when it applies globally. |
Accepted
Describes the accepted terms of service.
Fields | |
---|---|
terms_of_service |
The accepted termsOfService. |
accepted_by |
The account where the acceptance was recorded. This can be the account itself or, in the case of subaccounts, the MCA account. |
valid_until |
When set, it states that the accepted TermsOfService is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required TermsOfService is found in the Required message. |
AccessRight
The access right.
Enums | |
---|---|
ACCESS_RIGHT_UNSPECIFIED |
Default value. This value is unused. |
STANDARD |
Standard access rights. |
ADMIN |
Admin access rights. |
PERFORMANCE_REPORTING |
Users with this right have access to performance and insights. |
Account
An account.
Fields | |
---|---|
name |
Identifier. The resource name of the account. Format: |
account_id |
Output only. The ID of the account. |
account_name |
Required. A human-readable name of the account. See store name and business name for more information. |
adult_content |
Whether this account contains adult content. |
test_account |
Output only. Whether this is a test account. |
time_zone |
Required. The time zone of the account. On writes, For reads, |
language_code |
Required. The account's BCP-47 language code, such as |
AccountIssue
An AccountIssue
.
Fields | |
---|---|
name |
Identifier. The resource name of the account issue. Format: |
title |
The localized title of the issue. |
severity |
The overall severity of the issue. |
impacted_destinations[] |
The impact this issue has on various destinations. |
detail |
Further localized details about the issue. |
documentation_uri |
Link to Merchant Center Help Center providing further information about the issue and how to fix it. |
ImpactedDestination
The impact of the issue on a destination.
Fields | |
---|---|
impacts[] |
The (negative) impact for various regions on the given destination. |
reporting_context |
The impacted reporting context. |
Impact
The impact of the issue on a region.
Fields | |
---|---|
region_code |
The CLDR region code where this issue applies. |
severity |
The severity of the issue on the destination and region. |
Severity
All possible issue severities.
Enums | |
---|---|
SEVERITY_UNSPECIFIED |
The severity is unknown. |
CRITICAL |
The issue causes offers to not serve. |
ERROR |
The issue might affect offers (in the future) or might be an indicator of issues with offers. |
SUGGESTION |
The issue is a suggestion for improvement. |
AccountTax
The tax settings of a merchant account. All methods require the admin role.
Fields | |
---|---|
name |
Identifier. The name of the tax setting. Format: "{account_tax.name=accounts/{account}}" |
account |
Output only. The ID of the account to which these account tax settings belong. |
tax_rules[] |
Tax rules. "Define the tax rules in each region. No tax will be presented if a region has no rule." |
Address
Shipping address of the warehouse.
Fields | |
---|---|
street_address |
Street-level part of the address. For example: |
city |
Required. City, town or commune. May also include dependent localities or sublocalities (For example neighborhoods or suburbs). |
administrative_area |
Required. Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). |
postal_code |
Required. Postal code or ZIP (For example "94043"). |
region_code |
Required. CLDR country code (For example "US"). |
BusinessDayConfig
Business days of the warehouse.
Fields | |
---|---|
business_days[] |
Required. Regular business days. May not be empty. |
Weekday
Enums | |
---|---|
WEEKDAY_UNSPECIFIED |
|
MONDAY |
|
TUESDAY |
|
WEDNESDAY |
|
THURSDAY |
|
FRIDAY |
|
SATURDAY |
|
SUNDAY |
BusinessIdentity
Collection of information related to the identity of a business.
Fields | |
---|---|
name |
Identifier. The resource name of the business identity. Format: |
promotions_consent |
Optional. Whether the identity attributes may be used for promotions. |
black_owned |
Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to |
women_owned |
Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to |
veteran_owned |
Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to |
latino_owned |
Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to |
small_business |
Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to |
IdentityAttribute
All information related to an identity attribute.
Fields | |
---|---|
identity_declaration |
Required. The declaration of identity for this attribute. |
IdentityDeclaration
All possible settings regarding the declaration of an identity.
Enums | |
---|---|
IDENTITY_DECLARATION_UNSPECIFIED |
Default value indicating that no selection was made. |
SELF_IDENTIFIES_AS |
Indicates that the account identifies with the attribute. |
DOES_NOT_SELF_IDENTIFY_AS |
Indicates that the account does not identify with the attribute. |
PromotionsConsent
All possible settings regarding promotions related to the business identity.
Enums | |
---|---|
PROMOTIONS_CONSENT_UNSPECIFIED |
Default value indicating that no selection was made. |
PROMOTIONS_CONSENT_GIVEN |
Indicates that the account consented to having their business identity used for promotions. |
PROMOTIONS_CONSENT_DENIED |
Indicates that the account did not consent to having their business identity used for promotions. |
BusinessInfo
Collection of information related to a business.
Fields | |
---|---|
name |
Identifier. The resource name of the business info. Format: |
address |
Optional. The address of the business. |
phone |
Output only. The phone number of the business. |
phone_verification_state |
Output only. The phone verification state of the business. |
customer_service |
Optional. The customer service of the business. |
CarrierRate
A list of carrier rates that can be referred to by main_table
or single_value
.
Fields | |
---|---|
name |
Required. Name of the carrier rate. Must be unique per rate group. |
carrier |
Required. Carrier service, such as |
carrier_service |
Required. Carrier service, such as |
origin_postal_code |
Required. Shipping origin for this carrier rate. |
percentage_adjustment |
Optional. Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example |
flat_adjustment |
Optional. Additive shipping rate modifier. Can be negative. For example |
ClaimHomepageRequest
Request message for the ClaimHomepage
method.
Fields | |
---|---|
name |
Required. The name of the homepage to claim. Format: |
CreateAndConfigureAccountRequest
Request message for the CreateAndConfigureAccount
method.
Fields | |
---|---|
account |
Required. The account to be created. |
users[] |
Optional. Users to be added to the account. |
service[] |
Optional. If specified, an account service between the account to be created and the provider account is initialized as part of the creation. |
accept_terms_of_service |
Optional. The Terms of Service (ToS) to be accepted immediately upon account creation. |
AcceptTermsOfService
Reference to a Terms of Service resource.
Fields | |
---|---|
name |
Required. The resource name of the terms of service version. |
region_code |
Required. Region code as defined by CLDR. This is either a country when the ToS applies specifically to that country or |
AddAccountService
Additional instructions to add account services during creation of the account.
Fields | |
---|---|
Union field service_type . Currently only supports Multi-client parent account type. service_type can be only one of the following: |
|
account_aggregation |
The provider is an aggregator for the account. |
provider |
Optional. The provider of the service. Format: |
CreateRegionRequest
Request message for the CreateRegion
method.
Fields | |
---|---|
parent |
Required. The account to create a region for. Format: |
region_id |
Required. The identifier for the region, unique over all regions of the same account. |
region |
Required. The region to create. |
CreateUserRequest
Request message for the CreateUser
method.
Fields | |
---|---|
parent |
Required. The resource name of the account for which a user will be created. Format: |
user_id |
Required. The email address of the user (for example, |
user |
Required. The user to create. |
CustomerService
Customer service information.
Fields | |
---|---|
uri |
Optional. The URI where customer service may be found. |
email |
Optional. The email address where customer service may be reached. |
phone |
Optional. The phone number where customer service may be called. |
CutoffTime
Business days cutoff time definition.
Fields | |
---|---|
hour |
Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day. |
minute |
Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day. |
time_zone |
Required. Timezone identifier For example "Europe/Zurich". |
DeleteAccountRequest
Request message for the DeleteAccount
method.
Fields | |
---|---|
name |
Required. The name of the account to delete. Format: |
DeleteRegionRequest
Request message for the DeleteRegion
method.
Fields | |
---|---|
name |
Required. The name of the region to delete. Format: |
DeleteUserRequest
Request message for the DeleteUser
method.
Fields | |
---|---|
name |
Required. The name of the user to delete. Format: It is also possible to delete the user corresponding to the caller by using |
DeliveryTime
Time spent in various aspects from order to the delivery of the product.
Fields | |
---|---|
warehouse_based_delivery_times[] |
Optional. Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in [delivery time][[google.shopping.content.bundles.ShippingSetting.DeliveryTime] should be set. |
min_transit_days |
Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either |
max_transit_days |
Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to |
cutoff_time |
Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST. |
min_handling_days |
Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. |
max_handling_days |
Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to |
transit_time_table |
Transit time table, number of business days spent in transit based on row and column dimensions. Either |
handling_business_day_config |
The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed. |
transit_business_day_config |
The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed. |
DisableProgramRequest
Request message for the DisableProgram method.
Fields | |
---|---|
name |
Required. The name of the program for which to disable participation for the given account. Format: |
Distance
Maximum delivery radius. This is only required for the local delivery shipment type.
Fields | |
---|---|
value |
Integer value of distance. |
unit |
Unit can differ based on country, it is parameterized to include miles and kilometers. |
Unit
Unit can differ based on country, it is parameterized to include miles and kilometers.
Enums | |
---|---|
UNIT_UNSPECIFIED |
Unit unspecified |
MILES |
Unit in miles |
KILOMETERS |
Unit in kilometers |
EmailPreferences
The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.
Fields | |
---|---|
name |
Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user. |
news_and_tips |
Optional. Updates on new features, tips and best practices. |
OptInState
Opt in state of the email preference.
Enums | |
---|---|
OPT_IN_STATE_UNSPECIFIED |
Opt-in status is not specified. |
OPTED_OUT |
User has opted out of receiving this type of email. |
OPTED_IN |
User has opted in to receiving this type of email. |
UNCONFIRMED |
User has opted in to receiving this type of email and the confirmation email has been sent, but user has not yet confirmed the opt in (applies only to certain countries). |
EnableProgramRequest
Request message for the EnableProgram method.
Fields | |
---|---|
name |
Required. The name of the program for which to enable participation for the given account. Format: |
GetAccountRequest
Request message for the GetAccount
method.
Fields | |
---|---|
name |
Required. The name of the account to retrieve. Format: |
GetAccountTaxRequest
Request to get tax settings
Fields | |
---|---|
name |
Required. The name from which tax settings will be retrieved |
GetBusinessIdentityRequest
Request message for the GetBusinessIdentity
method.
Fields | |
---|---|
name |
Required. The resource name of the business identity. Format: |
GetBusinessInfoRequest
Request message for the GetBusinessInfo
method.
Fields | |
---|---|
name |
Required. The resource name of the business info. Format: |
GetEmailPreferencesRequest
Request message for GetEmailPreferences method.
Fields | |
---|---|
name |
Required. The name of the |
GetHomepageRequest
Request message for the GetHomepage
method.
Fields | |
---|---|
name |
Required. The name of the homepage to retrieve. Format: |
GetOnlineReturnPolicyRequest
Request message for the GetOnlineReturnPolicy
method.
Fields | |
---|---|
name |
Required. The name of the return policy to retrieve. Format: |
GetProgramRequest
Request message for the GetProgram method.
Fields | |
---|---|
name |
Required. The name of the program to retrieve. Format: |
GetRegionRequest
Request message for the GetRegion
method.
Fields | |
---|---|
name |
Required. The name of the region to retrieve. Format: |
GetShippingSettingsRequest
Request message for the GetShippingSetting
method.
Fields | |
---|---|
name |
Required. The name of the shipping setting to retrieve. Format: |
GetTermsOfServiceAgreementStateRequest
Request message for the GetTermsOfServiceAgreementState
method.
Fields | |
---|---|
name |
Required. The resource name of the terms of service version. Format: |
GetTermsOfServiceRequest
Request message for the GetTermsOfService
method.
Fields | |
---|---|
name |
Required. The resource name of the terms of service version. Format: |
GetUserRequest
Request message for the GetUser
method.
Fields | |
---|---|
name |
Required. The name of the user to retrieve. Format: It is also possible to retrieve the user corresponding to the caller by using |
Headers
A non-empty list of row or column headers for a table. Exactly one of prices
, weights
, num_items
, postal_code_group_names
, or location
must be set.
Fields | |
---|---|
prices[] |
Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example |
weights[] |
Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example |
number_of_items[] |
Required. A list of inclusive number of items upper bounds. The last value can be |
postal_code_group_names[] |
Required. A list of postal group names. The last value can be |
locations[] |
Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set. |
Homepage
A store's homepage.
Fields | |
---|---|
name |
Identifier. The resource name of the store's homepage. Format: |
claimed |
Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793. |
uri |
Required. The URI (typically a URL) of the store's homepage. |
InsertShippingSettingsRequest
Request message for the InsertShippingSetting
method.
Fields | |
---|---|
parent |
Required. The account where this product will be inserted. Format: accounts/{account} |
shipping_setting |
Required. The new version of the account. |
ListAccountIssuesRequest
Request message for the ListAccountIssues
method.
Fields | |
---|---|
parent |
Required. The parent, which owns this collection of issues. Format: |
page_size |
Optional. The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 100; values above 100 will be coerced to 100 |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
language_code |
Optional. The issues in the response will have human-readable fields in the given language. The format is BCP-47, such as |
time_zone |
Optional. The IANA timezone used to localize times in human-readable fields. For example 'America/Los_Angeles'. If not set, 'America/Los_Angeles' will be used. |
ListAccountIssuesResponse
Response message for the ListAccountIssues
method.
Fields | |
---|---|
account_issues[] |
The issues from the specified account. |
next_page_token |
A token, which can be sent as |
ListAccountsRequest
Request message for the ListAccounts
method.
Fields | |
---|---|
page_size |
Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
filter |
Optional. Returns only accounts that match the filter. For more details, see the filter syntax reference. |
ListAccountsResponse
Response message for the ListAccounts
method.
Fields | |
---|---|
accounts[] |
The accounts matching the |
next_page_token |
A token, which can be sent as |
ListOnlineReturnPoliciesRequest
Request message for the ListOnlineReturnPolicies
method.
Fields | |
---|---|
parent |
Required. The merchant account for which to list return policies. Format: |
page_size |
Optional. The maximum number of |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListOnlineReturnPoliciesResponse
Response message for the ListOnlineReturnPolicies
method.
Fields | |
---|---|
online_return_policies[] |
The retrieved return policies. |
next_page_token |
A token, which can be sent as |
ListProgramsRequest
Request message for the ListPrograms method.
Fields | |
---|---|
parent |
Required. The name of the account for which to retrieve all programs. Format: |
page_size |
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. |
page_token |
Optional. A continuation token, received from a previous |
ListProgramsResponse
Response message for the ListPrograms method.
Fields | |
---|---|
programs[] |
The programs for the given account. |
next_page_token |
A token that can be sent as |
ListRegionsRequest
Request message for the ListRegions
method.
Fields | |
---|---|
parent |
Required. The account to list regions for. Format: |
page_size |
Optional. The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 regions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListRegionsResponse
Response message for the ListRegions
method.
Fields | |
---|---|
regions[] |
The regions from the specified merchant. |
next_page_token |
A token, which can be sent as |
ListSubAccountsRequest
Request message for the ListSubAccounts
method.
Fields | |
---|---|
provider |
Required. The parent account. Format: |
page_size |
Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListSubAccountsResponse
Response message for the ListSubAccounts
method.
Fields | |
---|---|
accounts[] |
The accounts for which the given parent account is an aggregator. |
next_page_token |
A token, which can be sent as |
ListUsersRequest
Request message for the ListUsers
method.
Fields | |
---|---|
parent |
Required. The parent, which owns this collection of users. Format: |
page_size |
Optional. The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 100; values above 100 will be coerced to 100 |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListUsersResponse
Response message for the ListUsers
method.
Fields | |
---|---|
users[] |
The users from the specified account. |
next_page_token |
A token, which can be sent as |
LocationIdSet
A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
Fields | |
---|---|
location_ids[] |
Required. A non-empty list of location IDs. They must all be of the same location type (For example, state). |
MinimumOrderValueTable
Table of per store minimum order values for the pickup fulfillment type.
Fields | |
---|---|
store_code_set_with_movs[] |
Required. A list of store code sets sharing the same minimum order value (MOV). At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency. |
StoreCodeSetWithMov
A list of store code sets sharing the same minimum order value. At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency.
Fields | |
---|---|
store_codes[] |
Optional. A list of unique store codes or empty for the catch all. |
value |
The minimum order value for the given stores. |
OnlineReturnPolicy
Online return policy object. This is currently used to represent return policies for ads and free listings programs.
Fields | |
---|---|
name |
Identifier. The name of the |
return_policy_id |
Output only. Return policy ID generated by Google. |
label |
This field represents the unique user-defined label of the return policy. It is important to note that the same label cannot be used in different return policies for the same country. Unless a product specifies a specific label attribute, policies will be automatically labeled as 'default'. To assign a custom return policy to certain product groups, follow the instructions provided in the Return policy label. The label can contain up to 50 characters. |
countries[] |
The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code. |
policy |
The return policy. |
restocking_fee |
The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set. |
return_methods[] |
The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns. |
item_conditions[] |
The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'. |
return_shipping_fee |
The return shipping fee. Should be set only when customer need to download and print the return label. |
return_policy_uri |
The return policy uri. This can used by Google to do a sanity check for the policy. It must be a valid URL. |
accept_defective_only |
This field specifies if merchant only accepts defective products for returns, and this field is required. |
process_refund_days |
The field specifies the number of days it takes for merchants to process refunds, field is optional. |
accept_exchange |
This field specifies if merchant allows customers to exchange products, this field is required. |
ItemCondition
The available item conditions.
Enums | |
---|---|
ITEM_CONDITION_UNSPECIFIED |
Default value. This value is unused. |
NEW |
New. |
USED |
Used. |
Policy
The available policies.
Fields | |
---|---|
type |
Policy type. |
days |
The number of days items can be returned after delivery, where one day is defined as 24 hours after the delivery timestamp. Required for |
Type
Return policy types.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Default value. This value is unused. |
NUMBER_OF_DAYS_AFTER_DELIVERY |
The number of days within which a return is valid after delivery. |
NO_RETURNS |
No returns. |
LIFETIME_RETURNS |
Life time returns. |
RestockingFee
The restocking fee. This can be a flat fee or a micro percent.
Fields | |
---|---|
Union field
|
|
fixed_fee |
Fixed restocking fee. |
micro_percent |
Percent of total price in micros. 15,000,000 means 15% of the total price would be charged. |
ReturnMethod
The available return methods.
Enums | |
---|---|
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. |
ReturnShippingFee
The return shipping fee. This can either be a fixed fee or a boolean to indicate that the customer pays the actual shipping cost.
Fields | |
---|---|
type |
Type of return shipping fee. |
fixed_fee |
Fixed return shipping fee amount. This value is only applicable when type is |
Type
Return shipping fee types.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Default value. This value is unused. |
FIXED |
The return shipping fee is a fixed value. |
CUSTOMER_PAYING_ACTUAL_FEE |
Customers will pay the actual return shipping fee. |
PhoneVerificationState
The phone verification state.
Enums | |
---|---|
PHONE_VERIFICATION_STATE_UNSPECIFIED |
Default value. This value is unused. |
PHONE_VERIFICATION_STATE_VERIFIED |
The phone is verified. |
PHONE_VERIFICATION_STATE_UNVERIFIED |
The phone is unverified |
Program
Defines participation in a given program for the specified account.
Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the Free product listings program, which enables products from a merchant's store to be shown across Google for free.
Fields | |
---|---|
name |
Identifier. The resource name of the program. Format: |
documentation_uri |
Output only. The URL of a Merchant Center help page describing the program. |
state |
Output only. The participation state of the account in the program. |
active_region_codes[] |
Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by CLDR. This is either a country where the program applies specifically to that country or |
unmet_requirements[] |
Output only. The requirements that the account has not yet satisfied that are affecting participation in the program. |
Requirement
Defines a requirement specified for participation in the program.
Fields | |
---|---|
title |
Output only. Name of the requirement. |
documentation_uri |
Output only. The URL of a help page describing the requirement. |
affected_region_codes[] |
Output only. The regions that are currently affected by this requirement not being met. Region codes are defined by CLDR. This is either a country where the program applies specifically to that country or |
State
Possible program participation states for the account.
Enums | |
---|---|
STATE_UNSPECIFIED |
Default value. This value is unused. |
NOT_ELIGIBLE |
The account is not eligible to participate in the program. |
ELIGIBLE |
The account is eligible to participate in the program. |
ENABLED |
The program is enabled for the account. |
RateGroup
Shipping rate group definitions. Only the last one is allowed to have an empty applicable_shipping_labels
, which means "everything else". The other applicable_shipping_labels
must not overlap.
Fields | |
---|---|
applicable_shipping_labels[] |
Required. A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. |
subtables[] |
Optional. A list of subtables referred to by |
carrier_rates[] |
Optional. A list of carrier rates that can be referred to by |
single_value |
The value of the rate group (For example flat rate $10). Can only be set if |
main_table |
A table defining the rate group, when |
name |
Optional. Name of the rate group. If set has to be unique within shipping service. |
Region
Represents a geographic region that you can use as a target with both the RegionalInventory
and ShippingSettings
services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets. For more information, see Set up regions for more information.
Fields | |
---|---|
name |
Identifier. The resource name of the region. Format: |
postal_code_area |
Optional. A list of postal codes that defines the region area. |
geotarget_area |
Optional. A list of geotargets that defines the region area. |
regional_inventory_eligible |
Output only. Indicates if the region is eligible for use in the Regional Inventory configuration. |
shipping_eligible |
Output only. Indicates if the region is eligible for use in the Shipping Services configuration. |
display_name |
Optional. The display name of the region. |
GeoTargetArea
A list of geotargets that defines the region area.
Fields | |
---|---|
geotarget_criteria_ids[] |
Required. A non-empty list of location IDs. They must all be of the same location type (for example, state). |
PostalCodeArea
A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible through the account's ShippingSettings.postalCodeGroups
resource.
Fields | |
---|---|
region_code |
Required. CLDR territory code or the country the postal code group applies to. |
postal_codes[] |
Required. A range of postal codes. |
PostalCodeRange
A range of postal codes that defines the region area.
Fields | |
---|---|
begin |
Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: |
end |
Optional. A postal code or a pattern of the form |
Required
Describes the terms of service which are required to be accepted.
Fields | |
---|---|
terms_of_service |
The termsOfService that need to be accepted. |
tos_file_uri |
Full URL to the terms of service file. This field is the same as TermsOfService.file_uri, it is added here for convenience only. |
RetrieveForApplicationTermsOfServiceAgreementStateRequest
Request message for the RetrieveForApplicationTermsOfServiceAgreementState
method.
Fields | |
---|---|
parent |
Required. The account for which to get a TermsOfServiceAgreementState Format: |
RetrieveLatestTermsOfServiceRequest
Request message for the RetrieveLatestTermsOfService
method.
Fields | |
---|---|
region_code |
Region code as defined by CLDR. This is either a country when the ToS applies specifically to that country or 001 when it applies globally. |
kind |
The Kind this terms of service version applies to. |
Row
Include a list of cells.
Fields | |
---|---|
cells[] |
Required. The list of cells that constitute the row. Must have the same length as |
Service
Shipping service.
Fields | |
---|---|
delivery_countries[] |
Required. The CLDR territory code of the countries to which the service applies. |
rate_groups[] |
Optional. Shipping rate group definitions. Only the last one is allowed to have an empty |
loyalty_programs[] |
Optional. Loyalty programs that this shipping service is limited to. |
service_name |
Required. Free-form name of the service. Must be unique within target account. |
active |
Required. A boolean exposing the active status of the shipping service. |
currency_code |
The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups. |
delivery_time |
Required. Time spent in various aspects from order to the delivery of the product. |
shipment_type |
Type of locations this service ships orders to. |
minimum_order_value |
Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table. |
minimum_order_value_table |
Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value. |
store_config |
A list of stores your products are delivered from. This is only valid for the local delivery shipment type. |
LoyaltyProgram
Loyalty program provided by a merchant.
Fields | |
---|---|
loyalty_program_tiers[] |
Optional. Loyalty program tier of this shipping service. |
program_label |
This is the loyalty program label set in your loyalty program settings in Merchant Center. This sub-attribute allows Google to map your loyalty program to eligible offers. |
LoyaltyProgramTiers
Subset of a merchants loyalty program.
Fields | |
---|---|
tier_label |
The tier label [tier_label] sub-attribute differentiates offer level benefits between each tier. This value is also set in your program settings in Merchant Center, and is required for data source changes even if your loyalty program only has 1 tier. |
ShipmentType
Shipment type of shipping service.
Enums | |
---|---|
SHIPMENT_TYPE_UNSPECIFIED |
This service did not specify shipment type. |
DELIVERY |
This service ships orders to an address chosen by the customer. |
LOCAL_DELIVERY |
This service ships orders to an address chosen by the customer. The order is shipped from a local store near by. |
COLLECTION_POINT |
This service ships orders to an address chosen by the customer. The order is shipped from a collection point. |
StoreConfig
A list of stores your products are delivered from. This is only valid for the local delivery shipment type.
Fields | |
---|---|
store_codes[] |
Optional. A list of store codes that provide local delivery. If empty, then |
store_service_type |
Indicates whether all stores, or selected stores, listed by this merchant provide local delivery. |
cutoff_config |
Configs related to local delivery ends for the day. |
service_radius |
Maximum delivery radius. This is only required for the local delivery shipment type. |
CutoffConfig
Configs related to local delivery ends for the day.
Fields | |
---|---|
local_cutoff_time |
Time that local delivery ends for the day. |
store_close_offset_hours |
Only valid with local delivery fulfillment. Represents cutoff time as the number of hours before store closing. Mutually exclusive with |
no_delivery_post_cutoff |
Merchants can opt-out of showing n+1 day local delivery when they have a shipping service configured to n day local delivery. For example, if the shipping service defines same-day delivery, and it's past the cut-off, setting this field to |
LocalCutoffTime
Time that local delivery ends for the day.
Fields | |
---|---|
hour |
Hour local delivery orders must be placed by to process the same day. |
minute |
Minute local delivery orders must be placed by to process the same day. |
StoreServiceType
Indicates whether all stores, or selected stores, listed by the merchant provide local delivery.
Enums | |
---|---|
STORE_SERVICE_TYPE_UNSPECIFIED |
Did not specify store service type. |
ALL_STORES |
Indicates whether all stores, current and future, listed by this merchant provide local delivery. |
SELECTED_STORES |
Indicates that only the stores listed in store_codes are eligible for local delivery. |
ShippingSettings
The merchant account's [shipping setting]((https://support.google.com/merchants/answer/6069284).
Fields | |
---|---|
name |
Identifier. The resource name of the shipping setting. Format: |
services[] |
Optional. The target account's list of services. |
warehouses[] |
Optional. A list of warehouses which can be referred to in |
etag |
Required. This field is used for avoid async issue. Make sure shipping setting data didn't change between get call and insert call. The user should do following steps:
|
Table
A table defining the rate group, when single_value
is not expressive enough.
Fields | |
---|---|
rows[] |
Required. The list of rows that constitute the table. Must have the same length as |
name |
Name of the table. Required for subtables, ignored for the main table. |
row_headers |
Required. Headers of the table's rows. |
column_headers |
Headers of the table's columns. Optional: if not set then the table has only one dimension. |
TaxRule
Primary type convension
percent micro : 100% = 1 000 000 and 1% = 10 000 cannot be negative.
Information about tax nexus and related parameters applicable to orders delivered to the area covered by a single tax admin. Nexus is created when a merchant is doing business in an area administered by tax admin (only US states are supported for nexus configuration). If merchant has nexus in a US state, merchant needs to pay tax to all tax authorities associated with the shipping destination. Next Id : 8
Fields | |
---|---|
region_code |
Region code in which this rule is applicable |
shipping_taxed |
If set, shipping charge is taxed (at the same rate as product) when delivering to this admin's area. Can only be set on US states without category. |
effective_time_period |
Required. Time period when this rule is effective. If the duration is missing from effective_time listed, then it is open ended to the future. The start of this time period is inclusive, and the end is exclusive. |
Union field location . Describe the location through either postal code range or a criteria id. location can be only one of the following: |
|
location_id |
The admin_id or criteria_id of the region in which this rule is applicable. |
post_code_range |
The range of postal codes in which this rule is applicable. |
Union field rate_calculation . What is the way to calculate tax rate for deliveries to this admin's area. Can only be set on US states. rate_calculation can be only one of the following: |
|
use_google_rate |
Rate that depends on delivery location: if merchant has a nexus in corresponding US state, rates from authorities with jurisdiction over delivery area are added up. |
self_specified_rate_micros |
A fixed rate specified in micros, where 100% = 1_000_000. Suitable for origin-based states. |
TaxPostalCodeRange
A range of postal codes that defines the area.
Fields | |
---|---|
start |
Required. The start of the postal code range, which is also the smallest in the range. |
end |
The end of the postal code range. Will be the same as start if not specified. |
TermsOfService
A TermsOfService
.
Fields | |
---|---|
name |
Identifier. The resource name of the terms of service version. Format: |
region_code |
Region code as defined by CLDR. This is either a country where the ToS applies specifically to that country or |
kind |
The Kind this terms of service version applies to. |
external |
Whether this terms of service version is external. External terms of service versions can only be agreed through external processes and not directly by the merchant through UI or API. |
file_uri |
URI for terms of service file that needs to be displayed to signing users. |
TermsOfServiceAgreementState
This resource represents the agreement state for a given account and terms of service kind. The state is as follows:
- If the merchant has accepted a terms of service: accepted will be populated, otherwise it will be empty
- If the merchant must sign a terms of service: required will be populated, otherwise it will be empty.
Note that both required and accepted can be present. In this case the accepted
terms of services will have an expiration date set in the valid_until field. The required
terms of services need to be accepted before valid_until
in order for the account to continue having a valid agreement. When accepting new terms of services we expect 3Ps to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as tos_file_uri. The actual acceptance of the terms of service is done by calling accept on the TermsOfService resource.
Fields | |
---|---|
name |
Identifier. The resource name of the terms of service version. Format: |
region_code |
Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to. |
terms_of_service_kind |
Terms of Service kind associated with the particular version. |
accepted |
The accepted terms of service of this kind and for the associated region_code |
required |
The required terms of service |
TermsOfServiceKind
The TermsOfService Kind.
Enums | |
---|---|
TERMS_OF_SERVICE_KIND_UNSPECIFIED |
Default value. This value is unused. |
MERCHANT_CENTER |
Merchant Center application. |
TransitTable
Transit time table, number of business days spent in transit based on row and column dimensions. Either min_transit_days
, max_transit_days
or transit_time_table
can be set, but not both.
Fields | |
---|---|
postal_code_group_names[] |
Required. A list of region names |
transit_time_labels[] |
Required. A list of transit time labels. The last value can be |
rows[] |
Required. If there's only one dimension set of |
TransitTimeRow
If there's only one dimension set of postal_code_group_names
or transit_time_labels
, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a postal_code_group_names
, and columns (values) to a transit_time_labels
.
Fields | |
---|---|
values[] |
Required. Transit time range (min-max) in business days. |
TransitTimeValue
Transit time range (min-max) in business days.
Fields | |
---|---|
min_transit_days |
Minimum transit time range in business days. 0 means same day delivery, 1 means next day delivery. |
max_transit_days |
Must be greater than or equal to |
UnclaimHomepageRequest
Request message for the UnclaimHomepage
method.
Fields | |
---|---|
name |
Required. The name of the homepage to unclaim. Format: |
UpdateAccountRequest
Request message for the UpdateAccount
method.
Fields | |
---|---|
account |
Required. The new version of the account. |
update_mask |
Required. List of fields being updated. |
UpdateAccountTaxRequest
Request to update the tax settings
Fields | |
---|---|
account_tax |
Required. The tax setting that will be updated |
update_mask |
The list of fields to be updated |
UpdateBusinessIdentityRequest
Request message for the UpdateBusinessIdentity
method.
Fields | |
---|---|
business_identity |
Required. The new version of the business identity. |
update_mask |
Required. List of fields being updated. |
UpdateBusinessInfoRequest
Request message for the UpdateBusinessInfo
method.
Fields | |
---|---|
business_info |
Required. The new version of the business info. |
update_mask |
Required. List of fields being updated. |
UpdateEmailPreferencesRequest
Request message for UpdateEmailPreferences method.
Fields | |
---|---|
email_preferences |
Required. Email Preferences to be updated. |
update_mask |
Required. List of fields being updated. |
UpdateHomepageRequest
Request message for the UpdateHomepage
method.
Fields | |
---|---|
homepage |
Required. The new version of the homepage. |
update_mask |
Required. List of fields being updated. |
UpdateRegionRequest
Request message for the UpdateRegion
method.
Fields | |
---|---|
region |
Required. The updated region. |
update_mask |
Optional. The comma-separated field mask indicating the fields to update. Example: |
UpdateUserRequest
Request message for the UpdateUser
method.
Fields | |
---|---|
user |
Required. The new version of the user. Use |
update_mask |
Required. List of fields being updated. |
User
A user.
Fields | |
---|---|
name |
Identifier. The resource name of the user. Format: Use |
state |
Output only. The state of the user. |
access_rights[] |
Optional. The access rights the user has. |
State
The possible states of a user.
Enums | |
---|---|
STATE_UNSPECIFIED |
Default value. This value is unused. |
PENDING |
The user is pending confirmation. In this state, the user first needs to accept the invitation before performing other actions. |
VERIFIED |
The user is verified. |
Value
The single value of a rate group or the value of a rate group table's cell. Exactly one of no_shipping
, flat_rate
, price_percentage
, carrier_rateName
, subtable_name
must be set.
Fields | |
---|---|
no_shipping |
If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set. |
flat_rate |
A flat rate. Can only be set if all other fields are not set. |
price_percentage |
A percentage of the price represented as a number in decimal notation (For example, |
carrier_rate |
The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set. |
subtable |
The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set. |
Warehouse
A fulfillment warehouse, which stores and handles inventory. Next tag: 7
Fields | |
---|---|
name |
Required. The name of the warehouse. Must be unique within account. |
shipping_address |
Required. Shipping address of the warehouse. |
cutoff_time |
Required. The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code. |
handling_days |
Required. The number of days it takes for this warehouse to pack up and ship an item. This is on the warehouse level, but can be overridden on the offer level based on the attributes of an item. |
business_day_config |
Business days of the warehouse. If not set, will be Monday to Friday by default. |
WarehouseBasedDeliveryTime
Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in delivery_time
should be set.
Fields | |
---|---|
carrier |
Required. Carrier, such as |
carrier_service |
Required. Carrier service, such as |
warehouse |
Required. Warehouse name. This should match [warehouse][ShippingSetting.warehouses.name] |
WarehouseCutoffTime
The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code.
Fields | |
---|---|
hour |
Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Hour is based on the timezone of warehouse. |
minute |
Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Minute is based on the timezone of warehouse. |