Method: orders.patch

Perbarui Pesanan dari 3p menjadi AOG. Menampilkan INVALID_ARGUMENT jika ID pesanan kosong atau tidak sama dengan pesanan yang ada.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
orderUpdate.order.merchantOrderId

string

Wajib: ID pesanan internal yang ditetapkan penjual. ID ini harus unik, dan diperlukan untuk operasi pembaruan pesanan berikutnya. ID ini dapat ditetapkan ke googleOrderId yang diberikan, atau nilai unik lainnya. Perhatikan bahwa ID yang ditampilkan kepada pengguna adalah userVisibleOrderId, yang mungkin merupakan nilai yang berbeda dan lebih mudah digunakan. Panjang maksimum yang diizinkan adalah 64 karakter.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi 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
  }
}
Kolom
header

object (OrderRequestHeader)

Header untuk permintaan pesanan pembaruan.

orderUpdate.type
(deprecated)

enum (Type)

Tidak digunakan lagi: Sebagai gantinya, gunakan OrderUpdate.update_mask. Jika jenis = SNAPSHOT, OrderUpdate.order harus merupakan seluruh pesanan. Jika jenis = ORDER_STATUS, ini adalah perubahan status tingkat pesanan. Hanya order.last_update_time dan status vertical ini yang diambil. Catatan: type.ORDER_STATUS hanya mendukung pembaruan status PurcahaseOrderExtension dan tidak ada rencana untuk memperpanjang dukungan ini. Sebagai gantinya, kami merekomendasikan penggunaan updateMask karena lebih umum, dapat diperluas, dan dapat digunakan untuk semua vertical.

orderUpdate.order.googleOrderId

string

ID pesanan yang ditetapkan Google.

orderUpdate.order.userVisibleOrderId

string

ID yang ditampilkan kepada pengguna yang merujuk ke pesanan saat ini. ID ini harus konsisten dengan ID yang ditampilkan untuk pesanan ini dalam konteks lain, termasuk situs, aplikasi, dan email.

orderUpdate.order.userVisibleStateLabel
(deprecated)

string

Tidak digunakan lagi: Gunakan status OrderExtensions sebagai gantinya. Label yang terlihat oleh pengguna untuk status pesanan ini.

orderUpdate.order.buyerInfo

object (UserInfo)

Info tentang pembeli.

orderUpdate.order.image

object (Image)

Gambar yang terkait dengan pesanan.

orderUpdate.order.createTime

string (Timestamp format)

Wajib: Tanggal dan waktu pesanan dibuat.

Stempel waktu dalam format RFC3339 UTC "Zulu", akurat hingga nanodetik. Contoh: "2014-10-02T15:01:23.045123456Z".
orderUpdate.order.lastUpdateTime

string (Timestamp format)

Tanggal dan waktu pesanan terakhir diperbarui. Wajib untuk OrderUpdate.

Stempel waktu dalam format RFC3339 UTC "Zulu", akurat hingga nanodetik. Contoh: "2014-10-02T15:01:23.045123456Z".
orderUpdate.order.transactionMerchant

object (Merchant)

Penjual yang memfasilitasi checkout. Hal ini dapat berbeda dari penyedia tingkat item baris. Contoh: Pesanan Expedia dengan item baris dari ANA.

orderUpdate.order.contents

object (Contents)

Wajib: Konten pesanan yang merupakan grup item baris.

orderUpdate.order.priceAttributes[]

object (PriceAttribute)

Harga, diskon, pajak, dan sebagainya.

orderUpdate.order.followUpActions[]

object (Action)

Tindakan lanjutan di tingkat pesanan.

orderUpdate.order.paymentData

object (PaymentData)

Data terkait pembayaran untuk pesanan.

orderUpdate.order.termsOfServiceUrl

string

Link ke persyaratan layanan yang berlaku untuk pesanan/pesanan yang diusulkan.

orderUpdate.order.note

string

Catatan dilampirkan pada pesanan.

orderUpdate.order.promotions[]

object (Promotion)

Semua promosi yang terkait dengan pesanan ini.

orderUpdate.order.disclosures[]

object (Disclosure)

Pengungkapan yang terkait dengan pesanan ini.

orderUpdate.order.vertical
(deprecated)

object

Tidak digunakan lagi: Gunakan vertical sebagai gantinya. Properti ini akan diterapkan ke semua item baris, kecuali diganti pada beberapa item baris. Vertical ini harus sesuai dengan jenis vertikal tingkat item baris. Nilai yang mungkin: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.
orderUpdate.updateMask

string (FieldMask format)

Catatan: Ada pertimbangan/rekomendasi berikut untuk kolom khusus berikut: 1. order.last_update_time akan selalu diperbarui sebagai bagian dari permintaan pembaruan. 2. order.create_time, order.google_order_id, dan order.merchant_order_id akan diabaikan jika diberikan sebagai bagian dari updateMask.

Daftar dipisahkan koma yang berisi nama-nama kolom yang sepenuhnya valid. Contoh: "user.displayName,photo".
orderUpdate.userNotification

object (UserNotification)

Jika ditentukan, menampilkan notifikasi kepada pengguna dengan judul dan teks yang ditentukan. Menentukan notifikasi adalah saran untuk memberi tahu dan tidak dijamin akan menghasilkan notifikasi.

orderUpdate.reason

string

Alasan perubahan/pembaruan.

Kolom union verticals. Properti ini akan diterapkan ke semua item baris, kecuali diganti pada beberapa item baris. Vertical ini harus sesuai dengan jenis vertikal tingkat item baris. verticals hanya dapat berupa salah satu dari berikut:
orderUpdate.order.purchase

object (PurchaseOrderExtension)

Pesanan pembelian (PO)

orderUpdate.order.ticket

object (TicketOrderExtension)

Pesanan tiket

Isi respons

Jika berhasil, isi respons memuat instance Order.

OrderUpdate

Pembaruan pada pesanan.

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

enum (Type)

Tidak digunakan lagi: Sebagai gantinya, gunakan OrderUpdate.update_mask. Jika jenis = SNAPSHOT, OrderUpdate.order harus merupakan seluruh pesanan. Jika type = ORDER_STATUS, ini adalah perubahan status tingkat pesanan. Hanya order.last_update_time dan status vertikal ini yang diambil. Catatan: type.ORDER_STATUS hanya mendukung pembaruan status PurcahaseOrderExtension dan tidak ada rencana untuk memperluas dukungan ini. Sebagai gantinya, kami merekomendasikan penggunaan updateMask karena lebih umum, dapat diperluas, dan dapat digunakan untuk semua vertical.
order

object (Order)
updateMask

string (FieldMask format)

Catatan: Ada pertimbangan/rekomendasi berikut untuk kolom khusus berikut: 1. order.last_update_time akan selalu diperbarui sebagai bagian dari permintaan pembaruan. 2. order.create_time, order.google_order_id, dan order.merchant_order_id akan diabaikan jika diberikan sebagai bagian dari updateMask.

Daftar dipisahkan koma yang berisi nama-nama kolom yang sepenuhnya valid. Contoh: "user.displayName,photo".
userNotification

object (UserNotification)

Jika ditentukan, menampilkan notifikasi kepada pengguna dengan judul dan teks yang ditentukan. Menentukan notifikasi adalah saran untuk memberi tahu dan tidak dijamin akan menghasilkan notifikasi.

reason

string

Alasan perubahan/pembaruan.

Jenis

Tidak digunakan lagi: Sebagai gantinya, gunakan OrderUpdate.update_mask. Mengizinkan pembaruan pada pesanan.

Enum
TYPE_UNSPECIFIED Jenis tidak ditentukan, tidak boleh menetapkannya secara eksplisit.
ORDER_STATUS Hanya perbarui status pesanan.
SNAPSHOT Perbarui ringkasan pesanan.

UserNotification

Notifikasi pengguna opsional untuk ditampilkan sebagai bagian dari Pembaruan pesanan.

Representasi JSON 
{
  "title": string,
  "text": string
}
Kolom
title

string

Judul untuk notifikasi pengguna. Panjang maksimum yang diizinkan adalah 30 karakter.

text

string

Isi notifikasi. Panjang maksimum yang diizinkan adalah 100 karakter.