Partilhar via

Obter uma etiqueta de envio

Use este método para recuperar dados para uma etiqueta de envio específica de um envio específico de um produto.

Pré-requisitos

Caso ainda não o tenha feito, conclua todos os Pré-requisitos para as APIs de Hardware da Microsoft antes de tentar utilizar qualquer um desses métodos. Antes de poder usar esses métodos, o produto e o envio já devem existir na sua conta do Centro de Desenvolvimento. Para criar ou gerenciar envios de produtos, consulte os métodos em Gerenciar envios de produtos.

Solicitação

Este método tem a seguinte sintaxe. Consulte as seções a seguir para obter exemplos de uso e descrições do cabeçalho e do corpo da solicitação.

Método Solicitar URI
GET https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/{shippingLabelId}

Cabeçalho da solicitação

Cabeçalho Tipo Descrição
autorização corda Obrigatório. O token de acesso do Microsoft Entra ID na forma Bearer *<token>*.
aceitar corda Opcional. Especifica o tipo de conteúdo. O valor permitido é "application/json"

Parâmetros de solicitação

Os parâmetros de solicitação são opcionais para esse método.

Nome Tipo Descrição
incluirInformaçõesDeSegmentação Booleano Opcional. Se esse parâmetro for definido como true, a etiqueta de remessa retornará os detalhes de direcionamento da etiqueta de remessa, como IDs de hardware e CHIDs. Para obter mais informações, consulte objeto de segmentação.

Corpo de solicitação

Não forneça um conteúdo de solicitação para este método.

Exemplos de solicitações

O exemplo a seguir demonstra como recuperar informações sobre um produto específico registrado em sua conta.

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

Resposta

O exemplo a seguir demonstra o corpo de resposta JSON retornado por uma solicitação bem-sucedida para uma etiqueta de remessa específica. Os detalhes sobre os valores no corpo da resposta aparecem na tabela a seguir ao exemplo.

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

Corpo da resposta

Para obter detalhes sobre o corpo da resposta, consulte recurso ShippingLabel.

Códigos de erro

Para obter informações sobre códigos de erro, consulte Códigos de erro.

Ver também

  • Last updated on