Got questions? Contact Us, Call Us 1-800-224-0976 or write manager@api2cart.com
Download the guide "How to Integrate with Multiple eCommerce Platforms in Less than a Month" and find more how to connect your B2B SaaS system with various shopping platforms quickly!
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).
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:
Global permissions
{
"_v":"17.4",
"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": "17.4",
"clients": [
{
"client_id": "YOUR_CLIENT_ID",
"allowed_origins": [
],
"resources": [
{
"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/*/submit",
"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": "/products/*/prices",
"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":"(**)"
}
]
}
]
}
Global permissions
{
"_v":"17.4",
"clients":[
{
"client_id":"YOUR_CLIENT_ID",
"resources":[
{
"resource_id":"/**",
"methods":[
"put",
"get",
"post",
"patch"
],
"read_attributes":"(**)",
"write_attributes":"(**)"
}
]
}
]
}
Or per resource permissions
{
"_v": "17.4",
"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":"(**)"
}
]
}
]
}
In order to connect Amazon SP-API to API2Cart account, you need to fill out the credentials, which is shown in the screenshot below:
The seller account that is planned to be connected to API2Cart must have an active "Professional" selling plan.
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
2. In order to make calls to the Amazon SP API, you must have an AWS account. If you do not have it, then you can register it here - AWS Free Tier.
If you already have an AWS account, you can proceed to the stage of obtaining the following credentials:
Go to https://console.aws.amazon.com/iam/home#/users and follow the steps as shown below:
Select the JSON tab, and insert the following code:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": "execute-api:Invoke",
"Resource": "arn:aws:execute-api:*:*:*"
}
]
}
Go to https://console.aws.amazon.com/iam/home#/roles
Open the newly created role and save Role ARN.
6. Add an AWS Security Token Service policy to your IAM user
Go to https://console.aws.amazon.com/iam/home#/users7. To determine which value should be substituted into amazon_sp_aws_region you need to use the table Selling Partner API endpoints.
Selling region | Endpoint | AWS Region |
North America (Canada, US, Mexico, and Brazil marketplaces) | https://sellingpartnerapi-na.amazon.com | us-east-1 |
Europe (Spain, UK, France, Netherlands, Germany, Italy, Sweden, Poland, Turkey, U.A.E, and India marketplaces) | https://sellingpartnerapi-eu.amazon.com | eu-west-1 |
Far East (Singapore, Australia, and Japan marketplaces) | https://sellingpartnerapi-fe.amazon.com | us-west-2 |
For example, if the seller sells in the US, you must select us-east-1.
8. 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.
Click “View” to see amazon_sp_client_id and amazon_sp_client_secret.
9. To get the last parameter - amazon_sp_refresh_token you need to implement OAuth authentication in one of the following ways:
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.
10. Now, when you have all the necessary credentials, you can add a store in API2Cart.
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.
1) First, make account.cart.add request:
https://docs.api2cart.com/post/interactive-docs?version=v1.1#/account/AccountCartAdd
with the following parameters:
where Api_key is your API key, cart_id is Walmart.
To find walmart_private_key, walmart_channel_type, and walmart_consumer_id go to your
store admin panel → Settings → Consumer IDs & Private Keys.
Copy parameters values and make request:
https://api.api2cart.com/v1.1/account.cart.add.json?api_key=***&cart_id=Walmart&walmart_private_key=***&walmart_channel_type=***&walmart_consumer_id=***
To connect your eBay account to API2Cart, send
account.cart.addrequest using
POST method (!)from your API2Cart account. This request should contain the following parameters:
How to get parameters marked in red above:
Go to the eBay developers program page
https://developer.ebay.com/my/auth/Log in to your account or register one. After the successful authentication, you will land on Application Keys page, which looks like this:
On the screenshot above we’ve highlighted the keys needed to connect your eBay account to API2Cart:
ebay_client_id and ebay_client_secret.Go to the User Tokens page: https://developer.ebay.com/my/auth.
To get RuName, go to User Tokens tab-> Get a Token from eBay via Your Application -> press Add eBay Redirect URL - there will appear a setting page -> tick the box under OAuth Enabled -> get your parameter RuName (eBay Redirect URL name).
On the same page (User Tokens) set up Sign-in settings. 1) 2) Switch on OAuth: 3) Your auth accepted URL - here specify a URL link on which you’ll get the code, which is a very important parameter. 4) Save settings. Click the link in the field: Your branded eBay Sandbox Sign In (OAuth) - copy this big URL link and paste it into the address bar. There you will see the following page:
Sign in to your seller eBay account, then go to page Grant application access to Token Name: press Agree, then you will be redirected to the page you’ve specified in the field Your auth accepted URL.On that page you will receive data in the following format: state:null
code:v^1.1#i^1#r^1#p^3#f^0#I^3#t^Ul41Xzg6MDM5RENGM0E3NEIxNTJDQkU5QjQxMDA2MjA5NjRBOTRfMV8xI0VeMTI4NA==
And the last step, use “code” to get refresh_token. You can do this via POSTMAN.Send POST request to the link https://api.ebay.com/identity/v1/oauth2/token, in case you use production environment. Otherwise, if you use sandbox send a request to this link - https://api.sandbox.ebay.com/identity/v1/oauth2/token. Specify in Body parameters grant_type, code and redirect_uri, like we did on the screenshot below. Make sure "code" parameter value is not url encoded before passing it as a request parameter
On the Authorization tab choose Type: Basic Auth, and in fields Username and Password paste you client_id and client_secret, as we did in the screenshot below.
6) ebay_site_id:
Each eBay site maps to a unique eBay global ID. You can get it from https://developer.ebay.com/devzone/merchandising/docs/concepts/siteidtoglobalid.html
If you don't set this parameter, it will be 0 (US) by default.
After you press Send, eBay will give you
access_token and refresh_token, which are necessary for connecting your eBay account to API2Cart.The instruction above is based on official eBay documentation: https://developer.ebay.com/api-docs/static/oauth-qref-auth-code-grant.html
0) Note: If you are trying to connect another marketplace (not Amazon.ca, Amazon.com, Amazon.com.mx) or you need to get customer's personal info (name, address etc.) you must register your developer:
Be sure to click the Verify button to verify email addresses that you enter.
Your AWS Access Key ID and Secret Key appear. Use these credentials when adding store (amazon_access_key_id amazon_secret_key).
1) The seller goes to the User Permissions page in Seller Central and logs into their Amazon seller account as the primary user.
2) Go to Settings > User Permissions page in Seller Central.
NOTE: The owner of the Amazon account is the only one who will see the developer area on the User Permissions page. Not even a full access super-admin can see it, only the owner.
3) The seller clicks the Authorize a developer button. In the Developer name text box, the seller enters the name of the developer that they are authorizing. This doesn't need to be the exact name; it is merely for the seller's reference in the future. Example: API2Cart.
4) In the Developer ID text box, the seller enters the Developer ID: 0677-7064-4291 (or your Developer ID obtained in paragraph 0) and then clicks the Authorize developer button.
5) The seller's MWS Auth Token appears.
6) Add Amazon store in your API2Cart account using the credentials obtained in the previous steps.
amazon_access_token (MWS Auth Token)
amazon_seller_id (Seller ID)
amazon_marketplaces_ids (comma separated string of values specified in Marketplace ID)
If you were doing the paragraph 0, you need to insert the last two parameters
amazon_access_key_id
amazon_secret_key
To connect Etsy account to API2Cart you’ll need to either:
https://www.etsy.com/developers/register
Once you register an account and you will receive following credentials for your app:
KEYSTRING
SHARED SECRET
Consumer Key - KEYSTRING from step 1
Consumer Secret - SHARED SECRET from step 1
Response body will look like “login_url=URL”
You should urldecode URL and provide it to the account owner.
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>
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.
To connect Squarespace store to API2Cart and start working with the data from it, you need to register a new account.
To add the store built on Squarespace, you will need to have the Store URL and squarespace_api_key.
To get squarespace_api_key, you have to go to Squarespace admin panel, click on Settings, choose the option Advanced in the menu, click on Developer Api Keys, and Generate Key.
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_secret.
To get commercehq_api_key and commercehq_api_secret, 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.
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.
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.
The request examples (Postman collection)
for HSQL database:
./hybris/bin/platform/license.sh -temp CPS_SQL
for MySQL:
/hybris/bin/platform/license.sh -temp CPS_MYS
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
).
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. Go to Advanced Settings.
3. Click API Accounts.
4. Click Create API Account.
5. Type the name of the user in the Username box.
6. There you will find API Path box. Copy its value.
7. 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.
8. Click the Save button. There will appear a window BigCommerce API Credential with Client ID, Client Secret and Access Token.
9. Add BigCommerce store to your API2Cart account, using credential you've got in steps 6 and 8.
To start your work with API2Cart you need to register a new account.
To connect Shopify to API2Cart, you will need to provide API key, API password, and shared secret which can be generated in Shopify admin panel.
Here is a step-by-step guidance that will help you to retrieve Shopify credentials by your own:
API key, API password, and shared secret will appear right after you save the app.
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:
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:
Product API methods allow you to manage products in the store. It is possible to:
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.option.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:
Run order.add method to add orders to the store, and provide all necessary parameters.
public function apiAdd($params)
{
$params = array(
'customer_email' => 'mail@gmail.com',
'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:
Run customer.add method, to add customers to the store, and provide all necessary parameters.
public function apiAdd($params)
{
$params = array(
'email' => 'mail@mail.com',
'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:
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.
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.