Method: orders.patch

Aktualizacja zamówienia z 3p na AOG. Zwraca wartość FAILED_ATTRIBUTE, jeśli identyfikator zamówienia jest pusty lub nie jest równy istniejącemu zamówieniu.

Żądanie HTTP

PATCH https://actions.googleapis.com/v3/orders/{orderUpdate.order.merchantOrderId}

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
orderUpdate.order.merchantOrderId

string

Wymagane: wewnętrzny identyfikator zamówienia przypisany przez sprzedawcę. Ten identyfikator musi być niepowtarzalny i jest wymagany przy kolejnych aktualizacjach zamówień. Ten identyfikator może być ustawiony na podany identyfikator googleOrderId lub inną unikalną wartość. Pamiętaj, że identyfikator prezentowany użytkownikom to uservisibleOrderId, który może mieć inną, bardziej przyjazną dla użytkownika wartość. Maksymalna dozwolona długość to 64 znaki.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "header": {
    object (OrderRequestHeader)
  },
  "orderUpdate": {
    "type": enum (Type),
    "order": {
      "googleOrderId": string,
      "userVisibleOrderId": string,
      "userVisibleStateLabel": string,
      "buyerInfo": {
        object (UserInfo)
      },
      "image": {
        object (Image)
      },
      "createTime": string,
      "lastUpdateTime": string,
      "transactionMerchant": {
        object (Merchant)
      },
      "contents": {
        object (Contents)
      },
      "priceAttributes": [
        {
          object (PriceAttribute)
        }
      ],
      "followUpActions": [
        {
          object (Action)
        }
      ],
      "paymentData": {
        object (PaymentData)
      },
      "termsOfServiceUrl": string,
      "note": string,
      "promotions": [
        {
          object (Promotion)
        }
      ],
      "disclosures": [
        {
          object (Disclosure)
        }
      ],
      "vertical": {
        "@type": string,
        field1: ...,
        ...
      },

      // Union field verticals can be only one of the following:
      "purchase": {
        object (PurchaseOrderExtension)
      },
      "ticket": {
        object (TicketOrderExtension)
      }
      // End of list of possible types for union field verticals.
    },
    "updateMask": string,
    "userNotification": {
      object (UserNotification)
    },
    "reason": string
  }
}
Pola
header

object (OrderRequestHeader)

Nagłówek żądania aktualizacji zamówienia.

orderUpdate.type
(deprecated)

enum (Type)

Wycofano: zamiast tego użyj elementu OrderUpdate.update_mask. Jeśli typ to = SNAPSHOT, element OrderUpdate.order powinien zawierać całe zamówienie. Jeśli typ = ORDER_STATUS, jest to zmiana stanu na poziomie zamówienia. Odbierane są tylko zamówienie.last_update_time i ten stan branży. Uwaga: typ.ORDER_STATUS obsługuje tylko aktualizacje stanu PurcahaseOrderExtension i nie ma planu przedłużania tej obsługi. Zamiast tego zalecamy używanie parametru updateMask, ponieważ jest to bardziej ogólne, rozszerzalne i można go używać we wszystkich branżach.

orderUpdate.order.googleOrderId

string

Identyfikator zamówienia przypisany przez Google.

orderUpdate.order.userVisibleOrderId

string

Identyfikator dla użytkownika odnoszący się do bieżącego zamówienia. Ten identyfikator powinien być taki sam jak identyfikator wyświetlany w przypadku tego zamówienia w innych kontekstach, w tym w witrynach, aplikacjach i poczcie e-mail.

orderUpdate.order.userVisibleStateLabel
(deprecated)

string

Wycofano: zamiast tego użyj stanu rozszerzenia Orders. Etykieta widoczna dla użytkownika wskazująca stan tego zamówienia.

orderUpdate.order.buyerInfo

object (UserInfo)

Informacje o kupującym.

orderUpdate.order.image

object (Image)

Obraz powiązany z zamówieniem.

orderUpdate.order.createTime

string (Timestamp format)

Wymagane: data i godzina utworzenia zamówienia.

Znacznik czasu w formacie RFC3339 UTC „Zulu”, z dokładnością do nanosekund. Przykład: "2014-10-02T15:01:23.045123456Z".
orderUpdate.order.lastUpdateTime

string (Timestamp format)

Data i godzina ostatniej aktualizacji zamówienia. Wymagane w przypadku aktualizacji zamówienia.

Znacznik czasu w formacie RFC3339 UTC „Zulu”, z dokładnością do nanosekund. Przykład: "2014-10-02T15:01:23.045123456Z".
orderUpdate.order.transactionMerchant

object (Merchant)

Sprzedawca, który umożliwił dokonanie płatności. Może się to różnić od wartości dostawcy na poziomie elementu zamówienia. Przykład: zamówienie z Expedii z elementem zamówienia z firmy ANA.

orderUpdate.order.contents

object (Contents)

Wymagane: zawartość zamówienia, która stanowi grupę elementów zamówienia.

orderUpdate.order.priceAttributes[]

object (PriceAttribute)

Cena, rabaty, podatki itd.

orderUpdate.order.followUpActions[]

object (Action)

Dalsze działania na poziomie zamówienia.

orderUpdate.order.paymentData

object (PaymentData)

Dane dotyczące płatności za zamówienie.

orderUpdate.order.termsOfServiceUrl

string

Link do warunków korzystania z usługi odnoszących się do zamówienia lub proponowanego zamówienia.

orderUpdate.order.note

string

Uwagi dołączone do zamówienia.

orderUpdate.order.promotions[]

object (Promotion)

Wszystkie promocje powiązane z tym zamówieniem.

orderUpdate.order.disclosures[]

object (Disclosure)

Ujawnianie informacji związane z tym zamówieniem.

orderUpdate.order.vertical
(deprecated)

object

Wycofane: używaj branż. Właściwości te będą stosowane do wszystkich elementów zamówienia, chyba że w którymś z nich zostaną zastąpione. Ta kategoria musi być zgodna z branżą na poziomie elementu zamówienia. Możliwe wartości: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

Obiekt zawierający pola dowolnego typu. Dodatkowe pole "@type" zawiera identyfikator URI identyfikujący typ. Przykład: { "id": 1234, "@type": "types.example.com/standard/id" }.
orderUpdate.updateMask

string (FieldMask format)

Uwaga: istnieją zalecenia/zalecenia dotyczące następujących pól specjalnych: 1. order.last_update_time będzie zawsze aktualizowany w ramach żądania aktualizacji. 2. order.create_time, order.google_order_id i order.merchant_order_id będą ignorowane, jeśli zostaną podane w ramach UpdateMask.

Rozdzielona przecinkami lista w pełni kwalifikowanych nazw pól. Przykład: "user.displayName,photo".
orderUpdate.userNotification

object (UserNotification)

Jeśli została określona, wyświetla użytkownikowi powiadomienie z podanym tytułem i tekstem. Określenie powiadomienia to tylko sugestia powiadomienia, ale nie ma gwarancji, że spowoduje ono wyświetlenie powiadomienia.

orderUpdate.reason

string

Przyczyna zmiany/aktualizacji.

Pole sumy verticals. Właściwości te będą stosowane do wszystkich elementów zamówienia, chyba że w którymś z nich zostaną zastąpione. Ta kategoria musi być zgodna z branżą na poziomie elementu zamówienia. verticals może mieć tylko jedną z tych wartości:
orderUpdate.order.purchase

object (PurchaseOrderExtension)

Zamówienie

orderUpdate.order.ticket

object (TicketOrderExtension)

Zamawianie biletów

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Order.

OrderUpdate

Zaktualizuj zamówienie.

Zapis JSON 
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
Pola
type
(deprecated)

enum (Type)

Wycofano: zamiast tego użyj elementu OrderUpdate.update_mask. Jeśli typ to = SNAPSHOT, element OrderUpdate.order powinien zawierać całe zamówienie. Jeśli typ = ORDER_STATUS, jest to zmiana stanu na poziomie zamówienia. Odbierane są tylko zamówienie.last_update_time i ten stan branży. Uwaga: typ.ORDER_STATUS obsługuje tylko aktualizacje stanu PurcahaseOrderExtension i nie ma planu przedłużania tej obsługi. Zamiast tego zalecamy używanie parametru updateMask, ponieważ jest to bardziej ogólne, rozszerzalne i można go używać we wszystkich branżach.
order

object (Order)
updateMask

string (FieldMask format)

Uwaga: istnieją zalecenia/zalecenia dotyczące następujących pól specjalnych: 1. order.last_update_time będzie zawsze aktualizowany w ramach żądania aktualizacji. 2. order.create_time, order.google_order_id i order.merchant_order_id będą ignorowane, jeśli zostaną podane w ramach UpdateMask.

Rozdzielona przecinkami lista w pełni kwalifikowanych nazw pól. Przykład: "user.displayName,photo".
userNotification

object (UserNotification)

Jeśli została określona, wyświetla użytkownikowi powiadomienie z podanym tytułem i tekstem. Określenie powiadomienia to tylko sugestia powiadomienia, ale nie ma gwarancji, że spowoduje ono wyświetlenie powiadomienia.

reason

string

Przyczyna zmiany/aktualizacji.

Typ

Wycofano: zamiast tego użyj elementu OrderUpdate.update_mask. Zezwolono na aktualizacje zamówienia.

Wartości w polu enum
TYPE_UNSPECIFIED Typ nieokreślony; nie należy go wyraźnie ustawiać.
ORDER_STATUS Aktualizuj tylko stan zamówienia.
SNAPSHOT Aktualizacja migawki zamówienia.

UserNotification

Opcjonalne powiadomienie użytkownika wyświetlane w ramach aktualizacji zamówienia.

Zapis JSON 
{
  "title": string,
  "text": string
}
Pola
title

string

Tytuł powiadomienia użytkownika. Maksymalna dozwolona długość to 30 znaków.

text

string

Treść powiadomienia. Maksymalna dozwolona długość to 100 znaków.