Criar uma nova etiqueta de remessa
Use esse método na API de Hardware da Microsoft para criar uma nova etiqueta de remessa. Antes de usar isso, verifique se você criou um produto e criou um envio para esse produto. Para obter detalhes, consulte Criar um produto e criar um envio.
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.
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 |
|---|---|
| POST | https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels |
O productID e o submissionID no método representam o envio para o qual a etiqueta de remessa deve ser criada.
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 token> de portador<do formulário. |
| Aceitar | Cadeia de caracteres | 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
O exemplo a seguir demonstra o corpo da solicitação JSON para criar uma nova etiqueta de remessa.
{
"publishingSpecifications": {
"goLiveDate": "2018-02-22T06:50:54.793Z",
"visibleToAccounts": [
27691110,
27691111
],
"isAutoInstallDuringOSUpgrade": true,
"isAutoInstallOnApplicableSystems": false,
"manualAcquisition": false,
"isDisclosureRestricted": false,
"publishToWindows10s": true,
"additionalInfoForMsApproval": {
"microsoftContact": "abc@microsoft.com",
"validationsPerformed": "Validation 1",
"affectedOems": [
"OEM1",
"OEM2"
],
"isRebootRequired": false,
"isCoEngineered": false,
"isForUnreleasedHardware": false,
"hasUiSoftware": false,
"businessJustification": "This is a business justification"
}
},
"targeting": {
"hardwareIds": [
{
"bundleId": "3aba7558-10ca-42db-b1d1-57af5718aea3",
"infId": "foo.inf",
"operatingSystemCode": "WINDOWS_v100_RS3_FULL",
"pnpString": "hid\\vid_dummy256f&pid_dummyc62f"
}
],
"chids": [
{
"chid": "346511cf-ccee-5c6d-8ee9-3c70fc7aae83",
"distributionState": "pendingAdd"
}
],
"restrictedToAudiences": [
"00000000-0000-0000-0000-000000000001",
"00000000-0000-0000-0000-000000000002"
],
"inServicePublishInfo": {
"flooring": "RS1",
"ceiling": "RS3"
}
},
"name": "Shipping Label Name",
"destination": "windowsUpdate"
}
Para obter detalhes sobre os campos na solicitação, consulte Recurso ShippingLabel.
Pontos a serem lembrados ao criar etiquetas de remessa
- Ao publicar em Windows Update (o destino é windowsUpdate), você deve incluir um objeto publishingSpecifications. Para instalações automáticas (isAutoInstallDuringOSUpgrade ou isAutoInstallOnApplicableSystems é true), você deve definir additionalInfoForMsApproval.
- se na etiqueta de remessa isAutoInstallDuringOSUpgrade ou isAutoInstallOnApplicableSystems for true, manualAcquisition deverá ser false e o driver será publicado com "May request user input" definido como false.
- se na etiqueta de remessa isAutoInstallDuringOSUpgrade e isAutoInstallOnApplicableSystems forem false, manualAcquisition deverá ser true e o driver será publicado com "May request user input" definido como true.
- Ao compartilhar com outros parceiros (o destino é outroPartner), você deve incluir o objeto recipientSpecifications .
Preenchendo informações de direcionamento
O objeto de direcionamento contém dados que instruem Windows Update sobre:
Como o driver deve ser direcionado em termos de IDs de hardware.
Se a CHID ou as restrições devem ser aplicadas.
O objeto de ID de hardware deve conter uma combinação válida de ID de pacote, ID PNP, código do sistema operacional e nome INF ao criar uma nova etiqueta de remessa. Baixe o arquivo de metadados do driver (fornecido como um link quando você obtém detalhes de um envio) para obter as combinações permitidas e válidas desses atributos para seu envio. Para obter mais informações, consulte metadados do pacote de driver.
Exemplos de solicitação
O exemplo a seguir demonstra como criar um novo produto.
POST https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/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 criar uma etiqueta de remessa. Detalhes sobre os valores no corpo da resposta aparecem na tabela após o exemplo.
{
"id": 1152921504606997500,
"productId": 14461751976964156,
"submissionId": 1152921504621467600,
"publishingSpecifications": {
"goLiveDate": "2018-02-22T06:50:54.793+00:00",
"visibleToAccounts": [
27691110,
27691111
],
"isAutoInstallDuringOSUpgrade": true,
"isAutoInstallOnApplicableSystems": false,
"isDisclosureRestricted": false,
"publishToWindows10s": true,
"additionalInfoForMsApproval": {
"microsoftContact": "abc@microsoft.com",
"validationsPerformed": "Validation 1",
"affectedOems": [
"OEM1",
"OEM2"
],
"isRebootRequired": false,
"isCoEngineered": false,
"isForUnreleasedHardware": false,
"hasUiSoftware": false,
"businessJustification": "This is a business justification"
},
"manualAcquisition": false
},
"workflowStatus": {
"currentStep": "preProcessShippingLabel",
"state": "notStarted",
"messages": []
},
"links": [
{
"href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606997603",
"rel": "self",
"method": "GET"
},
{
"href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606997603",
"rel": "update_shippinglabel",
"method": "PATCH"
}
],
"name": "Shipping Label Name",
"destination": "windowsUpdate"
}
Corpo da resposta
Para obter detalhes sobre o corpo da resposta, consulte recurso de etiqueta de remessa.
Códigos do Erro
Para obter informações sobre códigos de erro, consulte Códigos de erro.