Udostępnij przez

Aktualizowanie etykiety wysyłkowej

Użyj tej metody w interfejsie API sprzętu firmy Microsoft , aby zaktualizować etykietę wysyłkową. Przed użyciem tej metody upewnij się, że utworzono już etykietę wysyłkową. Aby uzyskać więcej informacji na temat tworzenia etykiety wysyłkowej, zobacz Tworzenie nowej etykiety wysyłkowej.

Wymagania wstępne

Jeśli jeszcze tego nie zrobiono, przed użyciem dowolnej z tych metod należy spełnić wszystkie wymagania wstępne dotyczące interfejsów API sprzętu firmy Microsoft.

Żądanie

Ta metoda ma następującą składnię. Inne sekcje w tym temacie zawierają przykłady użycia i opisy nagłówka i treści żądania.

Metoda Żądanie URI
Poprawka https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels/{shippingLabelId}

Identyfikator produktu, identyfikator przesyłania i identyfikator wysyłkiLabelID w metodzie reprezentują produkt, przesłanie i etykietę wysyłkową do zaktualizowania.

Nagłówek żądania

Nagłówek Typ Opis
Autoryzacja Sznurek To jest wymagane. Token dostępu Microsoft Entra ID w postaci Bearer<token>.
Akceptuj Sznurek Opcjonalny. Określa typ zawartości. Dozwolona wartość to "application/json"

Parametry żądania

Nie należy podawać parametrów żądania dla tej metody.

Ciało żądania

W poniższym przykładzie pokazano treść żądania JSON dla etykiety wysyłkowej. Do etykiety wysyłkowej można wprowadzić tylko następujące typy zmian:

  • Dodawanie identyfikatorów sprzętu
  • Usuwanie/wygasanie identyfikatorów sprzętu
  • Dodawanie identyfikatorów CHID
  • Usuwanie identyfikatorów CHID
  • Dodawanie odbiorców
  • Aktualizuj/usuń odbiorców
  • Podaj uzasadnienie biznesowe dla zmian
{
  "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"
  }
}

Aby uzyskać szczegółowe informacje o polach w żądaniu, zobacz element ShippingLabel.

Punkty do notatki:

  • Należy podać wartość dla action przy aktualizowaniu identyfikatorów CHID lub HardwareID.

  • Odbiorca jest polem tylko do aktualizacji. Podanie wartości w tym polu zastępuje dowolną poprzednią wartość. Pozostawienie wartości pustej spowoduje usunięcie poprzedniej wartości.

  • Aby dowiedzieć się, jak uzyskać listę odbiorców w organizacji, zobacz uzyskiwanie odbiorców.

  • Obiekt identyfikatora sprzętu powinien zawierać prawidłową kombinację identyfikatora pakietu, identyfikatora PNP, kodu systemu operacyjnego i nazwy INF podczas aktualizowania etykiety wysyłkowej. Aby uzyskać prawidłowe, dozwolone kombinacje tych atrybutów dla przesyłania (pakietu), pobierz plik metadanych sterownika (podany jako link) po otrzymaniu szczegółów przesłania. Aby uzyskać szczegółowe informacje, zobacz Metadane pakietu sterowników.

Prośba o przykłady

W poniższym przykładzie pokazano, jak zaktualizować etykietę wysyłkową.

PATCH https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964156/submissions/1152921504621467600/shippingLabels/1152921504606980300 HTTP/1.1
Authorization: Bearer <your access token>

Odpowiedź

Odpowiedź będzie pusta ze stanem HTTP 204.

Po wykonaniu tego kroku użyj metody w sekcji Pobierz etykietę wysyłkową , aby uzyskać zaktualizowane szczegóły etykiety wysyłkowej.

Kody błędów

Aby uzyskać więcej informacji na temat kodów błędów, zobacz Kody błędów.

Zobacz też

  • przykłady API panelu sterowania sprzętem (GitHub)
  • Last updated on