我們即將停用內部部署 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{} 的其中一項。如果遇到任何錯誤,請參閱錯誤和狀態訊息