Atualizar uma etiqueta de remessa
Use esse método na API de Hardware da Microsoft para atualizar uma etiqueta de envio. Antes de usar esse método, verifique se você já criou uma etiqueta de remessa. Para obter mais informações sobre como criar uma etiqueta de remessa, consulte Criar uma nova etiqueta de remessa.
Pré-requisitos
Se você ainda não fez isso, conclua todos os pré-requisitos para as APIs de Hardware da Microsoft antes de usar qualquer um desses métodos.
Solicitação
Esse método tem a seguinte sintaxe. As outras seções neste tópico fornecem exemplos de uso e descrições do cabeçalho e do corpo da solicitação.
| Método | URI da solicitação |
|---|---|
| PATCH | https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels/{shippingLabelId} |
O productID, submissionID e shippingLabelID no método representam o produto, o envio e o rótulo de envio a serem atualizados.
Cabeçalho da solicitação
| parâmetro | Tipo | Descrição |
|---|---|---|
| Autorização | String | Obrigatórios. O token de acesso Microsoft Entra ID no token> de portador<de 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 uma etiqueta de remessa. Somente os seguintes tipos de alterações podem ser feitas em uma etiqueta de remessa:
- Adicionar IDs de hardware
- Remover/expirar IDs de hardware
- Adicionar CHIDs
- Remover CHIDs
- Adicionar público-alvo
- Atualizar/remover público-alvo
- Fornecer justificativa comercial para as alterações
{
"targeting": {
"chids": [
{
"action": "add",
"chid": "812fac65-9c26-473c-b3a9-1eb3803ac22c"
},
{
"action": "remove",
"chid": "aed6336d-0958-444c-89b6-bf471191d6f0"
}
],
"hardwareIds": [
{
"action": "remove",
"bundleId": "a2dfbcd8-1d4a-4885-90a3-2ac8360542da",
"infId": "foo.inf",
"operatingSystemCode": "WINDOWS_v100_X64_RS3_FULL",
"pnpString": "pci\\ven_8086&dev_5a85"
},
{
"action": "add",
"bundleId": "48140805-45a3-4a76-8818-e75c117adba9",
"infId": "foo.inf",
"operatingSystemCode": "WINDOWS_v100_X64_RS3_FULL",
"pnpString": "pci\\ven_8086&dev_5a85"
}
],
"restrictedToAudiences": [
"00000000-0000-0000-0000-000000000000",
"00000000-0000-0000-0000-000000000001"
],
"inServicePublishInfo": {
"flooring": "RS1",
"ceiling": "RS3"
},
"businessJustification": "Business justification for updating shipping label"
}
}
Para obter detalhes sobre os campos na solicitação, consulte Recurso ShippingLabel.
Pontos a serem observados:
Você deve fornecer um valor para a ação ao atualizar CHIDs ou HardwareIDs.
O público-alvo é um campo somente atualização. Fornecer um valor neste campo substitui qualquer valor anterior. Deixar o valor em branco remove o valor anterior.
Para saber como obter uma lista de públicos para sua organização, consulte obter público-alvo.
O objeto 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 atualizar uma etiqueta de remessa. Para obter as combinações válidas e permitidas desses atributos para o envio (pacote), baixe o arquivo de metadados do driver (fornecido como um link) ao obter os detalhes de um envio. Para obter detalhes, consulte Metadados do pacote do driver.
Exemplos de solicitação
O exemplo a seguir demonstra como atualizar uma etiqueta de remessa.
PATCH https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964156/submissions/1152921504621467600/shippingLabels/1152921504606980300 HTTP/1.1
Authorization: Bearer <your access token>
Resposta
A resposta estará vazia com um status HTTP de 204.
Após esta etapa, use o método em Obter uma etiqueta de remessa para obter os detalhes atualizados da etiqueta de remessa.
Códigos do Erro
Para obter mais informações sobre códigos de erro, consulte Códigos de erro.