Developer Docs

    เริ่มต้น

    Partner API — Auth

    Partner API — Sales

    Partner API — Products

    Partner API — Inventory

    Partner API — Purchasing

    Partner API — Customers

    Partner API — Reports

    Partner API — Webhooks

    อ้างอิง

    List Products

    ดึงรายการสินค้าพร้อม SKU ทั้งหมดของธุรกิจ

    Products เป็นข้อมูลระดับ Business ไม่แยกตามสาขา — ทุก Token ที่มี Scope read:products จะเห็นสินค้าทั้งหมดของธุรกิจ

    Endpoint นี้เหมาะสำหรับ:

    • ซิงค์ข้อมูล Product Catalog เข้าสู่ระบบภายนอก
    • สร้าง Product Master ใน Data Warehouse
    • เชื่อมต่อระบบ e-Commerce หรือ Menu Display
    • อ้างอิง product_sku_id สำหรับ join กับข้อมูล Sales และ Inventory

    Required Scope

    read:products
    

    Access Token ต้องได้รับ Scope read:products มิฉะนั้นระบบจะปฏิเสธคำขอ


    Endpoint

    GET /api/partner/v1/products
    

    Request Headers

    Authorization: Bearer <access_token>
    

    Query Parameters

    ParameterTypeRequiredDescription
    is_activebooleanNoกรองตามสถานะสินค้า — true หรือ false
    category_idstring (UUID)Noกรองตาม Product Category
    qstringNoค้นหาจาก product_name หรือ product_code (1–255 ตัวอักษร)
    limitintegerNoจำนวนรายการต่อหน้า (1–200) ค่าเริ่มต้น 50
    cursorstringNoCursor สำหรับดึงหน้าถัดไป

    Pagination

    Endpoint นี้ใช้ Cursor-based Pagination

    หาก has_more เป็น true ให้ส่ง next_cursor กลับมาใน parameter cursor เพื่อดึงหน้าถัดไป

    GET /api/partner/v1/products?cursor=<next_cursor>
    

    ค่า Cursor เป็น Opaque Value — ไม่ควรอ่าน แก้ไข หรือสร้างเอง


    Example Request

    curl -X GET \
      "https://<host>/api/partner/v1/products?is_active=true&limit=50" \
      -H "Authorization: Bearer <access_token>"
    

    Example Response

    {
      "data": [
        {
          "id": "29b44aa5-a145-422f-a1b6-7a983147c43e",
          "product_code": "สเต-10734",
          "product_name": "สเต๊ะรวม 100 ไม้",
          "product_name_en": "",
          "category_id": "3ea9302b-6470-461f-b8ab-1e0f6bc3abae",
          "unit_id": "7d482fd4-f20a-452c-8177-a704cd05f9a0",
          "is_active": true,
          "track_inventory": false,
          "image_url": "",
          "created_at": "2026-05-24T09:28:07.890Z",
          "updated_at": "2026-05-24T09:28:07.890Z",
          "product_skus": [
            {
              "id": "9ed16e5b-702b-4980-b59c-996d44b732b8",
              "sku_code": "SKU-001",
              "sku_name": "สเต๊ะรวม 100 ไม้",
              "barcode": "",
              "unit_id": null,
              "is_default": true,
              "is_active": true
            }
          ]
        }
      ],
      "pagination": {
        "next_cursor": "...",
        "has_more": true,
        "limit": 50
      }
    }
    

    Product Object

    FieldTypeDescription
    idstring (UUID)Product ID
    product_codestringรหัสสินค้า
    product_namestringชื่อสินค้า (ภาษาหลัก)
    product_name_enstringชื่อสินค้า (ภาษาอังกฤษ)
    category_idstring (UUID) | nullหมวดหมู่สินค้า
    unit_idstring (UUID) | nullหน่วยนับ
    is_activebooleantrue หากสินค้ายังใช้งานอยู่
    track_inventorybooleantrue หากสินค้านี้ติดตาม Stock
    image_urlstringURL รูปภาพสินค้า
    created_atstring (ISO 8601)เวลาที่สร้าง record
    updated_atstring (ISO 8601)เวลาที่แก้ไขล่าสุด
    product_skusProductSku[]รายการ SKU ของสินค้านี้

    track_inventory

    หาก track_inventory เป็น false สินค้านั้นจะไม่ปรากฏในข้อมูล Inventory — ไม่มีการนับ Stock


    ProductSku Object

    FieldTypeDescription
    idstring (UUID)SKU ID — ใช้ join กับ Sales และ Inventory
    sku_codestringรหัส SKU
    sku_namestringชื่อ SKU
    barcodestringBarcode (ถ้ามี)
    unit_idstring (UUID) | nullหน่วยนับของ SKU นี้
    is_defaultbooleantrue หากเป็น SKU หลักของสินค้า
    is_activebooleantrue หาก SKU นี้ยังใช้งานอยู่