Api2cart

Swagger API2Cart

API2Cart

E-commerce#openapi#ecommerce

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

API2Cart

Endpoints 146

account

  • POSTAccountCartAdd/account.cart.add.jsonAdd store to the account
  • GETAccountCartList/account.cart.list.json?params=force_all&exclude=string&request_from_date=string&request_to_date=string&store_url=string&store_key=stringGet list of carts.
  • PUTAccountConfigUpdate/account.config.update.json?new_store_key=string&bridge_url=string&store_root=string&db_tables_prefix=string&3dcart_private_key=string&3dcart_access_token=string&3dcartapi_api_key=string&amazon_sp_client_id=string&amazon_sp_client_secret=string&amazon_sp_aws_user_key_id=string&amazon_sp_aws_user_secret=string&amazon_sp_aws_region=string&amazon_sp_aws_role_arn=string&amazon_sp_refresh_token=string&amazon_sp_api_environment=production&amazon_access_token=string&amazon_seller_id=string&amazon_marketplaces_ids=string&amazon_secret_key=string&amazon_access_key_id=string&aspdotnetstorefront_api_user=string&aspdotnetstorefront_api_pass=string&bigcommerceapi_admin_account=string&bigcommerceapi_api_path=string&bigcommerceapi_api_key=string&bigcommerceapi_client_id=string&bigcommerceapi_access_token=string&bigcommerceapi_context=string&demandware_client_id=string&demandware_api_password=string&demandware_user_name=string&demandware_user_password=string&ebay_client_id=string&ebay_client_secret=string&ebay_runame=string&ebay_access_token=string&ebay_refresh_token=string&ebay_environment=string&ebay_site_id=0&ecwid_acess_token=string&ecwid_store_id=string&etsy_keystring=string&etsy_shared_secret=string&etsy_access_token=string&etsy_token_secret=string&etsy_client_id=string&etsy_refresh_token=string&neto_api_key=string&neto_api_username=string&shopify_api_key=string&shopify_api_password=string&shopify_shared_secret=string&shopify_access_token=string&shopware_access_key=string&shopware_api_key=string&shopware_api_secret=string&volusion_login=string&volusion_password=string&walmart_client_id=string&walmart_client_secret=string&walmart_environment=production&walmart_channel_type=string&squarespace_api_key=string&hybris_client_id=string&hybris_client_secret=string&hybris_username=string&hybris_password=string&hybris_websites=string&lightspeed_api_key=string&lightspeed_api_secret=string&commercehq_api_key=string&commercehq_api_password=string&wc_consumer_key=string&wc_consumer_secret=string&magento_consumer_key=string&magento_consumer_secret=string&magento_access_token=string&magento_token_secret=string&prestashop_webservice_key=string&wix_app_id=string&wix_app_secret_key=string&wix_refresh_token=string&mercado_libre_app_id=string&mercado_libre_app_secret_key=string&mercado_libre_refresh_token=string&zid_client_id=0&zid_client_secret=string&zid_access_token=string&zid_authorization=string&zid_refresh_token=stringUpdate configs in the API2Cart database.
  • GETAccountFailedWebhooks/account.failed_webhooks.json?count=10&start=0&ids=stringList webhooks that was not delivered to the callback.
  • GETAccountSupportedPlatforms/account.supported_platforms.jsonGet list of supported platforms

cart

  • GETBridgeDownload/bridge.download.file?whitelabel=falseDownload bridge for store
  • GETCartBridge/cart.bridge.jsonGet bridge key and store key
  • GETCartCatalogPriceRulesCount/cart.catalog_price_rules.count.jsonGet count of cart catalog price rules discounts.
  • GETCartCatalogPriceRulesList/cart.catalog_price_rules.list.json?page_cursor=string&start=0&count=10&ids=string&params=id,name,description&response_fields=string&exclude=stringGet cart catalog price rules discounts.
  • POSTCartClearCache/cart.clear_cache.json?cache_type=stringClear cache on store.
  • GETCartConfig/cart.config.json?params=store_name,store_url,db_prefix&exclude=stringGet list of cart configs
  • PUTCartConfigUpdate/cart.config.update.jsonDeprecated. Use this API method to update custom data in client database.
  • POSTCartCouponAdd/cart.coupon.add.jsonCreate new coupon
  • POSTCartCouponConditionAdd/cart.coupon.condition.add.json?store_id=string&coupon_id=string&target=coupon_prerequisite&entity=order&key=total&operator===&value=stringCreate new coupon condition
  • GETCartCouponCount/cart.coupon.count.json?store_id=string&date_start_from=string&date_start_to=string&date_end_from=string&date_end_to=string&avail=trueGet cart coupons count.
  • DELETECartCouponDelete/cart.coupon.delete.json?id=string&store_id=stringDelete coupon
  • GETCartCouponList/cart.coupon.list.json?page_cursor=string&start=0&count=10&coupons_ids=string&store_id=string&date_start_from=string&date_start_to=string&date_end_from=string&date_end_to=string&avail=true&lang_id=string&params=id,code,name,description&response_fields=string&exclude=stringGet cart coupon discounts.
  • POSTCartCreate/cart.create.json?cart_id=3DCart&store_url=string&bridge_url=string&store_root=string&store_key=string&shared_secret=string&validate_version=false&verify=true&db_tables_prefix=string&ftp_host=string&ftp_user=string&ftp_password=string&ftp_port=0&ftp_store_dir=string&apiKey_3dcart=string&AdminAccount=string&ApiPath=string&ApiKey=string&client_id=string&accessToken=string&context=string&access_token=string&apiKey_shopify=string&apiPassword=string&accessToken_shopify=string&apiKey=string&apiUsername=string&EncryptedPassword=string&Login=string&apiUser_adnsf=string&apiPass=string&accessKey_scelite=string&apiKey_scelite=string&apiSecretKey_scelite=string&privateKey=string&appToken=string&etsy_keystring=string&etsy_shared_secret=string&tokenSecret=string&etsy_client_id=string&etsy_refresh_token=string&ebay_client_id=string&ebay_client_secret=string&ebay_runame=string&ebay_access_token=string&ebay_refresh_token=string&ebay_environment=production&ebay_site_id=0&dw_client_id=string&dw_api_pass=string&demandware_user_name=string&demandware_user_password=string&store_id=string&seller_id=string&amazon_secret_key=string&amazon_access_key_id=string&marketplaces_ids=string&environment=production&hybris_client_id=string&hybris_client_secret=string&hybris_username=string&hybris_password=string&hybris_websites=string&walmart_client_id=string&walmart_client_secret=string&walmart_environment=production&walmart_channel_type=string&lightspeed_api_key=string&lightspeed_api_secret=string&shopware_access_key=string&shopware_api_key=string&shopware_api_secret=string&commercehq_api_key=string&commercehq_api_password=string&3dcart_private_key=string&3dcart_access_token=string&wc_consumer_key=string&wc_consumer_secret=string&magento_consumer_key=string&magento_consumer_secret=string&magento_access_token=string&magento_token_secret=string&prestashop_webservice_key=string&wix_app_id=string&wix_app_secret_key=string&wix_refresh_token=string&mercado_libre_app_id=string&mercado_libre_app_secret_key=string&mercado_libre_refresh_token=string&zid_client_id=0&zid_client_secret=string&zid_access_token=string&zid_authorization=string&zid_refresh_token=stringDeprecated. Add store to the account
  • DELETECartDelete/cart.delete.json?delete_bridge=trueRemove store from API2Cart
  • GETCartDisconnect/cart.disconnect.json?delete_bridge=falseDeprecated. Disconnect with the store and clear store session data.
  • POSTCartGiftcardAdd/cart.giftcard.add.json?amount=0.0&code=string&owner_email=string&recipient_email=stringCreate new gift card
  • GETCartGiftcardCount/cart.giftcard.count.json?store_id=stringGet gift cards count.
  • GETCartGiftcardList/cart.giftcard.list.json?page_cursor=string&start=0&count=10&store_id=string&params=id,code,name&response_fields=string&exclude=stringGet gift cards list.
  • GETCartInfo/cart.info.json?params=store_name,store_url,db_prefix&response_fields=string&exclude=string&store_id=stringGet cart information
  • GETCartList/cart.list.jsonDeprecated. Get list of supported carts
  • GETCartMetaDataList/cart.meta_data.list.json?entity_id=string&entity=product&store_id=string&key=string&count=10&page_cursor=string&params=key,value&response_fields=string&exclude=stringGet entity meta data
  • POSTCartMetaDataSet/cart.meta_data.set.json?entity_id=string&entity=product&store_id=string&key=string&value=string&namespace=stringSet meta data for a specific entity
  • DELETECartMetaDataUnset/cart.meta_data.unset.json?entity_id=string&entity=product&store_id=string&key=string&id=stringUnset meta data for a specific entity
  • GETCartMethods/cart.methods.jsonGet list of cart methods
  • GETCartPluginList/cart.plugin.list.json?store_key=string&store_id=string&start=0&count=10Get list of installed plugins
  • POSTCartScriptAdd/cart.script.add.json?name=string&description=string&html=string&src=string&load_method=string&scope=storefront&store_id=stringAdd new script to the storefront
  • DELETECartScriptDelete/cart.script.delete.json?id=string&store_id=stringRemove script from the storefront
  • GETCartScriptList/cart.script.list.json?page_cursor=string&start=0&count=10&created_from=string&created_to=string&modified_from=string&modified_to=string&script_ids=string&store_id=string&params=id,name,description&response_fields=string&exclude=stringGet scripts installed to the storefront
  • GETCartShippingZonesList/cart.shipping_zones.list.json?store_id=string&start=0&count=10&params=id,name,enabled&response_fields=string&exclude=stringGet list of shipping zones
  • GETCartValidate/cart.validate.json?validate_version=falseCheck store availability, bridge connection for the downloadable carts, identify DB prefix, validate API accesses for API carts.

product

  • POSTProductAdd/product.add.jsonAdd new product to store.
  • GETProductAttributeList/product.attribute.list.json?product_id=string&attribute_id=string&variant_id=string&page_cursor=string&start=0&count=10&attribute_group_id=string&set_name=string&lang_id=string&store_id=string&sort_by=attribute_id&sort_direction=asc&params=attribute_id,name&response_fields=string&exclude=stringGet list of attributes and values.
  • POSTProductAttributeValueSet/product.attribute.value.set.json?product_id=string&attribute_id=string&attribute_group_id=string&attribute_name=string&value=string&value_id=0&lang_id=string&store_id=stringSet attribute value to product.
  • POSTProductAttributeValueUnset/product.attribute.value.unset.json?product_id=string&attribute_id=string&store_id=string&include_default=false&reindex=true&clear_cache=trueRemoves attribute value for a product.
  • GETProductBrandList/product.brand.list.json?start=0&count=10&params=id,name,short_description,active,url&brand_ids=string&exclude=string&store_id=string&lang_id=string&created_from=string&created_to=string&modified_from=string&modified_to=string&response_fields=stringGet list of brands from your store.
  • GETProductChildItemFind/product.child_item.find.json?find_value=string&find_where=name&find_params=whole_words&store_id=stringSearch product child item (bundled item or configurable product variant) in store catalog.
  • GETProductChildItemInfo/product.child_item.info.json?params=force_all&response_fields=string&exclude=string&product_id=string&id=string&store_id=string&lang_id=string&currency_id=stringGet child for specific product.
  • GETProductChildItemList/product.child_item.list.json?page_cursor=string&start=0&count=10&params=force_all&response_fields=string&exclude=string&created_from=string&created_to=string&modified_from=string&modified_to=string&product_id=string&product_ids=string&store_id=string&lang_id=string&currency_id=string&avail_sale=true&report_request_id=string&disable_report_cache=falseGet child items list of specific product(s).
  • GETProductCount/product.count.json?category_id=string&created_from=string&created_to=string&modified_from=string&modified_to=string&avail_view=true&avail_sale=true&store_id=string&lang_id=string&product_ids=string&report_request_id=string&disable_report_cache=false&brand_name=string&product_attributes=string&status=string&type=stringCount products in store.
  • POSTProductCurrencyAdd/product.currency.add.json?iso3=string&rate=0.0&name=string&avail=true&symbol_left=string&symbol_right=string&default=falseAdd currency and/or set default in store
  • GETProductCurrencyList/product.currency.list.json?start=0&count=10&params=name,iso3,default,avail&page_cursor=string&exclude=string&response_fields=string&default=true&avail=trueGet list of currencies
  • DELETEProductDelete/product.delete.json?id=stringProduct delete
  • GETProductFields/product.fields.jsonRetrieve all available fields for product item in store.
  • GETProductFind/product.find.json?find_value=string&find_where=name&find_params=whole_words&find_what=product&lang_id=string&store_id=stringSearch product in store catalog. "Apple" is specified here by default.
  • POSTProductImageAdd/product.image.add.jsonAdd image to product
  • DELETEProductImageDelete/product.image.delete.json?product_id=string&id=string&store_id=stringDelete image
  • PUTProductImageUpdate/product.image.update.json?product_id=string&image_name=string&type=additional&label=string&position=0&id=string&store_id=string&lang_id=string&hidden=trueUpdate details of image
  • GETProductInfo/product.info.json?id=string&params=id,name,description,price,categories_ids&response_fields=string&exclude=string&store_id=string&lang_id=string&currency_id=string&report_request_id=string&disable_report_cache=falseGet product info about product ID * or specify other product ID.
  • GETProductList/product.list.json?page_cursor=string&start=0&count=10&params=id,name,description,price,categories_ids&response_fields=string&exclude=string&category_id=string&created_from=string&created_to=string&modified_from=string&modified_to=string&avail_view=true&avail_sale=true&store_id=string&lang_id=string&currency_id=string&product_ids=string&since_id=0&report_request_id=string&disable_report_cache=false&sort_by=id&sort_direction=asc&sku=string&disable_cache=false&brand_name=string&product_attributes=string&status=string&type=stringGet list of products from your store. Returns 10 products by default.
  • POSTProductManufacturerAdd/product.manufacturer.add.json?product_id=string&manufacturer=stringAdd manufacturer to store and assign to product
  • POSTProductOptionAdd/product.option.add.json?name=string&type=option_type_select&product_id=string&default_option_value=string&option_values=string&description=string&avail=true&sort_order=0&required=false&clear_cache=trueAdd product option from store.
  • POSTProductOptionAssign/product.option.assign.json?product_id=string&option_id=string&required=false&sort_order=0&option_values=string&clear_cache=trueAssign option from product.
  • GETProductOptionList/product.option.list.json?start=0&count=10&params=id,name,description&exclude=string&response_fields=string&product_id=string&lang_id=string&store_id=stringGet list of options.
  • POSTProductOptionValueAdd/product.option.value.add.json?product_id=string&option_id=string&option_value=string&sort_order=0&clear_cache=trueAdd product option item from option.
  • POSTProductOptionValueAssign/product.option.value.assign.json?product_option_id=0&option_value_id=0&clear_cache=trueAssign product option item from product.
  • PUTProductOptionValueUpdate/product.option.value.update.json?product_id=string&option_id=string&option_value_id=0&option_value=string&price=0.0&quantity=0.0&clear_cache=trueUpdate product option item from option.
  • POSTProductPriceAdd/product.price.add.jsonAdd some prices to the product.
  • DELETEProductPriceDelete/product.price.delete.json?product_id=string&group_prices=stringDelete some prices of the product
  • PUTProductPriceUpdate/product.price.update.jsonUpdate some prices of the product.
  • GETProductReviewList/product.review.list.json?start=0&page_cursor=string&count=10&product_id=string&ids=string&store_id=string&status=string&params=id,customer_id,email,message,status,product_id,nick_name,summary,rating,ratings,status,created_time&exclude=string&response_fields=stringGet reviews of a specific product.
  • POSTProductStoreAssign/product.store.assign.json?product_id=string&store_id=stringAssign product to store
  • POSTProductTaxAdd/product.tax.add.jsonAdd tax class and tax rate to store and assign to product.
  • PUTProductUpdate/product.update.json?id=string&model=string&old_price=0.0&price=0.0&special_price=0.0&sprice_create=string&sprice_expire=string&cost_price=0.0&retail_price=0.0&quantity=0.0&weight=0.0&increase_quantity=0.0&reduce_quantity=0.0&warehouse_id=string&reserve_quantity=0.0&manage_stock=true&backorder_status=string&name=string&sku=string&visible=string&manufacturer=string&manufacturer_id=string&categories_ids=string&description=string&short_description=string&meta_title=string&meta_keywords=string&meta_description=string&store_id=string&lang_id=string&in_stock=true&status=string&seo_url=string&report_request_id=string&disable_report_cache=false&reindex=true&tags=string&clear_cache=true&gtin=string&taxable=true&product_class=string&height=0.0&length=0.0&width=0.0&harmonized_system_code=string&country_of_origin=string&search_keywords=string&barcode=stringUpdate price and quantity for a specific product
  • POSTProductVariantAdd/product.variant.add.jsonAdd variant to product.
  • GETProductVariantCount/product.variant.count.json?created_from=string&created_to=string&modified_from=string&modified_to=string&category_id=string&product_id=string&store_id=stringGet count variants.
  • DELETEProductVariantDelete/product.variant.delete.json?id=string&product_id=stringDelete variant.
  • POSTProductVariantImageAdd/product.variant.image.add.jsonAdd image to product
  • DELETEProductVariantImageDelete/product.variant.image.delete.json?product_id=string&product_variant_id=0&id=string&store_id=stringDelete image to product
  • GETProductVariantInfo/product.variant.info.json?params=id,name,description,price&exclude=string&id=string&store_id=stringGet variant info.
  • GETProductVariantList/product.variant.list.json?start=0&count=10&params=id,name,description,price&exclude=string&created_from=string&created_to=string&modified_from=string&modified_to=string&category_id=string&product_id=string&store_id=stringGet list variants.
  • POSTProductVariantPriceAdd/product.variant.price.add.jsonAdd some prices to the product variant.
  • DELETEProductVariantPriceDelete/product.variant.price.delete.json?id=string&group_prices=stringDelete some prices of the product variant.
  • PUTProductVariantPriceUpdate/product.variant.price.update.jsonUpdate some prices of the product variant.
  • PUTProductVariantUpdate/product.variant.update.json?store_id=string&id=string&product_id=string&warehouse_id=string&reserve_quantity=0.0&quantity=0.0&increase_quantity=0&reduce_quantity=0&price=0.0&special_price=0.0&retail_price=0.0&old_price=0.0&cost_price=0.0&sprice_create=string&sprice_expire=string&manage_stock=true&in_stock=true&name=string&description=string&sku=string&meta_title=string&meta_description=string&meta_keywords=string&short_description=string&visible=string&status=string&backorder_status=string&weight=0&barcode=string&reindex=true&taxable=true&options=string&harmonized_system_code=string&country_of_origin=string&width=0.0&height=0.0&length=0.0&gtin=string&clear_cache=true&lang_id=string&model=string&available_for_sale=trueUpdate variant.

category

  • POSTCategoryAdd/category.add.json?name=string&parent_id=string&stores_ids=0&store_id=string&lang_id=string&avail=true&sort_order=0&created_time=string&modified_time=string&description=string&meta_title=string&meta_description=string&meta_keywords=string&seo_url=stringAdd new category in store
  • POSTCategoryAssign/category.assign.json?product_id=string&category_id=string&store_id=stringAssign category to product
  • GETCategoryCount/category.count.json?parent_id=string&store_id=string&lang_id=string&created_from=string&created_to=string&modified_from=string&modified_to=string&avail=trueCount categories in store.
  • DELETECategoryDelete/category.delete.json?id=stringDelete category in store
  • GETCategoryFind/category.find.json?find_value=string&find_where=name&find_params=whole_words&store_id=string&lang_id=stringSearch category in store. "Laptop" is specified here by default.
  • POSTCategoryImageAdd/category.image.add.json?category_id=string&image_name=string&url=string&label=string&mime=string&type=base&position=0&store_id=stringAdd image to category
  • DELETECategoryImageDelete/category.image.delete.json?category_id=string&image_id=string&store_id=stringDelete image
  • GETCategoryInfo/category.info.json?id=string&params=id,parent_id,name,description&response_fields=string&exclude=string&store_id=string&lang_id=stringGet category info about category ID* or specify other category ID.
  • GETCategoryList/category.list.json?start=0&count=10&page_cursor=string&parent_id=string&params=id,parent_id,name,description&response_fields=string&exclude=string&store_id=string&lang_id=string&created_from=string&created_to=string&modified_from=string&modified_to=string&avail=trueGet list of categories from store.
  • POSTCategoryUnassign/category.unassign.json?category_id=string&product_id=string&store_id=stringUnassign category to product
  • PUTCategoryUpdate/category.update.json?id=string&name=string&parent_id=string&stores_ids=0&avail=true&sort_order=0&modified_time=string&description=string&meta_title=string&meta_description=string&meta_keywords=string&seo_url=string&lang_id=string&store_id=stringUpdate category in store

order

  • GETOrderAbandonedList/order.abandoned.list.json?customer_id=string&customer_email=string&created_to=string&created_from=string&modified_to=string&modified_from=string&skip_empty_email=false&store_id=string&page_cursor=string&count=10&start=0&params=customer,totals,items&response_fields=string&exclude=stringGet list of orders that were left by customers before completing the order.
  • POSTOrderAdd/order.add.jsonAdd a new order to the cart.
  • GETOrderCount/order.count.json?customer_id=string&customer_email=string&order_status=string&order_status_ids=string&created_to=string&created_from=string&modified_to=string&modified_from=string&store_id=string&ids=string&order_ids=string&ebay_order_status=string&financial_status=string&fulfillment_status=string&shipping_method=string&delivery_method=string&ship_node_type=stringCount orders in store
  • GETOrderFinancialStatusList/order.financial_status.list.jsonRetrieve list of financial statuses
  • GETOrderFind/order.find.json?customer_id=string&customer_email=string&order_status=string&start=0&count=10&params=order_id,customer,totals,address,items,bundles,status&exclude=string&created_to=string&created_from=string&modified_to=string&modified_from=string&financial_status=stringDeprecated. This method is deprecated and won't be supported in the future. Please use "order.list" instead.
  • GETOrderFulfillmentStatusList/order.fulfillment_status.list.jsonRetrieve list of fulfillment statuses
  • GETOrderInfo/order.info.json?order_id=string&id=string&params=order_id,customer,totals,address,items,bundles,status&response_fields=string&exclude=string&store_id=string&enable_cache=falseInfo about a specific order by ID
  • GETOrderList/order.list.json?customer_id=string&customer_email=string&phone=string&order_status=string&order_status_ids=string&start=0&count=10&page_cursor=string&sort_by=order_id&sort_direction=asc&params=order_id,customer,totals,address,items,bundles,status&response_fields=string&exclude=string&created_to=string&created_from=string&modified_to=string&modified_from=string&store_id=string&ids=string&order_ids=string&ebay_order_status=string&basket_id=string&financial_status=string&fulfillment_status=string&shipping_method=string&skip_order_ids=string&since_id=0&is_deleted=true&shipping_country_iso3=string&enable_cache=false&delivery_method=string&ship_node_type=string&currency_id=stringGet list of orders from store.
  • POSTOrderPreestimateShippingList/order.preestimate_shipping.list.jsonRetrieve list of order preestimated shipping methods
  • POSTOrderRefundAdd/order.refund.add.jsonAdd a refund to the order.
  • POSTOrderShipmentAdd/order.shipment.add.jsonAdd a shipment to the order.
  • DELETEOrderShipmentDelete/order.shipment.delete.json?shipment_id=string&order_id=string&store_id=stringDelete order's shipment.
  • GETOrderShipmentInfo/order.shipment.info.json?id=string&order_id=string&start=0&params=id,order_id,items,tracking_numbers&response_fields=string&exclude=string&store_id=stringGet information of shipment.
  • GETOrderShipmentList/order.shipment.list.json?order_id=string&page_cursor=string&start=0&count=10&params=id,order_id,items,tracking_numbers&response_fields=string&exclude=string&created_from=string&created_to=string&modified_from=string&modified_to=string&store_id=stringGet list of shipments by orders.
  • POSTOrderShipmentTrackingAdd/order.shipment.tracking.add.jsonAdd order shipment's tracking info.
  • PUTOrderShipmentUpdate/order.shipment.update.jsonUpdate order's shipment information.
  • GETOrderStatusList/order.status.list.json?store_id=stringRetrieve list of statuses
  • GETOrderTransactionList/order.transaction.list.json?count=10&order_ids=string&store_id=string&params=id,order_id,amount,description&response_fields=string&exclude=string&page_cursor=stringRetrieve list of order transaction
  • PUTOrderUpdate/order.update.json?order_id=string&store_id=string&order_status=string&comment=string&admin_comment=string&admin_private_comment=string&date_modified=string&date_finished=string&financial_status=string&fulfillment_status=string&order_payment_method=string&send_notifications=falseUpdate existing order.

customer

  • POSTCustomerAdd/customer.add.jsonAdd customer into store.
  • GETCustomerAttributeList/customer.attribute.list.json?count=10&page_cursor=string&customer_id=string&store_id=string&lang_id=string&params=force_all&exclude=string&response_fields=stringGet attributes for specific customer
  • GETCustomerCount/customer.count.json?group_id=string&created_from=string&created_to=string&modified_from=string&modified_to=string&store_id=string&customer_list_id=string&avail=trueGet number of customers from store.
  • GETCustomerFind/customer.find.json?find_value=string&find_where=email&find_params=whole_words&store_id=stringFind customers in store.
  • POSTCustomerGroupAdd/customer.group.add.json?name=string&store_id=string&stores_ids=stringCreate customer group.
  • GETCustomerGroupList/customer.group.list.json?page_cursor=string&start=0&count=10&store_id=string&lang_id=string&group_ids=string&params=id,name,additional_fields&exclude=string&response_fields=stringGet list of customers groups.
  • GETCustomerInfo/customer.info.json?id=string&params=id,email,first_name,last_name&response_fields=string&exclude=string&store_id=stringGet customers' details from store.
  • GETCustomerList/customer.list.json?page_cursor=string&start=0&count=10&created_from=string&created_to=string&modified_from=string&modified_to=string&params=id,email,first_name,last_name&response_fields=string&exclude=string&group_id=string&store_id=string&customer_list_id=string&avail=trueGet list of customers from store.
  • PUTCustomerUpdate/customer.update.json?id=string&group_id=string&group_ids=string&first_name=string&last_name=string&news_letter_subscription=true&tags=string&address_book_id_{x}=string&address_book_first_name_{x}=string&address_book_last_name_{x}=string&address_book_company_{x}=string&address_book_phone_{x}=string&address_book_address1_{x}=string&address_book_address2_{x}=string&address_book_city_{x}=string&address_book_country_{x}=string&address_book_state_{x}=string&address_book_postcode_{x}=stringUpdate information of customer in store.

attribute

  • POSTAttributeAdd/attribute.add.json?type=text&code=string&name=string&store_id=string&lang_id=string&visible=false&required=false&position=0&attribute_group_id=string&is_global=Store&is_searchable=false&is_filterable=No&is_comparable=false&is_html_allowed_on_front=false&is_filterable_in_search=false&is_configurable=false&is_visible_in_advanced_search=false&is_used_for_promo_rules=false&used_in_product_listing=false&used_for_sort_by=false&apply_to=all_typesAdd new attribute
  • POSTAttributeAssignGroup/attribute.assign.group.json?id=string&group_id=string&attribute_set_id=stringAssign attribute to the group
  • POSTAttributeAssignSet/attribute.assign.set.json?id=string&group_id=string&attribute_set_id=stringAssign attribute to the attribute set
  • GETAttributeAttributesetList/attribute.attributeset.list.json?start=0&count=10&params=id,name&exclude=string&response_fields=stringGet attribute_set list
  • GETAttributeCount/attribute.count.json?type=string&store_id=string&lang_id=string&visible=true&required=true&system=trueGet attributes count
  • DELETEAttributeDelete/attribute.delete.json?store_id=string&id=stringDelete attribute from store
  • GETAttributeGroupList/attribute.group.list.json?start=0&count=10&lang_id=string&params=id,name&exclude=string&response_fields=string&attribute_set_id=stringGet attribute group list
  • GETAttributeInfo/attribute.info.json?id=string&store_id=string&lang_id=string&params=force_all&exclude=string&response_fields=stringGet attribute info
  • GETAttributeList/attribute.list.json?start=0&count=10&type=string&attribute_ids=string&store_id=string&lang_id=string&params=id,name,code,type&exclude=string&response_fields=string&visible=true&required=true&system=trueGet attributes list
  • GETAttributeTypeList/attribute.type.list.jsonGet list of supported attributes types
  • POSTAttributeUnassignGroup/attribute.unassign.group.json?id=string&group_id=stringUnassign attribute from group
  • POSTAttributeUnassignSet/attribute.unassign.set.json?id=string&attribute_set_id=stringUnassign attribute from attribute set
  • POSTAttributeUpdate/attribute.update.json?id=string&name=string&store_id=string&lang_id=stringUpdate attribute data

tax

  • GETTaxClassInfo/tax.class.info.json?tax_class_id=string&store_id=string&lang_id=string&params=tax_class_id,name,avail&response_fields=string&exclude=stringGet info about tax

webhook

  • GETWebhookCount/webhook.count.json?entity=string&action=string&active=trueCount registered webhooks on the store.
  • POSTWebhookCreate/webhook.create.json?entity=string&action=string&callback=string&label=string&fields=force_all&active=true&store_id=stringCreate webhook on the store and subscribe to it.
  • DELETEWebhookDelete/webhook.delete.json?id=stringDelete registered webhook on the store.
  • GETWebhookEvents/webhook.events.jsonList all Webhooks that are available on this store.
  • GETWebhookList/webhook.list.json?params=id,entity,action,callback&start=0&count=10&entity=string&action=string&active=true&ids=stringList registered webhook on the store.
  • PUTWebhookUpdate/webhook.update.json?id=string&callback=string&label=string&fields=string&active=trueUpdate Webhooks parameters.

basket

  • GETBasketInfo/basket.info.json?id=string&store_id=string&params=force_all&exclude=string&response_fields=stringRetrieve basket information.
  • POSTBasketItemAdd/basket.item.add.json?customer_id=string&product_id=string&variant_id=string&quantity=0&store_id=stringAdd item to basket
  • POSTBasketLiveShippingServiceCreate/basket.live_shipping_service.create.json?store_id=string&name=string&callback=stringCreate live shipping rate service. (Beta)
  • DELETEBasketLiveShippingServiceDelete/basket.live_shipping_service.delete.json?id=0Delete live shipping rate service. (Beta)
  • GETBasketLiveShippingServiceList/basket.live_shipping_service.list.json?store_id=string&start=0&count=10Retrieve a list of live shipping rate services. (Beta)

bridge

  • POSTBridgeDelete/bridge.delete.jsonDelete bridge from the store.
  • POSTBridgeUpdate/bridge.update.jsonUpdate bridge in the store.

subscriber

  • GETSubscriberList/subscriber.list.json?start=0&count=10&subscribed=true&store_id=string&email=string&params=force_all&exclude=string&created_from=string&created_to=string&modified_from=string&modified_to=string&page_cursor=string&response_fields=stringGet subscribers list

API details

Base URL
https://api.api2cart.com/v1.1
Authentication
An API key in the x-api-key header
An API key in the x-store-key header
Operations
146 operations on 146 pathsGET 71POST 46DELETE 16PUT 13
5 marked deprecated
Main resources
product 44cart 30order 19attribute 13category 11customer 9webhook 6account 5basket 5bridge 2
Response formats
application/json application/zip
Description format
OpenAPI 3.0.0, API version 1.1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Swagger API2Cart in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Swagger API2Cart collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the x-api-key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “AccountCartAdd” (POST /account.cart.add.json), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Swagger API2Cart?

API2Cart It is listed under E-commerce and has 146 endpoints.

Who publishes the Swagger API2Cart?

It is listed from Api2cart's public API description (an OpenAPI document), not published by Api2cart on Swastik Codes. Anyone who controls api2cart.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Swagger API2Cart?

Requests go to https://api.api2cart.com/v1.1. Endpoint paths are added to this base URL.

How do I authenticate with the Swagger API2Cart?

It accepts 2 methods: an API key in the x-api-key header; an API key in the x-store-key header.

How many endpoints does the Swagger API2Cart have?

146 operations on 146 paths (71 GET, 46 POST, 16 DELETE, 13 PUT). The largest groups are product, cart, order, attribute.

Is forking the Swagger API2Cart free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.