Gofive OpenAPI
empeoVenioeTaxGo
empeoVenioeTaxGo
  1. Customer
  • Introduction
  • Activity
    • Get a Activity
      GET
    • Activities Enquiry
      POST
  • Authentication API
    • Authorization
      POST
  • Customer
    • Create or Update customer
      POST
    • Get a Customer By CustomerCode
      GET
    • Customers Enquiry
      POST
    • Get a Customer By CustomerName
      GET
    • Create Customer Satisfaction
      POST
    • Add Customer Event
      POST
    • Get Customer Events by Customer Code
      GET
    • Edit Customer Event
      PUT
    • Delete Customer Event
      DELETE
    • Get Customer Event Types
      GET
  • Case
    • Add Case
      POST
    • Edit Case by CaseNo
      PUT
    • Get Case by CaseNo
      GET
    • Get Case Categories
      GET
  • Deal
    • Create Deal
      POST
    • Update Deal
      PUT
    • Deal Enquiry
      POST
    • Get Deal
      GET
    • Get Deal Board
      GET
    • Get Deal Stage
      GET
    • Get Deal Interest
      GET
    • Get DealLabel
      GET
    • Get Deal Missed Reason Categories
      GET
  • Employee
    • Employees Enquiry
    • Get a Employee
  • Expense
    • Create Expense
    • Update Expense
    • Expense Enquiry
    • Get a Expense
  • Product
    • Create Or Update Products
    • Get a Product Ticket
    • Get Products With Take & Status
    • Get a Product by ProductCode
    • Get Product Groups
    • Get Product Properties
    • Get Products By Filter
    • Verify Serial Number
    • /v3/Products/serials/status
    • Create or Update Codeguard Products
    • Update Product Stock
    • /v1/products/units
    • /v1/products/units Copy
  • Quotation
    • Create Update Quotation
    • Convert Quotation To SalesOrder
    • Quotation Enquiry
    • Get a Quotation By QuotationNo
    • Cancel Quotation
  • SalesOrder
    • Create Or Update SalesOrder
    • Get a SalesOrders By Id
    • Get a SalesOrder By SalesOrderNo
    • Get Sale Order Attachment
    • Reject SaleOrder
    • Approve Sale Order
    • Update SalesOrder Payment
    • Update SalesOrder Tracking Number
  • Webhooks
    • Webhook Payload
  • Task
    • CreateTask
  • Setting
    • Get HeaderTemplate
  1. Customer

Get a Customer By CustomerCode

GET
https://api.gofive.co.th/v3/customers/{customerCode}
ดึงข้อมูล customer โดยใช้ customercode

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
customerCode
string 
required
รหัส customerCode
Header Params
Ocp-Apim-Subscription-Key
string 
required
รหัส subscription key ลูกค้า
Example:
<Your Subscription-Key>
Content-Type
string 
required
Example:
application/json

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.gofive.co.th/v3/customers/' \
--header 'Ocp-Apim-Subscription-Key: <Your Subscription-Key>' \
--header 'Content-Type: application/json'

Responses

🟢200Success
application/json
Body
status
object 
required
code
string 
required

สถานะของ Business Code ถ้า
Success = 1000
Error 1 ตัว = 4001
Error มากกว่า 1 ตัว = 4002    
หรือเป็น Subcode ที่ต้องการจะแสดงเพื่อสื่อความหมายของ Error โดย subcode จะเป็นตัวเดียวกับ business error code หรือไม่ก็ได้ เพื่อความสะดวกในการแสดงผล

description
string 
required
คำอธิบายข้อความที่จะแสดง
data
object 
required
customerId
string 
required
รหัส id ของลูกค้า
customerName
string 
required
ชื่อลูกค้า Required [ชื่อลูกค้าห้ามซ้ำกัน]
customerCode
string 
required
รหัสลูกค้า [ถ้าไม่ใส่จะเป็น การสร้างลูกค้าใหม่]
customerState
integer 
required
สถานะของลูกค้า Required : 1 = Lead , 2 = Prospect , 3 = Customer
customerType
integer 
optional
ประเภท 1 = Business , 2 = individual
customerStatus
integer 
required
สถานะการใช้งาน 0 = active , 1 = ended (Required Note) , 2 = closed (Required Note)
customerPicture
string 
required
รูปของลูกค้า โดยรับเป็น URL
customer2ndName
string 
optional
ชื่อรองลูกค้า เช่น ชื่อลูกค้าภาษาอื่นๆ
customerAliases
array[string]
required
รายการนามแฝง
customerTaxNo
string 
optional
เลขประจำตัวผู้เสียภาษี
branchCode
string 
optional
รหัสสาขา
customerPhone
string 
optional
เบอร์โทรศัพท์ลูกค้า
customerMobile
string 
optional
เบอร์มือถือลูกค้า
customerEmail
string 
optional
อีเมลลูกค้า
customerSocialAccount
object  | null 
optional
Social Account ของลูกค้า
customerTags
array[string]
optional
แท็กของลูกค้า
addresses
array [object {5}] 
required
ที่อยู่
sourceName
string 
optional
แหล่งที่มาลูกค้า
customerGroupName
string 
optional
กลุ่มลูกค้า [*ทำการสร้างให้ใหม่เมื่อข้อมูลไม่ตรงกัน]
interestsName
array[string]
required
ความสนใจ [*ทำการสร้างให้ใหม่เมื่อข้อมูลไม่ตรงกัน]
classificationName
string 
optional
คลาสลูกค้า โดยใส่ค่าได้ มากที่สุด 3 ตัวอักษร
contacts
array [object {10}] 
required
รายการข้อมูลผู้ติดต่อ
customFields
array [object {2}] 
required
ฟิลด์ข้อมูลลูกค้าที่กำหนดเอง
customerNote
string 
optional
เมื่อ CustomerStatus เป็น Ended , Closed
owners
array[string]
optional
รหัสพนักงานผู้รับผิดชอบ
primaryOwner
string 
optional
รหัสพนักงานผู้รับผิดชอบหลัก
leadStatus
integer 
required
สถานะผู้สนใจ 1 = New , 2 = Followup , 3 = Unqualified , 4 = Interested [*ถ้าไม่มีการส่งข้อมูลมา Lead = 1 ,Prospect = 2, Customer = 3]
customerIncome
string  | null 
optional
รายได้
*ทำการสร้างให้ใหม่เมื่อข้อมูลไม่ตรงกัน
creditLimit
string  | null 
optional
งบลูกค้า
*ไม่มีใช้ใน venio
Example
{
  "status": {
    "code": "1000",
    "description": "Success"
  },
  "data": {
    "customerId": "string",
    "customerName": "string",
    "customerCode": "string",
    "customerState": 3,
    "customerType": 1,
    "customerStatus": 0,
    "leadStatus": 4,
    "customerPicture": "string",
    "customer2ndName": "string",
    "customerAliases": [
      "string"
    ],
    "customerTaxNo": "string",
    "branchCode": "string",
    "customerPhone": "string",
    "customerMobile": "string",
    "customerEmail": "string",
    "customerSocialAccount": {
      "facebook": "string"
    },
    "customerTags": [
      "string"
    ],
    "addresses": [
      {
        "locationName": "string",
        "locationAddress": "string",
        "locationType": 1,
        "latitude": "string",
        "longitude": "string"
      }
    ],
    "sourceName": "string",
    "customerGroupName": "string",
    "interestsName": [
      "string"
    ],
    "classificationName": "string",
    "customFields": [
      null
    ],
    "contact": [
      {
        "contactName": "string",
        "contactPicture": "string",
        "contactPhone": "string",
        "contactMobile": "string",
        "contactEmail": "string",
        "contactSocialAccount": {
          "facebook": "string"
        },
        "contactPosition": "string",
        "contactBirthdate": "YYYY-MM-DD",
        "contactNote": "string",
        "contactStatus": true
      }
    ],
    "customerNote": "string",
    "owners": [
      "string"
    ],
    "primaryOwner": "string"
  }
}
🟠401Unauthorized
🟠403Forbidden
🟠400Bad Request
🟠401User authentication required V2.
Previous
Create or Update customer
Next
Customers Enquiry
Built with