getDiscountList

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

Classic/VPC環境で利用できます。

アカウントが保有する割引リストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET、POST	/discount/getDiscountList

リクエストヘッダ

NAVERクラウドプラットフォームで共通して使用されるヘッダの詳細は、Ncloud APIの共通ヘッダをご参照ください。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	Optional	ページ番号
`pageSize`	Integer	Optional	ページサイズ 1,000以下(デフォルト: 1,000)
`isOrganization`	Boolean	Optional	Organizationサービスアカウントの統合照会かどうかマスターのみ使用可能 `isOrganization`、`isPartner`のいずれも`true`の場合、エラーを返す
`isPartner`	Boolean	Optional	パートナーアカウントの照会かどうかパートナー代表のみ使用可能 `isOrganization`、`isPartner`のいずれも`true`の場合、エラーを返す
`memberNoList`	List<String>	Optional	会員番号リストマスターまたはパートナー代表のみ使用可能
`discountTypeCode`	String	Optional	割引タイプ `PRODUCT` \| `CREDIT` \| `COIN` `PRODUCT`: サービス料金割引 `CREDIT`: クレジット `COIN`: コイン
`startMonth`	String	Optional	照会開始月(yyyyMM) 最大3か月照会可能 <例> 202401
`endMonth`	String	Optional	照会最終月(yyyyMM) 最大3か月照会可能 <例> 202403
`isValidDiscount`	Boolean	Optional	有効な割引だけ照会するかどうか `true` \| `false` `true`: 有効な割引だけ照会 `false`: すべての割引を照会
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location  --request GET 'https://billingapi.apigw.ntruss.com/billing/v1/discount/getDiscountList?startMonth=202401&endMonth=202403&isValidDiscount=true&responseFormatType=xml' \
--header 'x-ncp-apigw-timestamp: {timestamp}' \
--header 'x-ncp-iam-access-key: {access key}' \
--header 'x-ncp-apigw-signature-v2: {signature}' \

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、DiscountListをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

<?xml version="1.0" encoding="UTF-8"?>
<getDiscountListResponse>
  <requestId>b797****-****-****-****-****6fab4b70</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>2</totalRows>
  <discountList>
    <discount>
      <memberNo>******</memberNo>
      <discountNo>54</discountNo>
      <discountType>
        <code>COIN</code>
        <codeName>Coin</codeName>
      </discountType>
      <discountName>銀行振込(農協)</discountName>
      <discountProcessMethod>
        <code>FXSUM</code>
        <codeName>Flat rate</codeName>
      </discountProcessMethod>
      <discountValue>100000</discountValue>
      <validityStartMonth>202007</validityStartMonth>
      <validityEndMonth>202307</validityEndMonth>
    </discount>
    <discount>
      <memberNo>******</memberNo>
      <discountNo>158</discountNo>
      <discountType>
        <code>COIN</code>
        <codeName>Coin</codeName>
      </discountType>
      <discountName>クレジットカード(TEST)</discountName>
      <discountProcessMethod>
        <code>FXSUM</code>
        <codeName>Flat rate</codeName>
      </discountProcessMethod>
      <discountValue>10000</discountValue>
      <validityStartMonth>202007</validityStartMonth>
      <validityEndMonth>202307</validityEndMonth>
    </discount>
  </discountList>
</getDiscountListResponse>

この記事は役に立ちましたか?

What's Next

getCoinHistoryList

リクエスト
レスポンス

タグ

Discount