{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/ecommerce:api2cart/account-cart-add":{"post":{"operationId":"ecommerce_api2cart_account_cart_add","summary":"Add store to the account","description":"POST /account.cart.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/account-cart-list":{"get":{"operationId":"ecommerce_api2cart_account_cart_list","summary":"Get list of carts.","description":"GET /account.cart.list.json","tags":["ecommerce"],"parameters":[{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"force_all","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"request_from_date","in":"query","required":false,"description":"Retrieve entities from their creation date","schema":{"type":"string","description":"Retrieve entities from their creation date"}},{"name":"request_to_date","in":"query","required":false,"description":"Retrieve entities to their creation date","schema":{"type":"string","description":"Retrieve entities to their creation date"}},{"name":"store_url","in":"query","required":false,"description":"A web address of a store","schema":{"type":"string","description":"A web address of a store"}},{"name":"store_key","in":"query","required":false,"description":"Find store by store key","schema":{"type":"string","description":"Find store by store key"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/account-config-update":{"post":{"operationId":"ecommerce_api2cart_account_config_update","summary":"Update configs in the API2Cart database.","description":"PUT /account.config.update.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"new_store_key":{"type":"string","description":"Update store key"},"bridge_url":{"type":"string","description":"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…"},"store_root":{"type":"string","description":"Absolute path to the store root directory (used with \"bridge_url\" parameter)"},"db_tables_prefix":{"type":"string","description":"DB tables prefix"},"3dcart_private_key":{"type":"string","description":"3DCart Private Key"},"3dcart_access_token":{"type":"string","description":"3DCart Token"},"3dcartapi_api_key":{"type":"string","description":"3DCart API Key"},"amazon_sp_client_id":{"type":"string","description":"Amazon SP API app client id"},"amazon_sp_client_secret":{"type":"string","description":"Amazon SP API app client secret"},"amazon_sp_aws_user_key_id":{"type":"string","description":"Amazon AWS user access key ID"},"amazon_sp_aws_user_secret":{"type":"string","description":"Amazon AWS user secret access key"},"amazon_sp_aws_region":{"type":"string","description":"Amazon AWS Region"},"amazon_sp_aws_role_arn":{"type":"string","description":"Amazon AWS Role ARN"},"amazon_sp_refresh_token":{"type":"string","description":"Amazon SP API OAuth refresh token"},"amazon_sp_api_environment":{"type":"string","default":"production","description":"Amazon SP API environment"},"amazon_access_token":{"type":"string","description":"MWS Auth Token. Access token authorizing the app to access resources on behalf of a user"},"amazon_seller_id":{"type":"string","description":"Amazon Seller ID (Merchant token)"},"amazon_marketplaces_ids":{"type":"string","description":"Amazon Marketplace IDs comma separated string"},"amazon_secret_key":{"type":"string","description":"Amazon Secret Key"},"amazon_access_key_id":{"type":"string","description":"Amazon Secret Key Id"},"aspdotnetstorefront_api_user":{"type":"string","description":"It's a AspDotNetStorefront account for which API is available"},"aspdotnetstorefront_api_pass":{"type":"string","description":"AspDotNetStorefront API Password"},"bigcommerceapi_admin_account":{"type":"string","description":"It's a BigCommerce account for which API is enabled"},"bigcommerceapi_api_path":{"type":"string","description":"BigCommerce API URL"},"bigcommerceapi_api_key":{"type":"string","description":"Bigcommerce API Key"},"bigcommerceapi_client_id":{"type":"string","description":"Client ID of the requesting app"},"bigcommerceapi_access_token":{"type":"string","description":"Access token authorizing the app to access resources on behalf of a user"},"bigcommerceapi_context":{"type":"string","description":"API Path section unique to the store"},"demandware_client_id":{"type":"string","description":"Demandware client id"},"demandware_api_password":{"type":"string","description":"Demandware api password"},"demandware_user_name":{"type":"string","description":"Demandware user name"},"demandware_user_password":{"type":"string","description":"Demandware user password"},"ebay_client_id":{"type":"string","description":"Application ID (AppID)."},"ebay_client_secret":{"type":"string","description":"Shared Secret from eBay application"},"ebay_runame":{"type":"string","description":"The RuName value that eBay assigns to your application."},"ebay_access_token":{"type":"string","description":"Used to authenticate API requests."},"ebay_refresh_token":{"type":"string","description":"Used to renew the access token."},"ebay_environment":{"type":"string","description":"eBay environment"},"ebay_site_id":{"type":"integer","default":0,"description":"eBay global ID"},"ecwid_acess_token":{"type":"string","description":"Access token authorizing the app to access resources on behalf of a user"},"ecwid_store_id":{"type":"string","description":"Store Id"},"etsy_keystring":{"type":"string","description":"Etsy keystring"},"etsy_shared_secret":{"type":"string","description":"Etsy shared secret"},"etsy_access_token":{"type":"string","description":"Access token authorizing the app to access resources on behalf of a user"},"etsy_token_secret":{"type":"string","description":"Secret token authorizing the app to access resources on behalf of a user"},"etsy_client_id":{"type":"string","description":"Etsy Client Id"},"etsy_refresh_token":{"type":"string","description":"Etsy Refresh token"},"neto_api_key":{"type":"string","description":"Neto API Key"},"neto_api_username":{"type":"string","description":"Neto User Name"},"shopify_api_key":{"type":"string","description":"Shopify API Key"},"shopify_api_password":{"type":"string","description":"Shopify API Password"},"shopify_shared_secret":{"type":"string","description":"Shared secret"},"shopify_access_token":{"type":"string","description":"Access token authorizing the app to access resources on behalf of a user"},"shopware_access_key":{"type":"string","description":"Shopware access key"},"shopware_api_key":{"type":"string","description":"Shopware api key"},"shopware_api_secret":{"type":"string","description":"Shopware client secret access key"},"volusion_login":{"type":"string","description":"It's a Volusion account for which API is enabled"},"volusion_password":{"type":"string","description":"Volusion API Password"},"walmart_client_id":{"type":"string","description":"Walmart client ID"},"walmart_client_secret":{"type":"string","description":"Walmart client secret"},"walmart_environment":{"type":"string","default":"production","description":"Walmart environment"},"walmart_channel_type":{"type":"string","description":"Walmart WM_CONSUMER.CHANNEL.TYPE header"},"squarespace_api_key":{"type":"string","description":"Squarespace API Key"},"hybris_client_id":{"type":"string","description":"Omni Commerce Connector Client ID"},"hybris_client_secret":{"type":"string","description":"Omni Commerce Connector Client Secret"},"hybris_username":{"type":"string","description":"User Name"},"hybris_password":{"type":"string","description":"User password"},"hybris_websites":{"type":"array","description":"Websites to stores mapping data"},"lightspeed_api_key":{"type":"string","description":"LightSpeed api key"},"lightspeed_api_secret":{"type":"string","description":"LightSpeed api secret"},"commercehq_api_key":{"type":"string","description":"CommerceHQ api key"},"commercehq_api_password":{"type":"string","description":"CommerceHQ api password"},"wc_consumer_key":{"type":"string","description":"Woocommerce consumer key"},"wc_consumer_secret":{"type":"string","description":"Woocommerce consumer secret"},"magento_consumer_key":{"type":"string","description":"Magento Consumer Key"},"magento_consumer_secret":{"type":"string","description":"Magento Consumer Secret"},"magento_access_token":{"type":"string","description":"Magento Access Token"},"magento_token_secret":{"type":"string","description":"Magento Token Secret"},"prestashop_webservice_key":{"type":"string","description":"Prestashop webservice key"},"wix_app_id":{"type":"string","description":"Wix App ID"},"wix_app_secret_key":{"type":"string","description":"Wix App Secret Key"},"wix_refresh_token":{"type":"string","description":"Wix refresh token"},"mercado_libre_app_id":{"type":"string","description":"Mercado Libre App ID"},"mercado_libre_app_secret_key":{"type":"string","description":"Mercado Libre App Secret Key"},"mercado_libre_refresh_token":{"type":"string","description":"Mercado Libre Refresh Token"},"zid_client_id":{"type":"integer","description":"Zid Client ID"},"zid_client_secret":{"type":"string","description":"Zid Client Secret"},"zid_access_token":{"type":"string","description":"Zid Access Token"},"zid_authorization":{"type":"string","description":"Zid Authorization"},"zid_refresh_token":{"type":"string","description":"Zid refresh token"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/account-failed-webhooks":{"get":{"operationId":"ecommerce_api2cart_account_failed_webhooks","summary":"List webhooks that was not delivered to the callback.","description":"GET /account.failed_webhooks.json","tags":["ecommerce"],"parameters":[{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"ids","in":"query","required":false,"description":"List of сomma-separated webhook ids","schema":{"type":"string","description":"List of сomma-separated webhook ids"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/account-supported-platforms":{"get":{"operationId":"ecommerce_api2cart_account_supported_platforms","summary":"Get list of supported platforms","description":"GET /account.supported_platforms.json","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/attribute-add":{"post":{"operationId":"ecommerce_api2cart_attribute_add","summary":"Add new attribute","description":"POST /attribute.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type","name"],"properties":{"type":{"type":"string","enum":["text","select","textarea","date","price","multiselect","boolean"],"description":"Defines attribute's type"},"code":{"type":"string","description":"Entity code"},"name":{"type":"string","description":"Defines attributes's name"},"store_id":{"type":"string","description":"Store Id"},"lang_id":{"type":"string","description":"Language id"},"visible":{"type":"boolean","default":false,"description":"Set visibility status"},"required":{"type":"boolean","default":false,"description":"Defines if the option is required"},"position":{"type":"integer","default":0,"description":"Attribute`s position"},"attribute_group_id":{"type":"string","description":"Filter by attribute_group_id"},"is_global":{"type":"string","default":"Store","description":"Attribute saving scope"},"is_searchable":{"type":"boolean","default":false,"description":"Use attribute in Quick Search"},"is_filterable":{"type":"string","default":"No","description":"Use In Layered Navigation"},"is_comparable":{"type":"boolean","default":false,"description":"Comparable on Front-end"},"is_html_allowed_on_front":{"type":"boolean","default":false,"description":"Allow HTML Tags on Frontend"},"is_filterable_in_search":{"type":"boolean","default":false,"description":"Use In Search Results Layered Navigation"},"is_configurable":{"type":"boolean","default":false,"description":"Use To Create Configurable Product"},"is_visible_in_advanced_search":{"type":"boolean","default":false,"description":"Use in Advanced Search"},"is_used_for_promo_rules":{"type":"boolean","default":false,"description":"Use for Promo Rule Conditions"},"used_in_product_listing":{"type":"boolean","default":false,"description":"Used in Product Listing"},"used_for_sort_by":{"type":"boolean","default":false,"description":"Used for Sorting in Product Listing"},"apply_to":{"type":"string","default":"all_types","description":"Types of products which can have this attribute"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/attribute-assign-group":{"post":{"operationId":"ecommerce_api2cart_attribute_assign_group","summary":"Assign attribute to the group","description":"POST /attribute.assign.group.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","group_id"],"properties":{"id":{"type":"string","description":"Entity id"},"group_id":{"type":"string","description":"Attribute group_id"},"attribute_set_id":{"type":"string","description":"Attribute set id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/attribute-assign-set":{"post":{"operationId":"ecommerce_api2cart_attribute_assign_set","summary":"Assign attribute to the attribute set","description":"POST /attribute.assign.set.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","attribute_set_id"],"properties":{"id":{"type":"string","description":"Entity id"},"group_id":{"type":"string","description":"Attribute group_id"},"attribute_set_id":{"type":"string","description":"Attribute set id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/attribute-attributeset-list":{"get":{"operationId":"ecommerce_api2cart_attribute_attributeset_list","summary":"Get attribute_set list","description":"GET /attribute.attributeset.list.json","tags":["ecommerce"],"parameters":[{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/attribute-count":{"get":{"operationId":"ecommerce_api2cart_attribute_count","summary":"Get attributes count","description":"GET /attribute.count.json","tags":["ecommerce"],"parameters":[{"name":"type","in":"query","required":false,"description":"Defines attribute's type","schema":{"type":"string","description":"Defines attribute's type"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"lang_id","in":"query","required":false,"description":"Language id","schema":{"type":"string","description":"Language id"}},{"name":"visible","in":"query","required":false,"description":"Filter items by visibility status","schema":{"type":"boolean","description":"Filter items by visibility status"}},{"name":"required","in":"query","required":false,"description":"Defines if the option is required","schema":{"type":"boolean","description":"Defines if the option is required"}},{"name":"system","in":"query","required":false,"description":"True if attribute is system","schema":{"type":"boolean","description":"True if attribute is system"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/attribute-delete":{"post":{"operationId":"ecommerce_api2cart_attribute_delete","summary":"Delete attribute from store","description":"DELETE /attribute.delete.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"store_id":{"type":"string","description":"Store Id"},"id":{"type":"string","description":"Entity id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/attribute-group-list":{"get":{"operationId":"ecommerce_api2cart_attribute_group_list","summary":"Get attribute group list","description":"GET /attribute.group.list.json","tags":["ecommerce"],"parameters":[{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"lang_id","in":"query","required":false,"description":"Language id","schema":{"type":"string","description":"Language id"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"attribute_set_id","in":"query","required":false,"description":"Attribute set id","schema":{"type":"string","description":"Attribute set id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/attribute-info":{"get":{"operationId":"ecommerce_api2cart_attribute_info","summary":"Get attribute info","description":"GET /attribute.info.json","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"Entity id","schema":{"type":"string","description":"Entity id"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"lang_id","in":"query","required":false,"description":"Language id","schema":{"type":"string","description":"Language id"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"force_all","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/attribute-list":{"get":{"operationId":"ecommerce_api2cart_attribute_list","summary":"Get attributes list","description":"GET /attribute.list.json","tags":["ecommerce"],"parameters":[{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"type","in":"query","required":false,"description":"Defines attribute's type","schema":{"type":"string","description":"Defines attribute's type"}},{"name":"attribute_ids","in":"query","required":false,"description":"Filter attributes by ids","schema":{"type":"string","description":"Filter attributes by ids"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"lang_id","in":"query","required":false,"description":"Retrieves attributes on specified language id","schema":{"type":"string","description":"Retrieves attributes on specified language id"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,code,type","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"visible","in":"query","required":false,"description":"Filter items by visibility status","schema":{"type":"boolean","description":"Filter items by visibility status"}},{"name":"required","in":"query","required":false,"description":"Defines if the option is required","schema":{"type":"boolean","description":"Defines if the option is required"}},{"name":"system","in":"query","required":false,"description":"True if attribute is system","schema":{"type":"boolean","description":"True if attribute is system"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/attribute-type-list":{"get":{"operationId":"ecommerce_api2cart_attribute_type_list","summary":"Get list of supported attributes types","description":"GET /attribute.type.list.json","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/attribute-unassign-group":{"post":{"operationId":"ecommerce_api2cart_attribute_unassign_group","summary":"Unassign attribute from group","description":"POST /attribute.unassign.group.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","group_id"],"properties":{"id":{"type":"string","description":"Entity id"},"group_id":{"type":"string","description":"Customer group_id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/attribute-unassign-set":{"post":{"operationId":"ecommerce_api2cart_attribute_unassign_set","summary":"Unassign attribute from attribute set","description":"POST /attribute.unassign.set.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","attribute_set_id"],"properties":{"id":{"type":"string","description":"Entity id"},"attribute_set_id":{"type":"string","description":"Attribute set id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/attribute-update":{"post":{"operationId":"ecommerce_api2cart_attribute_update","summary":"Update attribute data","description":"POST /attribute.update.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"Entity id"},"name":{"type":"string","description":"Defines new attributes's name"},"store_id":{"type":"string","description":"Store Id"},"lang_id":{"type":"string","description":"Language id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/basket-info":{"get":{"operationId":"ecommerce_api2cart_basket_info","summary":"Retrieve basket information.","description":"GET /basket.info.json","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"Entity id","schema":{"type":"string","description":"Entity id"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"force_all","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/basket-item-add":{"post":{"operationId":"ecommerce_api2cart_basket_item_add","summary":"Add item to basket","description":"POST /basket.item.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customer_id","product_id"],"properties":{"customer_id":{"type":"string","description":"Retrieves orders specified by customer id"},"product_id":{"type":"string","description":"Defines id of the product which should be added to the basket"},"variant_id":{"type":"string","description":"Defines product's variants specified by variant id"},"quantity":{"type":"number","default":0,"description":"Defines new items quantity"},"store_id":{"type":"string","description":"Store Id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/basket-live-shipping-service-create":{"post":{"operationId":"ecommerce_api2cart_basket_live_shipping_service_create","summary":"Create live shipping rate service.","description":"POST /basket.live_shipping_service.create.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","callback"],"properties":{"store_id":{"type":"string","description":"Store Id"},"name":{"type":"string","description":"Shipping Service Name"},"callback":{"type":"string","description":"Callback url that returns shipping rates. It should be able to accept POST requests with json data."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/basket-live-shipping-service-delete":{"post":{"operationId":"ecommerce_api2cart_basket_live_shipping_service_delete","summary":"Delete live shipping rate service.","description":"DELETE /basket.live_shipping_service.delete.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"Entity id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/basket-live-shipping-service-list":{"get":{"operationId":"ecommerce_api2cart_basket_live_shipping_service_list","summary":"Retrieve a list of live shipping rate services.","description":"GET /basket.live_shipping_service.list.json","tags":["ecommerce"],"parameters":[{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/bridge-delete":{"post":{"operationId":"ecommerce_api2cart_bridge_delete","summary":"Delete bridge from the store.","description":"POST /bridge.delete.json","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/bridge-download":{"get":{"operationId":"ecommerce_api2cart_bridge_download","summary":"Download bridge for store","description":"GET /bridge.download.file","tags":["ecommerce"],"parameters":[{"name":"whitelabel","in":"query","required":false,"description":"Identifies if there is a necessity to download whitelabel bridge.","schema":{"type":"boolean","default":false,"description":"Identifies if there is a necessity to download whitelabel bridge."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/bridge-update":{"post":{"operationId":"ecommerce_api2cart_bridge_update","summary":"Update bridge in the store.","description":"POST /bridge.update.json","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-bridge":{"get":{"operationId":"ecommerce_api2cart_cart_bridge","summary":"Get bridge key and store key","description":"GET /cart.bridge.json","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-catalog-price-rules-count":{"get":{"operationId":"ecommerce_api2cart_cart_catalog_price_rules_count","summary":"Get count of cart catalog price rules discounts.","description":"GET /cart.catalog_price_rules.count.json","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-catalog-price-rules-list":{"get":{"operationId":"ecommerce_api2cart_cart_catalog_price_rules_list","summary":"Get cart catalog price rules discounts.","description":"GET /cart.catalog_price_rules.list.json","tags":["ecommerce"],"parameters":[{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)"}},{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"ids","in":"query","required":false,"description":"Retrieves catalog_price_rules by ids","schema":{"type":"string","description":"Retrieves catalog_price_rules by ids"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,description","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-clear-cache":{"post":{"operationId":"ecommerce_api2cart_cart_clear_cache","summary":"Clear cache on store.","description":"POST /cart.clear_cache.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["cache_type"],"properties":{"cache_type":{"type":"string","description":"Defines which cache should be cleared."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-config":{"get":{"operationId":"ecommerce_api2cart_cart_config","summary":"Get list of cart configs","description":"GET /cart.config.json","tags":["ecommerce"],"parameters":[{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"store_name,store_url,db_prefix","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-coupon-add":{"post":{"operationId":"ecommerce_api2cart_cart_coupon_add","summary":"Create new coupon","description":"POST /cart.coupon.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-coupon-condition-add":{"post":{"operationId":"ecommerce_api2cart_cart_coupon_condition_add","summary":"Create new coupon condition","description":"POST /cart.coupon.condition.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["coupon_id","entity","key","operator","value"],"properties":{"store_id":{"type":"string","description":"Store Id"},"coupon_id":{"type":"string","description":"Coupon Id"},"target":{"type":"string","default":"coupon_prerequisite","description":"Defines condition operator"},"entity":{"type":"string","enum":["order","order_shipping_address","product","customer"],"description":"Defines condition entity type"},"key":{"type":"string","enum":["total","subtotal","shipping_total","total_quantity","total_weight","country","product_id","variant_id","category_id","customer_id","item_price","item_total_price","item_quantity"],"description":"Defines condition entity attribute key"},"operator":{"type":"string","enum":["==","<","<=",">",">=","ONE_OF"],"description":"Defines condition operator"},"value":{"type":"string","description":"Defines condition value, can be comma separated according to the operator."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-coupon-count":{"get":{"operationId":"ecommerce_api2cart_cart_coupon_count","summary":"Get cart coupons count.","description":"GET /cart.coupon.count.json","tags":["ecommerce"],"parameters":[{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"date_start_from","in":"query","required":false,"description":"Filter entity by date_start (greater or equal)","schema":{"type":"string","description":"Filter entity by date_start (greater or equal)"}},{"name":"date_start_to","in":"query","required":false,"description":"Filter entity by date_start (less or equal)","schema":{"type":"string","description":"Filter entity by date_start (less or equal)"}},{"name":"date_end_from","in":"query","required":false,"description":"Filter entity by date_end (greater or equal)","schema":{"type":"string","description":"Filter entity by date_end (greater or equal)"}},{"name":"date_end_to","in":"query","required":false,"description":"Filter entity by date_end (less or equal)","schema":{"type":"string","description":"Filter entity by date_end (less or equal)"}},{"name":"avail","in":"query","required":false,"description":"Defines category's visibility status","schema":{"type":"boolean","default":true,"description":"Defines category's visibility status"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-coupon-delete":{"post":{"operationId":"ecommerce_api2cart_cart_coupon_delete","summary":"Delete coupon","description":"DELETE /cart.coupon.delete.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Entity id"},"store_id":{"type":"string","description":"Store Id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-coupon-list":{"get":{"operationId":"ecommerce_api2cart_cart_coupon_list","summary":"Get cart coupon discounts.","description":"GET /cart.coupon.list.json","tags":["ecommerce"],"parameters":[{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)"}},{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"coupons_ids","in":"query","required":false,"description":"Filter coupons by ids","schema":{"type":"string","description":"Filter coupons by ids"}},{"name":"store_id","in":"query","required":false,"description":"Filter coupons by store id","schema":{"type":"string","description":"Filter coupons by store id"}},{"name":"date_start_from","in":"query","required":false,"description":"Filter entity by date_start (greater or equal)","schema":{"type":"string","description":"Filter entity by date_start (greater or equal)"}},{"name":"date_start_to","in":"query","required":false,"description":"Filter entity by date_start (less or equal)","schema":{"type":"string","description":"Filter entity by date_start (less or equal)"}},{"name":"date_end_from","in":"query","required":false,"description":"Filter entity by date_end (greater or equal)","schema":{"type":"string","description":"Filter entity by date_end (greater or equal)"}},{"name":"date_end_to","in":"query","required":false,"description":"Filter entity by date_end (less or equal)","schema":{"type":"string","description":"Filter entity by date_end (less or equal)"}},{"name":"avail","in":"query","required":false,"description":"Filter coupons by avail status","schema":{"type":"boolean","description":"Filter coupons by avail status"}},{"name":"lang_id","in":"query","required":false,"description":"Language id","schema":{"type":"string","description":"Language id"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,code,name,description","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-delete":{"post":{"operationId":"ecommerce_api2cart_cart_delete","summary":"Remove store from API2Cart","description":"DELETE /cart.delete.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"delete_bridge":{"type":"boolean","default":true,"description":"Identifies if there is a necessity to delete bridge"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-giftcard-add":{"post":{"operationId":"ecommerce_api2cart_cart_giftcard_add","summary":"Create new gift card","description":"POST /cart.giftcard.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["amount"],"properties":{"amount":{"type":"number","description":"Defines the gift card amount value."},"code":{"type":"string","description":"Gift card code"},"owner_email":{"type":"string","description":"Gift card owner email"},"recipient_email":{"type":"string","description":"Gift card recipient email"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-giftcard-count":{"get":{"operationId":"ecommerce_api2cart_cart_giftcard_count","summary":"Get gift cards count.","description":"GET /cart.giftcard.count.json","tags":["ecommerce"],"parameters":[{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-giftcard-list":{"get":{"operationId":"ecommerce_api2cart_cart_giftcard_list","summary":"Get gift cards list.","description":"GET /cart.giftcard.list.json","tags":["ecommerce"],"parameters":[{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)"}},{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,code,name","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-info":{"get":{"operationId":"ecommerce_api2cart_cart_info","summary":"Get cart information","description":"GET /cart.info.json","tags":["ecommerce"],"parameters":[{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"store_name,store_url,db_prefix","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-meta-data-list":{"get":{"operationId":"ecommerce_api2cart_cart_meta_data_list","summary":"Get entity meta data","description":"GET /cart.meta_data.list.json","tags":["ecommerce"],"parameters":[{"name":"entity_id","in":"query","required":true,"description":"Entity Id","schema":{"type":"string","description":"Entity Id"}},{"name":"entity","in":"query","required":false,"description":"Entity","schema":{"type":"string","default":"product","description":"Entity"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"lang_id","in":"query","required":false,"description":"Language id","schema":{"type":"string","description":"Language id"}},{"name":"key","in":"query","required":false,"description":"Key","schema":{"type":"string","description":"Key"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"key,value","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-meta-data-set":{"post":{"operationId":"ecommerce_api2cart_cart_meta_data_set","summary":"Set meta data for a specific entity","description":"POST /cart.meta_data.set.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["entity_id","key","value","namespace"],"properties":{"entity_id":{"type":"string","description":"Entity Id"},"entity":{"type":"string","default":"product","description":"Entity"},"store_id":{"type":"string","description":"Store Id"},"lang_id":{"type":"string","description":"Language id"},"key":{"type":"string","description":"Key"},"value":{"type":"string","description":"Value"},"namespace":{"type":"string","description":"Metafield namespace"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-meta-data-unset":{"post":{"operationId":"ecommerce_api2cart_cart_meta_data_unset","summary":"Unset meta data for a specific entity","description":"DELETE /cart.meta_data.unset.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["entity_id","key","id"],"properties":{"entity_id":{"type":"string","description":"Entity Id"},"entity":{"type":"string","default":"product","description":"Entity"},"store_id":{"type":"string","description":"Store Id"},"key":{"type":"string","description":"Key"},"id":{"type":"string","description":"Entity id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-methods":{"get":{"operationId":"ecommerce_api2cart_cart_methods","summary":"Get list of cart methods","description":"GET /cart.methods.json","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-plugin-list":{"get":{"operationId":"ecommerce_api2cart_cart_plugin_list","summary":"Get list of installed plugins","description":"GET /cart.plugin.list.json","tags":["ecommerce"],"parameters":[{"name":"store_key","in":"query","required":false,"description":"Set this parameter if bridge is already uploaded to store","schema":{"type":"string","description":"Set this parameter if bridge is already uploaded to store"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-script-add":{"post":{"operationId":"ecommerce_api2cart_cart_script_add","summary":"Add new script to the storefront","description":"POST /cart.script.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The user-friendly script name"},"description":{"type":"string","description":"The user-friendly description"},"html":{"type":"string","description":"An html string containing exactly one `script` tag."},"src":{"type":"string","description":"The URL of the remote script"},"load_method":{"type":"string","description":"The load method to use for the script"},"scope":{"type":"string","default":"storefront","description":"The page or pages on the online store where the script should be included"},"store_id":{"type":"string","description":"Store Id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-script-delete":{"post":{"operationId":"ecommerce_api2cart_cart_script_delete","summary":"Remove script from the storefront","description":"DELETE /cart.script.delete.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Entity id"},"store_id":{"type":"string","description":"Store Id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-script-list":{"get":{"operationId":"ecommerce_api2cart_cart_script_list","summary":"Get scripts installed to the storefront","description":"GET /cart.script.list.json","tags":["ecommerce"],"parameters":[{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)"}},{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"created_from","in":"query","required":false,"description":"Retrieve entities from their creation date","schema":{"type":"string","description":"Retrieve entities from their creation date"}},{"name":"created_to","in":"query","required":false,"description":"Retrieve entities to their creation date","schema":{"type":"string","description":"Retrieve entities to their creation date"}},{"name":"modified_from","in":"query","required":false,"description":"Retrieve entities from their modification date","schema":{"type":"string","description":"Retrieve entities from their modification date"}},{"name":"modified_to","in":"query","required":false,"description":"Retrieve entities to their modification date","schema":{"type":"string","description":"Retrieve entities to their modification date"}},{"name":"script_ids","in":"query","required":false,"description":"Retrieves only scripts with specific ids","schema":{"type":"string","description":"Retrieves only scripts with specific ids"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,description","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-shipping-zones-list":{"get":{"operationId":"ecommerce_api2cart_cart_shipping_zones_list","summary":"Get list of shipping zones","description":"GET /cart.shipping_zones.list.json","tags":["ecommerce"],"parameters":[{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,enabled","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/cart-validate":{"get":{"operationId":"ecommerce_api2cart_cart_validate","summary":"Check store availability, bridge connection for the downloadable carts, identify DB prefix, validate API…","description":"GET /cart.validate.json","tags":["ecommerce"],"parameters":[{"name":"validate_version","in":"query","required":false,"description":"Specify if api2cart should validate cart version","schema":{"type":"boolean","default":false,"description":"Specify if api2cart should validate cart version"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/category-add":{"post":{"operationId":"ecommerce_api2cart_category_add","summary":"Add new category in store","description":"POST /category.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Defines category's name that has to be added"},"parent_id":{"type":"string","description":"Adds categories specified by parent id"},"stores_ids":{"type":"string","default":0,"description":"Create category in the stores that is specified by comma-separated stores' id"},"store_id":{"type":"string","description":"Store Id"},"lang_id":{"type":"string","description":"Language id"},"avail":{"type":"boolean","default":true,"description":"Defines category's visibility status"},"sort_order":{"type":"integer","default":0,"description":"Sort number in the list"},"created_time":{"type":"string","description":"Entity's date creation"},"modified_time":{"type":"string","description":"Entity's date modification"},"description":{"type":"string","description":"Defines category's description"},"meta_title":{"type":"string","description":"Defines unique meta title for each entity"},"meta_description":{"type":"string","description":"Defines unique meta description of a entity"},"meta_keywords":{"type":"string","description":"Defines unique meta keywords for each entity"},"seo_url":{"type":"string","description":"Defines unique category's URL for SEO"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/category-assign":{"post":{"operationId":"ecommerce_api2cart_category_assign","summary":"Assign category to product","description":"POST /category.assign.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["product_id","category_id"],"properties":{"product_id":{"type":"string","description":"Defines category assign to the product, specified by product id"},"category_id":{"type":"string","description":"Defines category assign, specified by category id"},"store_id":{"type":"string","description":"Store Id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/category-count":{"get":{"operationId":"ecommerce_api2cart_category_count","summary":"Count categories in store.","description":"GET /category.count.json","tags":["ecommerce"],"parameters":[{"name":"parent_id","in":"query","required":false,"description":"Counts categories specified by parent id","schema":{"type":"string","description":"Counts categories specified by parent id"}},{"name":"store_id","in":"query","required":false,"description":"Counts category specified by store id","schema":{"type":"string","description":"Counts category specified by store id"}},{"name":"lang_id","in":"query","required":false,"description":"Counts category specified by language id","schema":{"type":"string","description":"Counts category specified by language id"}},{"name":"created_from","in":"query","required":false,"description":"Retrieve entities from their creation date","schema":{"type":"string","description":"Retrieve entities from their creation date"}},{"name":"created_to","in":"query","required":false,"description":"Retrieve entities to their creation date","schema":{"type":"string","description":"Retrieve entities to their creation date"}},{"name":"modified_from","in":"query","required":false,"description":"Retrieve entities from their modification date","schema":{"type":"string","description":"Retrieve entities from their modification date"}},{"name":"modified_to","in":"query","required":false,"description":"Retrieve entities to their modification date","schema":{"type":"string","description":"Retrieve entities to their modification date"}},{"name":"avail","in":"query","required":false,"description":"Defines category's visibility status","schema":{"type":"boolean","default":true,"description":"Defines category's visibility status"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/category-delete":{"post":{"operationId":"ecommerce_api2cart_category_delete","summary":"Delete category in store","description":"DELETE /category.delete.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Defines category removal, specified by category id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/category-find":{"get":{"operationId":"ecommerce_api2cart_category_find","summary":"Search category in store. \"Laptop\" is specified here by default.","description":"GET /category.find.json","tags":["ecommerce"],"parameters":[{"name":"find_value","in":"query","required":true,"description":"Entity search that is specified by some value","schema":{"type":"string","description":"Entity search that is specified by some value"}},{"name":"find_where","in":"query","required":false,"description":"Entity search that is specified by the comma-separated unique fields","schema":{"type":"string","default":"name","description":"Entity search that is specified by the comma-separated unique fields"}},{"name":"find_params","in":"query","required":false,"description":"Entity search that is specified by comma-separated parameters","schema":{"type":"string","default":"whole_words","description":"Entity search that is specified by comma-separated parameters"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"lang_id","in":"query","required":false,"description":"Language id","schema":{"type":"string","description":"Language id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/category-image-add":{"post":{"operationId":"ecommerce_api2cart_category_image_add","summary":"Add image to category","description":"POST /category.image.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["category_id","image_name","url","type"],"properties":{"category_id":{"type":"string","description":"Defines category id where the image should be added"},"image_name":{"type":"string","description":"Defines image's name"},"url":{"type":"string","description":"Defines URL of the image that has to be added"},"label":{"type":"string","description":"Defines alternative text that has to be attached to the picture"},"mime":{"type":"string","description":"Mime type of image http://en.wikipedia.org/wiki/Internet_media_type."},"type":{"type":"string","enum":["base","thumbnail"],"description":"Defines image's types that are specified by comma-separated list"},"position":{"type":"integer","default":0,"description":"Defines image’s position in the list"},"store_id":{"type":"string","description":"Store Id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/category-image-delete":{"post":{"operationId":"ecommerce_api2cart_category_image_delete","summary":"Delete image","description":"DELETE /category.image.delete.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["category_id","image_id"],"properties":{"category_id":{"type":"string","description":"Defines category id where the image should be deleted"},"image_id":{"type":"string","description":"Define image id"},"store_id":{"type":"string","description":"Store Id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/category-info":{"get":{"operationId":"ecommerce_api2cart_category_info","summary":"Get category info about category ID*** or specify other category ID.","description":"GET /category.info.json","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"Retrieves category's info specified by category id","schema":{"type":"string","description":"Retrieves category's info specified by category id"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,parent_id,name,description","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"store_id","in":"query","required":false,"description":"Retrieves category info specified by store id","schema":{"type":"string","description":"Retrieves category info specified by store id"}},{"name":"lang_id","in":"query","required":false,"description":"Retrieves category info specified by language id","schema":{"type":"string","description":"Retrieves category info specified by language id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/category-list":{"get":{"operationId":"ecommerce_api2cart_category_list","summary":"Get list of categories from store.","description":"GET /category.list.json","tags":["ecommerce"],"parameters":[{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)"}},{"name":"parent_id","in":"query","required":false,"description":"Retrieves categories specified by parent id","schema":{"type":"string","description":"Retrieves categories specified by parent id"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,parent_id,name,description","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"store_id","in":"query","required":false,"description":"Retrieves categories specified by store id","schema":{"type":"string","description":"Retrieves categories specified by store id"}},{"name":"lang_id","in":"query","required":false,"description":"Retrieves categorys specified by language id","schema":{"type":"string","description":"Retrieves categorys specified by language id"}},{"name":"created_from","in":"query","required":false,"description":"Retrieve entities from their creation date","schema":{"type":"string","description":"Retrieve entities from their creation date"}},{"name":"created_to","in":"query","required":false,"description":"Retrieve entities to their creation date","schema":{"type":"string","description":"Retrieve entities to their creation date"}},{"name":"modified_from","in":"query","required":false,"description":"Retrieve entities from their modification date","schema":{"type":"string","description":"Retrieve entities from their modification date"}},{"name":"modified_to","in":"query","required":false,"description":"Retrieve entities to their modification date","schema":{"type":"string","description":"Retrieve entities to their modification date"}},{"name":"avail","in":"query","required":false,"description":"Defines category's visibility status","schema":{"type":"boolean","default":true,"description":"Defines category's visibility status"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/category-unassign":{"post":{"operationId":"ecommerce_api2cart_category_unassign","summary":"Unassign category to product","description":"POST /category.unassign.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["category_id","product_id"],"properties":{"category_id":{"type":"string","description":"Defines category unassign, specified by category id"},"product_id":{"type":"string","description":"Defines category unassign to the product, specified by product id"},"store_id":{"type":"string","description":"Store Id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/category-update":{"post":{"operationId":"ecommerce_api2cart_category_update","summary":"Update category in store","description":"PUT /category.update.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Defines category update specified by category id"},"name":{"type":"string","description":"Defines new category’s name"},"parent_id":{"type":"string","description":"Defines new parent category id"},"stores_ids":{"type":"string","default":0,"description":"Update category in the stores that is specified by comma-separated stores' id"},"avail":{"type":"boolean","description":"Defines category's visibility status"},"sort_order":{"type":"integer","description":"Sort number in the list"},"modified_time":{"type":"string","description":"Entity's date modification"},"description":{"type":"string","description":"Defines new category's description"},"meta_title":{"type":"string","description":"Defines unique meta title for each entity"},"meta_description":{"type":"string","description":"Defines unique meta description of a entity"},"meta_keywords":{"type":"string","description":"Defines unique meta keywords for each entity"},"seo_url":{"type":"string","description":"Defines unique category's URL for SEO"},"lang_id":{"type":"string","description":"Language id"},"store_id":{"type":"string","description":"Store Id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/customer-add":{"post":{"operationId":"ecommerce_api2cart_customer_add","summary":"Add customer into store.","description":"POST /customer.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/customer-attribute-list":{"get":{"operationId":"ecommerce_api2cart_customer_attribute_list","summary":"Get attributes for specific customer","description":"GET /customer.attribute.list.json","tags":["ecommerce"],"parameters":[{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)"}},{"name":"customer_id","in":"query","required":true,"description":"Retrieves orders specified by customer id","schema":{"type":"string","description":"Retrieves orders specified by customer id"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"lang_id","in":"query","required":false,"description":"Language id","schema":{"type":"string","description":"Language id"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"force_all","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/customer-count":{"get":{"operationId":"ecommerce_api2cart_customer_count","summary":"Get number of customers from store.","description":"GET /customer.count.json","tags":["ecommerce"],"parameters":[{"name":"group_id","in":"query","required":false,"description":"Customer group_id","schema":{"type":"string","description":"Customer group_id"}},{"name":"created_from","in":"query","required":false,"description":"Retrieve entities from their creation date","schema":{"type":"string","description":"Retrieve entities from their creation date"}},{"name":"created_to","in":"query","required":false,"description":"Retrieve entities to their creation date","schema":{"type":"string","description":"Retrieve entities to their creation date"}},{"name":"modified_from","in":"query","required":false,"description":"Retrieve entities from their modification date","schema":{"type":"string","description":"Retrieve entities from their modification date"}},{"name":"modified_to","in":"query","required":false,"description":"Retrieve entities to their modification date","schema":{"type":"string","description":"Retrieve entities to their modification date"}},{"name":"store_id","in":"query","required":false,"description":"Counts customer specified by store id","schema":{"type":"string","description":"Counts customer specified by store id"}},{"name":"customer_list_id","in":"query","required":false,"description":"The numeric ID of the customer list in Demandware.","schema":{"type":"string","description":"The numeric ID of the customer list in Demandware."}},{"name":"avail","in":"query","required":false,"description":"Defines category's visibility status","schema":{"type":"boolean","default":true,"description":"Defines category's visibility status"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/customer-find":{"get":{"operationId":"ecommerce_api2cart_customer_find","summary":"Find customers in store.","description":"GET /customer.find.json","tags":["ecommerce"],"parameters":[{"name":"find_value","in":"query","required":true,"description":"Entity search that is specified by some value","schema":{"type":"string","description":"Entity search that is specified by some value"}},{"name":"find_where","in":"query","required":false,"description":"Entity search that is specified by the comma-separated unique fields","schema":{"type":"string","default":"email","description":"Entity search that is specified by the comma-separated unique fields"}},{"name":"find_params","in":"query","required":false,"description":"Entity search that is specified by comma-separated parameters","schema":{"type":"string","default":"whole_words","description":"Entity search that is specified by comma-separated parameters"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/customer-group-add":{"post":{"operationId":"ecommerce_api2cart_customer_group_add","summary":"Create customer group.","description":"POST /customer.group.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Customer group name"},"store_id":{"type":"string","description":"Store Id"},"stores_ids":{"type":"string","description":"Assign customer group to the stores that is specified by comma-separated stores' id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/customer-group-list":{"get":{"operationId":"ecommerce_api2cart_customer_group_list","summary":"Get list of customers groups.","description":"GET /customer.group.list.json","tags":["ecommerce"],"parameters":[{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)"}},{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"lang_id","in":"query","required":false,"description":"Language id","schema":{"type":"string","description":"Language id"}},{"name":"group_ids","in":"query","required":false,"description":"Groups that will be assigned to a customer","schema":{"type":"string","description":"Groups that will be assigned to a customer"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,additional_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/customer-info":{"get":{"operationId":"ecommerce_api2cart_customer_info","summary":"Get customers' details from store.","description":"GET /customer.info.json","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"Retrieves customer's info specified by customer id","schema":{"type":"string","description":"Retrieves customer's info specified by customer id"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,email,first_name,last_name","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"store_id","in":"query","required":false,"description":"Retrieves customer info specified by store id","schema":{"type":"string","description":"Retrieves customer info specified by store id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/customer-list":{"get":{"operationId":"ecommerce_api2cart_customer_list","summary":"Get list of customers from store.","description":"GET /customer.list.json","tags":["ecommerce"],"parameters":[{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)"}},{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"created_from","in":"query","required":false,"description":"Retrieve entities from their creation date","schema":{"type":"string","description":"Retrieve entities from their creation date"}},{"name":"created_to","in":"query","required":false,"description":"Retrieve entities to their creation date","schema":{"type":"string","description":"Retrieve entities to their creation date"}},{"name":"modified_from","in":"query","required":false,"description":"Retrieve entities from their modification date","schema":{"type":"string","description":"Retrieve entities from their modification date"}},{"name":"modified_to","in":"query","required":false,"description":"Retrieve entities to their modification date","schema":{"type":"string","description":"Retrieve entities to their modification date"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,email,first_name,last_name","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"group_id","in":"query","required":false,"description":"Customer group_id","schema":{"type":"string","description":"Customer group_id"}},{"name":"store_id","in":"query","required":false,"description":"Retrieves customers specified by store id","schema":{"type":"string","description":"Retrieves customers specified by store id"}},{"name":"customer_list_id","in":"query","required":false,"description":"The numeric ID of the customer list in Demandware.","schema":{"type":"string","description":"The numeric ID of the customer list in Demandware."}},{"name":"avail","in":"query","required":false,"description":"Defines category's visibility status","schema":{"type":"boolean","default":true,"description":"Defines category's visibility status"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/customer-update":{"post":{"operationId":"ecommerce_api2cart_customer_update","summary":"Update information of customer in store.","description":"PUT /customer.update.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/customer-wishlist-list":{"get":{"operationId":"ecommerce_api2cart_customer_wishlist_list","summary":"Get a Wish List of customer from the store.","description":"GET /customer.wishlist.list.json","tags":["ecommerce"],"parameters":[{"name":"customer_id","in":"query","required":true,"description":"Retrieves orders specified by customer id","schema":{"type":"string","description":"Retrieves orders specified by customer id"}},{"name":"id","in":"query","required":false,"description":"Entity id","schema":{"type":"string","description":"Entity id"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"{return_code,return_message,pagination,result}","description":"Set this parameter in order to choose which entity fields you want to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/order-abandoned-list":{"get":{"operationId":"ecommerce_api2cart_order_abandoned_list","summary":"Get list of orders that were left by customers before completing the order.","description":"GET /order.abandoned.list.json","tags":["ecommerce"],"parameters":[{"name":"customer_id","in":"query","required":false,"description":"Retrieves orders specified by customer id","schema":{"type":"string","description":"Retrieves orders specified by customer id"}},{"name":"customer_email","in":"query","required":false,"description":"Retrieves orders specified by customer email","schema":{"type":"string","description":"Retrieves orders specified by customer email"}},{"name":"created_to","in":"query","required":false,"description":"Retrieve entities to their creation date","schema":{"type":"string","description":"Retrieve entities to their creation date"}},{"name":"created_from","in":"query","required":false,"description":"Retrieve entities from their creation date","schema":{"type":"string","description":"Retrieve entities from their creation date"}},{"name":"modified_to","in":"query","required":false,"description":"Retrieve entities to their modification date","schema":{"type":"string","description":"Retrieve entities to their modification date"}},{"name":"modified_from","in":"query","required":false,"description":"Retrieve entities from their modification date","schema":{"type":"string","description":"Retrieve entities from their modification date"}},{"name":"skip_empty_email","in":"query","required":false,"description":"Filter empty emails","schema":{"type":"boolean","default":false,"description":"Filter empty emails"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"customer,totals,items","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/order-add":{"post":{"operationId":"ecommerce_api2cart_order_add","summary":"Add a new order to the cart.","description":"POST /order.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/order-count":{"get":{"operationId":"ecommerce_api2cart_order_count","summary":"Count orders in store","description":"GET /order.count.json","tags":["ecommerce"],"parameters":[{"name":"customer_id","in":"query","required":false,"description":"Counts orders quantity specified by customer id","schema":{"type":"string","description":"Counts orders quantity specified by customer id"}},{"name":"customer_email","in":"query","required":false,"description":"Counts orders quantity specified by customer email","schema":{"type":"string","description":"Counts orders quantity specified by customer email"}},{"name":"order_status","in":"query","required":false,"description":"Counts orders quantity specified by order status","schema":{"type":"string","description":"Counts orders quantity specified by order status"}},{"name":"order_status_ids","in":"query","required":false,"description":"Retrieves orders specified by order statuses","schema":{"type":"array","description":"Retrieves orders specified by order statuses"}},{"name":"created_to","in":"query","required":false,"description":"Retrieve entities to their creation date","schema":{"type":"string","description":"Retrieve entities to their creation date"}},{"name":"created_from","in":"query","required":false,"description":"Retrieve entities from their creation date","schema":{"type":"string","description":"Retrieve entities from their creation date"}},{"name":"modified_to","in":"query","required":false,"description":"Retrieve entities to their modification date","schema":{"type":"string","description":"Retrieve entities to their modification date"}},{"name":"modified_from","in":"query","required":false,"description":"Retrieve entities from their modification date","schema":{"type":"string","description":"Retrieve entities from their modification date"}},{"name":"store_id","in":"query","required":false,"description":"Counts orders quantity specified by store id","schema":{"type":"string","description":"Counts orders quantity specified by store id"}},{"name":"ids","in":"query","required":false,"description":"Counts orders specified by ids","schema":{"type":"string","description":"Counts orders specified by ids"}},{"name":"order_ids","in":"query","required":false,"description":"Counts orders specified by order ids","schema":{"type":"string","description":"Counts orders specified by order ids"}},{"name":"ebay_order_status","in":"query","required":false,"description":"Counts orders quantity specified by order status","schema":{"type":"string","description":"Counts orders quantity specified by order status"}},{"name":"financial_status","in":"query","required":false,"description":"Counts orders quantity specified by financial status","schema":{"type":"string","description":"Counts orders quantity specified by financial status"}},{"name":"fulfillment_status","in":"query","required":false,"description":"Create order with fulfillment status","schema":{"type":"string","description":"Create order with fulfillment status"}},{"name":"shipping_method","in":"query","required":false,"description":"Retrieve entities according to shipping method","schema":{"type":"string","description":"Retrieve entities according to shipping method"}},{"name":"delivery_method","in":"query","required":false,"description":"Retrieves order with delivery method","schema":{"type":"string","description":"Retrieves order with delivery method"}},{"name":"ship_node_type","in":"query","required":false,"description":"Retrieves order with ship node type","schema":{"type":"string","description":"Retrieves order with ship node type"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/order-financial-status-list":{"get":{"operationId":"ecommerce_api2cart_order_financial_status_list","summary":"Retrieve list of financial statuses","description":"GET /order.financial_status.list.json","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/order-fulfillment-status-list":{"get":{"operationId":"ecommerce_api2cart_order_fulfillment_status_list","summary":"Retrieve list of fulfillment statuses","description":"GET /order.fulfillment_status.list.json","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/order-info":{"get":{"operationId":"ecommerce_api2cart_order_info","summary":"Info about a specific order by ID","description":"GET /order.info.json","tags":["ecommerce"],"parameters":[{"name":"order_id","in":"query","required":false,"description":"Retrieves order’s info specified by order id","schema":{"type":"string","description":"Retrieves order’s info specified by order id"}},{"name":"id","in":"query","required":false,"description":"Retrieves order info specified by id","schema":{"type":"string","description":"Retrieves order info specified by id"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"order_id,customer,totals,address,items,bundles,status","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"store_id","in":"query","required":false,"description":"Defines store id where the order should be found","schema":{"type":"string","description":"Defines store id where the order should be found"}},{"name":"enable_cache","in":"query","required":false,"description":"If the value is 'true' and order exist in our cache, we will return order.info response from cache","schema":{"type":"boolean","default":false,"description":"If the value is 'true' and order exist in our cache, we will return order.info response from cache"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/order-list":{"get":{"operationId":"ecommerce_api2cart_order_list","summary":"Get list of orders from store.","description":"GET /order.list.json","tags":["ecommerce"],"parameters":[{"name":"customer_id","in":"query","required":false,"description":"Retrieves orders specified by customer id","schema":{"type":"string","description":"Retrieves orders specified by customer id"}},{"name":"customer_email","in":"query","required":false,"description":"Retrieves orders specified by customer email","schema":{"type":"string","description":"Retrieves orders specified by customer email"}},{"name":"phone","in":"query","required":false,"description":"Filter orders by customer's phone number","schema":{"type":"string","description":"Filter orders by customer's phone number"}},{"name":"order_status","in":"query","required":false,"description":"Retrieves orders specified by order status","schema":{"type":"string","description":"Retrieves orders specified by order status"}},{"name":"order_status_ids","in":"query","required":false,"description":"Retrieves orders specified by order statuses","schema":{"type":"array","description":"Retrieves orders specified by order statuses"}},{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve orders via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve orders via cursor-based pagination (it can't be used with any other filtering parameter)"}},{"name":"sort_by","in":"query","required":false,"description":"Set field to sort by","schema":{"type":"string","default":"order_id","description":"Set field to sort by"}},{"name":"sort_direction","in":"query","required":false,"description":"Set sorting direction","schema":{"type":"string","default":"asc","description":"Set sorting direction"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"order_id,customer,totals,address,items,bundles,status","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"created_to","in":"query","required":false,"description":"Retrieve entities to their creation date","schema":{"type":"string","description":"Retrieve entities to their creation date"}},{"name":"created_from","in":"query","required":false,"description":"Retrieve entities from their creation date","schema":{"type":"string","description":"Retrieve entities from their creation date"}},{"name":"modified_to","in":"query","required":false,"description":"Retrieve entities to their modification date","schema":{"type":"string","description":"Retrieve entities to their modification date"}},{"name":"modified_from","in":"query","required":false,"description":"Retrieve entities from their modification date","schema":{"type":"string","description":"Retrieve entities from their modification date"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"ids","in":"query","required":false,"description":"Retrieves orders specified by ids","schema":{"type":"string","description":"Retrieves orders specified by ids"}},{"name":"order_ids","in":"query","required":false,"description":"Retrieves orders specified by order ids","schema":{"type":"string","description":"Retrieves orders specified by order ids"}},{"name":"ebay_order_status","in":"query","required":false,"description":"Retrieves orders specified by order status","schema":{"type":"string","description":"Retrieves orders specified by order status"}},{"name":"basket_id","in":"query","required":false,"description":"Retrieves order’s info specified by basket id.","schema":{"type":"string","description":"Retrieves order’s info specified by basket id."}},{"name":"financial_status","in":"query","required":false,"description":"Retrieves orders specified by financial status","schema":{"type":"string","description":"Retrieves orders specified by financial status"}},{"name":"fulfillment_status","in":"query","required":false,"description":"Create order with fulfillment status","schema":{"type":"string","description":"Create order with fulfillment status"}},{"name":"shipping_method","in":"query","required":false,"description":"Retrieve entities according to shipping method","schema":{"type":"string","description":"Retrieve entities according to shipping method"}},{"name":"skip_order_ids","in":"query","required":false,"description":"Skipped orders by ids","schema":{"type":"string","description":"Skipped orders by ids"}},{"name":"since_id","in":"query","required":false,"description":"Retrieve entities starting from the specified id.","schema":{"type":"integer","description":"Retrieve entities starting from the specified id."}},{"name":"is_deleted","in":"query","required":false,"description":"Filter deleted orders","schema":{"type":"boolean","description":"Filter deleted orders"}},{"name":"shipping_country_iso3","in":"query","required":false,"description":"Retrieve entities according to shipping country","schema":{"type":"string","description":"Retrieve entities according to shipping country"}},{"name":"enable_cache","in":"query","required":false,"description":"If the value is 'true', we will cache orders for a 15 minutes in order to increase speed and reduce requests throttling for some methods…","schema":{"type":"boolean","default":false,"description":"If the value is 'true', we will cache orders for a 15 minutes in order to increase speed and reduce requests throttling for some methods…"}},{"name":"delivery_method","in":"query","required":false,"description":"Retrieves order with delivery method","schema":{"type":"string","description":"Retrieves order with delivery method"}},{"name":"ship_node_type","in":"query","required":false,"description":"Retrieves order with ship node type","schema":{"type":"string","description":"Retrieves order with ship node type"}},{"name":"currency_id","in":"query","required":false,"description":"Currency Id","schema":{"type":"string","description":"Currency Id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/order-preestimate-shipping-list":{"post":{"operationId":"ecommerce_api2cart_order_preestimate_shipping_list","summary":"Retrieve list of order preestimated shipping methods","description":"POST /order.preestimate_shipping.list.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/order-refund-add":{"post":{"operationId":"ecommerce_api2cart_order_refund_add","summary":"Add a refund to the order.","description":"POST /order.refund.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/order-shipment-add":{"post":{"operationId":"ecommerce_api2cart_order_shipment_add","summary":"Add a shipment to the order.","description":"POST /order.shipment.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/order-shipment-delete":{"post":{"operationId":"ecommerce_api2cart_order_shipment_delete","summary":"Delete order's shipment.","description":"DELETE /order.shipment.delete.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["shipment_id","order_id"],"properties":{"shipment_id":{"type":"string","description":"Shipment id indicates the number of delivery"},"order_id":{"type":"string","description":"Defines the order for which the shipment will be deleted"},"store_id":{"type":"string","description":"Store Id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/order-shipment-info":{"get":{"operationId":"ecommerce_api2cart_order_shipment_info","summary":"Get information of shipment.","description":"GET /order.shipment.info.json","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"Entity id","schema":{"type":"string","description":"Entity id"}},{"name":"order_id","in":"query","required":true,"description":"Defines the order id","schema":{"type":"string","description":"Defines the order id"}},{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,order_id,items,tracking_numbers","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/order-shipment-list":{"get":{"operationId":"ecommerce_api2cart_order_shipment_list","summary":"Get list of shipments by orders.","description":"GET /order.shipment.list.json","tags":["ecommerce"],"parameters":[{"name":"order_id","in":"query","required":true,"description":"Retrieves shipments specified by order id","schema":{"type":"string","description":"Retrieves shipments specified by order id"}},{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)"}},{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,order_id,items,tracking_numbers","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"created_from","in":"query","required":false,"description":"Retrieve entities from their creation date","schema":{"type":"string","description":"Retrieve entities from their creation date"}},{"name":"created_to","in":"query","required":false,"description":"Retrieve entities to their creation date","schema":{"type":"string","description":"Retrieve entities to their creation date"}},{"name":"modified_from","in":"query","required":false,"description":"Retrieve entities from their modification date","schema":{"type":"string","description":"Retrieve entities from their modification date"}},{"name":"modified_to","in":"query","required":false,"description":"Retrieve entities to their modification date","schema":{"type":"string","description":"Retrieve entities to their modification date"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/order-shipment-tracking-add":{"post":{"operationId":"ecommerce_api2cart_order_shipment_tracking_add","summary":"Add order shipment's tracking info.","description":"POST /order.shipment.tracking.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/order-shipment-update":{"post":{"operationId":"ecommerce_api2cart_order_shipment_update","summary":"Update order's shipment information.","description":"PUT /order.shipment.update.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/order-status-list":{"get":{"operationId":"ecommerce_api2cart_order_status_list","summary":"Retrieve list of statuses","description":"GET /order.status.list.json","tags":["ecommerce"],"parameters":[{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/order-transaction-list":{"get":{"operationId":"ecommerce_api2cart_order_transaction_list","summary":"Retrieve list of order transaction","description":"GET /order.transaction.list.json","tags":["ecommerce"],"parameters":[{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"order_ids","in":"query","required":true,"description":"Retrieves order transactions specified by order ids","schema":{"type":"string","description":"Retrieves order transactions specified by order ids"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,order_id,amount,description","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/order-update":{"post":{"operationId":"ecommerce_api2cart_order_update","summary":"Update existing order.","description":"PUT /order.update.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["order_id"],"properties":{"order_id":{"type":"string","description":"Defines the orders specified by order id"},"store_id":{"type":"string","description":"Defines store id where the order should be found"},"order_status":{"type":"string","description":"Defines new order's status"},"comment":{"type":"string","description":"Specifies order comment"},"admin_comment":{"type":"string","description":"Specifies admin's order comment"},"admin_private_comment":{"type":"string","description":"Specifies private admin's order comment"},"date_modified":{"type":"string","description":"Specifies order's modification date"},"date_finished":{"type":"string","description":"Specifies order's finished date"},"financial_status":{"type":"string","description":"Update order financial status to specified"},"fulfillment_status":{"type":"string","description":"Create order with fulfillment status"},"order_payment_method":{"type":"string","description":"Defines order payment method. Setting order_payment_method on Shopify will also change financial_status field value to 'paid'"},"send_notifications":{"type":"boolean","default":false,"description":"Send notifications to customer after order was created"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-add":{"post":{"operationId":"ecommerce_api2cart_product_add","summary":"Add new product to store.","description":"POST /product.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-attribute-list":{"get":{"operationId":"ecommerce_api2cart_product_attribute_list","summary":"Get list of attributes and values.","description":"GET /product.attribute.list.json","tags":["ecommerce"],"parameters":[{"name":"product_id","in":"query","required":true,"description":"Retrieves attributes specified by product id","schema":{"type":"string","description":"Retrieves attributes specified by product id"}},{"name":"attribute_id","in":"query","required":false,"description":"Retrieves info for specified attribute_id","schema":{"type":"string","description":"Retrieves info for specified attribute_id"}},{"name":"variant_id","in":"query","required":false,"description":"Defines product's variants specified by variant id","schema":{"type":"string","description":"Defines product's variants specified by variant id"}},{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)"}},{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"attribute_group_id","in":"query","required":false,"description":"Filter by attribute_group_id","schema":{"type":"string","description":"Filter by attribute_group_id"}},{"name":"set_name","in":"query","required":false,"description":"Retrieves attributes specified by set_name in Magento","schema":{"type":"string","description":"Retrieves attributes specified by set_name in Magento"}},{"name":"lang_id","in":"query","required":false,"description":"Retrieves attributes specified by language id","schema":{"type":"string","description":"Retrieves attributes specified by language id"}},{"name":"store_id","in":"query","required":false,"description":"Retrieves attributes specified by store id","schema":{"type":"string","description":"Retrieves attributes specified by store id"}},{"name":"sort_by","in":"query","required":false,"description":"Set field to sort by","schema":{"type":"string","default":"attribute_id","description":"Set field to sort by"}},{"name":"sort_direction","in":"query","required":false,"description":"Set sorting direction","schema":{"type":"string","default":"asc","description":"Set sorting direction"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"attribute_id,name","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-attribute-value-set":{"post":{"operationId":"ecommerce_api2cart_product_attribute_value_set","summary":"Set attribute value to product.","description":"POST /product.attribute.value.set.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["product_id"],"properties":{"product_id":{"type":"string","description":"Defines product id where the attribute should be added"},"attribute_id":{"type":"string","description":"Filter by attribute_id"},"attribute_group_id":{"type":"string","description":"Filter by attribute_group_id"},"attribute_name":{"type":"string","description":"Define attribute name"},"value":{"type":"string","description":"Define attribute value"},"value_id":{"type":"integer","description":"Define attribute value id"},"lang_id":{"type":"string","description":"Language id"},"store_id":{"type":"string","description":"Store Id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-attribute-value-unset":{"post":{"operationId":"ecommerce_api2cart_product_attribute_value_unset","summary":"Removes attribute value for a product.","description":"POST /product.attribute.value.unset.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["product_id","attribute_id"],"properties":{"product_id":{"type":"string","description":"Product id"},"attribute_id":{"type":"string","description":"Attribute Id"},"store_id":{"type":"string","description":"Store Id"},"include_default":{"type":"boolean","default":false,"description":"Boolean, whether or not to unset default value of the attribute, if applicable"},"reindex":{"type":"boolean","default":true,"description":"Is reindex required"},"clear_cache":{"type":"boolean","default":true,"description":"Is cache clear required"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-brand-list":{"get":{"operationId":"ecommerce_api2cart_product_brand_list","summary":"Get list of brands from your store.","description":"GET /product.brand.list.json","tags":["ecommerce"],"parameters":[{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,short_description,active,url","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"brand_ids","in":"query","required":false,"description":"Retrieves brands specified by brand ids","schema":{"type":"string","description":"Retrieves brands specified by brand ids"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"lang_id","in":"query","required":false,"description":"Language id","schema":{"type":"string","description":"Language id"}},{"name":"created_from","in":"query","required":false,"description":"Retrieve entities from their creation date","schema":{"type":"string","description":"Retrieve entities from their creation date"}},{"name":"created_to","in":"query","required":false,"description":"Retrieve entities to their creation date","schema":{"type":"string","description":"Retrieve entities to their creation date"}},{"name":"modified_from","in":"query","required":false,"description":"Retrieve entities from their modification date","schema":{"type":"string","description":"Retrieve entities from their modification date"}},{"name":"modified_to","in":"query","required":false,"description":"Retrieve entities to their modification date","schema":{"type":"string","description":"Retrieve entities to their modification date"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-child-item-find":{"get":{"operationId":"ecommerce_api2cart_product_child_item_find","summary":"Search product child item (bundled item or configurable product variant) in store catalog.","description":"GET /product.child_item.find.json","tags":["ecommerce"],"parameters":[{"name":"find_value","in":"query","required":true,"description":"Entity search that is specified by some value","schema":{"type":"string","description":"Entity search that is specified by some value"}},{"name":"find_where","in":"query","required":false,"description":"Entity search that is specified by the comma-separated unique fields","schema":{"type":"string","default":"name","description":"Entity search that is specified by the comma-separated unique fields"}},{"name":"find_params","in":"query","required":false,"description":"Entity search that is specified by comma-separated parameters","schema":{"type":"string","default":"whole_words","description":"Entity search that is specified by comma-separated parameters"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-child-item-info":{"get":{"operationId":"ecommerce_api2cart_product_child_item_info","summary":"Get child for specific product.","description":"GET /product.child_item.info.json","tags":["ecommerce"],"parameters":[{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"force_all","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"product_id","in":"query","required":true,"description":"Filter by parent product id","schema":{"type":"string","description":"Filter by parent product id"}},{"name":"id","in":"query","required":true,"description":"Entity id","schema":{"type":"string","description":"Entity id"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"lang_id","in":"query","required":false,"description":"Language id","schema":{"type":"string","description":"Language id"}},{"name":"currency_id","in":"query","required":false,"description":"Currency Id","schema":{"type":"string","description":"Currency Id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-child-item-list":{"get":{"operationId":"ecommerce_api2cart_product_child_item_list","summary":"Get child items list of specific product(s).","description":"GET /product.child_item.list.json","tags":["ecommerce"],"parameters":[{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve products child items via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve products child items via cursor-based pagination (it can't be used with any other filtering parameter)"}},{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"force_all","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"created_from","in":"query","required":false,"description":"Retrieve entities from their creation date","schema":{"type":"string","description":"Retrieve entities from their creation date"}},{"name":"created_to","in":"query","required":false,"description":"Retrieve entities to their creation date","schema":{"type":"string","description":"Retrieve entities to their creation date"}},{"name":"modified_from","in":"query","required":false,"description":"Retrieve entities from their modification date","schema":{"type":"string","description":"Retrieve entities from their modification date"}},{"name":"modified_to","in":"query","required":false,"description":"Retrieve entities to their modification date","schema":{"type":"string","description":"Retrieve entities to their modification date"}},{"name":"product_id","in":"query","required":false,"description":"Filter by parent product id","schema":{"type":"string","description":"Filter by parent product id"}},{"name":"product_ids","in":"query","required":false,"description":"Filter by parent product ids","schema":{"type":"string","description":"Filter by parent product ids"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"lang_id","in":"query","required":false,"description":"Language id","schema":{"type":"string","description":"Language id"}},{"name":"currency_id","in":"query","required":false,"description":"Currency Id","schema":{"type":"string","description":"Currency Id"}},{"name":"avail_sale","in":"query","required":false,"description":"Specifies the set of available/not available products for sale","schema":{"type":"boolean","description":"Specifies the set of available/not available products for sale"}},{"name":"report_request_id","in":"query","required":false,"description":"Report request id","schema":{"type":"string","description":"Report request id"}},{"name":"disable_report_cache","in":"query","required":false,"description":"Disable report cache for current request","schema":{"type":"boolean","default":false,"description":"Disable report cache for current request"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-count":{"get":{"operationId":"ecommerce_api2cart_product_count","summary":"Count products in store.","description":"GET /product.count.json","tags":["ecommerce"],"parameters":[{"name":"category_id","in":"query","required":false,"description":"Counts products specified by category id","schema":{"type":"string","description":"Counts products specified by category id"}},{"name":"created_from","in":"query","required":false,"description":"Retrieve entities from their creation date","schema":{"type":"string","description":"Retrieve entities from their creation date"}},{"name":"created_to","in":"query","required":false,"description":"Retrieve entities to their creation date","schema":{"type":"string","description":"Retrieve entities to their creation date"}},{"name":"modified_from","in":"query","required":false,"description":"Retrieve entities from their modification date","schema":{"type":"string","description":"Retrieve entities from their modification date"}},{"name":"modified_to","in":"query","required":false,"description":"Retrieve entities to their modification date","schema":{"type":"string","description":"Retrieve entities to their modification date"}},{"name":"avail_view","in":"query","required":false,"description":"Specifies the set of visible/invisible products","schema":{"type":"boolean","description":"Specifies the set of visible/invisible products"}},{"name":"avail_sale","in":"query","required":false,"description":"Specifies the set of available/not available products for sale","schema":{"type":"boolean","description":"Specifies the set of available/not available products for sale"}},{"name":"store_id","in":"query","required":false,"description":"Counts products specified by store id","schema":{"type":"string","description":"Counts products specified by store id"}},{"name":"lang_id","in":"query","required":false,"description":"Counts products specified by language id","schema":{"type":"string","description":"Counts products specified by language id"}},{"name":"product_ids","in":"query","required":false,"description":"Counts products specified by product ids","schema":{"type":"string","description":"Counts products specified by product ids"}},{"name":"report_request_id","in":"query","required":false,"description":"Report request id","schema":{"type":"string","description":"Report request id"}},{"name":"disable_report_cache","in":"query","required":false,"description":"Disable report cache for current request","schema":{"type":"boolean","default":false,"description":"Disable report cache for current request"}},{"name":"brand_name","in":"query","required":false,"description":"Retrieves brands specified by brand name","schema":{"type":"string","description":"Retrieves brands specified by brand name"}},{"name":"product_attributes","in":"query","required":false,"description":"Defines product attributes","schema":{"type":"array","description":"Defines product attributes"}},{"name":"status","in":"query","required":false,"description":"Defines product's status","schema":{"type":"string","description":"Defines product's status"}},{"name":"type","in":"query","required":false,"description":"Defines products's type","schema":{"type":"string","description":"Defines products's type"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-currency-add":{"post":{"operationId":"ecommerce_api2cart_product_currency_add","summary":"Add currency and/or set default in store","description":"POST /product.currency.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["iso3","rate"],"properties":{"iso3":{"type":"string","description":"Specifies standardized currency code"},"rate":{"type":"number","description":"Defines the numerical identifier against to the major currency"},"name":{"type":"string","description":"Defines currency's name"},"avail":{"type":"boolean","default":true,"description":"Specifies whether the currency is available"},"symbol_left":{"type":"string","description":"Defines the symbol that is located before the currency"},"symbol_right":{"type":"string","description":"Defines the symbol that is located after the currency"},"default":{"type":"boolean","default":false,"description":"Specifies currency's default meaning"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-currency-list":{"get":{"operationId":"ecommerce_api2cart_product_currency_list","summary":"Get list of currencies","description":"GET /product.currency.list.json","tags":["ecommerce"],"parameters":[{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"name,iso3,default,avail","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"default","in":"query","required":false,"description":"Specifies the set of default/not default currencies","schema":{"type":"boolean","description":"Specifies the set of default/not default currencies"}},{"name":"avail","in":"query","required":false,"description":"Specifies the set of available/not available currencies","schema":{"type":"boolean","description":"Specifies the set of available/not available currencies"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-delete":{"post":{"operationId":"ecommerce_api2cart_product_delete","summary":"Product delete","description":"DELETE /product.delete.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Product id that will be removed"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-fields":{"get":{"operationId":"ecommerce_api2cart_product_fields","summary":"Retrieve all available fields for product item in store.","description":"GET /product.fields.json","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-find":{"get":{"operationId":"ecommerce_api2cart_product_find","summary":"Search product in store catalog. \"Apple\" is specified here by default.","description":"GET /product.find.json","tags":["ecommerce"],"parameters":[{"name":"find_value","in":"query","required":true,"description":"Entity search that is specified by some value","schema":{"type":"string","description":"Entity search that is specified by some value"}},{"name":"find_where","in":"query","required":false,"description":"Entity search that is specified by the comma-separated unique fields","schema":{"type":"string","default":"name","description":"Entity search that is specified by the comma-separated unique fields"}},{"name":"find_params","in":"query","required":false,"description":"Entity search that is specified by comma-separated parameters","schema":{"type":"string","default":"whole_words","description":"Entity search that is specified by comma-separated parameters"}},{"name":"find_what","in":"query","required":false,"description":"Parameter's value specifies the entity that has to be found","schema":{"type":"string","default":"product","description":"Parameter's value specifies the entity that has to be found"}},{"name":"lang_id","in":"query","required":false,"description":"Search products specified by language id","schema":{"type":"string","description":"Search products specified by language id"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-image-add":{"post":{"operationId":"ecommerce_api2cart_product_image_add","summary":"Add image to product","description":"POST /product.image.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-image-delete":{"post":{"operationId":"ecommerce_api2cart_product_image_delete","summary":"Delete image","description":"DELETE /product.image.delete.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["product_id","id"],"properties":{"product_id":{"type":"string","description":"Defines product id where the image should be deleted"},"id":{"type":"string","description":"Entity id"},"store_id":{"type":"string","description":"Store Id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-image-update":{"post":{"operationId":"ecommerce_api2cart_product_image_update","summary":"Update details of image","description":"PUT /product.image.update.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["product_id","id"],"properties":{"product_id":{"type":"string","description":"Defines product id where the image should be updated"},"variant_ids":{"type":"string","description":"Defines product's variants ids"},"image_name":{"type":"string","description":"Defines image's name"},"type":{"type":"string","default":"additional","description":"Defines image's types that are specified by comma-separated list"},"label":{"type":"string","description":"Defines alternative text that has to be attached to the picture"},"position":{"type":"integer","description":"Defines image’s position in the list"},"id":{"type":"string","description":"Defines image update specified by image id"},"store_id":{"type":"string","description":"Store Id"},"lang_id":{"type":"string","description":"Language id"},"hidden":{"type":"boolean","description":"Define is hide image"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-info":{"get":{"operationId":"ecommerce_api2cart_product_info","summary":"Get product info about product ID *** or specify other product ID.","description":"GET /product.info.json","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"Retrieves product's info specified by product id","schema":{"type":"string","description":"Retrieves product's info specified by product id"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,description,price,categories_ids","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"store_id","in":"query","required":false,"description":"Retrieves product info specified by store id","schema":{"type":"string","description":"Retrieves product info specified by store id"}},{"name":"lang_id","in":"query","required":false,"description":"Retrieves product info specified by language id","schema":{"type":"string","description":"Retrieves product info specified by language id"}},{"name":"currency_id","in":"query","required":false,"description":"Currency Id","schema":{"type":"string","description":"Currency Id"}},{"name":"report_request_id","in":"query","required":false,"description":"Report request id","schema":{"type":"string","description":"Report request id"}},{"name":"disable_report_cache","in":"query","required":false,"description":"Disable report cache for current request","schema":{"type":"boolean","default":false,"description":"Disable report cache for current request"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-list":{"get":{"operationId":"ecommerce_api2cart_product_list","summary":"Get list of products from your store. Returns 10 products by default.","description":"GET /product.list.json","tags":["ecommerce"],"parameters":[{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve products via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve products via cursor-based pagination (it can't be used with any other filtering parameter)"}},{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,description,price,categories_ids","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"category_id","in":"query","required":false,"description":"Retrieves products specified by category id","schema":{"type":"string","description":"Retrieves products specified by category id"}},{"name":"created_from","in":"query","required":false,"description":"Retrieve entities from their creation date","schema":{"type":"string","description":"Retrieve entities from their creation date"}},{"name":"created_to","in":"query","required":false,"description":"Retrieve entities to their creation date","schema":{"type":"string","description":"Retrieve entities to their creation date"}},{"name":"modified_from","in":"query","required":false,"description":"Retrieve entities from their modification date","schema":{"type":"string","description":"Retrieve entities from their modification date"}},{"name":"modified_to","in":"query","required":false,"description":"Retrieve entities to their modification date","schema":{"type":"string","description":"Retrieve entities to their modification date"}},{"name":"avail_view","in":"query","required":false,"description":"Specifies the set of visible/invisible products","schema":{"type":"boolean","description":"Specifies the set of visible/invisible products"}},{"name":"avail_sale","in":"query","required":false,"description":"Specifies the set of available/not available products for sale","schema":{"type":"boolean","description":"Specifies the set of available/not available products for sale"}},{"name":"store_id","in":"query","required":false,"description":"Retrieves products specified by store id","schema":{"type":"string","description":"Retrieves products specified by store id"}},{"name":"lang_id","in":"query","required":false,"description":"Retrieves products specified by language id","schema":{"type":"string","description":"Retrieves products specified by language id"}},{"name":"currency_id","in":"query","required":false,"description":"Currency Id","schema":{"type":"string","description":"Currency Id"}},{"name":"product_ids","in":"query","required":false,"description":"Retrieves products specified by product ids","schema":{"type":"string","description":"Retrieves products specified by product ids"}},{"name":"since_id","in":"query","required":false,"description":"Retrieve entities starting from the specified id.","schema":{"type":"integer","description":"Retrieve entities starting from the specified id."}},{"name":"report_request_id","in":"query","required":false,"description":"Report request id","schema":{"type":"string","description":"Report request id"}},{"name":"disable_report_cache","in":"query","required":false,"description":"Disable report cache for current request","schema":{"type":"boolean","default":false,"description":"Disable report cache for current request"}},{"name":"sort_by","in":"query","required":false,"description":"Set field to sort by","schema":{"type":"string","default":"id","description":"Set field to sort by"}},{"name":"sort_direction","in":"query","required":false,"description":"Set sorting direction","schema":{"type":"string","default":"asc","description":"Set sorting direction"}},{"name":"sku","in":"query","required":false,"description":"Filter by product's sku","schema":{"type":"string","description":"Filter by product's sku"}},{"name":"disable_cache","in":"query","required":false,"description":"Disable cache for current request","schema":{"type":"boolean","default":false,"description":"Disable cache for current request"}},{"name":"brand_name","in":"query","required":false,"description":"Retrieves brands specified by brand name","schema":{"type":"string","description":"Retrieves brands specified by brand name"}},{"name":"product_attributes","in":"query","required":false,"description":"Defines product attributes","schema":{"type":"array","description":"Defines product attributes"}},{"name":"status","in":"query","required":false,"description":"Defines product's status","schema":{"type":"string","description":"Defines product's status"}},{"name":"type","in":"query","required":false,"description":"Defines products's type","schema":{"type":"string","description":"Defines products's type"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-manufacturer-add":{"post":{"operationId":"ecommerce_api2cart_product_manufacturer_add","summary":"Add manufacturer to store and assign to product","description":"POST /product.manufacturer.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["product_id","manufacturer"],"properties":{"product_id":{"type":"string","description":"Defines products specified by product id"},"manufacturer":{"type":"string","description":"Defines product’s manufacturer's name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-option-add":{"post":{"operationId":"ecommerce_api2cart_product_option_add","summary":"Add product option from store.","description":"POST /product.option.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"Defines option's name"},"type":{"type":"string","enum":["option_type_select","option_type_text","option_type_radio","option_type_checkbox","option_type_textarea","option_type_readonly","option_type_multiselect","option_type_multicheckbox","option_type_file","option_type_date","option_type_datetime","option_type_time"],"description":"Defines option's type that has to be added"},"product_id":{"type":"string","description":"Defines product id where the option should be added"},"default_option_value":{"type":"string","description":"Defines default option value that has to be added"},"option_values":{"type":"string","description":"Defines option values that has to be added"},"description":{"type":"string","description":"Defines option's description"},"avail":{"type":"boolean","default":true,"description":"Defines whether the option is available"},"sort_order":{"type":"integer","default":0,"description":"Sort number in the list"},"required":{"type":"boolean","default":false,"description":"Defines if the option is required"},"clear_cache":{"type":"boolean","default":true,"description":"Is cache clear required"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-option-assign":{"post":{"operationId":"ecommerce_api2cart_product_option_assign","summary":"Assign option from product.","description":"POST /product.option.assign.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["product_id","option_id"],"properties":{"product_id":{"type":"string","description":"Defines product id where the option should be assigned"},"option_id":{"type":"string","description":"Defines option id which has to be assigned"},"required":{"type":"boolean","default":false,"description":"Defines if the option is required"},"sort_order":{"type":"integer","default":0,"description":"Sort number in the list"},"option_values":{"type":"string","description":"Defines option values that has to be assigned"},"clear_cache":{"type":"boolean","default":true,"description":"Is cache clear required"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-option-list":{"get":{"operationId":"ecommerce_api2cart_product_option_list","summary":"Get list of options.","description":"GET /product.option.list.json","tags":["ecommerce"],"parameters":[{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,name,description","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"product_id","in":"query","required":false,"description":"Retrieves products' options specified by product id","schema":{"type":"string","description":"Retrieves products' options specified by product id"}},{"name":"lang_id","in":"query","required":false,"description":"Language id","schema":{"type":"string","description":"Language id"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-option-value-add":{"post":{"operationId":"ecommerce_api2cart_product_option_value_add","summary":"Add product option item from option.","description":"POST /product.option.value.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["product_id","option_id","option_value"],"properties":{"product_id":{"type":"string","description":"Defines product id where the option value should be added"},"option_id":{"type":"string","description":"Defines option id where the value has to be added"},"option_value":{"type":"string","description":"Defines option value that has to be added"},"sort_order":{"type":"integer","default":0,"description":"Sort number in the list"},"clear_cache":{"type":"boolean","default":true,"description":"Is cache clear required"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-option-value-assign":{"post":{"operationId":"ecommerce_api2cart_product_option_value_assign","summary":"Assign product option item from product.","description":"POST /product.option.value.assign.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["product_option_id","option_value_id"],"properties":{"product_option_id":{"type":"integer","description":"Defines product's option id where the value has to be assigned"},"option_value_id":{"type":"integer","description":"Defines value id that has to be assigned"},"clear_cache":{"type":"boolean","default":true,"description":"Is cache clear required"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-option-value-update":{"post":{"operationId":"ecommerce_api2cart_product_option_value_update","summary":"Update product option item from option.","description":"PUT /product.option.value.update.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["product_id","option_id","option_value_id","option_value"],"properties":{"product_id":{"type":"string","description":"Defines product id where the option value should be updated"},"option_id":{"type":"string","description":"Defines option id where the value has to be updated"},"option_value_id":{"type":"integer","description":"Defines value id that has to be assigned"},"option_value":{"type":"string","description":"Defines option value that has to be added"},"price":{"type":"number","description":"Defines new product option price"},"quantity":{"type":"number","description":"Defines new products' options quantity"},"clear_cache":{"type":"boolean","default":true,"description":"Is cache clear required"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-price-add":{"post":{"operationId":"ecommerce_api2cart_product_price_add","summary":"Add some prices to the product.","description":"POST /product.price.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-price-delete":{"post":{"operationId":"ecommerce_api2cart_product_price_delete","summary":"Delete some prices of the product","description":"DELETE /product.price.delete.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["product_id"],"properties":{"product_id":{"type":"string","description":"Defines the product where the price has to be deleted"},"group_prices":{"type":"string","description":"Defines product's group prices"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-price-update":{"post":{"operationId":"ecommerce_api2cart_product_price_update","summary":"Update some prices of the product.","description":"PUT /product.price.update.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-review-list":{"get":{"operationId":"ecommerce_api2cart_product_review_list","summary":"Get reviews of a specific product.","description":"GET /product.review.list.json","tags":["ecommerce"],"parameters":[{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"product_id","in":"query","required":true,"description":"Product id","schema":{"type":"string","description":"Product id"}},{"name":"ids","in":"query","required":false,"description":"Retrieves reviews specified by ids","schema":{"type":"string","description":"Retrieves reviews specified by ids"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"status","in":"query","required":false,"description":"Defines status","schema":{"type":"string","description":"Defines status"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,customer_id,email,message,status,product_id,nick_name,summary,rating,ratings,status,created_time","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-store-assign":{"post":{"operationId":"ecommerce_api2cart_product_store_assign","summary":"Assign product to store","description":"POST /product.store.assign.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["product_id","store_id"],"properties":{"product_id":{"type":"string","description":"Defines id of the product which should be assigned to a store"},"store_id":{"type":"string","description":"Defines id of the store product should be assigned to"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-tax-add":{"post":{"operationId":"ecommerce_api2cart_product_tax_add","summary":"Add tax class and tax rate to store and assign to product.","description":"POST /product.tax.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-update":{"post":{"operationId":"ecommerce_api2cart_product_update","summary":"Update price and quantity for a specific product","description":"PUT /product.update.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-variant-add":{"post":{"operationId":"ecommerce_api2cart_product_variant_add","summary":"Add variant to product.","description":"POST /product.variant.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-variant-delete":{"post":{"operationId":"ecommerce_api2cart_product_variant_delete","summary":"Delete variant.","description":"DELETE /product.variant.delete.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","product_id"],"properties":{"id":{"type":"string","description":"Defines variant removal, specified by variant id"},"product_id":{"type":"string","description":"Defines product's id where the variant has to be deleted"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-variant-image-add":{"post":{"operationId":"ecommerce_api2cart_product_variant_image_add","summary":"Add image to product","description":"POST /product.variant.image.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-variant-image-delete":{"post":{"operationId":"ecommerce_api2cart_product_variant_image_delete","summary":"Delete image to product","description":"DELETE /product.variant.image.delete.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["product_id","product_variant_id","id"],"properties":{"product_id":{"type":"string","description":"Defines product id where the variant image should be deleted"},"product_variant_id":{"type":"integer","description":"Defines product's variants specified by variant id"},"id":{"type":"string","description":"Entity id"},"store_id":{"type":"string","description":"Store Id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-variant-price-add":{"post":{"operationId":"ecommerce_api2cart_product_variant_price_add","summary":"Add some prices to the product variant.","description":"POST /product.variant.price.add.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-variant-price-delete":{"post":{"operationId":"ecommerce_api2cart_product_variant_price_delete","summary":"Delete some prices of the product variant.","description":"DELETE /product.variant.price.delete.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","product_id","group_prices"],"properties":{"id":{"type":"string","description":"Defines the variant where the price has to be deleted"},"product_id":{"type":"string","description":"Product id"},"group_prices":{"type":"string","description":"Defines variants's group prices"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-variant-price-update":{"post":{"operationId":"ecommerce_api2cart_product_variant_price_update","summary":"Update some prices of the product variant.","description":"PUT /product.variant.price.update.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/product-variant-update":{"post":{"operationId":"ecommerce_api2cart_product_variant_update","summary":"Update variant.","description":"PUT /product.variant.update.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/subscriber-list":{"get":{"operationId":"ecommerce_api2cart_subscriber_list","summary":"Get subscribers list","description":"GET /subscriber.list.json","tags":["ecommerce"],"parameters":[{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"subscribed","in":"query","required":false,"description":"Filter by subscription status","schema":{"type":"boolean","description":"Filter by subscription status"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"email","in":"query","required":false,"description":"Filter subscribers by email","schema":{"type":"string","description":"Filter subscribers by email"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"force_all","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}},{"name":"created_from","in":"query","required":false,"description":"Retrieve entities from their creation date","schema":{"type":"string","description":"Retrieve entities from their creation date"}},{"name":"created_to","in":"query","required":false,"description":"Retrieve entities to their creation date","schema":{"type":"string","description":"Retrieve entities to their creation date"}},{"name":"modified_from","in":"query","required":false,"description":"Retrieve entities from their modification date","schema":{"type":"string","description":"Retrieve entities from their modification date"}},{"name":"modified_to","in":"query","required":false,"description":"Retrieve entities to their modification date","schema":{"type":"string","description":"Retrieve entities to their modification date"}},{"name":"page_cursor","in":"query","required":false,"description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/tax-class-info":{"get":{"operationId":"ecommerce_api2cart_tax_class_info","summary":"Get info about tax","description":"GET /tax.class.info.json","tags":["ecommerce"],"parameters":[{"name":"tax_class_id","in":"query","required":true,"description":"Retrieves taxes specified by class id","schema":{"type":"string","description":"Retrieves taxes specified by class id"}},{"name":"store_id","in":"query","required":false,"description":"Store Id","schema":{"type":"string","description":"Store Id"}},{"name":"lang_id","in":"query","required":false,"description":"Language id","schema":{"type":"string","description":"Language id"}},{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"tax_class_id,name,avail","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"response_fields","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"exclude","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all","schema":{"type":"string","description":"Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/webhook-count":{"get":{"operationId":"ecommerce_api2cart_webhook_count","summary":"Count registered webhooks on the store.","description":"GET /webhook.count.json","tags":["ecommerce"],"parameters":[{"name":"entity","in":"query","required":false,"description":"The entity you want to filter webhooks by (e.g. order or product)","schema":{"type":"string","description":"The entity you want to filter webhooks by (e.g. order or product)"}},{"name":"action","in":"query","required":false,"description":"The action you want to filter webhooks by (e.g. order or product)","schema":{"type":"string","description":"The action you want to filter webhooks by (e.g. order or product)"}},{"name":"active","in":"query","required":false,"description":"The webhook status you want to filter webhooks by","schema":{"type":"boolean","description":"The webhook status you want to filter webhooks by"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/webhook-create":{"post":{"operationId":"ecommerce_api2cart_webhook_create","summary":"Create webhook on the store and subscribe to it.","description":"POST /webhook.create.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["entity","action"],"properties":{"entity":{"type":"string","description":"Specify the entity that you want to enable webhooks for (e.g product, order, customer, category)"},"action":{"type":"string","description":"Specify what action (event) will trigger the webhook (e.g add, delete, or update)"},"callback":{"type":"string","description":"Callback url that returns shipping rates. It should be able to accept POST requests with json data."},"label":{"type":"string","description":"The name you give to the webhook"},"fields":{"type":"string","default":"force_all","description":"Fields the webhook should send"},"active":{"type":"boolean","default":true,"description":"Webhook status"},"store_id":{"type":"string","description":"Defines store id where the webhook should be assigned"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/webhook-delete":{"post":{"operationId":"ecommerce_api2cart_webhook_delete","summary":"Delete registered webhook on the store.","description":"DELETE /webhook.delete.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Webhook id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/webhook-events":{"get":{"operationId":"ecommerce_api2cart_webhook_events","summary":"List all Webhooks that are available on this store.","description":"GET /webhook.events.json","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/webhook-list":{"get":{"operationId":"ecommerce_api2cart_webhook_list","summary":"List registered webhook on the store.","description":"GET /webhook.list.json","tags":["ecommerce"],"parameters":[{"name":"params","in":"query","required":false,"description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"id,entity,action,callback","description":"Set this parameter in order to choose which entity fields you want to retrieve"}},{"name":"start","in":"query","required":false,"description":"This parameter sets the number from which you want to get entities","schema":{"type":"integer","default":0,"description":"This parameter sets the number from which you want to get entities"}},{"name":"count","in":"query","required":false,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250","schema":{"type":"integer","default":10,"description":"This parameter sets the entity amount that has to be retrieved. Max allowed count=250"}},{"name":"entity","in":"query","required":false,"description":"The entity you want to filter webhooks by (e.g. order or product)","schema":{"type":"string","description":"The entity you want to filter webhooks by (e.g. order or product)"}},{"name":"action","in":"query","required":false,"description":"The action you want to filter webhooks by (e.g. add, update, or delete)","schema":{"type":"string","description":"The action you want to filter webhooks by (e.g. add, update, or delete)"}},{"name":"active","in":"query","required":false,"description":"The webhook status you want to filter webhooks by","schema":{"type":"boolean","description":"The webhook status you want to filter webhooks by"}},{"name":"ids","in":"query","required":false,"description":"List of сomma-separated webhook ids","schema":{"type":"string","description":"List of сomma-separated webhook ids"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:api2cart/webhook-update":{"post":{"operationId":"ecommerce_api2cart_webhook_update","summary":"Update Webhooks parameters.","description":"PUT /webhook.update.json","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Webhook id"},"callback":{"type":"string","description":"Callback url that returns shipping rates. It should be able to accept POST requests with json data."},"label":{"type":"string","description":"The name you give to the webhook"},"fields":{"type":"string","description":"Fields the webhook should send"},"active":{"type":"boolean","description":"Webhook status"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}