Một Collect là một đối tượng kết nối một sản phẩm (Product) với một danh mục sản phẩm (Collection)
Với mỗi sản phẩm trong danh mục sản phẩm thường, luôn tồn tại một Collect chứa thông tin id của cả sản phẩm và danh mục đó. Một sản phẩm có thể thuộc một hay nhiều danh mục và sẽ có nhiều hơn một Collect kết nối sản phẩm với mỗi danh mục. Không giống như nhiều tài nguyên khác của Sapo, Collect trong suốt đối với chủ shop, chúng là những đối tượng dùng cho việc quản lý mối quan hệ giữa sản phẩm và danh mục sản phẩm thường.
Reminder
Collect chỉ để xác định sản phẩm trong danh mục sản phẩm thường; Danh mục sản phẩm thông minh sử dụng luật để xác định sản phẩm thuộc chúng. Tạo một Collect kết nối sản phẩm với một danh mục sản phẩm thông minh sẽ dẫn đến lỗi 422 .
Bạn có thể làm gì với Collect?
Sapo API cho phép bạn thực hiện các thao tác sau với tài nguyên Collect. 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 Collect
collection_id |
{ "collection_id" : 841564295 }
Id của danh mục sản phẩm thường chứa sản phẩm. |
created_on |
{ "created_on" : "null" }
Thời gian Collect được tạo. API trả về kết quả theo định dạng chuẩn ISO 8601. |
featured |
Xác định xem Collect có nổi bật hay không. Giá trị hợp lệ là "true" hoặc "false". |
id |
Số duy nhất định danh Collect. |
position |
Số xác định vị trí được sắp xếp bằng tay của sản phẩm trong danh mục sản phẩm thường. Vị trí đầu tiên là 1. Giá trị này chỉ được dùng khi danh mục sản phẩm thường được xem theo kiểu sắp xếp bằng tay. |
product_id |
{ "product_id" : 632910392 }
Số duy nhất định danh sản phẩm trong danh mục sản phẩm thường. |
modified_on |
{ "modified_on" : "null" }
Thời gian Collect được cập nhật lần cuối. API trả về giá trị theo định dạng chuẩn ISO 8601. |
Endpoints
POST/admin/collects.json
Thêm một sản phẩm vào danh mục
Cố gắng tạo một Collect mà không có ID của sản phẩm hay danh mục sẽ trả về lỗi
POST /admin/collects.json
{
"collect": {
"body": "foobar"
}
}Xem kết quả
HTTP/1.1 422 Unprocessable Entity
{
"errors": {
"collection_id": [
"is not exist"
],
"product_id": [
"is not exist"
]
}
}
Tạo một liên kết giữa sản phẩm với danh mục
POST /admin/collects.json
{
"collect": {
"product_id": 921728736,
"collection_id": 841564295
}
}Xem kết quả
HTTP/1.1 201 Created
{
"collect": {
"id": 1071559575,
"collection_id": 841564295,
"product_id": 921728736,
"featured": false,
"created_on": "2015-09-02T14:47:56Z",
"modified_on": "2015-09-02T14:47:56Z",
"position": 2
}
}
DELETE/admin/collects/841564295.json
Xóa một sản phẩm khỏi danh mục
Hủy liên kết giữa sản phẩm với danh mục
HTTP/1.1 404
{
"error": "Not Found"
}
GET/admin/collects.json
Liệt kê tất cả các Collect hoặc những Collect ứng với các sản phẩm, danh mục xác định
page |
Số trang (mặc định: 1) |
limit |
Số bản ghi trên trang (mặc định: 50) (tối đa: 250) |
fields |
danh sách các trường trong kết quả trả về, cách nhau bởi dấu phẩy |
Liệt kê tất cả các Collect của shop
HTTP/1.1 200 OK
{
"collects": [
{
"id": 395646240,
"collection_id": 395646240,
"product_id": 632910392,
"featured": false,
"created_on": null,
"modified_on": null,
"position": 1
},
{
"id": 841564295,
"collection_id": 841564295,
"product_id": 632910392,
"featured": false,
"created_on": null,
"modified_on": null,
"position": 1
}
]
}
Liệt kê các Collect của sản phẩm xác định
GET /admin/collects.json?product_id=632910392
Xem kết quả
HTTP/1.1 200 OK
{
"collects": [
{
"id": 395646240,
"collection_id": 395646240,
"product_id": 632910392,
"featured": false,
"created_on": null,
"modified_on": null,
"position": 1
},
{
"id": 841564295,
"collection_id": 841564295,
"product_id": 632910392,
"featured": false,
"created_on": null,
"modified_on": null,
"position": 1
}
]
}
Liệt kê tất cả các Collect của một danh mục xác định
GET /admin/collects.json?collection_id=841564295
Xem kết quả
HTTP/1.1 200 OK
{
"collects": [
{
"id": 1071559574,
"collection_id": 841564295,
"product_id": 921728736,
"featured": false,
"created_on": "2015-09-02T14:47:55Z",
"modified_on": "2015-09-02T14:47:55Z",
"position": 1
},
{
"id": 841564295,
"collection_id": 841564295,
"product_id": 632910392,
"featured": false,
"created_on": null,
"modified_on": null,
"position": 2
}
]
}
GET/admin/collects/count.json
Lấy tổng số tất cả các Collect hoặc những Collect của các sản phẩm hay danh mục sản phẩm cụ thể
Đếm số Collect của một danh mục xác định
GET /admin/collects/count.json?collection_id=841564295
Xem kết quả
HTTP/1.1 200 OK
{
"count": 1
}
Đếm số Collect của một sản phẩm xác định
GET /admin/collects/count.json?product_id=632910392
Xem kết quả
HTTP/1.1 200 OK
{
"count": 2
}
Đếm tất cả các Collect của shop
HTTP/1.1 200 OK
{
"count": 2
}
GET/admin/collects/841564295.json
Lấy về một Collect với Id xác định hoặc bằng Id của sản phẩm và danh mục
fields |
Danh sách tất cả các trường trong kết quả trả về, cách nhau bởi dấu phẩy |
Trả về một Collect với Id xác định
HTTP/1.1 200 OK
{
"collect": {
"id": 841564295,
"collection_id": 841564295,
"product_id": 632910392,
"featured": false,
"created_on": null,
"modified_on": null,
"position": 1,
}
}
