更新发货标签

  • 项目

在 Microsoft 硬件API 中使用此方法更新发货标签。 使用此方法之前，请确保已创建发货标签。 有关创建发货标签的详细信息，请参阅创建新的发货标签。

先决条件

完成 Microsoft 硬件 API 的所有先决条件（如果尚未这样做），然后再使用这其中的任何方法。

请求

此方法具有以下语法。 本主题中的其他部分提供了标头和请求正文的用法示例和说明。

方法 请求 URI
PATCH https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels/{shippingLabelId}

方法中的 productID、submissionID 和 shippingLabelID 表示要更新的产品、提交和发货标签。

请求头

标头 类型 说明
授权 字符串 必需。 Bearer<token> 令牌形式的 Microsoft Entra ID 访问令牌。
Accept 字符串 可选。 指定内容的类型。 允许的值是“application/json”

请求参数

请勿为此方法提供请求参数。

请求正文

以下示例演示了发货标签的 JSON 请求正文。 只能对发货标签进行以下类型的更改：

  • 添加硬件 ID
  • 删除硬件 ID/使硬件 ID 过期
  • 添加 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"
  }
}

有关请求中的字段的详细信息，请参阅发货标签资源。

需要注意的要点：

  • 更新 CHID 或 HardwareID 时，必须为“操作”提供值。

  • “受众”是仅更新字段。 在此字段中提供值将覆盖以前的任何值。 将此值留空将删除上一个值。

  • 若要了解如何获取组织的受众列表，请参阅获取受众。

  • 更新发货标签时，硬件 ID 对象应包含捆绑 ID、PNP ID、OS 代码和 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。

完成此步骤后，请使用获取发货标签中的方法获取发货标签的更新详细信息。

错误代码

有关错误代码的更多信息，请参阅错误代码。

另请参阅