How to use PinnacleCart API Documentation

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 from your cart.

Applies to Version(s): 3.7.X - 3.8.2r2 (or Current)

PinnacleCart Documentation

Note: 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 acceptence 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.

Note:The pinnacle WSDL file can be found at: https://www.YourSiteName.com/content/admin/plugins/openapi/index.php?username=YourApiUserName&password=YourApiPassword&token=YourApiToken&apiType=soap&wsdl=1

XML

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

JSON

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

How do I find the API in my cart?

Note: Each cart has a different area to find this, it can be easily found by using the Search function in each cart by just using API

When you access the Administrator of your Cart you will go to Settings>Advanced Settings>API Access then you will see a screen that looks like the following:

You will want to Enable the API, create a Username and the create a Password

Note: Important to remember this Password as if you create a new one, you will have to add that into each of your API calls

The Token is pre-generated, but if you would like to generate a new token you can do this by using the "Generate" button.

How do I use the API?

Note: This is just a brief overview and simple to the point, this doesn't get to indepth 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> ....etc.

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:

In the Example above you can see a 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.

How to Enable The PinnacleCart API

If you didn't get your question answered, please contact the Pinnacle Cart 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

Was this article helpful?
0 out of 0 found this helpful