Share via

Get transfer details by ID

  • Article

Prerequisites

  • Credentials as described in Partner Center authentication. This scenario supports authentication with both standalone App and App+User credentials.

  • A customer ID (customer-tenant-id). If you don't know the customer's ID, you can look it up in Partner Center by selecting the Customers workspace, then the customer from the customer list, then Account. On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. The Microsoft ID is the same as the customer ID (customer-tenant-id).

  • A transfer identifier for an existing transfer.

Appropriate roles: Admin agent

REST request

Request syntax

Method Request URI
GET {baseURL}/v1/customers/{customer-id}/transfers/{transfer-id} HTTP/1.1

URI parameter

Use the following path parameter to identify the customer and specify the transfer to be accepted.

Name Type Required Description
customer-id string Yes A GUID formatted customer-id that identifies the customer.
transfer-id string Yes A GUID formatted transfer-id that identifies the transfer.

Request headers

For more information, see Partner Center REST headers.

Request example

GET /v1/customers/b67f0b00-f9e8-4c57-bcb5-0b8b95c6ccf0/transfers/46e8ed67-8adf-4f65-b3d8-d31318080556 HTTP/1.1
Authorization: Bearer <token>
Connection: keep-alive
MS-RequestId: 0d61b5ce-b396-4f5e-a50b-e8779d0d23cc
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
Accept: application/json

REST response

If successful, this method returns the populated TransferEntity resource in the response body.

Response success and error codes

Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters. For the full list, see Error Codes.

Response example for in progress

HTTP/1.1 200 OK
Content-Length: 1501
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 0d61b5ce-b396-4f5e-a50b-e8779d0d23cc
X-Locale: en-US
Date: Fri, 17 May 2024 18:25:25 GMT

{
        "id": "96978f5b-ee35-486f-96e9-a17ed4a1d87d",
        "status": "InProgress",
        "transferType": 3,
        "customerEmailId": "",
        "createdTime": "2024-04-09T22:45:06.7851706Z",
        "lastModifiedTime": "2024-04-10T17:26:56Z",
        "customerName": "legacytomodern09022021",
        "customerTenantId": "425829ba-6938-4b55-af29-fbbd28ebeebf",
        "partnertenantid": "736ee76b-2635-4b33-a942-25ed0673f31e",
        "sourcePartnerName": "test",
        "sourcePartnerTenantId": "736ee76b-2635-4b33-a942-25ed0673f31e",
        "targetPartnerName": "TEST_TEST_CSPIntegrationTest2T19Q3",
        "targetPartnerTenantId": "35ae17a4-532a-4895-9dc1-baeb7279eedd",
        "targetPartnerEmailId": "35ae17a4-532a-4895-9dc1-baeb7279eedd",
        "transferDirection": 2,
        "ignoreEligibilityCheck": false,
        "lastModifiedUser": "fec7ff82-163d-4763-afb1-6947d2b0db28",
        "lineItems": [
            {
                "id": 0,
                "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
                "billingCycle": "unknown",
                "quantity": 0,
                "productType": 0,
                "status": "InProgress"
            },
            {
                "id": 0,
                "subscriptionId": "bbbb1b1b-cc2c-dd3d-ee4e-ffffff5f5f5f",
                "billingCycle": "unknown",
                "quantity": 0,
                "productType": 5,
                "status": "InProgress"
            }
        ],
        "links": {
            "self": {
                "uri": "/customers/425829ba-6938-4b55-af29-fbbd28ebeebf/transfers/96978f5b-ee35-486f-96e9-a17ed4a1d87d",
                "method": "GET",
                "headers": []
            }
        },
        "attributes": {
            "objectType": "TransferEntity"
        }
    }

Response example for in progress

HTTP/1.1 200 OK
Content-Length: 1501
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 0d61b5ce-b396-4f5e-a50b-e8779d0d23cc
X-Locale: en-US
Date: Fri, 17 May 2024 18:25:25 GMT

{
        "id": "2d9a20f4-532d-438d-b694-bb7ab4585508",
        "status": "Pending",
        "transferType": 3,
        "customerEmailId": "",
        "createdTime": "2024-05-09T18:53:13.8486497Z",
        "lastModifiedTime": "2024-05-09T18:53:14Z",
        "customerName": "legacytomodern09022021",
        "customerTenantId": "425829ba-6938-4b55-af29-fbbd28ebeebf",
        "partnertenantid": "736ee76b-2635-4b33-a942-25ed0673f31e",
        "sourcePartnerName": "test",
        "sourcePartnerTenantId": "736ee76b-2635-4b33-a942-25ed0673f31e",
        "targetPartnerName": "TEST_TEST_CSPIntegrationTest2T19Q3",
        "targetPartnerTenantId": "35ae17a4-532a-4895-9dc1-baeb7279eedd",
        "targetPartnerEmailId": "35ae17a4-532a-4895-9dc1-baeb7279eedd",
        "transferDirection": 2,
        "ignoreEligibilityCheck": false,
        "lastModifiedUser": "35ebf490-ac97-44af-9048-d3cdac1e4c84",
        "links": {
            "self": {
                "uri": "/customers/425829ba-6938-4b55-af29-fbbd28ebeebf/transfers/2d9a20f4-532d-438d-b694-bb7ab4585508",
                "method": "GET",
                "headers": []
            }
        },
        "attributes": {
            "objectType": "TransferEntity"
        }
    }

Response example for completed

HTTP/1.1 200 OK
Content-Length: 1501
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 0d61b5ce-b396-4f5e-a50b-e8779d0d23cc
X-Locale: en-US
Date: Fri, 17 May 2024 18:25:25 GMT

{
        "id": "1c53f090-7a5d-454f-bffa-696650863e79",
        "status": "Complete",
        "transferType": 3,
        "customerEmailId": "",
        "createdTime": "2024-04-24T19:29:58.4656093Z",
        "lastModifiedTime": "2024-04-24T19:38:22Z",
        "completedTime": "2024-04-24T19:36:12.7197415Z",
        "customerName": "legacytomodern09022021",
        "customerTenantId": "425829ba-6938-4b55-af29-fbbd28ebeebf",
        "partnertenantid": "736ee76b-2635-4b33-a942-25ed0673f31e",
        "sourcePartnerName": "736ee76b-2635-4b33-a942-25ed0673f31e",
        "sourcePartnerTenantId": "736ee76b-2635-4b33-a942-25ed0673f31e",
        "targetPartnerName": "TEST_TEST_CSPIntegrationTest2T19Q3",
        "targetPartnerTenantId": "35ae17a4-532a-4895-9dc1-baeb7279eedd",
        "targetPartnerEmailId": "35ae17a4-532a-4895-9dc1-baeb7279eedd",
        "transferDirection": 2,
        "ignoreEligibilityCheck": false,
        "lastModifiedUser": "f430373f-96d2-4ba5-b3ab-6b5dc69ae44f",
        "lineItems": [
            {
                "id": 0,
                "subscriptionId": "cccc2c2c-dd3d-ee4e-ff5f-aaaaaa6a6a6a",
                "billingCycle": "unknown",
                "quantity": 0,
                "productType": 0
            },
            {
                "id": 1,
                "orderId": "bc857bb7-45ad-4667-b369-14126df2f74c",
                "billingCycle": "unknown",
                "quantity": 0,
                "productType": 1
            }
        ],
        "links": {
            "self": {
                "uri": "/customers/425829ba-6938-4b55-af29-fbbd28ebeebf/transfers/1c53f090-7a5d-454f-bffa-696650863e79",
                "method": "GET",
                "headers": []
            }
        },
        "attributes": {
            "objectType": "TransferEntity"
        }
    }