Получение этикетки доставки
Используйте этот метод для получения данных для определенной этикетки доставки определенной отправки продукта.
Предварительные требования
Если вы еще не сделали этого, выполните все предварительные требования для API оборудования Майкрософт, прежде чем пытаться использовать любой из этих методов. Прежде чем использовать эти методы, продукт и отправка должны уже существовать в вашей учетной записи Центра разработки. Сведения о создании отправок для продуктов и управлении ими см. в статье Управление отправками продуктов.
Запрос
У этого метода следующий синтаксис. Примеры использования и описание текста заголовка и запроса приведены в следующих разделах.
| Метод | Универсальный код ресурса (URI) запроса |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/{shippingLabelId} |
Заголовок запроса
| Заголовок | Тип | Описание |
|---|---|---|
| авторизация | строка | Обязательный. Маркер доступа идентификатора Microsoft Entra в формате Bearer *<token>*. |
| accept | строка | Необязательный параметр. Указывает тип содержимого. Допустимое значение — application/json. |
Параметры запроса
Параметры запроса являются необязательными для этого метода.
| Имя | Тип | Описание |
|---|---|---|
| includeTargetingInfo | Логическое | Необязательный элемент. Если для этого параметра задано значение true, метка доставки возвращает целевые сведения о этикетке доставки, такие как идентификаторы оборудования и chiD. Дополнительные сведения см. в разделе Целевой объект. |
Текст запроса
Предоставлять текст запроса для этого метода не требуется.
Примеры запросов
В следующем примере показано, как получить сведения о конкретном продукте, зарегистрированном в вашей учетной записи.
GET https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964156/submissions/1152921504621467600/shippingLabels/1152921504606980300 HTTP/1.1
Authorization: Bearer <your access token>
Ответ
В следующем примере демонстрируется текст ответа JSON, возвращенный успешным запросом на определенную транспортную этикетку. Сведения о значениях в тексте ответа отображаются в таблице, приведенной ниже.
{
"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"
}
Текст ответа
Дополнительные сведения о тексте ответа см. в разделе Ресурс ShippingLabel.
Коды ошибок
Дополнительные сведения о кодах ошибок см. в разделе Коды ошибок.