Contact

Get Contacts

GET https://open-api.zortout.com/v4/Contact/GetContacts

Get list of contacts.

Query Parameters

Name	Type	Description
keyword	String	Keyword to search at least 3 characters
page	Int	Page (Default = 1)
limit	Int	Limit per page (Max = 500)

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret
contactidlist	String	Contact ID List Ex. 1234,5678

200: OK Success

Response

Parameter	Type	Description/Example
res	Response	Response Code 200- Success
list	Contact (Array)	Contact List (Array)
count	Int	Total contact number by filter

Contact (Array)	Type	Description/Example
id	Int	Contact ID
name	String	Contact Name
code	String	Contact Code
idnumber	String	Contact ID Number/Tax ID
phone	String	Contact Phone
email	String	Contact Email
address	String	Contact Address
branchname	String	Branch Name
branchno	String	Branch No
facebook	String	Facebook
line	String	LINE
instagram	String	Instagram
imagepath	String	Image Url
tag	String (Array)	Tag List (Array)
properties	Property (Array)	Custom Properties List

Property (Array)	Type	Description/Example
id	Int	Property ID
name	String	Property Name
value	String	Property Value

Get Contact Detail

GET https://open-api.zortout.com/v4/Contact/GetContactDetail

Get contact detail

Query Parameters

Name	Type	Description
id*	Int	Contact ID

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

200: OK Success

Response

Parameter	Type	Description/Example
id	Int	Contact ID
name	String	Contact Name
code	String	Contact Code
idnumber	String	Contact ID Number/Tax ID
phone	String	Contact Phone
email	String	Contact Email
address	String	Contact Address
branchname	String	Branch Name
branchno	String	Branch No
facebook	String	Facebook
line	String	LINE
instagram	String	Instagram
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

SubContact (Array)	Type	Description/Example
name	String	Subcontact Name
position	String	Subcontact Position
phone	String	Subcontact Phone
mobile	String	Subcontact Mobile
email	String	Subcontact Email
isMain	Boolean	Main Status

ShippingAddress (Array)	Type	Description/Example
name	String	Shipping Name
address	String	Shipping Address
phone	String	Shipping Phone
email	String	Shipping Email
isMain	Boolean	Main Status

Property (Array)	Type	Description/Example
id	Int	Property ID
name	String	Property Name
value	String	Property Value

Add Contact

POST https://open-api.zortout.com/v4/Contact/AddContact

Add contact.

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Request Body

Name	Type	Description
code*	String	Contact Code
name*	String	Contact Name
idnumber	String	Contact ID Number/Tax ID
phone	String	Contact Phone
email	String	Contact Email
address	String	Contact Address
branchname	String	Branch Name
branchno	String	Branch No
facebook	String	Facebook
line	String	Line
instagram	String	Instagram
∟ 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

200: OK Success

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Succes
resDesc	String	Response Description
detail	Detail	Detail

Detail	Type	Description/Example
id	Int	Contact ID

Ex. Request JSON

{
  "code": "C0001",
  "name": "Contact1",
  "idnumber": "123456789",
  "email": "[e-mail]",
  "phone": "021234567"
}

Update Contact

POST https://open-api.zortout.com/v4/Contact/UpdateContact

Edit contact info

Query Parameters

Name	Type	Description
id*	Int	Contact ID

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Request Body

Name	Type	Description
idnumber	String	Contact ID Number/Tax ID
code*	String	Contact Code
facebook	String	Facebook
name	String	Contact Name
branchname	String	Branch Name
line	String	Line
address	String	Contact Address
phone	String	Contact Phone
email	String	Contact Email
instagram	String	Instagram
branchno	String	Branch No

200: OK Success

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Ex. Request JSON

{
  "code": "C0001",
  "name": "Contact1",
  "idnumber": "123456789",
  "email": "[e-mail]",
  "phone": "021234567"
}