Partner payouts - Creates a new payments export request
Toto rozhraní API umožňuje vytvořit novou žádost o export plateb. Pro každou žádost doporučujeme použít $filter param. Níže se dozvíte, jak se používají filtry a všechny filtry dostupné v rozhraní pro export (UX) jsou také dostupné prostřednictvím tohoto rozhraní API a poskytují flexibilitu a konzistenci při filtrování dat.
POST https://api.partnercenter.microsoft.com/v{version}/payouts/paymentsPOST https://api.partnercenter.microsoft.com/v{version}/payouts/payments?$filter={$filter}&enrollmentParticipantId={enrollmentParticipantId}&paymentId={paymentId}&payoutStatusUpdateTS={payoutStatusUpdateTS}&paymentAmount={paymentAmount}&payoutOrderType={payoutOrderType}&Multiple filters={Multiple filters}Parametry identifikátoru URI
| Name | V | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
version
|
path | True |
string |
|
|
$filter
|
query |
string |
Parametr dotazu $filter je volitelný parametr pro vytvoření operace exportu. Důrazně ale doporučujeme použít $filter pro lepší výkon a rychlejší dostupnost sestavy exportu. Níže jsou uvedeny některé filtry klíčových atributů, které je možné použít jako součást operace exportu. |
|
|
enrollment
|
query |
int |
Zaregistrovaný filtr ID MPN pro žádost o export Využití: {baseUrl}/payouts/payments?$filter=enrollmentParticipantId=12345 |
|
|
Multiple filters
|
query |
string |
Tady je ukázkový dotaz s více filtry pro požadavek na export. Využití: {baseUrl}/payouts/payments?$filter=payoutStatusUpdateTS ge 2023-01-01 a payoutStatusUpdateTS le 2023-2023-05-31 a (enrollmentParticipantId eq 'XXXXXXX') a (programName eq 'CSP Direct Bill Partner') a (payoutOrderType eq 'RABAT') a (paymentId eq 'xxxxxxx') |
|
|
payment
|
query |
double |
Částka platby pro filtrování plateb pro žádost o export Využití: {baseUrl}/payouts/payments?$filter=paymentAmount ge 2000 a paymentAmount le 5000 |
|
|
payment
|
query |
int |
Filtr PaymentId pro žádost o export Využití: {baseUrl}/payouts/payments?$filter=paymentId=123456 |
|
|
payout
|
query |
string |
Typ objednávky výplaty (Rabat, coop, Poplatek, Prodej) pro filtrování plateb za žádost o export. Využití: {baseUrl}/payouts/payments?$filter=?$filter=payoutOrderType='RABAT' |
|
|
payout
|
query |
string |
Datum stavu výplaty pro filtrování plateb pro žádost o export Využití: {baseUrl}/payouts/transactionhistory?$filter=payoutStatusUpdateTS ge 2023-03-01 a payoutStatusUpdateTS le 2023-04-12 |
Hlavička požadavku
| Name | Vyžadováno | Typ | Description |
|---|---|---|---|
| Authorization | True |
string |
Autorizační nosný token |
| Client-Request-ID |
string |
ID požadavku poskytnutého uživatelem |
Odpovědi
| Name | Typ | Description |
|---|---|---|
| 202 Accepted |
Žádost byla úspěšně přijata ke zpracování. Hlavičky Request-ID: string |
|
| 400 Bad Request |
Došlo k chybě nebo neplatnému vstupu. Text odpovědi poskytne podrobnosti o chybě. |
|
| 401 Unauthorized |
Požadavek nebyl ověřen. Klient se musí nejprve ověřit ve službě partnerského rozhraní API. |
|
| 403 Forbidden |
Žádost byla ověřena, ale byla odmítnuta, protože volající nemá práva k jeho vyvolání. |
|
| 404 Not Found |
Prostředek nebyl nalezen. |
|
| 429 Too Many Requests |
Příliš mnoho požadavků. |
|
| 500 Internal Server Error |
Službě partnerského rozhraní API nebo některé z jejích závislostí se nepodařilo splnit požadavek. Volající to možná zkusí znovu. |
Definice
Microsoft.Partner.Service.PartnerPayout.Contracts.V1.Export
| Name | Typ | Description |
|---|---|---|
| blobLocation |
string |
|
| processingStartDateTime |
string |
|
| requestDateTime |
string |
|
| requestId |
string |
|
| requestPath |
string |
|
| requestQueryString |
string |
|
| status |
enum:
|