REST Resource: accounts.businessInfo
Stay organized with collections
Save and categorize content based on your preferences.
Resource: BusinessInfo
The BusinessInfo
message contains essential information about a business.
This message captures key business details such as physical address, customer service contacts, and region-specific identifiers.
Fields |
name |
string
Identifier. The resource name of the business info. Format: accounts/{account}/businessInfo
|
address |
object (PostalAddress )
Optional. The address of the business. Only regionCode , addressLines , postalCode , administrativeArea and locality fields are supported. All other fields are ignored.
|
phone |
object (PhoneNumber )
Output only. The phone number of the business.
|
phoneVerificationState |
enum (PhoneVerificationState )
Output only. The phone verification state of the business.
|
customerService |
object (CustomerService )
Optional. The customer service of the business.
|
koreanBusinessRegistrationNumber |
string
Optional. The 10-digit Korean business registration number separated with dashes in the format: XXX-XX-XXXXX.
|
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. |
CustomerService
Customer service information.
JSON representation |
{
"uri": string,
"email": string,
"phone": {
object (PhoneNumber )
}
} |
Fields |
uri |
string
Optional. The URI where customer service may be found.
|
email |
string
Optional. The email address where customer service may be reached.
|
phone |
object (PhoneNumber )
Optional. The phone number where customer service may be called.
|
Methods |
|
Retrieves the business info of an account. |
|
Updates the business info of an account. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-31 UTC.
[null,null,["Last updated 2025-07-31 UTC."],[],[],null,["# REST Resource: accounts.businessInfo\n\n- [Resource: BusinessInfo](#BusinessInfo)\n - [JSON representation](#BusinessInfo.SCHEMA_REPRESENTATION)\n- [PhoneVerificationState](#PhoneVerificationState)\n- [CustomerService](#CustomerService)\n - [JSON representation](#CustomerService.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: BusinessInfo\n----------------------\n\nThe `BusinessInfo` message contains essential information about a business.\n\nThis message captures key business details such as physical address, customer service contacts, and region-specific identifiers.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"address\": { object (/merchant/api/reference/rest/Shared.Types/PostalAddress) }, \"phone\": { object (/merchant/api/reference/rest/Shared.Types/PhoneNumber) }, \"phoneVerificationState\": enum (/merchant/api/reference/rest/accounts_v1/accounts.businessInfo#PhoneVerificationState), \"customerService\": { object (/merchant/api/reference/rest/accounts_v1/accounts.businessInfo#CustomerService) }, \"koreanBusinessRegistrationNumber\": string } ``` |\n\n| Fields ||\n|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo` |\n| `address` | `object (`[PostalAddress](/merchant/api/reference/rest/Shared.Types/PostalAddress)`)` Optional. The address of the business. Only `regionCode`, `addressLines`, `postalCode`, `administrativeArea` and `locality` fields are supported. All other fields are ignored. |\n| `phone` | `object (`[PhoneNumber](/merchant/api/reference/rest/Shared.Types/PhoneNumber)`)` Output only. The phone number of the business. |\n| `phoneVerificationState` | `enum (`[PhoneVerificationState](/merchant/api/reference/rest/accounts_v1/accounts.businessInfo#PhoneVerificationState)`)` Output only. The phone verification state of the business. |\n| `customerService` | `object (`[CustomerService](/merchant/api/reference/rest/accounts_v1/accounts.businessInfo#CustomerService)`)` Optional. The customer service of the business. |\n| `koreanBusinessRegistrationNumber` | `string` Optional. The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. |\n\nPhoneVerificationState\n----------------------\n\nThe phone verification state.\n\n| Enums ||\n|----------------------------------------|--------------------------------------|\n| `PHONE_VERIFICATION_STATE_UNSPECIFIED` | Default value. This value is unused. |\n| `PHONE_VERIFICATION_STATE_VERIFIED` | The phone is verified. |\n| `PHONE_VERIFICATION_STATE_UNVERIFIED` | The phone is unverified. |\n\nCustomerService\n---------------\n\nCustomer service information.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"uri\": string, \"email\": string, \"phone\": { object (/merchant/api/reference/rest/Shared.Types/PhoneNumber) } } ``` |\n\n| Fields ||\n|---------|----------------------------------------------------------------------------------------------------------------------------------------------------|\n| `uri` | `string` Optional. The URI where customer service may be found. |\n| `email` | `string` Optional. The email address where customer service may be reached. |\n| `phone` | `object (`[PhoneNumber](/merchant/api/reference/rest/Shared.Types/PhoneNumber)`)` Optional. The phone number where customer service may be called. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------------------------------------------|--------------------------------------------|\n| ### [getBusinessInfo](/merchant/api/reference/rest/accounts_v1/accounts.businessInfo/getBusinessInfo) | Retrieves the business info of an account. |\n| ### [updateBusinessInfo](/merchant/api/reference/rest/accounts_v1/accounts.businessInfo/updateBusinessInfo) | Updates the business info of an account. |"]]