The PinnacleCart API can help you connect your cart to Facebook, Google and be used for functions such as pulling specific orders or all orders. In this article, we'll show you the basics of using our API that we can support and help you with. The API in our cart is used to speak with Shipping Carriers and Payment Gateways as well as pull basic information in your cart.



Applies to Version(s): 3.9 or Current


In this article, you will learn


PinnacleCart Documentation for the API

How do I find the API in my cart

How to use the API

 

Overview


PinnacleCart Documentation


We regret that we cannot provide support or assistance with the PinnacleCart API as part of our support services. We can check your URLs with the use of the information in the documentation, but won't be able to help with your scripts. We do have a Professional Services team that will build out whatever you need. 


Our PinnacleCart Documentation can be found at support.pinnaclecart.com or by using this API Documentation direct link. Our API supports SOAP/WSDL, XML and JSON


SOAP/WSDL 

SOAP, or Simple Object Access Protocol, is a protocol for exchanging information. It is a widely adopted standard for communication between web services and consumers. Support for SOAP is built into almost every major IDE and/or framework upon which components expected to communicate with the web are built. WSDL, or Web Services Description Language (WSDL, pronounced 'wiz-dəl'), is an XML-based language that provides a model for describing Web services. SOAP Web-services are often described using WSDL. The advantage of SOAP is its wide acceptance and strong-typing and predefined call description, which makes integration nearly automatic in many frameworks. The disadvantage is, compared to XML or JSON, it is a bit more difficult for the average developer to use.


XML

XML, or eXtensible Markup Language, is a widely-used language for exchanging information. Every major modern language/framework has an XML parser. The advantage of XML is its wide acceptance and ease of use.


JSON


JSON, or Javascript Object Notation, is a widely-used language for exchanging information, usually between web-clients and servers via AJAX.


How to find and enable the API in my Cart


Each cart has a different area to find this, it can be easily found by using the Search tab.

  1. Type API in the search tab. 
  2. Click API access in the search results.
  3. Tick the box to enable API
  4. You will be prompted to create a Username and Password.
  5. To get security token, click Generate.
  6. Click Save.


Note: Important to remember this password because you will have to add it into each of your API calls.



How to use the API


Note: This is just a brief overview about the API function. This doesn't go too in-depth on pulling smaller portions of data from the cart. 


The basic format or setup for a call will look something like this:


https://www.YourSiteName.com/content/admin/plugins/openapi/index.php?username=<YourApiUserName>&password=<YourApiPassword>&token=<YourApiToken>&apiType=<xml|soap|json>&call=<CallName>&<Arg1>=<Arg1Value>&<Arg2>=<Arg2Value>&<Arg3>=<Arg3Value


So say we wanted to see all orders in an XML output, my URL from the image would look something like this:


https://chrisgust.pinnaclecart.com/cart380//content/admin/plugins/openapi/index.php?username=Gusto3232&password=Viking3232&token=r8cEWa9scTyYyC39myfGAjxXuTTCpwhDPq4i99XV0bz4gACUCXZXv60W8OErOD5c&apiType=xml&call=GetOrders


This is now telling the API to retrieve all orders from the Database in the Documentation that is provided you will see a Call Reference on the Left-Hand side, those are your Call References to use. As you can see in the Documentation, GetOrders is all I need to add at the end. 


Now before that call, you can see XML. This is telling the API how I want to retrieve the information, and going back to the top of the Article. I mentioned the Supported Protocols that were used by this API. You can use JSON, and SOAP/WSDL to query the information as well. 


Here is an example of what the Call from my test cart looks like when I call for Orders:


sample-URL-call


In the example above you can see single order information - OrderId, OrderNumber, Status, etc. That URL call will pull all the orders for your cart at once so if you're searching for a bit information, you can do a CTRL+F function in your browser to search. 


Note: All API calls must be secure (https://). 



Links to Related Articles

API Documentation



If you didn't get your question answered, please contact the PinnacleCart Support Team. To submit a ticket, go to the My Account drop-down menu at the top right of the admin area and select Support.