Vytvoření žádosti o export plateb

Článek
11/13/2024

Odešlete požadavek POST do koncového bodu rozhraní API a zařadíte do fronty novou žádost o export plateb.

Požadavek REST

metoda	Identifikátor URI žádosti
POST	`https://api.partner.microsoft.com/v1.0/payouts/payments?$filter={$filter}&fileformat=csv`

Parametry požadavku

Název	In	Požaduje se	Type	Popis
$filter	Dotaz	No	String	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.
fileFormat	Dotaz	No	String	Podporované hodnoty jsou .csv/.tsv. Výchozí hodnota je .csv, pokud není zadaná žádná hodnota.

Název	Popis	Typ	Formát
programName	Filtrujte podle jednoho nebo více programů, do kterých jste zaregistrovaní. Příklady hodnot – CSP Indirect Provider, CSP 2T Indirect Provider, 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’`

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

Název	Požadováno	Type	Popis
Autorizace	Ano	String	Autorizační nosný token
ms-correlationid	No	String	Interní sledování požadavků. Každý požadavek vygeneruje nový sledovací modul (GUID).
ms-requestid	No	String	ID idempotence požadavku.

Další informace najdete v hlavičce REST Partnerského centra.

Text požadavku

–

Odpověď rozhraní API

HTTP/1.1 202 Accepted

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

Název	Volitelné	Popis
Hodnota	false (nepravda)	Možné hodnoty a akce najdete v následující tabulce.

Hodnota	Akce klienta
requestId	ID žádosti o export
requestDateTime	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, když je soubor exportu připravený
Stav	Stav operace exportu Stav najdete v následujícím seznamu možných hodnot.

Možné hodnoty stavu

Zařazeno do fronty: Operace exportu nebyla spuštěna.
Zpracování: Probíhá operace exportu.
Selhání: Operace exportu selhala po opakovaných pokusech, 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.

Název	Popis
202 Přijato	Požadavek je přijat. Zadejte dotaz na adresu URL požadavku GET pro stav požadavku.

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

Název	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.
500 – Vnitřní chyba serveru	Rozhraní API nebo jedna z jejích závislostí nemůže požadavek splnit. Zkuste to později.
404 – Nenalezeno	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ě.

Sdílet prostřednictvím