Requirements

  1. Access to L1 CMP - Log into the Reseller Control Panel to View Marketplace API username, password and subscription key.
  2. Purchase Marketplace API - Must place the order in the cloud marketplace by searching for “marketplace API”.
  3. Resources - Recommended to have technical staff familiar with JSON and REST APIs.
  4. Support Assistance - Reach out to the appropriate support email based on region using our support contact directory.

Overview

Please follow this example of the activation parameters to create a new subscription for Microsoft NCE. In this example for the distribution model, Partner of Record attestation is sent, and the subscription will be created for a new tenant, including an item that does not require offer attestation. As you can see, all the agreement information, the customer details and company information are included in the example. You can use this example to build your own request by providing the required values for each property or deleting the properties that you do not need according to the information provided in this guide.


Process

Step 1 - Generate Token

  • Authorizations: BasicAuth
  • Header Parameters
    • x-subscription key (required) - string - The ID of your reseller’s subscription on the API gateway that defines restrictions on your API calls
  • Requests Body Schema
    • Marketplace – string - Marketplace code



Step 2 - Make new Order request

  • Post {{prodUrl}}/orders



Step 3 - Authorization for Order request

  • Bearer Token (required)



Step 4 - Body for Order request

application/json={

    "customerId": "1000105563",

    "type": "sales",

    "ponumber": "00-0000",

    "subscriptionPeriod": { 

     "type": "year", 

     "duration": 1 

     },

    "products": [

        {

            "mpn": "CFQ7TTC0LH16:0001",

            "quantity": 1,

            "billingPeriod": {

                "type": "month",

                "duration": 1

            },

            "parameters": [

                {

                    "name": "tenant_preference",

                    "value": "new"

                },

                {

                    "name": "partner_on_record_attestation_accepted",

                       "structured_value": {

                           "attestation_accepted": true

                    }

                },

                {

                    "name": "microsoft_domain",

                    "value": "xxxxxxx.onmicrosoft.com"

                },

                {

                    "name": "mca_acceptance",

                    "value": "yes"

                },

                {

                    "name": "agreement_date",

                    "value": "04-09-2022"

                },

                {

                    "name": "first_name_agreement",

                    "value": "John"

                },

                {

                    "name": "last_name_agreement",

                    "value": "Doe"

                },

                {

                    "name": "email_address_agreement",

                    "value": john@doe.com

                },

                {

                    "name": "effective_address",

                    "value": "1759 Wehrle Dr"

                },

                {

                    "name": "effective_city",

                    "value": "Williamsville"

                },

                {

                    "name": "effective_state",

                    "value": "NY"

                },

                {

                    "name": "effective_postal_code",

                    "value": "14221"

                },

                {

                    "name": "effective_country",

                    "value": "US"

                },

                {

                    "name": "effective_phonenumber",

                    "value": "(716) 633-3600"

                },

                {

                    "name": "customer_company_name",

                    "value": "27 Rings Jewelers"

                },

                {

                    "name": "customer_email",

                    "value": john@doe.com

                },

                {

                    "name": "special_qualifications",

                    "value": "None"

                },

                {

                    "name": "offer_attestation",

                       "structured_value": {

                           "attestation_accepted": false

                    }

                }

            ]

        }

    ],

}

customerId – End customer ID from the Cloud Marketplace (required)

type – indicator of the type of order being placed (required)

  • sales

ponumber – (NOT required)

subscriptionPeriod – indicator of the commitment for the subscription. (required)

  • year” annual commitment
  • month” month commitment

mpn – Product ID that can be found within the product catalog (required)

billingPeriod – differentiator between a billed monthly/yearly NCE subscription (required)

  • year” billed upfront
  • month” billed monthly

This example would be for an annual commitment billed monthly. 

tenant_preference (required)

  • new -  this string is used if a new Microsoft Tenant (CSP Account) must be created.
  • existing – this string is used if an existing Microsoft CSP Account must be used

partner_on_record_attestation_accepted 

  • Sales Orders – required must be True
  • Change orders – (NOT required)

microsoft_domain (required)

  • Existing – enter in domain for the specific end customer
  • New – enter in the domain you wish to create for your end customer (if domain is already taken this tag will fail)

mca_acceptance (Microsoft Customer Agreement) (required only for NEW tenants or if MCA has not been accepted)

  • Must be set to yes to confirm that the MCA has been accepted

Agreement Parameters

agreement_date
  • Date when the MCA was accepted MM-DD-YYYY
first_name_agreement:
  • First name of the individual at the end customers organization who accepted the MCA
last_name_agreement:
  • Last name of the individual at the end customers organization who accepted the MCA

Below Customer & Company information is only required if the company information did not pass Microsoft’s validation

email_address_agreement:

  • Email address of the individual at the customers organization who accepted the MCA

effective_address

  • End customer business address line

effective_city

  • End customer city of business

effective_state

  • End customer corresponding state/province/region

effective_postal_code

  • End customer zip or postal code




effective_country

  • End customer country indicated by two-letter code. For example US

effective_phonenumber

  • End customer phone number 

customer_company_name

  • Must consist of more than one unique character
  • Tabs or spaces must not be used
  • Standalone abbreviations must not be used (LLC, Inc., c p a, c.p.a, corp etc.)

customer_email 

  • The domain must not be @microsoft.com
  • The customer email domain must not be the same as the partner email domain

special_qualifications (NOT required)

  • You must either use “None” or “soe”
  • If the customer meets the State Owned eligibility criteria, the “soe” alue must be used. Otherwise use “None”
  • If “soe” is used, then the SOE qualification will be updated accordingly in Microsoft

offer_attestation (required)

  • You must either use True or False for attestation_accepted
  • This parameter is sued to confirm that each person using Windows 365 Business with Windows Hybrid Benefit also needs to have a valid copy of Windows 10/11 Pro installed on their primary work device.



Step 5 - Order Placed Successfully

Once the order has been placed successfully, the order will go to Microsoft for the final completion and follow standard completion timeline.



Step 6 - Order completion

Once the order has been completed you can see the subscriptions within the Microsoft Partner Center, Ingram's Cloud Marketplace, and any storefront that has been created if applicable.