支払いエクスポート要求を作成する
API エンドポイントに POST 要求を送信して、支払いのための新しいエクスポート要求をキューに入れます。
REST 要求
Method | 要求 URI |
---|---|
投稿 | https://api.partner.microsoft.com/v1.0/payouts/payments?$filter={$filter}&fileformat=csv |
要求パラメーター
名前 | / | 必須 | タイプ | 説明 |
---|---|---|---|---|
$filter | クエリ | いいえ | String | これは省略可能なフィルターですが、パフォーマンスを向上させるためにフィルターを使用し、過去 3 年間のデータをエクスポートするのではなく、エクスポート データを制限することを強くお勧めします。 $filterオプションの完全なセットについては、次の表を参照してください。 |
fileFormat | クエリ | いいえ | String | サポートされている値は .csv/.tsv です。 値が指定されていない場合、既定値は .csv です。 |
名前 | Description | Type | 形式 |
---|---|---|---|
programName | 登録している 1 つ以上のプログラムでフィルター処理します。 値の例 - 'CSP 間接プロバイダー'、'CSP 2T 間接プロバイダー'、'CSP Direct Bill Partner'、'CSP 1T Direct Partner'、'CSP Indirect Reseller'、'CSP 2T Indirect Reseller' | String | {baseUrl}/v1.0/payouts/payments?$filter=?$filter=programName=’CSP Indirect Provider’ |
複数の要求パラメーターを含むサンプル支払いフィルター
“?$filter=payoutStatusUpdateTS le 2019-09-25T23:11:55.647Z and (enrollmentParticipantId eq 'XXXXXXX') and (programName eq 'CSP Direct Bill Partner') and (payoutOrderType eq 'REBATE') and (paymentId eq '000000000000')”
要求ヘッダー
名前 | Required | タイプ | 説明 |
---|---|---|---|
承認 | はい | String | 承認ベアラー トークン。 |
ms-correlationid | いいえ | String | 内部要求トラッカー。 各要求では、新しいトラッカー (GUID) が生成されます。 |
ms-requestid | いいえ | String | 要求のべき等 ID。 |
詳細については、パートナー センターの REST ヘッダーに関するページを参照してください。
要求本文
該当なし
API 応答
HTTP/1.1 202 Accepted
API 応答ペイロードは、次の属性を返します。
名前 | 省略可能 | 説明 |
---|---|---|
Value | false | 使用可能な値とアクションについては、次の表を参照してください。 |
Value | クライアント側の処理 |
---|---|
requestId | エクスポート要求の要求 ID |
requestDateTime | エクスポート要求の開始日時 |
requestPath | エクスポート要求のクエリ パス。 |
requestQueryString | エクスポート要求の一部として使用されるフィルター。 |
blobLocation | エクスポート ファイルの準備ができたときにトークンを含む BLOB リソース |
Status | エクスポート操作の状態。 状態に使用できる値の一覧を次に示します。 |
状態に使用できる値
- キューに入っている: エクスポート操作が開始されていません
- 処理: エクスポート操作が進行中です
- 失敗: 再試行後にエクスポート操作が失敗しました。新しい要求をキューに登録してみてください
- 完了: エクスポート操作が完了し、エクスポート ファイルをダウンロードする準備ができました。
応答の例:
{
"value": [
{
"requestId": "93c2b3cf-c6d8-4e7e-ade1-007768a6eba4",
"requestDateTime": "2023-05-25T21:20:46.3727561Z",
"requestPath": "/v1.0/payouts/payments",
"requestQueryString": "paymentDate ge 2023-03-01 and paymentDate le 2023-04-12",
"blobLocation": "",
"status": "Queued"
}
],
"nextLink": null,
"totalCount": 1
}
API は HTTP 状態 202 を返します。
名前 | 説明 |
---|---|
202 Accepted | 要求は受け入れられます。 要求の状態を GET 要求 URL に照会します。 |
要求に応じて、API は他の標準状態を返すことができます。
名前 | 説明 |
---|---|
400 要求が正しくありません | データが見つからないか、正しくありません。 |
401 権限がありません | 呼び出し元は認証されないため、最初の呼び出しを行う前にパートナー API サービスで認証する必要があります。 |
403 無効 | 呼び出し元は要求を行う権限がありません。 |
500 内部サーバー エラー | API またはその依存関係の 1 つが要求を満たすことができません。 後でもう一度試してみてください。 |
404 見つかりません | 入力パラメーターではリソースを使用できません。 |
429 レート制限 | 同じ型の要求が多すぎます。 しばらくしてからお試しください。 |