Method: orders.patch

Zaktualizuj zamówienie z 3p na AOG. Zwraca wartość INVALID_AR, 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ć unikalny i wymagany przy kolejnych operacjach aktualizacji zamówienia. Ten identyfikator może być ustawiony na podany identyfikator googleOrderId lub dowolną inną unikalną wartość. Pamiętaj, że identyfikator przedstawiany 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)

Wycofane: użyj elementu OrderUpdate.update_mask. Jeśli typ ma wartość SNAPSHOT, to polecenie OrderUpdate.order powinno zawierać całość zamówienia. Jeśli typ = ORDER_STATUS, jest to zmiana stanu na poziomie zamówienia. Zarejestrowane zostaną tylko dane order.last_update_time i ten stan w branży. Uwaga: typ.ORDER_STATUS obsługuje tylko aktualizacje stanu PurcahaseOrderExtension. Nie ma planu rozszerzenia tej obsługi. Zamiast tego zalecamy użycie updateMask, ponieważ jest to bardziej ogólne, uniwersalne rozwiązanie, które może być używane we wszystkich branżach.

orderUpdate.order.googleOrderId

string

Identyfikator zamówienia przypisany przez Google.

orderUpdate.order.userVisibleOrderId

string

Identyfikator widoczny dla użytkownika odnoszący się do bieżącego zamówienia. Ten identyfikator powinien być spójny z identyfikatorem wyświetlanym dla tego zamówienia w innych kontekstach, m.in. na stronach internetowych, w aplikacjach i e-mailach.

orderUpdate.order.userVisibleStateLabel
(deprecated)

string

Wycofane: użyj stanu OrderExtensions. Etykieta widoczna dla użytkownika stanu 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. Wymagany w przypadku aktualizacji OrderUpdate.

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ę różnić od danych dostawcy na poziomie elementu zamówienia. Przykład: zamówienie Expedia z elementem zamówienia od ANA.

orderUpdate.order.contents

object (Contents)

Wymagane: zawartość zamówienia będąca grupą elementów zamówienia.

orderUpdate.order.priceAttributes[]

object (PriceAttribute)

Cena, rabaty, podatki itp.

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 dotyczących 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)

Wymagane oświadczenia dotyczące tego zamówienia.

orderUpdate.order.vertical
(deprecated)

object

Wycofane: zamiast tego użyj kategorii. Właściwości te będą mieć zastosowanie do wszystkich elementów zamówienia, chyba że zostaną zastąpione w którymś z nich. Ta branża musi odpowiadać typowi branży 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: w przypadku tych pól specjalnych obowiązują następujące zalecenia/zalecenia: 1. Pole order.last_update_time będzie zawsze aktualizowane w ramach żądania aktualizacji. 2. Jeśli zostaną podane w elemencie updateMask, wartość order.create_time, order.google_order_id oraz order.merchant_order_id będą ignorowane.

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

object (UserNotification)

Jeśli zostanie określony, wyświetli użytkownikowi powiadomienie z podanym tytułem i tekstem. Określenie powiadomienia to sugestia powiadomienia i nie ma gwarancji, że doprowadzi ono do powiadomienia.

orderUpdate.reason

string

Przyczyna zmiany lub aktualizacji.

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

object (PurchaseOrderExtension)

Zamówienie kupna

orderUpdate.order.ticket

object (TicketOrderExtension)

Zamówienie biletów

Treść odpowiedzi

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

OrderUpdate

Zaktualizuj do zamówienia.

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

enum (Type)

Wycofane: użyj elementu OrderUpdate.update_mask. Jeśli typ ma wartość SNAPSHOT, to polecenie OrderUpdate.order powinno zawierać całość zamówienia. Jeśli typ = ORDER_STATUS, jest to zmiana stanu na poziomie zamówienia. Zarejestrowane zostaną tylko dane order.last_update_time i ten stan w branży. Uwaga: typ.ORDER_STATUS obsługuje tylko aktualizacje stanu PurcahaseOrderExtension. Nie ma planu rozszerzenia tej obsługi. Zamiast tego zalecamy użycie updateMask, ponieważ jest to bardziej ogólne, uniwersalne rozwiązanie, które może być używane we wszystkich branżach.
order

object (Order)
updateMask

string (FieldMask format)

Uwaga: w przypadku tych pól specjalnych obowiązują następujące zalecenia: 1. Pole order.last_update_time będzie zawsze aktualizowane w ramach żądania aktualizacji. 2. Jeśli dane są zawarte w elemencie updateMask, wartość order.create_time, order.google_order_id oraz order.merchant_order_id będą ignorowane.

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

object (UserNotification)

Jeśli zostanie określony, wyświetli użytkownikowi powiadomienie z podanym tytułem i tekstem. Określenie powiadomienia to sugestia powiadomienia i nie ma gwarancji, że doprowadzi ono do powiadomienia.

reason

string

Przyczyna zmiany lub aktualizacji.

Typ

Wycofane: użyj elementu OrderUpdate.update_mask. Dozwolone aktualizacje zamówienia.

Wartości w polu enum
TYPE_UNSPECIFIED Typ nieokreślony – nie należy go bezpośrednio ustawiać.
ORDER_STATUS aktualizować tylko stanu zamówienia,
SNAPSHOT Zaktualizuj migawkę 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 dla użytkownika. Maksymalna dozwolona długość to 30 znaków.

text

string

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