取得出貨標籤數據

如需 Microsoft 硬體 API 的簡介，包括使用 API 的必要條件，請參閱 使用 API 管理硬體提交。

使用 Microsoft 硬體 API 中的下列方法，取得向 硬體開發人員中心 帳戶註冊的硬體產品標籤送數據。

https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/

您必須先存在於 開發人員中心 帳戶中，才能使用這些方法的產品和提交。 若要建立或管理產品的提交，請參閱管理產品提交中的方法。

必要條件

如果您尚未這麼做，請先完成 Microsoft 硬體 API 的所有 必要條件 ，再嘗試使用上述任何方法。

數據資源

取得出貨標籤數據的 Microsoft 硬體儀錶板 API 方法會使用下列 JSON 數據資源。

ShippingLabel 資源

此資源代表針對向您的帳戶註冊之產品提交而建立的出貨標籤。

{
  "id": 1152921504606978422,
  "productId": 14461751976964157,
  "submissionId": 1152921504621467613,
  "publishingSpecifications": {
    "goLiveDate": "2018-04-12T05:28:32.721Z",
    "visibleToAccounts": [
      27691110, 27691111
    ],
    "isAutoInstallDuringOSUpgrade": true,
    "isAutoInstallOnApplicableSystems": true,
    "isDisclosureRestricted": false,
    "publishToWindows10s": false,
    "additionalInfoForMsApproval": {
      "microsoftContact": "abc@microsoft.com",
      "validationsPerformed": "Validation 1",
      "affectedOems": [
        "OEM1", "OEM2"
      ],
      "isRebootRequired": false,
      "isCoEngineered": true,
      "isForUnreleasedHardware": true,
      "hasUiSoftware": false,
      "businessJustification": "This is a business justification"
    }
  },
  "recipientSpecifications": {
    "receiverPublisherId": "27691110",
    "enforceChidTargeting": true
  },
  "targeting": {
    "hardwareIds": [
      {
        "bundleId": "amd64",
        "infId": "foo.inf",
        "operatingSystemCode": "WINDOWS_v100_SERVER_X64_RS5_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": "finalizePublishing",
    "state": "completed",
    "messages": [],
    "errorReport": ""
  },
  "links": [
    {
      "href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606978422",
      "rel": "self",
      "method": "GET"
    }
  ],
  "name": "Shipping Label Name",
  "destination": "windowsUpdate"
}

此資源具有下列值：

發佈規格物件

這個物件代表如何將對象發佈至 Windows Update 的規格。 只有在出貨標籤的目的地為 windowsUpdate 時，才能使用/需要此物件

{
  "goLiveDate": "2018-04-12T05:28:32.721Z",
  "visibleToAccounts": [
    27691110,
    27691111
  ],
  "isAutoInstallDuringOSUpgrade": true,
  "isAutoInstallOnApplicableSystems": true,
  "isDisclosureRestricted": false,
  "publishToWindows10s": false,
  "additionalInfoForMsApproval": {
    "microsoftContact": "abc@microsoft.com",
    "validationsPerformed": "Validation 1",
    "affectedOems": [
      "OEM1",
      "OEM2"
    ],
    "isRebootRequired": false,
    "isCoEngineered": true,
    "isForUnreleasedHardware": true,
    "hasUiSoftware": false,
    "businessJustification": "This is a business justification"
  }
}

此物件具有下列值

Microsoft 物件的其他資訊

此物件代表 Microsoft 需要檢閱出貨標籤的一些額外資訊。 只有當出貨標籤的目的地是 windowsUpdate，而且出貨標籤示為 isAutoInstallDuringOSUpgrade 或 isAutoInstallOnApplicableSystems 時，才會提供/需要此物件。

{
    "microsoftContact": "abc@microsoft.com",
    "validationsPerformed": "Validation 1",
    "affectedOems": [
      "OEM1",
      "OEM2"
    ],
    "isRebootRequired": false,
    "isCoEngineered": true,
    "isForUnreleasedHardware": true,
    "hasUiSoftware": false,
    "businessJustification": "This is a business justification"
}

此物件具有下列值

收件者規格物件

此物件代表與另一個合作夥伴共用提交的詳細數據和條件。 只有當出貨標籤的目的地是另一個Partner時，才能使用/需要這個物件。

{
	"receiverPublisherId": "27691110",
	"enforceChidTargeting": false
}

此物件具有下列值

目標物件

此物件代表發行至 Windows Update 時所需的出貨標籤目標詳細數據。

{
  "hardwareIds": [
    {
      "bundleId": "amd64",
      "infId": "foo.inf",
      "operatingSystemCode": "WINDOWS_v100_SERVER_X64_RS5_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
  }
}

此物件具有下列值

硬體識別元物件

此物件代表必須以出貨標籤為目標的硬體識別碼詳細數據。 如需詳細資訊，請參閱硬體標識符。

{
	"bundleId": "amd64",
	"infId": "foo.inf",
	"operatingSystemCode": "WINDOWS_v100_SERVER_X64_RS5_FULL",
	"pnpString": "hid\\vid_dummy256f&pid_dummyc62f",
	"distributionState": "pendingAdd"
}

此物件具有下列值

硬體標識元對象應該包含套件組合標識碼、PNP 識別碼、OS Code 和 INF 名稱的有效組合，同時建立新的出貨捲標。 若要取得提交（套件）這些屬性的允許/有效組合，您可以在取得提交的詳細數據時下載驅動程式元數據檔案，以連結的形式提供。 如需詳細資訊， 請參閱驅動程式套件元數據。

CHIDs 物件

此物件代表必須以出貨標籤為目標的 CHID （電腦硬體識別碼）。 如需 詳細資訊， 請參閱使用 CHID。

{
	"chid": "346511cf-ccee-5c6d-8ee9-3c70fc7aae83",
	"distributionState": "pendingAdd"
}

此物件具有下列值

在 Service Publish Information 物件中

這個物件代表由地板和天花板定義的分佈範圍。 樓層描述驅動程式將散發至的最早 Windows 版本，而上限會標示為最新版本。 藉由新增地板和天花板，您可以限制司機的分佈。

{
  "flooring": "RS1",
  "ceiling": "RS3",

}

此物件具有下列值

如需這些值的詳細資訊，請參閱 限制 Windows 版本的驅動程式散發。

共同工程驅動程式發佈信息物件

這個物件代表在開發較新版本和未發行之 Windows 驅動程式時，由地板和天花板定義的分佈範圍。 此物件僅適用於 Microsoft 共同工程合作夥伴。 樓層描述驅動程式將散發至的最早 Windows 版本，而上限會標示為最新版本。 藉由新增地板和天花板，您可以限制司機的分佈。

{
  "flooringBuildNumber": 17135,
  "ceilingBuildNumber": 17139
}

此物件具有下列值

如需詳細資訊，請參閱 限制 Windows 版本的驅動程式散發。

運送標籤工作流程狀態物件

這個物件代表指定實體的工作流程狀態。

{
      "currentStep": "Created",
      "state": "completed",
      "messages": []
    }

此物件具有下列值

錯誤碼

如需錯誤碼的相關信息，請參閱 錯誤碼。

另請參閱

• 硬體儀錶板 API 範例 （GitHub）