Obtener datos de las etiquetas de envío

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

Utilice los siguientes métodos en las API de hardware de Microsoft para obtener datos de las etiquetas de envío de productos de hardware registrados en su cuenta de Hardware Dev Center.

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

Para poder usar estos métodos, el producto y el envío ya deben existir en su cuenta del Centro de desarrollo. Para crear o gestionar presentaciones de productos, consulte los métodos en "Administrar presentaciones de productos".

Descripción Método URI
Obtener datos para todas las etiquetas de envío de un envío GET 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 GET https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/{shippingLabelId}

Prerequisites

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

Recursos de datos

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

Recurso de etiqueta de envío

Este recurso representa una etiqueta de envío creada para la presentación de su 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,
    "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"
}

Este recurso tiene los siguientes valores:

Value Tipo Descripción
id long Identificador de la etiqueta de envío
productId long Identificador de producto privado al que está asociada esta etiqueta de envío
Id de envío long Identificador 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.
especificaciones del destinatario matriz de objetos Consulte el objeto de especificaciones del destinatario para obtener más detalles.
focalización 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.
Enlaces matriz de objetos Para obtener más información, consulta link object ( Objeto de vínculo).
nombre string Nombre de la etiqueta de envío
destino string Indica el destino de la etiqueta de envío. Los valores posibles son (descripción entre paréntesis):
  • anotherPartner (esta etiqueta de envío es para compartir el envío con otro asociado)
  • windowsUpdate (este etiqueta de envío es 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 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"
  }
}

Este objeto tiene los siguientes valores

Value Tipo Descripción
goLiveDate datetime Fecha para que el controlador esté disponible para su descarga en Windows Update. Si no se proporciona ninguna fecha, el controlador se publica inmediatamente después de la certificación.
visibleParaLasCuentas matriz de long Lista de los ID de vendedores que tendrán permisos de solo lectura sobre el transportista y la etiqueta de envío. Esta información es útil cuando desea que un asociado tenga en cuenta una solicitud de etiqueta de envío, como cuando publique un controlador en su nombre.
isAutoInstallDuringOSUpgrade booleano Si el controlador se entregará a las máquinas aplicables durante una actualización del sistema operativo.
isAutoInstallOnApplicableSystems booleano Si el controlador se distribuirá automáticamente a los equipos correspondientes.
isDisclosureRestricted booleano Si se impedirá que el controlador aparezca en WSUS y en el catálogo de Windows Update.
publishToWindows10s booleano Si el controlador se publicará en Windows 10 S
additionalInfoForMsApproval object Para obtener información, consulte Información adicional del objeto Microsoft.

Información adicional para el objeto Microsoft

Este objeto representa información adicional que requiere Microsoft para revisar la etiqueta Envío. Este objeto solo estará disponible o necesario cuando el destino de la etiqueta de envío sea windowsUpdate y la etiqueta de envío esté marcada como isAutoInstallDuringOSUpgrade o isAutoInstallOnApplicableSystems.

{
    "microsoftContact": "abc@microsoft.com",
    "validationsPerformed": "Validation 1",
    "affectedOems": [
      "OEM1",
      "OEM2"
    ],
    "isRebootRequired": false,
    "isCoEngineered": true,
    "isForUnreleasedHardware": true,
    "hasUiSoftware": false,
    "businessJustification": "This is a business justification"
}

Este objeto tiene los siguientes valores

Value Tipo Descripción
microsoftContact string Dirección de correo electrónico del patrocinador de Microsoft que trabaja con usted en esta solicitud
validationsPerformed string Descripción de cómo se validó el controlador. Microsoft usa esta información durante la revisión.
affectedOems string Lista de nombres de OEM afectados por esta publicación. Esta información la usará Microsoft durante la revisión.
isRebootRequired booleano Si se requiere un reinicio después de instalar el controlador. Microsoft usa esta información durante la revisión.
isCoEngineered booleano Si el controlador es un controlador codesarrollado que funciona con compilaciones activas (aún no publicadas) de Windows. Microsoft usa esta información durante la revisión.
isForUnreleasedHardware booleano Si el controlador admite un dispositivo nuevo o aún no lanzado. Microsoft usa esta información durante la revisión.
hasUiSoftware booleano ¿Si el controlador implementará una interfaz de usuario o software? Microsoft usa esta información durante la revisión.
businessJustification string Justificación comercial para promover esta solicitud de publicación. Microsoft usa esta información durante la revisión.

Objeto de especificaciones del destinatario

Este objeto representa los detalles y condiciones en los que el envío se comparte con otro asociado. Este objeto solo estará disponible o necesario cuando el destino de la etiqueta de envío sea otroPartner.

{
	"receiverPublisherId": "27691110",
	"enforceChidTargeting": false,
    "blockDuaCreation": false
}

Este objeto tiene los siguientes valores

Value Tipo Descripción
receiverPublisherId string ID del vendedor con quien se comparte el controlador. Los destinatarios pueden descargar el controlador, publicar en Windows Update, crear paquetes DUA. Los destinatarios no pueden compartir aún más con otros asociados.
enforceChidTargeting booleano Indica si un socio debe aplicar CHID a las etiquetas de envío que cree para esta presentación de controladores. Esto le permite proteger a los usuarios cuando un identificador de hardware puede compartirse entre muchas empresas asociadas.
blockDuaCreation Booleano Indica si está bloqueada la creación de DUA para los destinatarios de esta etiqueta de envío compartida. Cuando es true, los receptores no pueden descargar el shell DUA ni crear envíos derivados. El valor predeterminado es falso.

Objeto objetivo

Este objeto representa los detalles de destino de la etiqueta de envío que se requiere cuando se publica en Windows Update.

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

Este objeto tiene los siguientes valores

Value Tipo Descripción
identificadores de hardware matriz de objetos Para obtener más información, consulta Objeto de id. de hardware.
chids matriz de objetos Para obtener más información, consulta el objeto CHIDs.
restringido a determinados públicos matriz de cadenas Un array de cadenas que representa Audiences. Las audiencias permiten restringir esta publicación a las máquinas con una configuración determinada. Por ejemplo, un grupo de prueba solo se enviará a los clientes que tengan instalada una determinada clave del Registro. Para obtener información sobre cómo identificar y administrar las audiencias aplicables a su organización, consulte Obtención de datos de audiencia.
inServicePublishInfo object Consulte el objeto de información de publicación del servicio para obtener más detalles. El objeto de destino puede contener inServicePublishInfo o coEngDriverPublishInfo, no ambos.
coEngDriverPublishInfo object Consulte el objeto de información de publicación del controlador de coingeniería para obtener más detalles. El objeto de destino puede contener inServicePublishInfo o coEngDriverPublishInfo, no ambos.

Objeto ID de hardware

Este objeto representa los detalles del identificador de hardware que debe tener como destino la etiqueta de envío. Consulte identificadores de hardware para obtener más detalles.

{
	"bundleId": "amd64",
	"infId": "foo.inf",
	"operatingSystemCode": "WINDOWS_v100_SERVER_X64_RS5_FULL",
	"pnpString": "hid\\vid_dummy256f&pid_dummyc62f",
	"distributionState": "pendingAdd"
}

Este objeto tiene los siguientes valores

Value Tipo Descripción
bundleId string Identificador que representa el paquete en el que se encuentra el identificador de hardware.
infId string Nombre del archivo inf que contiene este identificador de hardware
operatingSystemCode string El código del sistema operativo aplicable a este identificador de hardware específico: combinación de arquitectura. Consulte la lista de códigos del sistema operativo para ver los posibles valores.
pnpString string El identificador PNP o el identificador de hardware al que va dirigido.
distributionState string Representa el estado de destino actual de este identificador de hardware. Los valores posibles son (descripción en parantésis):
  • adición pendiente (Se ha solicitado añadir este identificador de hardware y el proceso está en curso)
  • Eliminación pendiente (Se ha solicitado eliminar (expirar) este identificador de hardware y el proceso está en curso)
  • agregado (este identificador de hardware se ha agregado correctamente como destino en esta etiqueta de envío)
  • notSet (no se ha realizado ninguna acción o no se ha establecido el estado en este identificador de hardware)
acción string Esto solo es aplicable durante la actualización o revisión de una etiqueta de envío. Los valores posibles son:
  • add
  • eliminar

El objeto de identificador de hardware debe contener una combinación válida de identificador de paquete, identificador PNP, código del sistema operativo y el nombre del INF al crear una nueva etiqueta de envío. Para obtener las combinaciones permitidas o válidas de estos atributos para el envío (paquete), puede descargar el archivo de metadatos del controlador que se proporciona como un vínculo al obtener detalles de un envío. Para obtener más información, consulte metadatos del paquete de controladores.

objeto CHIDs

Este objeto representa el CHID (identificador de hardware del equipo) al que debe ir dirigida la etiqueta de envío. Consulte el uso de CHID para obtener más información.

{
	"chid": "346511cf-ccee-5c6d-8ee9-3c70fc7aae83",
	"distributionState": "pendingAdd"
}

Este objeto tiene los siguientes valores

Value Tipo Descripción
chid GUID CHID que se debe seleccionar
distributionState string Valor opcional que indica el estado actual de segmentación de este CHID. Por defecto, es Desconocido si no está definido. Valores posibles (descripción entre paréntesis):
  • Desconocido
  • Adición pendiente (Se ha solicitado agregar este identificador de hardware y el proceso está en curso)
  • Se agregó
  • PendingRemove (se ha solicitado una eliminación (expiración) para este identificador de hardware y está en curso)
  • Recuperación pendiente
  • Recuperado
acción string Esto solo es aplicable durante la actualización o revisión de una etiqueta de envío. Los valores posibles son:
  • add
  • eliminar

En el objeto Service Publish Information

Este objeto representa intervalos de distribución definidos por un piso y un techo. El límite inferior describe la versión más antigua de Windows a la que se distribuirá el controlador, y el límite superior marca la más reciente. Al agregar un piso y un techo, puede restringir la distribución del conductor.

{
  "flooring": "RS1",
  "ceiling": "RS3",

}

Este objeto tiene los siguientes valores

Value Tipo Descripción
suelo string Use esta opción cuando desee que un controlador se ofrezca solo en y encima del sistema operativo Windows 10 indicado. Por ejemplo, seleccionar una base RS4 significaría que solo los sistemas con Windows 10 1803 (RS4) y versiones posteriores recibirán este controlador. Los valores posibles son:
  • ÉSIMO
  • RS1
  • RS2
  • RS3
  • RS4
  • RS5
  • 19H1
  • VB
  • FE
  • CO
  • NI
Tenga en cuenta que los valores posibles se expandirán para incluir la versión actual del sistema operativo.
Techo string El acceso a esta característica es limitado. Use esta opción cuando desee que solo se ofrezca un controlador para el sistema operativo enumerado y los sistemas anteriores. Por ejemplo, seleccionar un límite RS3 en un controlador certificado para Windows 10 1607 (RS1) significaría que su controlador nunca se ofrecería a sistemas que ejecuten Windows 10 1803 (RS4) o versiones posteriores. Los valores posibles son:
  • ÉSIMO
  • RS1
  • RS2
  • RS3
  • RS4
  • RS5
  • 19H1
  • VB
  • FE
  • CO
Tenga en cuenta que los valores posibles se expandirán para incluir la versión actual del sistema operativo.

Para obtener más información sobre estos valores, consulta Limitación de la distribución de controladores por versiones de Windows.

objeto de información de publicación del controlador de Co-Engineering

Este objeto representa los intervalos de distribución definidos por un piso y un techo al desarrollar controladores para versiones más recientes e no publicadas de Windows. Este objeto está disponible solo para Microsoft asociados de co-ingeniería. El límite inferior describe la versión más antigua de Windows a la que se distribuirá el controlador, y el límite superior marca la más reciente. Al agregar un piso y un techo, puede restringir la distribución del conductor.

{
  "flooringBuildNumber": 17135,
  "ceilingBuildNumber": 17139
}

Este objeto tiene los siguientes valores

Value Tipo Descripción
flooringBuildNumber number Número de compilación de la versión cuando desea que solo se ofrezca un controlador en y por encima de este número de compilación. Por ejemplo, si el piso debe ser 10.1.17135, la entrada debe ser 17135. La versión principal (10.1) siempre tiene como valor predeterminado la versión adecuada automáticamente.
ceilingBuildNumber number Número de compilación de la versión cuando desea que un controlador solo se ofrezca en este número de compilación o por debajo de este número de compilación. Por ejemplo, si el límite máximo debe ser 10.1.17139, la entrada debe ser 17139. La versión principal (10.1) siempre tiene como valor predeterminado la versión adecuada automáticamente.

Para obtener más información, consulta Limitar la distribución de controladores por versiones de Windows.

Shipping Label Workflow Status (objeto Estado del flujo de trabajo de etiqueta de envío)

Este objeto representa el estado del flujo de trabajo de una entidad determinada.

{
      "currentStep": "Created",
      "state": "completed",
      "messages": []
    }

Este objeto tiene los siguientes valores

Value Tipo Descripción
currentStep string Nombre del paso actual en el flujo de trabajo general de esta entidad.
Para las etiquetas de envío publicadas en Windows Update, los valores posibles son (descripción entre paréntesis):
  • Creado (Crear etiqueta de envío)
  • PreProcessShippingLabel (validación de la información de destino)
  • FinalizePreProcessing (Invocando el siguiente paso adecuado después de pre-prpcess)
  • PublishJobValidation (Comprobación de si se ha completado la ingesta o envío de paquetes)
  • UpdateGeneration (generación de detalles de publicación para WU)
  • MicrosoftApproval (promoción/despliegue gradual)
  • Publicación (envío de los detalles de publicación a WU)
  • FinalizarPublishing (completar el proceso de publicación)
Para las etiquetas de envío que se comparten con otros asociados, los valores posibles son (descripción entre paréntesis):
  • Creado (Crear etiqueta de envío)
  • PreProcessShippingLabel (validación de la información de destino)
  • FinalizePreProcessing (Invoca el siguiente paso adecuado después de pre-prpcess)
  • PublishJobValidation (Comprobación de si se ha completado la ingesta o envío de paquetes)
  • ProcessSharing (generación de detalles de uso compartido para el receptor)
  • FinalizarSharing (completar el proceso de uso compartido)
Estado string El estado del paso actual. Los valores posibles son:
  • No iniciado
  • iniciado
  • fallido
  • completado
Messages array Matriz de cadenas para proporcionar mensajes sobre el paso actual (especialmente en caso de error).

Nota:

No hay ningún valor de currentStep que se corresponda con la implementación gradual.

Códigos de error

Para obtener información sobre los códigos de error, consulte Códigos de error.

Consulte también