account

account.config.update

Use this method to automate the change of credentials used to connect online stores. The list of supported parameters differs depending on the platform.

put/account.config.update.json

Request

  • Base URL: https://api.api2cart.com/v1.1
  • URL: https://api.api2cart.com/v1.1/account.config.update.json
  • Auth: API key in header x-api-key and API key in header x-store-key

Query parameters

replace_parametersboolean

Identifies if there is a necessity to replace parameters

new_store_urlstring

The web address of the store you want to update to connect to API2Cart

new_store_keystring

Update store key

custom_labelstring

Defines a custom label for the store in the app

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)

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.

3dcart_private_keystring

3DCart Private Key

3dcart_access_tokenstring

3DCart Token

3dcartapi_api_keystring

3DCart API Key

amazon_sp_client_idstring

Amazon SP API app client id

amazon_sp_client_secretstring

Amazon SP API app client secret

amazon_sp_refresh_tokenstring

Amazon SP API OAuth refresh token

amazon_sp_aws_regionstring

Amazon AWS Region

amazon_sp_api_environmentstring

Amazon SP API environment

amazon_seller_idstring

Amazon Seller ID (Merchant token)

aspdotnetstorefront_api_userstring

It's a AspDotNetStorefront account for which API is available

aspdotnetstorefront_api_passstring

AspDotNetStorefront API Password

americommerce_app_idstring

Americommerce App ID

americommerce_app_secretstring

Americommerce App Secret

americommerce_access_tokenstring

Americommerce Access Token

americommerce_refresh_tokenstring

Americommerce Refresh Token

bigcommerceapi_admin_accountstring

It's a BigCommerce account for which API is enabled

bigcommerceapi_api_pathstring

BigCommerce API URL

bigcommerceapi_api_keystring

Bigcommerce API Key

bigcommerceapi_client_idstring

Client ID of the requesting app

bigcommerceapi_access_tokenstring

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

bigcommerceapi_contextstring

API Path section unique to the store

bol_api_keystring

Bol API Key

bol_api_secretstring

Bol API Secret

bol_retailer_idinteger

Bol Retailer ID

demandware_client_idstring

Demandware client id

demandware_api_passwordstring

Demandware api password

demandware_user_namestring

Demandware user name

demandware_user_passwordstring

Demandware user password

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

ecwid_acess_tokenstring

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

ecwid_store_idstring

Store Id

lazada_app_idstring

Lazada App ID

lazada_app_secretstring

Lazada App Secret

lazada_refresh_tokenstring

Lazada Refresh Token

lazada_regionstring

Lazada API endpoint Region

etsy_keystringstring

Etsy keystring

etsy_shared_secretstring

Etsy shared secret

etsy_access_tokenstring

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

etsy_token_secretstring

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

facebook_app_idstring

Facebook App ID

facebook_app_secretstring

Facebook App Secret

facebook_access_tokenstring

Facebook Access Token

facebook_business_idstring

Facebook Business ID

neto_api_keystring

Neto API Key

neto_api_usernamestring

Neto User Name

shopline_access_tokenstring

Shopline APP Key

shopline_app_keystring

Shopline APP Key

shopline_app_secretstring

Shopline App Secret

shopline_shared_secretstring

Shopline Shared Secret

shopify_access_tokenstring

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

shopify_client_idstring

Shopify Client ID

shopify_api_keystring

Shopify API Key

shopify_api_passwordstring

Shopify API Password

shopify_shared_secretstring

Shared secret

shopee_partner_idstring

Shopee Partner ID

shopee_partner_keystring

Shopee Partner Key

shopee_shop_idstring

Shopee SHOP ID

shopee_refresh_tokenstring

Shopee Refresh Token

shopee_regionstring

Shopee API endpoint Region. Use for Chinese Mainland or Brazil.

shopee_environmentstring

Shopee Environment

shoplazza_access_tokenstring

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

shoplazza_shared_secretstring

Shared secret

miva_access_tokenstring

Miva access token

miva_signaturestring

Miva signature

mirakl_api_keystring

Mirakl API Key

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

bigcartel_user_namestring

Subdomain of store

bigcartel_passwordstring

BigCartel account password

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.

volusion_loginstring

It's a Volusion account for which API is enabled

volusion_passwordstring

Volusion API 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'

square_client_idstring

Square (Weebly) Client ID

square_client_secretstring

Square (Weebly) Client Secret

square_refresh_tokenstring

Square (Weebly) Refresh Token

squarespace_api_keystring

Squarespace API Key

squarespace_client_idstring

Squarespace Connector Client ID

squarespace_client_secretstring

Squarespace Connector Client Secret

squarespace_access_tokenstring

Squarespace access token

squarespace_refresh_tokenstring

Squarespace refresh token

hybris_client_idstring

Omni Commerce Connector Client ID

hybris_client_secretstring

Omni Commerce Connector Client Secret

hybris_usernamestring

User Name

hybris_passwordstring

User password

hybris_websitesstring[]

Websites to stores mapping data

lightspeed_api_keystring

LightSpeed api key

lightspeed_api_secretstring

LightSpeed api secret

commercehq_api_keystring

CommerceHQ api key

commercehq_api_passwordstring

CommerceHQ api password

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

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

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

zoho_client_idstring

Zoho Client ID

zoho_client_secretstring

Zoho Client Secret

zoho_refresh_tokenstring

Zoho Refresh Token

zoho_regionstring

Zoho API endpoint Region

tiendanube_user_idinteger

Tiendanube User ID

tiendanube_access_tokenstring

Tiendanube Access Token

tiendanube_client_secretstring

Tiendanube Client Secret

otto_client_idstring

Otto Client ID

otto_client_secretstring

Otto Client Secret

otto_app_idstring

Otto App ID

otto_refresh_tokenstring

Otto Refresh Token

otto_environmentstring

Otto Environment

otto_access_tokenstring

Otto Access Token

tiktokshop_app_keystring

TikTok Shop App Key

tiktokshop_app_secretstring

TikTok Shop App Secret

tiktokshop_refresh_tokenstring

TikTok Shop Refresh Token

tiktokshop_access_tokenstring

TikTok Shop Access Token

salla_client_idstring

Salla Client ID

salla_client_secretstring

Salla Client Secret

salla_refresh_tokenstring

Salla Refresh Token

salla_access_tokenstring

Salla Access Token

temu_app_keystring

Temu App Key

temu_app_secretstring

Temu App Secret

temu_access_tokenstring

Temu Access Token

temu_regionstring

Temu API endpoint Region.

scapi_client_idstring

Salesforce Commerce API Client ID

scapi_client_secretstring

Salesforce Commerce API Client Secret

scapi_organization_idstring

Salesforce Commerce Organization ID

scapi_short_codestring

Salesforce Commerce Short Code

scapi_scopesstring

Salesforce Commerce API Scopes

idempotency_keystring

A unique identifier associated with a specific request. Repeated requests with the same <strong>idempotency_key</strong> return a cached response without re-executing the business logic. <strong>Please note that the cache lifetime is 15 minutes.</strong>

Response

successful operation

return_codeinteger
return_messagestring

Changes

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