Erstellen einer Übertragung für neuen Commerce mithilfe von Partner Center-REST-APIs

Artikel
09/20/2024

Partner können neue Commerce-Abonnements von einem Transacting-Partner an einen anderen übertragen. Ein Zielpartner erstellt die Übertragungsanforderung. Der Quellpartner aktualisiert die Übertragung mit Positionsdetails. In diesem Thema wird die API erläutert, die ein Zielpartner aufrufen würde, um die Übertragungsanforderung zu erstellen. Dieses Thema ist nur für Azure Plan-Reservierungen, Sparpläne und Abonnements und neue lizenzbasierte Abonnements relevant. Weitere wertvolle Informationen finden Sie in der Dokumentation zum Übertragen von Abonnements.

Voraussetzungen

Anmeldeinformationen, wie unter Partner Center-Authentifizierung beschrieben. Dieses Szenario unterstützt die Authentifizierung mit eigenständigen App- und App+Benutzeranmeldeinformationen.
Eine Kunden-ID (customer-tenant-ID). Wenn Sie die KUNDEN-ID nicht kennen, können Sie sie im Partner Center nachschlagen, indem Sie den Arbeitsbereich "Kunden " und dann den Kunden aus der Kundenliste und dann "Konto" auswählen. Suchen Sie auf der Kontoseite des Kunden im Abschnitt Kundenkontoinfo nach der Microsoft-ID. Die Microsoft-ID entspricht der Kunden-ID (customer-tenant-ID).
Geeignete Rollen: Administrator-Agent

REST-Anforderung

Anforderungssyntax

Methode	Anforderungs-URI
POST	{baseURL}/v1/customers/{customer-ID}/transfers HTTP/1.1

URI-Parameter

Verwenden Sie zum Identifizieren des Kunden die folgenden Pfadparameter:

Name	Type	Erforderlich	Beschreibung
customer-id	Zeichenfolge	Ja	Eine guid formatierte Kunden-ID, die den Kunden identifiziert.

Anforderungsheader

Weitere Informationen finden Sie unter Partner Center-REST-Header.

Anforderungstext

In dieser Tabelle werden die TransferEntity-Eigenschaften im Anforderungstext zum Erstellen einer neuen E-Mail-Übertragungsanforderung beschrieben.

Eigenschaft	Type	Erforderlich	Beschreibung
sourcePartnerTenantId	Zeichenfolge	Ja	Eine GUID-formatierte Partner-ID, die den Partner identifiziert, der die Übertragung initiiert.
sourcePartnerName	Zeichenfolge	Ja	Der Name der Organisation des Partners, die die Übertragung initiiert.
customerEmailId	Zeichenfolge	Ja	Eine Zeichenfolge des Kunden, um Benachrichtigungen über die Übermittlungserstellung zu erhalten.
customerName	Zeichenfolge	No	Optional. Der Name des Kunden, dessen Abonnements übertragen werden.
targetPartnerTenantId	Zeichenfolge	No	Eine GUID-formatierte Partnermandanten-ID, die den Partner identifiziert, an den die Übertragung gerichtet ist. Der Partnerautorisierungskontext wird bei weggelassener Partnermandanten-ID aufgelöst.
targetPartnerEmailId	Zeichenfolge	No	Eine GUID-formatierte Partnermandanten-ID, die den Partner identifiziert, an den die Übertragung gerichtet ist. Der Partnerautorisierungskontext wird bei weggelassener Partnermandanten-ID aufgelöst.
transferType	Zeichenfolge	Ja	Eine Zeichenfolge, die den Übertragungstyp definiert. 3 stellt NewCommerce dar und sollte für Azure-Plan und neue lizenzbasierte Abonnements für den Handel verwendet werden.

Anforderungsbeispiel

{
    "id": "43fb1d3a-79fe-45a9-863e-9a4acf17b630",
    "status": "InProgress",
    "transferType": 3,
    "customerEmailId": "",
    "createdTime": "2024-04-30T18:31:41.5133355Z",
    "lastModifiedTime": "2024-05-01T00:51:55Z",
    "expirationTime": "2024-05-31T00:00:00Z",
    "customerName": "ipdbtrans2",
    "customerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
    "partnertenantid": "a94dcde1-ecd7-wace-a6ef-ef73ba6b8ba5",
    "sourcePartnerName": "Test_Test_IP4_AG",
    "sourcePartnerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
    "targetPartnerName": "Test_Test_DB_AG",
    "targetPartnerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
    "targetPartnerEmailId": "817512d3-0689-47a0-bbf2-a7f11ae1fc11",
    "transferDirection": 2,
    "ignoreEligibilityCheck": false,
    "lastModifiedUser": "1671774b-679f-4543-a152-1f8b14006c0e",
    "lineItems": [{
        "id": 0,
        "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
        "billingCycle": "unknown",
        "quantity": 0,
        "productType": 5,
        "status": "InProgress"
    }],
    "links": {
        "self": {
            "uri": "/customers/aaaabbbb-0000-cccc-1111-dddd2222eeee/transfers/43fb1d3a-79fe-45a9-863e-9a4acf17b630",
            "method": "GET",
            "headers": []
        }
    }
}

REST-Antwort

Bei erfolgreicher Ausführung gibt die Methode die aufgefüllte TransferEnity-Ressource im Antworttext zurück.

Erfolgs- und Fehlercodes der Antwort

Jede Antwort enthält einen HTTP-Statuscode, der Erfolg oder Fehler und weitere Debuginformationen angibt. Verwenden Sie ein Netzwerkablaufverfolgungstool, um diesen Code, fehlertyp und weitere Parameter zu lesen. Die vollständige Liste findest du unter Partner-API: REST-Fehlercodes.

Beispielantwort

HTTP/1.1 201 Created
Content-Length: 138
Content-Type: application/json; charset=utf-8
MS-RequestId: 4fa6dad6-a89f-4875-8247-7294a10ae1cf
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US,en-US

{
"id": "43fb1d3a-79fe-45a9-863e-9a4acf17b630",
"status": "Pending",
"transferType": 3,
"customerEmailId": "",
"createdTime": "2024-04-30T18:31:41.5133355Z",
"lastModifiedTime": "2024-04-30T18:31:41Z",
"expirationTime": "2024-05-31T00:00:00Z",
"customerName": "ipdbtrans2",
"customerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"partnertenantid": "817512d3-0689-47a0-bbf2-a7f11ae1fc11",
"sourcePartnerName": "Test_Test_IP4_AG",
"sourcePartnerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"targetPartnerName": "Test_Test_DB_AG",
"targetPartnerTenantId": "817512d3-0689-47a0-bbf2-a7f11ae1fc11",
"targetPartnerEmailId": "817512d3-0689-47a0-bbf2-a7f11ae1fc11",
"transferDirection": 1,
"ignoreEligibilityCheck": false,
"lastModifiedUser": "7ffdaa28-3b1c-4a61-b580-e1aa6ecf833c",
"links": {
    "self": {
        "uri": "/customers/aaaabbbb-0000-cccc-1111-dddd2222eeee/transfers/43fb1d3a-79fe-45a9-863e-9a4acf17b630",
        "method": "GET",
        "headers": []
    }
}
}

Freigeben über