- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Find Customer By Name
Type
- Get
Example:
- https://ws.cenpoint.com/cpwc.wc?custcode=bogusCustCode&token=bogusToken&appName=sweetAppName&prg=cpapi&proc=findCustByName&custName=inc
Base URL (includes authentication + end point)
- https://ws.cenpoint.com/cpwc.wc?custcode=<<Company Code>>&token=<<API Key>>&appName=<<YourAppName>>&prg=cpapi&proc=findCustByName
Parameters:
Name Type Description Example custName String Customer name to search for. Either full or partial name. Case insensitive Inc
Returns:
- Array of customers that match the search criteria. Max of 50 results returned
- {"VFPData":{"rows":[{"custid":"0000000007","custname":"Great Outdoors, Inc","email":"scott@cenpoint.com","phone":"8014786822","addr1_m":"13134 S 5800 W","addr2_m":"Suite 3","addr3_m":"Under the Stairs","city_m":"Herriman","state_m":"UT","zip_m":"84096"},{"custid":"0000000035","custname":"Mystery Inc.","email":"Scoobydoo.com","phone":"5555555555","addr1_m":"","addr2_m":"","addr3_m":"","city_m":"","state_m":"","zip_m":""}]}}
- Returned Fields:
Name Type Description Example custid String 10 character id for the customer 0000000007 custname String Customer name Great Outdoors, Inc email String General email for customer example@domain.com phone String General phone number 8014786822 addr1_m String Mailing address line 1 13134 S. 5800 W. addr2_m String Mailing address line 2 Suite 3 addr3_m String Mailing address line 3 Under the stairs city_m String Mailing address city Herriman state_m String Mailing address state (2 character abbreviation) UT zip_m String Mailing address zip 84096
- OR error message
- {"errorCode":"-4","errorDesc":"No results found"