จัดการรายละเอียดผลิตภัณฑ์ในแค็ตตาล็อกของคุณโดยใช้ API
ผู้ค้าปลีกสามารถจัดการรายละเอียดผลิตภัณฑ์ในแค็ตตาล็อกของตนได้โดยใช้เอนพอยต์ API ที่หลากหลาย API เหล่านี้ช่วยให้คุณ
- อัปเดตสินค้าคงคลัง
- ลบผลิตภัณฑ์จากแค็ตตาล็อก
- ค้นหาข้อมูลที่ละเอียดเกี่ยวกับผลิตภัณฑ์
การอัปเดตสต็อกสินค้า
หากต้องการอัปเดตสต๊อกผลิตภัณฑ์ ให้ซิงค์ผลิตภัณฑ์อีกครั้งด้วย CitrusAd และตั้งค่าสต๊อกเป็นศูนย์ โดยทั่วไปแล้วผู้ขายปลีกจะดำเนินการอัปเดตเหล่านี้เป็นประจำทุกวันเพื่อให้แสดงสิ่งที่เปลี่ยนแปลง เช่น
- อัพเดตชื่อสินค้า
- สถานะสต๊อก หากสต๊อกผลิตภัณฑ์ตั้งไว้เป็นศูนย์ แสดงว่าผลิตภัณฑ์นั้นขายหมดแล้ว อย่างไรก็ตาม สต๊อกผลิตภัณฑ์ใหม่อาจมาถึงในวันถัดไป
ขอพารามิเตอร์
ต่อไปนี้เป็นพารามิเตอร์การสืบค้นและเนื้อหา:
พารามิเตอร์การสืบค้น
วัตถุ | ประเภท | คำอธิบาย |
---|---|---|
ID ทีม | สตริง, ไม่บังคับ | ID ทีมคุณ หาก teamId ไม่ได้ให้มา จะตั้งค่าเริ่มต้นเป็น teamId ระบุไว้ในการรับรองความถูกต้อง |
พารามิเตอร์เนื้อหา
วัตถุ | ประเภท | คำอธิบาย |
---|---|---|
ID แคตตาล็อก | สตริง, จำเป็น | ตัวระบุสำหรับแค็ตตาล็อกที่ผลิตภัณฑ์นั้นอยู่ คุณสามารถได้รับ catalogID จาก Retail Media UI ของ Epsilon หรือจากผู้ค้าปลีก |
GTIN | สตริง, จำเป็น | หมายเลขประจำตัวสินค้าสากล (GTIN) สำหรับผลิตภัณฑ์ |
สินค้าคงคลัง | หมายเลข, ไม่บังคับ | จำนวนสต็อกสําหรับผลิตภัณฑ์ |
ราคา | หมายเลข, ไม่บังคับ | ราคาผลิตภัณฑ์ |
categoryHierarchy | อาร์เรย์สตริง ไม่จําเป็น | ลําดับชั้นของแค็ตตาล็อกที่ผลิตภัณฑ์นั้นอยู่ |
แท็ก | อาร์เรย์สตริง ไม่จําเป็น | แท็กที่เกี่ยวข้องกับผลิตภัณฑ์ |
ตัวกรอง | อาร์เรย์สตริง ไม่จําเป็น | ตัวกรองที่ใช้กับผลิตภัณฑ์ |
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"
]
}
]
}
ลบผลิตภัณฑ์ออกจากแค็ตตาล็อกของคุณ
เมื่อคุณมีผลิตภัณฑ์ในแค็ตตาล็อกแล้ว คุณอาจต้องการลบออกในภายหลัง หากต้องการลบผลิตภัณฑ์ ให้ทำตามขั้นตอนด้านล่าง
ขอพารามิเตอร์
เอนพอยต์ยอมรับหนึ่งรหัสผลิตภัณฑ์ต่อคำขอ ซึ่งโดยทั่วไปคือ GTIN ID ของคุณ หากต้องการลบผลิตภัณฑ์ ให้ร้องขอ DELETE HTTP ดังนี้
DELETE $BASE_URL/v1/catalog-products/<CATALOG_ID>/<PRODUCT_CODE> HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
เวลาในการประมวลผล
การลบผลิตภัณฑ์อาจใช้เวลา 30 นาทีถึงหนึ่งชั่วโมง
สำคัญ
หากผลิตภัณฑ์หมดสต๊อก ให้ตั้งค่าสต๊อกเป็น 0 แทนที่จะลบออก การลบผลิตภัณฑ์ออกจะทำให้ผู้โฆษณาไม่สามารถเลือกผลิตภัณฑ์ในแพลตฟอร์ม CitrusAd ได้ แม้ว่าจะมีผลิตภัณฑ์ในสต๊อก
การจัดการข้อผิดพลาด
หากไม่พบผลิตภัณฑ์ อาจหมายความว่าผลิตภัณฑ์นั้นยังไม่ได้ถูกนำเข้าระบบ CitrusAd
เรียกค้นรายละเอียดสินค้า
คุณอาจจำเป็นต้องดึงข้อมูลปัจจุบันของผลิตภัณฑ์ในแค็ตตาล็อกของคุณในภายหลัง ในการดำเนินการนี้ คุณสามารถส่งคำขอ GET HTTP ได้ดังนี้
GET $BASE_URL/v1/catalog-products/<CATALOG_ID>/<PRODUCT_CODE> HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
วัตถุ | ประเภท | คำอธิบาย |
---|---|---|
ID แคตตาล็อก | สตริง, จำเป็น | ตัวระบุสำหรับแค็ตตาล็อกที่ผลิตภัณฑ์นั้นอยู่ คุณสามารถได้รับ catalogID จาก Retail Media UI ของ Epsilon หรือจากผู้ค้าปลีก |
รหัสสินค้า | สตริง, จำเป็น | โดยทั่วไปจะเป็นหมายเลขประจำตัวสินค้าสากล (GTIN) ของผลิตภัณฑ์ |
คุณควรได้รับข้อมูลปัจจุบันที่นำเข้ามาในระบบ CitrusAd สำหรับรหัสผลิตภัณฑ์ที่ระบุ
หมายเหตุ
การอัปเดตผลิตภัณฑ์จะไม่ได้รับการดำเนินการทันทีในระบบ CitrusAd โดยอาจต้องใช้เวลาสักระยะหนึ่งเพื่อให้ CitrusAd รวบรวมข้อมูลและแสดงข้อมูลอัปเดตได้ครบถ้วน อย่ากังวลหากข้อมูลผลิตภัณฑ์ไม่ได้รับการอัปเดตทันทีเมื่อเรียกค้น
ที่อัปเดต 4 เดือนที่แล้ว