API ของคู่ค้า
ข้อมูลอ้างอิง API

การซิงค์ข้อมูลลูกค้าผ่าน API

กำลังส่งข้อมูลลูกค้าไปยัง CitrusAd

ในการส่งข้อมูลลูกค้าไปยัง CitrusAd ให้ใช้คำสั่งที่คล้ายกับคำสั่งด้านล่าง โปรดทราบว่าข้อมูลใน customers ฟิลด์เป็นข้อมูลจำลอง และให้ไว้ที่นี่เพื่อเป็นตัวอย่างเท่านั้น

📘

ทั้งหมด customer ฟิลด์วัตถุเป็นตัวเลือกที่ไม่บังคับ หากคุณผลักดัน customer วัตถุที่ไม่มีค่าฟิลด์ใดๆ id จะถูกสร้างขึ้น ดังนั้นอย่าระบุ id หากคุณกําลังสร้าง customer วัตถุ

ค่าทั้งหมดใน targetingData ฟิลด์เป็นไปตามอำเภอใจและกำหนดค่าได้โดยผู้ค้าปลีก โปรดไปที่หน้าอ้างอิงสำหรับข้อมูลเพิ่มเติม

POST $BASE_URL/v1/customers HTTP/1.1 
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "customers": [
        {
            "id": "i4358f9b-bbb9-49fb-93fe-3ad481ce564",
            "targetingData": {
            "customer_type": "Corporate"
            }
        }
    ]
}

หากสำเร็จ อ็อบเจ็กต์ต่อไปนี้จะถูกส่งคืน:

{
    "customers": [
        {
            "targetingData": {
                "customer_type": "Corporate"
            },
            "gender": "Other",
            "teamId": "9be784a8-22fc-4315-a335-b7d2c2494f0a",
            "postcode": "",
            "suburb": "",
            "id": "i4358f9b-bbb9-49fb-93fe-3ad481ce564",
            "yearOfBirth": 0
        }
    ]
}

การซิงค์ลูกค้าหลายราย

หากคุณกำลังซิงค์ลูกค้าหลายราย คุณสามารถส่งรายการได้สูงสุด 100 รายการเป็นชุดในแต่ละครั้ง จำนวนคำขอที่คุณสามารถทำได้ไม่จำกัด

คำสั่งซื้อเพย์โหลดของลูกค้าเป็นลำดับเดียวกับผลลัพธ์ที่ส่งคืน ทำให้ข้อมูลยังคงสอดคล้องกับการเป็นตัวแทนของลูกค้าที่ผู้ประกอบจะเก็บรักษาไว้ในแบ็กเอนด์

POST $BASE_URL/v1/customers HTTP/1.1 
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "customers": [
        {
            "id": "i4358f9b-bbb9-49fb-93fe-3ad481ce564",
            "targetingData": {
            "customer_type": "Corporate"
            }
        },
        {
            "id": "c7792468-07ea-4cc3-9b1a-975bb43dfa02",
            "targetingData": {
            "customer_type": "Retail"
            }
        }
    ]
}

หากสำเร็จ อ็อบเจ็กต์ต่อไปนี้จะถูกส่งคืน:

{
    "customers": [
        {
            "targetingData": {
                "customer_type": "Corporate"
            },
            "gender": "Other",
            "teamId": "9be784a8-22fc-4315-a335-b7d2c2494f0a",
            "postcode": "",
            "suburb": "",
            "id": "i4358f9b-bbb9-49fb-93fe-3ad481ce564",
            "yearOfBirth": 0
        },
        {
            "targetingData": {
                "customer_type": "Retail"
            },
            "gender": "Other",
            "teamId": "9be784a8-22fc-4315-a335-b7d2c2494f0a",
            "postcode": "",
            "suburb": "",
            "id": "c7792468-07ea-4cc3-9b1a-975bb43dfa02",
            "yearOfBirth": 0
        }
    ]
}

🚧

gender,postcode,suburb,yearOfBirth ฟิลด์

โปรดทราบว่าฟิลด์เหล่านี้จะไม่ได้ใช้อีกต่อไป และเหลือไว้สำหรับการผสานรวมในอดีตเท่านั้น

การนําเข้าข้อมูลลูกค้าจํานวนมาก

เมื่อรวมระบบ เราขอแนะนำให้คุณส่งข้อมูลลูกค้าชุดแรกเป็นไฟล์สำหรับการนำเข้า เนื่องจาก API ยอมรับชุดละ 100 รายการ