Creación de una nueva etiqueta de envío

  • Artículo

Use este método en la API de hardware de Microsoft para crear una nueva etiqueta de envío. Antes de usar esto, asegúrese de que ha creado un producto y ha creado un envío para ese producto. Para obtener más información, consulte Crear un producto y crear un envío.

Requisitos previos

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

Solicitud

Este método tiene la siguiente sintaxis. Consulta las siguientes secciones para ver ejemplos de uso y descripciones tanto del encabezado como del cuerpo de la solicitud.

Método URI de solicitud
POST https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels

El productID y submissionID del método representan el envío para el que se va a crear la etiqueta de envío.

Encabezado de solicitud

Encabezado Tipo Descripción
Authorization String Necesario. Token de acceso de identificador de Microsoft Entra en el formulario Token>de portador<.
Aceptar String Opcional. Especifica el tipo de contenido. El valor permitido es "application/json"

Parámetros de solicitud

No proporcione parámetros de solicitud para este método.

Cuerpo de la solicitud

En el ejemplo siguiente se muestra el cuerpo de la solicitud JSON para crear una nueva etiqueta de envío.

{
  "publishingSpecifications": {
    "goLiveDate": "2018-02-22T06:50:54.793Z",
    "visibleToAccounts": [
      27691110,
      27691111
    ],
    "isAutoInstallDuringOSUpgrade": true,
    "isAutoInstallOnApplicableSystems": false,
    "manualAcquisition": false,
    "isDisclosureRestricted": false,
    "publishToWindows10s": true,
    "additionalInfoForMsApproval": {
      "microsoftContact": "abc@microsoft.com",
      "validationsPerformed": "Validation 1",
      "affectedOems": [
        "OEM1",
        "OEM2"
      ],
      "isRebootRequired": false,
      "isCoEngineered": false,
      "isForUnreleasedHardware": false,
      "hasUiSoftware": false,
      "businessJustification": "This is a business justification"
    }
  },
  "targeting": {
    "hardwareIds": [
      {
        "bundleId": "3aba7558-10ca-42db-b1d1-57af5718aea3",
        "infId": "foo.inf",
        "operatingSystemCode": "WINDOWS_v100_RS3_FULL",
        "pnpString": "hid\\vid_dummy256f&pid_dummyc62f"
      }
    ],
    "chids": [
      {
        "chid": "346511cf-ccee-5c6d-8ee9-3c70fc7aae83",
        "distributionState": "pendingAdd"
      }
    ],
    "restrictedToAudiences": [
      "00000000-0000-0000-0000-000000000001",
      "00000000-0000-0000-0000-000000000002"
      ],
    "inServicePublishInfo": {
      "flooring": "RS1",
      "ceiling": "RS3"
    }
  },
  "name": "Shipping Label Name",
  "destination": "windowsUpdate"
}

Para más información sobre los campos de la solicitud, consulte Recurso ShippingLabel.

Puntos que se deben recordar al crear etiquetas de envío

  • Al publicar en Windows Update (el destino es windowsUpdate), debe incluir un objeto publishingSpecifications. Para las instalaciones automáticas (isAutoInstallDuringOSUpgrade o isAutoInstallOnApplicableSystems es true), debe establecer additionalInfoForMsApproval.
  • si en la etiqueta de envío esAutoInstallDuringOSUpgrade o isAutoInstallOnApplicableSystems es true, manualAcquisition debe ser false y el controlador se publicará con "May request user input" establecido en false.
  • si en la etiqueta de envío esAutoInstallDuringOSUpgrade y isAutoInstallOnApplicableSystems son false, manualAcquisition debe ser true y el controlador se publicará con "May request user input" establecido en true.
  • Al compartir con otros asociados (destination es anotherPartner), debe incluir el objeto recipientSpecifications .

Rellenar la información de destino

El objeto de destino contiene datos que indican Windows Update acerca de:

  • Cómo debe dirigirse el controlador en términos de identificadores de hardware.

  • Si se deben aplicar restricciones o CHID.

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

Ejemplos de solicitud

En el ejemplo siguiente se muestra cómo crear un nuevo producto.

POST https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels HTTP/1.1
Authorization: Bearer <your access token>

Response

En el ejemplo siguiente se muestra el cuerpo de respuesta JSON devuelto por una solicitud correcta para crear una etiqueta de envío. Los detalles sobre los valores del cuerpo de la respuesta aparecen en la tabla siguiente al ejemplo.

{
  "id": 1152921504606997500,
  "productId": 14461751976964156,
  "submissionId": 1152921504621467600,
  "publishingSpecifications": {
    "goLiveDate": "2018-02-22T06:50:54.793+00:00",
    "visibleToAccounts": [
      27691110,
      27691111
    ],
    "isAutoInstallDuringOSUpgrade": true,
    "isAutoInstallOnApplicableSystems": false,
    "isDisclosureRestricted": false,
    "publishToWindows10s": true,
    "additionalInfoForMsApproval": {
      "microsoftContact": "abc@microsoft.com",
      "validationsPerformed": "Validation 1",
      "affectedOems": [
        "OEM1",
        "OEM2"
      ],
      "isRebootRequired": false,
      "isCoEngineered": false,
      "isForUnreleasedHardware": false,
      "hasUiSoftware": false,
      "businessJustification": "This is a business justification"
    },
    "manualAcquisition": false
  },
  "workflowStatus": {
    "currentStep": "preProcessShippingLabel",
    "state": "notStarted",
    "messages": []
  },
  "links": [
    {
      "href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606997603",
      "rel": "self",
      "method": "GET"
    },
    {
      "href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606997603",
      "rel": "update_shippinglabel",
      "method": "PATCH"
    }
  ],
  "name": "Shipping Label Name",
  "destination": "windowsUpdate"
}

Response body

Para más información sobre el cuerpo de la respuesta, consulte el recurso de etiqueta de envío.

Códigos de error

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

Consulte también

ejemplos de API de panel de hardware (GitHub)