Refresh

This website manage.optidigital.ca/kb/answer/874 is currently offline. Cloudflare's Always Online™ shows a snapshot of this web page from the Internet Archive's Wayback Machine. To check for the live version, click Refresh.

Getting Customer Details By Username

Description

Gets the Customer details for the specified Customer Username.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
username String Required Username of the Customer

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/customers/details.json?auth-userid=0&api-key=key&[email protected]

Response

Returns a hash map containing the below details:

  • Customer Id (customerid)

  • Customer Username (username)

  • Reseller Id of the Parent Reseller (resellerid)

  • Name (name)

  • Company (company)

  • Email Address (useremail)

  • Telephone Number Country Code (telnocc)

  • Telephone Number (telno)

  • First line of address of the Customer (address1)

  • Second line of address of the Customer (address2)

  • Third line of address of the Customer (address3)

  • City (city)

  • State (state)

  • Country Code (country)

  • ZIP Code (zip)

  • Personal Identification Number (pin)

  • Creation Date (creationdt)

  • Current Status (customerstatus)

  • Sales Contact Id (salescontactid)

  • Language Preference for the Control Panel and Emails (langpref)

  • Total Receipts (totalreceipts)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.