Ottenere i dati delle etichette di spedizione

Articolo
02/22/2024

Per un'introduzione alle API hardware Microsoft, inclusi i prerequisiti per l'uso dell'API, vedere Gestire gli invii di hardware usando le API.

Usare i metodi seguenti nelle API hardware Microsoft per ottenere i dati per la spedizione di etichette di prodotti hardware registrati nell'account Hardware Dev Center.

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

Prima di poter usare questi metodi, il prodotto e l'invio devono esistere già nel tuo account Dev Center. Per creare o gestire gli invii per i prodotti, vedi i metodi in Gestire gli invii di prodotti.

Descrizione	Method	URI
Ottenere i dati per tutte le etichette di spedizione di un invio	GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/`
Ottenere dati per un'etichetta di spedizione specifica di un invio	GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/{shippingLabelId}`

Prerequisiti

Se non è già stato fatto, completare tutti i prerequisiti per le API hardware Microsoft prima di provare a usare uno di questi metodi.

Risorse dati

I metodi dell'API del dashboard hardware Microsoft per ottenere i dati delle etichette di spedizione usano le risorse di dati JSON seguenti.

Risorsa ShippingLabel

Questa risorsa rappresenta un'etichetta di spedizione creata per un invio del prodotto registrato nel tuo account.

{
  "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"
}

Questa risorsa ha i valori seguenti:

Valore	Tipo	Descrizione
id	long	ID dell'etichetta di spedizione
productId	long	ID prodotto privato a cui è associata questa etichetta di spedizione
submissionId	long	ID invio a cui è associata questa etichetta di spedizione
publishingSpecifications	oggetto	Per altri dettagli, vedere l'oggetto specifiche di pubblicazione
recipientSpecifications	matrice di oggetti	Per altri dettagli, vedere l'oggetto specifiche del destinatario
destinazioni	oggetto	Per altri dettagli, fare riferimento all'oggetto di destinazione
workflowStatus	oggetto	Questo oggetto illustra lo stato del flusso di lavoro per questa etichetta di spedizione. Per altri dettagli, vedere l'oggetto stato del flusso di lavoro dell'etichetta di spedizione
collegamenti	matrice di oggetti	Per altre info, vedi l'oggetto link.
name	string	Nome dell'etichetta di spedizione
destination	string	Indica la destinazione dell'etichetta di spedizione. I valori possibili sono (descrizione tra parentesi): anotherPartner (questa etichetta di spedizione è per condividere l'invio con un altro partner) windowsUpdate (questa etichetta di spedizione è per la pubblicazione in Windows Update) Notset

Pubblicazione dell'oggetto Specifications

Questo oggetto rappresenta le specifiche della modalità di pubblicazione di un oggetto in Windows Update. Questo oggetto sarà disponibile/necessario solo quando la destinazione dell'etichetta di spedizione è 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"
  }
}