获取发货标签

使用此方法可检索特定产品提交的特定发货标签的数据。

先决条件

如果尚未开始操作,请先完成 Microsoft 硬件 API 的所有先决条件,然后再尝试使用其中任何方法。 在使用这些方法之前,产品和提交必须已存在于你的开发人员中心帐户中。 若要创建或管理产品提交,请参阅管理产品提交中的方法。

请求

此方法具有以下语法。 请参阅以下部分,获取标头和请求正文的使用示例和描述。

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

请求头

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

请求参数

此方法的请求参数为可选项。

名称 Type 描述
includeTargetingInfo boolean 可选。 如果此参数设置为 true,则发货标签会返回发货标签的目标详细信息,例如硬件 ID 和 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"
}

响应正文

有关响应正文的详细信息,请参阅发货标签资源

错误代码

有关错误代码的信息,请参阅错误代码

另请参阅