Obtenir une étiquette d’expédition
Utilisez cette méthode pour récupérer les données d’une étiquette d’expédition spécifique d’une soumission spécifique d’un produit.
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’essayer d’utiliser l’une de ces méthodes. Avant de pouvoir utiliser ces méthodes, le produit et la soumission doivent déjà exister dans votre compte du Centre de développement. Pour créer ou gérer les soumissions de produits, consultez les méthodes dans Gérer les soumissions de produits.
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 |
---|---|
GET | https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/{shippingLabelId} |
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 | facultatif. Spécifie le type de contenu. La valeur autorisée est « application/json » |
Paramètres de la demande
Les paramètres de requête sont facultatifs pour cette méthode.
Nom | Type | Description |
---|---|---|
includeTargetingInfo | boolean | facultatif. Si ce paramètre a la valeur true, l’étiquette d’expédition retourne les détails de ciblage de l’étiquette d’expédition, comme les ID matériels et les CHID. Pour plus d’informations, consultez Ciblage de l’objet. |
Corps de la demande
Ne fournissez pas de corps de requête pour cette méthode.
Exemples de demande
L’exemple suivant montre comment récupérer des informations sur un produit spécifique inscrit sur votre compte.
GET https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964156/submissions/1152921504621467600/shippingLabels/1152921504606980300 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 pour une étiquette d’expédition spécifique. Des détails sur les valeurs dans le corps de la réponse apparaissent dans le tableau suivant l’exemple.
{
"id": 1152921504606978300,
"productId": 14461751976964156,
"submissionId": 1152921504621467600,
"publishingSpecifications": {
"goLiveDate": "2018-04-12T05:28:32.721Z",
"visibleToAccounts": [
27691110,
27691111
],
"isAutoInstallDuringOSUpgrade": true,
"isAutoInstallOnApplicableSystems": true,
"isDisclosureRestricted": false,
"publishToWindows10s": false,
"additionalInfoForMsApproval": {
"microsoftContact": "abc@mcirosoft.com",
"validationsPerformed": "Validation 1",
"affectedOems": [
"OEM1",
"OEM2"
],
"isRebootRequired": false,
"isCoEngineered": true,
"isForUnreleasedHardware": true,
"hasUiSoftware": false,
"businessJustification": "This is a business justification"
}
},
"targeting": {
"hardwareIds": [
{
"bundleId": "amd64",
"infId": "foo.inf",
"operatingSystemCode": "WINDOWS_v100_SERVER_X64_RS5_FULL",
"pnpString": "hid\\vid_dummy256f&pid_dummyc62f",
"distributionState": "pendingAdd"
},
{
"bundleId": "amd64",
"infId": "foo.inf",
"operatingSystemCode": "WINDOWS_v100_RS2_FULL",
"pnpString": "hid\\vid_dummy256f&pid_dummyc62f",
"distributionState": "pendingAdd"
}
],
"chids": [
{
"chid": "346511cf-ccee-5c6d-8ee9-3c70fc7aae83",
"distributionState": "pendingAdd"
}
],
"restrictedToAudiences": [
"00000000-0000-0000-0000-000000000000",
"00000000-0000-0000-0000-000000000001"
],
"inServicePublishInfo": {
"flooring": "RS1",
"ceiling": "RS3"
},
"coEngDriverPublishInfo": {
"flooringBuildNumber": 17135,
"ceilingBuildNumber": 17139
}
},
"workflowStatus": {
"currentStep": "microsoftApproval",
"state": "started",
"messages": []
},
"links": [
{
"href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606978459",
"rel": "self",
"method": "GET"
},
{
"href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606978459",
"rel": "update_shippinglabel",
"method": "PATCH"
}
],
"name": "VR_RS4Build_DualPublishCheck",
"destination": "windowsUpdate"
}
Response body
Pour plus d’informations sur le corps de la réponse, consultez la ressource ShippingLabel.
Codes d’erreur
Pour plus d’informations sur les codes d’erreur, consultez Codes d’erreur.