วิธีใช้ Store Information API

คู่มือสำหรับดึงและอัปเดตข้อมูลพื้นฐานของร้านค้า (ชื่อร้าน・ประเภทร้าน・ข้อมูลติดต่อ・ที่อยู่) ผ่าน REST API คุณสามารถสร้างหน้าจอแก้ไขข้อมูลร้านค้าจากไคลเอนต์ที่ยืนยันตัวตนด้วยโทเคน เช่น แอปพนักงาน ได้

การยืนยันตัวตน

ใช้การยืนยันตัวตนเดียวกับการดึงรายการร้านค้า แนบ Authorization: Bearer แอกเซสโทเคน (โทเคนขอบเขต user) ในคำขอ และผู้เรียกต้องเป็นสมาชิกของบัญชีธุรกิจเป้าหมาย ไม่จำเป็นต้องมีขอบเขตเพิ่มเติม หากร้านค้าเป้าหมายไม่ได้อยู่ภายใต้บัญชีธุรกิจนั้น จะคืนค่า 404

ดึงร้านค้า 1 รายการ

ใช้สำหรับแสดงค่าเริ่มต้นของหน้าจอแก้ไข

GET /api/v1/me/organizations/{organizationId}/stores/{storeId}

ตัวอย่างเรสปอนส์ (รูปแบบ MeStore ซึ่งเป็นรูปแบบเดียวกับแต่ละรายการในรายการร้านค้า):

{
  "id": "store-id",
  "name": "渋谷店",
  "storeType": "Restaurant",
  "primaryCategory": "...",
  "status": "Active",
  "address": {
    "country": "JP",
    "prefecture": "東京都",
    "city": "渋谷区",
    "line1": "...",
    "line2": "...",
    "postalCode": "150-0001",
    "latitude": 35.6,
    "longitude": 139.7
  },
  "phone": "03-xxxx-xxxx",
  "websiteUrl": "https://...",
  "updatedAt": "2026-06-20T00:00:00Z"
}

อัปเดตข้อมูลร้านค้า

PUT /api/v1/me/organizations/{organizationId}/stores/{storeId}

รายการที่แก้ไขได้ ได้แก่ ชื่อร้าน (name)・ประเภทร้าน (storeType)・หมวดหมู่หลัก (primaryCategory)・สถานะ (status)・หมายเลขโทรศัพท์ (phone)・เว็บไซต์ (websiteUrl)・ที่อยู่ (postalCode / prefecture / city / line1 / line2 ใน address)

รองรับการอัปเดตบางส่วน รายการที่ไม่ได้ระบุ (เป็น null) จะไม่ถูกเปลี่ยนแปลง และการส่งสตริงว่างจะเป็นการล้างค่ารายการนั้น

ตัวอย่างคำขอ:

{
  "name": "渋谷本店",
  "phone": "03-1234-5678",
  "websiteUrl": "https://example.com",
  "address": {
    "postalCode": "150-0002",
    "prefecture": "東京都",
    "city": "渋谷区",
    "line1": "渋谷1-2-3",
    "line2": "ビル4F"
  }
}

จะได้ข้อมูลร้านค้าหลังอัปเดต (รูปแบบ MeStore เดียวกับตอนดึง) คืนมา หน้าจอสามารถวาดใหม่ด้วยเรสปอนส์นี้ได้

ข้อควรระวัง

• แม้จะอัปเดตที่อยู่ ฝั่งเซิร์ฟเวอร์จะไม่ทำจีโอโค้ดดิง (ดึงละติจูด・ลองจิจูดใหม่) ค่า country / latitude / longitude จะถูกคงไว้
• เวลาทำการ・วันหยุดประจำ・เวลาทำงานที่รับได้ อยู่นอกขอบเขตของ API นี้ กรุณาใช้ Business Hours API
• รายการที่ไม่ได้รวมอยู่ในบอดี้ของคำขอ (เช่น ID ภายนอก・ข้อมูลการเชื่อมต่อ POS) จะถูกคงไว้ทั้งหมด

เพจที่เกี่ยวข้อง

• การดึงรายการบัญชีธุรกิจ・ร้านค้า・เครื่อง POS
• วิธีใช้ Business Hours API