eSolve RESTful web services.

Welcome to the eSolve RESTFul Web Services Guide. This document is intended for a specific audience namely other developers that want to integrate third party programs and or service as data consumers of the eSolve Product. A real word example would be to make data available to an Mobile Application or extract and use data that in turn has been integrated to other third party software providers such as IQ Retail's range of products etc.

See the practical example at the end of the document using our demo data.

List of available End-points

• get-access-token
• get-tree
• get-items
• get-item-images
• get-locations
• get-location-levels
• get-sellprices
• get-manufacturers
• get-users
• get-addresses
• get-clients

• set-transaction
• set-checkin
• set-images
• set-image-upload
• set-sellprices
• set-levels

Using the domain name supplied during the configuration phase of the project. For demo purposes, we use http://template500.geckonet.co.za/. The endpoints are consumed as follow:

GetAccessToken: http://template500.geckonet.co.za/service/get-access-token.php

The get-access-token authenticates and binds your calls to an access token or key. This key will be valid for a pre-configured period of time. If it expires, you will need to call this method again to retrieve a new key.

Invoke:
?ws_id=DEMO001&email=service@21digital.co.za&password=Serv1001G3koT3s

URLEncode GET Params:
ws_id: The pre-defined web service client identifier.
email: The eSolve registered username.
password: The eSolve registered username.

Expected Result:
{"records":{"key":"f84f0978cc58aa1726c63bcd7c35ad045f3eed47","expires":3600}}

JSON Result Variables:
key: is the authentication token to be used in your future calls.

Validate the key:
To check the validity of the key, call the following endpoint. Replace [key] with the value to check:
http://template500.geckonet.co.za/service/get-access-token.php?ws_id=DEMO001&key=[key]

GetTree: http://template500.geckonet.co.za/service/get-tree.php

Invoke:
?ws_id=DEMO001&key=f84f0978cc58aa1726c63bcd7c35ad045f3eed47

URLEncode GET Params:
ws_id: The pre-defined web service client identifier.
key: The access token issued during authentication.

Expected Result:
{"records":[{"esolve_init":null,"menu_id":"BM0000000000001","description":"Building Materials","seo_description":"","sort_priority":"1.1000","active":"1","display_only":"0","seo_page_priority":"0.5","seo_page_update_frequency":"ignore","seo_page_title":"","seo_keywords":"","sef_description":"building_materials","stock_sort_order":"Stock Code Ascending Order","short_description":"Building Materials","sub_category_layout":"","owner_menu_id":"","mapped_subcategories_id":"0","item_layout":null,"type":"category","total_stock":0,"current_selected":false,"children":[{"esolve_init":null,"id":"1915","menu_id":"BM0000000000001","sql":"","description":"Insulation - Building Materials","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"insulation__building_materials","short_description":"Insulation - Building Materials","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"0"},{"esolve_init":null,"id":"1917","menu_id":"BM0000000000001","sql":"","description":"Lumber - Building Materials","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"lumber__building_materials","short_description":"Lumber - Building Materials","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"0"},{"esolve_init":null,"id":"1916","menu_id":"BM0000000000001","sql":"","description":"Masonry - Building Materials","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"masonry__building_materials","short_description":"Masonry - Building Materials","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"0"}]},{"esolve_init":null,"menu_id":"ELE000000000001","description":"Electrical","seo_description":"","sort_priority":"1.1000","active":"1","display_only":"0","seo_page_priority":"0.5","seo_page_update_frequency":"","seo_page_title":"","seo_keywords":"","sef_description":"electrical","stock_sort_order":"Stock Code Ascending Order","short_description":"Electrical","sub_category_layout":"","owner_menu_id":"","mapped_subcategories_id":"0","item_layout":null,"type":"category","total_stock":13,"current_selected":false,"children":[{"esolve_init":null,"id":"1898","menu_id":"ELE000000000001","sql":"(SUBDEPARTM = 'BAT0') and (SELLPRICE1 <> 1)","description":"Batteries - Electrical","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"Stock Code Ascending Order","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"batteries__electrical","short_description":"Batteries - Electrical","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"5"},{"esolve_init":null,"id":"1902","menu_id":"ELE000000000001","sql":"SUBDEPARTM = 'GEYS'","description":"Geyser - Electrical","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"Stock Code Ascending Order","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"geyser__electrical","short_description":"Geyser - Electrical","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"8"},{"esolve_init":null,"id":"1899","menu_id":"ELE000000000001","sql":"","description":"Lighting - Electrical","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"lighting__electrical","short_description":"Lighting - Electrical","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"0"},{"esolve_init":null,"id":"1909","menu_id":"ELE000000000001","sql":"","description":"Wiring and Cabling - Electrical","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"wiring_and_cabling__electrical","short_description":"Wiring and Cabling - Electrical","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"0"}]},{"esolve_init":null,"menu_id":"GO0000000000001","description":"Garden & Outdoor","seo_description":"","sort_priority":"1.1000","active":"1","display_only":"0","seo_page_priority":"0.5","seo_page_update_frequency":"","seo_page_title":"","seo_keywords":"","sef_description":"garden_and_outdoor","stock_sort_order":"Stock Code Ascending Order","short_description":"Garden & Outdoor","sub_category_layout":"","owner_menu_id":"","mapped_subcategories_id":"0","item_layout":null,"type":"category","total_stock":22,"current_selected":false,"children":[{"esolve_init":null,"id":"1901","menu_id":"GO0000000000001","sql":"SUBDEPARTM = 'BAIT'","description":"Baits - Gardening","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"Stock Code Ascending Order","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"baits__gardening","short_description":"Baits - Gardening","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"2"},{"esolve_init":null,"id":"1900","menu_id":"GO0000000000001","sql":"SUBDEPARTM = 'FERT'","description":"Fertilizers - Gardening","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"Stock Code Ascending Order","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"fertilizers__gardening","short_description":"Fertilizers - Gardening","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"8"},{"esolve_init":null,"id":"1903","menu_id":"GO0000000000001","sql":"SUBDEPARTM = 'WATE'","description":"Watering - Gardening","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"Stock Code Ascending Order","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"watering__gardening","short_description":"Watering - Gardening","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"12"}]},{"esolve_init":null,"menu_id":"HAR000000000001","description":"Hardware","seo_description":"","sort_priority":"1.1000","active":"1","display_only":"0","seo_page_priority":"0.5","seo_page_update_frequency":"ignore","seo_page_title":"","seo_keywords":"","sef_description":"hardware","stock_sort_order":"Stock Code Ascending Order","short_description":"Hardware","sub_category_layout":"","owner_menu_id":"","mapped_subcategories_id":"0","item_layout":null,"type":"category","total_stock":0,"current_selected":false,"children":[{"esolve_init":null,"id":"1905","menu_id":"HAR000000000001","sql":"","description":"Fasteners - Hardware","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"fasteners__hardware","short_description":"Fasteners - Hardware","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"0"},{"esolve_init":null,"id":"1907","menu_id":"HAR000000000001","sql":"","description":"Hand Tools - Hardware","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"hand_tools__hardware","short_description":"Hand Tools - Hardware","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"0"},{"esolve_init":null,"id":"1906","menu_id":"HAR000000000001","sql":"","description":"Power Tools - Hardware","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"power_tools__hardware","short_description":"Power Tools - Hardware","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"0"},{"esolve_init":null,"id":"1908","menu_id":"HAR000000000001","sql":"","description":"Safety Gear - Hardware","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"safety_gear__hardware","short_description":"Safety Gear - Hardware","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"0"}]},{"esolve_init":null,"menu_id":"PAI000000000001","description":"Painting","seo_description":"","sort_priority":"1.1000","active":"1","display_only":"0","seo_page_priority":"0.5","seo_page_update_frequency":"","seo_page_title":"","seo_keywords":"","sef_description":"painting","stock_sort_order":"Stock Code Ascending Order","short_description":"Painting","sub_category_layout":"","owner_menu_id":"","mapped_subcategories_id":"0","item_layout":null,"type":"category","total_stock":0,"current_selected":false,"children":[{"esolve_init":null,"id":"1910","menu_id":"PAI000000000001","sql":"","description":"Indoor Paint - Painting","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"indoor_paint__painting","short_description":"Indoor Paint - Painting","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"0"},{"esolve_init":null,"id":"1911","menu_id":"PAI000000000001","sql":"","description":"Outdoor Paint - Painting","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"outdoor_paint__painting","short_description":"Outdoor Paint - Painting","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"0"},{"esolve_init":null,"id":"1913","menu_id":"PAI000000000001","sql":"","description":"Paint Tools - Painting","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"paint_tools__painting","short_description":"Paint Tools - Painting","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"0"},{"esolve_init":null,"id":"1912","menu_id":"PAI000000000001","sql":"","description":"Spray Paint - Painting","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"Stock Code Ascending Order","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"spray_paint__painting","short_description":"Spray Paint - Painting","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"0"}]},{"esolve_init":null,"menu_id":"PLU000000000001","description":"Plumbing","seo_description":"","sort_priority":"1.1000","active":"1","display_only":"0","seo_page_priority":"0.5","seo_page_update_frequency":"","seo_page_title":"","seo_keywords":"","sef_description":"plumbing","stock_sort_order":"Stock Code Ascending Order","short_description":"Plumbing","sub_category_layout":"","owner_menu_id":"","mapped_subcategories_id":"0","item_layout":null,"type":"category","total_stock":5,"current_selected":false,"children":[{"esolve_init":null,"id":"1914","menu_id":"PLU000000000001","sql":"","description":"Pipes - Plumbing","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"pipes__plumbing","short_description":"Pipes - Plumbing","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"0"},{"esolve_init":null,"id":"1904","menu_id":"PLU000000000001","sql":"SUBDEPARTM = 'SINK'","description":"Sinks - Plumbing","seo_description":"","min_level":"0","limit":"0","alternate_url":"","active":"1","stock_sort_order":"Stock Code Ascending Order","display_only":"0","sort_priority":"1.0001","seo_page_priority":"0.5","seo_page_update_frequency":"monthly","seo_page_title":"","seo_keywords":"","sef_description":"sinks__plumbing","short_description":"Sinks - Plumbing","item_layout":"","external_system_code":"","location_id":"0","subcategory_exclude_from_price_comparison_feed":"0","type":"subcategory","current_selected":false,"total_stock":"5"}]}]}

JSON Result Variables:
[{ "esolve_init":null, Indicator field show that the table structure is version controlled.
"menu_id":"BM0000000000001", The main code or identifier for the category. Either parent, child or stand alone category.
"description":"Building Materials", The Description of the category as defined in eSolve.
"seo_description":"",
"sort_priority":"1.1000",
"active":"1",
"display_only":"0",
"seo_page_priority":"0.5",
"seo_page_update_frequency":"ignore",
"seo_page_title":"",
"seo_keywords":"",
"sef_description":"building_materials", Used for Search engine Friendly URL's
"stock_sort_order":"Stock Code Ascending Order",
"short_description":"Building Materials",
"sub_category_layout":"",
"owner_menu_id":"", If defined, and greater than zero, this is a child category. This one is a stand alone / parent category.
"mapped_subcategories_id":"0",
"item_layout":null,
"type":"category",
"total_stock":0,
"current_selected":false,
"children":[
- The Sub Categories Data envelope.
{
"esolve_init":null, Indicator field show that the table structure is version controlled.
"id":"1915", The unique sub-category id. Integer value greater than zero.
"menu_id":"BM0000000000001", The sub-categories owner. A sub category is not a child, it is a deeper data structure.
"sql":"", - Rules define to extract data from the ERP. IQ / Omni / Syspro etc
"description":"Insulation - Building Materials", User defined description of the sub-category.
"seo_description":"",
"min_level":"0", The onhand level of stock items assigned to this sub-category may not be less than this value.
"limit":"0", The onhand level of stock items assigned to this sub-category may not be more than this value.
"alternate_url":"",
"active":"1",
"stock_sort_order":"",
"display_only":"0",
"sort_priority":"1.0001",
"seo_page_priority":"0.5",
"seo_page_update_frequency":"monthly",
"seo_page_title":"",
"seo_keywords":"",
"sef_description":"insulation__building_materials",
"short_description":"Insulation - Building Materials",
"item_layout":"",
"external_system_code":"",
"location_id":"0",
"subcategory_exclude_from_price_comparison_feed":"0",
"type":"subcategory",
"current_selected":false,
"total_stock":"0"}
]
]

GetItems: http://template500.geckonet.co.za/service/get-items.php

Invoke:
?ws_id=DEMO001&key=f84f0978cc58aa1726c63bcd7c35ad045f3eed47

URLEncode GET Params:
ws_id: The pre-defined web service client identifier.
key: key: The access token issued during authentication.
Optional:
category_id: Returns all the item that match the category id.
subcategory_id: Returns all the item that match the sub-category id.
is_active: Returns Active Items only.
display_only: Returns items that are not to be transacted on.

Expected Result:
{"records":[{"id":"54","code":"FER0003","supplier_code":"","external_system_code":"FER0003","barcode":"","name":"Efekto bravo 720","description":"","category_id":"GO0000000000001","category_description":"Garden & Outdoor","subcategory_id":"1901","subcategory_description":"Baits - Gardening","image_checksum":"0a4265dee3df15d82d654c69e41bf8f8","image_path":"","image_name":"FER0003.jpg","image_last_modified":1472814197,"must_collect":"0","delivery_category":"regular_item","is_active":"1","vat_item":"1","items_in_pack":"500","sellprice":null},{"id":"55","code":"FER0004","supplier_code":"","external_system_code":"FER0004","barcode":"","name":"Efekto cutworm bait","description":"","category_id":"GO0000000000001","category_description":"Garden & Outdoor","subcategory_id":"1901","subcategory_description":"Baits - Gardening","image_checksum":"bc775d14c775aa910ca97369c3870fc7","image_path":"","image_name":"FER0004.jpg","image_last_modified":1472814198,"must_collect":"0","delivery_category":"regular_item","is_active":"1","vat_item":"1","items_in_pack":"10","sellprice":null}]}

JSON Result Variables:
[{ "id":"54",Unique eSolve id for the stock item.
"code":"FER0003",The stock or PLU code of the item. This value is unique.
"supplier_code":"",The suppliers code for this item if available.
"external_system_code":"FER0003",ERP plu code. i.e, the stock code in IQ Business
"barcode":"",Scanable barcode value.
"name":"Efekto bravo 720",The name of the product
"description":"",Short description of the product
"category_id":"GO0000000000001",The products category owner.
"category_description":"Garden & Outdoor",The category owners description.
"subcategory_id":"1901",The subcategory_id for this product.
"subcategory_description":"Baits - Gardening",The sub-category owners description.
"image_checksum":"0a4265dee3df15d82d654c69e41bf8f8",MD5 Checksum signature for the file. Used to detect file changes.
"image_path":"",Path to the image.
"image_name":"FER0003.jpg",File name on the server.
"image_last_modified":1472814197,Date last modified for the image.
"must_collect":"0",Must be collected from the store, not deliverable.
"delivery_category":"regular_item",Possible other values (large_item,dangerous_item,abnormally_large_item,special_order_item,gift_voucher_electronic_item,gift_voucher_physical_item,rental_item,digital_item,control_item)
"is_active":"1",If the product is active or not.
"vat_item":"1",Indicates that tax applies on this item.
"vat_rate":"1.14",Multiplier to apply on the exclusive VAT price in order to get the Inclusive VAT price.
"vat_percentage":"14",The VAT rate expressed as a percentage.
"items_in_pack":"500",6 in a pack etc.
"regular_sellprice":150.0000Price of the item, excluding tax with 4 decimal places before discounts are applied.
"regular_sellprice_inclusive":171.00Price of the item, including tax with 2 decimal places before discounts are applied.
"sellprice":135.0000Price of the item, excluding tax with 4 decimal places after discounts have been applied.
"sellprice_inclusive": 153.90Price of the item, including tax with 2 decimal places after discounts have been applied.
"discounts_on_code":[{

"id":"1",Unique Database ID for the discount.
"qty_level":"1",Number of items that should be purchased for discount to apply.
"value":"0",Value of item that should be purchased for discount to apply.
"discount":"10",Percentage discount before tax.
"active":"1",Is the discount active or not.
"specials_id":"0",Discount could be linked to a special, this will be the specials unique.
"apply_condition_on":"any",Conditional value if any.
"default_discount":"10",If the condition is not met, the discount should be this value.
"default_discounted_price":"0",Override price instead of a discount percentage for the default value.
"discounted_price":"0",Override price for the discount if condition is met.
"clients_id":"0",Client id on whom the discount apply.
"loyalty_classification_id":"0",Loyalty classification on which the discount applies.
"company_name":null,Name of the client the price apply too.
"client_firstname":null,Firstname of the client.
"client_surname":nullLastname of the client.
}]
}]

GetItemImages: http://template500.geckonet.co.za/service/get-item-images.php

Invoke:
?ws_id=DEMO001&key=f84f0978cc58aa1726c63bcd7c35ad045f3eed47

URLEncode GET Params:
ws_id: The pre-defined web service client identifier.
key: The access token issued during authentication.
code: The stock code of the item the images is to be retrieved for

Expected Result:
{"records":[{"id":"41","code":"BAT0001","image_name":"BAT0001.jpg","image_last_modified":1464781246,"image_original":"http:\/\/template500.geckonet.co.za\/images\/stock\/original\/BAT0001.jpg","image_big":"http:\/\/template500.geckonet.co.za\/images\/stock\/big\/BAT0001.jpg","image_thumb":"http:\/\/template500.geckonet.co.za\/images\/stock\/thumb\/BAT0001.jpg","image_small":"http:\/\/template500.geckonet.co.za\/images\/stock\/small\/BAT0001.jpg","image_tiny":"http:\/\/template500.geckonet.co.za\/images\/stock\/tiny\/BAT0001.jpg"}]}

JSON Result Variables:
[{ "id":"41",This id must match the id retrieved during the get-items.
"code":"BAT0001",Stock code, of the item in eSolve
"image_name":"BAT0001.jpg",
"image_last_modified":1464781246,
"image_original":"http:\/\/template500.geckonet.co.za\/images\/stock\/original\/BAT0001.jpg",Image URL for the uploaded item.
"image_big":"http:\/\/template500.geckonet.co.za\/images\/stock\/big\/BAT0001.jpg",Big image, used in zooms.
"image_thumb":"http:\/\/template500.geckonet.co.za\/images\/stock\/thumb\/BAT0001.jpg",Thumb image, used as the listing page.
"image_small":"http:\/\/template500.geckonet.co.za\/images\/stock\/small\/BAT0001.jpg",Used on item details pages.
"image_tiny":"http:\/\/template500.geckonet.co.za\/images\/stock\/tiny\/BAT0001.jpg"For drop-down lists.
}]

GetLocations: http://template500.geckonet.co.za/service/get-locations.php

Invoke:
?ws_id=DEMO001&key=f84f0978cc58aa1726c63bcd7c35ad045f3eed47

URLEncode GET Params:
ws_id: The pre-defined web service client identifier.
key: The access token issued during authentication.

Expected Result:
{"records":[{"id":"1","identifier":"","head_office":"1","default_location_for_payment_methods":"1","description":"Head Office","external_system_code":"","erp_identifier":"ESL","userid":"1","importance":"1","is_active":"1","street":"49 Harrod Drive","suburb":"Oak Glen","city":"Bellville","province":"Western Cape","country":"South Africa","postal_code":"","latitude":"-33.890000","longitude":"18.657500","pobox_postal_code":"","pobox_city":"","pobox":"","branch_telnumber":"","branch_telnumber_2":"","branch_telnumber_3":"","branch_cellnumber":"","branch_fax":"","branch_email":"","monday_open_time":"00:00","monday_close_time":"00:00","tuesday_open_time":"00:00","tuesday_close_time":"00:00","wednesday_open_time":"00:00","wednesday_close_time":"00:00","thursday_open_time":"00:00","thursday_close_time":"00:00","friday_open_time":"00:00","friday_close_time":"00:00","saturday_open_time":"00:00","saturday_close_time":"00:00","sunday_open_time":"00:00","sunday_close_time":"00:00","public_holiday_open_time":"00:00","public_holiday_close_time":"00:00","website_url":"http:\/\/"},{"id":"2","identifier":"second.branch","head_office":"0","default_location_for_payment_methods":"0","description":"Secon Branch","external_system_code":"","erp_identifier":"ES2","userid":"1","importance":"0","is_active":"1","street":"49 Harrod Drive","suburb":"Oak Glen","city":"Bellville","province":"Western Cape","country":"South Africa","postal_code":"","latitude":"-33.890000","longitude":"18.657500","pobox_postal_code":"","pobox_city":"","pobox":"","branch_telnumber":"","branch_telnumber_2":"","branch_telnumber_3":"","branch_cellnumber":"","branch_fax":"","branch_email":"wernerrottcher@gmail.com","monday_open_time":"00:00","monday_close_time":"00:00","tuesday_open_time":"00:00","tuesday_close_time":"00:00","wednesday_open_time":"00:00","wednesday_close_time":"00:00","thursday_open_time":"00:00","thursday_close_time":"00:00","friday_open_time":"00:00","friday_close_time":"00:00","saturday_open_time":"00:00","saturday_close_time":"00:00","sunday_open_time":"00:00","sunday_close_time":"00:00","public_holiday_open_time":"00:00","public_holiday_close_time":"00:00","website_url":"http:\/\/"}]}

JSON Result Variables:
[{ "id":"1",This is the location id that must be used when posting a transaction or requesting stock levels.
"identifier":"",
"head_office":"1",
"default_location_for_payment_methods":"1",
"description":"Head Office",
"external_system_code":"",
"erp_identifier":"ESL",The name of the company in IQ. Company number.
"userid":"1",Should be web service or admin user id.
"importance":"1",
"is_active":"1",Must be true. If not, transaction against this location will be ignored.
"street":"49 Harrod Drive",
"suburb":"Oak Glen",
"city":"Bellville",
"province":"Western Cape",
"country":"South Africa",
"postal_code":"",
"latitude":"-33.890000",Could be used to calculate distance between the client and location.
"longitude":"18.657500",
"pobox_postal_code":"",
"pobox_city":"",
"pobox":"",
"branch_telnumber":"",
"branch_telnumber_2":"",
"branch_telnumber_3":"",
"branch_cellnumber":"",
"branch_fax":"",
"branch_email":"",
"monday_open_time":"00:00",
"monday_close_time":"00:00",
"tuesday_open_time":"00:00",
"tuesday_close_time":"00:00",
"wednesday_open_time":"00:00",
"wednesday_close_time":"00:00",
"thursday_open_time":"00:00",
"thursday_close_time":"00:00",
"friday_open_time":"00:00",
"friday_close_time":"00:00",
"saturday_open_time":"00:00",
"saturday_close_time":"00:00",
"sunday_open_time":"00:00",
"sunday_close_time":"00:00",
"public_holiday_open_time":"00:00",
"public_holiday_close_time":"00:00",
"website_url":"http:\/\/"}
]

GetLocationLevels: http://template500.geckonet.co.za/service/get-location-levels.php

Invoke:
?ws_id=DEMO001&key=f84f0978cc58aa1726c63bcd7c35ad045f3eed47

URLEncode GET Params:
ws_id: The pre-defined web service client identifier.
key: The access token issued during authentication.
location_id: The id of the location you need onhand levels for.
Optional:
code: The stock code of the item's onhand levels to be retrieved.
Expected Result:
{"records":[{"location_id":"1","code":"BAT0001","level":"88"},{"location_id":"1","code":"BAT0002","level":"10"},{"location_id":"1","code":"BAT0003","level":"-1"},{"location_id":"1","code":"BAT0004","level":"0"},{"location_id":"1","code":"BAT0005","level":"0"},{"location_id":"1","code":"FER0001","level":"0"},{"location_id":"1","code":"FER0002","level":"0"},{"location_id":"1","code":"FER0003","level":"0"},{"location_id":"1","code":"FER0004","level":"0"},{"location_id":"1","code":"FER0005","level":"0"},{"location_id":"1","code":"FER0006","level":"0"},{"location_id":"1","code":"FER0007","level":"0"},{"location_id":"1","code":"FER0008","level":"0"},{"location_id":"1","code":"FER0009","level":"0"},{"location_id":"1","code":"FER0010","level":"0"},{"location_id":"1","code":"GEY001","level":"0"},{"location_id":"1","code":"GEY002","level":"0"},{"location_id":"1","code":"GEY003","level":"0"},{"location_id":"1","code":"GEY004","level":"0"},{"location_id":"1","code":"GEY005","level":"0"},{"location_id":"1","code":"GEY006","level":"0"},{"location_id":"1","code":"GEY007","level":"1"},{"location_id":"1","code":"GEY008","level":"1"},{"location_id":"1","code":"GUN0001","level":"5"},{"location_id":"1","code":"HC15MM1","level":"4"},{"location_id":"1","code":"HC20MM1","level":"1"},{"location_id":"1","code":"HC2W001","level":"3"},{"location_id":"1","code":"HCCU001","level":"4"},{"location_id":"1","code":"HCON001","level":"65"},{"location_id":"1","code":"HMEN001","level":"7"},{"location_id":"1","code":"HMEN002","level":"3"},{"location_id":"1","code":"HNOZ001","level":"21"},{"location_id":"1","code":"HREAL001","level":"5"},{"location_id":"1","code":"HSG001","level":"61"},{"location_id":"1","code":"HSP0001","level":"2"},{"location_id":"1","code":"SHIP001","level":"0"},{"location_id":"1","code":"SINK001","level":"7"},{"location_id":"1","code":"SINK002","level":"1"},{"location_id":"1","code":"SINK003","level":"2"},{"location_id":"1","code":"SINK004","level":"3"},{"location_id":"1","code":"SINK005","level":"1"}]}

JSON Result Variables:
[{
"location_id":"1",The location's id' stock levels are to be retrieved for. Get this value from get-locations end-point
"code":"BAT0001",Optional specific stock code level required.
"level":"88"Current level as indicated by the ERP system or internal stock control system, depending on client.
}]

GetSellprices: http://template500.geckonet.co.za/service/get-sellprices.php

Invoke:
?ws_id=DEMO001&key=f84f0978cc58aa1726c63bcd7c35ad045f3eed47

URLEncode GET Params:
ws_id: The pre-defined web service client identifier.
key: The access token issued during authentication.
code: The stock code of the item the prices is to be retrieved for.

Expected Result:
{"records":[{"id":"2482","code":"BAT0001","price_index":"0","sellprice":"12345","description":"Discount per Group per Product","clients_id":"8","subcategory_id":"0","location_id":"1","country_id":"238","pricing_group":"","source_type":"external","update_type":"iq_itemized","external_system_id":"0","created":"2017-10-30 18:10:34","modified":"2017-10-30 18:10:34"},{"id":"2481","code":"BAT0001","price_index":"0","sellprice":"12345","description":"Discount per Group per Product","clients_id":"0","subcategory_id":"0","location_id":"1","country_id":"238","pricing_group":"E001","source_type":"external","update_type":"iq_contract","external_system_id":"0","created":"2017-10-30 18:08:37","modified":"2017-10-30 18:10:40"}]}

JSON Result Variables:
[{
"location_id":"1",The location's id stock levels are to be retrieved for. Get this value from get-locations end-point
"code":"BAT0001",The applicable stock code.
"price_index":"0",Price index, 1 to 10
"sellprice":"12345",The current prices for the unique sell-prices collection
"description":"Discount per Group per Product", "clients_id":"8",Price for the specific client, 0 if no client account is linked.
"subcategory_id":"0",
"location_id":"1",Price is linked to a location, by default 1
"country_id":"238",Internal country code. Not yet exposed via the API.
"pricing_group":"", "source_type":"external", Possible values are internal, external. External indicates ERP or Third Party controlled price. Internal is the eSolve price
"update_type":"iq_itemized",ERP Identifier
"external_system_id":"0", ERP unique integer id, if available. IQ doesn't supply this value but Omni does.
"created":"2017-10-30 18:10:34",
"modified":"2017-10-30 18:10:34" }]

GetManufacturers: http://template500.geckonet.co.za/service/get-manufacturers.php

Invoke:
?ws_id=DEMO001&key=f84f0978cc58aa1726c63bcd7c35ad045f3eed47

URLEncode GET Params:
ws_id: The pre-defined web service client identifier.
key: The access token issued during authentication.

Expected Result:
{"records":[{"id":"1","manufacturer":"Eveready","sef_manufacturer":"eveready","sort_priority":"1.0001","title":"Eveready Batteries","article":"","modified":"2017-11-13 08:23:52","is_active":"1","featured":"0"}]}

JSON Result Variables:
[{
"id":"1",Unique id for this brand
"manufacturer":"Eveready",The brand or manufacturer's name.
"sef_manufacturer":"eveready",SEF friendly name
"sort_priority":"1.0001",
"title":"Eveready Batteries",Page title for the manufacturer.
"article":"",A brief description of the Brand.
"modified":"2017-11-13 08:23:52",
"is_active":"1",
"featured":"0"
}]

GetUsers: http://template500.geckonet.co.za/service/get-users.php

Invoke:
?ws_id=DEMO001&key=f84f0978cc58aa1726c63bcd7c35ad045f3eed47

URLEncode GET Params:
ws_id: The pre-defined web service client identifier.
key: The access token issued during authentication.
Optional:
email: The email address of a specific user details required.

Expected Result:
{"records":[{"userid":"3","email":"werner@21digital.co.za","type_of_registration":"","account":"","loyaltynumber":"","gender":"","title":"Mr.","initials":"","firstname":"Werner","surname":"Rottcher","idnumber":"","telnumber":"","cellnumber":"0828875987","fax":"","addresses_id":"6420","busname":"","vatnum":"","busdescript":"","business_type":"","language":"","newsletter":"Yes","created":"2017-05-25 17:46:53","modified":"0000-00-00 00:00:00","lastvisit":"2017-05-25 17:46:53"}]}

JSON Result Variables:
[{ "userid":"3",Unique ID for the user account
"email":"werner@21digital.co.za",Valid email address for the user. Domain and format validated
"type_of_registration":"",Could be blank, individual or business
"account":"",Account number if available.
"loyaltynumber":"",Loyalty number if available.
"gender":"",
"title":"Mr.",
"initials":"",
"firstname":"Werner",
"surname":"Rottcher",
"idnumber":"",
"telnumber":"",
"cellnumber":"0828875987",
"fax":"",
"addresses_id":"6420",
"busname":"",Business Name if applicable.
"vatnum":"",
"busdescript":"",
"business_type":"",
"language":"",
"newsletter":"Yes",Opt-in status for newsletter
"created":"2017-05-25 17:46:53",
"modified":"0000-00-00 00:00:00",
"lastvisit":"2017-05-25 17:46:53"Last seen by the system as authenticated visits.
}]

GetAddresses: http://template500.geckonet.co.za/service/get-addresses.php

Invoke:
?ws_id=DEMO001&key=f84f0978cc58aa1726c63bcd7c35ad045f3eed47

URLEncode GET Params:
ws_id: The pre-defined web service client identifier.
key: The access token issued during authentication.
userid: The user ID address must be retreived for.
Optional:
addresses_id: The specific address required for an user account.

Expected Result:
{"records":[{"id":"6420","userid":"3","recipient":"Mr. Werner Rottcher","address_type":"","pobox":"","street_number":"49","street":"Harrod Drive","suburb":"Oakglen","city":"Bellvile","sub_region":"","province":"Western Cape","country":"South Africa","postal_code":"7530","latitude":"0.0000","longitude":"0.0000"}]}

JSON Result Variables:
[{ "id":"6420", Unique addresses id.
"userid":"3",Associated User ID.
"recipient":"Mr. Werner Rottcher", "address_type":"",Blank, Postal or Physical. Blank is synonyme for Physical.
"pobox":"", "street_number":"49", "street":"Harrod Drive", "suburb":"Oakglen", "city":"Bellvile", "sub_region":"","province": "Western Cape", "country":"South Africa", "postal_code":"7530", "latitude":"0.0000",Available if GEO Coding is enabled during registration.
"longitude":"0.0000"Available if GEO Coding is enabled during registration.
}]

GetClients: http://template500.geckonet.co.za/service/get-clients.php

Invoke:
?ws_id=DEMO001&key=f84f0978cc58aa1726c63bcd7c35ad045f3eed47

URLEncode GET Params:
ws_id: The pre-defined web service client identifier.
key: The access token issued during authentication.
Optional:
account: The specific number for the account details you would like to retrieve.
is_active: Specifies if you'd like to retrieve active or inactive accounts. By Default active accounts are retrieved.

Expected Result:
{"records":[{"id":"7","account":"21D001","branch_code":"HO","account_group":"","pricing_group":"E002","loyalty_classification_id":"2","company_name":"21 Digital Web Solutions cc","client_contact_person":"","client_firstname":"","client_surname":"","client_email":"","client_contact_number":"","client_fax_number":"","client_cellphone_number":"","client_id_number":"","street":"","suburb":"","city":"","province":"","country":"South Africa","postal_code":"","postal_address":"","delivery_address":"","latitude":"0.000000","longitude":"0.000000","vat_number":"","credit_limit":"0","default_sellprice":"5","is_active":"1"}]}

JSON Result Variables:
[{
"id":"7"eSolve Internal client_id, auto-incremental
, "account":"21D001"Unique account identifier.
, "branch_code":"HO"Client is assigned to the "head office" location.
, "account_group":""Unique account identifier for the master account.
, "pricing_group":"E002"Price list group as defined in eSolve.
, "loyalty_classification_id":"2"Internal eSolve defined loyalty. Enumerated by the eSolve Administrator user. Typical, 1 = Might mean Platinium, and 2 = Gold
, "company_name":"21 Digital Web Solutions cc",
"client_contact_person":"",
"client_firstname":"",
"client_surname":"",
"client_email":"",
"client_contact_number":"",
"client_fax_number":"",
"client_cellphone_number":"",
"client_id_number":"",
"street":"","suburb":"",
"city":"",
"province":"",
"country":"South Africa",
"postal_code":"",
"postal_address":"",
"delivery_address":"",
"latitude":"0.000000",
"longitude":"0.000000",
"vat_number":"",
"credit_limit":"0",
"default_sellprice":"5",Default assigned pricing level for the user. Currently, 11 levels exists. 0-10
"is_active":"1"
}]

SetTransaction: http://template500.geckonet.co.za/service/set-transaction.php

Invoke:
?ws_id=DEMO001&key=f84f0978cc58aa1726c63bcd7c35ad045f3eed47

URLEncode GET Params:
ws_id: The pre-defined web service client identifier.
key: The access token issued during authentication.

Data Object (JSON) To be submitted:
Download Example: order_request.json.txt

external_order_number External system unique reference number. This number can only be used once.
client_firstname Required field, must contain the clients christened name.
client_surname Optional.
client_email Required field. Must contain a valid email address. Domain name is also validated.

Fields: order_client[street - postal_code]:
Optional Is the address for the client.

Field Collection: order_items
code Required. Is the unique stock code for the item.
cart_id Your internal reference number.
qty Required. Number of items ordered.
price Required. ZAR currency formated to 4th decimal value. 0.0000.

location_id Required. Is where the order is to be routed.
Fields: orders[recipient - longitude]:
Require fields. Order delivery address.

shipping_total Shipping total for the order. Excluding VAT. Format: 0.000.
insurance_total Insurance total for the order. Excluding VAT. Format: 0.0000.
payment Payment processed for the order, Including VAT. Format: 0.00

Response:

The RESPONSE should be something like:
Download Response: order_response.json.txt

SetLevels: http://template500.geckonet.co.za/service/set-levels.php

Invoke:
?ws_id=DEMO001&key=f84f0978cc58aa1726c63bcd7c35ad045f3eed47

URLEncode GET Params:
ws_id: The pre-defined web service client identifier.
key: The access token issued during authentication.

Data Object (JSON) To be submitted:
Download Example: levels_reuest.json.txt

Response:

The RESPONSE should be something like:
Download Response: levels_response.json.txt