オプション商品の登録

POST /partners/customers/{domainId}/option-products

オプション商品を登録 (適用) する。

  • トライアル猶予期間は適用 (購入) 不可能。
  • アップグレード中は適用 (購入) 不可能。
  • アーカイブ (トーク)
    • Standard/Standard Trial/Advanced/Advanced Trial プラン のみ適用 (購入) 可能。
  • アーカイブ (メール)
    • Advanced/Advanced Trial プラン のみ適用 (購入) 可能。
  • 追加ストレージ
    • Standard/Advanced プラン のみ適用 (購入) 可能。
  • Drive
    • Standard/Standard Trial/Advanced/Advanced Trial プラン のみ適用 (購入) 可能。
  • アドレス帳登録数拡張
    • Standard/Advanced プラン のみ適用 (購入) 可能。
  • 既にオプション商品の予約設定が進行中の場合、過去の予約設定は削除され、即時適用 (購入) される。

注意
この API は引き続きご利用いただけますが、ドキュメントは 契約中の商品リストの取得 をご参照ください。

Authorization

oauth2

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

Scope

partner

Request

HTTP Request

POST

https://www.worksapis.com/v1.0/partners/customers/{domainId}/option-products

Path Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID


required
example : 10000001 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Request Body

PropertyTypeDescription
optionProductId string 

オプション商品 ID

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

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

サブオプション商品 ID

  • オプション商品 ID が ACV2 の場合
    • ACV201 : アーカイブ (トーク)
  • オプション商品 ID が ACV3 の場合
    • ACV301 : アーカイブ (メール)
  • オプション商品 ID が DRV の場合
    • DRV01: Drive (for STD)
    • DRV_PS: Drive Plus (for STD)
    • 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 万件まで)

required
Allowed values : ACV201, ACV301, DRV01, DRV_PS, DRV_PA, SSTG201, SSTG202, SSTG203, SSTG204, SSTG205, SSTG206, SSTG207, BCT01, BCT02, BCT03, BCT04 

Request Example

追加ストレージ 5TB を購入する

1{
2 "optionProductId": "SSTG2",
3 "subOptionId": "SSTG202"
4}

アーカイブ (トーク) を購入する

1{
2 "optionProductId": "ACV2",
3 "subOptionId": "ACV201"
4}

Response

HTTP 201

OK

PropertyTypeDescription
optionProductId string 

オプション商品 ID

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

Allowed values : ACV2, ACV3, DRV, SSTG2, BCT 
subOptionId string 

サブオプション商品 ID

  • オプション商品 ID が ACV2 の場合
    • ACV201 : アーカイブ (トーク)
  • オプション商品 ID が ACV3 の場合
    • ACV301 : アーカイブ (メール)
  • オプション商品 ID が DRV の場合
    • DRV01: Drive (for STD)
    • DRV_PS: Drive Plus (for STD)
    • 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 万件まで)

Allowed values : ACV201, ACV301, DRV01, DRV_PS, DRV_PA, SSTG201, SSTG202, SSTG203, SSTG204, SSTG205, SSTG206, SSTG207, BCT01, BCT02, BCT03, BCT04 
appliedTime string 

適用 (購入) 日時


format : date-time
readOnly : true 
quantity integer 

契約数

  • optionProductIdSSTG の場合、単位は TB
  • その他は null

readOnly : true
nullable : true 

Response Example

example

1{
2 "optionProductId": "SSTG2",
3 "subOptionId": "SSTG202",
4 "quantity": null,
5 "appliedTime": "2021-11-01T00:00:00.000Z"
6}