Partilhar via


Obter todas as etiquetas de envio

Use esse método na API de Hardware da Microsoft para recuperar dados de todos os rótulos de envio de um envio específico de um produto.

Pré-requisitos

Se você ainda não fez isso, conclua todos os pré-requisitos para as APIs de Hardware da Microsoft antes de tentar usar qualquer um desses métodos. 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 para produtos, consulte os métodos em Gerenciar envios de produtos.

Solicitação

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

Método URI da solicitação
GET https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/

Cabeçalho da solicitação

parâmetro Tipo Descrição
Autorização string Obrigatórios. O token de acesso de ID de Microsoft Entra no formulário Portador *<token>*.
accept string Opcional. Especifica o tipo de conteúdo. O valor permitido é "application/json"

Parâmetros da solicitação

Não forneça parâmetros de solicitação para esse método.

Corpo da solicitação

Não forneça um corpo da solicitação para esse método.

Exemplos de solicitação

O exemplo a seguir demonstra como recuperar informações sobre todos os produtos registrados em sua conta.

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

Resposta

O exemplo a seguir demonstra o corpo da resposta JSON retornado por uma solicitação bem-sucedida para todos os rótulos de envio de um envio específico de um produto registrado em sua conta de desenvolvedor. Para resumir, este exemplo mostra apenas os dados dos três primeiros rótulos de remessa retornados pela solicitação. Detalhes sobre os valores no corpo da resposta aparecem na tabela seguindo o exemplo.

{
  "value": [
    {
      "id": 1152921504606980300,
      "productId": 14461751976964156,
      "submissionId": 1152921504621467600,
      "publishingSpecifications": {
        "goLiveDate": "2018-04-04T16:11:27.2965057+00:00",
        "visibleToAccounts": [],
        "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"
        }
      },
      "workflowStatus": {
        "currentStep": "microsoftApproval",
        "state": "started",
        "messages": []
      },
      "links": [
        {
          "href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606980231",
          "rel": "self",
          "method": "GET"
        },
        {
          "href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606980231",
          "rel": "update_shippinglabel",
          "method": "PATCH"
        }
      ],
      "name": "Publish to Windows Update with promotions",
      "destination": "windowsUpdate"
    },
    {
      "id": 1152921504606978500,
      "productId": 14461751976964156,
      "submissionId": 1152921504621467600,
      "recipientSpecifications": {
        "receiverPublisherId": "27691110",
        "enforceChidTargeting": false
      },
      "workflowStatus": {
        "currentStep": "finalizeSharing",
        "state": "completed",
        "messages": []
      },
      "links": [
        {
          "href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606978460",
          "rel": "self",
          "method": "GET"
        },
        {
          "href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606978460",
          "rel": "update_shippinglabel",
          "method": "PATCH"
        }
      ],
      "name": "Share submission with another Partner",
      "destination": "anotherPartner"
    },
    {
      "id": 1152921504606978500,
      "productId": 14461751976964156,
      "submissionId": 1152921504621467600,
      "publishingSpecifications": {
        "goLiveDate": "2018-04-03T04:50:52.2293001+00:00",
        "visibleToAccounts": [],
        "isAutoInstallDuringOSUpgrade": false,
        "isAutoInstallOnApplicableSystems": false,
        "isDisclosureRestricted": false,
        "publishToWindows10s": false
      },
      "workflowStatus": {
        "currentStep": "finalizePublishing",
        "state": "completed",
        "messages": []
      },
      "links": [
        {
          "href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606978538",
          "rel": "self",
          "method": "GET"
        },
        {
          "href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606978538",
          "rel": "update_shippinglabel",
          "method": "PATCH"
        }
      ],
      "name": "Publish to Windows Update without promotions",
      "destination": "windowsUpdate"
    }
  ],
  "links": [
    {
      "href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products?pageSize=50",
      "rel": "self",
      "method": "GET"
    }
  ]
}

Esse recurso tem os seguintes valores

Valor Tipo Descrição
value array Uma matriz de objetos que contêm informações sobre cada etiqueta de envio. Para obter mais informações sobre os dados em cada objeto, consulte Envio de recurso de rótulo.
links array Uma matriz de objetos com links úteis sobre a entidade que contém. Consulte Objeto Link para obter mais detalhes.

Códigos do Erro

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

Confira também