Support Sapo

Tổng đài hỗ trợ - 
1900 6750
( 7:00 - 22:00 )

api-reference
tai-lieu-api
tai-lieu-nha-phat-trien

Event

Event được tạo ra khi có các thao tác tác động đến một số tài nguyên xác định của Sapo, ví dụ như tạo một bài viết, đặt hàng, giao vận, thêm, sửa, xóa sản phẩm...

Chú ý

Event được trả về bởi API không phải ứng với thời gian thực. Event có thể không có trong kết quả trả về vài giây sau khi có hành động xảy ra. Trong một vài trường hợp, có thể phải mất đến vài phút để Event có thể xuất hiện.

Event được tạo bởi các tài nguyên sau của Sapo:

Article Event

Hành động Thông báo Mô tả
create Thêm mới bài viết: article_url Bài viết đã được tạo.
destroy Xóa bài viết: article_title Bài viết đã bị xóa.
published Xuất bản bài viết: article_url. Bài viết đã được xuất bản.
unpublished Hủy xuất bản bài viết: article_url. Bài viết đã được hủy xuất bản.
update Cập nhật bài viết: article_url. Bài viết đã được cập nhật.

Blog Event

Hành động Thông báo Mô tả
create Thêm mới danh mục bài viết: new_blog_url Danh mục bài viết đã được thêm mới.
destroy Xóa danh mục bài viết: blog_name. Danh mục bài viết đã bị xóa.
update Sửa danh mục bài viết: blog_url. Danh mục bài viết đã được cập nhật.

Collection Event

Hành động Thông báo Mô tả
create Thêm mới danh mục: collection_url Danh mục đã được thêm mới.
destroy Xóa danh mục: collection_name. Danh mục đã được xóa.
published Xuất bản danh mục: collection_url. Danh mục đã được xuất bản.
unpublished Hủy xuất bản danh mục: collection_url. Danh mục đã được ẩn.
update Cập nhật danh mục: collection_url. Danh mục đã được cập nhật.

Comment Event

Hành động Thông báo Mô tả
create Bình luận mới cho: article_url: comment_excerpt Bình luận đã được thêm mới.

Order Event

Có rất nhiều Event sinh ra ứng với Order. Một vài Event được sinh ra bởi chính Order nhưng nhiều Event khác được sinh ra bởi các hành động xảy ra trong quá trình đặt hàng, đóng hay hủy đơn hàng. Order Event có thể được chia vào các loại như sau:

  • Authorization: thành công, thất bại và tạm dừng
  • Capture: thành công, thất bại và tạm dừng
  • Email: dành cho việc xác nhận đơn hàng, vận chuyển và hủy
  • Fulfillment: thành công, thất bại, tạm dừng, hủy, hoàn kho và cập nhật
  • Order: đặt hàng, xác nhận, lưu trữ, bỏ lưu trữ và hủy
  • Refund: thành công, thất bại và tạm dừng
  • Sale: thành công, thất bại và tạm dừng
  • Void: thành công, thất bại và tạm dừng
Hành động Thông báo Mô tả
authorization_failure Thanh toán cần xác nhận money_amount thất bại Thanh toán cần xác nhận thất bại. Số tiền chưa được xác minh để nhận.
authorization_pending Thanh toán cần xác nhận money_amount đang chờ xác nhận. Thanh toán cần xác nhận thất bại. Số tiền chưa được xác minh để nhận.
authorization_success Thanh toán cần xác nhận money_amount thành công Thanh toán cần xác nhận thành công. Số tiền đã được xác minh để nhận.
cancelled Đơn hàng bị hủy bởi shop_staff_name. Lý do bởi reason Đơn hàng đã bị hủy.
capture_failure Xác nhận đã nhận money_amount thất bại Xác nhận nhận tiền thất bại. Tiền chưa được chuyển đến cho chủ Shop.
capture_pending Xác nhận đã nhận money_amount đang chờ xác nhận. Quá trình nhận tiền đang được thực hiện. Số tiền chưa chuyển thành công đến chủ Shop.
capture_success Xác nhận đã nhận money_amount thành công Quá trình nhận tiền thành công.
closed Đơn hàng đã được lưu trữ. Đơn hàng đã được lưu trữ.
confirmed Có một đơn hàng mới: order_number từ customer_name. Đơn hàng mới được xác nhận.
fulfillment_success Giao thành công number_of_line_items sản phẩm cho đơn hàng order_url. Giao thành công number_of_line_items sản phẩm.
mail_sent message_type đã được gửi tới khách hàng. message_type đã được gửi tới khách hàng.
placed Đơn hàng đã được đặt. Đơn hàng đã được đặt.
re_opened Đơn hàng đã được mở lại. Đơn hàng đã được mở lại.
refund_success Hoàn trả thành công money_amount cho đơn hàng order_url. Hoàn trả thành công money_amount.
restock_line_items Hoàn kho number_of_line_items sản phẩm. Hoàn kho number_of_line_items sản phẩm.
sale_failure Nhận money_amount thất bại. Nhận money_amount thất bại.
sale_pending Nhận money_amount đang chờ xác nhận. Nhận money_amount đang chờ xác nhận.
sale_success Nhận money_amount thành công. Nhận money_amount thành công.
update order_number was updated. The order was updated.

Page Event

Hành động Thông báo Mô tả
create Thêm mới trang nội dung: page_url Trang nội dung đã được thêm mới.
destroy Xóa trang nội dung: page_title. Trang nội dung đã bị xóa.
published Xuất bản trang nội dung: page_url. Trang nội dung đã được xuất bản.
unpublished Hủy xuất bản trang nội dung: page_url. Trang nội dung đã được ẩn.
update Cập nhật trang nội dung: page_url. Trang nội dung đã được cập nhật.

Product Event

Hành động Thông báo Mô tả
create Thêm mới sản phẩm: product_url Sản phẩm đã được thêm mới.
destroy product_name was destroyed. The product was deleted.
published Hiện sản phẩm: product_url. Sản phẩm đã được hiển thị.
unpublished Ẩn sản phẩm: product_url. Sản phẩm đã được ẩn.
update Cập nhật sản phẩm: product_url. Sản phẩm đã được cập nhật.

Bạn có thể làm gì với Event?

Sapo API cho phép bạn thực hiện các thao tác sau với tài nguyên Event. Các phiên bản chi tiết hơn của những thao tác này có thể có:

Các thuộc tính của Event

arguments
 
{ "arguments" : "IPod Nano - 8GB" }

Tham chiếu tới một Event cụ thể và nguồn của Event.

 
body
 
{ "body" : "null" }

Chứa thông tin về Event.

 
created_on
 
{ "created_on" : "2015-04-20T08:33:57Z" }

Thời gian Event được tạo. API trả về kết quả theo định dạng chuẩn ISO 8601.

 
id
 
{ "id" : 164748010 }

Số duy nhất định danh Event.

 
description
 
{ "description" : "Received a new order" }

Mô tả của Event

 
path
 
{ "path" : "/admin/orders/406514653/transactions/#1145" }

Một đường dẫn URL đến nguồn của Event (có thể null)

 
message
 
{ "message" : "Received new order" }

Đoạn mô tả thông báo về Event.

 
subject_id
 
{ "subject_id" : 406514653 }

Id của nguồn sinh Event.

 
subject_type
 
{ "subject_type" : "Order" }

Loại của nguồn sinh Event. Nó sẽ là một trong các giá trị sau:

  • Article
  • Blog
  • Collection
  • Comment
  • Order
  • Page
  • Product
  • ApiPermission
 
verb
 
{ "verb" : "confirmed" }

Loại Event diễn ra. Các nguồn khác nhau thì có các loại Event khác nhau.

Endpoints

GET/admin/orders/450789469/events.json
limit

Số lượng kết quả

(mặc định: 50) (tối đa: 250)		 
page

Trang

(mặc định: 1)		 
since_id

Giới hạn kết quả trả về sau một ID xác định

 
created_on_min

Lấy các Event được tạo sau ngày này (định dạng: 2008-12-31 03:00)

 
created_on_max

Lấy các Event được tạo trước ngày này (định dạng: 2008-12-31 03:00)

 
filter

Lấy các Event xác định trong bộ lọc

 
verb

Lấy Event theo loại xác định

 
fields

danh sách các trường trong kết quả trả về, cách nhau bởi dấu phẩy

Lấy một 'page' của Event từ một Order xác định

GET /admin/orders/#{id}/events.json?limit=1&page=2
Xem kết quả
HTTP/1.1 200 OK
{
  "events": [
    {
      "id": 164748010,
      "subject_id": 450789469,
      "created_on": "2008-01-10T06:00:00Z",
      "subject_type": "Order",
      "verb": "confirmed",
      "arguments": [
        "#1001",
        "Bob Norman"
      ],
      "body": null,
      "message": "Received new order <a href=\"\/admin\/orders\/450789469\">#1001<\/a> by Bob Norman",
      "author": "Shopify",
      "description": "Received new order #1001 by Bob Norman",
      "path": "\/admin\/orders\/450789469"
    }
  ]
}

Lấy các Event liên quan đến Product và Order

GET /admin/events.json?filter=Product,Order
Xem kết quả
HTTP/1.1 200 OK
{
  "events": [
    {
      "id": 677313116,
      "subject_id": 921728736,
      "created_on": "2008-01-10T08:00:00Z",
      "subject_type": "Product",
      "verb": "create",
      "arguments": [
        "IPod Touch 8GB"
      ],
      "body": null,
      "message": "created a new product: <a href=\"\/admin\/products\/921728736\">IPod Touch 8GB<\/a>.",
      "author": "Shopify",
      "description": null,
      "path": "\/admin\/products\/921728736"
    },
    {
      "id": 365755215,
      "subject_id": 632910392,
      "created_on": "2008-01-10T07:00:00Z",
      "subject_type": "Product",
      "verb": "create",
      "arguments": [
        "IPod Nano - 8GB"
      ],
      "body": null,
      "message": "created a new product: <a href=\"\/admin\/products\/632910392\">IPod Nano - 8GB<\/a>.",
      "author": "Shopify",
      "description": null,
      "path": "\/admin\/products\/632910392"
    },
    {
      "id": 164748010,
      "subject_id": 450789469,
      "created_on": "2008-01-10T06:00:00Z",
      "subject_type": "Order",
      "verb": "confirmed",
      "arguments": [
        "#1001",
        "Bob Norman"
      ],
      "body": null,
      "message": "Received new order <a href=\"\/admin\/orders\/450789469\">#1001<\/a> by Bob Norman",
      "author": "Shopify",
      "description": "Received new order #1001 by Bob Norman",
      "path": "\/admin\/orders\/450789469"
    }
  ]
}

Lấy các Event từ một Product xác định

GET /admin/products/#{id}/events.json
Xem kết quả
HTTP/1.1 200 OK
{
  "events": [
    {
      "id": 677313116,
      "subject_id": 921728736,
      "created_on": "2008-01-10T08:00:00Z",
      "subject_type": "Product",
      "verb": "create",
      "arguments": [
        "IPod Touch 8GB"
      ],
      "body": null,
      "message": "created a new product: <a href=\"\/admin\/products\/921728736\">IPod Touch 8GB<\/a>.",
      "author": "Shopify",
      "description": null,
      "path": "\/admin\/products\/921728736"
    }
  ]
}

Lấy các Event từ một Order xác định

GET /admin/orders/#{id}/events.json
Xem kết quả
HTTP/1.1 200 OK
{
  "events": [
    {
      "id": 852065041,
      "subject_id": 450789469,
      "created_on": "2008-01-10T09:00:00Z",
      "subject_type": "Order",
      "verb": "placed",
      "arguments": [
      ],
      "body": null,
      "message": "Order was placed",
      "author": "Shopify",
      "description": "Order was placed",
      "path": "\/admin\/orders\/450789469"
    },
    {
      "id": 164748010,
      "subject_id": 450789469,
      "created_on": "2008-01-10T06:00:00Z",
      "subject_type": "Order",
      "verb": "confirmed",
      "arguments": [
        "#1001",
        "Bob Norman"
      ],
      "body": null,
      "message": "Received new order <a href=\"\/admin\/orders\/450789469\">#1001<\/a> by Bob Norman",
      "author": "Shopify",
      "description": "Received new order #1001 by Bob Norman",
      "path": "\/admin\/orders\/450789469"
    },
    {
      "id": 103105390,
      "subject_id": 450789469,
      "created_on": "2008-01-10T05:00:00Z",
      "subject_type": "Order",
      "verb": "authorization_success",
      "arguments": [
        "389404469",
        "210.94",
        "USD"
      ],
      "body": null,
      "message": "Successfully authorized $409.94 USD on the Visa ending in 4242",
      "author": "Shopify",
      "description": "Successfully authorized $409.94 USD on the Visa ending in 4242",
      "path": "\/admin\/orders\/450789469\/transactions\/389404469"
    }
  ]
}

Lấy tất cả Event sau một ID xác định

GET /admin/events.json?since_id=164748010
Xem kết quả
HTTP/1.1 200 OK
{
  "events": [
    {
      "id": 365755215,
      "subject_id": 632910392,
      "created_on": "2008-01-10T07:00:00Z",
      "subject_type": "Product",
      "verb": "create",
      "arguments": [
        "IPod Nano - 8GB"
      ],
      "body": null,
      "message": "created a new product: <a href=\"\/admin\/products\/632910392\">IPod Nano - 8GB<\/a>.",
      "author": "Shopify",
      "description": null,
      "path": "\/admin\/products\/632910392"
    },
    {
      "id": 677313116,
      "subject_id": 921728736,
      "created_on": "2008-01-10T08:00:00Z",
      "subject_type": "Product",
      "verb": "create",
      "arguments": [
        "IPod Touch 8GB"
      ],
      "body": null,
      "message": "created a new product: <a href=\"\/admin\/products\/921728736\">IPod Touch 8GB<\/a>.",
      "author": "Shopify",
      "description": null,
      "path": "\/admin\/products\/921728736"
    }
  ]
}

Chỉ các Event từ Shop được trả về, không bao gồm thông báo từ Sapo Blog.

GET /admin/events.json
Xem kết quả
HTTP/1.1 200 OK
{
  "events": [
    {
      "id": 677313116,
      "subject_id": 921728736,
      "created_on": "2008-01-10T08:00:00Z",
      "subject_type": "Product",
      "verb": "create",
      "arguments": [
        "IPod Touch 8GB"
      ],
      "body": null,
      "message": "created a new product: <a href=\"\/admin\/products\/921728736\">IPod Touch 8GB<\/a>.",
      "author": "Shopify",
      "description": null,
      "path": "\/admin\/products\/921728736"
    },
    {
      "id": 365755215,
      "subject_id": 632910392,
      "created_on": "2008-01-10T07:00:00Z",
      "subject_type": "Product",
      "verb": "create",
      "arguments": [
        "IPod Nano - 8GB"
      ],
      "body": null,
      "message": "created a new product: <a href=\"\/admin\/products\/632910392\">IPod Nano - 8GB<\/a>.",
      "author": "Shopify",
      "description": null,
      "path": "\/admin\/products\/632910392"
    },
    {
      "id": 164748010,
      "subject_id": 450789469,
      "created_on": "2008-01-10T06:00:00Z",
      "subject_type": "Order",
      "verb": "confirmed",
      "arguments": [
        "#1001",
        "Bob Norman"
      ],
      "body": null,
      "message": "Received new order <a href=\"\/admin\/orders\/450789469\">#1001<\/a> by Bob Norman",
      "author": "Shopify",
      "description": "Received new order #1001 by Bob Norman",
      "path": "\/admin\/orders\/450789469"
    }
  ]
}

Chỉ lấy các Event liên quan đến Product đã bị xóa

GET /admin/events.json?filter=Product&verb=destroy
Xem kết quả
HTTP/1.1 200 OK
{
  "events": [
  ]
}

Tham số created_on_min và created_on_max được chuyển sang thời gian theo timezone của Shop.

GET /admin/events.json?created_on_min=2008-01-10 08:00:00
Xem kết quả
HTTP/1.1 200 OK
{
  "events": [
    {
      "id": 677313116,
      "subject_id": 921728736,
      "created_on": "2008-01-10T08:00:00Z",
      "subject_type": "Product",
      "verb": "create",
      "arguments": [
        "IPod Touch 8GB"
      ],
      "body": null,
      "message": "created a new product: <a href=\"\/admin\/products\/921728736\">IPod Touch 8GB<\/a>.",
      "author": "Shopify",
      "description": null,
      "path": "\/admin\/products\/921728736"
    }
  ]
}
GET/admin/events/677313116.json
fields

danh sách các trường trong kết quả trả về, cách nhau bởi dấu phẩy

Hiển thị các trường giống nhau như một danh sách các hành động.

GET /admin/events/#{id}.json
Xem kết quả
HTTP/1.1 200 OK
{
  "event": {
    "id": 677313116,
    "subject_id": 921728736,
    "created_on": "2008-01-10T08:00:00Z",
    "subject_type": "Product",
    "verb": "create",
    "arguments": [
      "IPod Touch 8GB"
    ],
    "body": null,
    "message": "created a new product: <a href=\"\/admin\/products\/921728736\">IPod Touch 8GB<\/a>.",
    "author": "Shopify",
    "description": null,
    "path": "\/admin\/products\/921728736"
  }
}
GET/admin/events/count.json
created_on_min

Tổng số Event được tạo sau ngày này (định dạng: 2008-12-31 03:00)

 
created_on_max

Tổng số Event được tạo trước ngày này (định dạng: 2008-12-31 03:00)

Tổng số Event từ sau một thời gian xác định

GET /admin/events/count.json?created_on_min=2008-01-10 08:00:00
Xem kết quả
HTTP/1.1 200 OK
{
  "count": 1
}

Tổng số tất cả Event

GET /admin/events/count.json
Xem kết quả
HTTP/1.1 200 OK
{
  "count": 3
}

Bài viết trên có hữu ích cho bạn không?

Hữu ích Không hữu ích
Số lượt đánh giá hữu ích: