Obtener una lista de suscripciones en función del pedido

Artículo
06/13/2024

Se aplica a: Centro de partners | Centro de partners operado por 21Vianet | Centro de partners para Microsoft Cloud for US Government

Obtiene una colección de recursos de suscripción que corresponden a un orden determinado.

Requisitos previos

Credenciales tal como se describen en el artículo Autenticación del Centro de partners. Este escenario admite la autenticación con credenciales de aplicación independiente y app+usuario.
Un id. de cliente (customer-tenant-id). Si no conoce el identificador del cliente, puede buscarlo en el Centro de partners seleccionando el área de trabajo Clientes , luego el cliente de la lista de clientes y, a continuación , Cuenta. En la página Cuenta del cliente, busca el Id. de Microsoft en la sección Información de la cuenta del cliente. El id. de Microsoft es el mismo que el de cliente (customer-tenant-id).
Un identificador de pedido.

C#

Para obtener una lista de suscripciones por pedido, use la colección IAggregatePartner.Customers y llame al método ById(). A continuación, llame a la propiedad Subscriptions, seguida del método ByOrder(). Por último llame a Get() o a GetAsync().

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

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

Ejemplo: Aplicación de prueba de consola. Project: PartnerSDK.FeatureSample (Clase): SubscriptionsByOrder.cs

Solicitud REST

Sintaxis de la solicitud

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

Parámetro de URI

En esta tabla se muestra el parámetro de consulta necesario para obtener todas las suscripciones.

Nombre	Type	Obligatorio	Descripción
customer-tenant-id	guid	Y	GUID correspondiente al cliente.
id-for-order	guid	Y	GUID correspondiente al orden.

Encabezados de solicitud

Para obtener más información, consulta Encabezados REST del Centro de partners.

Cuerpo de la solicitud

Ninguno.

Ejemplo de solicitud

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: aaaa0000-bb11-2222-33cc-444444dddddd
Connection: Keep-Alive

Respuesta REST

Si se ejecuta correctamente, este método devuelve una colección de recursos de suscripción en el cuerpo de la respuesta.

Códigos de error y de respuesta correctos

Cada respuesta incluye un código de estado HTTP que indica si la operación se ha realizado correctamente o con errores y proporciona información de depuración adicional. Use una herramienta de seguimiento de red para leer este código, el tipo de error y los parámetros adicionales. Para obtener la lista completa, consulte Códigos de error.

Ejemplo de respuesta

HTTP/1.1 200 OK
Content-Length: 73754
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
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"
    }
}

Ejemplo de respuesta en el nuevo comercio

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: bbbb1111-cc22-3333-44dd-555555eeeeee
Date: Thurs, 6 June 2024 10:50:45 GMT

{
  "totalCount": 1,
  "items": [
    {
        "id": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
        "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/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
                "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" }
}

Compartir vía