Vytvoření žádosti o export plateb

Odešlete požadavek POST do koncového bodu rozhraní API pro zařazení do fronty nové žádosti o export plateb.

Požadavek REST

Metoda	Žádost URI
POST	https://api.partner.microsoft.com/v1.0/payouts/payments?$filter={$filter}&fileformat=csv

Parametry požadavku

Jméno	V	Požadováno	Typ	Popis
$filter	Dotaz	Ne	Řetězec	I když se jedná o volitelný filtr, důrazně doporučujeme používat filtry pro rychlejší výkon a omezení exportovaných dat místo exportu za poslední tři roky dat. Úplnou sadu možností $filter najdete v následující tabulce.
formát souboru	Dotaz	Ne	Řetězec	Podporované hodnoty jsou .csv/.tsv. Výchozí hodnota je .csv, pokud není zadaná žádná hodnota.

Jméno	Popis	Typ	Formát
programName	Filtrujte podle jednoho nebo více programů, do kterých jste zaregistrovaní. Příklady hodnot – „CSP nepřímý poskytovatel“, „CSP 2T nepřímý poskytovatel“, „CSP přímý fakturační partner“, „CSP 1T přímý partner“, „CSP nepřímý prodejce“, „CSP 2T nepřímý prodejce“	Řetězec	{baseUrl}/v1.0/payouts/payments?$filter=?$filter=programName=’CSP Indirect Provider’

Ukázkový filtr plateb s více parametry požadavku

“?$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')”

Hlavička požadavku

Jméno	Požadováno	Typ	Popis
Oprávnění	Ano	Řetězec	Autorizační nosný token
ms-correlationid	Ne	Řetězec	Interní systém sledování požadavků. Každý požadavek vygeneruje nový sledovací modul (GUID).
ms-requestid	Ne	Řetězec	Idempotence ID požadavku.

Chcete-li se dozvědět více, podívejte se na REST hlavičky Partner Center.

Tělo žádosti

Není k dispozici

Odpověď rozhraní API

HTTP/1.1 202 Accepted

Datová část odpovědi rozhraní API vrátí následující atributy:

Jméno	Volitelný	Popis
Hodnota	falešný	Možné hodnoty a akce najdete v následující tabulce.

Hodnota	Akce klienta
ID žádosti	ID žádosti o export
žádostDatumČas	Datum zahájení žádosti o export
requestPath	Cesta dotazu na žádost o export
requestQueryString	Filtr použitý jako součást žádosti o export.
BlobLocation	Prostředek objektu blob s tokenem, který je k dispozici, když je exportovaný soubor připraven.
Stav	Stav operace exportu Stav najdete v následujícím seznamu možných hodnot.

Možné hodnoty stavu

• Ve frontě: Operace exportu nezačala
• Zpracování: Probíhá operace exportu
• selhalo: Operace exportu se po několika pokusech nezdařila, zkuste zařadit novou žádost do fronty.
• Dokončeno: Operace exportu byla dokončena a soubor exportu je připravený ke stažení.

Ukázková odpověď:

{
    "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
}

Rozhraní API vrátí stav HTTP 202.

Jméno	Popis
202 Přijato	Požadavek je přijat. Prozkoumejte URL GET požadavku pro stav požadavku.

V závislosti na požadavku může rozhraní API vrátit další standardní stavy:

Jméno	Popis
400 Chybný požadavek	Došlo k chybějícím nebo nesprávným datům.
401 Neautorizováno	Volající není ověřený a musí se před prvním voláním ověřit ve službě partnerského rozhraní API.
403 Zakázáno	Volající nemá oprávnění k provedení žádosti.
Vnitřní chyba serveru 500	Rozhraní API nebo jedna z jeho závislostí nemůže požadavek splnit. Zkuste to znovu později.
404 Nenalezena	Prostředek není dostupný se vstupními parametry.
429 Omezování rychlosti	Příliš mnoho požadavků stejného typu. Zkuste to po nějaké době.