API DOCUMENTATION Last Update: Mar 28, 2022

Client - Account Info

Show a client's (store's) account information:

 

The data to be submitted to the API is composed of the following fields:

 

  field   Example   Note
user_id john1970 Required
user_password 1959caadac9b13dcb3 Required
type account_info Required
account_id greatwidgets Required
output JSON or XML Optional.
If not provided, defaults to XML
callback someFunctionName Optional: JSONP format
condensed yes Optional (No white space)
Applies only to JSON(P) output

  

 

Example PHP Request:

If you are using PHP, the $data array would look like this:

  1. $data['user_id'] = 'john1970';
  2. $data['user_password'] = '1959caadac9b13dcb3';
  3. $data['type'] = 'account_info';
  4. $data['account_id'] = 'greatwidgets';

 

Success XML Response (New or Updated Account):

  1. <response status="success">
  2. <account>
  3. <account_id>test2009050502</account_id>
  4. <biz_name>Great Widgets Company</biz_name>
  5. <biz_address1>123 Main St.</biz_address1>
  6. <biz_address2></biz_address2>
  7. <biz_city>Anytown</biz_city>
  8. <biz_state>CA</biz_state>
  9. <biz_zip>55555</biz_zip>
  10. <biz_country>NZ</biz_country>
  11. <biz_locations>50</biz_locations>
  12. <biz_online>N</biz_online>
  13. <biz_employees>5000</biz_employees>
  14. <industry>Sciene & Technology</industry>
  15. <contact_first_name>John</contact_first_name>
  16. <contact_last_name>Smith</contact_last_name>
  17. <contact_email>John@email.com</contact_email>
  18. <contact_phone>555-555-5555</contact_phone>
  19. <language>EN</language>
  20. <symbol>USD</symbol>
  21. <glyph>$</glyph>
  22. <timezone>14</timezone>
  23. <created>2010-09-05</created>
  24. </account>
  25. </response>

NOTES:

  • If the account is a coalition account, a <coalition>Yes</coalition> node will be added.
  • If the account is a two-tier account, a <two_tier>Yes</two_tier> node will be added.

 

Error XML Response:

  1. <response status="error">
  2. <error>Error message</error>
  3. </response>