Actualización de una etiqueta de envío
Use este método en la API de hardware de Microsoft para actualizar una etiqueta de envío. Antes de usar este método, asegúrese de que ya ha creado una etiqueta de envío. Para obtener más información sobre cómo crear una etiqueta de envío, consulta Crear una nueva etiqueta de 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 usar cualquiera de estos métodos.
Solicitud
Este método tiene la siguiente sintaxis. En las demás secciones de este tema se proporcionan ejemplos de uso y descripciones del encabezado y el cuerpo de la solicitud.
| Método | URI de solicitud |
|---|---|
| PATCH | https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels/{shippingLabelId} |
El productID, submissionID y shippingLabelID en el método representan el producto, el envío y la etiqueta de envío que se van a actualizar.
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 una etiqueta de envío. Solo se pueden realizar los siguientes tipos de cambios en una etiqueta de envío:
- Adición de identificadores de hardware
- Quitar o expirar identificadores de hardware
- Agregar CHID
- Eliminación de CHID
- Agregar audiencia
- Actualizar o quitar audiencia
- Proporcionar justificación comercial para los cambios
{
"targeting": {
"chids": [
{
"action": "add",
"chid": "812fac65-9c26-473c-b3a9-1eb3803ac22c"
},
{
"action": "remove",
"chid": "aed6336d-0958-444c-89b6-bf471191d6f0"
}
],
"hardwareIds": [
{
"action": "remove",
"bundleId": "a2dfbcd8-1d4a-4885-90a3-2ac8360542da",
"infId": "foo.inf",
"operatingSystemCode": "WINDOWS_v100_X64_RS3_FULL",
"pnpString": "pci\\ven_8086&dev_5a85"
},
{
"action": "add",
"bundleId": "48140805-45a3-4a76-8818-e75c117adba9",
"infId": "foo.inf",
"operatingSystemCode": "WINDOWS_v100_X64_RS3_FULL",
"pnpString": "pci\\ven_8086&dev_5a85"
}
],
"restrictedToAudiences": [
"00000000-0000-0000-0000-000000000000",
"00000000-0000-0000-0000-000000000001"
],
"inServicePublishInfo": {
"flooring": "RS1",
"ceiling": "RS3"
},
"businessJustification": "Business justification for updating shipping label"
}
}
Para obtener más información sobre los campos de la solicitud, consulte El recurso ShippingLabel.
Puntos a tener en cuenta:
Debe proporcionar un valor para la acción al actualizar CHID o HardwareID.
La audiencia es un campo de solo actualización. Si se proporciona un valor en este campo, se sobrescribe cualquier valor anterior. Si se deja el valor en blanco, se quita el valor anterior.
Para obtener información sobre cómo obtener una lista de audiencias para su organización, consulte Obtener audiencia.
El objeto de identificador de hardware debe contener una combinación válida de identificador de agrupación, id. de PNP, código del sistema operativo y nombre INF al actualizar una etiqueta de envío. Para obtener las combinaciones válidas permitidas de estos atributos para el envío (paquete), descargue el archivo de metadatos del controlador (proporcionado como vínculo) al obtener los detalles de un 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 actualizar una etiqueta de envío.
PATCH https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964156/submissions/1152921504621467600/shippingLabels/1152921504606980300 HTTP/1.1
Authorization: Bearer <your access token>
Response
La respuesta estará vacía con un estado HTTP de 204.
Después de este paso, use el método en Obtener una etiqueta de envío para obtener los detalles actualizados de la etiqueta de envío.
Códigos de error
Para obtener más información sobre los códigos de error, consulta Códigos de error.