cart

cart.create

Add store to the account

post/cart.create.json

Request

Base URL: https://api.api2cart.com/v1.1
URL: https://api.api2cart.com/v1.1/cart.create.json
Auth: API key in header x-api-key

Request body

Integration identifier

store_urlstring

A web address of a store that you would like to connect to API2Cart

bridge_urlstring

This parameter allows to set up store with custom bridge url (also you must use store_root parameter if a bridge folder is not in the root folder of the store)

store_rootstring

Absolute path to the store root directory (used with "bridge_url" parameter)

store_keystring

Set this parameter if bridge is already uploaded to store

shared_secretstring

Shared secret

validate_versionboolean

Specify if api2cart should validate cart version

verifyboolean

Enables or disables cart's verification

db_tables_prefixstring

DB tables prefix

user_agentstring

This parameter allows you to set your custom user agent, which will be used in requests to the store. Please use it cautiously, as the store's firewall may block specific values.

ftp_hoststring

FTP connection host

ftp_userstring

FTP User

ftp_passwordstring

FTP Password

ftp_portinteger

FTP Port

ftp_store_dirstring

FTP Store dir

apiKey_3dcartstring

3DCart API Key

AdminAccountstring

It's a BigCommerce account for which API is enabled

ApiPathstring

BigCommerce API URL

ApiKey_Bigcommercestring

Bigcommerce API Key

client_idstring

Client ID of the requesting app

accessTokenstring

Access token authorizing the app to access resources on behalf of a user

contextstring

API Path section unique to the store

access_tokenstring

Access token authorizing the app to access resources on behalf of a user

apiKey_shopifystring

Shopify API Key

apiPasswordstring

Shopify API Password

accessToken_shopifystring

Access token authorizing the app to access resources on behalf of a user

shopify_client_idstring

Shopify Client ID

apiKeystring

Neto API Key

apiUsernamestring

Neto User Name

EncryptedPasswordstring

Volusion API Password

Loginstring

It's a Volusion account for which API is enabled

apiUser_adnsfstring

It's a AspDotNetStorefront account for which API is available

apiPassstring

AspDotNetStorefront API Password

privateKeystring

3DCart Application Private Key

appTokenstring

3DCart Token from Application

etsy_keystringstring

Etsy keystring

etsy_shared_secretstring

Etsy shared secret

tokenSecretstring

Secret token authorizing the app to access resources on behalf of a user

etsy_client_idstring

Etsy Client Id

etsy_refresh_tokenstring

Etsy Refresh token

ebay_client_idstring

Application ID (AppID).

ebay_client_secretstring

Shared Secret from eBay application

ebay_runamestring

The RuName value that eBay assigns to your application.

ebay_access_tokenstring

Used to authenticate API requests.

ebay_refresh_tokenstring

Used to renew the access token.

ebay_environmentstring

eBay environment

ebay_site_idinteger

eBay global ID

dw_client_idstring

Demandware client id

dw_api_passstring

Demandware api password

demandware_user_namestring

Demandware user name

demandware_user_passwordstring

Demandware user password

store_idstring required

Store Id

seller_idstring

Seller Id

environmentstring

hybris_client_idstring

Omni Commerce Connector Client ID

hybris_client_secretstring

Omni Commerce Connector Client Secret

hybris_usernamestring

User Name

hybris_passwordstring

User password

walmart_client_idstring

Walmart client ID. For the region 'ca' use Consumer ID

walmart_client_secretstring

Walmart client secret. For the region 'ca' use Private Key

walmart_environmentstring

Walmart environment

walmart_channel_typestring

Walmart WM_CONSUMER.CHANNEL.TYPE header

walmart_regionstring

Walmart region

walmart_refresh_tokenstring

Walmart refresh token received by a Solution Provider application through the Walmart App Store authorization. When it is set, walmart_client_id and walmart_client_secret are the credentials of that application, not of the seller. Must be used together with walmart_seller_id and is supported only for walmart_region = 'us'

walmart_seller_idstring

Walmart seller id the refresh token was issued for, sent as the WM_PARTNER.ID header. Must be used together with walmart_refresh_token and is supported only for walmart_region = 'us'

lightspeed_api_keystring

LightSpeed api key

lightspeed_api_secretstring

LightSpeed api secret

shoplazza_access_tokenstring

Access token authorizing the app to access resources on behalf of a user

shoplazza_shared_secretstring

Shared secret

shopware_access_keystring

Shopware access key

unas_api_keystring

UNAS API Key

shopware_api_keystring

Shopware api key

shopware_api_secretstring

Shopware client secret access key

commercehq_api_keystring

CommerceHQ api key

commercehq_api_passwordstring

CommerceHQ api password

3dcart_private_keystring

3DCart Private Key

3dcart_access_tokenstring

3DCart Token

wc_consumer_keystring

Woocommerce consumer key

wc_consumer_secretstring

Woocommerce consumer secret

magento_consumer_keystring

Magento Consumer Key

magento_consumer_secretstring

Magento Consumer Secret

magento_access_tokenstring

Magento Access Token

magento_token_secretstring

Magento Token Secret

prestashop_webservice_keystring

Prestashop webservice key

wix_app_idstring

Wix App ID

wix_app_secret_keystring

Wix App Secret Key

wix_instance_idstring

Wix Instance ID

wix_refresh_tokenstring

Wix refresh token

mercado_libre_app_idstring

Mercado Libre App ID

mercado_libre_app_secret_keystring

Mercado Libre App Secret Key

mercado_libre_refresh_tokenstring

Mercado Libre Refresh Token

zid_client_idinteger

Zid Client ID

zid_client_secretstring

Zid Client Secret

zid_access_tokenstring

Zid Access Token

zid_authorizationstring

Zid Authorization

zid_refresh_tokenstring

Zid refresh token

flipkart_client_idstring

Flipkart Client ID

flipkart_client_secretstring

Flipkart Client Secret

allegro_client_idstring

Allegro Client ID

allegro_client_secretstring

Allegro Client Secret

allegro_access_tokenstring

Allegro Access Token

allegro_refresh_tokenstring

Allegro Refresh Token

allegro_environmentstring

Allegro Environment

bricklink_consumer_keystring

Bricklink Consumer Key

bricklink_consumer_secretstring

Bricklink Consumer Secret

bricklink_tokenstring

Bricklink Access Token

bricklink_token_secretstring

Bricklink Access Token Secret

nopcommerce_tokenstring

Access token authorizing the app to access resources on behalf of a user

nopcommerce_secretstring

nopCommerce webhook signing secret generated by the Api2Cart.Connector plugin. Optional when connecting a store, but required to receive webhooks from it.

jumpseller_client_idstring

Jumpseller OAuth2 Client ID

jumpseller_client_secretstring

Jumpseller OAuth2 Client Secret

jumpseller_refresh_tokenstring

Jumpseller OAuth2 refresh token

jumpseller_loginstring

Jumpseller API login

jumpseller_authtokenstring

Jumpseller API auth token

Example request

{
  "cart_id": "Opencart14",
  "store_url": "http://mystore.com",
  "bridge_url": "https://your-store.com/custom/bridge/path/bridge.php",
  "store_root": "/home/www/stores/magento1922",
  "store_key": "ab37fc230bc5df63a5be1b11220949be",
  "shared_secret": "gmz3iz45x2",
  "validate_version": true,
  "db_tables_prefix": "oc_",
  "user_agent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0",
  "ftp_host": "ftp.mystore.com",
  "ftp_user": "user",
  "ftp_password": "G4}q215D4_H9$Be",
  "ftp_port": 22,
  "ftp_store_dir": "/public",
  "apiKey_3dcart": "82cc921c6a5c67082cc921c6a5c6707e1d6e6862ba3201a",
  "AdminAccount": "admin",
  "ApiPath": "http://mystore.bigcommerce.com/api/v1",
  "ApiKey_Bigcommerce": "6b89704cd75738cb0f9f6468d5462aba",
  "client_id": "p1r37bt131z86675nofv9xmhietoe4t",
  "accessToken": "igse8e4rdmzkxdi937qe69d59en1imw",
  "context": "stores/etplnf8o8v",
  "access_token": "igse8e4rdmzkxdi937qe69d59en1imw",
  "apiKey_shopify": "bbca57d8ff3c3677128112c15556d9e3",
  "apiPassword": "860f3a6fc87632301a42cd88e4b5ab3d",
  "accessToken_shopify": "igse8e4rdmzkxdi937qe69d59en1imw",
  "shopify_client_id": "b5defe55db3f6836fb4e0e6624ff9577",
  "apiKey": "bbca57d8ff3c3677128112c15556d9e3",
  "apiUsername": "mylogin",
  "EncryptedPassword": "7943CA5F3990E00D9A4CCF0BD998211F",
  "Login": "admin",
  "apiUser_adnsf": "admin",
  "apiPass": "f6471ef78f72b41849a8b8b67791b0b5",
  "privateKey": "2xo0m9ib5ty7rv84num9uic3e9mio0cy73nsdey7e5270",
  "appToken": "82cc921c6a5c67082cc921c6a5c6707e1d6e6862ba3201a",
  "etsy_keystring": "a9psel85v1wy5faeyjw03y0r",
  "etsy_shared_secret": "gmz3iz45x2",
  "tokenSecret": "igse8e4rdmzkxdi937qe69d59en1imw",
  "etsy_client_id": "w0fi0igk2w29bjcd7ydr2s35",
  "etsy_refresh_token": "223577551.L07_RE-y7unmKf2dox4djsHkVxwpUfs1ikG_uQmHhF-aASEReNn_Qns1Wqn3dDa0ZMxrt9CIael3dgudeDZb31ZUdS",
  "ebay_client_id": "a9psel85v1wy5faeyjw03y0r",
  "ebay_client_secret": "gmz3iz45x2",
  "ebay_runame": "gmz3iz45x2",
  "ebay_access_token": "v^1.1#i ... AjRV4yNjA=",
  "ebay_refresh_token": "v^1.1#i ... rAewqVasdA=",
  "ebay_environment": "sandbox",
  "dw_client_id": "b849eb85-v8b9-1dw8-9fe2-97e1d6ffc7b0",
  "dw_api_pass": "testpassword",
  "demandware_user_name": "admin",
  "demandware_user_password": "12345",
  "store_id": "1",
  "seller_id": "A9PSDFGFGHFOQD",
  "environment": "sandbox",
  "hybris_client_id": "api_client_1",
  "hybris_client_secret": "secret_phrase_1",
  "hybris_username": "admin",
  "hybris_password": "nimda",
  "walmart_client_id": "423f6A24-123z-8654-989u-6fa96478289",
  "walmart_client_secret": "1gf85fea-8974-2648-w12w-rt54284tdf54",
  "walmart_environment": "production",
  "walmart_channel_type": "0f3e4dd4-0514-4346-b39d-af0e00ea066d",
  "walmart_region": "us",
  "walmart_refresh_token": "eyJraWQiOiIxYmIxMTYyNS1lM2Y2LTQyNWMtOTkwMS0zZTdiNmJhNzZmNjIiLCJhbGciOiJSUzI1NiJ9",
  "walmart_seller_id": "10000004372",
  "lightspeed_api_key": "cf5444729c2abd6b6a5d983691767cb5",
  "lightspeed_api_secret": "2620ee52a8bc942f9d5d3a575f4d363e",
  "shoplazza_access_token": "igse8e4rdmzkxdi937qe69d59en1imw",
  "shoplazza_shared_secret": "gmz3iz45x2",
  "shopware_access_key": "SWSCS3O1RJBSRNBYQLFIYJN2ZQ",
  "unas_api_key": "c238908e29ceb6e6ad3df15f89a6234709d3f000",
  "shopware_api_key": "SWSCS3O1RJBSRNBYQLFIYJN2ZQ",
  "shopware_api_secret": "V3NYNWg2b1dZdHBUWDN1cmdKdGhnenp5enVJYlJ0WlJvOFF2bnQ",
  "commercehq_api_key": "sJrD-LM0eddhe63rfgfva0dDydXfre4",
  "commercehq_api_password": "4Grr_ZCLNNoSUuhAjesKuchxo9SL",
  "3dcart_private_key": "7dba81f90bdbe25e7000e73214ca51b",
  "3dcart_access_token": "4Grr_ZCLNNoSUuhAjesKuchxo9SL",
  "wc_consumer_key": "ck_26d8e2ad604f3917e429df6961722282bdcf109d",
  "wc_consumer_secret": "cs_931ced666118a15c5f7b4a33a15gf5589cbeba55",
  "magento_consumer_key": "ktv4n9rgrj0evjuy2t6p2xlb1f8u5pmy",
  "magento_consumer_secret": "a46abc3kxyinlbggy06i9g975xqo6gjq",
  "magento_access_token": "igse8e4rdmzkxdi937qe69d59en1imw",
  "magento_token_secret": "igse8e4rdmzkxdi937qe69d59en1imw",
  "prestashop_webservice_key": "CKJ1ZEWRJWRLTPVBQJ9FGGRORD4AGS96",
  "wix_app_id": "6b0b5b7b-7d87-45b5-bf34-ac6b438e63da",
  "wix_app_secret_key": "316c0a09-f195-42be-74f6-a02cebb9cae6",
  "wix_instance_id": "58b893a4-6b16-5c2f-qt78-qa3r61t32rt8",
  "wix_refresh_token": "\n        OAUTH2.eyJraWQiOiJkZ0x3cjNRMCIsImFsZyI6IkhTMjU2In0.\n        eyJkYXRhIjoie1wiaWRcIjpcImJlZjM3MmRmLTUyNGItNDI3NS05M2RkL\n        Tg4NDBlOTU3ZWU2OFwifSIsImlhdCI6MTY0ODA0NTEyNiwiZXhwIjoxNzExMTE3MTI2fQ.\n        VRR2lGSbcTVmaArtmyyhy6o4WRDwTn-nlDCQpZ97eYw\n      ",
  "mercado_libre_app_id": "211188015100135",
  "mercado_libre_app_secret_key": "e2qoG2zklLlfP7cEngEJ94YjhkejkjAm",
  "mercado_libre_refresh_token": "TG-63h13529vb5464110188d2x9-703754376",
  "zid_client_id": 1234,
  "zid_client_secret": "nl5l1lE0vxgv6cV111fHsdlOOIfb0Ms5IR7l4Igs",
  "zid_access_token": "def50eyfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe657e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65de64a0c865d",
  "zid_authorization": "def50eyfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe657e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65de64a0c865d",
  "zid_refresh_token": "def50eyfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe657e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65d7e64a0cfe9fe65de64a0c865d",
  "flipkart_client_id": "19414773883a13a850b6a52350b7246499a24",
  "flipkart_client_secret": "nl5l1lE0vxgv6cV111fHsdlOOIfb0Ms5IR7l4Igs",
  "allegro_client_id": "2915e189ce3d23d23d2327d204ae6a0bd",
  "allegro_client_secret": "DNHtqdL2WPIefeUhQWYgtXPS23fgbfgasdsGHHJGhg3RTFDQWFGZmVoFRT5IfkQj1E7eR5",
  "allegro_access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IsfddfdfdeyJ1c2VyX25hbWUiOiI5NDUxMzE1MSIsInNjb3BlIjpbImFsbGVncm86YXBpOm9yZGVyczpyZWFkIiwiYWxsZWdybzphcGk6cHJvZmlsZTp3cml0ZSIsImFsbGVncm86YXBpOnNhbGU6b2ZmZXJzOndyaXRlIiwiYWxsZWdybzphcGk6YmlsbGluZzpyZWFkIiwiYWxsZWdybzphcGk6Y2FtcGFpZ25zIiwiYWxsZWdybzphcGk6ZGlzcHV0ZXMiLCJhbGxlZ3JvOmFwaTpzYWxlOm9mZmVyczpyZWFkIiwiYWxsZWdybzphcGk6YmlkcyIsImFsbGVncm86YXBpOm9yZGVyczp3cml0ZSIsImFsbGVncm86YXBpOnBheW1lbnRzOndyaXRlIiwiYWxsZWdybzphcGk6c2FsZTpzZXR0aW5nczp3cml0ZSIsImFsbGVncm86YXBpOnByb2ZpbGU6cmVhZCIsImFsbGVncm86YXBpOnJhdGluZ3MiLCJhbGxlZ3JvOmFwaTpzYWxlOnNldHRpbmdzOnJlYWQiLCJhbGxlZ3JvOmFwaTpwYXltZW50czpyZWFkIiwiYWxsZWdybzphcGk6bWVzc2FnaW5nIl0sI",
  "allegro_refresh_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IsfddfdfdeyJ1c2VyX25hbWUiOiI5NDUxMzE1MSIsInNjb3BlIjpbImFsbGVncm86YXBpOm9yZGVyczpyZWFkIiwiYWxsZWdybzphcGk6cHJvZmlsZTp3cml0ZSIsImFsbGVncm86YXBpOnNhbGU6b2ZmZXJzOndyaXRlIiwiYWxsZWdybzphcGk6YmlsbGluZzpyZWFkIiwiYWxsZWdybzphcGk6Y2FtcGFpZ25zIiwiYWxsZWdybzphcGk6ZGlzcHV0ZXMiLCJhbGxlZ3JvOmFwaTpzYWxlOm9mZmVyczpyZWFkIiwiYWxsZWdybzphcGk6YmlkcyIsImFsbGVncm86YXBpOm9yZGVyczp3cml0ZSIsImFsbGVncm86YXBpOnBheW1lbnRzOndyaXRlIiwiYWxsZWdybzphcGk6c2FsZTpzZXR0aW5nczp3cml0ZSIsImFsbGVncm86YXBpOnByb2ZpbGU6cmVhZCIsImFsbGVncm86YXBpOnJhdGluZ3MiLCJhbGxlZ3JvOmFwaTpzYWxlOnNldHRpbmdzOnJlYWQiLCJhbGxlZ3JvOmFwaTpwYXltZW50czpyZWFkIiwiYWxsZWdybzphcGk6bWVzc2FnaW5nIl0sI",
  "allegro_environment": "sandbox",
  "bricklink_consumer_key": "26F6CDA087D9444EAA71AC09E7A1D39A",
  "bricklink_consumer_secret": "a46abc3kxyinlbggy06i9g975xqo6gjq",
  "bricklink_token": "ktv4n9rgrj0evjuy2t6p2xlb1f8u5pmy",
  "bricklink_token_secret": "a46abc3kxyinlbggy06i9g975xqo6gjq",
  "nopcommerce_token": "igse8e4rdmzkxdi937qe69d59en1imw",
  "nopcommerce_secret": "a1f3c9e72b6d480fa5c81e9b7d2f04a63e8c5b1a9d7f3026e4b8c1a2f5d6e093",
  "jumpseller_client_id": "your_client_id",
  "jumpseller_client_secret": "your_client_secret",
  "jumpseller_refresh_token": "your_oauth_refresh_token",
  "jumpseller_login": "your_login",
  "jumpseller_authtoken": "your_auth_token"
}

Response

successful operation

return_codeinteger

return_messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.