다음을 통해 공유

새 배송 레이블 만들기

Microsoft Hardware API에서 이 메서드를 사용하여 새 배송 레이블을 만듭니다. 이를 사용하기 전에 제품을 만들고 해당 제품에 대한 제출을 만들도록 합니다. 자세한 내용은 제품 만들기 및 제출 만들기를 참조하세요.

사전 요구 사항

아직 수행하지 않은 경우 이러한 메서드를 사용하기 전에 Microsoft 하드웨어 API에 대한 모든 필수 구성 요소를 완료합니다.

요청

이 메서드에는 다음 구문이 있습니다. 헤더 및 요청 본문의 사용 예제와 설명은 다음 섹션을 참조하세요.

방법 요청 URI
POST https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels

메서드의 productID 및 submissionID는 배송 레이블을 만들 제출을 나타냅니다.

요청 헤더

헤더 형식 Description
권한 부여 문자열 필수 사항입니다. 전달자토큰 형식의 Microsoft Entra ID 액세스 토큰>입니다<.
동의함 String 선택 사항입니다. 콘텐츠 형식을 지정합니다. 허용되는 값은 "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 업데이트 게시할 때(대상은 windowsUpdate임) publishingSpecifications 개체를 포함해야 합니다. 자동 설치(isAutoInstallDuringOSUpgrade 또는 isAutoInstallOnApplicableSystems true)의 경우 additionalInfoForMsApproval을 설정해야 합니다.
  • 배송 레이블 에서 isAutoInstallDuringOSUpgrade 또는 isAutoInstallOnApplicableSystems 가 true이면 manualAcquisition 은 false여야 하며 드라이버는 "사용자 입력을 요청할 수 있음"이 false로 설정된 상태로 게시됩니다.
  • 배송 레이블 에서 isAutoInstallDuringOSUpgrade 및 isAutoInstallOnApplicableSystems 가 false이면 manualAcquisition 은 true여야 하며 드라이버는 "사용자 입력을 요청할 수 있음"이 true로 설정된 상태로 게시됩니다.
  • 다른 파트너와 공유할 때(대상 은 다른Partner임) recipientSpecifications 개체를 포함해야 합니다.

대상 지정 정보 채우기

대상 지정 개체에는 Windows 업데이트 다음 정보를 지시하는 데이터가 포함됩니다.

  • 하드웨어 ID 측면에서 드라이버를 대상으로 지정하는 방법

  • CHID 또는 제한을 적용해야 하는지 여부입니다.

하드웨어 ID 개체는 새 배송 레이블을 만들 때 번들 ID, PNP ID, 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"
}

응답 본문

응답 본문에 대한 자세한 내용은 레이블 리소스 배송을 참조하세요.

오류 코드

오류 코드에 대한 자세한 내용은 오류 코드를 참조하세요.

추가 정보

하드웨어 dashboard API 샘플(GitHub)

  • Last updated on