openapi-directory/api/api2cart.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"email":"contact@api2cart.com","x-twitter":"API2Cart"},"description":"API2Cart","termsOfService":"https://api2cart.com/terms-service","title":"Swagger API2Cart","version":"1.0.0","x-apisguru-categories":["ecommerce"],"x-logo":{"url":"https://twitter.com/API2Cart/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://app.api2cart.com/default/index/swagger-json","version":"2.0"}],"x-providerName":"api2cart.com"},"externalDocs":{"description":"Find out more about API2Cart","url":"http://docs.api2cart.com"},"tags":[{"name":"account"},{"name":"cart"},{"name":"product"},{"name":"category"},{"name":"order"},{"name":"customer"},{"name":"attribute"},{"name":"tax"},{"name":"webhook"}],"paths":{"/account.cart.list.json":{"get":{"description":"Get list of carts.","operationId":"AccountCartList","parameters":[{"description":"Set this parameter in order to choose which entity fields you want to retrieve","in":"query","name":"params","required":false,"schema":{"type":"string","default":"id,url,store_key,cart_id,requests_count"}},{"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","in":"query","name":"exclude","required":false,"schema":{"type":"string"}},{"description":"Retrieve entities from their creation date","in":"query","name":"request_from_date","required":false,"schema":{"type":"string"}},{"description":"Retrieve entities to their creation date","in":"query","name":"request_to_date","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"carts":{"items":{"properties":{"cart_id":{"type":"string"},"id":{"type":"string"},"store_key":{"type":"string"},"total_calls":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"carts_count":{"type":"integer"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[]}],"tags":["account"]}},"/account.config.update.json":{"put":{"description":"Update configs in the API2Cart database.","operationId":"AccountConfigUpdate","parameters":[{"description":"This parameter is deprecated for this method. Please, use this parameter in method account.config.update","in":"query","name":"db_tables_prefix","required":false,"schema":{"type":"string"}},{"description":"Client ID of the requesting app.","in":"query","name":"client_id","required":false,"schema":{"type":"string"}},{"description":"This parameter allows to set up store with custom bridge url (you must use store_root parameter if a bridge folder is not in the root folder of the store)","in":"query","name":"bridge_url","required":false,"schema":{"type":"string"}},{"description":"Absolute path to the store root directory (used with \"bridge_url\" parameter)","in":"query","name":"store_root","required":false,"schema":{"type":"string"}},{"description":"Shared secret","in":"query","name":"shared_secret","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"updated_items":{"type":"integer"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["account"]}},"/account.failed_webhooks.json":{"get":{"description":"List webhooks that was not delivered to the callback.","operationId":"AccountFailedWebhooks","parameters":[{"description":"This parameter sets the entity amount that has to be retrieved","in":"query","name":"count","required":false,"schema":{"type":"integer","default":10}},{"description":"This parameter sets the number from which you want to get entities","in":"query","name":"start","required":false,"schema":{"type":"integer","default":0}},{"description":"List of сomma-separated webhook ids","in":"query","name":"ids","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"all_failed_webhook":{"type":"string"},"webhook":{"items":{"properties":{"entity_id":{"type":"string"},"time":{"$ref":"#/components/schemas/DateTime"},"webhook_id":{"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[]}],"tags":["account"]}},"/attribute.add.json":{"post":{"description":"Add new attribute","operationId":"AttributeAdd","parameters":[{"description":"Defines attribute's type","in":"query","name":"type","required":true,"schema":{"type":"string","enum":["text","select","textarea","date","price","multiselect","boolean"]}},{"description":"Defines attributes's name","in":"query","name":"name","required":true,"schema":{"type":"string"}},{"description":"Store Id","in":"query","name":"store_id","required":false,"schema":{"type":"string"}},{"description":"Language id","in":"query","name":"lang_id","required":false,"schema":{"type":"integer"}},{"description":"Set visibility status","in":"query","name":"visible","required":false,"schema":{"type":"boolean","default":false}},{"description":"Defines if the option is required","in":"query","name":"required","required":false,"schema":{"type":"boolean","default":false}},{"description":"Attribute`s position","in":"query","name":"position","required":false,"schema":{"type":"integer","default":0}},{"description":"Attribute saving scope","in":"query","name":"is_global","required":false,"schema":{"type":"string","enum":["Global","Store","Website"],"default":"Store"}},{"description":"Use attribute in Quick Search","in":"query","name":"is_searchable","required":false,"schema":{"type":"boolean","default":false}},{"description":"Use In Layered Navigation","in":"query","name":"is_filterable","required":false,"schema":{"type":"string","enum":["Filterable (with results)","Filterable (no results)","No"],"default":"No"}},{"description":"Comparable on Front-end","in":"query","name":"is_comparable","required":false,"schema":{"type":"boolean","default":false}},{"description":"Allow HTML Tags on Frontend","in":"query","name":"is_html_allowed_on_front","required":false,"schema":{"type":"boolean","default":false}},{"description":"Use In Search Results Layered Navigation","in":"query","name":"is_filterable_in_search","required":false,"schema":{"type":"boolean","default":false}},{"description":"Use To Create Configurable Product","in":"query","name":"is_configurable","required":false,"schema":{"type":"boolean","default":false}},{"description":"Use in Advanced Search","in":"query","name":"is_visible_in_advanced_search","required":false,"schema":{"type":"boolean","default":false}},{"description":"Use for Promo Rule Conditions","in":"query","name":"is_used_for_promo_rules","required":false,"schema":{"type":"boolean","default":false}},{"description":"Used in Product Listing","in":"query","name":"used_in_product_listing","required":false,"schema":{"type":"boolean","default":false}},{"description":"Used for Sorting in Product Listing","in":"query","name":"used_for_sort_by","required":false,"schema":{"type":"boolean","default":false}},{"description":"Types of products which can have this attribute","in":"query","name":"apply_to","required":false,"schema":{"type":"string","enum":["simple","configurable","virtual","bundle","downloadable","all_types"],"default":"all_types"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"id":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["attribute"]}},"/attribute.assign.group.json":{"post":{"description":"Assign attribute to the group","operationId":"AttributeAssignGroup","parameters":[{"description":"Entity id","in":"query","name":"id","required":true,"schema":{"type":"string"}},{"description":"Attribute group_id","in":"query","name":"group_id","required":true,"schema":{"type":"integer"}},{"description":"Attribute set id","in":"query","name":"attribute_set_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"assigned":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["attribute"]}},"/attribute.assign.set.json":{"post":{"description":"Assign attribute to the attribute set","operationId":"AttributeAssignSet","parameters":[{"description":"Entity id","in":"query","name":"id","required":true,"schema":{"type":"string"}},{"description":"Attribute group_id","in":"query","name":"group_id","required":false,"schema":{"type":"integer"}},{"description":"Attribute set id","in":"query","name":"attribute_set_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"assigned":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["attribute"]}},"/attribute.attributeset.list.json":{"get":{"description":"Get attribute_set list","operationId":"AttributeAttributesetList","parameters":[{"description":"This parameter sets the number from which you want to get entities","in":"query","name":"start","required":false,"schema":{"type":"integer","default":0}},{"description":"This parameter sets the entity amount that has to be retrieved","in":"query","name":"count","required":false,"schema":{"type":"integer","default":10}},{"description":"Set this parameter in order to choose which entity fields you want to retrieve","in":"query","name":"params","required":false,"schema":{"type":"string","default":"id,name"}},{"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","in":"query","name":"exclude","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"items":{"$ref":"#/components/schemas/StoreAttribute_Group"},"type":"array"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["attribute"]}},"/attribute.count.json":{"get":{"description":"Get attributes count","operationId":"AttributeCount","parameters":[{"description":"Defines attribute's type","in":"query","name":"type","required":false,"schema":{"type":"string","enum":["text","select","textarea","date","price","multiselect","boolean"]}},{"description":"Store Id","in":"query","name":"store_id","required":false,"schema":{"type":"string"}},{"description":"Language id","in":"query","name":"lang_id","required":false,"schema":{"type":"integer"}},{"description":"Filter items by visibility status","in":"query","name":"visible","required":false,"schema":{"type":"boolean"}},{"description":"Defines if the option is required","in":"query","name":"required","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"attributes_count":{"type":"integer"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["attribute"]}},"/attribute.delete.json":{"delete":{"description":"Delete attribute from store","operationId":"AttributeDelete","parameters":[{"description":"Store Id","in":"query","name":"store_id","required":false,"schema":{"type":"string"}},{"description":"Entity id","in":"query","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"deleted":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["attribute"]}},"/attribute.group.list.json":{"get":{"description":"Get attribute group list","operationId":"AttributeGroupList","parameters":[{"description":"This parameter sets the number from which you want to get entities","in":"query","name":"start","required":false,"schema":{"type":"integer","default":0}},{"description":"This parameter sets the entity amount that has to be retrieved","in":"query","name":"count","required":false,"schema":{"type":"integer","default":10}},{"description":"Set this parameter in order to choose which entity fields you want to retrieve","in":"query","name":"params","required":false,"schema":{"type":"string","default":"id,name"}},{"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","in":"query","name":"exclude","required":false,"schema":{"type":"string"}},{"description":"Attribute set id","in":"query","name":"attribute_set_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"items":{"$ref":"#/components/schemas/StoreAttribute_Group"},"type":"array"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["attribute"]}},"/attribute.info.json":{"get":{"description":"Get attribute info","operationId":"AttributeInfo","parameters":[{"description":"Entity id","in":"query","name":"id","required":true,"schema":{"type":"string"}},{"description":"Store Id","in":"query","name":"store_id","required":false,"schema":{"type":"string"}},{"description":"Language id","in":"query","name":"lang_id","required":false,"schema":{"type":"integer"}},{"description":"Set this parameter in order to choose which entity fields you want to retrieve","in":"query","name":"params","required":false,"schema":{"type":"string","default":"force_all"}},{"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","in":"query","name":"exclude","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/StoreAttribute"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["attribute"]}},"/attribute.list.json":{"get":{"description":"Get attributes list","operationId":"AttributeList","parameters":[{"description":"This parameter sets the number from which you want to get entities","in":"query","name":"start","required":false,"schema":{"type":"integer","default":0}},{"description":"This parameter sets the entity amount that has to be retrieved","in":"query","name":"count","required":false,"schema":{"type":"integer","default":10}},{"description":"Defines attribute's type","in":"query","name":"type","required":false,"schema":{"type":"string","enum":["text","select","textarea","date","price","multiselect","boolean"]}},{"description":"Filter attributes by ids","in":"query","name":"attribute_ids","required":false,"schema":{"type":"string"}},{"description":"Store Id","in":"query","name":"store_id","required":false,"schema":{"type":"string"}},{"description":"Retrieves attributes on specified language id","in":"query","name":"lang_id","required":false,"schema":{"type":"integer"}},{"description":"Set this parameter in order to choose which entity fields you want to retrieve","in":"query","name":"params","required":false,"schema":{"type":"string","default":"id,name"}},{"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","in":"query","name":"exclude","required":false,"schema":{"type":"string"}},{"description":"Filter items by visibility status","in":"query","name":"visible","required":false,"schema":{"type":"boolean"}},{"description":"Defines if the option is required","in":"query","name":"required","required":false,"schema":{"type":"boolean"}},{"description":"True if attribute is system","in":"query","name":"system","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"order":{"items":{"$ref":"#/components/schemas/StoreAttribute"},"type":"array"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["attribute"]}},"/attribute.type.list.json":{"get":{"description":"Get list of supported attributes types","operationId":"AttributeTypeList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"attribute_type":{"items":{"type":"string"},"type":"array"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["attribute"]}},"/attribute.unassign.group.json":{"post":{"description":"Unassign attribute from group","operationId":"AttributeUnassignGroup","parameters":[{"description":"Entity id","in":"query","name":"id","required":true,"schema":{"type":"string"}},{"description":"Customer group_id","in":"query","name":"group_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"unassigned":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["attribute"]}},"/attribute.unassign.set.json":{"post":{"description":"Unassign attribute from attribute set","operationId":"AttributeUnassignSet","parameters":[{"description":"Entity id","in":"query","name":"id","required":true,"schema":{"type":"string"}},{"description":"Attribute set id","in":"query","name":"attribute_set_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"unassigned":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["attribute"]}},"/basket.item.add.json":{"post":{"description":"Add item to basket","operationId":"BasketItemAdd","parameters":[{"description":"Retrieves orders specified by customer id","in":"query","name":"customer_id","required":true,"schema":{"type":"string"}},{"description":"Defines id of the product which should be added to the basket","in":"query","name":"product_id","required":true,"schema":{"type":"string"}},{"description":"Defines product's variants specified by variant id","in":"query","name":"variant_id","required":false,"schema":{"type":"string"}},{"description":"Defines new items quantity","in":"query","name":"quantity","required":false,"schema":{"type":"number","default":0}},{"description":"Store Id","in":"query","name":"store_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"added":{"type":"boolean"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["basket"]}},"/bridge.delete.json":{"post":{"description":"Delete bridge from the store.","operationId":"BridgeDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"deleted":{"type":"boolean"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["bridge"]}},"/bridge.download.json":{"get":{"description":"Download bridge for store","operationId":"BridgeDownload","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["cart"]}},"/bridge.update.json":{"post":{"description":"Update bridge in the store.","operationId":"BridgeUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"updated":{"type":"boolean"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["bridge"]}},"/cart.bridge.json":{"get":{"description":"Get bridge key and store key","operationId":"CartBridge","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"bridge":{"type":"string"},"store_key":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[]}],"tags":["cart"]}},"/cart.clear_cache.json":{"post":{"description":"Clear cache on store.","operationId":"CartClearCache","parameters":[{"description":"Defines which cache should be cleared.","in":"query","name":"cache_type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"cache_cleared":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["cart"]}},"/cart.config.json":{"get":{"description":"Get list of cart configs","operationId":"CartConfig","parameters":[{"description":"Set this parameter in order to choose which entity fields you want to retrieve","in":"query","name":"params","required":false,"schema":{"type":"string","default":"store_name,store_url,db_prefix"}},{"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","in":"query","name":"exclude","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"db_prefix":{"type":"string"},"store_name":{"type":"string"},"store_url":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["cart"]}},"/cart.config.update.json":{"put":{"deprecated":true,"description":"Use this API method to update custom data in client database.","operationId":"CartConfigUpdate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartConfigUpdate"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["cart"]}},"/cart.coupon.add.json":{"post":{"description":"Create new coupon","operationId":"CartCouponAdd","parameters":[{"description":"Coupon code","in":"query","name":"code","required":true,"schema":{"type":"string"}},{"description":"Coupon discount type","in":"query","name":"action_type","required":true,"schema":{"type":"string","enum":["percent","fixed"]}},{"description":"Defines where discount should be applied","in":"query","name":"action_apply_to","required":true,"schema":{"type":"string","enum":["order_total","item_price","shipping"]}},{"description":"Specify how discount should be applied. If scope=matching_items, then discount will be applied to each of the items that match action conditions. Scope order means that discount will be applied once.","in":"query","name":"action_scope","required":true,"schema":{"type":"string","enum":["order","matching_items"]}},{"description":"Defines the discount amount value.","in":"query","name":"action_amount","required":true,"schema":{"type":"number"}},{"description":"Defines when discount code will be available.","in":"query","name":"date_start","required":false,"schema":{"type":"string","default":"Current date and time"}},{"description":"Defines when discount code will be expired.","in":"query","name":"date_end","required":false,"schema":{"type":"string"}},{"description":"Usage limit for coupon.","in":"query","name":"usage_limit","required":false,"schema":{"type":"integer"}},{"description":"Usage limit per customer.","in":"query","name":"usage_limit_per_customer","required":false,"schema":{"type":"integer"}},{"description":"Defines entity for action condition.","in":"query","name":"action_condition_entity","required":false,"schema":{"type":"string","enum":["order","order_shipping_address","product","customer"]}},{"description":"Defines entity attribute code for action condition.","in":"query","name":"action_condition_key","required":false,"schema":{"type":"string","enum":["product_id","category_id","variant_id","country"]}},{"description":"Defines condition operator.","in":"query","name":"action_condition_operator","required":false,"schema":{"type":"string","enum":["ONE_OF","=="]}},{"description":"Defines condition attribute value/s. Can be comma separated string.","in":"query","name":"action_condition_value","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"coupon_id":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["cart"]}},"/cart.coupon.count.json":{"get":{"description":"Get cart coupons count.","operationId":"CartCouponCount","parameters":[{"description":"Store Id","in":"query","name":"store_id","required":false,"schema":{"type":"string"}},{"description":"Filter entity by date_start (greater or equal)","in":"query","name":"date_start_from","required":false,"schema":{"type":"string"}},{"description":"Filter entity by date_start (less or equal)","in":"query","name":"date_start_to","required":false,"schema":{"type":"string"}},{"description":"Filter entity by date_end (greater or equal)","in":"query","name":"date_end_from","required":false,"schema":{"type":"string"}},{"description":"Filter entity by date_end (less or equal)","in":"query","name":"date_end_to","required":false,"schema":{"type":"string"}},{"description":"Defines category's visibility status","in":"query","name":"avail","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"coupons_count":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["cart"]}},"/cart.coupon.delete.json":{"delete":{"description":"Delete coupon","operationId":"CartCouponDelete","parameters":[{"description":"Entity id","in":"query","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"deleted":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["cart"]}},"/cart.coupon.list.json":{"get":{"description":"Get cart coupon discounts.","operationId":"CartCouponList","parameters":[{"description":"This parameter sets the number from which you want to get entities","in":"query","name":"start","required":false,"schema":{"type":"integer","default":0}},{"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","in":"query","name":"count","required":false,"schema":{"type":"integer","default":10}},{"description":"Filter coupons by store id","in":"query","name":"store_id","required":false,"schema":{"type":"string"}},{"description":"Filter entity by date_start (greater or equal)","in":"query","name":"date_start_from","required":false,"schema":{"type":"string"}},{"description":"Filter entity by date_start (less or equal)","in":"query","name":"date_start_to","required":false,"schema":{"type":"string"}},{"description":"Filter entity by date_end (greater or equal)","in":"query","name":"date_end_from","required":false,"schema":{"type":"string"}},{"description":"Filter entity by date_end (less or equal)","in":"query","name":"date_end_to","required":false,"schema":{"type":"string"}},{"description":"Filter coupons by avail status","in":"query","name":"avail","required":false,"schema":{"type":"boolean"}},{"description":"Language id","in":"query","name":"lang_id","required":false,"schema":{"type":"integer"}},{"description":"Set this parameter in order to choose which entity fields you want to retrieve","in":"query","name":"params","required":false,"schema":{"type":"string","default":"force_all"}},{"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","in":"query","name":"exclude","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"coupon":{"items":{"$ref":"#/components/schemas/Coupon"},"type":"array"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["cart"]}},"/cart.create.json":{"post":{"description":"Add store to the account","operationId":"CartCreate","parameters":[{"description":"Store’s identifier which you can get from cart_list method","in":"query","name":"cart_id","required":true,"schema":{"type":"string"}},{"description":"A web address of a store that you would like to connect to API2Cart","in":"query","name":"store_url","required":true,"schema":{"type":"string"}},{"description":"This parameter allows to set up store with custom bridge url (you must use store_root parameter if a bridge folder is not in the root folder of the store)","in":"query","name":"bridge_url","required":false,"schema":{"type":"string"}},{"description":"Absolute path to the store root directory (used with \"bridge_url\" parameter)","in":"query","name":"store_root","required":false,"schema":{"type":"string"}},{"description":"Set this parameter if bridge is already uploaded to store","in":"query","name":"store_key","required":false,"schema":{"type":"string"}},{"description":"Shared secret","in":"query","name":"shared_secret","required":false,"schema":{"type":"string"}},{"description":"Specify if api2cart should validate cart version","in":"query","name":"validate_version","required":false,"schema":{"type":"boolean","default":false}},{"description":"Enables or disables cart's verification","in":"query","name":"verify","required":false,"schema":{"type":"boolean","default":true}},{"description":"This parameter is deprecated for this method. Please, use this parameter in method account.config.update","in":"query","name":"db_tables_prefix","required":false,"schema":{"type":"string"}},{"description":"FTP connection host","in":"query","name":"ftp_host","required":false,"schema":{"type":"string"}},{"description":"FTP User","in":"query","name":"ftp_user","required":false,"schema":{"type":"string"}},{"description":"FTP Password","in":"query","name":"ftp_password","required":false,"schema":{"type":"string"}},{"description":"FTP Port","in":"query","name":"ftp_port","required":false,"schema":{"type":"integer"}},{"description":"FTP Store dir","in":"query","name":"ftp_store_dir","required":false,"schema":{"type":"string"}},{"description":"3DCart API Key","in":"query","name":"apiKey_3dcart","required":false,"schema":{"type":"string"}},{"description":"It's a BigCommerce account for which API is enabled","in":"query","name":"AdminAccount","required":false,"schema":{"type":"string"}},{"description":"BigCommerce API URL","in":"query","name":"ApiPath","required":false,"schema":{"type":"string"}},{"description":"Bigcommerce API Key","in":"query","name":"ApiKey","required":false,"schema":{"type":"string"}},{"description":"Client ID of the requesting app.","in":"query","name":"client_id","required":false,"schema":{"type":"string"}},{"description":"Access token authorizing the app to access resources on behalf of a user","in":"query","name":"accessToken","required":false,"schema":{"type":"string"}},{"description":"Access token authorizing the app to access resources on behalf of a user","in":"query","name":"access_token","required":false,"schema":{"type":"string"}},{"description":"Shopify API Key","in":"query","name":"apiKey_shopify","required":false,"schema":{"type":"string"}},{"description":"Shopify API Password","in":"query","name":"apiPassword","required":false,"schema":{"type":"string"}},{"description":"Volusion API Password","in":"query","name":"EncryptedPassword","required":false,"schema":{"type":"string"}},{"description":"It's a Volusion account for which API is enabled","in":"query","name":"Login","required":false,"schema":{"type":"string"}},{"description":"It's a AspDotNetStorefront account for which API is available","in":"query","name":"apiUser_adnsf","required":false,"schema":{"type":"string"}},{"description":"AspDotNetStorefront API Password","in":"query","name":"apiPass","required":false,"schema":{"type":"string"}},{"description":"Shopping Cart Elite Access Key","in":"query","name":"accessKey_scelite","required":false,"schema":{"type":"string"}},{"description":"Shopping Cart Elite API Key","in":"query","name":"apiKey_scelite","required":false,"schema":{"type":"string"}},{"description":"Shopping Cart Elite API Secret Key","in":"query","name":"apiSecretKey_scelite","required":false,"schema":{"type":"string"}},{"description":"3DCart Application Private Key","in":"query","name":"privateKey","required":false,"schema":{"type":"string"}},{"description":"3DCart Token from Application","in":"query","name":"appToken","required":false,"schema":{"type":"string"}},{"description":"Etsy keystring","in":"query","name":"etsy_keystring","required":false,"schema":{"type":"string"}},{"description":"Etsy shared secret","in":"query","name":"etsy_shared_secret","required":false,"schema":{"type":"string"}},{"description":"Secret token authorizing the app to access resources on behalf of a user","in":"query","name":"tokenSecret","required":false,"schema":{"type":"string"}},{"description":"Application ID (AppID).","in":"query","name":"ebay_client_id","required":false,"schema":{"type":"string"}},{"description":"Shared Secret from eBay application","in":"query","name":"ebay_client_secret","required":false,"schema":{"type":"string"}},{"description":"The RuName value that eBay assigns to your application.","in":"query","name":"ebay_runame","required":false,"schema":{"type":"string"}},{"description":"Used to authenticate API requests.","in":"query","name":"ebay_access_token","required":false,"schema":{"type":"string"}},{"description":"Used to renew the access token.","in":"query","name":"ebay_refresh_token","required":false,"schema":{"type":"string"}},{"description":"","in":"query","name":"ebay_environment","required":false,"schema":{"type":"string","enum":["production","sandbox"],"default":"production"}},{"description":"Demandware client id","in":"query","name":"dw_client_id","required":false,"schema":{"type":"string"}},{"description":"Demandware api password","in":"query","name":"dw_api_pass","required":false,"schema":{"type":"string"}},{"description":"Store Id","in":"query","name":"store_id","required":false,"schema":{"type":"string"}},{"description":"Seller Id","in":"query","name":"seller_id","required":true,"schema":{"type":"string"}},{"description":"Comma separated marketplaces ids","in":"query","name":"marketplaces_ids","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"store_key":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[]}],"tags":["cart"]}},"/cart.delete.json":{"delete":{"description":"Remove store from API2Cart","operationId":"CartDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"store":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["cart"]}},"/cart.disconnect.json":{"get":{"description":"Disconnect with the store and clear store session data.","operationId":"CartDisconnect","parameters":[{"description":"Identifies if there is a necessity to delete bridge","in":"query","name":"delete_bridge","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"connection":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["cart"]}},"/cart.giftcard.add.json":{"post":{"description":"Create new gift card","operationId":"CartGiftcardAdd","parameters":[{"description":"Defines the gift card amount value.","in":"query","name":"amount","required":true,"schema":{"type":"number"}},{"description":"Gift card code","in":"query","name":"code","required":false,"schema":{"type":"string"}},{"description":"Gift card owner email","in":"query","name":"owner_email","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"code":{"type":"string"},"id":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["cart"]}},"/cart.giftcard.count.json":{"get":{"description":"Get gift cards count.","operationId":"CartGiftcardCount","parameters":[{"description":"Store Id","in":"query","name":"store_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"gift_cards_count":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["cart"]}},"/cart.giftcard.list.json":{"get":{"description":"Get gift cards list.","operationId":"CartGiftcardList","parameters":[{"description":"This parameter sets the number from which you want to get entities","in":"query","name":"start","required":false,"schema":{"type":"integer","default":0}},{"description":"This parameter sets the entity amount that has to be retrieved","in":"query","name":"count","required":false,"schema":{"type":"integer","default":10}},{"description":"Store Id","in":"query","name":"store_id","required":false,"schema":{"type":"string"}},{"description":"Set this parameter in order to choose which entity fields you want to retrieve","in":"query","name":"params","required":false,"schema":{"type":"string","default":"force_all"}},{"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","in":"query","name":"exclude","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"gift_card":{"items":{"$ref":"#/components/schemas/GiftCard"},"type":"array"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["cart"]}},"/cart.info.json":{"get":{"description":"Get cart information","operationId":"CartInfo","parameters":[{"description":"Set this parameter in order to choose which entity fields you want to retrieve","in":"query","name":"params","required":false,"schema":{"type":"string","default":"store_name,store_url,db_prefix"}},{"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","in":"query","name":"exclude","required":false,"schema":{"type":"string"}},{"description":"Store Id","in":"query","name":"store_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/Cart"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["cart"]}},"/cart.list.json":{"get":{"description":"Get list of supported carts","operationId":"CartList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"supported_carts":{"items":{"properties":{"cart_id":{"type":"string"},"cart_name":{"type":"string"},"cart_versions":{"type":"string"},"params":{"items":{"type":"string"},"type":"array"}},"type":"object"},"type":"array"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[]}],"tags":["cart"]}},"/cart.methods.json":{"get":{"description":"Get list of cart methods","operationId":"CartMethods","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"method":{"items":{"type":"string"},"type":"array"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["cart"]}},"/cart.plugin.list.json":{"get":{"description":"Get list of installed plugins","operationId":"CartPluginList","parameters":[{"description":"Set this parameter if bridge is already uploaded to store","in":"query","name":"store_key","required":false,"schema":{"type":"string"}},{"description":"Store Id","in":"query","name":"store_id","required":false,"schema":{"type":"string"}},{"description":"This parameter sets the number from which you want to get entities","in":"query","name":"start","required":false,"schema":{"type":"integer","default":0}},{"description":"This parameter sets the entity amount that has to be retrieved","in":"query","name":"count","required":false,"schema":{"type":"integer","default":10}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"all_plugins":{"type":"integer"},"plugins":{"items":{"$ref":"#/components/schemas/PluginList"},"type":"array"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["cart"]}},"/cart.validate.json":{"get":{"description":"Check store availability, bridge connection for the downloadable carts, identify DB prefix, validate API accesses for API carts.","operationId":"CartValidate","parameters":[{"description":"Specify if api2cart should validate cart version","in":"query","name":"validate_version","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"status":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["cart"]}},"/category.add.json":{"post":{"description":"Add new category in store","operationId":"CategoryAdd","parameters":[{"description":"Defines category's name that has to be added","in":"query","name":"name","required":true,"schema":{"type":"string"}},{"description":"Adds categories specified by parent id","in":"query","name":"parent_id","required":false,"schema":{"type":"string"}},{"description":"Create category in the stores that is specified by comma-separated stores' id","in":"query","name":"stores_ids","required":false,"schema":{"type":"string","default":"0"}},{"description":"Store Id","in":"query","name":"store_id","required":false,"schema":{"type":"string"}},{"description":"Defines category's visibility status","in":"query","name":"avail","required":false,"schema":{"type":"boolean","default":true}},{"description":"Sort number in the list","in":"query","name":"sort_order","required":false,"schema":{"type":"integer","default":0}},{"description":"Entity's date creation","in":"query","name":"created_time","required":false,"schema":{"type":"string"}},{"description":"Entity's date modification","in":"query","name":"modified_time","required":false,"schema":{"type":"string"}},{"description":"Defines category's description","in":"query","name":"description","required":false,"schema":{"type":"string"}},{"description":"Defines unique meta title for each entity","in":"query","name":"meta_title","required":false,"schema":{"type":"string"}},{"description":"Defines unique meta description of a entity","in":"query","name":"meta_description","required":false,"schema":{"type":"string"}},{"description":"Defines unique meta keywords for each entity","in":"query","name":"meta_keywords","required":false,"schema":{"type":"string"}},{"description":"Defines unique category's URL for SEO","in":"query","name":"seo_url","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"category_id":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["category"]}},"/category.assign.json":{"post":{"description":"Assign category to product","operationId":"CategoryAssign","parameters":[{"description":"Defines category assign to the product, specified by product id","in":"query","name":"product_id","required":true,"schema":{"type":"string"}},{"description":"Defines category assign, specified by category id","in":"query","name":"category_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["category"]}},"/category.count.json":{"get":{"description":"Count categories in store.","operationId":"CategoryCount","parameters":[{"description":"Counts categories specified by parent id","in":"query","name":"parent_id","required":false,"schema":{"type":"string"}},{"description":"Counts category specified by store id","in":"query","name":"store_id","required":false,"schema":{"type":"string"}},{"description":"Counts category specified by language id","in":"query","name":"lang_id","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"categories_count":{"type":"integer"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["category"]}},"/category.delete.json":{"delete":{"description":"Delete category in store","operationId":"CategoryDelete","parameters":[{"description":"Defines category removal, specified by category id","in":"query","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"result":{"properties":{"deleted":{"type":"string"}},"type":"object"},"return_code":{"type":"integer"},"return_message":{"type":"string"}},"type":"object"}}}}},"security":[{"api_key":[],"store_key":[]}],"tags":["category"]}},"/category.find.json":{"get":{"description":"Search category in store. \"Laptop\" is specified here by default.","operationId":"CategoryFind","parameters":[{"description":"Entity search that is specified by some value","in":"query","name":"find_value","required":true,"schema":{"type":"string"}},{"description":"Entity search that is specified by the comma-separated unique fields","in":"query","name":"find_where","required":false,"schema":{"type":"string","en