利用可能店舗新規作成API

概要

POSTされたデータを使用して、新しく利用可能店舗を作成します。

URL

/cmapi/v2/providers/

メソッド

POST

リクエスト

リクエストパラメータ

なし

リクエストボディ

基底オブジェクト

キー	型	必須	デフォルト	許容値	説明	詳細	備考
name	文字列	o	-	1文字以上 60文字以下	利用可能店舗名	-	-
additional_items	オブジェクト	o	-	-	任意追加項目	「リクエスト "additional_items" オブジェクト」を参照。	-
latitude	文字列	-	""	200文字以下	緯度	-	-
longitude	文字列	-	""	200文字以下	経度	-	-

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

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

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

キー	型	必須	デフォルト	許容値	説明	詳細	備考
hours	文字列	-	""		営業時間	-	-
phone	文字列	-	""		電話番号	-	-
address	文字列	-	""		住所	-	-
holiday	文字列	-	""		定休日	-	-
shortName	文字列	o	-	1文字以上 20文字以下	店舗名略称	-	-
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 201 を返却し、作成したリソースを指し示す Location ヘッダを返却

レスポンスのサンプル

なし