Obtener una etiqueta de envío
Utilice este método para recuperar datos de una etiqueta de envío específica de un envío específico de un producto.
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. 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 administrar envíos para productos, consulte los métodos de Administrar envíos de productos.
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 |
---|---|
GET | https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/{shippingLabelId} |
Encabezado de solicitud
Encabezado | Tipo | Descripción |
---|---|---|
authorization | string | Necesario. Token de acceso de id. de Microsoft Entra en el formulario Bearer *<token>*. |
accept | string | Opcional. Especifica el tipo de contenido. El valor permitido es "application/json" |
Parámetros de solicitud
Los parámetros de solicitud son opcionales para este método.
Nombre | Tipo | Descripción |
---|---|---|
includeTargetingInfo | boolean | Opcional. Si este parámetro se establece en true, la etiqueta de envío devuelve los detalles de destino de la etiqueta de envío, como los identificadores de hardware y los CHID. Para obtener más información, consulta El objeto Targeting. |
Cuerpo de la solicitud
No incluyas un cuerpo de la solicitud para este método.
Ejemplos de solicitud
En el ejemplo siguiente se muestra cómo recuperar información sobre un producto específico registrado en su cuenta.
GET https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964156/submissions/1152921504621467600/shippingLabels/1152921504606980300 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 una etiqueta de envío específica. Los detalles sobre los valores del cuerpo de la respuesta aparecen en la tabla siguiente al ejemplo.
{
"id": 1152921504606978300,
"productId": 14461751976964156,
"submissionId": 1152921504621467600,
"publishingSpecifications": {
"goLiveDate": "2018-04-12T05:28:32.721Z",
"visibleToAccounts": [
27691110,
27691111
],
"isAutoInstallDuringOSUpgrade": true,
"isAutoInstallOnApplicableSystems": true,
"isDisclosureRestricted": false,
"publishToWindows10s": false,
"additionalInfoForMsApproval": {
"microsoftContact": "abc@mcirosoft.com",
"validationsPerformed": "Validation 1",
"affectedOems": [
"OEM1",
"OEM2"
],
"isRebootRequired": false,
"isCoEngineered": true,
"isForUnreleasedHardware": true,
"hasUiSoftware": false,
"businessJustification": "This is a business justification"
}
},
"targeting": {
"hardwareIds": [
{
"bundleId": "amd64",
"infId": "foo.inf",
"operatingSystemCode": "WINDOWS_v100_SERVER_X64_RS5_FULL",
"pnpString": "hid\\vid_dummy256f&pid_dummyc62f",
"distributionState": "pendingAdd"
},
{
"bundleId": "amd64",
"infId": "foo.inf",
"operatingSystemCode": "WINDOWS_v100_RS2_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": "microsoftApproval",
"state": "started",
"messages": []
},
"links": [
{
"href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606978459",
"rel": "self",
"method": "GET"
},
{
"href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606978459",
"rel": "update_shippinglabel",
"method": "PATCH"
}
],
"name": "VR_RS4Build_DualPublishCheck",
"destination": "windowsUpdate"
}
Response body
Para más información sobre el cuerpo de la respuesta, consulte El recurso ShippingLabel.
Códigos de error
Para obtener información sobre los códigos de error, consulte Códigos de error.