การซิงค์ผลิตภัณฑ์มาตรฐาน
เมื่อสร้างแค็ตตาล็อกแล้ว คุณจะสามารถซิงค์ผลิตภัณฑ์กับแค็ตตาล็อก ตัวอย่างด้านล่างสรุปบริบทมาตรฐานในการซิงค์ผลิตภัณฑ์:
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": 50,
"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"
]
}
]
}
หากสำเร็จ อ็อบเจ็กต์ต่อไปนี้จะถูกส่งคืน:
{
"catalogProducts": [
{
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"gtin": "23556578965543",
"inventory": 50,
"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"
],
"groups": [],
"profit": null
}
]
}
ในบริบทนี้ ค่าว่างหรือค่าที่ไม่มีผลสำหรับกลุ่มและกำไรสามารถละเว้นได้
กำลังซิงค์ข้อมูลตำแหน่ง
คุณยังสามารถซิงค์ตัวกรองสำหรับสถานที่ต่างๆ ที่ผลิตภัณฑ์ของคุณอยู่ในร้าน ซึ่งมีประโยชน์สำหรับการเพิ่มประสิทธิภาพระดับร้านค้า/ที่ตั้งของข้อมูลผลิตภัณฑ์ของคุณ
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": 50,
"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","location:123","location:ABC"
]
}
]
}
หากสำเร็จ อ็อบเจ็กต์ต่อไปนี้จะถูกส่งคืน:
{
"catalogProducts": [
{
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"gtin": "23556578965543",
"inventory": 50,
"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",
"location:123",
"location:ABC"
],
"groups": [],
"profit": null
}
]
}
กำลังซิงค์ข้อมูล HFSS
ในการซิงค์ผลิตภัณฑ์ของคุณ คุณจะต้องส่งตัวกรองของ hfss:true หรือ hfss:falseซึ่งช่วยให้ CitrusAd สามารถกรองอินเทอร์เฟซของเราได้อย่างเหมาะสม
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": 50,
"price": "19.99",
"tags": [
"imageurl:https://your.image.host.com/image.jpg","name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL"
],
"filters": [
"hfss:true","category:Health&Beauty","category:Grocery","Brand:Covergirl","Special_Flag:0","location:123","location:ABC"
]
}
]
}
จำเป็นต้องเรียนรู้เพิ่มเติมเกี่ยวกับ HFSS ใช่ไหม
ตรวจสอบสิ่งพิมพ์ของรัฐบาลสหราชอาณาจักรที่นี่: https://www.gov.uk/government/publications/restricting-promotions-of-products-high-in-fat-sugar-or-salt-by-location-and-by-volume-price/restricting-promotions-of-products-high-in-fat-sugar-or-salt-by-location-and-by-volume-price-implementation-guidance
การซิงค์ผลิตภัณฑ์หลายรายการ
หากคุณกำลังซิงค์ผลิตภัณฑ์หลายรายการ คุณสามารถจัดลำดับได้สูงสุด 100 รายการต่อคำขอ
บริบทตัวอย่างสำหรับการซิงค์สองผลิตภัณฑ์มีดังต่อไปนี้:
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": 50,
"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"
],
"profit": "1.50"
},
{
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"gtin": "23556578965738",
"inventory": 26,
"price": "8.50",
"tags": [
"imageurl:https://your.image.host.com/image.jpg",
"name:Kelloggs Froot Loops Breakfast Cereal 500g"
],
"filters": [
"Brand:Kelloggs",
"category:Pantry",
"category:BreakfastFoods",
"category:Cereals",
"Special_Flag:0"
],
"profit": "0.50"
}
]
}
หากสำเร็จ อ็อบเจ็กต์ต่อไปนี้จะถูกส่งคืน:
{
"catalogProducts": [
{
"gtin": "23556578965543",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"price": 19.99,
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"groups": [],
"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"
],
"inventory": 50,
"profit": 1.50,
"tags": [
"Natural",
"Lasting",
"Dry Skin",
"Beige"
]
},
{
"gtin": "23556578965736688",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"price": 8.50,
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"groups": [],
"tags": [
"imageurl:https://your.image.host.com/image.jpg",
"name:Kelloggs Froot Loops Breakfast Cereal 500g"
],
"filters": [
"Brand:Kelloggs",
"category:Pantry",
"category:BreakfastFoods",
"category:Cereals",
"Special_Flag:0"
],
"inventory": 26,
"profit": 0.50,
"tags": [
"Pantry",
"BreakfastFoods",
"Cereals",
"Kelloggs"
]
}
]
}
การอัปเดตสินค้าคงคลังของสินค้า
ในการอัปเดตสินค้าคงคลังของผลิตภัณฑ์ คุณจะต้องซิงค์ผลิตภัณฑ์อีกครั้งกับ CitrusAd ในการซิงค์ของคุณ ตั้งค่าสถานะสินค้าคงคลังของผลิตภัณฑ์เป็น 0มีตัวอย่างระบุไว้ด้านล่าง:
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"
]
}
]
}
การเรียกดูข้อมูลผลิตภัณฑ์
เมื่อคุณมีสินค้าในแค็ตตาล็อกแล้ว คุณอาจต้องการเรียกดูข้อมูลปัจจุบันในภายหลัง
ในการดำเนินการนี้ คุณสามารถทำการร้องขอ GET http พร้อมรูปแบบ URL เป็น v1/catalog-products/catalogId/<PRODUCT_CODE>เอนพอยต์สามารถรับรหัสผลิตภัณฑ์ได้หนึ่งรหัสต่อหนึ่งคำขอ คำขอตัวยึดตำแหน่งระบุไว้ด้านล่าง:
GET $BASE_URL/v1/catalog-products/<CATALOG_ID>/<PRODUCT_CODE> HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
คุณควรได้รับข้อมูลปัจจุบันที่นำเข้ามาในระบบ CitrusAd สำหรับรหัสผลิตภัณฑ์ ตัวอย่างอยู่ด้านล่าง
การพุชการอัปเดตผลิตภัณฑ์ไม่ได้เกิดขึ้นทันทีในระบบ CitrusAd อาจใช้เวลาสักครู่เพื่อให้ CitrusAd นำเข้าการอัปเดตผลิตภัณฑ์โดยสมบูรณ์ อย่ากังวลหากข้อมูลของผลิตภัณฑ์ไม่ได้รับการอัปเดตทันทีเมื่อดึงรายละเอียด
การลบผลิตภัณฑ์
หากต้องการลบผลิตภัณฑ์ออกจากแค็ตตาล็อกของคุณ ให้ส่งคำขอ DELETE HTTP โดยใช้รูปแบบต่อไปนี้เมื่อไม่ต้องการผลิตภัณฑ์อีกต่อไป
ขอพารามิเตอร์
เอนพอยต์ยอมรับหนึ่งรหัสผลิตภัณฑ์ต่อคําขอ ซึ่งโดยทั่วไปจะเป็นรหัส GTIN ของคุณ
DELETE $BASE_URL/v1/catalog-products/<CATALOG_ID>/<PRODUCT_CODE> HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
การลบสินค้าที่มีรหัสผู้ขาย
หากผลิตภัณฑ์มีรหัสผู้ขาย ให้ระบุเป็นพารามิเตอร์แบบสอบถามเมื่อลบผลิตภัณฑ์:
DELETE $BASE_URL/v1/catalog-products/<CATALOG_ID>/<PRODUCT_CODE>?sellerId=abc123> HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
เวลาในการประมวลผล
การลบผลิตภัณฑ์อาจใช้เวลาดำเนินการตั้งแต่ 30 นาทีถึง 1 ชั่วโมง
สำคัญ
หากผลิตภัณฑ์หมดสต๊อก ให้ตั้งค่าสต๊อกเป็น 0 แทนที่จะลบออก การลบผลิตภัณฑ์ออกจะทำให้ผู้โฆษณาไม่สามารถเลือกผลิตภัณฑ์ในแพลตฟอร์ม CitrusAd ได้ แม้ว่าจะมีผลิตภัณฑ์ในสต๊อก
การจัดการข้อผิดพลาด
หากคุณได้รับข้อผิดพลาดที่แจ้งว่า "ไม่พบผลิตภัณฑ์" อาจหมายความว่าผลิตภัณฑ์นั้นยังไม่ได้ถูกนำเข้าระบบ CitrusAd