Sample API Workflows |
  
|
Sample API Workflows |
|
Customers
---------
Creating a customer (core):
customer_create
customer_address_create (Billing)
customer_address_create (shipping)
Updating a customer (basic contact details):
customer_update
updating a customer (billing address):
customer_address_update
Updating a customer (shipping address):
customer_address_update
Extended customer details (creating/updating):
customer_udf_definitions_list
customer_udf_update
customer_document_update
Transactions
------------
Creating pending Orders:
transaction_create
transaction_payment_create
If POStive tax system is required for customer orders, web dev can use:
transaction_product_taxrate
to receive the customer/category specific tax rates before the above transaction create is used
Lookup existing pending transaction
transaction_pending_list (groups of pending transactions)
transaction_pending_info (single pending transaction)
Lookup existing Invoices
transaction_invoice_list (groups of invoices)
transaction_invoice_info (single invoice)
Inventory
---------
tax_rates_list
tax_category_group_list
tax_category_taxrate_link_list
tax_customer_group_lists
division_list
Product_price_groups_list
product_department_categoty_list
product_list
product_image_list
product_contract_pricing_list
Synchronization
---------------
system_changes_list
Web dev should save the last successful system_changes_list call and then the next time it is called use this last unc date/time.
Depending on what was in the system_changes_list, make calls as required eg customer related, product related calls to update the website.
Example of customer_create
Sent:
{
"customer" : {
"localcustomerid" : "13779",
"customertype" : "P",
"lookupcode" : "test123",
"email" : "testadd@gmail.com",
"company" : "Generic Corp.",
"firstname" : "John",
"lastname" : "Brown",
"homephone" : "555-555-5555",
"workphone" : "556-556-5556",
"cellphone" : "",
"faxphone" : "",
"taxvat" : "",
"taxgroupid" : 0
}
}
Received:
{
"createcustomer_response" : {
"result" : {
"status" : "Success",
"localcustomerid" : "13779",
"customerid" : "26"
}
}
}