Get a shipping label

Article
06/08/2022

Use this method to retrieve data for a specific shipping label of a specific submission of a product.

Prerequisites

If you have not done so already, complete all the Prerequisites for the Microsoft Hardware APIs before trying to use any of these methods. Before you can use these methods, the product and submission must already exist in your Dev Center account. To create or manage submissions for products, see the methods in Manage product submissions.

Request

This method has the following syntax. See the following sections for usage examples and descriptions of the header and request body.

Method	Request URI
GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/{shippingLabelId}`

Request header

Header	Type	Description
authorization	string	Required. The Microsoft Entra ID access token in the form Bearer <token>.
accept	string	Optional. Specifies the type of content. Allowed value is “application/json”

Request parameters

Request parameters are optional for this method.

Name	Type	Description
includeTargetingInfo	boolean	Optional. If this parameter is set to true, the shipping label returns the targeting details of the shipping label, like hardware IDs and CHIDs. For more info, see Targeting object.

Request body

Do not provide a request body for this method.

Request examples

The following example demonstrates how to retrieve information about a specific product registered to your account.

GET https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964156/submissions/1152921504621467600/shippingLabels/1152921504606980300 HTTP/1.1
Authorization: Bearer <your access token>

Response

The following example demonstrates the JSON response body returned by a successful request for a specific shipping label. Details about the values in the response body appear in the table following the example.

{
  "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"
}

Response body

For details about the response body, see ShippingLabel resource.

Error codes

For info about error codes, see Error codes.

Share via