การใช้งาน POSPOS Developer API

POSPOS Developer API เป็น RESTful API สำหรับดึงข้อมูลของร้านค้าไปใช้งานในระบบของท่าน ทุก API ตอบกลับในรูปแบบ JSON เอกสารนี้แบ่งเป็นหัวข้อตามกลุ่มข้อมูล โดยแต่ละหัวข้อระบุ API path, พารามิเตอร์ที่ส่งได้ และรูปแบบข้อมูลที่ตอบกลับ

ข้อมูลทั่วไป

การขอ API Key

• แจ้งเจ้าหน้าที่ทาง LINE Official @pospos เพื่อติดต่อสมัครการใช้งาน แล้วเจ้าหน้าที่จะแนะนำขั้นตอนการสมัคร

กรุณาเก็บรักษา API Key เป็นความลับ หากมีการใช้งานเกินเงื่อนไข ระบบจะระงับ API Key ตามเงื่อนไขของแพ็กเกจที่ใช้งาน

รูปแบบการตอบกลับเมื่อเกิดข้อผิดพลาด

{
  "success": 0,
  "message": "The date range between start and end must not exceed 2 days"
}

Buy Document (ใบรับซื้อ)

ใช้ดึงรายการใบรับซื้อสินค้าจากผู้จำหน่าย (Vendor) ของร้าน ตามช่วงวันที่ของเอกสาร

GET /buy-document

GET https://go.pospos.co/developer/api/buy-document

Header

Query Parameters

หมายเหตุ

• ผลลัพธ์รวมเอกสารทุกสถานะ (รวมเอกสารที่ยกเลิก) เรียงจากเอกสารที่สร้างล่าสุดก่อน
• ผลลัพธ์ถูกเก็บในแคช 15 นาที การเรียกด้วยพารามิเตอร์เดิมภายใน 15 นาทีจะได้ผลลัพธ์เดิม ข้อมูลจึงอาจช้ากว่าข้อมูลจริงได้สูงสุด 15 นาที

ตัวอย่างการเรียกใช้งาน

curl --location 'https://go.pospos.co/developer/api/buy-document?page=1&limit=10&start_date=2026-10-21T00:00:00%2B07:00&end_date=2026-10-22T23:59:59%2B07:00' \
--header 'apikey: {YOUR_API_KEY}'

ตัวอย่าง Response

ตัวอย่างนี้แสดงเฉพาะ field หลัก ข้อมูลจริงอาจมี field อื่นเพิ่มเติม

{
  "success": 1,
  "data": [
    {
      "_id": "6ad89fa3a9eb075121a21a59",
      "buy_code": "BUY26100001",
      "buy_date": "2026-10-21T04:18:59.272Z",
      "buy_send_date": "2026-10-21T04:18:59.272Z",
      "buy_status": 3,
      "buy_document_address": "99 ถนนตัวอย่าง แขวงตัวอย่าง เขตตัวอย่าง กรุงเทพมหานคร 10110",
      "buy_receive_address": "99 ถนนตัวอย่าง แขวงตัวอย่าง เขตตัวอย่าง กรุงเทพมหานคร 10110",
      "buy_note": "",
      "buy_order_list": [
        {
          "_id": "5bc59041a1099d01ae3de3b9",
          "code": "0007",
          "name": "น้ำดื่ม 600 มล.",
          "unit": { "_id": "5aaa2ab70fedd20c21891904", "name": "แพ็ก" },
          "stock": 10,
          "cost": 25,
          "cost_discount_price": 10,
          "total_price_exclude_discount": 250,
          "total_price_include_discount": 240,
          "rounding_amount": 0,
          "sum": 240,
          "actual_cost": 24,
          "price": 35,
          "exclude_vat": false,
          "attribute_status": false,
          "sku_list": []
        }
      ],
      "buy_sub_total": 240,
      "buy_trade_discount": 0,
      "buy_grand_total": 240,
      "rounding_amount": 0,
      "buy_tax_percent": 0,
      "buy_product_price_including_vat": false,
      "register_vat": false,
      "buy_commission_type": 1,
      "buy_commission_rate": 0,
      "buy_total_commission": 0,
      "vendor_detail": {
        "_id": "64f0c2a1b5e3a2001234abcd",
        "code": "V0001",
        "company_name": "บริษัท ตัวอย่าง จำกัด",
        "branch": "สำนักงานใหญ่",
        "tax_id": "0105500000000",
        "phonenumber": "021234567",
        "email": "contact@example.com",
        "address": "99 ถนนตัวอย่าง",
        "zipcode": "10110",
        "province": {
          "_id": "5a8ea7c75e843e9239e92354",
          "PROVINCE_NAME_TH": "กรุงเทพมหานคร",
          "PROVINCE_NAME_EN": "Bangkok"
        }
      },
      "vendor_info": {
        "name": "สมศักดิ์ ส่งของ",
        "phonenumber": "0812345678",
        "file_attachment": []
      },
      "buy_responsible_person_detail": {
        "_id": "5b6962bd1853520f428fad17",
        "code": "EMP001",
        "username": "staff@example.com",
        "firstname": "สมชาย",
        "lastname": "ใจดี"
      },
      "buy_order_status_history": [
        { "status": 0, "update_by": "สมชาย ใจดี", "date": "2026-10-21T04:18:59.272Z" },
        { "status": 2, "note": "", "update_by": "สมชาย ใจดี", "date": "2026-10-21T04:19:00.580Z" },
        { "status": 3, "note": "", "update_by": "สมชาย ใจดี", "date": "2026-10-21T04:19:00.627Z" }
      ],
      "currency": {
        "code": "THB",
        "name": "Thai Baht",
        "symbol": "฿",
        "symbol_position": "prefix",
        "decimal_places": 2
      },
      "created_at": "2026-10-21T04:19:00.524Z",
      "updated_at": "2026-10-21T04:19:00.640Z"
    }
  ],
  "total": 1,
  "total_page": 1,
  "sum_buy_grand_total": 240
}

Response Fields

data[] (ใบรับซื้อ)

สถานะเอกสาร (buy_status)

buy_order_list[] (รายการสินค้า)

แต่ละรายการเป็นข้อมูลสินค้า ณ เวลาที่สร้างเอกสาร จึงอาจมี field อื่นของสินค้าติดมาด้วย ให้ใช้ field ตามตารางนี้เป็นหลัก

vendor_detail (ผู้จำหน่าย)

vendor_info (ผู้นำส่งสินค้า)

buy_responsible_person_detail (พนักงานผู้รับผิดชอบ)

buy_order_status_history[] (ประวัติสถานะ)

Member (สมาชิก)

ใช้ดึงข้อมูลสมาชิกของร้าน ทุก API ในหัวข้อนี้ตอบกลับ data เป็น array ของสมาชิก หากไม่พบข้อมูลจะได้ array ว่าง

Header

GET /member

GET https://go.pospos.co/developer/api/member

Query Parameters

หมายเหตุ

• ต้องส่ง page และ limit คู่กัน หากไม่ส่งจะได้สมาชิกทั้งหมดในครั้งเดียว
• ผลลัพธ์ไม่มีจำนวนรายการทั้งหมด (total) ให้เรียกหน้าถัดไปจนกว่า data จะเป็น array ว่าง
• ผลลัพธ์ถูกเก็บในแคช 15 นาที การเรียกด้วยพารามิเตอร์เดิมภายใน 15 นาทีจะได้ผลลัพธ์เดิม ข้อมูลจึงอาจช้ากว่าข้อมูลจริงได้สูงสุด 15 นาที

ตัวอย่างการเรียกใช้งาน

curl --location 'https://go.pospos.co/developer/api/member?page=1&limit=50' \
--header 'apikey: {YOUR_API_KEY}'

GET /member/id/{id}

GET https://go.pospos.co/developer/api/member/id/{id}

Path Parameters

GET /member/code/{code}

GET https://go.pospos.co/developer/api/member/code/{code}

Path Parameters

GET /member/find/phonenumber/{phonenumber}

GET https://go.pospos.co/developer/api/member/find/phonenumber/{phonenumber}

Path Parameters

GET /member/search/{keyword}

GET https://go.pospos.co/developer/api/member/search/{keyword}

Path Parameters

หมายเหตุ

• ตอบกลับทุกรายการที่ตรงกับคำค้น ไม่มีการแบ่งหน้า
• ภาษาไทยต้องเข้ารหัส URL (URL encode) ก่อนส่ง และควรใช้เฉพาะตัวอักษรและตัวเลข เนื่องจากอักขระพิเศษ เช่น ( ) + * ? อาจทำให้ผลการค้นหาไม่ถูกต้อง

ตัวอย่าง Response (ใช้ร่วมกันทุก API ในหัวข้อนี้)

ตัวอย่างนี้แสดงเฉพาะ field หลัก ข้อมูลจริงอาจมี field อื่นเพิ่มเติม

{
  "success": 1,
  "data": [
    {
      "_id": "5e3a49151e4c10724fc1cdcc",
      "code": "M000018",
      "firstname": "สมหญิง",
      "lastname": "ใจดี",
      "nickname": "หญิง",
      "sex": "female",
      "date_of_birth": "1990-05-14T17:00:00.000Z",
      "phonenumber": "0812345678",
      "email": "member@example.com",
      "line_id": "somying",
      "key_card_id": "10001",
      "type": { "_id": "5bd6c8ede1a437580790850f", "name_th": "สมาชิก", "name_en": "member" },
      "tags": [ { "_id": "6aab8a55d1a12b1ee2ad8ab9", "name": "VVIP" } ],
      "favorite": false,
      "point_value": 120,
      "price_level": "0",
      "member_credit_status": true,
      "member_credit": 30,
      "payment_limit": 20000,
      "nationality_type": 1,
      "id_card": "",
      "address_status": true,
      "address": "99 ถนนตัวอย่าง",
      "country": { "_id": "5a8e9be55e843e9239e91b76", "COUNTRY_NAME_TH": "ไทย", "COUNTRY_NAME_EN": "Thailand" },
      "province": { "_id": "5a8ea7c75e843e9239e92354", "PROVINCE_NAME_TH": "กรุงเทพมหานคร", "PROVINCE_NAME_EN": "Bangkok" },
      "district": { "_id": "5a8fbe5e739a6560bf7a1d21", "DISTRICT_NAME_TH": "เขตทวีวัฒนา", "DISTRICT_NAME_EN": "Thawi Watthana" },
      "sub_district": { "_id": "65c3441a663032ccdb8667d7", "SUB_DISTRICT_NAME_TH": "แขวงทวีวัฒนา", "SUB_DISTRICT_NAME_EN": "Thawi Watthana", "ZIP_CODE": "10170" },
      "zipcode": "10170",
      "status": false,
      "storename": "",
      "taxid": "",
      "branch": "00000",
      "created_at": "2026-10-01T03:00:00.000Z",
      "updated_at": "2026-10-20T08:30:00.000Z"
    }
  ]
}

Response Fields

data[] (สมาชิก)

Vendor (ผู้จำหน่าย)

ใช้ดึงรายชื่อผู้จำหน่าย (Vendor) ของร้านแบบแบ่งหน้า

GET /vendor

GET https://go.pospos.co/developer/api/vendor

Header

Query Parameters

หมายเหตุ

• คำค้นภาษาไทยต้องเข้ารหัส URL (URL encode) ก่อนส่ง อักขระพิเศษ เช่น ( ) จะถูกค้นหาตามตัวอักษรนั้นตรงๆ
• ไม่ได้กำหนดการเรียงลำดับ โดยทั่วไปผลลัพธ์จะเรียงตามลำดับที่สร้างผู้จำหน่าย (เก่าไปใหม่)
• ผลลัพธ์ถูกเก็บในแคช 15 นาที การเรียกด้วยพารามิเตอร์เดิมภายใน 15 นาทีจะได้ผลลัพธ์เดิม ข้อมูลจึงอาจช้ากว่าข้อมูลจริงได้สูงสุด 15 นาที

ตัวอย่างการเรียกใช้งาน

curl --location 'https://go.pospos.co/developer/api/vendor?page=1&limit=10&term=V0000' \
--header 'apikey: {YOUR_API_KEY}'

ตัวอย่าง Response

ตัวอย่างนี้เป็นผู้จำหน่ายที่กรอกข้อมูลครบ field ที่ร้านไม่ได้กรอกไว้อาจไม่มีใน Response หรือมีค่าเป็น null และ object ที่อยู่อาจมี field อื่นเพิ่มเติม

{
  "success": 1,
  "data": [
    {
      "_id": "6909ddc457f31a761f645cef",
      "id": "6909ddc457f31a761f645cef",
      "code": "V000005",
      "company_name": "บริษัท ตัวอย่าง จำกัด",
      "branch": "00000",
      "tax_id": "0105500000000",
      "phonenumber": "021234567",
      "company_email": "contact@example.com",
      "company_line": "@example",
      "company_fax": "021234568",
      "address": "99 ถนนตัวอย่าง",
      "country": {
        "_id": "5a8e9be55e843e9239e91b76",
        "COUNTRY_NAME_TH": "ไทย",
        "COUNTRY_NAME_EN": "Thailand",
        "ABBREVIATION": "TH"
      },
      "province": {
        "_id": "5a8ea7c75e843e9239e92354",
        "PROVINCE_NAME_TH": "กรุงเทพมหานคร",
        "PROVINCE_NAME_EN": "Bangkok"
      },
      "district": {
        "_id": "5a8fbe5e739a6560bf7a1d17",
        "DISTRICT_NAME_TH": "เขตบางคอแหลม",
        "DISTRICT_NAME_EN": "Bang Kho Laem"
      },
      "sub_district": {
        "_id": "65c3441a663032ccdb8667ab",
        "SUB_DISTRICT_NAME_TH": "แขวงบางโคล่",
        "SUB_DISTRICT_NAME_EN": "Bang Khlo",
        "ZIP_CODE": "10120"
      },
      "province_other": "",
      "zipcode": "10120",
      "first_name": "สมศักดิ์",
      "last_name": "ส่งของ",
      "email": "somsak@example.com",
      "contact_person_phonenumber": "0812345678",
      "contact_person_line": "somsak",
      "vendor_credit_status": true,
      "vendor_credit": 30,
      "price_level_status": true,
      "price_level_id": "64f0c2a1b5e3a2001234abcd",
      "price_level": {
        "_id": "64f0c2a1b5e3a2001234abcd",
        "name": "ราคาส่ง",
        "index": 1
      }
    }
  ],
  "total": 7,
  "total_page": 1
}

Response Fields

data[] (ผู้จำหน่าย)

Purchase Order (ใบสั่งซื้อ)

ใช้ดึงรายการใบสั่งซื้อสินค้าจากผู้จำหน่าย (Vendor) ของร้าน ตามช่วงวันเวลาที่สร้างเอกสาร

GET /purchase-order

GET https://go.pospos.co/developer/api/purchase-order

Header

Query Parameters

หมายเหตุ

• ช่วงวันที่ใช้กรองจากวันเวลาที่สร้างเอกสาร (create_date) ไม่ใช่วันที่ออกเอกสาร (po_date)
• ผลลัพธ์รวมเอกสารทุกสถานะ (รวมเอกสารที่ยกเลิก) ไม่ได้กำหนดการเรียงลำดับ โดยทั่วไปจะเรียงตามลำดับที่สร้างเอกสาร (เก่าไปใหม่)
• ผลลัพธ์ถูกเก็บในแคช 15 นาที การเรียกด้วยพารามิเตอร์เดิมภายใน 15 นาทีจะได้ผลลัพธ์เดิม ข้อมูลจึงอาจช้ากว่าข้อมูลจริงได้สูงสุด 15 นาที

ตัวอย่างการเรียกใช้งาน

curl --location 'https://go.pospos.co/developer/api/purchase-order?page=1&limit=10&start=2026-10-19T00:00:00%2B07:00&end=2026-10-20T23:59:59%2B07:00' \
--header 'apikey: {YOUR_API_KEY}'

ตัวอย่าง Response

{
  "success": 1,
  "total": 1,
  "total_page": 1,
  "data": [
    {
      "_id": "6ad6e264979747f19fd1252c",
      "po_code": "690006",
      "po_date": "2026-10-20T03:39:11.033Z",
      "po_send_date": "2026-10-25T03:00:00.000Z",
      "po_end_date": null,
      "po_credit": 30,
      "status": 1,
      "payment_status": false,
      "po_document_address": "99 ถนนตัวอย่าง แขวงตัวอย่าง เขตตัวอย่าง กรุงเทพมหานคร 10110",
      "po_receive_address": "99 ถนนตัวอย่าง แขวงตัวอย่าง เขตตัวอย่าง กรุงเทพมหานคร 10110",
      "po_note": null,
      "po_order_list": [
        {
          "_id": "5bc58f89a1099d01ae3de3b3",
          "code": "0001",
          "name": "น้ำดื่ม 600 มล.",
          "image": "product_5bc58f89a1099d01ae3de3b3.jpeg",
          "category": { "_id": "5d6dbddff692072970618223", "name": "เครื่องดื่ม", "sort_index": 1 },
          "unit": { "_id": "5aaa2ab70fedd20c21891904", "name": "แพ็ก" },
          "stock": 10,
          "cost": 10,
          "cost_discount_price": 0,
          "sum": 100,
          "price": 15,
          "discount_type": 1,
          "discount_status": false,
          "sku_list": []
        },
        {
          "_id": "61af1ea7e48af351cb200f9e",
          "code": "0002",
          "name": "กาแฟ 3in1",
          "image": "1641525909534_0209d771cb61411f80290b3df50bc828.jpg",
          "category": { "_id": "5d6dbddff692072970618223", "name": "เครื่องดื่ม", "sort_index": 1 },
          "unit": { "_id": "5aaa2ab70fedd20c21891904", "name": "แพ็ก" },
          "stock": 10,
          "cost": 25.3,
          "cost_discount_price": 0,
          "sum": 253,
          "price": 35,
          "discount_type": 1,
          "discount_status": false,
          "sku_list": []
        }
      ],
      "po_sub_total": 353,
      "po_trade_discount": 0,
      "po_vat": 7,
      "po_grand_total": 377.71,
      "po_product_price_including_vat": false,
      "register_vat": true,
      "po_responsible_person_detail": {
        "firstname": "สมชาย",
        "lastname": "ใจดี"
      },
      "po_order_status_history": [],
      "create_date": "2026-10-20T03:39:16.887Z"
    }
  ]
}

Response Fields

data[] (ใบสั่งซื้อ)

สถานะเอกสาร (status)

po_order_list[] (รายการสินค้า)

แต่ละรายการเป็นข้อมูลสินค้า ณ เวลาที่สร้างเอกสาร

po_order_status_history[] (ประวัติสถานะ)

Category (หมวดหมู่สินค้า)

ใช้ดึงหมวดหมู่สินค้าของร้าน ทุก API ในหัวข้อนี้ตอบกลับ data เป็น array ของหมวดหมู่

Header

GET /category

GET https://go.pospos.co/developer/api/category

ตอบกลับหมวดหมู่สินค้าทั้งหมดของร้าน ไม่รวมหมวดหมู่วัตถุดิบ และไม่รวมหมวดหมู่ท็อปปิ้ง เว้นแต่ส่ง with_topping=true เรียงตามลำดับที่ร้านจัดไว้ (sort_index) หรือตามชื่อ ขึ้นอยู่กับการตั้งค่าการเรียงหมวดหมู่ของร้าน

Query Parameters

หมายเหตุ ผลลัพธ์ถูกเก็บในแคช 15 นาที การเรียกด้วยพารามิเตอร์เดิมภายใน 15 นาทีจะได้ผลลัพธ์เดิม ข้อมูลจึงอาจช้ากว่าข้อมูลจริงได้สูงสุด 15 นาที

GET /category/topping

GET https://go.pospos.co/developer/api/category/topping

ไม่มีพารามิเตอร์ ตอบกลับเฉพาะหมวดหมู่ท็อปปิ้ง (ตัวเลือกเสริมของสินค้า เช่น ขนาด ระดับความหวาน) เรียงแบบเดียวกับ GET /category

หมายเหตุ ผลลัพธ์ถูกเก็บในแคช 15 นาที การเรียกซ้ำภายใน 15 นาทีจะได้ผลลัพธ์เดิม ข้อมูลจึงอาจช้ากว่าข้อมูลจริงได้สูงสุด 15 นาที

GET /category/{id}

GET https://go.pospos.co/developer/api/category/{id}

Path Parameters

หมายเหตุ

• ตอบกลับ data เป็น array 1 รายการ
• หากไม่พบหมวดหมู่ได้ HTTP 404 หมวดหมู่ท็อปปิ้งและหมวดหมู่วัตถุดิบค้นหาด้วย API นี้ไม่ได้
• หาก id ไม่อยู่ในรูปแบบรหัสอ้างอิงได้ HTTP 400

ตัวอย่างการเรียกใช้งาน

curl --location 'https://go.pospos.co/developer/api/category' \
--header 'apikey: {YOUR_API_KEY}'

ตัวอย่าง Response (ใช้ร่วมกันทุก API ในหัวข้อนี้)

{
  "success": 1,
  "data": [
    {
      "_id": "66398f3f5da21856a38c1d93",
      "name": "เครื่องดื่ม",
      "sort_index": 0,
      "type": "normal",
      "color_code": "#FFFFFF",
      "status_topping": false,
      "status_raw_material": false,
      "is_exempt_from_weighting": false
    },
    {
      "_id": "673aae9db80f3f21ccfa579c",
      "name": "กาแฟ",
      "parent_id": "66398f3f5da21856a38c1d93",
      "sort_index": 1,
      "status_topping": false,
      "status_raw_material": false
    }
  ]
}

ตัวอย่างหมวดหมู่ท็อปปิ้งจาก GET /category/topping

{
  "_id": "5f76e5420c78b64f2e9b2619",
  "name": "ขนาด",
  "sort_index": 1,
  "status_topping": true,
  "required_select_topping": true,
  "select_multiple_topping": false,
  "minimum_topping": 1,
  "maximum_topping": 1,
  "status_raw_material": false
}

data[] (หมวดหมู่)

field ที่ร้านไม่ได้ตั้งค่าไว้อาจไม่มีใน Response

ประเภทหมวดหมู่ (type)

Credit (ขายเชื่อ)

ใช้ดึงรายการขายเชื่อ (ค้างชำระ) ของร้าน พร้อมยอดรวมและสถานะการครบกำหนดชำระ

GET /credit

GET https://go.pospos.co/developer/api/credit

Header

Query Parameters

หมายเหตุ

• ระบบนับช่วงวันที่ตามเวลาประเทศไทย ตั้งแต่ 00:00 น. ของ start ถึง 23:59:59 น. ของ end หากใช้ type=custom โดยไม่ส่ง start และ end จะได้รายการของวันนี้
• ไม่รวมรายการที่ยกเลิกแล้ว
• ไม่ได้กำหนดการเรียงลำดับของผลลัพธ์
• ผลลัพธ์ถูกเก็บในแคช 15 นาที การเรียกด้วยพารามิเตอร์เดิมภายใน 15 นาทีจะได้ผลลัพธ์เดิม ข้อมูลจึงอาจช้ากว่าข้อมูลจริงได้สูงสุด 15 นาที

ตัวอย่างการเรียกใช้งาน

curl --location 'https://go.pospos.co/developer/api/credit?page=1&limit=10&status=unpaid&period=OUT_OF_PERIOD' \
--header 'apikey: {YOUR_API_KEY}'

ตัวอย่าง Response

{
  "success": 1,
  "data": [
    {
      "_id": "618e330983469472db251ebd",
      "code": "0016",
      "create": "2026-10-12T09:25:29.160Z",
      "deadline_date": "2026-11-11T09:25:29.160Z",
      "deadline_to_now": 12,
      "in_of_period": true,
      "paid": false,
      "payment_date": "2026-10-12T09:25:29.160Z",
      "cancel": false,
      "create_from": 1,
      "status": 1,
      "member_detail": {
        "_id": "5f1a2b3c4d5e6f7a8b9c0d1e",
        "code": "M000070",
        "firstname": "สมหญิง",
        "lastname": "ใจดี"
      },
      "search_member_name": "สมหญิง ใจดี",
      "transaction": {
        "grand_total": 1500,
        "rounding_amount": 0,
        "installment_status": true,
        "installment_balance": 500,
        "reference_tax_invoice": { "code": "0016" }
      }
    }
  ],
  "total": 287,
  "total_page": 29,
  "sum_grand_total": 183073.93,
  "sum_installment_total": 1315.25,
  "in_of_period_total": 41,
  "out_of_period_total": 246
}

Response Fields

data[] (รายการขายเชื่อ)

Report (รายการขาย)

ใช้ดึงรายการบิลขายของร้าน ตามช่วงวันที่ขาย

GET /transactions

GET https://go.pospos.co/developer/api/transactions

Header

Query Parameters

หมายเหตุ

• ระบบนับช่วงวันที่ตามเวลาประเทศไทย ตั้งแต่ 00:00 น. ของ start ถึง 23:59:59 น. ของ end หากไม่ระบุ start และ end ระบบจะใช้วันปัจจุบัน
• บิลที่ขายก่อนช่วงวันที่ แต่ถูกยกเลิกภายในช่วงวันที่ (ตาม return_date) จะรวมอยู่ในผลลัพธ์ด้วย
• การค้นหาด้วย term ไม่ค้นจากเลขที่บิล (code)
• ไม่ได้กำหนดการเรียงลำดับของผลลัพธ์
• ผลลัพธ์ถูกเก็บในแคช 15 นาที การเรียกด้วยพารามิเตอร์เดิมภายใน 15 นาทีจะได้ผลลัพธ์เดิม ข้อมูลจึงอาจช้ากว่าข้อมูลจริงได้สูงสุด 15 นาที

ตัวอย่างการเรียกใช้งาน

curl --location 'https://go.pospos.co/developer/api/transactions?page=1&limit=200&start=2026-10-27&end=2026-10-28' \
--header 'apikey: {YOUR_API_KEY}'

ตัวอย่าง Response

ตัวอย่างนี้แสดงเฉพาะ field หลัก ข้อมูลจริงอาจมี field อื่นเพิ่มเติม

{
  "success": 1,
  "data": [
    {
      "_id": "6ae1bd9c715ebcf78627f7cf",
      "code": "2495",
      "timestamp": "2026-10-28T09:17:15.633Z",
      "status": "success",
      "return_date": "2026-10-28T09:17:15.634Z",
      "comment": "",
      "order_list": [
        {
          "code": "690499",
          "name": "ชาเขียวมัทฉะลาเต้",
          "stock": 1,
          "price": 200,
          "special_price": 200,
          "discount_type": 1,
          "cost_discount_price": 15,
          "total_price_include_discount": 185,
          "sku_list": [],
          "note_in_order": ["หวานน้อย"]
        },
        {
          "code": "690503",
          "name": "เสื้อยืดคอกลม",
          "stock": 1,
          "price": 500,
          "special_price": 500,
          "discount_type": 2,
          "cost_discount_price": 7,
          "total_price_include_discount": 465,
          "sku_list": [
            {
              "_id": "6ae1b980e53a595ed853aa1a",
              "sku": "690503-0002",
              "options": [
                { "_id": "6ae1b96de53a595ed853aa16", "name": "สีขาว" },
                { "_id": "6ae1b980e53a595ed853aa19", "name": "M" }
              ],
              "stock": 1,
              "price": 500
            }
          ]
        }
      ],
      "number_of_order_list": 2,
      "discount": 50,
      "sub_total": 600,
      "sub_total_exclude_vat": 0,
      "tax_percent": 0,
      "register_vat": false,
      "grand_total": 600,
      "rounding_amount": 0,
      "installment_status": false,
      "segment_type": 1,
      "segment_detail_type": { "pay_type": 1, "price": 600 },
      "segment_detail_type_list": [
        { "pay_type": 1, "price": 600 }
      ],
      "staff_detail": { "firstname": "สมชาย", "lastname": "ใจดี" },
      "actual_staff_detail": { "firstname": "สมชาย", "lastname": "ใจดี" },
      "buyer_detail": {
        "code": "M000045",
        "firstname": "สมหญิง",
        "lastname": "ใจดี",
        "key_card_id": "M000045"
      },
      "cash_register": { "_id": "5e314785b373e70802c0df3c", "name": "เครื่องขาย 1" },
      "reference_tax_invoice_abbreviate": { "code": "2425" },
      "rounding_rule": 0,
      "rounding_rule_value": 1,
      "discount_rounding_rule": 0,
      "discount_rounding_rule_value": 1
    }
  ],
  "total": 18,
  "total_page": 1
}

Response Fields

data[] (บิลขาย)

order_list[] (รายการสินค้า)

installments[] (รายการผ่อนชำระ)

ตัวอย่างเมื่อส่ง include=installments

{
  "installment_status": true,
  "installments": [
    {
      "installment_number": 1,
      "amount_pay": 500,
      "note": "ชำระงวดที่ 1",
      "segment_detail_type": { "pay_type": 1, "price": 500 }
    },
    {
      "installment_number": 2,
      "amount_pay": 1000,
      "note": "ชำระงวดสุดท้าย",
      "segment_detail_type": { "pay_type": 3, "price": 1000 }
    }
  ]
}

ช่องทางชำระเงิน (segment_type, pay_type)

Stock (สินค้าและสต็อก)

ใช้ดึงข้อมูลสินค้าพร้อมจำนวนคงเหลือ ทุก API ในหัวข้อนี้ตอบกลับ data เป็น array

Header

GET /stock/pagination

GET https://go.pospos.co/developer/api/stock/pagination

ตอบกลับสินค้าในหมวดหมู่ที่แสดงในหน้าขายแบบแบ่งหน้า ไม่รวมสินค้าท็อปปิ้งและวัตถุดิบ เรียงตามลำดับสินค้าที่ร้านจัดไว้ พร้อม total และ total_page

Query Parameters

หมายเหตุ

• ผลลัพธ์ถูกเก็บในแคช 15 นาที การเรียกด้วยพารามิเตอร์เดิมภายใน 15 นาทีจะได้ผลลัพธ์เดิม ข้อมูลจึงอาจช้ากว่าข้อมูลจริงได้สูงสุด 15 นาที

GET /stock/{code}

GET https://go.pospos.co/developer/api/stock/{code}

Path Parameters

หมายเหตุ ตอบกลับ data เป็น array 1 รายการ หากไม่พบสินค้าได้ HTTP 400 พร้อมข้อความ "ไม่พบข้อมูลสินค้า"

GET /stock/category/{categoryId}

GET https://go.pospos.co/developer/api/stock/category/{categoryId}

Path Parameters

หมายเหตุ ตอบกลับเฉพาะ _id, code, name, image, category, unit, global_index และ category_index ไม่มีข้อมูลสต็อกและราคา

ตัวอย่างการเรียกใช้งาน

curl --location 'https://go.pospos.co/developer/api/stock/pagination?page=1&limit=50' \
--header 'apikey: {YOUR_API_KEY}'

ตัวอย่าง Response (GET /stock/pagination)

ตัวอย่างนี้แสดงเฉพาะ field หลัก ข้อมูลจริงมี field อื่นของสินค้าเพิ่มเติม GET /stock/{code} ใช้รูปแบบ data เดียวกัน

{
  "success": 1,
  "data": [
    {
      "_id": "684a81ee448a35b1babfdb81",
      "code": "680461",
      "name": "น้ำดื่ม 600 มล.",
      "barcode_code": "8851234567890",
      "image": "1715048255459_92deb944c.jpeg",
      "category": { "_id": "66398f3f5da21856a38c1d93", "name": "เครื่องดื่ม" },
      "unit": { "_id": "5aaa2ab70fedd20c21891904", "name": "ขวด" },
      "price": 15,
      "special_price": 15,
      "cost": 8,
      "stock": 960,
      "min_stock": 5,
      "min_stock_status": false,
      "is_low": false,
      "unlimited_stock": false,
      "exclude_vat": false,
      "attribute_status": false,
      "sku_list": [],
      "status_relation": false,
      "status_kit": false,
      "kit": [],
      "status_serial_number": false,
      "serial_numbers": [],
      "price_levels_status": false,
      "price_levels": [],
      "status_wholesale_price": false,
      "global_index": 1,
      "category_index": 0,
      "delete": false,
      "lastupdate": "2026-10-29T07:11:22.770Z"
    }
  ],
  "total": 751,
  "total_page": 16
}

data[] (สินค้า)

Unit (หน่วยนับ)

ใช้ดึงหน่วยนับสินค้าของร้าน ทุก API ในหัวข้อนี้ตอบกลับ data เป็น array

Header

GET /unit

GET https://go.pospos.co/developer/api/unit

ไม่มีพารามิเตอร์ ตอบกลับหน่วยนับทั้งหมดของร้าน

หมายเหตุ ผลลัพธ์ถูกเก็บในแคช 15 นาที การเรียกซ้ำภายใน 15 นาทีจะได้ผลลัพธ์เดิม ข้อมูลจึงอาจช้ากว่าข้อมูลจริงได้สูงสุด 15 นาที

GET /unit/{id}

GET https://go.pospos.co/developer/api/unit/{id}

Path Parameters

หมายเหตุ ตอบกลับ data เป็น array 1 รายการ หากไม่พบได้ HTTP 404 หาก id ไม่อยู่ในรูปแบบรหัสอ้างอิงได้ HTTP 400

ตัวอย่างการเรียกใช้งาน

curl --location 'https://go.pospos.co/developer/api/unit' \
--header 'apikey: {YOUR_API_KEY}'

ตัวอย่าง Response

{
  "success": 1,
  "data": [
    { "_id": "5aaa2ab70fedd20c21891904", "name": "ชิ้น" },
    { "_id": "5c0a4d23c60de51f1da4c6e7", "name": "จาน" }
  ]
}

data[] (หน่วยนับ)

Webhook

ร้านตั้งค่า Webhook URL และเลือก Event ที่ต้องการได้ที่หน้า https://go.pospos.co/core/setting/general/developer เช่น เพิ่มหรือแก้ไขสินค้า พนักงาน ลูกค้า บัญชีธนาคาร และการเปิดหรือปิดกะการขาย API ในหัวข้อนี้ใช้ส่ง Event ไปยัง URL ปลายทาง เพื่อทดสอบว่าระบบของท่านรับ Webhook ได้

POST /webhook

POST https://go.pospos.co/developer/api/webhook

Header

Body

ตัวอย่างการเรียกใช้งาน

curl --location --request POST 'https://go.pospos.co/developer/api/webhook' \
--header 'apikey: {YOUR_API_KEY}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "targetUrl": "https://your-domain.com/webhook",
  "events": [
    {
      "version": "1",
      "type": "TEST_API",
      "timestamp": "2026-10-29T08:00:00.000Z",
      "source": { "type": "WEB", "userId": "xxxxx" },
      "message": { "type": "text", "data": "ทดสอบ API" }
    }
  ]
}'

ตัวอย่าง Response

{
  "success": 1
}

หมายเหตุ หากระบบส่ง Event ไม่สำเร็จจะได้ HTTP 400 พร้อมข้อความ "failure to send webhook"