TGI Web Services

cornsilkbistreInternet και Εφαρμογές Web

7 Δεκ 2013 (πριν από 3 χρόνια και 6 μήνες)

59 εμφανίσεις

TGI Web Services

All TGI Web Services use standard Simple Object Access Protocol (SOAP).
Please note that the available
Functions
,
parameters
,

&
results

may be occasionally updated and this document may be incomplete.

To view the most up
-
to
-
date
Service Info Page, or to view the Web Service Description Language
(WSDL), you may view our demo web service at:



http://ecom.tgiltd.com/sandbox/E2181/EcomWebService.dll

GetARInfo()


T
his Web Servic
e returns the current Accounts R
eceivable

information (including AR bucket values) for
each billto associated with a specified customer. It also returns the bucket captions established in E21
AR setup.

http://www.tgiltd.com/whitepapers/ecom21/TGI%20Web%20Services%20
-
%20GetARInfo.pdf

GetCustAddress
()


This Web S
ervice returns an array of either 1) all customer
records

added to E21 after a specified date,
or 2) all billto / shipto
address info

linked to a specified customer. Use
GetCustAddress
() to synchronize
your Ecommerce customer tables with E21, or to simply retrieve
linked billing a
nd shipping data in real
time.

http://www.tgiltd.com/whitepapers/ecom21/TGI%2
0Web%20Services%20
-
%20GetCustAddress
.pdf

GetCustInfo()


This Web Service returns detailed Customer, Shipto, or Billto information for a specified customer.

http://www.tgiltd.com/whitepapers/ecom21/TGI%20Web%20Services%20
-
%20GetCust
I
nfo.pdf

GetDocNumb()


This Web Service returns the next available sequential docume
nt number (Quote, Order, Customer or
Contact) from the E21 system and increments the system so that document number is allocated for use
outside of the system. This would allow a 3
rd

party application to create transaction records outside of
the E21 syste
m using actual E21 document numbers. These records would then need to be uploaded
offline (either in batch or manually) to be available within E21.

http://w
ww.tgiltd.com/whitepapers/ecom21/TGI%20Web%20Services%20
-
%20GetDocNumb.pdf

GetLoginInfo()

This Web Service can be used either to validate whether a
login already exists within the E21
database
, or

to
determine if a
[Login + Password] combination
is val
i
d
.

http://www.tgiltd.com/whitepapers/ecom21/TGI%20Web%20Services%20
-
%20GetLoginInfo.pdf

GetOrderDetail()


This Web Service returns all relevant information p
ertaining to a single order. This includes all header
information such as order number, status, dates, terms, billing info, shipping info etc., as well as item
information such as product codes, product price, order & ship quantities, etc. The function als
o returns
arrays of invoice and shipment tracking info.

http://www.tgiltd.com/whitepapers/ecom21/TGI%20Web%20Services%20
-
%20GetOrderDetail.pdf

GetOrderHist
ory()


This Web Service returns the summarized
history for all orders placed
for
a

specified
customer filtered
by date (past 30 days, past 90 days, past year, etc). Once order history has been retrieved you may use
GetOrderDetail
() to return specific orde
r information.

http://www.tgiltd.com/whitepapers/ecom21/TGI%20Web%20Services%20
-
%20GetOrderHistory.pdf

GetPartInfo()

This web service returns
customer specific
E21 product information such as pricing, availability, etc.


GetPartInfo()

is being kept for legacy systems, however, it has been replaced by GetPart
s
Info() which
should be used for all new development

http://www.tgiltd.com/whitepapers/ecom21/TGI%20Web%20Services%20
-
%20GetPartInfo.pdf

GetPartsInfo()

This web service returns an array of customer specific
E21 product information such as pricing,

availability, etc. It allows you to filter the results by specific product code(s), or any field(s) from the
product master (such as alternate codes, product groups, etc). It can also return matches of keyword
search strings.

http://www.tgiltd.com/whitepapers/ecom21/TGI%20Web%20Services%20
-
%20GetPartsInfo.pdf

GetZipInfo()


This Web Service returns all valid cities and the state for a specified zip code. Depending on the
specified instructions, it also can validate that the passed city and state are valid for the associated Zip. It
should be called at the time the user enter
s address information before the info is posted.

http://www.tgiltd.com/whitepapers/ecom21/TGI%20Web%20Services%20
-
%20GetZipInfo.pdf

LoadCustCodes()


This Web S
ervice returns an array of either 1) all customer codes added to E21 after a specified date, or
2) all billto / shipto codes linked to a specified customer. Use LoadCustCodes() to synchronize your
Ecommerce customer tables with E21, or to simply retrieve
linked billing and shipping data in real time.
Once you have retrieved the customer codes from LoadCustCode(), loop on the GetCustInfo() web
service to retrieve detailed customer information.

LoadCustCodes
()

is being kept for legacy systems, however, it has been replaced by Get
CustAddress
()
which should be used for all new development
. GetCustAddress() accepts
the

same parameters as
LoadCustCodes
()
, however it returns
both the applicable cust/bill/ship codes AND the
associated
a
ddress infomration
. This allows you to return all data in one WS call.


http://www.tgiltd.com/whitepapers/ecom21/TGI%20Web%20Services%20
-
%20LoadCustCodes.pdf

PostContact()

Use the PostContact() web service to p
ost a contact update into the E21 system. Currently this is
used exclusively for

updating
existing
customer contacts, but in the future you will be able to add
additional contacts to a specified customer as well. Please note that when using this web service, only
the
contact

information is updated (not the customer information).

http://www.tgiltd.com/whitepapers/ecom21/TGI%20Web%20Services%20
-
%20PostContact.pdf

PostOrder()

Use the PostOrder() web service to p
ost an order into the E21 syst
em. Called at the time the
Ecommerce order is submitted, PostOrder() accepts Ecommerce order information, validates & posts
the order into the E21 system, and returns E21 Order information.

http://www.tgiltd.com/whitepapers/ecom21/TGI%20Web%20Services%20
-
%20PostOrder.pdf

PostRegistration()

Use the PostRegistration() web service to p
ost user registration information into the E21 system.
Called at the time the user registers, PostRegistration() accepts customer login and account information,
validates & posts the information into the E21 system, and returns E21 generated customer & co
ntact
codes.

http://www.tgiltd.com/whitepapers/ecom21/TGI%20Web%20Services%20
-
%20PostRegistration.pdf

Code Samples

All sample programs have been generously dontated by existing TGI customers. As such, some methods
names, URLS, variables etc., have been redacted. Samples may be outdated and are simply provided as
a courtesy to developers as a starting point for web se
rvice integration.

Access Demo TGI
Web

Service
getPartsInfo
from JOOMLA using PHP

The following is a sample of a JOOMLA plugin written in PHP which calls the getPartsInfo() web service
and based on the results displays either the information for a single
product, or an option for a user to
select a valid product for pricing if multiple products are returned. This sample also contains code to call
getPartInfo if required.

h
ttp://www.tgiltd.com/whitepapers/ecom21/sample%20joomla%20plugin.zip


Access Demo TGI
Web

Service
postOrder
using PHP

The following is a very simple call to postOrder using PHP

h
ttp://www.tgiltd.com/whitepapers/ecom21/sample%20postOrder.zip


Testing

Download the TGI Web Service Test Client

Use the TGI Web Service Test Client to interface with our demo web services

http://www.tgiltd.com/whitepapers/ecom21/TestEcomWS.zip


Testing TGI Web Service Soap Envelope Request & Response values using
Google Chrome REST Console (With Sample SOAP Envelopes)


http://www.tgiltd.com/whitepapers/ecom21/TGI%20Web%20Services%20
-
%20Testing%20With%20REST%20Console.pdf


Miscellaneous

System Requirements

Breaking Changes