CS-Cart

The CS-Cart modules allow you to search, list, retrieve, create, update, and delete the orders, products, taxes, shipments, and vendors items from your CS-Cart account.

Getting Started with CS-Cart

Prerequisites

  • A CS-Cart account - create an account at cs-cart.com.

[Note] Note

The module dialog fields that are displayed in bold (in the {{Make}} scenario, not in this documentation article) are mandatory!

Connecting CS-Cart to {{Make}}

To connect your CS-Cart account to {{Make}} you need to obtain the API Key from your CS-Cart account and insert it in the Create a connection dialog in the {{Make}} module.

1. Log in to your CS-Cart account.

2. Click the Profile Icon>Account Settings.

3. Click Developer and then copy the API Key to your clipboard.

4. Log in to your {{Make}} account, add a module from the CS-Cart app into an {{Make}} scenario.

5. Click Add next to the Connection field.

61e825d142a64.gif

6. In the Connection name field, enter a name for the connection.

7. In the API Key enter the details copied in step 3 and click Continue.

The connection has been established.

Orders
Search Orders

Searches for orders or lists them all.

Connection

Establish a connection to your CS-Cart.

Limit

Set the maximum number of projects {{Make}} should return during one execution cycle. The default value is 10.

Get an Order

Retrieves an order specified by ID.

Create an Order

Creates a new order.

Update an Order

Updates an existing order.

Delete an Order

Deletes an order specified by ID.

Products
Search Products

Searches for products or lists them all.

Get a Product

Retrieves a single product specified by ID.

Create a Product

Creates a new product.

Update a Product

Updates a product specified by ID.

Delete a Product

Deletes a product specified by ID.

Taxes
List Taxes

Lists all available taxes.

Get a Tax

Retrieves info about the tax specified by ID.

Create a Tax

Creates a new tax.

Update a Tax

Updates info of a tax specified by ID.

Delete a Tax

Deletes a tax specified by ID.

Shipments
List Shipments

Lists all Shipments

Get a Shipment

Retrieves info about the shipment specified by ID.

Create a Shipment

Creates a new shipment for an order.

Delete a Shipment

Deletes a shipment specified by ID.

Vendors
Search Vendors

Searches for vendors or lists them all.

Get a Vendor

Retrieves a vendor specified by ID.

Create a Vendor

Creates a new vendor.

Update a Vendor

Updates a vendor specified by ID.

Delete a Vendor

Deletes a vendor specified by ID.

Other
Make an API Call

Performs an arbitrary authorized API Call.

Connection

Establish a connection to your CS-Cart.

URL

Enter a path relative to https://docs.cs-cart.com/latest/developer_guide/apiFor example: /1.0/projects/all. For the list of available endpoints, refer to the CS-Cart API Documentation.

Method

Select the HTTP method you want to use:

GET to retrieve information for an entry.

POST to create a new entry.

PUT to update/replace an existing entry.

PATCH to make a partial entry update.

DELETE to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - List Projects

The following API call returns all the projects from your CS-Cart account:

URL: /1.0/projects/all

Method: GET

Matches of the search can be found in the module's Output under Bundle > Body. In our example, 6 projects were returned: