Mettre à jour une étiquette d’expédition
Utilisez cette méthode dans l’API matériel Microsoft pour mettre à jour une étiquette d’expédition. Avant d’utiliser cette méthode, vérifiez que vous avez déjà créé une étiquette d’expédition. Pour plus d’informations sur la création d’une étiquette d’expédition, consultez Créer une étiquette d’expédition.
Prérequis
Si vous ne l’avez pas déjà fait, remplissez toutes les conditions préalables pour les API matérielles Microsoft avant d’utiliser l’une de ces méthodes.
Requête
Cette méthode présente la syntaxe suivante. Les autres sections de cette rubrique fournissent des exemples d’utilisation et des descriptions de l’en-tête et du corps de la requête.
| Méthode | URI de demande |
|---|---|
| PATCH | https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels/{shippingLabelId} |
ProductID, submissionID et shippingLabelID dans la méthode représentent le produit, l’envoi et l’étiquette d’expédition à mettre à jour.
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 demande JSON pour une étiquette d’expédition. Seuls les types de modifications suivants peuvent être apportés à une étiquette d’expédition :
- Ajouter des ID matériels
- Supprimer/expirer des ID matériels
- Ajouter des CHID
- Supprimer les CHID
- Ajouter une audience
- Mettre à jour/supprimer l’audience
- Fournir une justification métier pour les modifications
{
"targeting": {
"chids": [
{
"action": "add",
"chid": "812fac65-9c26-473c-b3a9-1eb3803ac22c"
},
{
"action": "remove",
"chid": "aed6336d-0958-444c-89b6-bf471191d6f0"
}
],
"hardwareIds": [
{
"action": "remove",
"bundleId": "a2dfbcd8-1d4a-4885-90a3-2ac8360542da",
"infId": "foo.inf",
"operatingSystemCode": "WINDOWS_v100_X64_RS3_FULL",
"pnpString": "pci\\ven_8086&dev_5a85"
},
{
"action": "add",
"bundleId": "48140805-45a3-4a76-8818-e75c117adba9",
"infId": "foo.inf",
"operatingSystemCode": "WINDOWS_v100_X64_RS3_FULL",
"pnpString": "pci\\ven_8086&dev_5a85"
}
],
"restrictedToAudiences": [
"00000000-0000-0000-0000-000000000000",
"00000000-0000-0000-0000-000000000001"
],
"inServicePublishInfo": {
"flooring": "RS1",
"ceiling": "RS3"
},
"businessJustification": "Business justification for updating shipping label"
}
}
Pour plus d’informations sur les champs de la demande, consultez ressource ShippingLabel.
Points à noter :
Vous devez fournir une valeur pour l’action lors de la mise à jour de CHID ou de HardwareIDs.
Audience est un champ de mise à jour uniquement. La fourniture d’une valeur dans ce champ remplace toute valeur précédente. Le fait de laisser la valeur vide supprime la valeur précédente.
Pour savoir comment obtenir une liste d’audiences pour votre organization, consultez Obtenir une audience.
L’objet d’ID matériel doit contenir une combinaison valide d’ID de bundle, d’ID PNP, de code de système d’exploitation et de nom INF lors de la mise à jour d’une étiquette d’expédition. Pour obtenir les combinaisons valides et autorisées de ces attributs pour votre soumission (package), 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 plus d’informations, consultez Métadonnées du package de pilote.
Exemples de demande
L’exemple suivant montre comment mettre à jour une étiquette d’expédition.
PATCH https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964156/submissions/1152921504621467600/shippingLabels/1152921504606980300 HTTP/1.1
Authorization: Bearer <your access token>
response
La réponse sera vide avec une status HTTP de 204.
Après cette étape, utilisez la méthode dans Obtenir une étiquette d’expédition pour obtenir les détails mis à jour de l’étiquette d’expédition.
Codes d’erreur
Pour plus d’informations sur les codes d’erreur, consultez Codes d’erreur.