PATCH/partners/customers/{domainId}/option-product-orders/{optionProductId}

顧客企業のオプション商品の予約設定を更新する。オプション商品の予約適用の種類 (type) に応じて設定項目を変更可能。

  • 顧客企業のオプション商品の予約設定がある場合のみ更新可能。
  • 年額契約の場合、解約したオプション商品の再適用 (再購入) は翌月から可能。
  • アーカイブ (トーク)
    • Standard/Standard Trial/Advanced/Advanced Trial プラン のみ設定可能。
    • 適用 (購入) 時の注意点 (type: APPLY)
      • 当日以降から契約終了日の翌日まで適用日を指定可能。
    • 解約時の注意点 (type: CANCEL)
      • 当日以降から契約終了日の翌日まで適用日を指定可能。
  • アーカイブ (メール)
    • Advanced/Advanced Trial プラン のみ設定可能。
    • 適用 (購入) 時の注意点 (type: APPLY)
      • 当日以降から契約終了日の翌日まで適用日を指定可能。
    • 解約時の注意点 (type: CANCEL)
      • 当日以降から契約終了日の翌日まで適用日を指定可能。
  • 追加ストレージ
    • Standard/Advanced プラン のみ登録可能。
    • 適用 (購入) 時の注意点 (type: APPLY)
      • 当日以降から契約終了日の翌日まで適用日を指定可能。
    • 解約時の注意点 (type: CANCEL)
      • 当日以降から契約終了日の翌日まで適用日を指定可能。
    • 変更時の注意点 (type: MODIFY)
      • 利用中のオプション商品と同一オプション商品には変更不可能。
      • 上位オプション商品へアップグレードのみ設定可能。
      • アップグレードの際、翌日から契約終了日の翌日まで適用日を指定可能。
  • Drive
    • Standard/Standard Trial/Advanced/Advanced Trial プラン のみ設定可能。
    • 適用 (購入) 時の注意点 (type: APPLY)
      • 当日以降から契約終了日の翌日まで適用日を指定可能。
    • 解約時の注意点 (type: CANCEL)
      • 当日以降から契約終了日の翌日まで適用日を指定可能。
  • アドレス帳登録数拡張
    • Standard/Advanced プラン のみ登録可能。
    • 適用 (購入) 時の注意点 (type: APPLY)
      • 当日以降から契約終了日の翌日まで適用日を指定可能。
    • 解約時の注意点 (type: CANCEL)
      • 当日以降から契約終了日の翌日まで適用日を指定可能。
    • 変更時の注意点 (type: MODIFY)
      • 利用中のオプション商品と同一オプション商品には変更不可能。
      • 上位オプション商品へアップグレードのみ設定可能。
      • アップグレードの際、翌日から契約終了日の翌日まで適用日を指定可能。

注意
この API は引き続きご利用いただけますが、ドキュメントは オプション商品の予約設定の変更 をご参照ください。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

partner

HTTP Request

PATCHhttps://www.worksapis.com/v1.0/partners/customers/{domainId}/option-product-orders/{optionProductId}

Path Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID


required
example : 10000001 
optionProductId string 

オプション商品 ID

  • ACV2 : アーカイブ (トーク)
  • ACV3 : アーカイブ (メール)
  • DRV : Drive
  • SSTG2 : 追加ストレージ
  • BCT : アドレス帳登録数拡張

required
Allowed values : ACV2, ACV3, SSTG2, DRV, BCT 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Request Body

PropertyTypeDescription
subOptionId string 

サブオプション商品 ID

  • オプション商品 ID が ACV2 の場合
    • ACV200 : アーカイブ (トーク) Trial
    • ACV201 : アーカイブ (トーク)
  • オプション商品 ID が ACV3 の場合
    • ACV300 : アーカイブ (メール) Trial
    • ACV301 : アーカイブ (メール)
  • オプション商品 ID が DRV の場合
    • DRV00: Drive Trial (for STD)
    • DRV01: Drive (for STD)
    • DRV_PS_T: Drive Plus Trial (for STD)
    • DRV_PS: Drive Plus (for STD)
    • DRV_PA_T: Drive Plus Trial (for ADV)
    • DRV_PA: Drive Plus (for ADV)
  • オプション商品 ID が SSTG2 の場合
    • SSTG201 : 追加ストレージ (1TB)
    • SSTG202 : 追加ストレージ (5TB)
    • SSTG203 : 追加ストレージ (10TB)
    • SSTG204 : 追加ストレージ (25TB)
    • SSTG205 : 追加ストレージ (50TB)
    • SSTG206 : 追加ストレージ (100TB)
    • SSTG207 : 追加ストレージ (500TB)
  • オプション商品 ID が BCT の場合
    • BCT01 : アドレス帳登録数拡張 (25 万件まで)
    • BCT02 : アドレス帳登録数拡張 (50 万件まで)
    • BCT03 : アドレス帳登録数拡張 (150 万件まで)
    • BCT04 : アドレス帳登録数拡張 (500 万件まで)
  • オプション商品 ID が CST_S の場合
    • CST_S00 : CXトーク 対応者5席の窓口 Trial
    • CST_S01 : CXトーク 対応者5席の窓口
  • オプション商品 ID が CST_M の場合
    • CST_M00 : CXトーク 対応者30席の窓口 Trial
    • CST_M01 : CXトーク 対応者30席の窓口
  • オプション商品 ID が CST_L の場合
    • CST_L00 : CXトーク 対応者100席の窓口 Trial
    • CST_L01 : CXトーク 対応者100席の窓口

Allowed values : ACV200, ACV201, ACV300, ACV301, DRV00, DRV01, DRV_PS_T, DRV_PS, DRV_PA_T, DRV_PA, SSTG201, SSTG202, SSTG203, SSTG204, SSTG205, SSTG206, SSTG207, BCT01, BCT02, BCT03, BCT04, CST_S00, CST_S01, CST_M00, CST_M01, CST_L00, CST_L01 
applyDate string 

適用日


required
example : 2021-11-01 

Request Example

Drive の適用日を 2021-11-01 に変更する

1{2  "subOptionId": "DRV01",3  "applyDate": "2021-11-01"4}

Response

HTTP 200

OK

PropertyTypeDescription
optionProductId string 

オプション商品 ID

  • ACV2 : アーカイブ (トーク)
  • ACV3 : アーカイブ (メール)
  • DRV : Drive
  • SSTG2 : 追加ストレージ
  • BCT : アドレス帳登録数拡張
  • CST_S : CXトーク 対応者5席の窓口
  • CST_M : CXトーク 対応者30席の窓口
  • CST_L : CXトーク 対応者100席の窓口

Allowed values : ACV2, ACV3, DRV, SSTG2, BCT, CST_S, CST_M, CST_L 
subOptionId string 

サブオプション商品 ID

  • オプション商品 ID が ACV2 の場合
    • ACV200 : アーカイブ (トーク) Trial
    • ACV201 : アーカイブ (トーク)
  • オプション商品 ID が ACV3 の場合
    • ACV300 : アーカイブ (メール) Trial
    • ACV301 : アーカイブ (メール)
  • オプション商品 ID が DRV の場合
    • DRV00: Drive Trial (for STD)
    • DRV01: Drive (for STD)
    • DRV_PS_T: Drive Plus Trial (for STD)
    • DRV_PS: Drive Plus (for STD)
    • DRV_PA_T: Drive Plus Trial (for ADV)
    • DRV_PA: Drive Plus (for ADV)
  • オプション商品 ID が SSTG2 の場合
    • SSTG201 : 追加ストレージ (1TB)
    • SSTG202 : 追加ストレージ (5TB)
    • SSTG203 : 追加ストレージ (10TB)
    • SSTG204 : 追加ストレージ (25TB)
    • SSTG205 : 追加ストレージ (50TB)
    • SSTG206 : 追加ストレージ (100TB)
    • SSTG207 : 追加ストレージ (500TB)
  • オプション商品 ID が BCT の場合
    • BCT01 : アドレス帳登録数拡張 (25 万件まで)
    • BCT02 : アドレス帳登録数拡張 (50 万件まで)
    • BCT03 : アドレス帳登録数拡張 (150 万件まで)
    • BCT04 : アドレス帳登録数拡張 (500 万件まで)
  • オプション商品 ID が CST_S の場合
    • CST_S00 : CXトーク 対応者5席の窓口 Trial
    • CST_S01 : CXトーク 対応者5席の窓口
  • オプション商品 ID が CST_M の場合
    • CST_M00 : CXトーク 対応者30席の窓口 Trial
    • CST_M01 : CXトーク 対応者30席の窓口
  • オプション商品 ID が CST_L の場合
    • CST_L00 : CXトーク 対応者100席の窓口 Trial
    • CST_L01 : CXトーク 対応者100席の窓口

Allowed values : ACV200, ACV201, ACV300, ACV301, DRV00, DRV01, DRV_PS_T, DRV_PS, DRV_PA_T, DRV_PA, SSTG201, SSTG202, SSTG203, SSTG204, SSTG205, SSTG206, SSTG207, BCT01, BCT02, BCT03, BCT04, CST_S00, CST_S01, CST_M00, CST_M01, CST_L00, CST_L01 
type string 

オプション商品の予約タイプ

  • APPLY : 適用
  • MODIFY : 変更
  • CANCEL :解約

Allowed values : APPLY, MODIFY, CANCEL 
quantity integer 

契約数

  • optionProductId が SSTG の場合、単位は TB
  • その他は null

readOnly : true
nullable : true 
applyDate string 

適用日


format : date 

Response Example

example

1{2  "optionProductId": "SSTG2",3  "subOptionId": "SSTG202",4  "type": "APPLY",5  "quantity": null,6  "applyDate": "2021-11-01"7}