パートナー センター REST API を使用して顧客のサブスクリプションの譲渡を受け入れる
この記事では、パートナー センターで REST API を使用して、顧客のサブスクリプションの譲渡を受け入れる方法について説明します。 この例には、REST 構文、ヘッダー、および REST 応答が含まれます。
Note
このトピックは、従来のライセンスベースのサービスにのみ適用され、新しいコマース エクスペリエンスには適用されません。 新しいコマース ライセンス ベースのサブスクリプションの譲渡の詳細については、 新しいコマース譲渡に関するトピックを参照してください。
対象のロール: 管理エージェント
前提条件
パートナー センターの認証に関するページで説明している資格情報。 このシナリオでは、スタンドアロン アプリとアプリ + ユーザーの両方の資格情報を使った認証がサポートされています。
顧客 ID です (
customer-tenant-id
)。 顧客の ID がわからない場合は、パートナー センターで [顧客] ワークスペースを選び、顧客一覧から顧客を選び、[アカウント] を選んで調べることができます。 お客様のアカウント ページで、[顧客のアカウント情報] セクションの Microsoft ID を探します。 Microsoft ID は、顧客 ID (customer-tenant-id
) と同じです。既存の転送の転送識別子。
REST 要求
要求の構文
認証方法 | 要求 URI |
---|---|
投稿 | {baseURL}/v1/customers/{customer-id}/transfers/{transfer-id}/accept HTTP/1.1 |
URI パラメーター
次のパス パラメーターを使用して顧客を識別し、受け入れる転送を指定します。
名前 | タイプ | Required | 説明 |
---|---|---|---|
customer-id | string | はい | 顧客を識別する GUID 形式の顧客 ID。 |
transfer-id | string | はい | 転送を識別する GUID 形式の転送 ID。 |
要求ヘッダー
詳細については、「パートナー センター REST ヘッダー」を参照してください。
要求の例
POST /v1/customers/d6bf25b7-e0a8-4f2d-a31b-97b55cfc774d/transfers/aa2bddb6-9cc8-4949-80fe-a37d5e0a13ba/accept HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 8389053b-731c-4261-9899-1583d7859153
X-Locale: en-US
Content-Type: application/json
Host: api.partnercenter.microsoft.com
Content-Length: 0
REST 応答
成功した場合、このメソッドは応答本文で設定された TransferSubmitResult リソースを返します。
応答の成功とエラーのコード
各応答には、成功または失敗を示す HTTP ステータス コードと、追加のデバッグ情報が付属しています。 このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワーク トレース ツールを使用します。 完全な一覧については、エラー コードに関するページを参照してください。
応答の例
HTTP/1.1 200 OK
Content-Length: 3389
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 8389053b-731c-4261-9899-1583d7859153
X-Locale: en-US
Date: Wed, 25 Mar 2020 19:13:06 GMT
{
"orders": [
{
"id": "21b92393-ffce-4bc7-87c5-62cfa897d8f9",
"alternateId": "21b92393-ffce-4bc7-87c5-62cfa897d8f9",
"referenceCustomerId": "b67f0b00-f9e8-4c57-bcb5-0b8b95c6ccf0",
"billingCycle": "annual",
"currencyCode": "USD",
"lineItems": [
{
"lineItemNumber": 0,
"offerId": "5344C201-3099-44E5-B333-C3EB0401EDE0",
"termDuration": "P1Y",
"transactionType": "New",
"friendlyName": "Dynamics 365 Customer Engagement Plan (36 mo)",
"quantity": 1,
"partnerIdOnRecord": "5139005",
"links": {
}
}
],
"creationDate": "2020-03-25T22:24:23.183+00:00",
"status": "completed",
"transactionType": "UserPurchase",
"links": {
"self": {
"uri": "/customers/b67f0b00-f9e8-4c57-bcb5-0b8b95c6ccf0/orders/21b92393-ffce-4bc7-87c5-62cfa897d8f9",
"method": "GET",
"headers": [ ]
},
"patchOperation": {
"uri": "/customers/b67f0b00-f9e8-4c57-bcb5-0b8b95c6ccf0/orders/21b92393-ffce-4bc7-87c5-62cfa897d8f9",
"method": "PATCH",
"headers": [ ]
}
},
"attributes": {
"etag": "eyJpZCI6IjIxYjkyMzkzLWZmY2UtNGJjNy04N2M1LTYyY2ZhODk3ZDhmOSIsInZlcnNpb24iOjF9",
"objectType": "Order"
}
},
{
"id": "7414b8ea-c167-4cc4-bc8e-b43efc177a46",
"alternateId": "7414b8ea-c167-4cc4-bc8e-b43efc177a46",
"referenceCustomerId": "b67f0b00-f9e8-4c57-bcb5-0b8b95c6ccf0",
"billingCycle": "annual",
"currencyCode": "USD",
"lineItems": [
{
"lineItemNumber": 0,
"offerId": "1A90EE13-2CB4-4785-BB0F-542813F00A37",
"termDuration": "P1Y",
"transactionType": "New",
"friendlyName": "Dynamics 365 Business Central Essential",
"quantity": 1,
"partnerIdOnRecord": "5139005",
"links": {
}
}
],
"creationDate": "2020-03-25T22:24:34.59+00:00",
"status": "completed",
"transactionType": "UserPurchase",
"links": {
"self": {
"uri": "/customers/b67f0b00-f9e8-4c57-bcb5-0b8b95c6ccf0/orders/7414b8ea-c167-4cc4-bc8e-b43efc177a46",
"method": "GET",
"headers": [ ]
},
"patchOperation": {
"uri": "/customers/b67f0b00-f9e8-4c57-bcb5-0b8b95c6ccf0/orders/7414b8ea-c167-4cc4-bc8e-b43efc177a46",
"method": "PATCH",
"headers": [ ]
}
},
"attributes": {
"etag": "eyJpZCI6Ijc0MTRiOGVhLWMxNjctNGNjNC1iYzhlLWI0M2VmYzE3N2E0NiIsInZlcnNpb24iOjF9",
"objectType": "Order"
}
}
],
"transferErrors": [
{
"transferGroupId": "1",
"lineItems": [
{
"id": 1,
"subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
"entitlementId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
"offerId": "A4179D30-CC09-49F0-977E-DC2CB70B874F",
"friendlyName": "Project Online Essentials",
"quantity": 1,
"transferGroupId": "1",
"addonItems": [ ],
"partnerIdOnRecord": "5139005",
"billingCycle": "annual",
"sourceSubscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e"
}
],
"code": 900103,
"description": "Subscription SyncState must be SyncComplete for the Subscription to be a source in a Subscription Ownership Transfer. Subscription: aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e, current state: None",
"attributes": {
"objectType": "TransferError"
}
}
],
"attributes": {
"objectType": "TransferSubmitResult"
}
}