Создание новой этикетки доставки
Используйте этот метод в API оборудования Майкрософт для создания новой этикетки доставки. Перед использованием убедитесь, что вы создали продукт и создали отправку для этого продукта. Дополнительные сведения см. в статье Создание продукта и создание отправки.
Предварительные требования
Если вы еще не сделали этого, выполните все предварительные требования для API оборудования Майкрософт, прежде чем пытаться использовать любой из этих методов.
Запрос
У этого метода следующий синтаксис. Примеры использования и описание текста заголовка и запроса приведены в следующих разделах.
| Метод | Универсальный код ресурса (URI) запроса |
|---|---|
| POST | https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels |
ProductID и submissionID в методе представляют отправку, для которой должна быть создана транспортная этикетка.
Заголовок запроса
| Заголовок | Тип | Описание |
|---|---|---|
| Авторизация | Строковый | Обязательный элемент. Маркер доступа идентификатора Microsoft Entra в форме Токен>носителя<. |
| Принять | Строка | Необязательный элемент. Указывает тип содержимого. Допустимое значение — application/json. |
Параметры запроса
Не предоставляйте параметры запроса для этого метода.
Текст запроса
В следующем примере показан текст запроса JSON для создания новой этикетки доставки.
{
"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"
}
Дополнительные сведения о полях в запросе см. в разделе Ресурс ShippingLabel.
Моменты, которые следует помнить при создании судоходных наклеек
- При публикации в клиентский компонент Центра обновления Windows (назначение — windowsUpdate) необходимо включить объект publishingSpecifications. Для автоматической установки (isAutoInstallDuringOSUpgrade или isAutoInstallOnApplicableSystems имеет значение true) необходимо задать параметр additionalInfoForMsApproval.
- Если в метке доставки isAutoInstallDuringOSUpgrade или isAutoInstallOnApplicableSystems имеет значение true, то параметр manualAcquisition должен иметь значение false, а драйвер будет опубликован с параметром "Может запросить ввод пользователя" значение false.
- Если в метке доставки isAutoInstallDuringOSUpgrade и isAutoInstallOnApplicableSystems задано значение false, то параметр manualAcquisition должен иметь значение true, а драйвер будет опубликован с параметром "Может запросить ввод пользователя" значение true.
- При совместном использовании с другими партнерами (назначение — anotherPartner) необходимо включить объект recipientSpecifications .
Заполнение сведений о целевом объекте
Целевой объект содержит данные, которые указывают клиентский компонент Центра обновления Windows о:
Как драйвер должен быть ориентирован с точки зрения идентификаторов оборудования.
Следует ли применять CHID или ограничения.
Объект идентификатора оборудования должен содержать допустимое сочетание идентификатора пакета, идентификатора PNP, кода ОС и имени INF при создании новой этикетки доставки. Скачайте файл метаданных драйвера (который предоставляется в виде ссылки при получении сведений об отправке), чтобы получить допустимые сочетания этих атрибутов для отправки. Дополнительные сведения см. в разделе Метаданные пакета драйверов.
Примеры запросов
В следующем примере показано, как создать новый продукт.
POST https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels HTTP/1.1
Authorization: Bearer <your access token>
Ответ
В следующем примере показан текст ответа JSON, возвращенный успешным запросом на создание этикетки доставки. Сведения о значениях в тексте ответа отображаются в таблице после примера.
{
"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"
}
Текст ответа
Дополнительные сведения о тексте ответа см. в разделе Ресурс этикетки доставки.
Коды ошибок
Дополнительные сведения о кодах ошибок см. в разделе Коды ошибок.
См. также раздел
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по