# Swagger API2Cart API

> Swagger API2Cart API on Apizie: 139 endpoints (Add store to the account, Get list of carts., Update configs in the API2Cart database., List webhooks that was not delivered to the callback., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/ecommerce:api2cart/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `ecommerce:api2cart`
- Category: E-commerce
- Status: byok
- Source: https://api2cart.com
- Page: https://www.apizie.tech/api/ecommerce/api2cart
- OpenAPI: https://www.apizie.tech/api/ecommerce/api2cart/openapi.json

API2Cart

## Endpoints

### Add store to the account
`POST https://www.apizie.tech/v1/ecommerce:api2cart/account-cart-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get list of carts.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/account-cart-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| request_from_date | string | no | Retrieve entities from their creation date |
| request_to_date | string | no | Retrieve entities to their creation date |
| store_url | string | no | A web address of a store |
| store_key | string | no | Find store by store key |

### Update configs in the API2Cart database.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/account-config-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| new_store_key | string | no | Update store key |
| bridge_url | string | no | 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 | string | no | Absolute path to the store root directory (used with "bridge_url" parameter) |
| db_tables_prefix | string | no | DB tables prefix |
| 3dcart_private_key | string | no | 3DCart Private Key |
| 3dcart_access_token | string | no | 3DCart Token |
| 3dcartapi_api_key | string | no | 3DCart API Key |
| amazon_sp_client_id | string | no | Amazon SP API app client id |
| amazon_sp_client_secret | string | no | Amazon SP API app client secret |
| amazon_sp_aws_user_key_id | string | no | Amazon AWS user access key ID |
| amazon_sp_aws_user_secret | string | no | Amazon AWS user secret access key |
| amazon_sp_aws_region | string | no | Amazon AWS Region |
| amazon_sp_aws_role_arn | string | no | Amazon AWS Role ARN |
| amazon_sp_refresh_token | string | no | Amazon SP API OAuth refresh token |
| amazon_sp_api_environment | string | no | Amazon SP API environment |
| amazon_access_token | string | no | MWS Auth Token. Access token authorizing the app to access resources on behalf of a user |
| amazon_seller_id | string | no | Amazon Seller ID (Merchant token) |
| amazon_marketplaces_ids | string | no | Amazon Marketplace IDs comma separated string |
| amazon_secret_key | string | no | Amazon Secret Key |
| amazon_access_key_id | string | no | Amazon Secret Key Id |
| aspdotnetstorefront_api_user | string | no | It's a AspDotNetStorefront account for which API is available |
| aspdotnetstorefront_api_pass | string | no | AspDotNetStorefront API Password |
| bigcommerceapi_admin_account | string | no | It's a BigCommerce account for which API is enabled |
| bigcommerceapi_api_path | string | no | BigCommerce API URL |
| bigcommerceapi_api_key | string | no | Bigcommerce API Key |
| bigcommerceapi_client_id | string | no | Client ID of the requesting app |
| bigcommerceapi_access_token | string | no | Access token authorizing the app to access resources on behalf of a user |
| bigcommerceapi_context | string | no | API Path section unique to the store |
| demandware_client_id | string | no | Demandware client id |
| demandware_api_password | string | no | Demandware api password |
| demandware_user_name | string | no | Demandware user name |
| demandware_user_password | string | no | Demandware user password |
| ebay_client_id | string | no | Application ID (AppID). |
| ebay_client_secret | string | no | Shared Secret from eBay application |
| ebay_runame | string | no | The RuName value that eBay assigns to your application. |
| ebay_access_token | string | no | Used to authenticate API requests. |
| ebay_refresh_token | string | no | Used to renew the access token. |
| ebay_environment | string | no | eBay environment |
| ebay_site_id | integer | no | eBay global ID |
| ecwid_acess_token | string | no | Access token authorizing the app to access resources on behalf of a user |
| ecwid_store_id | string | no | Store Id |
| etsy_keystring | string | no | Etsy keystring |
| etsy_shared_secret | string | no | Etsy shared secret |
| etsy_access_token | string | no | Access token authorizing the app to access resources on behalf of a user |
| etsy_token_secret | string | no | Secret token authorizing the app to access resources on behalf of a user |
| etsy_client_id | string | no | Etsy Client Id |
| etsy_refresh_token | string | no | Etsy Refresh token |
| neto_api_key | string | no | Neto API Key |
| neto_api_username | string | no | Neto User Name |
| shopify_api_key | string | no | Shopify API Key |
| shopify_api_password | string | no | Shopify API Password |
| shopify_shared_secret | string | no | Shared secret |
| shopify_access_token | string | no | Access token authorizing the app to access resources on behalf of a user |
| shopware_access_key | string | no | Shopware access key |
| shopware_api_key | string | no | Shopware api key |
| shopware_api_secret | string | no | Shopware client secret access key |
| volusion_login | string | no | It's a Volusion account for which API is enabled |
| volusion_password | string | no | Volusion API Password |
| walmart_client_id | string | no | Walmart client ID |
| walmart_client_secret | string | no | Walmart client secret |
| walmart_environment | string | no | Walmart environment |
| walmart_channel_type | string | no | Walmart WM_CONSUMER.CHANNEL.TYPE header |
| squarespace_api_key | string | no | Squarespace API Key |
| hybris_client_id | string | no | Omni Commerce Connector Client ID |
| hybris_client_secret | string | no | Omni Commerce Connector Client Secret |
| hybris_username | string | no | User Name |
| hybris_password | string | no | User password |
| hybris_websites | array | no | Websites to stores mapping data |
| lightspeed_api_key | string | no | LightSpeed api key |
| lightspeed_api_secret | string | no | LightSpeed api secret |
| commercehq_api_key | string | no | CommerceHQ api key |
| commercehq_api_password | string | no | CommerceHQ api password |
| wc_consumer_key | string | no | Woocommerce consumer key |
| wc_consumer_secret | string | no | Woocommerce consumer secret |
| magento_consumer_key | string | no | Magento Consumer Key |
| magento_consumer_secret | string | no | Magento Consumer Secret |
| magento_access_token | string | no | Magento Access Token |
| magento_token_secret | string | no | Magento Token Secret |
| prestashop_webservice_key | string | no | Prestashop webservice key |
| wix_app_id | string | no | Wix App ID |
| wix_app_secret_key | string | no | Wix App Secret Key |
| wix_refresh_token | string | no | Wix refresh token |
| mercado_libre_app_id | string | no | Mercado Libre App ID |
| mercado_libre_app_secret_key | string | no | Mercado Libre App Secret Key |
| mercado_libre_refresh_token | string | no | Mercado Libre Refresh Token |
| zid_client_id | integer | no | Zid Client ID |
| zid_client_secret | string | no | Zid Client Secret |
| zid_access_token | string | no | Zid Access Token |
| zid_authorization | string | no | Zid Authorization |
| zid_refresh_token | string | no | Zid refresh token |

### List webhooks that was not delivered to the callback.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/account-failed-webhooks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| start | integer | no | This parameter sets the number from which you want to get entities |
| ids | string | no | List of сomma-separated webhook ids |

### Get list of supported platforms
`GET https://www.apizie.tech/v1/ecommerce:api2cart/account-supported-platforms` (byok)

### Add new attribute
`POST https://www.apizie.tech/v1/ecommerce:api2cart/attribute-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| type | string | yes | Defines attribute's type |
| code | string | no | Entity code |
| name | string | yes | Defines attributes's name |
| store_id | string | no | Store Id |
| lang_id | string | no | Language id |
| visible | boolean | no | Set visibility status |
| required | boolean | no | Defines if the option is required |
| position | integer | no | Attribute`s position |
| attribute_group_id | string | no | Filter by attribute_group_id |
| is_global | string | no | Attribute saving scope |
| is_searchable | boolean | no | Use attribute in Quick Search |
| is_filterable | string | no | Use In Layered Navigation |
| is_comparable | boolean | no | Comparable on Front-end |
| is_html_allowed_on_front | boolean | no | Allow HTML Tags on Frontend |
| is_filterable_in_search | boolean | no | Use In Search Results Layered Navigation |
| is_configurable | boolean | no | Use To Create Configurable Product |
| is_visible_in_advanced_search | boolean | no | Use in Advanced Search |
| is_used_for_promo_rules | boolean | no | Use for Promo Rule Conditions |
| used_in_product_listing | boolean | no | Used in Product Listing |
| used_for_sort_by | boolean | no | Used for Sorting in Product Listing |
| apply_to | string | no | Types of products which can have this attribute |

### Assign attribute to the group
`POST https://www.apizie.tech/v1/ecommerce:api2cart/attribute-assign-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Entity id |
| group_id | string | yes | Attribute group_id |
| attribute_set_id | string | no | Attribute set id |

### Assign attribute to the attribute set
`POST https://www.apizie.tech/v1/ecommerce:api2cart/attribute-assign-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Entity id |
| group_id | string | no | Attribute group_id |
| attribute_set_id | string | yes | Attribute set id |

### Get attribute_set list
`GET https://www.apizie.tech/v1/ecommerce:api2cart/attribute-attributeset-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |

### Get attributes count
`GET https://www.apizie.tech/v1/ecommerce:api2cart/attribute-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| type | string | no | Defines attribute's type |
| store_id | string | no | Store Id |
| lang_id | string | no | Language id |
| visible | boolean | no | Filter items by visibility status |
| required | boolean | no | Defines if the option is required |
| system | boolean | no | True if attribute is system |

### Delete attribute from store
`POST https://www.apizie.tech/v1/ecommerce:api2cart/attribute-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| store_id | string | no | Store Id |
| id | string | yes | Entity id |

### Get attribute group list
`GET https://www.apizie.tech/v1/ecommerce:api2cart/attribute-group-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| lang_id | string | no | Language id |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| attribute_set_id | string | no | Attribute set id |

### Get attribute info
`GET https://www.apizie.tech/v1/ecommerce:api2cart/attribute-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Entity id |
| store_id | string | no | Store Id |
| lang_id | string | no | Language id |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |

### Get attributes list
`GET https://www.apizie.tech/v1/ecommerce:api2cart/attribute-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| type | string | no | Defines attribute's type |
| attribute_ids | string | no | Filter attributes by ids |
| store_id | string | no | Store Id |
| lang_id | string | no | Retrieves attributes on specified language id |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| visible | boolean | no | Filter items by visibility status |
| required | boolean | no | Defines if the option is required |
| system | boolean | no | True if attribute is system |

### Get list of supported attributes types
`GET https://www.apizie.tech/v1/ecommerce:api2cart/attribute-type-list` (byok)

### Unassign attribute from group
`POST https://www.apizie.tech/v1/ecommerce:api2cart/attribute-unassign-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Entity id |
| group_id | string | yes | Customer group_id |

### Unassign attribute from attribute set
`POST https://www.apizie.tech/v1/ecommerce:api2cart/attribute-unassign-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Entity id |
| attribute_set_id | string | yes | Attribute set id |

### Update attribute data
`POST https://www.apizie.tech/v1/ecommerce:api2cart/attribute-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Entity id |
| name | string | yes | Defines new attributes's name |
| store_id | string | no | Store Id |
| lang_id | string | no | Language id |

### Retrieve basket information.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/basket-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Entity id |
| store_id | string | no | Store Id |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |

### Add item to basket
`POST https://www.apizie.tech/v1/ecommerce:api2cart/basket-item-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | yes | Retrieves orders specified by customer id |
| product_id | string | yes | Defines id of the product which should be added to the basket |
| variant_id | string | no | Defines product's variants specified by variant id |
| quantity | number | no | Defines new items quantity |
| store_id | string | no | Store Id |

### Create live shipping rate service.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/basket-live-shipping-service-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| store_id | string | no | Store Id |
| name | string | yes | Shipping Service Name |
| callback | string | yes | Callback url that returns shipping rates. It should be able to accept POST requests with json data. |

### Delete live shipping rate service.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/basket-live-shipping-service-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Entity id |

### Retrieve a list of live shipping rate services.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/basket-live-shipping-service-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| store_id | string | no | Store Id |
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |

### Delete bridge from the store.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/bridge-delete` (byok)

### Download bridge for store
`GET https://www.apizie.tech/v1/ecommerce:api2cart/bridge-download` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| whitelabel | boolean | no | Identifies if there is a necessity to download whitelabel bridge. |

### Update bridge in the store.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/bridge-update` (byok)

### Get bridge key and store key
`GET https://www.apizie.tech/v1/ecommerce:api2cart/cart-bridge` (byok)

### Get count of cart catalog price rules discounts.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/cart-catalog-price-rules-count` (byok)

### Get cart catalog price rules discounts.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/cart-catalog-price-rules-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page_cursor | string | no | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) |
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| ids | string | no | Retrieves catalog_price_rules by ids |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |

### Clear cache on store.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/cart-clear-cache` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cache_type | string | yes | Defines which cache should be cleared. |

### Get list of cart configs
`GET https://www.apizie.tech/v1/ecommerce:api2cart/cart-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |

### Create new coupon
`POST https://www.apizie.tech/v1/ecommerce:api2cart/cart-coupon-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Create new coupon condition
`POST https://www.apizie.tech/v1/ecommerce:api2cart/cart-coupon-condition-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| store_id | string | no | Store Id |
| coupon_id | string | yes | Coupon Id |
| target | string | no | Defines condition operator |
| entity | string | yes | Defines condition entity type |
| key | string | yes | Defines condition entity attribute key |
| operator | string | yes | Defines condition operator |
| value | string | yes | Defines condition value, can be comma separated according to the operator. |

### Get cart coupons count.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/cart-coupon-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| store_id | string | no | Store Id |
| date_start_from | string | no | Filter entity by date_start (greater or equal) |
| date_start_to | string | no | Filter entity by date_start (less or equal) |
| date_end_from | string | no | Filter entity by date_end (greater or equal) |
| date_end_to | string | no | Filter entity by date_end (less or equal) |
| avail | boolean | no | Defines category's visibility status |

### Delete coupon
`POST https://www.apizie.tech/v1/ecommerce:api2cart/cart-coupon-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Entity id |
| store_id | string | no | Store Id |

### Get cart coupon discounts.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/cart-coupon-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page_cursor | string | no | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) |
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| coupons_ids | string | no | Filter coupons by ids |
| store_id | string | no | Filter coupons by store id |
| date_start_from | string | no | Filter entity by date_start (greater or equal) |
| date_start_to | string | no | Filter entity by date_start (less or equal) |
| date_end_from | string | no | Filter entity by date_end (greater or equal) |
| date_end_to | string | no | Filter entity by date_end (less or equal) |
| avail | boolean | no | Filter coupons by avail status |
| lang_id | string | no | Language id |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |

### Remove store from API2Cart
`POST https://www.apizie.tech/v1/ecommerce:api2cart/cart-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| delete_bridge | boolean | no | Identifies if there is a necessity to delete bridge |

### Create new gift card
`POST https://www.apizie.tech/v1/ecommerce:api2cart/cart-giftcard-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| amount | number | yes | Defines the gift card amount value. |
| code | string | no | Gift card code |
| owner_email | string | no | Gift card owner email |
| recipient_email | string | no | Gift card recipient email |

### Get gift cards count.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/cart-giftcard-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| store_id | string | no | Store Id |

### Get gift cards list.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/cart-giftcard-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page_cursor | string | no | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) |
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| store_id | string | no | Store Id |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |

### Get cart information
`GET https://www.apizie.tech/v1/ecommerce:api2cart/cart-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| store_id | string | no | Store Id |

### Get entity meta data
`GET https://www.apizie.tech/v1/ecommerce:api2cart/cart-meta-data-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| entity_id | string | yes | Entity Id |
| entity | string | no | Entity |
| store_id | string | no | Store Id |
| lang_id | string | no | Language id |
| key | string | no | Key |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| page_cursor | string | no | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |

### Set meta data for a specific entity
`POST https://www.apizie.tech/v1/ecommerce:api2cart/cart-meta-data-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| entity_id | string | yes | Entity Id |
| entity | string | no | Entity |
| store_id | string | no | Store Id |
| lang_id | string | no | Language id |
| key | string | yes | Key |
| value | string | yes | Value |
| namespace | string | yes | Metafield namespace |

### Unset meta data for a specific entity
`POST https://www.apizie.tech/v1/ecommerce:api2cart/cart-meta-data-unset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| entity_id | string | yes | Entity Id |
| entity | string | no | Entity |
| store_id | string | no | Store Id |
| key | string | yes | Key |
| id | string | yes | Entity id |

### Get list of cart methods
`GET https://www.apizie.tech/v1/ecommerce:api2cart/cart-methods` (byok)

### Get list of installed plugins
`GET https://www.apizie.tech/v1/ecommerce:api2cart/cart-plugin-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| store_key | string | no | Set this parameter if bridge is already uploaded to store |
| store_id | string | no | Store Id |
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |

### Add new script to the storefront
`POST https://www.apizie.tech/v1/ecommerce:api2cart/cart-script-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | no | The user-friendly script name |
| description | string | no | The user-friendly description |
| html | string | no | An html string containing exactly one `script` tag. |
| src | string | no | The URL of the remote script |
| load_method | string | no | The load method to use for the script |
| scope | string | no | The page or pages on the online store where the script should be included |
| store_id | string | no | Store Id |

### Remove script from the storefront
`POST https://www.apizie.tech/v1/ecommerce:api2cart/cart-script-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Entity id |
| store_id | string | no | Store Id |

### Get scripts installed to the storefront
`GET https://www.apizie.tech/v1/ecommerce:api2cart/cart-script-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page_cursor | string | no | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) |
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| created_from | string | no | Retrieve entities from their creation date |
| created_to | string | no | Retrieve entities to their creation date |
| modified_from | string | no | Retrieve entities from their modification date |
| modified_to | string | no | Retrieve entities to their modification date |
| script_ids | string | no | Retrieves only scripts with specific ids |
| store_id | string | no | Store Id |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |

### Get list of shipping zones
`GET https://www.apizie.tech/v1/ecommerce:api2cart/cart-shipping-zones-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| store_id | string | no | Store Id |
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |

### Check store availability, bridge connection for the downloadable carts, identify DB prefix, validate API…
`GET https://www.apizie.tech/v1/ecommerce:api2cart/cart-validate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| validate_version | boolean | no | Specify if api2cart should validate cart version |

### Add new category in store
`POST https://www.apizie.tech/v1/ecommerce:api2cart/category-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Defines category's name that has to be added |
| parent_id | string | no | Adds categories specified by parent id |
| stores_ids | string | no | Create category in the stores that is specified by comma-separated stores' id |
| store_id | string | no | Store Id |
| lang_id | string | no | Language id |
| avail | boolean | no | Defines category's visibility status |
| sort_order | integer | no | Sort number in the list |
| created_time | string | no | Entity's date creation |
| modified_time | string | no | Entity's date modification |
| description | string | no | Defines category's description |
| meta_title | string | no | Defines unique meta title for each entity |
| meta_description | string | no | Defines unique meta description of a entity |
| meta_keywords | string | no | Defines unique meta keywords for each entity |
| seo_url | string | no | Defines unique category's URL for SEO |

### Assign category to product
`POST https://www.apizie.tech/v1/ecommerce:api2cart/category-assign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| product_id | string | yes | Defines category assign to the product, specified by product id |
| category_id | string | yes | Defines category assign, specified by category id |
| store_id | string | no | Store Id |

### Count categories in store.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/category-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent_id | string | no | Counts categories specified by parent id |
| store_id | string | no | Counts category specified by store id |
| lang_id | string | no | Counts category specified by language id |
| created_from | string | no | Retrieve entities from their creation date |
| created_to | string | no | Retrieve entities to their creation date |
| modified_from | string | no | Retrieve entities from their modification date |
| modified_to | string | no | Retrieve entities to their modification date |
| avail | boolean | no | Defines category's visibility status |

### Delete category in store
`POST https://www.apizie.tech/v1/ecommerce:api2cart/category-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Defines category removal, specified by category id |

### Search category in store. "Laptop" is specified here by default.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/category-find` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| find_value | string | yes | Entity search that is specified by some value |
| find_where | string | no | Entity search that is specified by the comma-separated unique fields |
| find_params | string | no | Entity search that is specified by comma-separated parameters |
| store_id | string | no | Store Id |
| lang_id | string | no | Language id |

### Add image to category
`POST https://www.apizie.tech/v1/ecommerce:api2cart/category-image-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category_id | string | yes | Defines category id where the image should be added |
| image_name | string | yes | Defines image's name |
| url | string | yes | Defines URL of the image that has to be added |
| label | string | no | Defines alternative text that has to be attached to the picture |
| mime | string | no | Mime type of image http://en.wikipedia.org/wiki/Internet_media_type. |
| type | string | yes | Defines image's types that are specified by comma-separated list |
| position | integer | no | Defines image’s position in the list |
| store_id | string | no | Store Id |

### Delete image
`POST https://www.apizie.tech/v1/ecommerce:api2cart/category-image-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category_id | string | yes | Defines category id where the image should be deleted |
| image_id | string | yes | Define image id |
| store_id | string | no | Store Id |

### Get category info about category ID*** or specify other category ID.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/category-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Retrieves category's info specified by category id |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| store_id | string | no | Retrieves category info specified by store id |
| lang_id | string | no | Retrieves category info specified by language id |

### Get list of categories from store.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/category-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| page_cursor | string | no | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) |
| parent_id | string | no | Retrieves categories specified by parent id |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| store_id | string | no | Retrieves categories specified by store id |
| lang_id | string | no | Retrieves categorys specified by language id |
| created_from | string | no | Retrieve entities from their creation date |
| created_to | string | no | Retrieve entities to their creation date |
| modified_from | string | no | Retrieve entities from their modification date |
| modified_to | string | no | Retrieve entities to their modification date |
| avail | boolean | no | Defines category's visibility status |

### Unassign category to product
`POST https://www.apizie.tech/v1/ecommerce:api2cart/category-unassign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category_id | string | yes | Defines category unassign, specified by category id |
| product_id | string | yes | Defines category unassign to the product, specified by product id |
| store_id | string | no | Store Id |

### Update category in store
`POST https://www.apizie.tech/v1/ecommerce:api2cart/category-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Defines category update specified by category id |
| name | string | no | Defines new category’s name |
| parent_id | string | no | Defines new parent category id |
| stores_ids | string | no | Update category in the stores that is specified by comma-separated stores' id |
| avail | boolean | no | Defines category's visibility status |
| sort_order | integer | no | Sort number in the list |
| modified_time | string | no | Entity's date modification |
| description | string | no | Defines new category's description |
| meta_title | string | no | Defines unique meta title for each entity |
| meta_description | string | no | Defines unique meta description of a entity |
| meta_keywords | string | no | Defines unique meta keywords for each entity |
| seo_url | string | no | Defines unique category's URL for SEO |
| lang_id | string | no | Language id |
| store_id | string | no | Store Id |

### Add customer into store.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/customer-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get attributes for specific customer
`GET https://www.apizie.tech/v1/ecommerce:api2cart/customer-attribute-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| page_cursor | string | no | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) |
| customer_id | string | yes | Retrieves orders specified by customer id |
| store_id | string | no | Store Id |
| lang_id | string | no | Language id |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |

### Get number of customers from store.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/customer-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| group_id | string | no | Customer group_id |
| created_from | string | no | Retrieve entities from their creation date |
| created_to | string | no | Retrieve entities to their creation date |
| modified_from | string | no | Retrieve entities from their modification date |
| modified_to | string | no | Retrieve entities to their modification date |
| store_id | string | no | Counts customer specified by store id |
| customer_list_id | string | no | The numeric ID of the customer list in Demandware. |
| avail | boolean | no | Defines category's visibility status |

### Find customers in store.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/customer-find` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| find_value | string | yes | Entity search that is specified by some value |
| find_where | string | no | Entity search that is specified by the comma-separated unique fields |
| find_params | string | no | Entity search that is specified by comma-separated parameters |
| store_id | string | no | Store Id |

### Create customer group.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/customer-group-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Customer group name |
| store_id | string | no | Store Id |
| stores_ids | string | no | Assign customer group to the stores that is specified by comma-separated stores' id |

### Get list of customers groups.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/customer-group-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page_cursor | string | no | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) |
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| store_id | string | no | Store Id |
| lang_id | string | no | Language id |
| group_ids | string | no | Groups that will be assigned to a customer |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |

### Get customers' details from store.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/customer-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Retrieves customer's info specified by customer id |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| store_id | string | no | Retrieves customer info specified by store id |

### Get list of customers from store.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/customer-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page_cursor | string | no | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) |
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| created_from | string | no | Retrieve entities from their creation date |
| created_to | string | no | Retrieve entities to their creation date |
| modified_from | string | no | Retrieve entities from their modification date |
| modified_to | string | no | Retrieve entities to their modification date |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| group_id | string | no | Customer group_id |
| store_id | string | no | Retrieves customers specified by store id |
| customer_list_id | string | no | The numeric ID of the customer list in Demandware. |
| avail | boolean | no | Defines category's visibility status |

### Update information of customer in store.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/customer-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a Wish List of customer from the store.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/customer-wishlist-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | yes | Retrieves orders specified by customer id |
| id | string | no | Entity id |
| store_id | string | no | Store Id |
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| page_cursor | string | no | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |

### Get list of orders that were left by customers before completing the order.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/order-abandoned-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | no | Retrieves orders specified by customer id |
| customer_email | string | no | Retrieves orders specified by customer email |
| created_to | string | no | Retrieve entities to their creation date |
| created_from | string | no | Retrieve entities from their creation date |
| modified_to | string | no | Retrieve entities to their modification date |
| modified_from | string | no | Retrieve entities from their modification date |
| skip_empty_email | boolean | no | Filter empty emails |
| store_id | string | no | Store Id |
| page_cursor | string | no | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| start | integer | no | This parameter sets the number from which you want to get entities |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |

### Add a new order to the cart.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/order-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Count orders in store
`GET https://www.apizie.tech/v1/ecommerce:api2cart/order-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | no | Counts orders quantity specified by customer id |
| customer_email | string | no | Counts orders quantity specified by customer email |
| order_status | string | no | Counts orders quantity specified by order status |
| order_status_ids | array | no | Retrieves orders specified by order statuses |
| created_to | string | no | Retrieve entities to their creation date |
| created_from | string | no | Retrieve entities from their creation date |
| modified_to | string | no | Retrieve entities to their modification date |
| modified_from | string | no | Retrieve entities from their modification date |
| store_id | string | no | Counts orders quantity specified by store id |
| ids | string | no | Counts orders specified by ids |
| order_ids | string | no | Counts orders specified by order ids |
| ebay_order_status | string | no | Counts orders quantity specified by order status |
| financial_status | string | no | Counts orders quantity specified by financial status |
| fulfillment_status | string | no | Create order with fulfillment status |
| shipping_method | string | no | Retrieve entities according to shipping method |
| delivery_method | string | no | Retrieves order with delivery method |
| ship_node_type | string | no | Retrieves order with ship node type |

### Retrieve list of financial statuses
`GET https://www.apizie.tech/v1/ecommerce:api2cart/order-financial-status-list` (byok)

### Retrieve list of fulfillment statuses
`GET https://www.apizie.tech/v1/ecommerce:api2cart/order-fulfillment-status-list` (byok)

### Info about a specific order by ID
`GET https://www.apizie.tech/v1/ecommerce:api2cart/order-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| order_id | string | no | Retrieves order’s info specified by order id |
| id | string | no | Retrieves order info specified by id |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| store_id | string | no | Defines store id where the order should be found |
| enable_cache | boolean | no | If the value is 'true' and order exist in our cache, we will return order.info response from cache |

### Get list of orders from store.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/order-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | no | Retrieves orders specified by customer id |
| customer_email | string | no | Retrieves orders specified by customer email |
| phone | string | no | Filter orders by customer's phone number |
| order_status | string | no | Retrieves orders specified by order status |
| order_status_ids | array | no | Retrieves orders specified by order statuses |
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| page_cursor | string | no | Used to retrieve orders via cursor-based pagination (it can't be used with any other filtering parameter) |
| sort_by | string | no | Set field to sort by |
| sort_direction | string | no | Set sorting direction |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| created_to | string | no | Retrieve entities to their creation date |
| created_from | string | no | Retrieve entities from their creation date |
| modified_to | string | no | Retrieve entities to their modification date |
| modified_from | string | no | Retrieve entities from their modification date |
| store_id | string | no | Store Id |
| ids | string | no | Retrieves orders specified by ids |
| order_ids | string | no | Retrieves orders specified by order ids |
| ebay_order_status | string | no | Retrieves orders specified by order status |
| basket_id | string | no | Retrieves order’s info specified by basket id. |
| financial_status | string | no | Retrieves orders specified by financial status |
| fulfillment_status | string | no | Create order with fulfillment status |
| shipping_method | string | no | Retrieve entities according to shipping method |
| skip_order_ids | string | no | Skipped orders by ids |
| since_id | integer | no | Retrieve entities starting from the specified id. |
| is_deleted | boolean | no | Filter deleted orders |
| shipping_country_iso3 | string | no | Retrieve entities according to shipping country |
| enable_cache | boolean | no | 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… |
| delivery_method | string | no | Retrieves order with delivery method |
| ship_node_type | string | no | Retrieves order with ship node type |
| currency_id | string | no | Currency Id |

### Retrieve list of order preestimated shipping methods
`POST https://www.apizie.tech/v1/ecommerce:api2cart/order-preestimate-shipping-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Add a refund to the order.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/order-refund-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Add a shipment to the order.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/order-shipment-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Delete order's shipment.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/order-shipment-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| shipment_id | string | yes | Shipment id indicates the number of delivery |
| order_id | string | yes | Defines the order for which the shipment will be deleted |
| store_id | string | no | Store Id |

### Get information of shipment.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/order-shipment-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Entity id |
| order_id | string | yes | Defines the order id |
| start | integer | no | This parameter sets the number from which you want to get entities |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| store_id | string | no | Store Id |

### Get list of shipments by orders.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/order-shipment-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| order_id | string | yes | Retrieves shipments specified by order id |
| page_cursor | string | no | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) |
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| created_from | string | no | Retrieve entities from their creation date |
| created_to | string | no | Retrieve entities to their creation date |
| modified_from | string | no | Retrieve entities from their modification date |
| modified_to | string | no | Retrieve entities to their modification date |
| store_id | string | no | Store Id |

### Add order shipment's tracking info.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/order-shipment-tracking-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Update order's shipment information.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/order-shipment-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve list of statuses
`GET https://www.apizie.tech/v1/ecommerce:api2cart/order-status-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| store_id | string | no | Store Id |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |

### Retrieve list of order transaction
`GET https://www.apizie.tech/v1/ecommerce:api2cart/order-transaction-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| order_ids | string | yes | Retrieves order transactions specified by order ids |
| store_id | string | no | Store Id |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| page_cursor | string | no | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) |

### Update existing order.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/order-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| order_id | string | yes | Defines the orders specified by order id |
| store_id | string | no | Defines store id where the order should be found |
| order_status | string | no | Defines new order's status |
| comment | string | no | Specifies order comment |
| admin_comment | string | no | Specifies admin's order comment |
| admin_private_comment | string | no | Specifies private admin's order comment |
| date_modified | string | no | Specifies order's modification date |
| date_finished | string | no | Specifies order's finished date |
| financial_status | string | no | Update order financial status to specified |
| fulfillment_status | string | no | Create order with fulfillment status |
| order_payment_method | string | no | Defines order payment method. Setting order_payment_method on Shopify will also change financial_status field value to 'paid' |
| send_notifications | boolean | no | Send notifications to customer after order was created |

### Add new product to store.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/product-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get list of attributes and values.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/product-attribute-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| product_id | string | yes | Retrieves attributes specified by product id |
| attribute_id | string | no | Retrieves info for specified attribute_id |
| variant_id | string | no | Defines product's variants specified by variant id |
| page_cursor | string | no | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) |
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| attribute_group_id | string | no | Filter by attribute_group_id |
| set_name | string | no | Retrieves attributes specified by set_name in Magento |
| lang_id | string | no | Retrieves attributes specified by language id |
| store_id | string | no | Retrieves attributes specified by store id |
| sort_by | string | no | Set field to sort by |
| sort_direction | string | no | Set sorting direction |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |

### Set attribute value to product.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/product-attribute-value-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| product_id | string | yes | Defines product id where the attribute should be added |
| attribute_id | string | no | Filter by attribute_id |
| attribute_group_id | string | no | Filter by attribute_group_id |
| attribute_name | string | no | Define attribute name |
| value | string | no | Define attribute value |
| value_id | integer | no | Define attribute value id |
| lang_id | string | no | Language id |
| store_id | string | no | Store Id |

### Removes attribute value for a product.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/product-attribute-value-unset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| product_id | string | yes | Product id |
| attribute_id | string | yes | Attribute Id |
| store_id | string | no | Store Id |
| include_default | boolean | no | Boolean, whether or not to unset default value of the attribute, if applicable |
| reindex | boolean | no | Is reindex required |
| clear_cache | boolean | no | Is cache clear required |

### Get list of brands from your store.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/product-brand-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| brand_ids | string | no | Retrieves brands specified by brand ids |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| store_id | string | no | Store Id |
| lang_id | string | no | Language id |
| created_from | string | no | Retrieve entities from their creation date |
| created_to | string | no | Retrieve entities to their creation date |
| modified_from | string | no | Retrieve entities from their modification date |
| modified_to | string | no | Retrieve entities to their modification date |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |

### Search product child item (bundled item or configurable product variant) in store catalog.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/product-child-item-find` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| find_value | string | yes | Entity search that is specified by some value |
| find_where | string | no | Entity search that is specified by the comma-separated unique fields |
| find_params | string | no | Entity search that is specified by comma-separated parameters |
| store_id | string | no | Store Id |

### Get child for specific product.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/product-child-item-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| product_id | string | yes | Filter by parent product id |
| id | string | yes | Entity id |
| store_id | string | no | Store Id |
| lang_id | string | no | Language id |
| currency_id | string | no | Currency Id |

### Get child items list of specific product(s).
`GET https://www.apizie.tech/v1/ecommerce:api2cart/product-child-item-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page_cursor | string | no | Used to retrieve products child items via cursor-based pagination (it can't be used with any other filtering parameter) |
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| created_from | string | no | Retrieve entities from their creation date |
| created_to | string | no | Retrieve entities to their creation date |
| modified_from | string | no | Retrieve entities from their modification date |
| modified_to | string | no | Retrieve entities to their modification date |
| product_id | string | no | Filter by parent product id |
| product_ids | string | no | Filter by parent product ids |
| store_id | string | no | Store Id |
| lang_id | string | no | Language id |
| currency_id | string | no | Currency Id |
| avail_sale | boolean | no | Specifies the set of available/not available products for sale |
| report_request_id | string | no | Report request id |
| disable_report_cache | boolean | no | Disable report cache for current request |

### Count products in store.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/product-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category_id | string | no | Counts products specified by category id |
| created_from | string | no | Retrieve entities from their creation date |
| created_to | string | no | Retrieve entities to their creation date |
| modified_from | string | no | Retrieve entities from their modification date |
| modified_to | string | no | Retrieve entities to their modification date |
| avail_view | boolean | no | Specifies the set of visible/invisible products |
| avail_sale | boolean | no | Specifies the set of available/not available products for sale |
| store_id | string | no | Counts products specified by store id |
| lang_id | string | no | Counts products specified by language id |
| product_ids | string | no | Counts products specified by product ids |
| report_request_id | string | no | Report request id |
| disable_report_cache | boolean | no | Disable report cache for current request |
| brand_name | string | no | Retrieves brands specified by brand name |
| product_attributes | array | no | Defines product attributes |
| status | string | no | Defines product's status |
| type | string | no | Defines products's type |

### Add currency and/or set default in store
`POST https://www.apizie.tech/v1/ecommerce:api2cart/product-currency-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| iso3 | string | yes | Specifies standardized currency code |
| rate | number | yes | Defines the numerical identifier against to the major currency |
| name | string | no | Defines currency's name |
| avail | boolean | no | Specifies whether the currency is available |
| symbol_left | string | no | Defines the symbol that is located before the currency |
| symbol_right | string | no | Defines the symbol that is located after the currency |
| default | boolean | no | Specifies currency's default meaning |

### Get list of currencies
`GET https://www.apizie.tech/v1/ecommerce:api2cart/product-currency-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| page_cursor | string | no | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| default | boolean | no | Specifies the set of default/not default currencies |
| avail | boolean | no | Specifies the set of available/not available currencies |

### Product delete
`POST https://www.apizie.tech/v1/ecommerce:api2cart/product-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Product id that will be removed |

### Retrieve all available fields for product item in store.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/product-fields` (byok)

### Search product in store catalog. "Apple" is specified here by default.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/product-find` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| find_value | string | yes | Entity search that is specified by some value |
| find_where | string | no | Entity search that is specified by the comma-separated unique fields |
| find_params | string | no | Entity search that is specified by comma-separated parameters |
| find_what | string | no | Parameter's value specifies the entity that has to be found |
| lang_id | string | no | Search products specified by language id |
| store_id | string | no | Store Id |

### Add image to product
`POST https://www.apizie.tech/v1/ecommerce:api2cart/product-image-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Delete image
`POST https://www.apizie.tech/v1/ecommerce:api2cart/product-image-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| product_id | string | yes | Defines product id where the image should be deleted |
| id | string | yes | Entity id |
| store_id | string | no | Store Id |

### Update details of image
`POST https://www.apizie.tech/v1/ecommerce:api2cart/product-image-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| product_id | string | yes | Defines product id where the image should be updated |
| variant_ids | string | no | Defines product's variants ids |
| image_name | string | no | Defines image's name |
| type | string | no | Defines image's types that are specified by comma-separated list |
| label | string | no | Defines alternative text that has to be attached to the picture |
| position | integer | no | Defines image’s position in the list |
| id | string | yes | Defines image update specified by image id |
| store_id | string | no | Store Id |
| lang_id | string | no | Language id |
| hidden | boolean | no | Define is hide image |

### Get product info about product ID *** or specify other product ID.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/product-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Retrieves product's info specified by product id |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| store_id | string | no | Retrieves product info specified by store id |
| lang_id | string | no | Retrieves product info specified by language id |
| currency_id | string | no | Currency Id |
| report_request_id | string | no | Report request id |
| disable_report_cache | boolean | no | Disable report cache for current request |

### Get list of products from your store. Returns 10 products by default.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/product-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page_cursor | string | no | Used to retrieve products via cursor-based pagination (it can't be used with any other filtering parameter) |
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| category_id | string | no | Retrieves products specified by category id |
| created_from | string | no | Retrieve entities from their creation date |
| created_to | string | no | Retrieve entities to their creation date |
| modified_from | string | no | Retrieve entities from their modification date |
| modified_to | string | no | Retrieve entities to their modification date |
| avail_view | boolean | no | Specifies the set of visible/invisible products |
| avail_sale | boolean | no | Specifies the set of available/not available products for sale |
| store_id | string | no | Retrieves products specified by store id |
| lang_id | string | no | Retrieves products specified by language id |
| currency_id | string | no | Currency Id |
| product_ids | string | no | Retrieves products specified by product ids |
| since_id | integer | no | Retrieve entities starting from the specified id. |
| report_request_id | string | no | Report request id |
| disable_report_cache | boolean | no | Disable report cache for current request |
| sort_by | string | no | Set field to sort by |
| sort_direction | string | no | Set sorting direction |
| sku | string | no | Filter by product's sku |
| disable_cache | boolean | no | Disable cache for current request |
| brand_name | string | no | Retrieves brands specified by brand name |
| product_attributes | array | no | Defines product attributes |
| status | string | no | Defines product's status |
| type | string | no | Defines products's type |

### Add manufacturer to store and assign to product
`POST https://www.apizie.tech/v1/ecommerce:api2cart/product-manufacturer-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| product_id | string | yes | Defines products specified by product id |
| manufacturer | string | yes | Defines product’s manufacturer's name |

### Add product option from store.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/product-option-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Defines option's name |
| type | string | yes | Defines option's type that has to be added |
| product_id | string | no | Defines product id where the option should be added |
| default_option_value | string | no | Defines default option value that has to be added |
| option_values | string | no | Defines option values that has to be added |
| description | string | no | Defines option's description |
| avail | boolean | no | Defines whether the option is available |
| sort_order | integer | no | Sort number in the list |
| required | boolean | no | Defines if the option is required |
| clear_cache | boolean | no | Is cache clear required |

### Assign option from product.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/product-option-assign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| product_id | string | yes | Defines product id where the option should be assigned |
| option_id | string | yes | Defines option id which has to be assigned |
| required | boolean | no | Defines if the option is required |
| sort_order | integer | no | Sort number in the list |
| option_values | string | no | Defines option values that has to be assigned |
| clear_cache | boolean | no | Is cache clear required |

### Get list of options.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/product-option-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| start | integer | no | This parameter sets the number from which you want to get entities |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| product_id | string | no | Retrieves products' options specified by product id |
| lang_id | string | no | Language id |
| store_id | string | no | Store Id |

### Add product option item from option.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/product-option-value-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| product_id | string | yes | Defines product id where the option value should be added |
| option_id | string | yes | Defines option id where the value has to be added |
| option_value | string | yes | Defines option value that has to be added |
| sort_order | integer | no | Sort number in the list |
| clear_cache | boolean | no | Is cache clear required |

### Assign product option item from product.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/product-option-value-assign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| product_option_id | integer | yes | Defines product's option id where the value has to be assigned |
| option_value_id | integer | yes | Defines value id that has to be assigned |
| clear_cache | boolean | no | Is cache clear required |

### Update product option item from option.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/product-option-value-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| product_id | string | yes | Defines product id where the option value should be updated |
| option_id | string | yes | Defines option id where the value has to be updated |
| option_value_id | integer | yes | Defines value id that has to be assigned |
| option_value | string | yes | Defines option value that has to be added |
| price | number | no | Defines new product option price |
| quantity | number | no | Defines new products' options quantity |
| clear_cache | boolean | no | Is cache clear required |

### Add some prices to the product.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/product-price-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Delete some prices of the product
`POST https://www.apizie.tech/v1/ecommerce:api2cart/product-price-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| product_id | string | yes | Defines the product where the price has to be deleted |
| group_prices | string | no | Defines product's group prices |

### Update some prices of the product.
`POST https://www.apizie.tech/v1/ecommerce:api2cart/product-price-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get reviews of a specific product.
`GET https://www.apizie.tech/v1/ecommerce:api2cart/product-review-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| start | integer | no | This parameter sets the number from which you want to get entities |
| page_cursor | string | no | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) |
| count | integer | no | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 |
| product_id | string | yes | Product id |
| ids | string | no | Retrieves reviews specified by ids |
| store_id | string | no | Store Id |
| status | string | no | Defines status |
| params | string | no | Set this parameter in order to choose which entity fields you want to retrieve |
| exclude | string | no | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all |
| response_fields | string | no | Set this parameter in order to choose which entity fields you want to retrieve |

…and 19 more. See the OpenAPI spec.

## Example
```
curl "https://www.apizie.tech/v1/ecommerce:api2cart/account-cart-add" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Swagger API2Cart API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/ecommerce:api2cart/account-cart-add with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Swagger API2Cart API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Swagger API2Cart itself also needs your own key from api2cart.com.

### Can AI agents use the Swagger API2Cart API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key ecommerce:api2cart.

### What is the status of the Swagger API2Cart API?
Needs your own provider key (bring your own key)