API đối tác
Hướng dẫn

Quản lý chi tiết sản phẩm trong danh mục của bạn bằng API

Các nhà bán lẻ có thể quản lý thông tin chi tiết về sản phẩm trong danh mục của mình bằng nhiều điểm cuối API khác nhau. Các API này cho phép bạn:

  • Cập nhật hàng tồn kho sản phẩm
  • Xóa sản phẩm khỏi danh mục
  • Truy xuất thông tin chi tiết về sản phẩm

Cập nhật hàng tồn kho sản phẩm

Để cập nhật hàng tồn kho của sản phẩm, hãy đồng bộ lại sản phẩm với CitrusAd và đặt giá trị hàng tồn kho về 0. Các nhà bán lẻ thường cập nhật như vậy hằng ngày để phản ánh những thay đổi như:

  • Cập nhật tên sản phẩm
  • Tình trạng hàng tồn kho. Nếu số lượng hàng tồn kho của sản phẩm được đặt thành 0, điều đó có nghĩa là sản phẩm đã bán hết. Tuy nhiên, hàng mới có thể về vào ngày hôm sau.

Yêu cầu Thông số

Sau đây là các thông số truy vấn và nội dung:

Thông số truy vấn

đối tượngtypeMô tả
teamIdchuỗi, tùy chọnID của nhóm của bạn. Nếu một teamId không được cung cấp, nó sẽ mặc định là teamId được chỉ định trong xác thực.

Thông số nội dung

đối tượngtypeMô tả
catalogIdchuỗi, bắt buộcMã nhận dạng cho danh mục chứa sản phẩm. Bạn có thể tải ID catalogue từ giao diện người dùng Retail Media của Epsilon hoặc từ nhà bán lẻ.
gtinchuỗi, bắt buộcMã số thương phẩm toàn cầu (GTIN) cho sản phẩm.
inventorysố, tùy chọnKiểm kê hàng tồn kho của sản phẩm.
giásố, tùy chọnGiá của sản phẩm.
categoryHierarchymảng chuỗi, tùy chọnHệ thống phân cấp các danh mục mà sản phẩm thuộc về.
tagsmảng chuỗi, tùy chọnCác thẻ được liên kết với Sản phẩm.
bộ lọcmảng chuỗi, tùy chọnCác bộ lọc được áp dụng cho sản phẩm.
POST $BASE_URL/v1/catalog-products?teamId=<YOUR_TEAM_ID> HTTP/1.1 
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "catalogProducts": [
        {
            "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
            "gtin": "23556578965543",
            "inventory": 0,
            "price": "19.99",
            "tags": [
                 "imageurl:https://your.image.host.com/image.jpg","name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL"
            ],
            "filters": [
                 "category:Health&Beauty","category:Grocery","Brand:Covergirl","Special_Flag:0"
            ]
        }
    ]
}

Xóa sản phẩm khỏi danh mục của bạn

Khi một sản phẩm nằm trong danh mục, bạn có thể cần xóa sản phẩm đó sau này. Để xóa sản phẩm, hãy làm theo các bước dưới đây.

Yêu cầu Thông số

Điểm cuối chấp nhận một mã sản phẩm cho mỗi yêu cầu, thường là ID GTIN của bạn. Để xóa một sản phẩm, hãy thực hiện yêu cầu DELETE HTTP như sau:

DELETE $BASE_URL/v1/catalog-products/<CATALOG_ID>/<PRODUCT_CODE> HTTP/1.1 
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>

Thời gian xử lý

Có thể mất từ 30 phút đến một giờ để xử lý việc xóa sản phẩm.

📘

Quan trọng

Nếu một sản phẩm hết hàng, hãy đặt số lượng tồn kho của sản phẩm đó về 0 thay vì xóa sản phẩm đó. Việc xóa một sản phẩm sẽ loại bỏ khả năng các nhà quảng cáo chọn sản phẩm đó trên nền tảng CitrusAd, ngay cả khi sản phẩm đó có hàng trở lại.

Khắc phục lỗi

Nếu không tìm thấy sản phẩm, có thể sản phẩm đó chưa được đưa vào hệ thống CitrusAd.

Truy xuất thông tin chi tiết sản phẩm

Bạn có thể cần truy xuất thông tin hiện tại của sản phẩm trong danh mục của mình sau này. Để thực hiện việc này, bạn có thể gửi yêu cầu GET HTTP như sau:

GET $BASE_URL/v1/catalog-products/<CATALOG_ID>/<PRODUCT_CODE> HTTP/1.1 
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
đối tượngtypeMô tả
catalogIdchuỗi, bắt buộcMã nhận dạng cho danh mục chứa sản phẩm. Bạn có thể tải ID catalogue từ giao diện người dùng Retail Media của Epsilon hoặc từ nhà bán lẻ.
Mã sản phẩmchuỗi, bắt buộcĐây thường là Mã số thương phẩm toàn cầu (GTIN) của sản phẩm.

Bạn cần nhận thông tin hiện thời được nhập vào trong hệ thống CitrusAd cho mã sản phẩm được chỉ định.

📘

Ghi chú

Hệ thống CitrusAd không xử lý ngay lập tức các bản cập nhật sản phẩm. Có thể mất một thời gian để CitrusAd tiếp nhận và phản ánh đầy đủ bản cập nhật. Đừng lo lắng nếu thông tin sản phẩm không được cập nhật ngay lập tức khi truy xuất.

Cập nhật 4 tháng trước