建立新的出貨標籤

發行項
12/08/2023

在 Microsoft 硬體 API 中使用此方法來建立新的出貨標籤。使用之前，請確定您已建立產品，並建立該產品的提交。如需詳細資訊，請參閱建立產品並建立提交。

必要條件

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

要求

這個方法的語法如下。請參閱下列各小節了解標頭和要求主體的使用範例和描述。

方法	要求 URI
POST	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels`

方法中的 productID 和 submissionID 代表要為其建立出貨標籤的提交。

要求標頭

標頭	類型	描述
授權	String	必要。 Microsoft Entra識別碼存取權杖格式為Bearer< 權杖 > 。
接受	字串	選擇性。指定內容類型。允許的值為「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 Update (目的地為windowsUpdate) 時，您必須包含publishingSpecifications物件。對於自動安裝 (isAutoInstallDuringOSUpgrade 或 isAutoInstallOnApplicableSystems 為 true) ，您必須設定 additionalInfoForMsApproval。
如果在出貨標籤 中為AutoInstallDuringOSUpgrade 或 isAutoInstallOnApplicableSystems 為 true，則 manualAcquisition 必須為 false，且驅動程式將會以「May request user input」設定為 false 發佈。
如果在出貨標籤 中 isAutoInstallDuringOSUpgrade 和 isAutoInstallOnApplicableSystems 為 false，則 manualAcquisition 必須為 true，且驅動程式將會以設定為 true 的「May request user input」發佈。
與其他合作夥伴共用 (目的地 是 另一個Partner) 時，您必須包含 recipientSpecifications 物件。

填入目標資訊

目標物件包含指示Windows Update的資料：

驅動程式應該如何以硬體識別碼為目標。
是否應套用 CHID 或限制。

建立新的出貨標籤時，硬體識別碼物件應該包含套件組合識別碼、PNP 識別碼、OS 程式碼和 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"
}

回應本文

如需回應本文的詳細資訊，請參閱出貨標籤資源。

錯誤碼

如需錯誤碼的相關資訊，請參閱錯誤碼。

另請參閱

GitHub) (硬體儀表板 API 範例