all data is live and searchable
« Back . [api documentation and samples] . [view sample]
Main Web API Documentation Information
Actual Page/Function Name:
getSalespersonAndStoreInfo
Human Readable Name or Caption:
Get Salesperson And Store Info
Page/Function Description:
This method will get the correct contact info for the invoice.
Page/Function Output Type:
API - JSON or WDDX
Categories:
eComm,invoice,quote
Extra Page/Function Notes:
This returns things like locations, addresses, phone numbers, email addresses, as well as contact info for the salesperson who serviced the ticket.


Parameters
Scope Name Type Default Description Required Alternates Known Values
Arguments CORP_ID Numeric 0 Pass in the corp id number. This is your corporation ID or your business world number. This is required and will be validated. The default is 0, but will be checked for a real number. Yes
Arguments SALESPERSON_ID Numeric 0 Pass in the main salesperson id number (a payee/user id). Use 1 if unknown. Yes
Arguments STORE_ID Numeric 0 Pass in the store or location id number. This value is corporation specific and can be looked up by going to the getGeneralLookupValues method. You'll be looking for the QRY_LOCATION_INFO_ARRAY data. If you have multiple locations, this is extremely important. Yes


Results
RET_STATUS RET_MAIN_MESSAGE RET_SECOND_MESSAGE Redirect Link Description
ok success This assumes that everything went well!
Name Type Description Notes
QRY_SALES_CONTACT_ARRAY Array This is an array with the main contact information. This contains payee information like cell phone, email, first name, and last name.
QRY_SALES_STORE_ARRAY Array This is an array with the store information. This contains information like store address, city, email, fax, hours, name, phone, web address, etc.
corpSettings Missing the correct corp-wide settings. Unable to proceed. Use your back button and try again. This is returned if the query can't find the default salesperson name and default loc name for your corp id.
dbZero Unable to get the required corp-wide settings. Missing some data. Use your back button and try again. This is returned if there is an error while querying the default salesperson name and the default loc name.
dataIn Unable to get the correct [name] contact info. Missing some data. Use your back button and try again. This is returned if the corp id, salesperson id, or store id arguments are not found.
db Unable to connect to the database. Missing the [name] contact information. Use your back button and try again. This is returned if there was an error in querying values such as payee cell phone, payee email, payee first name, payee last name, store address, store city, etc.
zero Missing the [name] and [name] contact info. Unable to proceed. Use your back button and try again. This is returned if the sales contact or sales store record counts are zero.


Samples
Caption Text
JSON
{"API_CALL_FUNCTION_NAME":"getsalespersonandstoreinfo","CORP_ID":53,"SALESPERSON_ID":2,"STORE_ID":178,"API_CORP_KEY_ID":"PLA-0053","API_USER_NAME":"demo","API_USER_PASSWORD":"1234","API_CURRENT_PAYEE_ID":"2","API_INPUT_OUTPUT_TYPE":"JSON","API_URL_ENCODING":"AUTO"}