Obtener datos de las etiquetas de envío

Artículo
02/29/2024

Para ver una introducción a las API de hardware de Microsoft, incluidos los requisitos previos para usar la API, consulte Administrar envíos de hardware mediante API.

Utilice los métodos siguientes en las API de hardware de Microsoft para obtener los datos de las etiquetas de envío de los productos de hardware registrados en la cuenta del Centro de desarrollo de hardware.

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

Para poder utilizar estos métodos, el producto y el envío deben existir ya en su cuenta del Centro de desarrollo. Para crear o administrar envíos para productos, consulte los métodos en Administrar envíos de productos.

Descripción	Método	URI
Obtener datos para todas las etiquetas de envío de un envío	OBTENER	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/`
Obtener datos para una etiqueta de envío específica de un envío	OBTENER	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/{shippingLabelId}`

Requisitos previos

Si aún no lo ha hecho, complete todos los Requisitos previos de las API de hardware de Microsoft antes de intentar usar cualquiera de estos métodos.

Recursos de datos

Los métodos de la API del panel de hardware de Microsoft para obtener datos de etiquetas de envío utilizan los siguientes recursos de datos JSON.

Recurso ShippingLabel

Este recurso representa una etiqueta de envío creada para un envío del producto registrado en su cuenta.

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

Este recurso tiene los siguientes valores:

Valor	Tipo	Descripción
id	long	Id. de la etiqueta de envío
productId	long	Id. de producto privado al que está asociada esta etiqueta de envío
submissionId	long	Id. de envío al que está asociada esta etiqueta de envío
publishingSpecifications	object	Consulte el objeto de especificaciones de publicación para obtener más detalles.
recipientSpecifications	matriz de objetos	Consulte el objeto de especificaciones de destinatario para obtener más detalles.
establecer destinos	object	Consulte el objeto de destino para obtener más detalles.
workflowStatus	object	Este objeto muestra el estado del flujo de trabajo para esta etiqueta de envío. Consulte el objeto de estado del flujo de trabajo de etiqueta de envío para obtener más detalles.
vínculos	matriz de objetos	Para obtener más información, consulte el objeto de enlace.
name	string	Nombre de la etiqueta de envío
destination	string	Indica el destino de la etiqueta de envío. Los posibles valores son (descripción en paréntesis): anotherPartner (esta etiqueta de envío se utiliza para compartir el envío con otro asociado) windowsUpdate (esta etiqueta de envío se utiliza para publicar en Windows Update) notSet

Objeto de especificaciones de publicación

Este objeto representa las especificaciones de cómo se publicará un objeto en Windows Update. Este objeto estará disponible o será necesario solo cuando el destino de la etiqueta de envío sea 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"
  }
}