- Yêu cầu HTTP
- Tham số đường dẫn
- Nội dung yêu cầu
- Nội dung phản hồi
- OrderUpdate
- Loại
- UserNotification
Cập nhật thứ tự từ 3p 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
Tham số | |
---|---|
orderUpdate.order.merchantOrderId |
Bắt buộc: Mã đơn 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 ( |
Trường | ||
---|---|---|
header |
Tiêu đề của yêu cầu đơn đặt hàng cập nhật. |
|
orderUpdate.type |
Không dùng nữa: Thay vào đó, 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ì 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 |
Mã đơn hàng được chỉ định của Google. |
|
orderUpdate.order.userVisibleOrderId |
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 |
Không dùng nữa: Sử dụng trạng thái OrderExtension. Nhãn hiển thị cho người dùng cho trạng thái của đơn đặt hàng này. |
|
orderUpdate.order.buyerInfo |
Thông tin về người mua. |
|
orderUpdate.order.image |
Hình ảnh liên kết với đơn đặt hàng. |
|
orderUpdate.order.createTime |
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ụ: |
|
orderUpdate.order.lastUpdateTime |
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ụ: |
|
orderUpdate.order.transactionMerchant |
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 |
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[] |
Giá, chiết khấu, thuế, v.v. |
|
orderUpdate.order.followUpActions[] |
Hành động nối tiếp ở cấp đơn đặt hàng. |
|
orderUpdate.order.paymentData |
Dữ liệu liên quan đến việc thanh toán cho đơn đặt hàng. |
|
orderUpdate.order.termsOfServiceUrl |
Đườ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 |
Ghi chú đính kèm vào đơn đặt hàng. |
|
orderUpdate.order.promotions[] |
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[] |
Thông tin công bố liên quan đến đơn đặt hàng này. |
|
orderUpdate.order.vertical |
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 phù hợp với loại ngành dọc cấp mục hàng. Các giá trị có thể có: Một đối tượng có chứa các trường thuộc loại tuỳ ý. Trường bổ sung |
|
orderUpdate.updateMask |
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ụ: |
|
orderUpdate.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 |
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 trạng thái sau đây: |
||
orderUpdate.order.purchase |
Đơn đặt hàng |
|
orderUpdate.order.ticket |
Đơ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 ( |
Trường | |
---|---|
type |
Không dùng nữa: Thay vào đó, 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ì 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. |
order |
|
updateMask |
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ụ: |
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 |
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. Được 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 |
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 |
Nội dung của thông báo. Độ dài tối đa cho phép là 100 ký tự. |