利用可能店舗更新API

概要

送信されたリクエストデータで利用可能店舗を更新します。

URL

/cmapi/v2/providers/${provider_uuid}/

メソッド

PATCH

リクエスト

リクエストパラメータ

なし

リクエストボディ

基底オブジェクト

キー	型	必須	デフォルト	許容値	説明	詳細	備考
name	文字列	-	-		利用可能店舗名	-	-
additional_items	オブジェクト	-	-	-	任意追加項目	「リクエスト "additional_items" オブジェクト」を参照。	"additional_items" 内部の部分更新はできません。リクエストされたデータでの一括更新となります。
latitude	文字列	-	-		緯度	-	-
longitude	文字列	-	-		経度	-	-

リクエスト "additional_items" オブジェクト

• "additional_items" には、 FANSHIP システム公式の 6 項目の他に、ユーザ独自の項目を付与することが可能です。
  • ユーザ独自の項目が付与されていた場合、"additional_items" に値が登録される。
• "additional_items" オブジェクト内のキー名の命名規則については次の通り(value については特に制限を設けません)。
  • FANSHIP システム ： [A-Za-z][A-Za-z0-9_\-]*
  • ユーザ独自 ： _[A-Za-z0-9_\-]+

※ユーザ独自項目（以下記載の 6 項目以外）をご利用される場合は、必ずご相談ください。

キー	型	必須	デフォルト	許容値	説明	詳細	備考
hours	文字列	-	-		営業時間	-	-
phone	文字列	-	-		電話番号	-	-
address	文字列	-	-		住所	-	-
holiday	文字列	-	-		定休日	-	-
shortName	文字列	-	-		店舗名略称	-	-
thumbnail	文字列	-	-		サムネイル	サムネイル画像データのフルパス（https:// ... ）	画像指定に関する仕様については「画像登録」シートを参照。

リクエストのサンプル

{
    "name": "店舗名",
    "latitude": 35.693286,
    "longitude": 139.693197,
    "additional_items": {
        "hours": "10:00-22:00",
        "phone": "0311112222",
        "address": "東京都港区",
        "holiday": "土日祝日",
        "shortName": "略称",
        "thumbnail": "https://${domain}/storage/1/image/2019/03/26/072128329898/8rqgJnh6AC.png/"
    }
}

レスポンス

メディアタイプ

application/json

成功時レスポンス

http status 200 を返却

レスポンスのサンプル

なし