# Get a Customer By CustomerCode ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v3/customers/{customerCode}: get: summary: Get a Customer By CustomerCode deprecated: false description: ดึงข้อมูล customer โดยใช้ customercode tags: - Venio/Customer parameters: - name: customerCode in: path description: รหัส customerCode required: true schema: type: string - name: Ocp-Apim-Subscription-Key in: header description: รหัส subscription key ลูกค้า required: true example: schema: type: string - name: Content-Type in: header description: '' required: true example: application/json schema: type: string responses: '200': description: '' content: application/json: schema: type: object properties: status: type: object properties: code: type: string description: "

สถานะของ\_Business\_Code\_ถ้า
Success\_=\_1000
Error\_1\_ตัว\_=\_4001
Error\_มากกว่า\_1\_ตัว\_=\_4002\_\_\_\_
หรือเป็น\_Subcode\_ที่ต้องการจะแสดงเพื่อสื่อความหมายของ\_Error\_โดย\_subcode\_จะเป็นตัวเดียวกับ\_business\_error\_code\_หรือไม่ก็ได้\_เพื่อความสะดวกในการแสดงผล

" description: type: string description: คำอธิบายข้อความที่จะแสดง required: - code - description x-apidog-orders: - code - description x-apidog-ignore-properties: [] data: type: object x-apidog-refs: 01KD50QZ4PHJ8M0Z2WFXZP3RSD: $ref: '#/components/schemas/CustomerV2Dto' x-apidog-overrides: addresses: &ref_0 type: array items: type: object properties: addressId: type: integer branchCode: type: string description: รหัสสาขา nullable: true locationName: type: string description: ชื่อสถานที่ locationAddress: type: string description: ที่อยู่ secondaryAddress: type: string description: ที่อยู่ ภาษาอังกฤษ locationType: type: integer description: >- ประเภทสถานที่ [1 = billing address , 2 = shipping address] latitude: type: number description: ละติจูด nullable: true longitude: type: number description: ลองจิจูด nullable: true subdistrict: type: string description: แขวง/ตำบล nullable: true subdistrictEN: type: string description: แขวง/ตำบล ภาษาอังกฤษ nullable: true district: type: string description: เขต/อำเภอ nullable: true districtEN: type: string description: เขต/อำเภอ ภาษาอังกฤษ nullable: true province: type: string description: จังหวัด nullable: true provinceEN: type: string description: จังหวัด ภาษาอังกฤษ nullable: true zipCode: type: string description: รหัสไปรษณีย์ nullable: true x-apidog-orders: - addressId - 01KE6HX771C65NAS0G1CCKEKG9 required: - locationName - locationAddress - secondaryAddress - locationType x-apidog-refs: 01KE6HX771C65NAS0G1CCKEKG9: $ref: '#/components/schemas/Customer.Address' x-apidog-ignore-properties: - branchCode - locationName - locationAddress - secondaryAddress - locationType - latitude - longitude - subdistrict - subdistrictEN - district - districtEN - province - provinceEN - zipCode description: ที่อยู่ required: - addresses x-apidog-orders: - 01KD50QZ4PHJ8M0Z2WFXZP3RSD properties: customerId: type: string description: รหัส id ของลูกค้า customerName: type: string description: ชื่อลูกค้า Required [ชื่อลูกค้าห้ามซ้ำกัน] customerCode: type: string description: รหัสลูกค้า [ถ้าไม่ใส่จะเป็น การสร้างลูกค้าใหม่] customerState: type: integer description: >- สถานะของลูกค้า Required : 1 = Lead , 2 = Prospect , 3 = Customer customerType: type: integer description: ประเภท 1 = Business , 2 = individual customerStatus: type: integer description: >- สถานะการใช้งาน 0 = active , 1 = ended (Required Note) , 2 = closed (Required Note) customerPicture: type: string description: รูปของลูกค้า โดยรับเป็น URL customer2ndName: type: string description: ชื่อรองลูกค้า เช่น ชื่อลูกค้าภาษาอื่นๆ customerAliases: type: array items: type: string description: รายการนามแฝง customerTaxNo: type: string description: เลขประจำตัวผู้เสียภาษี customerPhone: type: string description: เบอร์โทรศัพท์ลูกค้า customerMobile: type: string description: เบอร์มือถือลูกค้า customerEmail: type: string description: อีเมลลูกค้า customerSocialAccount: type: object properties: facebook: type: string description: Facebook ลูกค้า line: type: string description: Line ลูกค้า whatsapp: type: string description: whatsApp ลูกค้า skype: type: string description: skype ลูกค้า instagram: type: string description: Instagram ลูกค้า linkedin: type: string description: LinkedIn ลูกค้า telegram: type: string description: Telegram wechat: type: string description: wechat ลูกค้า description: 'Social Account ของลูกค้า ' x-apidog-orders: - facebook - line - whatsapp - skype - instagram - linkedin - telegram - wechat x-apidog-ignore-properties: [] nullable: true customerTags: type: array items: type: string description: แท็กของลูกค้า addresses: *ref_0 sourceName: type: string description: แหล่งที่มาลูกค้า customerGroupName: type: string description: กลุ่มลูกค้า [*ทำการสร้างให้ใหม่เมื่อข้อมูลไม่ตรงกัน] interestsName: type: array items: type: string description: ความสนใจ [*ทำการสร้างให้ใหม่เมื่อข้อมูลไม่ตรงกัน] classificationName: type: string description: คลาสลูกค้า โดยใส่ค่าได้ มากที่สุด 3 ตัวอักษร contacts: type: array items: type: object properties: contactName: type: string description: ผู้ติดต่อ contactPicture: type: string description: รูปของผู้ติดต่อ ใช้เป็น URL ของรูป contactPhone: type: string description: เบอร์โทรศัพ ของผู้ติดต่อ contactMobile: type: string description: เบอร์โทรศัพมือถือ ของผู้ติดต่อ contactEmail: type: string description: Email ของผู้ติดต่อ contactSocialAccount: type: object properties: facebook: type: string description: facebook ผู้ติดต่อ line: type: string description: line ผู้ติดต่อ whatsapp: type: string description: whatsApp ผู้ติดต่อ skype: type: string description: skype ผู้ติดต่อ instagram: type: string description: instagram ผู้ติดต่อ linkedin: type: string description: linked ผู้ติดต่อ telegram: type: string description: telegram ผู้ติดต่อ wechat: type: string description: wechat ผู้ติดต่อ description: Social Account ของผู้ติดต่อ x-apidog-orders: - facebook - line - whatsapp - skype - instagram - linkedin - telegram - wechat x-apidog-ignore-properties: [] nullable: true contactPosition: type: string description: ตำแหน่ง ของผู้ติดต่อ contactBirthdate: type: string description: 'วันเกิด ของผู้ติดต่อ โดยมี Format : "YYYY-MM-DD"' contactNote: type: string description: รายละเอียดเพิ่มเติม contactStatus: type: boolean description: true = active , false = inactive tags: type: array items: type: string description: Tags ผู้ติดต่อ x-apidog-orders: - contactName - contactPicture - contactPhone - contactMobile - contactEmail - contactSocialAccount - contactPosition - contactBirthdate - contactNote - contactStatus - tags required: - contactName x-apidog-ignore-properties: [] description: รายการข้อมูลผู้ติดต่อ customFields: type: array items: type: object properties: customFieldName: type: string description: ชื่อหัวข้อฟิลด์ customFieldValue: type: array items: type: string description: ข้อมูลของฟิลด์ x-apidog-orders: - customFieldName - customFieldValue x-apidog-ignore-properties: [] description: ฟิลด์ข้อมูลลูกค้าที่กำหนดเอง customerNote: type: string description: เมื่อ CustomerStatus เป็น Ended , Closed owners: type: array items: type: string description: รหัสพนักงานผู้รับผิดชอบ primaryOwner: type: string description: รหัสพนักงานผู้รับผิดชอบหลัก leadStatus: type: integer description: >- สถานะผู้สนใจ 1 = New , 2 = Followup , 3 = Unqualified , 4 = Interested [*ถ้าไม่มีการส่งข้อมูลมา Lead = 1 ,Prospect = 2, Customer = 3] customerIncome: type: string description: |- รายได้ *ทำการสร้างให้ใหม่เมื่อข้อมูลไม่ตรงกัน nullable: true creditLimit: type: string description: |- งบลูกค้า *ไม่มีใช้ใน venio nullable: true required: - customerId - customerName - customerCode - customerState - customerStatus - customerPicture - customerAliases - addresses - interestsName - contacts - customFields - leadStatus x-apidog-ignore-properties: - customerId - customerName - customerCode - customerState - customerType - customerStatus - customerPicture - customer2ndName - customerAliases - customerTaxNo - customerPhone - customerMobile - customerEmail - customerSocialAccount - customerTags - addresses - sourceName - customerGroupName - interestsName - classificationName - contacts - customFields - customerNote - owners - primaryOwner - leadStatus - customerIncome - creditLimit required: - status - data x-apidog-orders: - status - data x-apidog-ignore-properties: [] examples: '1': summary: Success (OK) value: 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 customerPhone: string customerMobile: string customerEmail: string customerSocialAccount: facebook: string customerTags: - string addresses: - addressId: 0 branchCode: string locationName: string locationAddress: string secondaryAddress: string locationType: 1 latitude: string longitude: string subdistrict: string subdistrictEN: string district: string districtEN: string province: string provinceEN: string zipCode: 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 tags: - string customerNote: string owners: - string primaryOwner: string '2': summary: Unauthorized (401) value: statusCode: 401 message: Access denied due to invalid subscription key. Mak... '3': summary: Forbidden (403) value: status: description: >- {"isFavorite":false,"editable":false,"businessChats":[],"individualChats":[],"customerId":0,"companyId":0,"customerType":0,"isActive":false,"dateCreated":"0001-01-01T00:00:00","dateModified":"0001-01-01T00:00:00","isVerifiedByRD":false,"status":0} '4': summary: Bad Request (400) value: status: code: E1102 description: Customer Code "jenifier" doesn't exist. headers: {} x-apidog-name: Success '400': description: '' content: application/json: schema: type: object properties: status: type: object properties: code: type: string description: "

สถานะของ\_Business\_Code\_ถ้า
Success\_=\_1000
Error\_1\_ตัว\_=\_4001
Error\_มากกว่า\_1\_ตัว\_=\_4002\_\_\_\_
หรือเป็น\_Subcode\_ที่ต้องการจะแสดงเพื่อสื่อความหมายของ\_Error\_โดย\_subcode\_จะเป็นตัวเดียวกับ\_business\_error\_code\_หรือไม่ก็ได้\_เพื่อความสะดวกในการแสดงผล

" description: type: string description: คำอธิบายข้อความที่จะแสดง x-apidog-orders: - code - description required: - code - description x-apidog-ignore-properties: [] x-apidog-orders: - status required: - status x-apidog-ignore-properties: [] headers: {} x-apidog-name: 'Bad Request ' '401': description: '' content: application/json: schema: type: object properties: statusCode: type: integer description: |- สถานะ code ของ httpเช่น 200 Ok 201 Created 400 BadRequest 401 Unauthorized 404 Record not found 500 Internal Server Error message: type: string description: คำบรรยาย error x-apidog-orders: - statusCode - message required: - statusCode - message x-apidog-ignore-properties: [] headers: {} x-apidog-name: Unauthorized '403': description: '' content: application/json: schema: type: object properties: status: type: object properties: description: type: string description: คำบรรยาย error x-apidog-orders: - description required: - description x-apidog-ignore-properties: [] x-apidog-orders: - status required: - status x-apidog-ignore-properties: [] headers: {} x-apidog-name: Forbidden x-200:User authentication required V2.: description: '' content: application/json: schema: title: '' type: object properties: data: $ref: '#/components/schemas/Required%20authorization' status: $ref: '#/components/schemas/Response%20Error%20Msg%20' required: - data - status x-apidog-orders: - data - status x-apidog-ignore-properties: [] example: data: subCode: E9103 description: Authorization credentials required metadata: {} status: code: '4001' description: Business error with 1 errors headers: {} x-apidog-name: User authentication required V2. security: - bearer: [] x-apidog-folder: Venio/Customer x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/351895/apis/api-3590379-run components: schemas: CustomerV2Dto: type: object properties: customerId: type: string description: รหัส id ของลูกค้า customerName: type: string description: ชื่อลูกค้า Required [ชื่อลูกค้าห้ามซ้ำกัน] customerCode: type: string description: รหัสลูกค้า [ถ้าไม่ใส่จะเป็น การสร้างลูกค้าใหม่] customerState: type: integer description: 'สถานะของลูกค้า Required : 1 = Lead , 2 = Prospect , 3 = Customer' customerType: type: integer description: ประเภท 1 = Business , 2 = individual customerStatus: type: integer description: >- สถานะการใช้งาน 0 = active , 1 = ended (Required Note) , 2 = closed (Required Note) customerPicture: type: string description: รูปของลูกค้า โดยรับเป็น URL customer2ndName: type: string description: ชื่อรองลูกค้า เช่น ชื่อลูกค้าภาษาอื่นๆ customerAliases: type: array items: type: string description: รายการนามแฝง customerTaxNo: type: string description: เลขประจำตัวผู้เสียภาษี customerPhone: type: string description: เบอร์โทรศัพท์ลูกค้า customerMobile: type: string description: เบอร์มือถือลูกค้า customerEmail: type: string description: อีเมลลูกค้า customerSocialAccount: type: object properties: facebook: type: string description: Facebook ลูกค้า line: type: string description: Line ลูกค้า whatsapp: type: string description: whatsApp ลูกค้า skype: type: string description: skype ลูกค้า instagram: type: string description: Instagram ลูกค้า linkedin: type: string description: LinkedIn ลูกค้า telegram: type: string description: Telegram wechat: type: string description: wechat ลูกค้า description: 'Social Account ของลูกค้า ' x-apidog-orders: - facebook - line - whatsapp - skype - instagram - linkedin - telegram - wechat x-apidog-ignore-properties: [] nullable: true customerTags: type: array items: type: string description: แท็กของลูกค้า addresses: type: array items: type: object properties: addressId: type: integer branchCode: type: string description: รหัสสาขา locationName: type: string description: ที่อยู่ locationAddress: type: string description: ชื่อสถานที่ locationType: type: integer description: ประเภทสถานที่ [1 = billing address , 2 = shipping address] latitude: type: number description: ละติจูด longitude: type: number description: ลองจิจูด x-apidog-orders: - addressId - branchCode - locationName - locationAddress - locationType - latitude - longitude x-apidog-ignore-properties: [] description: ที่อยู่ sourceName: type: string description: แหล่งที่มาลูกค้า customerGroupName: type: string description: กลุ่มลูกค้า [*ทำการสร้างให้ใหม่เมื่อข้อมูลไม่ตรงกัน] interestsName: type: array items: type: string description: ความสนใจ [*ทำการสร้างให้ใหม่เมื่อข้อมูลไม่ตรงกัน] classificationName: type: string description: คลาสลูกค้า โดยใส่ค่าได้ มากที่สุด 3 ตัวอักษร contacts: type: array items: type: object properties: contactName: type: string description: ผู้ติดต่อ contactPicture: type: string description: รูปของผู้ติดต่อ ใช้เป็น URL ของรูป contactPhone: type: string description: เบอร์โทรศัพ ของผู้ติดต่อ contactMobile: type: string description: เบอร์โทรศัพมือถือ ของผู้ติดต่อ contactEmail: type: string description: Email ของผู้ติดต่อ contactSocialAccount: type: object properties: facebook: type: string description: facebook ผู้ติดต่อ line: type: string description: line ผู้ติดต่อ whatsapp: type: string description: whatsApp ผู้ติดต่อ skype: type: string description: skype ผู้ติดต่อ instagram: type: string description: instagram ผู้ติดต่อ linkedin: type: string description: linked ผู้ติดต่อ telegram: type: string description: telegram ผู้ติดต่อ wechat: type: string description: wechat ผู้ติดต่อ description: Social Account ของผู้ติดต่อ x-apidog-orders: - facebook - line - whatsapp - skype - instagram - linkedin - telegram - wechat x-apidog-ignore-properties: [] nullable: true contactPosition: type: string description: ตำแหน่ง ของผู้ติดต่อ contactBirthdate: type: string description: 'วันเกิด ของผู้ติดต่อ โดยมี Format : "YYYY-MM-DD"' contactNote: type: string description: รายละเอียดเพิ่มเติม contactStatus: type: boolean description: true = active , false = inactive tags: type: array items: type: string description: Tags ผู้ติดต่อ x-apidog-orders: - contactName - contactPicture - contactPhone - contactMobile - contactEmail - contactSocialAccount - contactPosition - contactBirthdate - contactNote - contactStatus - tags required: - contactName x-apidog-ignore-properties: [] description: รายการข้อมูลผู้ติดต่อ customFields: type: array items: type: object properties: customFieldName: type: string description: ชื่อหัวข้อฟิลด์ customFieldValue: type: array items: type: string description: ข้อมูลของฟิลด์ x-apidog-orders: - customFieldName - customFieldValue x-apidog-ignore-properties: [] description: ฟิลด์ข้อมูลลูกค้าที่กำหนดเอง customerNote: type: string description: เมื่อ CustomerStatus เป็น Ended , Closed owners: type: array items: type: string description: รหัสพนักงานผู้รับผิดชอบ primaryOwner: type: string description: รหัสพนักงานผู้รับผิดชอบหลัก leadStatus: type: integer description: >- สถานะผู้สนใจ 1 = New , 2 = Followup , 3 = Unqualified , 4 = Interested [*ถ้าไม่มีการส่งข้อมูลมา Lead = 1 ,Prospect = 2, Customer = 3] customerIncome: type: string description: |- รายได้ *ทำการสร้างให้ใหม่เมื่อข้อมูลไม่ตรงกัน nullable: true creditLimit: type: string description: |- งบลูกค้า *ไม่มีใช้ใน venio nullable: true required: - customerId - customerName - customerCode - customerState - customerStatus - customerPicture - customerAliases - addresses - interestsName - contacts - customFields - leadStatus x-apidog-orders: - customerId - customerName - customerCode - customerState - customerType - customerStatus - customerPicture - customer2ndName - customerAliases - customerTaxNo - customerPhone - customerMobile - customerEmail - customerSocialAccount - customerTags - addresses - sourceName - customerGroupName - interestsName - classificationName - contacts - customFields - customerNote - owners - primaryOwner - leadStatus - customerIncome - creditLimit x-apidog-ignore-properties: [] x-apidog-folder: '' Customer.Address: type: object properties: branchCode: type: string description: รหัสสาขา nullable: true locationName: type: string description: ชื่อสถานที่ locationAddress: type: string description: ที่อยู่ secondaryAddress: type: string description: ที่อยู่ ภาษาอังกฤษ locationType: type: integer description: ประเภทสถานที่ [1 = billing address , 2 = shipping address] latitude: type: number description: ละติจูด nullable: true longitude: type: number description: ลองจิจูด nullable: true subdistrict: type: string description: แขวง/ตำบล nullable: true subdistrictEN: type: string description: แขวง/ตำบล ภาษาอังกฤษ nullable: true district: type: string description: เขต/อำเภอ nullable: true districtEN: type: string description: เขต/อำเภอ ภาษาอังกฤษ nullable: true province: type: string description: จังหวัด nullable: true provinceEN: type: string description: จังหวัด ภาษาอังกฤษ nullable: true zipCode: type: string description: รหัสไปรษณีย์ nullable: true required: - locationName - locationAddress - secondaryAddress - locationType x-apidog-orders: - branchCode - locationName - locationAddress - secondaryAddress - locationType - latitude - longitude - subdistrict - subdistrictEN - district - districtEN - province - provinceEN - zipCode x-apidog-ignore-properties: [] x-apidog-folder: '' 'Response Error Msg ': type: object properties: code: type: string x-apidog-mock: '4001' description: type: string x-apidog-mock: Business error with 1 errors required: - code - description x-apidog-orders: - code - description x-apidog-ignore-properties: [] x-apidog-folder: '' Required authorization: type: object properties: subCode: type: string x-apidog-mock: E9103 description: type: string x-apidog-mock: Authorization credentials required metadata: type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] required: - subCode - description - metadata x-apidog-orders: - subCode - description - metadata x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: bearerAuth: type: jwt scheme: bearer bearerFormat: JWT description: ใส่ JWT Token ในรูปแบบ Bearer {token} bearer: type: http scheme: bearer servers: - url: https://api.gofive.co.th description: Production security: - bearerAuth: [] x-apidog: schemeGroups: - id: uyL_cJmK7q60QJZRTi5ot schemeIds: - bearerAuth required: true use: id: uyL_cJmK7q60QJZRTi5ot scopes: uyL_cJmK7q60QJZRTi5ot: bearerAuth: [] ```