Créer une étiquette d’expédition
Utilisez cette méthode dans l’API matériel Microsoft pour créer une étiquette d’expédition. Avant de l’utiliser, vérifiez que vous avez créé un produit et une soumission pour ce produit. Pour plus d’informations, consultez Créer un produit et créer une soumission.
Prérequis
Si vous ne l’avez pas déjà fait, remplissez toutes les conditions préalables pour les API de matériel Microsoft avant d’essayer d’utiliser l’une de ces méthodes.
Requête
Cette méthode présente la syntaxe suivante. Consultez les sections suivantes pour obtenir des exemples d’utilisation et une description de l’en-tête et du corps de la requête.
| Méthode | URI de demande |
|---|---|
| POST | https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels |
Le productID et le submissionID de la méthode représentent la soumission pour laquelle l’étiquette d’expédition doit être créée.
En-tête de requête
| En-tête | Type | Description |
|---|---|---|
| Autorisation | String | Obligatoire. Jeton d’accès d’ID Microsoft Entra sous la forme Jeton> du porteur<. |
| Accepter | String | Optionnel. Spécifie le type de contenu. La valeur autorisée est « application/json » |
Paramètres de la demande
Ne fournissez pas de paramètres de requête pour cette méthode.
Corps de la demande
L’exemple suivant illustre le corps de la requête JSON pour la création d’une étiquette d’expédition.
{
"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"
}
Pour plus d’informations sur les champs de la demande, consultez la ressource ShippingLabel.
Points à retenir lors de la création d’étiquettes d’expédition
- Lorsque vous publiez sur Windows Update (la destination est windowsUpdate), vous devez inclure un objet publishingSpecifications. Pour les installations automatiques (isAutoInstallDuringOSUpgrade ou isAutoInstallOnApplicableSystems a la valeur true), vous devez définir additionalInfoForMsApproval.
- si dans l’étiquette d’expédition isAutoInstallDuringOSUpgrade ou isAutoInstallOnApplicableSystems a la valeur true, manualAcquisition doit être false et le pilote est publié avec « May request user input » défini sur false.
- si dans l’étiquette d’expédition isAutoInstallDuringOSUpgrade et isAutoInstallOnApplicableSystems ont la valeur false, manualAcquisition doit être true et le pilote est publié avec « May request user input » défini sur true.
- Lors du partage avec d’autres partenaires (la destination est un autrePartner), vous devez inclure l’objet recipientSpecifications .
Remplissage des informations de ciblage
L’objet de ciblage contient des données qui indiquent Windows Update sur :
Comment le pilote doit être ciblé en termes d’ID matériels.
Indique si le CHID ou les restrictions doivent être appliqués.
L’objet d’ID matériel doit contenir une combinaison valide d’ID d’offre groupée, d’ID PNP, de code de système d’exploitation et de nom INF lors de la création d’une étiquette d’expédition. Téléchargez le fichier de métadonnées du pilote (fourni sous forme de lien lorsque vous obtenez les détails d’une soumission) pour obtenir les combinaisons autorisées et valides de ces attributs pour votre soumission. Pour plus d’informations, consultez Métadonnées du package de pilote.
Exemples de demande
L’exemple suivant montre comment créer un produit.
POST https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels HTTP/1.1
Authorization: Bearer <your access token>
response
L’exemple suivant illustre le corps de la réponse JSON retourné par une demande réussie de création d’une étiquette d’expédition. Des détails sur les valeurs dans le corps de la réponse apparaissent dans le tableau suivant l’exemple.
{
"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"
}
Response body
Pour plus d’informations sur le corps de la réponse, consultez la ressource d’étiquette d’expédition.
Codes d’erreur
Pour plus d’informations sur les codes d’erreur, consultez Codes d’erreur.