Обновление этикетки доставки

Используйте этот метод в API оборудования Майкрософт для обновления этикетки доставки. Перед использованием этого метода убедитесь, что вы уже создали транспортную этикетку. Дополнительные сведения о создании транспортной этикетки см. в разделе Создание новой этикетки доставки.

Предварительные требования

Если вы еще не сделали этого, выполните все предварительные требования для API оборудования Майкрософт, прежде чем использовать любой из этих методов.

Запрос

У этого метода следующий синтаксис. В других разделах этого раздела приводятся примеры использования и описания заголовка и текста запроса.

Метод Универсальный код ресурса (URI) запроса
PATCH https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels/{shippingLabelId}

ProductID, submissionID и shippingLabelID в методе представляют обновляемую этикетку продукта, отправки и доставки.

Заголовок запроса

Заголовок Тип Описание
Авторизация Строковый Обязательный элемент. Маркер доступа идентификатора Microsoft Entra в виде маркера> носителя<.
Принять Строка Необязательный элемент. Указывает тип содержимого. Допустимое значение — application/json.

Параметры запроса

Не указывайте параметры запроса для этого метода.

Текст запроса

В следующем примере показан текст запроса JSON для этикетки доставки. В транспортную этикетку можно вносить только следующие типы изменений:

  • Добавление идентификаторов оборудования
  • Удаление и истечение срока действия идентификаторов оборудования
  • Добавление идентификаторов CHID
  • Удаление идентификаторов CHID
  • Добавление аудитории
  • Обновление или удаление аудитории
  • Предоставление бизнес-обоснования для изменений
{
  "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"
  }
}

Дополнительные сведения о полях в запросе см. в разделе Ресурс ShippingLabel.

Примечания:

  • При обновлении идентификаторов CHID или HardwareID необходимо указать значение действия .

  • Аудитория — это поле только для обновления. При предоставлении значения в этом поле все предыдущие значения перезаписываются. Если оставить значение пустым, предыдущее значение удаляется.

  • Чтобы узнать, как получить список аудиторий для вашей организации, см. статью Получение аудитории.

  • Объект идентификатора оборудования должен содержать допустимое сочетание идентификатора пакета, идентификатора PNP, кода ОС и имени INF при обновлении этикетки доставки. Чтобы получить допустимые, допустимые сочетания этих атрибутов для отправки (пакета), скачайте файл метаданных драйвера (предоставленный в виде ссылки) при получении сведений об отправке. Дополнительные сведения см. в разделе Метаданные пакета драйвера.

Примеры запросов

В следующем примере показано, как обновить транспортную этикетку.

PATCH https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964156/submissions/1152921504621467600/shippingLabels/1152921504606980300 HTTP/1.1
Authorization: Bearer <your access token>

Ответ

Ответ будет пустым с состоянием HTTP 204.

После этого используйте метод в разделе Получение этикетки доставки , чтобы получить обновленные сведения о этикетке.

Коды ошибок

Дополнительные сведения о кодах ошибок см. в разделе Коды ошибок.

См. также раздел