Obtenir les données de l’étiquette d’expédition

Pour une introduction aux API matérielles de Microsoft, y compris les conditions préalables à l'utilisation de l'API, voir "Gérer les soumissions de matériel à l'aide des API" dans l'article Gérer les soumissions de matériel à l'aide des API.

Utilisez les méthodes suivantes dans Microsoft API matérielles pour obtenir des données pour les étiquettes d’expédition des produits matériels inscrits dans votre compte du Centre de développement matériel.

https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/

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 des soumissions de produits, consultez les méthodes sous Gérer les soumissions de produits.

Description	Méthode	URI
Obtenir des données pour toutes les étiquettes d’expédition d’une soumission	GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/`
Obtenir des données pour une étiquette d’expédition spécifique d’une soumission	GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/{shippingLabelId}`

Prerequisites

Si vous ne l’avez pas déjà fait, effectuez toutes les Prerequisites pour les API matérielles Microsoft avant d’essayer d’utiliser l’une de ces méthodes.

Ressources de données

Les méthodes d’API du tableau de bord matériel Microsoft pour obtenir des données d’étiquette d’expédition utilisent les ressources de données JSON suivantes.

Ressource d’étiquette d’expédition

Cette ressource représente une étiquette d’expédition créée pour une soumission de votre produit inscrit à votre compte.

{
  "id": 1152921504606978422,
  "productId": 14461751976964157,
  "submissionId": 1152921504621467613,
  "publishingSpecifications": {
    "goLiveDate": "2018-04-12T05:28:32.721Z",
    "visibleToAccounts": [
      27691110, 27691111
    ],
    "isAutoInstallDuringOSUpgrade": true,
    "isAutoInstallOnApplicableSystems": true,
    "isDisclosureRestricted": false,
    "publishToWindows10s": false,
    "additionalInfoForMsApproval": {
      "microsoftContact": "abc@microsoft.com",
      "validationsPerformed": "Validation 1",
      "affectedOems": [
        "OEM1", "OEM2"
      ],
      "isRebootRequired": false,
      "isCoEngineered": true,
      "isForUnreleasedHardware": true,
      "hasUiSoftware": false,
      "businessJustification": "This is a business justification"
    }
  },
  "recipientSpecifications": {
    "receiverPublisherId": "27691110",
    "enforceChidTargeting": true,
    "blockDuaCreation": false
  },
  "targeting": {
    "hardwareIds": [
      {
        "bundleId": "amd64",
        "infId": "foo.inf",
        "operatingSystemCode": "WINDOWS_v100_SERVER_X64_RS5_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": "finalizePublishing",
    "state": "completed",
    "messages": [],
    "errorReport": ""
  },
  "links": [
    {
      "href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606978422",
      "rel": "self",
      "method": "GET"
    }
  ],
  "name": "Shipping Label Name",
  "destination": "windowsUpdate"
}

Cette ressource a les valeurs suivantes :

Valeur	Type	Description
ID	long	ID de l’étiquette d’expédition
productId	long	ID de produit privé auquel cette étiquette d’expédition est associée
ID de soumission	long	ID de soumission auquel cette étiquette d’expédition est associée
spécifications de publication	Objet	Reportez-vous à l’objet spécifications de publication pour plus d’informations
specificationsDestinataire	tableau d'objets	Reportez-vous à l’objet spécifications des destinataires pour plus d’informations
ciblage	Objet	Pour plus d’informations, reportez-vous à l’objet de ciblage
workflowStatus	Objet	Cet objet représente l’état du flux de travail pour cette étiquette d’expédition. Reportez-vous à l’objet d’état du flux de travail de l’étiquette d’expédition pour plus d’informations
links	tableau d'objets	Pour plus d’informations, consultez l’objet de lien.
name	string	Nom de l’étiquette d’expédition
destination	string	Indique la destination de l’étiquette d’expédition. Les valeurs possibles sont (description entre parenthèses) : anotherPartner (cette étiquette d’expédition est destinée à partager la soumission avec un autre partenaire) windowsUpdate ( cette étiquette d’expédition est destinée à la publication sur Windows Update) notSet

Objet de spécifications de publication

Cet objet représente les spécifications de la façon dont un objet sera publié sur Windows Update. Cet objet sera disponible/nécessaire uniquement lorsque la destination de l’étiquette d’expédition est windowsUpdate

{
  "goLiveDate": "2018-04-12T05:28:32.721Z",
  "visibleToAccounts": [
    27691110,
    27691111
  ],
  "isAutoInstallDuringOSUpgrade": true,
  "isAutoInstallOnApplicableSystems": true,
  "isDisclosureRestricted": false,
  "publishToWindows10s": false,
  "additionalInfoForMsApproval": {
    "microsoftContact": "abc@microsoft.com",
    "validationsPerformed": "Validation 1",
    "affectedOems": [
      "OEM1",
      "OEM2"
    ],
    "isRebootRequired": false,
    "isCoEngineered": true,
    "isForUnreleasedHardware": true,
    "hasUiSoftware": false,
    "businessJustification": "This is a business justification"
  }
}