Obter dados da etiqueta de envio

Para obter uma introdução às APIs de hardware da Microsoft, incluindo pré-requisitos para usar a API, consulte Gerenciar envios de hardware usando APIs.

Use os seguintes métodos nas APIs de Hardware da Microsoft para obter dados para enviar etiquetas de produtos de hardware registrados para sua Conta do Centro de Desenvolvimento de Hardware.

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

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.

Descrição	Método	URI
Obter dados para todas as etiquetas de envio de um envio	Obtém	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/`
Obter dados para uma etiqueta de envio específica de um envio	Obtém	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/{shippingLabelId}`

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.

Recursos de dados

Os métodos da API do painel de hardware da Microsoft para obter dados de etiqueta de remessa usam os seguintes recursos de dados JSON.

Recurso ShippingLabel

Este recurso representa uma etiqueta de envio criada para um envio do seu produto que está registado na sua conta.

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

Este recurso tem os seguintes valores:

Valor	Tipo	Descrição
id	longo	O ID da etiqueta de envio
productId	longo	O ID privado do produto ao qual esta etiqueta de envio está associada
ID da submissão	longo	O ID de envio ao qual esta etiqueta de envio está associada
Especificações de Publicação	objeto	Consulte o objeto de especificações de publicação para obter mais detalhes
Especificações do Recipiente	Matriz de objetos	Consulte o objeto de especificações do destinatário para obter mais detalhes
direcionamento	objeto	Consulte o objeto de segmentação para obter mais detalhes
workflowStatus	objeto	Este objeto descreve o status do fluxo de trabalho para essa etiqueta de remessa. Consulte o objeto de status do fluxo de trabalho da etiqueta de remessa para obter mais detalhes
ligações	Matriz de objetos	Para obter mais informações, consulte objeto de link.
nome	corda	O nome da etiqueta de envio
destino	corda	Indica o destino da etiqueta de envio. Os valores possíveis são (descrição entre parênteses): anotherPartner (esta etiqueta de envio destina-se a partilhar a submissão com outro parceiro) windowsUpdate (esta etiqueta de envio destina-se a publicação no Windows Update) não definido

Objeto de Especificações de Publicação

Este objeto representa as especificações de como um objeto será publicado no Windows Update. Este objeto estará disponível/será necessário somente quando o destino da etiqueta de envio for 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"
  }
}