Condividi tramite

Creare una nuova etichetta di spedizione

Usare questo metodo nell'API Hardware Microsoft per creare una nuova etichetta di spedizione. Prima di usare questo assicurarsi di aver creato un prodotto e creato un invio per tale prodotto. Per informazioni dettagliate, vedere Creare un prodotto e creare un invio.

Prerequisiti

Se non è già stato fatto, completare tutti i prerequisiti per le API hardware Microsoft prima di provare a usare uno di questi metodi.

Richiesta

La sintassi di questo metodo è la seguente. Vedi le sezioni seguenti per esempi di uso e descrizioni dell'intestazione e del contenuto della richiesta.

Metodo URI richiesta
POST https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels

ProductID e submissionID nel metodo rappresentano l'invio per il quale deve essere creata l'etichetta di spedizione.

Intestazione della richiesta

Intestazione Tipo Descrizione
Autorizzazione string Obbligatorio. Token di accesso Microsoft Entra ID nel formato Token>di connessione<.
Accetta Stringa Facoltativo. Specifica il tipo di contenuto. Il valore consentito è "application/json"

Parametri della richiesta

Non fornire parametri di richiesta per questo metodo.

Testo della richiesta

L'esempio seguente illustra il corpo della richiesta JSON per la creazione di una nuova etichetta di spedizione.

{
  "publishingSpecifications": {
    "goLiveDate": "2018-02-22T06:50:54.793Z",
    "visibleToAccounts": [
      27691110,
      27691111
    ],
    "isAutoInstallDuringOSUpgrade": true,
    "isAutoInstallOnApplicableSystems": false,
    "manualAcquisition": false,
    "isDisclosureRestricted": false,
    "publishToWindows10s": true,
    "additionalInfoForMsApproval": {
      "microsoftContact": "abc@microsoft.com",
      "validationsPerformed": "Validation 1",
      "affectedOems": [
        "OEM1",
        "OEM2"
      ],
      "isRebootRequired": false,
      "isCoEngineered": false,
      "isForUnreleasedHardware": false,
      "hasUiSoftware": false,
      "businessJustification": "This is a business justification"
    }
  },
  "targeting": {
    "hardwareIds": [
      {
        "bundleId": "3aba7558-10ca-42db-b1d1-57af5718aea3",
        "infId": "foo.inf",
        "operatingSystemCode": "WINDOWS_v100_RS3_FULL",
        "pnpString": "hid\\vid_dummy256f&pid_dummyc62f"
      }
    ],
    "chids": [
      {
        "chid": "346511cf-ccee-5c6d-8ee9-3c70fc7aae83",
        "distributionState": "pendingAdd"
      }
    ],
    "restrictedToAudiences": [
      "00000000-0000-0000-0000-000000000001",
      "00000000-0000-0000-0000-000000000002"
      ],
    "inServicePublishInfo": {
      "flooring": "RS1",
      "ceiling": "RS3"
    }
  },
  "name": "Shipping Label Name",
  "destination": "windowsUpdate"
}

Per informazioni dettagliate sui campi nella richiesta, vedere Risorsa ShippingLabel.

Punti da ricordare durante la creazione di etichette di spedizione

  • Quando si esegue la pubblicazione in Windows Update (destinazione è windowsUpdate), è necessario includere un oggetto publishingSpecifications. Per le installazioni automatiche (isAutoInstallDuringOSUpgrade o isAutoInstallOnApplicableSystems è true), è necessario impostare additionalInfoForMsApproval.
  • se nell'etichetta di spedizione isAutoInstallDuringOSUpgrade o isAutoInstallOnApplicableSystems è true, manualAcquisition deve essere false e il driver verrà pubblicato con "May request user input" impostato su false.
  • se nell'etichetta di spedizione isAutoInstallDuringOSUpgrade e isAutoInstallOnApplicableSystems sono false, manualAcquisition deve essere true e il driver verrà pubblicato con "May request user input" impostato su true.
  • Quando si condivide con altri partner (destinazione è un altroPartner), è necessario includere l'oggetto recipientSpecifications .

Popolamento delle informazioni di destinazione

L'oggetto di destinazione contiene dati che indicano Windows Update informazioni su:

  • Come deve essere indirizzato il driver in termini di ID hardware.

  • Indica se è necessario applicare chid o restrizioni.

L'oggetto ID hardware deve contenere una combinazione valida di ID bundle, ID PNP, codice del sistema operativo e nome INF durante la creazione di una nuova etichetta di spedizione. Scaricare il file di metadati del driver (fornito come collegamento quando si ottengono i dettagli di un invio) per ottenere le combinazioni consentite e valide di questi attributi per l'invio. Per altre info, vedi Metadati del pacchetto driver.

Esempi di richiesta

Nell'esempio seguente viene illustrato come creare un nuovo prodotto.

POST https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels HTTP/1.1
Authorization: Bearer <your access token>

Risposta

L'esempio seguente illustra il corpo della risposta JSON restituito da una richiesta riuscita per la creazione di un'etichetta di spedizione. I dettagli sui valori nel corpo della risposta vengono visualizzati nella tabella che segue l'esempio.

{
  "id": 1152921504606997500,
  "productId": 14461751976964156,
  "submissionId": 1152921504621467600,
  "publishingSpecifications": {
    "goLiveDate": "2018-02-22T06:50:54.793+00:00",
    "visibleToAccounts": [
      27691110,
      27691111
    ],
    "isAutoInstallDuringOSUpgrade": true,
    "isAutoInstallOnApplicableSystems": false,
    "isDisclosureRestricted": false,
    "publishToWindows10s": true,
    "additionalInfoForMsApproval": {
      "microsoftContact": "abc@microsoft.com",
      "validationsPerformed": "Validation 1",
      "affectedOems": [
        "OEM1",
        "OEM2"
      ],
      "isRebootRequired": false,
      "isCoEngineered": false,
      "isForUnreleasedHardware": false,
      "hasUiSoftware": false,
      "businessJustification": "This is a business justification"
    },
    "manualAcquisition": false
  },
  "workflowStatus": {
    "currentStep": "preProcessShippingLabel",
    "state": "notStarted",
    "messages": []
  },
  "links": [
    {
      "href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606997603",
      "rel": "self",
      "method": "GET"
    },
    {
      "href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606997603",
      "rel": "update_shippinglabel",
      "method": "PATCH"
    }
  ],
  "name": "Shipping Label Name",
  "destination": "windowsUpdate"
}

Corpo della risposta

Per informazioni dettagliate sul corpo della risposta, vedere La risorsa etichetta di spedizione.

Codici di errore

Per informazioni sui codici di errore, vedi Codici di errore.

Vedi anche

Esempi di API del dashboard hardware (GitHub)