Got questions? Leave your message here or Schedule a quick call with our manager now

Getting Started

You can use the parameter verify=false to skip the validation.
You need to specify store admin username and password, no API key is required.

First, go to the Account Manager page (https://account.demandware.com/dw/account/Home), generate dw_client_id (Client Id) and dw_api_pass (Api Password).

Please provide the API client name and password, and select your organization.

Add the necessary roles for your API client and allowed scopes.

You can find a list of scopes here:
https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog

Select "client_secret_post" for the Token Endpoint Auth Method field.

For the Redirect URIs field, specify your Redirect URI.

For a detailed guide on creating an API Сlient in Demandware, you can find it at the following link.

The API Сlient ID and password created during setup will be used as parameters "demandware_client_id" and "demandware_api_password" when adding a store on Api2Cart.

Then, add permissions for API2Cart API, so that our API could retrieve data from the store. Go to your Admin panel: Administration > Open Commerce API Setting > Select type: Shop & Data > Select context: Global

Then, specify client application-specific configurations:

For Type Shop:

Global permissions

  
  {
    "_v":"22.6",
    "clients":[
       {
          "client_id":"YOUR_CLIENT_ID",
          "allowed_origins": [

          ],
          "resources":[
             {
                "resource_id":"/products/*/prices",
                "methods":["get"],
                "read_attributes":"(**)",
                "write_attributes":"(**)",
                "config":{
                   "product.prices.price_book_ids":"PRICE_BOOK_ID_1,PRICE_BOOK_ID_2,...,PRICE_BOOK_ID_N"
                }
             },
             {
                "resource_id":"/**",
                "methods":[
                   "put",
                   "get",
                   "post",
                   "patch"
                ],
                "read_attributes":"(**)",
                "write_attributes":"(**)"
             }
          ]
       }
    ]
  }
  

Or per resource permissions

  
  {
  "_v": "22.6",
  "clients": [
    {
      "client_id": "YOUR_CLIENT_ID",
      "allowed_origins": [],
      "resources": [
        {
          "resource_id": "/products/*/prices",
          "methods": [ "get" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)",
          "cache_time": 0,
          "config": {
             "_comment": "Add a comma-separated list of the price book ids currently active in the organization",
             "product.prices.price_book_ids": "REPLACE_ME_WITH_PRICE_BOOK_IDS"
          }
        },
        {
          "resource_id": "/baskets",
          "methods": [ "post" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/baskets/*",
          "methods": [ "get", "patch", "delete" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/baskets/*/billing_address",
          "methods": [ "put" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/baskets/*/coupons",
          "methods": [ "post" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/baskets/*/coupons/*",
          "methods": [ "delete" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/baskets/*/customer",
          "methods": [ "put" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/baskets/*/gift_certificate_items",
          "methods": [ "post" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/baskets/*/items",
          "methods": [ "post" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/baskets/*/items/*",
          "methods": [ "patch", "delete" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/baskets/*/notes",
          "methods": [ "post", "get" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/baskets/*/payment_instruments",
          "methods": [ "post" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/baskets/*/payment_instruments/*",
          "methods": [ "patch", "delete" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/baskets/*/payment_methods",
          "methods": [ "get" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/baskets/*/shipments",
          "methods": [ "post" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/baskets/*/shipments/*",
          "methods": [ "patch" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/baskets/*/shipments/*/shipping_address",
          "methods": [ "put" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/baskets/*/shipments/*/shipping_method",
          "methods": [ "put" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/baskets/*/shipments/*/shipping_methods",
          "methods": [ "get" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/baskets/*",
          "methods": [ "post" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/customers",
          "methods": [ "post" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/customers/auth",
          "methods": [ "post" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/customers/password_reset",
          "methods": [ "post" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/customers/*",
          "methods": [ "get", "patch" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/customers/*/addresses",
          "methods": [ "get", "post" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/customers/*/addresses/*",
          "methods": [ "get", "patch", "delete" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/customers/*/baskets",
          "methods": [ "get" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/customers/*/orders",
          "methods": [ "get" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/customers/*/password",
          "methods": [ "put" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/customers/*/payment_instruments",
          "methods": [ "get", "post" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/customers/*/payment_instruments/*",
          "methods": [ "get", "delete" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/orders",
          "methods": [ "post" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/orders/*",
          "methods": [ "get", "patch" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/orders/*/notes",
          "methods": [ "get", "post" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/orders/*/payment_methods",
          "methods": [ "get" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/orders/*/payment_instruments",
          "methods": [ "post" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/order_search",
          "methods": [ "post" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/products/*",
          "methods": [ "get" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/products/*/availability",
          "methods": [ "get" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)",
          "cache_time": 0
        },
        {
          "resource_id": "/site",
          "methods": [ "get" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/categories/*",
          "methods": [ "get" ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        }
      ]
    }
  ]
}
  
For Type Data

Global permissions


{
  "_v":"22.6",
  "clients":[
     {
        "client_id":"YOUR_CLIENT_ID",
        "resources":[
           {
              "resource_id":"/**",
              "methods":[
                 "put",
                 "get",
                 "post",
                 "patch"
              ],
              "read_attributes":"(**)",
              "write_attributes":"(**)"
           }
        ]
     }
  ]
}

Or per resource permissions

      
      {
  "_v": "22.6",
  "clients": [
    {
      "client_id": "YOUR_CLIENT_ID",
      "resources": [
        {
          "resource_id": "/sites",
          "methods": [
            "get"
          ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/sites/**",
          "methods": [
            "get"
          ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/catalog_search",
          "methods": [
            "post"
          ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/product_search",
          "methods": [
            "post"
          ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/products/*",
          "methods": [
            "get",
            "patch"
          ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/products/*/variant_search",
          "methods": [
            "post"
          ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/products/*/variations",
          "methods": [
            "get"
          ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/products/*/variation_attributes",
          "methods": [
            "get"
          ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/customer_lists/**",
          "methods": [
            "get",
            "post"
          ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/inventory_lists/*",
          "methods": ["patch"],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/inventory_lists/*/product_inventory_records/*",
          "methods": ["patch", "put", "get"],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
           "resource_id":"/system_object_definitions/**",
           "methods":["get", "put" , "patch", "post", "delete"],
           "read_attributes":"(**)",
           "write_attributes":"(**)"
        }
      ]
    }
  ]
}
      
    
To install SDK, download an SDK file for programing language you need.
To install SDK for PHP language, download the file, and run "composer install" command from it.
We don’t have composer packages.
In order to connect Amazon SP-API to API2Cart account, you need to fill out the credentials, which is shown in the screenshot below: Amazon SP API store parameters The seller account that is planned to be connected to API2Cart must have an active "Professional" selling plan at Amazon.

We recommend reading the original guide from the Amazon Selling Partner API Developer Guide.

1. amazon_seller_id - can be seen in Sellercentral -> Settings -> Account Info -> Business Information -> Merchant Token. Direct link: https://sellercentral.amazon.com/sw/AccountInfo/MerchantToken/step/MerchantToken How to connect Amazon SP-API to API2Cart? 2. To determine which value should be substituted into amazon_sp_aws_region you need to use the table Selling Partner API endpoints.

Selling region AWS Region
North America (Canada, US, Mexico, and Brazil marketplaces) us-east-1
Europe (Spain, UK, France, Belgium, Netherlands, Germany, Italy, Sweden, South Africa, Poland, Saudi Arabia, Egypt, Turkey, United Arab Emirates, and India marketplaces) eu-west-1
Far East (Singapore, Australia, and Japan marketplaces) us-west-2

For example, if the seller sells in the US, you must select us-east-1.

3. To get amazon_sp_client_id and amazon_sp_client_secret you need to go to an Amazon seller account registered as a developer. If there is no such an account, you have to register a seller account, and then register in it as a developer here - Register as a developer.

Go to Developer Central and add a new client.

Develop Apps Add new client Create SP API app

Click “View” to see amazon_sp_client_id and amazon_sp_client_secret.

LWA credentials

Please note that the lifetime of amazon_sp_client_id and amazon_sp_client_secret credentials is limited to 180 days. Therefore, you should periodically update them in the "Amazon developer console" and then in our system using the account.config.update method.

4. To get the last parameter - amazon_sp_refresh_token you need to implement OAuth authentication in one of the following ways:
  1. Website workflow
  2. Marketplace Appstore workflow
  3. Self authorization

Let's consider the 3rd way, it is the most convenient when you need to quickly get an amazon_sp_refresh_token to test the work.

Autorize app Copy the refresh token 5. Now, when you have all the necessary credentials, you can add a store in API2Cart. Add store Important details:
  • Amazon restricts API access to personally identifiable information (PII), such as addresses in orders. If your app requires this data, you need to get access to it. To do this, you need to select the “Direct-to-Consumer Shipping” role and fill out the application form on Amazon Developer Profile https://sellercentral.amazon.com/developer/register

  • We do not have our app with access to personal data, and we do not plan to do so because, in this case, we would be forced to place our app on the Amazon marketplace. That will cause a white label will be impossible, and sellers must install the API2Cart app instead of your app.

  • Sometimes you may get the API2Cart response with an error "Report is not ready yet, please try again later (report_request_id=XXXXXXXXXXXX)". This is because the Amazon API, in many cases, does not provide real-time data, so API2Cart is forced to work through the Reports API. For example, when requesting "product.list" or "product.info", API2Cart requests a report and waits for its result, the maximum waiting time is 15 seconds, and if the report information is not ready during this time, the above error text will be returned. When receiving this error, you need to wait 1-5 minutes and try to repeat the request with the same parameters. Reports are cached on our side for 15 minutes. If you pass the parameter disable_report_cache=true, the cache is not used.

To add eBay to Api2Cart, the following parameters are required:

  • ebay_client_id: eBay Client ID
  • ebay_client_secret: eBay Client Secret
  • ebay_refresh_token: eBay Refresh Token
  • ebay_environment: eBay Environment (Sandbox or Production)
  • ebay_site_id: eBay Site ID (optional, default is 0)

To obtain these parameters, you need to have a developer account on eBay.
To sign in or register, please visit the following page: https://developer.ebay.com/signin

Application Keys are available on the following page: https://developer.ebay.com/my/keys
Depending on the environment (Sandbox or Production), you will need the App ID (ebay_client_id) and Cert ID (ebay_client_secret).

To obtain the ebay_refresh_token, select User Tokens on the page that opens.

In the Get a Token from eBay via Your Application section, add the eBay Redirect URL.

Fill in the fields for the added eBay Redirect URL and click Save. Enable the OAuth Enabled checkbox for this eBay Redirect URL.

Then select OAuth and click Test Sign-In.

This will open a login page where you need to log in with your eBay seller account (for sandbox environment, you can register a test user at https://developer.ebay.com/sandbox/register).

After successful login with the seller account and confirmation of the application access request, you will be redirected to the URL specified in the Your auth accepted URL field. The redirect URL will include a code parameter in the following format:
code:v^1.1#i^1#r^1#p^3#f^0#I^3#t^Ul41Xzg6MDM5RENGM0E3NEIxNTJDQkU5QTRfMV8xI0VeMTI4NA==

This code is required to obtain the refresh token. To get the refresh token, send a POST request to https://api.ebay.com/identity/v1/oauth2/token (for production) or https://api.sandbox.ebay.com/identity/v1/oauth2/token (for sandbox) with the following parameters:

  • grant_type: authorization_code
  • redirect_uri: the URL specified in the "Your auth accepted URL" field
  • code: the code obtained (make sure it's not URL encoded)
Include basic authorization in the request as well.

Upon successful execution of the request, you will receive the refresh token, which is used as the ebay_refresh_token parameter when adding the eBay store to Api2Cart.

The ebay_environment parameter can be either Sandbox or Production, depending on the use case.

The ebay_site_id parameter (default is 0) is used to identify the eBay Site ID. More information can be found at https://developer.ebay.com/devzone/merchandising/docs/concepts/siteidtoglobalid.html.

eBay Marketplace Account Deletion/Closure Notifications Workflow

You should also pay attention to eBay Marketplace account deletion/closure. You need to subscribe to a webhook that will receive notifications about eBay Marketplace account deletions.

On the Alerts and Notifications page for the Production environment, select the Marketplace Account Deletion checkbox. You can choose to opt-out of receiving deletion notifications or subscribe to them.

To receive notifications, you need to prepare a callback that will respond with a specific response. Fill in the fields accordingly:

  • Callback URL: Fill in the URL of your callback endpoint.
  • Callback Method: Select the appropriate method (e.g., POST).
  • Request Headers: Define any required headers for the callback.
  • Request Body: Configure the request body format (e.g., JSON).

After clicking Save, eBay will send data that needs to be processed in a specific way and return a generated hash as a response.

Your callback endpoint should respond with the following JSON response:

{ "challengeResponse": "52161ff4651cb71888801b47bae62f44d7f6d0aab17e70d00f64fc84368ca38f" }

For an example, you can use a workflow on a service like https://pipedream.com/ with the appropriate code.

More details on how to do this can be found https://developer.ebay.com/marketplace-account-deletion.

After successful validation of the callback, the Send Test Notification button will become active.

Once everything is set up, eBay will start sending deletion account notifications to the specified URL.

To upload the bridge to Magento Commerce cloud stores and make it available on the URL, the store developer should do the following steps:

1) Add the bridge folder to the project root directory via GIT:

2) Edit the file .magento.app.yaml:

Add the following configurations:

"/bridge2cart":

root: "/"

passthru: "/bridge.php"

index:

bridge.php

expires: -1

scripts: true

allow: true

3) Push changes to the repository and merge them to master.

WooCommerce Plugin Installation

To add a plugin or an extension on WooCommerce:
  1. Go to your admin panel and click on ‘Plugins” menu -> "Add New"
  2. Choose API2Cart Connector and click “Install Now” button.
  3. After downloading the plugin, click “Activate Plugin” to get it rolling.
The plugin tab should now appear on your admin panel.


Magento Plugin Installation

To add a plugin or an extension on Magento 1:
  1. Go to the Magento admin panel and navigate System -> Magento connect -> Magento connect manager.
  2. Login with the same credentials you use to access your admin panel.
  3. Then under Direct package file upload you can Upload package file. Click the Choose File button, select the extension .tgz file, and click Upload. To ensure the plugin is installed correctly, use the PHP version that matches the Magento version requirements.
  4. If the version of PHP conflicts with the version of Magento in use, we suggest that you should install it using the following instructions:
    • Unzip the archive and upload the files to the server.
    • Clear the Magento cache by going into System-> Cache Management, selecting all in the list, choosing the Refresh option in the dropdown menu, and finally clicking Submit.
  5. Go to System-> Configuration and find API2CART Bridge in the menu on the left.

The installation process will begin and show a message when it’s finished. You can optionally click on “Refresh” button to see whether the extension is installed or not.


PrestaShop Plugin Installation

To perform the installation:
  1. Login into your Prestashop admin panel.
  2. Go to the module tab and click “Add a module from my computer”
  3. In “Module file” box click “Browse” button.
  4. Select module *.zip file from your computer.
  5. Complete the process by pressing “Upload this module” button.

The page will reload, and you should see the new module in a list of your modules.


Cs-Cart Plugin Installation

To perform the installation:
  1. Login into your Cs-Cart admin panel.
  2. Click on the navigation "Add-ons" -> "Manage Add-ons".
  3. Click on the "+" button to upload the plugin.
  4. In the dialog box that appears, click on the "Local" option to download the plug-in *.zip file
  5. Click the "Upload & install" to upload the installation.

After a successful installation, in the "Add-ons" page you will see the API2Cart plugin.


OpenCart Plugin Installation


Note: After any of these plugins is successfully installed, the store owner needs to give the information on his unique store key to B2B provider for the proper work through the API.

To connect Walmart store you will need:

  • Client Id
  • Client Secret
  • Walmart environment

Log in to the seller account and go to the API Key Management section. (Or you can switch to https://developer.walmart.com/ and log in there under your account).





There you can get access to existing keys for production and sandbox environments.



You can also generate a new pair of client id and client secret, providing full access for this key.



Use Client Id and Client Secret when adding store (walmart_client_id and walmart_client_secret parameters).

Parameter walmart_environment you can leave empty or specify the value production if the production key is used. In case the sandbox key is used be sure to specify the sandbox value for walmart_environment parameter.



This API is no longer supported by Etsy, use Etsy API V3 instead.

To connect Etsy account to API2Cart you’ll need to either:

  • - create an application with marketplace-wide access (needs to go through approval process by Etsy);
  • - or create private application that will have access to a single store data only.
  • Both could be done via link below:

https://www.etsy.com/developers/register

Once you register an account and you will receive following credentials for your app:

KEYSTRING

SHARED SECRET

how to integrate etsy
  1. Perform GET request to https://openapi.etsy.com/v2/oauth/request_token using Oauth 1.0 authorization

Consumer Key - KEYSTRING from step 1

Consumer Secret - SHARED SECRET from step 1

integrate etsy

Response body will look like “login_url=URL

You should urldecode URL and provide it to the account owner.

  1. Account owner follows URL, confirms application access to the account and receives VERIFICATION CODE.
etsy integration
  1. Perform GET request to https://openapi.etsy.com/v2/oauth/access_token?oauth_verifier=VERIFICATION CODE

Using Oauth 1.0 authorization

Consumer Key - KEYSTRING from step 1

Consumer Secret - SHARED SECRET from step 1

Access Token=(oauth_token from URL from step 2)

Token Secret=(oauth_token_secret from URL from step 2)

Verifier=(VERIFICATION CODE from step 2)

Response should look like

oauth_token=<ACCESS TOKEN>&oauth_token_secret=<TOKEN SECRET>

  How to connect Etsy to API2Cart?
  1. Finally you can connect Etsy store in your API2Cart account using the following parameters: KeyString - KEYSTRING from step 1

Shared Secret - SHARED SECRET from step 1

Access Token - ACCESS TOKEN from step 4

Secret Token - TOKEN SECRET from step 4


To connect Ecwid store via API2Cart, you need to register and list your branded External APP on Ecwid App Marketplace. It will only serve to receive OAuth Access Token which is later on used to add a store to the API2Cart system.


Find out what you need to register here.


During the registration process, you will need to specify OAuth Scopes - the resources that will be accessed through Ecwid API. That will directly affect which of our methods will work through the Access Token that your App receives.


Why do you need to register your App?


If API2Cart lists its App on the Ecwid marketplace, then the store owner will install the API2Cart App, not yours


Ecwid API works only on a paid subscription. For more details click here.


However, you can specify that you need such an account for testing and the Ecwid team will provide you with a paid account for free for development and testing purposes.


If you have an Ecwid store with a paid subscription, you can get an Access Token without waiting for the approval of your APP. To do this, you need to install the "Play with Ecwid API and Postman" App.


  • 1. Install App by clicking on the link

  • 2. After installation, click “Connect with Ecwid”

  • 3. Next, you need to copy Postman collection url

  • 4. Import collection


  • 5. Copy the token from the request settings


  • 6. Add a store to API2Cart. To do this, you need to specify:

  • - Ecwid Store Id (where to get it you can find here)
  • - Ecwid Access Token (value received in step 5)
  • - Store Url (which can be found in the Ecwid Control Panel)

To connect CommerceHQ store to API2Cart and start working with the data from it, you need to register a new account.

To add the store built on CommerceHQ, you will need to have the Store URL, commercehq_api_key and commercehq_api_password.

To get commercehq_api_key and commercehq_api_password, you have to create a Private App in CommerceHQ admin panel.

For that go to Dashboard, choose Apps Store in the menu, press the button Add a Private App.

After the creation of Private App, you will see the required data for connecting CommerceHQ store to API2Cart.

There are two ways to connect Squarespace to API2Cart. To connect Squarespace to API2Cart using the first method, utilizing the squarespace_api_key parameter, follow these steps:

The first method, using the squarespace_api_key parameter, does the following:

 
  • To get squarespace_api_key:
 

It would be best if you went to the Squarespace administrator panel. Click on 'Settings,' select the 'Advanced' option from the menu, click 'Developer API Keys,' and then 'Create Key.'


If you plan to use webhooks on Squarespace, please connect using the second method. To connect Squarespace to API2Cart using the second method, utilizing squarespace_client_id, squarespace_secret, squarespace_access_token, squarespace_refresh_token parameters, follow these steps:
  1. Obtain your client_id and client_secret:

    • Fill out the form at https://partner.squarespace.com/oauth-form to get your_client_id and your_client_secret.
    • The application processing is manual and may take up to 7 days. After approval, Squarespace support will send your client_id and client_secret to the provided email.

  2. Authorize your application:

    • Go to the following link in your browser: https://login.squarespace.com/api/1/login/oauth/provider/authorize
    • Set the parameters:

      • client_id - obtained in step 1
      • redirect_uri - callback URL for receiving POST requests with data
      • scope - required scopes (e.g., website.orders, website.orders.read, website.transactions.read, website.inventory, website.inventory.read, website.products, website.products.read)
      • state - any value for CSRF protection, to be used in step 3
      • access_type - set as "offline"
      • After clicking "Allow," you will be redirected to the specified callback URL with a parameter code, which is needed for the next step.
  3. Exchange the code for tokens:

    • Make a POST request to the URL https://login.squarespace.com/api/1/login/oauth/provider/tokens with the following parameters:

      • grant_type - set to "authorization_code" for the first request and "refresh_token" for token refresh
      • code - the value obtained in step 2
      • redirect_uri - the URL to which the request with parameters will be sent
      • refresh_token - specify the refresh_token in case of token refresh and grant_type=refresh_token

  4. Use the obtained tokens in your application:

    • After step 3, you will receive a POST request to the callback URL specified in step 2 with the necessary parameters, including access_token and refresh_token.
    • Fill out the form in your application using the parameters:

      • squarespace_client_id - client_id from step 1
      • squarespace_client_secret - client_secret from step 1
      • squarespace_access_token - access_token from step 3
      • squarespace_refresh_token - refresh_token from step 3

Getting credentials

Create a client

Set token lifetime

To work with orders endpoint, you need to add a store with the parameters hybris_username, hybris_password.

Also, the user must belong to groups such as customersupportagentgroup and customermanagergroup.

To work with warehouses and get store data via cart.info, the admin user must also belong to a group warehouseadministratorgroup.

This can be done by simply assigning the user to a group, or if the user is already in a group and there is a need to expand its capabilities, then you can add its subgroup to the group.

If everything is done correctly, you can add a store.

The parameter hybris_websites is an array of objects in a JSON string with the following structure:

If, when trying to add a store, an error occurs due to incorrect permissions, for example, due to the absence of a group, it is necessary to delete the incorrectly generated OAuth Access Token. If you try to regenerate it, Hybris will still give the same token until it expires.

To connect Lightspeed store to API2Cart you need to specify the following credentials:

  • lightspeed_api_key
  • lightspeed_api_secret

There are two ways to get them:

  1. The store owners can contact the LightSpeed Customer Service department in order to receive api_key and api_secret credentials.
  2. You can develop your App and publish it on LightSpeed App Store. After that, you will get APP_KEY and APP_SECRET. Then you should specify the callback URL to which store credentials come. You can do it in the partner environment (Under ‘Apps > (APP NAME) > Success URL’).

When the store owner installs your App, credentials to the store will come to your callback URL (language, shop id, signature, timestamp, token, and cluster_id). From all the credentials you need only a token.

Now you have credentials needed for adding Lightspeed store to API2Cart.

  • lightspeed_api_key = APP_KEY
  • lightspeed_api_secret = md5(token + APP_SECRET);

More info you can find on LightSpeed docs.

To integrate with Shift4Shop via the REST API, you need to create and authorize an application with necessary scopes for the store. To do this, you need to have a Shift4Shop developer account https://developer.3dcart.com/".

In the dashboardhttps://devportal.3dcart.com/dashboard.asp you need to create a new application.

Choose the necessary scopes.

It is recommended to select all scopes, because after adding the store they cannot be changed.

Next, you need to authorize this application in your store.

After that, you will be redirected to a page where you will need to specify the URL of the Shift4Shop store.

Next, you will be redirected to a page where you need to accept the terms and authorize the application on the store.

After that, information about the store will appear on the application page in the dashboard.

To connect Shift4Shop to API2Cart, you need a private_key and an access_token credentials.

Follow these steps to connect PrestaShop API to API2Cart:

  1. Visit PrestaShop. Go to the Advanced Parameters -> Webservice
  2. PrestaShop-API-to-API2Cart

  3. Add a new webservice key
  4. PrestaShop-API-to-API2Cart2

  5. Generate Key and permit access
  6. PrestaShop-API-to-API2Cart3

  7. Enable PrestaShop's webservice
  8. PrestaShop-API-to-API2Cart-4

  9. After the previous steps, you must go to the API2Cart APP and choose the Add store option. Then, you need to choose PrestaShop API, fill in all the required fields, and press the button Add
  10. PrestaShop-API-to-API2Cart-5

To integrate with Wix, you need to have a Wix developer account https://dev.wix.com/.

1. First of all, you need to create your own application.

Specify Redirect URL and App URL.

On this page, you should copy App ID and Secret Key which will be needed in the next steps.

You also need to select the necessary permissions. The minimum required permissions to add a store to API2Cart are full access to Wix Stores -> Read Stores, Wix Developers -> Manage Your App and Business Info -> Manage Consent Policy.

It is worth giving full access here. If you change permissions later, you will have to re-add the application to the store.

2. Next, you need to add an application to the store.

Here you should select added store or add the new one.


Next, the window opens with a page you specified in the App URL. You need to copy the token from the URL.

3. Here you form the URL for installing the application. Note: You need to obtain approval from the Wix and list of your application on the Wix Marketplace.

    https://www.wix.com/installer/install?code=<code>&appId=<app_id>&redirectUrl=<redirect_url></redirect_url>
    

code is the token that you copied in the previous step.

After that, you should follow this URL in a browser and click Add to Site.

Next, there will be a redirect to redirectUrl, where you need to take the code from the URL.

4. After that you need to make the following request:

curl -X POST \
  https://www.wixapis.com/oauth/access \
  -H 'Content-Type: application/json' \
  -d '{
    "grant_type": "authorization_code",
    "client_id": <APP_ID>,
    "client_secret": <APP_SECRET>,
    "code": <AUTH_CODE>
}'

As a result, you get refresh_token.

5. In order to add a store to API2Cart you need to specify the following fields:

In order to connect Magento 2 API to API2Cart, you need to do the following:

  1. Choose Integrations in the menu (System -> Integrations)

  2. magento 2 api
  3. Press the button "Add New Integration"

  4. Enter the name and data of the admin account

  5. In the API tab, set access to all entities. After that, choose "Save"

  6. Activate the integration


  7. Fill in the received data for authorization on the API2Cart APP

To integrate with Zid platform, you need to follow this instruction.

  1. In order to get the needed credentials, you need to have a Zid developer account https://partner.zid.sa/.
  2. It is necessary to create an application.

    Instruction-on-Zid-integration

    All information can be filled in English and Arabic.

    Instruction-on-Zid-integration-1

    It is required to select the necessary scopes. It is recommended to select all permissions because, in case of their change, you will need to get all tokens again. The page below contains the Client ID and Client Secret that will be needed to receive the tokens.

    Instruction-on-Zid-integration-2

    Next, you need to fill in detailed information about the application.

    Instruction-on-Zid-integration-3

    There is no need to fill in anything on the following page.

    Instruction-on-Zid-integration-4

    On this page, if necessary, you can set up a paid subscription to the application.

    Instruction-on-Zid-integration-5
  3. It is necessary to generate a URL for adding the application to the store, using the data from the previous step.
  4. https://oauth.zid.sa/oauth/authorize?client_id=&redirect_uri=&response_type=code

    After that, you need to use the mentioned URL in the browser. It is necessary to provide the access requested by the application.

    Instruction-on-Zid-integration-6

    As a result, it should redirect to the Redirect URL. You will see the code in the browser line.

    Instruction-on-Zid-integration-7
  5. You need to make a request.
  6. 
    curl -X POST \
      https://oauth.zid.sa/oauth/token \
      -H 'Content-Type: application/json' \
      -d '{
        "grant_type": "authorization_code",
        "client_id": ,
        "client_secret": ,
        "redirect_uri": ,
        "code": 
    }'
    

    The result of the request will be access_token, authorization and refresh_token.

    Instruction-on-Zid-integration-8

    To add a Zid store to API2Cart, you need to fill in the appropriate fields.

    Instruction-on-Zid-integration-9

To add a store from Etsy APIv3, you need etsy_client_id і etsy_refresh_token



etsy_client_id is a keystring of the App created in Development Apps. To manage your apps, go to https://www.etsy.com/developers/your-apps and add a new application.




For successful registration of the application, the store registration must be fully completed (all supporting documents sent to Etsy, connected card for payment, etc.), otherwise there may be nuances with the registration of the application or its authorization with OAuth 2.0 for further work.



Once an app is registered, Etsy reviews and approves it. After the Etsy app is approved, you can authorize it via Oauth 2.0 and perform requests.



You can do it with the help of a postman. For this, you need to create a new request and select the Oauth2.0 authorization type on the Authorization tab.




  • Token Name - an arbitrary name for the token to be used in postman
  • Grant Type - Authorization Code (With PKCE)
  • Callback URL - callback_url, which is registered for this application
  • Auth URL - https://www.etsy.com/oauth/connect
  • Access Token URL - https://api.etsy.com/v3/public/oauth/token
  • Client ID - keystring of created application (parameter etsy_client_id)
  • Code Challenge Method - SHA-256
  • Scope - following scopes can be used for the applicationі: address_r address_w billing_r cart_r cart_w email_r favorites_r favorites_w feedback_r listings_d listings_r listings_w profile_r profile_w recommend_r recommend_w shops_r shops_w transactions_r transactions_w
  • https://developer.etsy.com/documentation/essentials/authentication/ - here you can find the information about scopes
  • State - a one-time marker created specifically for this request. An arbitrary set of symbols and numbers.
  • Client Authentication - Send client credentials in body

When receiving a token, you need to confirm access permission for the application.



After successful authorization, we will receive a refresh_token, which can be used to add a store to the app.




Important! Please note that Etsy does not have a sandbox environment, and you must test your APP on a production store. Therefore, we advise you to read and strictly follow the API Testing Policy.

First, you must ensure that the WooCommerce REST API is working. The following conditions must be met:



Next, you need to create API keys:



The following fields must be filled in:



In the User field, you need to specify a user who has the Administrator role. The Permissions field must be Read/Write


As a result, we will get Consumer key and Consumer secret, which are needed to add a store to the API2Cart:



To add a store in the API2Cart admin panel, fill in the fields as follows:



Troubleshooting

If you receive the following message while adding a store:


First of all, you need to check whether you have specified the correct store_url, wc_consumer_key and wc_consumer_secret.


If all the fields are correct, another reason can be that your server may be configured in such a way that it does not accept authorization tokens in request headers. You need to add the following line to the .htaccess file in the folder with the woocommerce project:


RewriteRule ^index\.php$ - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]


You can find additional information in the Woocommerce guide.


https://github.com/woocommerce/woocommerce/wiki/Getting-started-with-the-REST-API

Parameters supported in the product.add method for Amazon SP-API

  • sku - Required. A unique identifier for the product in the seller's catalog.
  • price - Required
  • quantity - Required
  • asin, ean, gtin, upc - One of these is required. one of them is transferred.
  • category_id
  • store_id
  • product_type
  • marketplace_item_properties

asin, ean, gtin, upc parameters are identifiers that identify a product in the Amazon catalog. Every product that is in the Amazon catalog has a unique asin.

Adding a product that already exists in the Amazon catalog

To add a product that already exists in the Amazon catalog, you only need to provide the SKU, the product identifier, and the price and quantity. The quantity can be zero. Only integer values are supported. After a while, the product will appear in the seller's catalog and will have the properties of the product that was assigned to the identifier (name, description, attributes, images, etc.) as well as the seller's offer (offer), which is determined by the price and quantity.

Adding a product that does not exist in the Amazon catalog

Adding a new product that does not exist in the Amazon catalog is a more complex process, as Amazon requires filling out a large number of attributes to create a new product with an indication of the category in which the product will be placed.

Therefore, when creating a product through product.add, if the product identifier that does not yet exist in the Amazon catalog is specified, one of the parameters must be specified: category_id or product_type

To work with Amazon categories, we have added support for the category.count\list\info\find methods.

In the response of the category.list\info methods, the product_types field is displayed in additional_fields. If it contains any data, the ID of this category can be passed in the category_id parameter. Instead of the category_id parameter, you can use the product_type parameter, specifying the value of the additional_fields.product_types field (if the additional_fields.product_types field contains several values, separated by commas, then one of them).

Once one of the category_id or product_type parameters has been defined, you need to pass the attributes of the new product that is being created in the Amazon catalog. For a list of mandatory requirements for a certain product type (product_type) in Amazon, there is a JSON-schema. This JSON-schema is displayed in the category.info method in the additional_fields.category_options field (category.list this field is not displayed to save requests to Amazon).

As you can see from the image, the additional_fields.category_options object contains a WASHER object with the corresponding JSON-schema. If additional_fields.product_types contains multiple values, then JSON-schemas for all product types will be displayed.

The data from the JSON-schema fields is passed in the marketplace_item_properties parameter. This parameter is validated both on the Api2Cart side

and on the Amazon side.

The corresponding errors that will be displayed in an unsuccessful attempt of the product.add method.

If all the required properties for a certain product type are passed, the product will be created in the Amazon catalog.

Possible nuances:

Even if we received a response with return_code: 0 for the product.add method on Amazon SP-API, this does not mean that Amazon will immediately place the product in its catalog and the seller's catalog among its offers. This product may require additional adjustments in the seller's admin panel. Such products are located in the Catalog > Complete Your Drafts menu section.

which will contain product drafts and Amazon's appropriate troubleshooting guidelines for their listing of these products.

To integrate your customer's store with your business system via API2Cart, you will need to take the following steps:

  1. Register: Create an account on the API2Cart platform and fill in the necessary information that is required during registration. To create your account, you will need to contact our specialists.
  2. Get an API key: After registration, you will receive an API key, which will be used as an authentication token to make API requests. The API key will be available in the account.
  3. api2cart account
  4. Choose supported platforms: API2Cart supports more than 40 different eCommerce platforms, such as Shopify, WooCommerce, Magento, BigCommerce, Amazon, eBay, and more. You need to choose the specific platform on which the store is built.
  5. Get required settings for platform connection: For each platform you choose, you will need to provide your store URL, API credentials, and other relevant information required to add the store to API2Cart.
  6. When adding a store through the dashboard, there will be prompts for the parameters that are required to be added, as well as a link to the documentation on how to get the necessary parameters for the selected platform:

    api2cart add store

    To connect platforms (Magento, OpenCart, WooCommerce, and others), before they connect, you need to download and drop a bridge into the root of the site or install the “Bridge Connector” plugin for the corresponding platform. Also, in addition to the store URL, you need to specify the store_key parameter received after downloading or connecting the plugin. You can also set additional parameters for the connection.

    api2cart add store 2

    It is also possible to connect a store using the API2Cart API, having an API key and the necessary parameters to connect using the account.cart.add method This will establish a connection between the store and API2Cart.

  7. Connect the platform: After successfully connecting the platform to the unified API provided by API2Cart, you will be able to access various data on the store, such as products, orders, customers, categories, and more.
  In order to integrate with Mercado Libre, you need to create an application. To create an application, you need to follow the link https://developers.mercadolibre.com.co/devcenter/ It is necessary to fill in the information:     

Specify the callback URL and select the necessary scopes. We recommend you select all because you will need to perform all the actions again.

   

After creating an application, you will receive an App ID and a Secret Key.

 

 

Then you need to create a link

https://auth.mercadolibre.com.co/authorization?response_type=code&client_id=$APP_ID&redirect_uri=$YOUR_URL

In the end, you need to add the domain of the country for which the account is registered. If you go to the link in the browser, there will be a window where you need to grant access to the application.

 

 

After that, a redirect will be to the page whose URL should contain the code

   

Which should be used in the next query

 

where client_id - App ID, client_secret - Secret Key

As a result, you will receive access_token and refresh_token

To add a page to API2Cart, you need to specify refresh_token, App ID, and Secret Key

 

In order to see all additional parameters that are unique for your shopping cart, call product.list API method with the params=force_all parameter. Or set the necessary fields separated by comma in parameter "params" (params=length,depth).

This parameter is generated automatically for hosted carts (Shopify, Bigcommerce, Volusion, etc.). If you are working with self-hosted carts (Magento, WooCommerce, OpenCart, etc.) follow these steps:
  • Call cart_bridge method from which you could get store_key.
  • Call bridge_download method and pass store_key which was generated in cart_bridge.
  • Upload the bridge to the root ftp server folder.
  • Call cart_create method and paste previously generated store_url.
All described above is concerned to manual way of bridge upload.
To start working with the service you have to register an account, sign in and connect store by providing the required information (store’s URL, API credentials, etc). Also, you need to install the plugin if you have to work with open-source platforms. Quick Demo tour will provide you with more detailed information on how to start working with the service.

In most cases the system automatically defines the prefix of specific shopping cart and uses it. However if you have several shopping carts of one type, the automatic defining will not work. In this case you should use the method account.cart.add and define the prefix of your shopping cart with a parameter db_tables_prefix.

1. Log into the store.

2. Copy store URL from your browser address bar.

3. Go to Advanced Settings.

4. Click API Accounts.

5. Click Create API Account.

6. Type the name of the user in the Username box.

7. There you will find API Path box. Copy the part of the value that placed between api.bigcommerce.com and /v3/ as shown.

8. Click Content - modify, Checkout Content - modify, Customers - modify, Customers Login - login, Information Settings - modify, Marketing - modify, Orders - modify, Order Transactions - modify, Products - modify, Themes - modify, Carts - modify.

9. Click the Save button. There will appear a window BigCommerce API Credential with Client ID and Access Token.

10. Add BigCommerce store to your API2Cart account, using credential you've got in steps 2, 7 and 9.

To connect Shopify store to API2Cart you need to specify the following credentials:

Required credentials:

  1. shopify_api_key + shopify_api_password - for connection via Private app
  2. shopify_access_token - for connection via Custom app
  3. shopify_shared_secret - is needed to work with Live Shipping Rates or Webhooks

Note. Private apps are deprecated and can`t be created as of January 2022. Custom apps are used instead

To receive shopify_access_token you need to create a Custom app. There are 2 ways:

Let's consider the 2nd way.

In Shopify admin

Open Apps section and press Develop apps for your store.

Press Allow custom app development.

Next step - Create Custom app.

Choose scopes and permissions to the store data.

Webhook Subscriptions Event version - leave without any changes.

Next, open Overview tab and Install the app.

Access token and shared secret will be available in API credentials section.

Please note that Access token could be seen just once. If you lose it you will need to create another App.

Use needed credentials to connect the store.

You can find additional information in Shopify guide.

https://shopify.dev/apps/auth/admin-app-access-tokens.

If you are interested in oAuth authorization proceed with the first way via Partner dashboard. Here is a Shopify guide https://shopify.dev/apps/auth/oauth/getting-started .

Volusion requires API Key (URL) and Encrypted Password
  1. Login to the Admin Area of your Volusion store.
  2. Click the Inventory tab followed by the Import/Export link at the top, below the Inventory tab.
  3. Click the Volusion API tab.
  4. Point to Get Help in the top right and click Get help with this page.
  5. Click the Volusion API Integration Help link at the bottom of the page.
  6. Select to view instructions for Generic Orders and expand the URL with Query Stringsection at the bottom. The Encrypted Password can be found in the URL displayed, between the Encrypted Password= and &API_Name.
Please note, you must have a Volusion Gold plan or higher in order to have API access for your store.

This API is no longer supported by 3DCart, use Shift4Shop instead.


You need to retrieve API Key from your 3DCart (Shift4Shop) admin account.
  1. Log in to your admin panel and go to Settings -> General -> Store Settings.
  2. Go to the Advanced Settings section located at the far bottom of the page.
  3. Click on Change Settings next to API Settings.
  4. Check Enable API if it isn't enabled yet.
  5. Copy API User Key and save changes.

The process of connecting the store to API2Cart depends on the type of shopping cart. There are two major types: Hosted (3dcart, Volusion, Shopify) and Open-source (PrestaShop, WooCommerce, OpenCart, etc.) Get the type of carts here.

For Hosted Carts

You are able to add your stores in 2 ways:

  1. Through the interface in your account. Simply press ‘Add store button’, paste your store’s URL, select type, valid API key and API password.
  2. By calling account.cart.add method.  In order to add store correctly, provide all necessary parameters that are described in documentation.
public function apiCreate()
{
  $params = array(
    'cart_id'      => 'BigcommerceApi',
    'store_url'    => 'https://example.com',
    'verify'       => 'false',//set this param=false for test only
    'store_key'    => 'ab37fc230bc5df63a5be1b11220949be',//for self-hosted cart only
    'AdminAccount' => 'admin',
    'ApiPath'      => 'https://example.com/api/v1',
    'ApiKey'       => '6b89704cd75738cb0f9f6468d5462aba',
  );

  return $api->request('account.cart.add', $params);
}

Note: Store key is generated automatically for hosted carts (Shopify, Bigcommerce, Volusion, etc.)

For Open-source Carts.

When talking about Open-source platforms, it’s worth mentioning that API2Cart connects to such type of solutions through connection bridge.

You are able to add your stores in 2 ways:

  1. Through the interface in your account. Simply press ‘Add store button’, paste your store’s URL, select type, download bridge and paste it to your store’s root folder via FTP client. (Read our FAQ on what is the connection bridge and why do you need it)
  2. By calling these methods:
  • Call cart.bridge method from which you could get store_key.
  • Call bridge.download method and pass store_key which was generated in cart_bridge.
  • Upload the bridge to the root ftp server folder.
  • Call account.cart.add method and paste previously generated store_url.

Product API methods allow you to manage products in the store. It is possible to:

  • Create - add products
  • Read - retrieve list, info, find
  • Update - update
  • Delete - delete

Run product.add method, in order to add new products to the store, and provide all necessary parameters.

public function apiAdd($params)
{
  $params = array(
    'name'        => 'Bag',
    'model'       => 'bag_01',
    'description' => 'This is new product',
    'price'       => 99.9,
    'quantity'    => 12,
    'manufacturer'=> 'Test',
  );

  return $api->request('product.add', $params);
}

Note: You may add image, tax, manufacturer, option, variant or other info to the product by calling these methods: product.image.add, product.variant.add, product.manufacturer.add, product.tax.add, product.option.add, product.option.value.add, product.option.assign, product.option.value.assign

For more methods jump into documentation.

If you want to update the product, call product.list method  to retrieve product id.

public function apiList($params)
{
  $params = array(
    'start'  => 0,
    'count'  => 50,
    'params' => 'id,name,price',
  );

  return $api->request('product.list', $params);
}

When you get product id, you are able to update price and inventory(quantity) for this product, simply calling product.update method.

public function apiUpdate($params)
{
  $params = array(
    'id' => 69,
    'price' => 89,
  );

  return $api->request('product.update', $params);
}

Note: You may update variant, image and product option value by calling the following methods: product.variant.update, product.image.update, product.option.value.update

For more API methods visit our documentation.

Order API methods allow you to manage orders in the store. It is possible to:

  • Create - add orders
  • Read - retrieve list, info, find
  • Update - update
  • Delete - delete

Run order.add method to add orders to the store, and provide all necessary parameters.

public function apiAdd($params)
{
  $params = array(
    'customer_email'         => '[email protected]',
    'order_status'           => 'Complete',
    'bill_first_name'        => 'Adam',
    'bill_last_name'         => 'Smith',
    'bill_address_1'         => 'Green str. 35',
    'bill_city'              => 'Chicago',
    'bill_postcode'          => '12345',
    'bill_state'             => 'IL',
    'bill_country'           => 'US',
    'total_price'            => '23.56',
    'order_item_id_1'        => 8,
    'order_item_name_1'      => 'Bag',
    'order_item_model_1'     => 'bag_01',
    'order_item_price_1'     => 89,
    'order_item_quantity_1'  => 3,
  );

  return = $api->request('order.add', $params);
}

If you want to update an order, call order.list method to get order id.

public function apiList($params)
{
  $params = array(
    'start'  => 0,
    'count'  => 5,
    'params' => 'id,customer,status'
  );

  return $api->request('order.list', $params);
}

When you get your order id, you are able to update comment and order status by calling  order.update method

public function apiUpdate($params)
{
  $params = array(
    'order_id'     => 11,
    'order_status' => 'Pending',
    'comment'      => 'Order comment'
  );

  return $api->request('order.update', $params);//returns the number of updated orders
}

Note: You are able to count orders in the store by calling order.count method.

For more methods jump into documentation.

Customer API methods allow you to manage customers in the store. It is possible to:

  • Create - add customers
  • Read - retrieve list, info, find
  • Update - update
  • Delete - delete

Run customer.add method, to add customers to the store, and provide all necessary parameters.

public function apiAdd($params)
{
  $params = array(
    'email'      => '[email protected]',
    'first_name' => 'John',
    'last_name'  => 'Smith',
  );

  return $api->request('customer.add', $params);
}

If you want to update the customer, call customer.list method  to retrieve customer id.

public function apiList($params)
{
  $params = array(
    'start' => 0,
    'count' => 5
  );

  return $api->request('customer.list', $params);
}

When you get your customer id, you are able to perform customer.update method.

public function apiUpdate($params)
{
  $params = array(
    'id'         => 11,
    'first_name' => 'Jack',
    'last_name'  => 'Smith',
  );    

  return $api->request('customer.update', $params);
}

For more methods jump into documentation.

Categories API methods allow you to manage categories in the store. It is possible to:

  • Create - add categories
  • Read - retrieve list, info, find
  • Update - update
  • Delete - delete

Run category.add method, to add customers to the store, and provide all necessary parameters.

public function apiAdd($params)
{
  $params = array(
    'name' => 'Shoes'
  );

  return $api->request('category.add', $params);
}

If you want to update the category, call category.list method to get category id.

public function apiList($params)
{
  $params = array(
    'start'  => 2,
    'count'  => 2,
  );
  
  return $api->request('category.list', $params);
}

When you get your category id, you are able to perform category.update method.

public function apiUpdate($params)
{
  $params = array(
    'id'         => 20,
    'avail'      => 'false',
    'meta_title' => 'meta title for category'
  );
    
  return $api->request('category.update', $params);
}

If you want to assign your product to some category, simply call product.list method and category.list method to get product id and category id.

After that, run category.assign method.

public function apiAssign($params)
{
  $params = array(
    'product_id'     => 69,
    'category_id'    => 20,
  );
    
  return $api->request('category.assign', $params);
}

For more methods jump into documentation.

When signing up for API2Cart account, you are asked to provide name, e-mail address, password.

When adding a new store, you are asked to provide API key and store URLs. You may also be asked to provide your direct database connection to speed up the process. We take appropriate security measures to protect your information. Find out more about our Privacy Policy.

API key is a code that consists of 32 characters and is generated by API2Cart for each user individually. In order to get it, you need to register your account first. After that service will automatically provide you with API key. You can find it on the page with your stores list.
 
API key is a code generated by API2Cart for each user individually. It provides you with access rights on the API. You will use your API key to establish connection between service and stores you are going to work with. Personal API Key helps us to identify users who perform API requests, allows to track and control API usage.
In order to integrate your client’s store with your business system via API2Cart you will have to:
    • provide API Key/Token and password if it is a hosted platform
    • or use bridge files to establish connection to other carts.

See the full list below (in alphabetic order):

 
3dcart API Key
Amazon MWS Auth Token, Seller ID, Marketplace IDs, Secret Key, Access Key ID
AceShop Bridge files uploaded to store folder
AspDotNetStorefront Admin User and Password
Bigcommerce Client ID, Access Token, Context
CS-Cart Bridge files uploaded to store folder / plugin
CubeCart Bridge files uploaded to store folder
Demandware API Client ID, API Password, User Name, User Password, Environment Type
Ebay App ID, Shared Secret, Refreshed Token, Environment, Global ID
Ecwid Store ID, Access Token
Etsy KeyString, Shared Secret, Access Token, Secret Token
Gambio Bridge files uploaded to store folder
Hybris Client ID, Client Secret, User Name, User Password
Interspire Bridge files uploaded to store folder
JooCart Bridge files uploaded to store folder
LightSpeed eCommerce API Key, API Secret
Loaded Commerce Bridge files uploaded to store folder
Magento Bridge files uploaded to store folder / plugin
MijoShop Bridge files uploaded to store folder
Neto API Key, User Name
OpenCart Bridge files uploaded to store folder
osCMax Bridge files uploaded to store folder
osCommerce Bridge files uploaded to store folder
Oxid Bridge files uploaded to store folder
Pinnacle Cart Bridge files uploaded to store folder
PrestaShop Bridge files uploaded to store folder / plugin
Shop-Script Premium Bridge files uploaded to store folder
Shopify API Key, API Password, Access Token, Shared Secret
Shopware Bridge files uploaded to store folder
Squarespace API Key
TomatoCart Bridge files uploaded to store folder
Ubercart Bridge files uploaded to store folder
VirtueMart Bridge files uploaded to store folder
Volusion Login and API Password
Walmart Client ID, Client Secret
WooCommerce Bridge files uploaded to store folder / plugin
WebAsyst Shop-Script Bridge files uploaded to store folder
WPEcommerce Bridge files uploaded to store folder
XCart Bridge files uploaded to store folder
Xtcommerce Bridge files uploaded to store folder
Xtcommerce Veyton Bridge files uploaded to store folder
Zencart Bridge files uploaded to store folder

For more information about how to get your API Key/Token follow this link.