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

Article
02/26/2024

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.

Utilisez les méthodes suivantes prévues par les API matérielles de Microsoft pour obtenir des données sur les étiquettes d'expédition des produits matériels enregistrés 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 Dev Center. Pour créer ou gérer des soumissions de produits, consultez les méthodes de la section Gérer les soumissions de produits.

Description	Method	URI
Obtenir les données de 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}`

Prérequis

Si vous ne l'avez pas encore fait, remplissez toutes les conditions préalables pour les API matérielles de Microsoft avant d'essayer d'utiliser l'une de ces méthodes.

Ressources de données

Les méthodes de l'API matérielles de Microsoft pour l'obtention des ressources d'étiquettes d'expédition utilisent les ressources de données JSON suivantes.

Ressource ShippingLael

Cette ressource représente une étiquette d'expédition créée pour une soumission de votre produit qui est enregistrée sur 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
  },
  "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	L'ID de l'étiquette d'expédition
productId	long	L'identifiant privé du produit auquel cette étiquette d'expédition est associée
submissionId	long	L'identifiant de soumission auquel cette étiquette d'expédition est associée
publishingSpecifications	object	Pour en savoir plus, reportez-vous à l'objet « spécifications de publication ».
recipientSpecifications	tableau d'objets	Pour en savoir plus, reportez-vous à l'objet « spécifications du destinataire »
cibler	object	Pour en savoir plus, reportez-vous à la rubrique objet ciblé.
workflowStatus	object	Cet objet représente l'état du workflow pour cette étiquette d'expédition. Pour en savoir plus, reportez-vous à l'objet statut du workflow de l'étiquette d'expédition
liens	tableau d'objets	Pour en savoir plus, consultez l'objet du lien.
name	chaîne	Le nom de l'étiquette d'expédition
destination	string	Indique la destination de l'étiquette d'expédition. Les valeurs possibles sont les suivantes (description entre parenthèses) : anotherPartner (cette étiquette d'expédition permet de partager la soumission avec un autre partenaire) windowsUpdate (cette étiquette d'expédition est destinée à être publiée sur Windows Update) notSet

Objet Spécifications de publication

Cet objet représente les spécifications de la manière dont un objet sera publié dans Windows Update. Cet objet ne sera disponible ou nécessaire que 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"
  }
}