Skapa begäran om vinstexport

Artikel
11/13/2024

Använd det här API:et för att köa nya intäkter och underliggande transaktioner/betalningsdataexportbegäran med valfria filter för att dela upp och tärna data om intäkter och transaktioner. Den returnerar http-status 202 och ett begärande-ID, som kan användas för att avsöka tillbaka för att kontrollera statusen för den köade transaktionsexportbegäran.

Skicka en POST-begäran till API-slutpunkten för att köa en ny exportbegäran för transaktioner/intäkter.

REST-begäran

Metod	URI för förfrågan
POST	`https://api.partner.microsoft.com/v1.0/payouts/transactionhistory?$filter={$filter}&fileformat=csv`

Parametrar för begäran

Name	Om	Obligatoriskt	Type	Beskrivning
$filter	Fråga	Nej	String	Även om det är ett valfritt filter rekommenderar vi starkt att du använder filter för snabbare prestanda och begränsar dina exportdata i stället för att exportera de senaste tre årens data. I följande tabell finns en fullständig uppsättning $filter alternativ.
fileFormat	Fråga	Nej	String	Värden som stöds är .csv/.tsv. Standardvärdet är .csv om inget värde anges.

$filter-frågeparam är en valfri parameter för att skapa en exportåtgärd. Vi rekommenderar dock starkt att du använder $filters för bättre prestanda och snabbare tillgänglighet för exportrapporten. Följande är några av de nyckelattributfilter som kan användas som en del av exportåtgärden:

Name	beskrivning	Typ	Exempel
`enrollmentParticipantId`	Registrerat MPN-ID för organisationen.	Int	{baseUrl}`/v1.0/payouts/transactionhistory?$filter= enrollmentParticipantId=12345`
`EarningForDate`	Datum för intjäningsperiod för exportåtgärden.	Datum/tid	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=earningForDate ge 2023-03-01 and earningForDate le 2023-04-12`
`transactionAmount`	Transaktionsbelopp.	Dubbel	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=transactionAmount ge 2000 and transactionAmount le 5000`
`earningAmount`	Intjäningsbelopp i transaktionsvaluta.	Dubbel	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=earningAmount ge 2000 and earningAmount le 5000`
`engagementName`	Gäller endast för Microsoft Commerce Incentives. Exempelvärden - `'Azure CSP motion incentives - Indirect Provider'`.	String	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=engagementName=’Azure CSP motion incentives’`
`payableSubType`	Filtrera efter intjäningstyp. Exempelvärden - `'REBATE'`, `'COOP'`, `'FEE'`, `'SELL'`	String	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=payableSubType=’REBATE’ or payableSubType=’FEE’`
`payoutStatus`	Filtrera transaktioner efter utbetalningsstatus. Exempelvärden - `'SENT'`, `'UPCOMING'`, `'IN PROGRESS'`.	String	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=payoutStatus=’IN PROGRESS’`

Exempel på transaktionshistorikfilter med flera begärandeparametrar:

”?$filter=earningForDate ge 2019-01-27T23:16:31.009Z and earningForDate le 2019-09-25T23:16:31.009Z and (enrollmentParticipantId eq 'XXXXXXX') and (programName eq ‘Microsoft Commerce Incentives’) and (payableSubType eq 'REBATE') and (paymentId eq '000000000000') and (engagementName eq 'Azure Enterprise and Self-Service Incentive' or engagementName eq 'Azure CSP motion incentives - Indirect Provider') and (leverCode eq ‘Azure Enterprise and Self-Service Motion’) and (payoutStatus eq 'SENT')”

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
Auktorisering	Ja	String	Auktoriseringsbäraretoken.
ms-correlationid	Nej	String	En intern spårning av begäranden. Varje begäran genererar en ny spårare (GUID).
ms-requestid	Nej	String	Begärande-ID:t för idempotens.

Mer information finns i REST-huvuden för Partnercenter

Begärandetext

Ej tillämpligt.

API-svar

HTTP/1.1 202 Accepted

API-svarsnyttolasten returnerar följande attribut:

Name	Valfritt	beskrivning
Värde	falskt	Se följande tabell för möjliga värden och åtgärder.

Möjliga värden och åtgärder

Värde	Klientåtgärd
requestId	Begärande-ID för exportbegäran
requestDateTime	Initieringsdatum för exportbegäran
requestPath	Frågesökväg för exportbegäran.
requestQueryString	Filter som används som en del av exportbegäran.
blobLocation	Blobresurs med token när exportfilen är klar
Status	Exportera åtgärdsstatus. Se följande lista över möjliga värden för status.

Möjliga värden för status

I kö: Exportåtgärden har inte startats
Bearbetning: Exportåtgärden pågår
Misslyckades: Exportåtgärden misslyckades efter återförsök, försök att köa en ny begäran
Slutförd: Exportåtgärden har slutförts och exportfilen är klar för nedladdning.

Exempelsvar

{
    "value": [
        {
            "requestId": "93c2b3cf-c6d8-4e7e-ade1-007768a6eba4",
            "requestDateTime": "2023-05-25T21:20:46.3727561Z",
            "requestPath": "/v1.0/payouts/transactionhistory",
            "requestQueryString": "earningForDate ge 2023-03-01 and earningForDate le 2023-04-12",
            "blobLocation": "",
            "status": "Queued"
        }
    ],
    "nextLink": null,
    "totalCount": 1
}

API returnerar HTTP-status 202.

Name	beskrivning
202 Accepterad	Begäran godkändes. Fråga GET-begärande-URL:en om status för begäran.

Beroende på begäran kan API:et returnera andra standardstatusar:

Name	beskrivning
400 – Felaktig begäran	Det saknades eller var felaktiga data.
401 – Ej behörig	Anroparen är inte autentiserad och måste autentisera med partner-API-tjänsten innan det första anropet.
403 – Förbjuden	Anroparen har inte behörighet att göra begäran.
500 – Internt serverfel	API:et eller något av dess beroenden kan inte uppfylla begäran. Försök igen senare.
404 – Hittades inte	Resursen är inte tillgänglig med indataparametrar.
429 Hastighetsbegränsning	För många begäranden av samma typ. Försök efter någon gång.

Dela via