Method: orders.patch

Cập nhật đơn đặt hàng từ bên thứ ba thành AOG. Trả về INVALID_ARGUMENT nếu id của đơn đặt hàng trống hoặc không bằng một đơn đặt hàng hiện có.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
orderUpdate.order.merchantOrderId

string

Bắt buộc: Mã đơn đặt hàng nội bộ do người bán chỉ định. Mã nhận dạng này phải là duy nhất và bắt buộc phải có cho các hoạt động cập nhật đơn đặt hàng tiếp theo. Mã này có thể được đặt thành googleOrderId hoặc bất kỳ giá trị duy nhất nào khác mà bạn cung cấp. Xin lưu ý rằng mã nhận dạng mà người dùng nhìn thấy là userVisibleOrderId. Đây có thể là một giá trị khác và thân thiện với người dùng hơn. Độ dài tối đa cho phép là 64 ký tự.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng 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
  }
}
Trường
header

object (OrderRequestHeader)

Tiêu đề của yêu cầu đơn đặt hàng cập nhật.

orderUpdate.type
(deprecated)

enum (Type)

Không dùng nữa: Hãy sử dụng OrderUpdate.update_mask. Nếu type = SNAPSHOT, OrderUpdate.order phải là toàn bộ đơn đặt hàng. Nếu loại = ORDER_STATUS, đây là thay đổi về trạng thái cấp đơn đặt hàng. Chỉ có order.last_update_time và trạng thái dọc này mới được chọn. Lưu ý: type.ORDER_STATUS chỉ hỗ trợ thông tin cập nhật về trạng thái của PurcahaseOrderExtension và không có kế hoạch gia hạn hỗ trợ này. Thay vào đó, bạn nên sử dụng updateMask vì API này có tính tổng quát, dễ mở rộng và có thể dùng cho tất cả các ngành dọc.

orderUpdate.order.googleOrderId

string

Mã đơn hàng được chỉ định của Google.

orderUpdate.order.userVisibleOrderId

string

Mã nhận dạng dành cho người dùng tham chiếu đến đơn đặt hàng hiện tại. Mã nhận dạng này phải nhất quán với mã nhận dạng hiển thị cho đơn đặt hàng này trong các ngữ cảnh khác, bao gồm cả trang web, ứng dụng và email.

orderUpdate.order.userVisibleStateLabel
(deprecated)

string

Không dùng nữa: Thay vào đó, hãy sử dụng trạng thái OrderExtensions. Nhãn hiển thị cho người dùng về trạng thái của đơn đặt hàng này.

orderUpdate.order.buyerInfo

object (UserInfo)

Thông tin về người mua.

orderUpdate.order.image

object (Image)

Hình ảnh liên kết với đơn đặt hàng.

orderUpdate.order.createTime

string (Timestamp format)

Bắt buộc: Ngày và giờ tạo đơn đặt hàng.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, chính xác đến nano giây. Ví dụ: "2014-10-02T15:01:23.045123456Z"

orderUpdate.order.lastUpdateTime

string (Timestamp format)

Ngày và giờ cập nhật đơn đặt hàng lần gần đây nhất. Bắt buộc đối với OrderUpdate.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, chính xác đến nano giây. Ví dụ: "2014-10-02T15:01:23.045123456Z"

orderUpdate.order.transactionMerchant

object (Merchant)

Người bán hỗ trợ thanh toán. Số lượng này có thể khác với nhà cung cấp cấp mục hàng. Ví dụ: Đơn đặt hàng trên Expedia có mục hàng của ANA.

orderUpdate.order.contents

object (Contents)

Bắt buộc: Nội dung đơn đặt hàng là một nhóm các mục hàng.

orderUpdate.order.priceAttributes[]

object (PriceAttribute)

Giá, chiết khấu, thuế, v.v.

orderUpdate.order.followUpActions[]

object (Action)

Hành động nối tiếp ở cấp đơn đặt hàng.

orderUpdate.order.paymentData

object (PaymentData)

Dữ liệu liên quan đến việc thanh toán cho đơn đặt hàng.

orderUpdate.order.termsOfServiceUrl

string

Đường liên kết đến điều khoản dịch vụ áp dụng cho đơn đặt hàng/đơn đặt hàng được đề xuất.

orderUpdate.order.note

string

Ghi chú đính kèm vào đơn đặt hàng.

orderUpdate.order.promotions[]

object (Promotion)

Tất cả chương trình khuyến mãi liên kết với đơn đặt hàng này.

orderUpdate.order.disclosures[]

object (Disclosure)

Thông tin công bố liên quan đến đơn đặt hàng này.

orderUpdate.order.vertical
(deprecated)

object

Không dùng nữa: Sử dụng ngành dọc. Các thuộc tính này sẽ áp dụng cho mọi mục hàng, trừ phi bị ghi đè trong một số mục hàng. Ngành dọc này phải khớp với loại ngành dọc ở cấp mục hàng. Các giá trị có thể có: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

Một đối tượng chứa các trường thuộc một loại tuỳ ý. Trường bổ sung "@type" chứa URI xác định kiểu. Ví dụ: { "id": 1234, "@type": "types.example.com/standard/id" }.

orderUpdate.updateMask

string (FieldMask format)

Lưu ý: Chúng tôi cần cân nhắc/đề xuất những trường đặc biệt sau đây: 1. order.last_update_time sẽ luôn được cập nhật trong yêu cầu cập nhật. 2. order.create_time, order.google_order_id và order.merchant_order_id sẽ bị bỏ qua nếu được cung cấp như một phần của updateMask.

Danh sách các tên đủ điều kiện được phân tách bằng dấu phẩy gồm các tên trường đủ điều kiện. Ví dụ: "user.displayName,photo"

orderUpdate.userNotification

object (UserNotification)

Nếu được chỉ định, hệ thống sẽ hiển thị thông báo cho người dùng kèm theo tiêu đề và nội dung cụ thể. Việc chỉ định thông báo là đề xuất thông báo và không đảm bảo sẽ dẫn đến thông báo.

orderUpdate.reason

string

Lý do thay đổi/cập nhật.

Trường kết hợp verticals. Các thuộc tính này sẽ áp dụng cho mọi mục hàng, trừ phi bị ghi đè trong một số mục hàng. Ngành dọc này phải phù hợp với loại ngành dọc cấp mục hàng. verticals chỉ có thể là một trong những giá trị sau:
orderUpdate.order.purchase

object (PurchaseOrderExtension)

Đơn đặt hàng

orderUpdate.order.ticket

object (TicketOrderExtension)

Đơn đặt vé

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của Order.

OrderUpdate

Cập nhật đơn đặt hàng.

Biểu diễn dưới dạng JSON
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
Trường
type
(deprecated)

enum (Type)

Không dùng nữa: Hãy sử dụng OrderUpdate.update_mask. Nếu loại = SNAPSHOT, OrderUpdate.order phải là toàn bộ đơn đặt hàng. Nếu loại = ORDER_STATUS, đây là thay đổi về trạng thái cấp đơn đặt hàng. Chỉ có order.last_update_time và trạng thái dọc này mới được chọn. Lưu ý: type.ORDER_STATUS chỉ hỗ trợ thông tin cập nhật về trạng thái của PurcahaseOrderExtension và không có kế hoạch gia hạn hỗ trợ này. Thay vào đó, bạn nên sử dụng updateMask vì lớp này mang tính chung hơn, có thể mở rộng và có thể dùng cho tất cả ngành dọc.

order

object (Order)

updateMask

string (FieldMask format)

Lưu ý: Chúng tôi cần cân nhắc/đề xuất những trường đặc biệt sau đây: 1. order.last_update_time sẽ luôn được cập nhật trong yêu cầu cập nhật. 2. order.create_time, order.google_order_id và order.merchant_order_id sẽ bị bỏ qua nếu được cung cấp như một phần của updateMask.

Danh sách các tên đủ điều kiện được phân tách bằng dấu phẩy gồm các tên trường đủ điều kiện. Ví dụ: "user.displayName,photo"

userNotification

object (UserNotification)

Nếu được chỉ định, hệ thống sẽ hiển thị thông báo cho người dùng kèm theo tiêu đề và nội dung cụ thể. Việc chỉ định thông báo là đề xuất thông báo và không đảm bảo sẽ dẫn đến thông báo.

reason

string

Lý do thay đổi/cập nhật.

Loại

Không dùng nữa: Thay vào đó, hãy sử dụng OrderUpdate.update_mask. Cho phép cập nhật đơn đặt hàng.

Enum
TYPE_UNSPECIFIED Loại chưa xác định, không nên đặt tuỳ chọn này một cách rõ ràng.
ORDER_STATUS Chỉ cập nhật trạng thái của đơn đặt hàng.
SNAPSHOT Cập nhật ảnh chụp nhanh đơn đặt hàng.

UserNotification

Thông báo không bắt buộc dành cho người dùng để hiển thị trong quá trình cập nhật Đơn đặt hàng.

Biểu diễn dưới dạng JSON
{
  "title": string,
  "text": string
}
Trường
title

string

Tiêu đề của thông báo cho người dùng. Độ dài tối đa cho phép là 30 ký tự.

text

string

Nội dung của thông báo. Độ dài tối đa cho phép là 100 ký tự.