我們即將停用內部部署 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

類型:字串陣列

與商業(例如網站、Facebook 粉絲專頁、Instagram)相關的網址(包括 http://https://)。最多 2 個網站,每個網站最多 256 個字元

部分更新

如果只需要更新部分欄位的新資訊,可發出只會變更必要欄位的要求:

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

如果要求成功,系統會傳回 HTTP 狀態代碼 200 OK,以及 null{}。如果發生任何錯誤,請參閱錯誤和狀態訊息