我们将弃用本地 API。请参阅我们的本地 API 弃用文档,了解弃用详情以及如何迁移到我们的下一代云端 API。

商业简介设置

/v1/settings/business/profile

使用 /v1/settings/business/profile 端点配置以下商业简介设置:商业地址、商家描述、商家联系电邮地址、商家所属行业和商家网站。

准备工作

  • 您必须使用 admin 帐号访问商业简介设置。

检索

执行 GET API 调用,以检索您的商业简介设置。

示例

GET /v1/settings/business/profile

如果调用成功,则响应包括含有商业简介数据的 profile 对象。如需详细了解有关此数据的描述,请查看下方的参数列表

{
   "settings": {
     "business": {
        "profile": {
          "address": "new-business-address",
          "description": "business-description",
          "email": "new-business-email",
          "vertical": "business-industry",
          "websites": [ "website-1", "website-2" ]
        }
      }
}

如果遇到任何错误,请参阅错误和状态消息

更新商业简介设置

执行 POST API 调用,以更新您的商业简介设置。

示例

POST /v1/settings/business/profile
{
    "address": "your-business-address",
    "description": "your-business-description",
    "email": "your-business-email",
    "vertical": "your-business-industry",
    "websites": [ "your-website-1", "your-website-2" ]
}

参数

名称描述

address

类型:字符串

商业地址。不超过 256 个字符

description

类型:字符串

商家描述。不超过 512 个字符

email

类型:字符串

商家联系电邮地址(有效的电邮地址格式)。不超过 128 个字符

vertical

类型:字符串

商家所属行业。必须为以下可接受值之一:

  • Automotive
  • Beauty, Spa and Salon
  • Clothing and Apparel
  • Education
  • Entertainment
  • Event Planning and Service
  • Finance and Banking
  • Food and Grocery
  • Public Service
  • Hotel and Lodging
  • Medical and Health
  • Non-profit
  • Professional Services
  • Shopping and Retail
  • Travel and Transportation
  • Restaurant
  • Other

商家所属行业一经创建,即无法将其重置为空值。

websites

类型:字符串数组

与商家关联的网址(包含 http://https://),例如网站、Facebook 公共主页和 Instagram。不超过 2 个网站,每个网址不超过 256 个字符

部分更新

现在,如果您仅需使用新信息更新若干字段,可以提交以下请求,从而仅更改必要字段:

  POST /v1/settings/business/profile
{
    "address": "new-business-address",
    "email": "new-business-email"
}

若请求成功,系统会返回 HTTP 状态代码 200 OK 以及 null{}。如果遇到任何错误,请参阅错误和状态消息