Contact
Last updated
Last updated
GET https://open-api.zortout.com/v4/Contact/GetContacts
Get list of contacts.
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Parameter | Type | Description/Example |
|---|---|---|
| Contact (Array) | Type | Description/Example |
|---|---|---|
GET https://open-api.zortout.com/v4/Contact/GetContactDetail
Get contact detail
POST https://open-api.zortout.com/v4/Contact/AddContact
Add contact.
POST https://open-api.zortout.com/v4/Contact/UpdateContact
Edit contact info
| Property (Array) | Type | Description/Example |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Parameter | Type | Description/Example |
|---|---|---|
| SubContact (Array) | Type | Description/Example |
|---|---|---|
| ShippingAddress (Array) | Type | Description/Example |
|---|---|---|
| Property (Array) | Type | Description/Example |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Parameter | Type | Description/Example |
|---|---|---|
| Detail | Type | Description/Example |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Parameter | Type | Description/Example |
|---|---|---|
keyword
String
Keyword to search at least 3 characters
page
Int
Page (Default = 1)
limit
Int
Limit per page (Max = 500)
storename*
String
Store Name
apikey*
String
API Key
apisecret*
String
API Secret
contactidlist
String
Contact ID List Ex. 1234,5678
res
Response
Response Code 200- Success
list
Contact (Array)
Contact List (Array)
count
Int
Total contact number by filter
id
Int
Contact ID
name
String
Contact Name
code
String
Contact Code
idnumber
String
Contact ID Number/Tax ID
phone
String
Contact Phone
String
Contact Email
address
String
Contact Address
branchname
String
Branch Name
branchno
String
Branch No
String
line
String
LINE
String
imagepath
String
Image Url
tag
String (Array)
Tag List (Array)
properties
Property (Array)
Custom Properties List
id
Int
Property ID
name
String
Property Name
value
String
Property Value
id*
Int
Contact ID
storename*
String
Store Name
apikey*
String
API Key
apisecret*
String
API Secret
id
Int
Contact ID
name
String
Contact Name
code
String
Contact Code
idnumber
String
Contact ID Number/Tax ID
phone
String
Contact Phone
String
Contact Email
address
String
Contact Address
branchname
String
Branch Name
branchno
String
Branch No
String
line
String
LINE
String
imagepath
String
Image Url
subContactList
SubContact (Array)
Subcontact List (Array)
shippingList
ShippingAddress (Array)
Shipping Address List (Array)
tag
String (Array)
Tag List (Array)
properties
Property (Array)
Custom Properties List
name
String
Subcontact Name
position
String
Subcontact Position
phone
String
Subcontact Phone
mobile
String
Subcontact Mobile
String
Subcontact Email
isMain
Boolean
Main Status
name
String
Shipping Name
address
String
Shipping Address
phone
String
Shipping Phone
String
Shipping Email
isMain
Boolean
Main Status
id
Int
Property ID
name
String
Property Name
value
String
Property Value
storename*
String
Store Name
apikey*
String
API Key
apisecret*
String
API Secret
code*
String
Contact Code
name*
String
Contact Name
idnumber
String
Contact ID Number/Tax ID
phone
String
Contact Phone
String
Contact Email
address
String
Contact Address
branchname
String
Branch Name
branchno
String
Branch No
String
line
String
Line
String
∟ value
String
Property Value
∟ name
String
Property Name Require if id = 0 or null
*Must have either id or name
∟ id
Int
Property ID
*Must have either id or name
properties
Property (Array)
Custom Properties List
resCode
String
Response Code 200- Succes
resDesc
String
Response Description
detail
Detail
Detail
id
Int
Contact ID
id*
Int
Contact ID
storename*
String
Store Name
apikey*
String
API Key
apisecret*
String
API Secret
idnumber
String
Contact ID Number/Tax ID
code*
String
Contact Code
String
name
String
Contact Name
branchname
String
Branch Name
line
String
Line
address
String
Contact Address
phone
String
Contact Phone
String
Contact Email
String
branchno
String
Branch No
resCode
String
Response Code 200- Success
resDesc
String
Response Description