Obter uma lista de subscrições por encomenda

Artigo
06/13/2024

Aplica-se a: Partner Center | Partner Center operado pela 21Vianet | Partner Center for Microsoft Cloud for US Government

Obtém uma coleção de recursos de Assinatura que correspondem a uma determinada ordem.

Pré-requisitos

Credenciais conforme descrito na autenticação do Partner Center. Este cenário oferece suporte à autenticação com credenciais autônomas de Aplicativo e Aplicativo+Usuário.
Um ID de cliente (customer-tenant-id). Se não souber o ID do cliente, pode procurá-lo no Partner Center selecionando a área de trabalho Clientes e, em seguida, o cliente na lista de clientes e, em seguida, Conta. Na página Conta do cliente, procure a ID da Microsoft na seção Informações da Conta do Cliente. A ID da Microsoft é a mesma que a ID do cliente (customer-tenant-id).
Um ID de encomenda.

C#

Para obter uma lista de assinaturas por ordem, use sua coleção IAggregatePartner.Customers e chame o método ById( ). Em seguida, chame a propriedade Subscriptions, seguida pelo método ByOrder(). Termine chamando Get() ou GetAsync().

// IAggregatePartner partnerOperations;
// var selectedCustomerId as string;
// string orderID;

ResourceCollection<Subscription> customerSubscriptions = partnerOperations.Customers.ById(selectedCustomerId).Subscriptions.ByOrder(orderID).Get();

Exemplo: Aplicativo de teste de console. Projeto: PartnerSDK.FeatureSample Classe: SubscriptionsByOrder.cs

Pedido REST

Sintaxe da solicitação

Método	URI do pedido
GET	{baseURL}/v1/customers/{customer-tenant-id}/subscriptions?order_id={id-for-order} HTTP/1.1

Parâmetro URI

Esta tabela lista o parâmetro de consulta necessário para obter todas as assinaturas.

Nome	Type	Obrigatório	Description
ID do cliente-locatário	GUID	Y	Um GUID correspondente ao cliente.
ID por encomenda	GUID	Y	Um GUID correspondente à ordem.

Cabeçalhos do pedido

Para obter mais informações, consulte Cabeçalhos REST do Partner Center.

Corpo do pedido

Nenhum.

Exemplo de solicitação

GET https://api.partnercenter.microsoft.com/v1/customers/{customer-tenant-id}/subscriptions?order_id={id-for-order} HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 16fee928-dc2c-412f-adbb-871f68babf16
MS-CorrelationId: c49004b1-224f-4d86-a607-6c8bcc52cfdd
Connection: Keep-Alive

Resposta do REST

Se for bem-sucedido, esse método retornará uma coleção de recursos de Assinatura no corpo da resposta.

Códigos de sucesso e erro de resposta

Cada resposta vem com um código de status HTTP que indica sucesso ou falha e informações adicionais de depuração. Use uma ferramenta de rastreamento de rede para ler esse código, tipo de erro e parâmetros adicionais. Para obter a lista completa, consulte Códigos de erro.

Exemplo de resposta

HTTP/1.1 200 OK
Content-Length: 73754
Content-Type: application/json
MS-CorrelationId: c49004b1-224f-4d86-a607-6c8bcc52cfdd
MS-RequestId: 16fee928-dc2c-412f-adbb-871f68babf16
Date: Wed, 25 Nov 2015 05:50:45 GMT

{
    "totalCount": 1,
    "items": [{
        "id": "83ef9d05-4169-4ef9-9657-0e86b1eab1de",
        "entitlementId": "a356ac8c-e310-44f4-bf85-C7f29044af99",
        "friendlyName": "Myofferpurchase",
        "quantity": 1,
        "unitType": "none",
        "creationDate": "2015-11-25T06: 41: 12Z",
        "effectiveStartDate": "2015-11-24T08: 00: 00Z",
        "commitmentEndDate": "2016-12-12T08: 00: 00Z",
        "status": "active",
        "autoRenewEnabled": false,
        "billingType": "none",
        "contractType": "subscription",
        "links": {
            "offer": {
                "uri": "/v1/offers/0CCA44D6-68E9-4762-94EE-31ECE98783B9",
                "method": "GET",
                "headers": []
            },
            "self": {
                "uri": "/subscriptions?key=<key>",
                "method": "GET",
                "headers": []
            }
        },
        "orderId": "{id-for-order}",
        "attributes": {
            "etag": "<etag>",
            "objectType": "Subscription"
        }
    }],
    "attributes": {
        "objectType": "Collection"
    }
}

Exemplo de resposta em novo comércio

GET https://api.partnercenter.microsoft.com/v1/customers/c501c3c4-d776-40ef-9ecf-9cefb59442c1//subscriptions?order_id=79d9f5e2f43a HTTP/1.1
Content-Length: 73754
Content-Type: application/json
MS-RequestId: 261a7eab-99ba-4fef-b3f1-476ebfddfa52
MS-CorrelationId: 9972257f-c746-44fd-bd60-8a33e5982e55
Date: Thurs, 6 June 2024 10:50:45 GMT

{
  "totalCount": 1,
  "items": [
    {
        "id": "0ee4f7f6-b583-403e-81bb-9facbc96ef54",
        "offerId": "CFQ7TTC0LH18:0001:CFQ7TTC0P0WS",
        "offerName": "Microsoft 365 Business Basic",
        "friendlyName": "Microsoft 365 Business Basic",
        "productType": {
            "id": "OnlineServicesNCE",
            "displayName": "OnlineServicesNCE"
        },
        "quantity": 2,
        "unitType": "Licenses",
        "hasPurchasableAddons": false,
        "creationDate": "2024-06-05T19:26:38.3667635Z",
        "effectiveStartDate": "2024-06-05T00:00:00Z",
        "commitmentEndDate": "2024-07-04T00:00:00Z",
        "commitmentEndDateTime": "2024-07-04T23:59:59Z",
        "cancellationAllowedUntilDate": "2024-06-12T19:27:03.440527Z",
        "billingCycleEndDate": "2024-07-04T00:00:00Z",
        "billingCycleEndDateTime": "2024-07-04T23:59:59Z",
        "status": "active",
        "autoRenewEnabled": true,
        "isTrial": false,
        "billingType": "license",
        "billingCycle": "monthly",
        "termDuration": "P1M",
        "renewalTermDuration": "",
        "isMicrosoftProduct": true,
        "partnerId": "4847383",
        "attentionNeeded": false,
        "actionTaken": false,
        "contractType": "subscription",
        "links": {
            "product": {
                "uri": "/products/CFQ7TTC0LH18?country=US",
                "method": "GET",
                "headers": []
            },
            "sku": {
                "uri": "/products/CFQ7TTC0LH18/skus/0001?country=US",
                "method": "GET",
                "headers": []
            },
            "availability": {
                "uri": "/products/CFQ7TTC0LH18/skus/0001/availabilities/CFQ7TTC0P0WS?country=US",
                "method": "GET",
                "headers": []
            },
            "self": {
                "uri": "/customers/c501c3c4-d776-40ef-9ecf-9cefb59442c1/subscriptions/0ee4f7f6-b583-403e-81bb-9facbc96ef54",
                "method": "GET",
                "headers": []
            }
        },
        "publisherName": "Microsoft Corporation",
        "refundableQuantity": {
            "totalQuantity": 1,
            "details": [
                {
                    "quantity": 1,
                    "allowedUntilDateTime": "2024-06-14T17:41:13.4675407Z"
                }
            ]
        },
        "orderId": "79d9f5e2f43a",
        "attributes": {
            "objectType": "Subscription"
        }
    }
  ],
  "attributes": { "objectType": "Collection" }
}

Partilhar via