[API] 組織

組織
API

組織データ

組織データは下記が表示、編集可能です。

名前 タイプ 必須 最大値 メモ
id 文字列 68文字 閲覧のみ、店舗ID
name 文字列 必須 68文字 店舗名
postalCode 文字列 必須 12文字 郵便番号
country 文字列 必須 24文字 国名
prefecture 文字列 必須 24文字 都道府県
locality 文字列 必須 24文字 市区町村
address1 文字列 必須 24文字 住所、番地
address2 文字列 24文字|ビル名、部屋名
tel 文字列 必須 24文字 電話番号
email 文字列 必須 48文字 メールアドレス
smaregiContractId 文字列 閲覧のみ
validPlans オブジェクト 閲覧のみ、有効なプランの一覧

組織一覧の取得

リクエスト

curl -X 'GET' \
  'https://api.receiptroller.com/account/organizations' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {YOUR TOKEN}'

レスポンス

 content-encoding: gzip 
 content-type: application/json; charset=utf-8 
 date: Sun,26 Mar 2023 01:57:13 GMT 
 request-context: appId=cid-v1:6063436e-6416-4d93-ab8b-2ff42f1102a0 
 server: Microsoft-IIS/10.0 
 transfer-encoding: chunked 
 vary: Accept-Encoding 
 x-powered-by: ASP.NET 
 
[
  {
    "id": "9356c405-b51a-4c40-8a11-9898c6d4be66",
    "name": "下田商店"
  },
  {
    "id": "8fe6866d-c5e1-4703-875d-d2bdfa10bc2a",
    "name": "TOKYO ANIME"
  },
  {
    "id": "e53f4703-66cf-4d08-b6fe-77a1c65b4607",
    "name": "ABCクッキー"
  },
  {
    "id": "61fd7924-6a42-4837-bd84-6b9f3046c033",
    "name": "渋谷アパレル"
  }
]

組織詳細取得

リクエスト

curl -X 'GET' \
  'https://api.receiptroller.com/account/organization/8fe6866d-c5e1-4703-875d-d2bdfa10bc2a' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {YOUR TOKEN}'

レスポンス

 content-encoding: gzip 
 content-type: application/json; charset=utf-8 
 date: Sun,26 Mar 2023 01:59:23 GMT 
 request-context: appId=cid-v1:6063436e-6416-4d93-ab8b-2ff42f1102a0 
 server: Microsoft-IIS/10.0 
 transfer-encoding: chunked 
 vary: Accept-Encoding 
 x-powered-by: ASP.NET 
 
{
  "id": "8fe6866d-c5e1-4703-875d-d2bdfa10bc2a",
  "name": "TOKYO ANIME",
  "postalCode": "",
  "country": "",
  "prefecture": "",
  "locality": "",
  "address1": "",
  "address2": null,
  "tel": null,
  "email": null,
  "smaregiContractId": null,
  "validPlans": []
}

組織情報の更新

リクエスト

curl -X 'POST' \
  'https://api.receiptroller.com/account/organization/update' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {YOUR TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "8fe6866d-c5e1-4703-875d-d2bdfa10bc2a",
  "Name":"TOKYO ANIME",
  "postalCode": "3800096",
  "country": "JAPAN",
  "prefecture": "長野県",
  "locality": "長野市",
  "address1": "鶴賀七瀬123-12"
}'

レスポンス


 access-control-allow-credentials: true 
 access-control-allow-origin: https://api.receiptroller.com 
 content-encoding: gzip 
 content-type: application/json; charset=utf-8 
 date: Sun,26 Mar 2023 02:04:22 GMT 
 request-context: appId=cid-v1:6063436e-6416-4d93-ab8b-2ff42f1102a0 
 server: Microsoft-IIS/10.0 
 transfer-encoding: chunked 
 vary: Origin,Accept-Encoding 
 x-powered-by: ASP.NET 
 
{
  "id": "8fe6866d-c5e1-4703-875d-d2bdfa10bc2a",
  "name": "TOKYO ANIME",
  "postalCode": "3800096",
  "country": "JAPAN",
  "prefecture": "長野県",
  "locality": "長野市",
  "address1": "鶴賀七瀬123-12",
  "address2": null,
  "tel": null,
  "email": null,
  "smaregiContractId": null
}
更新日: 2023-06-27