Welcome to CoreCommerce's XML API Documentation

We will discuss all of the endpoints you can connect to, how to connect to them, and what each endpoint will give you back in response. 


We will begin by listing a brief summary of what the API can do and what it can not do.


What the API can do:

  • Retrieve a List of Products, Categories, Orders, or Customers.
  • Add or Update Product or Category Info
  • Update Order Info like Statuses, Billing Info, Shipping Info, Tracking Info
  • Update Customer Info


Specific things to mention that the API can NOT do:

  • Run Credit Card Transactions when Adding an Order
  • Give Shipping Quotes
  • Calculate Tax that has not already been saved with an order


Lets go over the different Endpoints and what they all do. 


If you want to learn about how to authenticate and where the auth values are created, go to this article.


Click below to go directly to the page specific to that endpoint:


CATEGORY ENDPOINTS

Category ADD

This will allow you ADD a new category to your CoreCommerce store.



Category EDIT

This will allow you EDIT an existing category in your CoreCommerce store.



PRODUCT ENDPOINTS


Product LIST

This will allow you REQUEST A LISTING OF PRODUCTS from your CoreCommerce store, based on different search criteria. 


COMING SOON


Product ADD

This will allow you ADD a new product to your CoreCommerce store.


COMING SOON


Product EDIT

This will allow you EDIT an existing product in your CoreCommerce store.


COMING SOON


Product DELETE

This will allow you DELETE an existing product from your CoreCommerce store.



ORDER ENDPOINTS

Order LIST

This will allow you REQUEST A LISTING OF ORDERS from your CoreCommerce store, based on different search criteria. 


COMING SOON


Order ADD

This will allow you ADD an order that originated from a different source into your CoreCommerce store.

**This does not run credit card transactions when adding orders.


COMING SOON


Order EDIT

This will allow you EDIT an existing order in your CoreCommerce store.

**This does not process any credit card transactions or credits. You can edit the total within the order, but it will not talk to a gateway or credit the transaction itself. 


COMING SOON


Order DELETE

This will allow you DELETE an existing order from your CoreCommerce store. 

**This will NOT credit any credit card transaction, and it will NOT replenish any inventory levels of products in the order.




CUSTOMER ENDPOINTS


Customer LIST

This will allow you REQUEST A LISTING OF CUSTOMER from your CoreCommerce store, based on different search criteria. 




Customer ADD

This will allow you ADD a customer into your CoreCommerce store.




Customer EDIT

This will allow you EDIT an existing customer's details in your CoreCommerce store.



Customer DELETE

This will allow you DELETE an existing customer from your CoreCommerce store. 

**Deleting a customer will NOT delete any order history tied to that customer for reporting.