Obter dados da etiqueta de pedido

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

Use os métodos a seguir nas APIs de Hardware Microsoft para obter dados para o envio de etiquetas de produtos de hardware registrados em sua Conta do Centro de Desenvolvimento de Hardware.

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

Antes de usar esses métodos, o produto e o envio já devem existir em 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 todos os rótulos de envio de um envio	GET	`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	GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/{shippingLabelId}`

Pré-requisitos

Se você ainda não fez isso, conclua todos os Prerequisites para as APIs de Hardware Microsoft antes de tentar usar qualquer um desses métodos.

Recursos de dados

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

Recurso de etiqueta de envio

Esse recurso representa uma etiqueta de remessa criada para um envio do produto que está registrado em 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,
    "blockDuaCreation": false
  },
  "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	long	A ID da etiqueta de remessa
ID do produto	long	A ID do produto privado à qual essa etiqueta de remessa está associada
ID de submissão	long	A ID de envio à qual essa etiqueta de remessa está associada
especificações de publicação	objeto	Consulte o objeto de especificações de publicação para obter mais detalhes
especificações do destinatário	matriz de objetos	Consulte o objeto de especificações do destinatário para obter mais detalhes
direcionamento	objeto	Consulte o objeto de direcionamento para obter mais detalhes
workflowStatus	objeto	Esse objeto ilustra o status do fluxo de trabalho para essa etiqueta de envio. Consulte o objeto de status do fluxo de trabalho da etiqueta de envio para obter mais detalhes
links	matriz de objetos	Para obter mais informações, consulte o objeto link.
name	cadeia	O nome da etiqueta de remessa
destino	cadeia	Indica o destino da etiqueta de remessa. Os valores possíveis são (descrição entre parênteses): anotherPartner (essa etiqueta de envio é para compartilhar o envio com outro parceiro) windowsUpdate (este rótulo de distribuição é para publicação no Windows Update) notSet

Objeto de Especificações de Publicação

Esse objeto representa as especificações de como um objeto será publicado no Windows Update. Esse objeto estará disponível/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"
  }
}