Obter dados da etiqueta de pedido

Artigo
02/26/2024

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 etiquetas de pedido 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á deve 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 todas as etiquetas de pedido de um envio	GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/`
Obter dados para uma etiqueta de pedido 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 tiver feito isso, preencha todos os pré-requisitos para as APIs de hardware da Microsoft antes de tentar usar 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 pedido usam os seguintes recursos de dados JSON.

Recurso ShippingLabel

Este recurso representa uma etiqueta de pedido criada para o 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 possui os seguintes valores:

Valor	Type	Descrição
ID	longo	O ID da etiqueta de pedido
productId	longo	O ID do produto privado ao qual esta etiqueta de pedido está associada
submissionId	longo	O ID de envio ao qual esta etiqueta de pedido está associada
publishingSpecifications	objeto	Consulte o objeto de especificações de publicação para obter mais detalhes
recipientSpecifications	matriz de objetos	Consulte o objeto de especificações de destinatário para obter mais detalhes
targeting	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 pedido. Consulte o objeto de status do fluxo de trabalho da etiqueta de pedido para obter mais detalhes
links	matriz de objetos	Para obter mais informações, consulte o objeto de link.
nome	string	O nome da etiqueta de pedido
destino	string	Indica o destino da etiqueta de pedido. Os valores possíveis são (descrições entre parênteses): anotherPartner (esta etiqueta de pedido destina-se ao compartilhamento do envio com outro parceiro) windowsUpdate (esta etiqueta de envio destina-se à publicação no Windows Update) notSet

Objeto Especificações de Publicação

Esse 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 pedido 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"
  }
}