@datafire/api2cart v4.0.0

@datafire/api2cart

Client library for Swagger API2Cart

Installation and Usage

npm install --save @datafire/api2cart

let api2cart = require('@datafire/api2cart').create({
  api_key: "",
  store_key: ""
});

.then(data => {
  console.log(data);
});

Description

API2Cart

Actions

AccountCartAdd

Add store to the account

api2cart.AccountCartAdd({
  "body": {
    "cart_id": "",
    "store_url": ""
  }
}, context)

Input

• input object
  • body required AccountCartAdd

Output

• output object
  • result object
    • store_key string
  • return_code integer
  • return_message string

AccountCartList

Get list of carts.

api2cart.AccountCartList({}, context)

Input

• input object
  • params string: Set this parameter in order to choose which entity fields you want to retrieve
  • exclude string: 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: Retrieve entities from their creation date
  • request_to_date string: Retrieve entities to their creation date
  • store_url string: A web address of a store
  • store_key string: Find store by store key

Output

• output object
  • result object
    • carts array
      • items object
        • cart_id string
        • id string
        • store_key string
        • total_calls string
        • url string
    • carts_count integer
  • return_code integer
  • return_message string

AccountConfigUpdate

Update configs in the API2Cart database.

api2cart.AccountConfigUpdate({}, context)

Input

• input object
  • new_store_key string: Update store key
  • bridge_url string: This parameter allows to set up store with custom bridge url (also you must use store_root parameter if a bridge folder is not in the root folder of the store)
  • store_root string: Absolute path to the store root directory (used with "bridge_url" parameter)
  • db_tables_prefix string: This parameter is deprecated for this method. Please, use this parameter in method account.config.update
  • 3dcartapi_api_key string: 3DCart API Key
  • amazon_access_token string: MWS Auth Token. Access token authorizing the app to access resources on behalf of a user
  • amazon_seller_id string: Amazon Seller ID
  • amazon_marketplaces_ids string: Amazon Marketplace IDs comma separated string
  • amazon_secret_key string: Amazon Secret Key
  • amazon_access_key_id string: Amazon Secret Key Id
  • aspdotnetstorefront_api_user string: It's a AspDotNetStorefront account for which API is available
  • aspdotnetstorefront_api_pass string: AspDotNetStorefront API Password
  • bigcommerceapi_admin_account string: It's a BigCommerce account for which API is enabled
  • bigcommerceapi_api_path string: BigCommerce API URL
  • bigcommerceapi_api_key string: Bigcommerce API Key
  • bigcommerceapi_client_id string: Client ID of the requesting app
  • bigcommerceapi_access_token string: Access token authorizing the app to access resources on behalf of a user
  • bigcommerceapi_context string: API Path section unique to the store
  • demandware_client_id string: Demandware client id
  • demandware_api_password string: Demandware api password
  • demandware_user_name string: Demandware user name
  • demandware_user_password string: Demandware user password
  • demandware_env_type string: Demandware environment
  • ebay_client_id string: Application ID (AppID).
  • ebay_client_secret string: Shared Secret from eBay application
  • ebay_runame string: The RuName value that eBay assigns to your application.
  • ebay_access_token string: Used to authenticate API requests.
  • ebay_refresh_token string: Used to renew the access token.
  • ebay_environment string: eBay environment
  • ebay_site_id integer: eBay global ID
  • ecwid_acess_token string: Access token authorizing the app to access resources on behalf of a user
  • ecwid_store_id string: Store Id
  • etsy_keystring string: Etsy keystring
  • etsy_shared_secret string: Etsy shared secret
  • etsy_access_token string: Access token authorizing the app to access resources on behalf of a user
  • etsy_token_secret string: Secret token authorizing the app to access resources on behalf of a user
  • neto_api_key string: Neto API Key
  • neto_api_username string: Neto User Name
  • shopify_api_key string: Shopify API Key
  • shopify_api_password string: Shopify API Password
  • shopify_shared_secret string: Shared secret
  • shopify_access_token string: Access token authorizing the app to access resources on behalf of a user
  • shopware_api_key string: Shopware api key
  • volusion_login string: It's a Volusion account for which API is enabled
  • volusion_password string: Volusion API Password
  • walmart_client_id string: Walmart client ID
  • walmart_client_secret string: Walmart client secret
  • squarespace_api_key string: Squarespace API Key
  • hybris_client_id string: Omni Commerce Connector Client ID
  • hybris_client_secret string: Omni Commerce Connector Client Secret
  • hybris_username string: User Name
  • hybris_password string: User password
  • lightspeed_api_key string: LightSpeed api key
  • lightspeed_api_secret string: LightSpeed api secret

Output

• output object
  • result object
    • updated_items integer
  • return_code integer
  • return_message string

AccountFailedWebhooks

List webhooks that was not delivered to the callback.

api2cart.AccountFailedWebhooks({}, context)

Input

• input object
  • count integer: This parameter sets the entity amount that has to be retrieved. Max allowed count=250
  • start integer: This parameter sets the number from which you want to get entities
  • ids string: List of сomma-separated webhook ids

Output

• output object
  • result object
    • all_failed_webhook string
    • webhook array
      • items object
        • entity_id string
        • time A2CDateTime
        • webhook_id integer
  • return_code integer
  • return_message string

AccountSupportedPlatforms

Get list of supported platforms

api2cart.AccountSupportedPlatforms(null, context)

Input

This action has no parameters

Output

• output object
  • result object
    • supported_platforms array
      • items object
        • cart_id string
        • cart_name string
        • cart_versions string
        • params object
          • additional array
          • required array
  • return_code integer
  • return_message string

AttributeAdd

Add new attribute

api2cart.AttributeAdd({
  "type": "",
  "name": ""
}, context)

Input

• input object
  • type required string (values: text, select, textarea, date, price, multiselect, boolean): Defines attribute's type
  • code string: Entity code
  • name required string: Defines attributes's name
  • store_id string: Store Id
  • lang_id string: Language id
  • visible boolean: Set visibility status
  • required boolean: Defines if the option is required
  • position integer: Attribute`s position
  • attribute_group_id string: Filter by attribute_group_id
  • is_global string: Attribute saving scope
  • is_searchable boolean: Use attribute in Quick Search
  • is_filterable string: Use In Layered Navigation
  • is_comparable boolean: Comparable on Front-end
  • is_html_allowed_on_front boolean: Allow HTML Tags on Frontend
  • is_filterable_in_search boolean: Use In Search Results Layered Navigation
  • is_configurable boolean: Use To Create Configurable Product
  • is_visible_in_advanced_search boolean: Use in Advanced Search
  • is_used_for_promo_rules boolean: Use for Promo Rule Conditions
  • used_in_product_listing boolean: Used in Product Listing
  • used_for_sort_by boolean: Used for Sorting in Product Listing
  • apply_to string: Types of products which can have this attribute

Output

• output object
  • result object
    • id string
  • return_code integer
  • return_message string

AttributeAssignGroup

Assign attribute to the group

api2cart.AttributeAssignGroup({
  "id": "",
  "group_id": ""
}, context)

Input

• input object
  • id required string: Entity id
  • group_id required string: Attribute group_id
  • attribute_set_id string: Attribute set id

Output

• output object
  • result object
    • assigned string
  • return_code integer
  • return_message string

AttributeAssignSet

Assign attribute to the attribute set

api2cart.AttributeAssignSet({
  "id": "",
  "attribute_set_id": ""
}, context)

Input

• input object
  • id required string: Entity id
  • group_id string: Attribute group_id
  • attribute_set_id required string: Attribute set id

Output

• output object
  • result object
    • assigned string
  • return_code integer
  • return_message string

AttributeAttributesetList

Get attribute_set list

api2cart.AttributeAttributesetList({}, context)

Input

• input object
  • start integer: This parameter sets the number from which you want to get entities
  • count integer: This parameter sets the entity amount that has to be retrieved. Max allowed count=250
  • params string: Set this parameter in order to choose which entity fields you want to retrieve
  • exclude string: Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter params equal force_all

Output

• output object
  • result array
    • items StoreAttribute_Group
  • return_code integer
  • return_message string

AttributeCount

Get attributes count

api2cart.AttributeCount({}, context)

Input

• input object
  • type string: Defines attribute's type
  • store_id string: Store Id
  • lang_id string: Language id
  • visible boolean: Filter items by visibility status
  • required boolean: Defines if the option is required
  • system boolean: True if attribute is system

Output

• output object
  • result object
    • attributes_count integer
  • return_code integer
  • return_message string

AttributeDelete

Delete attribute from store

api2cart.AttributeDelete({
  "id": ""
}, context)

Input

• input object
  • store_id string: Store Id
  • id required string: Entity id

Output

• output object
  • result object
    • deleted string
  • return_code integer
  • return_message string

AttributeGroupList

Get attribute group list

api2cart.AttributeGroupList({}, context)

Input

• input object
  • start integer: This parameter sets the number from which you want to get entities
  • count integer: This parameter sets the entity amount that has to be retrieved. Max allowed count=250
  • lang_id string: Language id
  • params string: Set this parameter in order to choose which entity fields you want to retrieve
  • exclude string: Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter params equal force_all
  • attribute_set_id string: Attribute set id

Output

• output object
  • result array
    • items StoreAttribute_Group
  • return_code integer
  • return_message string

AttributeInfo

Get attribute info

api2cart.AttributeInfo({
  "id": ""
}, context)

Input

• input object
  • id required string: Entity id
  • store_id string: Store Id
  • lang_id string: Language id
  • params string: Set this parameter in order to choose which entity fields you want to retrieve
  • exclude string: Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter params equal force_all

Output

• output object
  • result StoreAttribute
  • return_code integer
  • return_message string

AttributeList

Get attributes list

api2cart.AttributeList({}, context)

Input

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

Output

• output object
  • result object
    • order array
      • items StoreAttribute
  • return_code integer
  • return_message string

AttributeTypeList

Get list of supported attributes types

api2cart.AttributeTypeList(null, context)

Input

This action has no parameters

Output

• output object
  • result object
    • attribute_type array
      • items string
  • return_code integer
  • return_message string

AttributeUnassignGroup

Unassign attribute from group

api2cart.AttributeUnassignGroup({
  "id": "",
  "group_id": ""
}, context)

Input

• input object
  • id required string: Entity id
  • group_id required string: Customer group_id

Output

• output object
  • result object
    • unassigned string
  • return_code integer
  • return_message string

AttributeUnassignSet

Unassign attribute from attribute set

api2cart.AttributeUnassignSet({
  "id": "",
  "attribute_set_id": ""
}, context)

Input

• input object
  • id required string: Entity id
  • attribute_set_id required string: Attribute set id

Output

• output object
  • result object
    • unassigned string
  • return_code integer
  • return_message string

BasketInfo

Retrieve basket information.

api2cart.BasketInfo({
  "id": ""
}, context)

Input

• input object
  • id required string: Entity id
  • store_id string: Store Id
  • params string: Set this parameter in order to choose which entity fields you want to retrieve
  • exclude string: Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter params equal force_all

Output

• output object
  • result Basket
  • return_code integer
  • return_message string

BasketItemAdd

Add item to basket

api2cart.BasketItemAdd({
  "customer_id": "",
  "product_id": ""
}, context)

Input

• input object
  • customer_id required string: Retrieves orders specified by customer id
  • product_id required string: Defines id of the product which should be added to the basket
  • variant_id string: Defines product's variants specified by variant id
  • quantity number: Defines new items quantity
  • store_id string: Store Id

Output

• output object
  • result object
    • added boolean
  • return_code integer
  • return_message string

BasketLiveShippingServiceCreate

Create live shipping rate service. (Beta)

api2cart.BasketLiveShippingServiceCreate({
  "name": "",
  "callback": ""
}, context)

Input

• input object
  • store_id string: Store Id
  • name required string: Shipping Service Name
  • callback required string: Callback url that returns shipping rates. It should be able to accept POST requests with json data.

Output

• output object
  • result object
    • id integer
  • return_code integer
  • return_message string

BasketLiveShippingServiceDelete

Delete live shipping rate service. (Beta)

api2cart.BasketLiveShippingServiceDelete({
  "id": 0
}, context)

Input

• input object
  • id required integer: Entity id

Output

• output object
  • result object
    • status boolean
  • return_code integer
  • return_message string

BasketLiveShippingServiceList

Retrieve a list of live shipping rate services. (Beta)

api2cart.BasketLiveShippingServiceList({}, context)

Input

• input object
  • store_id string: Store Id
  • start integer: This parameter sets the number from which you want to get entities
  • count integer: This parameter sets the entity amount that has to be retrieved. Max allowed count=250

Output

• output object
  • result object
    • live_shipping_services array
      • items Basket_LiveShippingService
  • return_code integer
  • return_message string

BridgeDelete

Delete bridge from the store.

api2cart.BridgeDelete(null, context)

Input

This action has no parameters

Output

• output object
  • result object
    • deleted boolean
  • return_code integer
  • return_message string

BridgeDownload

Download bridge for store

api2cart.BridgeDownload({}, context)

Input

• input object
  • whitelabel boolean: Identifies if there is a necessity to download whitelabel bridge.

Output

• output file

BridgeUpdate

Update bridge in the store.

api2cart.BridgeUpdate(null, context)

Input

This action has no parameters

Output

• output object
  • result object
    • updated boolean
  • return_code integer
  • return_message string

CartBridge

Get bridge key and store key

api2cart.CartBridge(null, context)

Input

This action has no parameters

Output

• output object
  • result object
    • bridge string
    • store_key string
  • return_code integer
  • return_message string

CartCatalogPriceRulesCount

Get count of cart catalog price rules discounts.

api2cart.CartCatalogPriceRulesCount(null, context)

Input

This action has no parameters

Output

• output object
  • result object
    • catalog_price_rules_count string
  • return_code integer
  • return_message string

CartCatalogPriceRulesList

Get cart catalog price rules discounts.

api2cart.CartCatalogPriceRulesList({}, context)

Input

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

Output

• output Model_Response_Cart_Catalog_PriceRules_List

CartClearCache

Clear cache on store.

api2cart.CartClearCache({
  "cache_type": ""
}, context)

Input

• input object
  • cache_type required string: Defines which cache should be cleared.

Output

• output object
  • result object
    • cache_cleared string
  • return_code integer
  • return_message string

CartConfig

Get list of cart configs

api2cart.CartConfig({}, context)

Input

• input object
  • params string: Set this parameter in order to choose which entity fields you want to retrieve
  • exclude string: Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter params equal force_all

Output

• output object
  • result object
    • db_prefix string
    • store_name string
    • store_url string
  • return_code integer
  • return_message string

CartConfigUpdate

Use this API method to update custom data in client database.

api2cart.CartConfigUpdate({
  "body": {}
}, context)

Input

• input object
  • body required CartConfigUpdate

Output

• output object
  • result object
  • return_code integer
  • return_message string

CartCouponAdd

Create new coupon

api2cart.CartCouponAdd({
  "body": {
    "code": "",
    "action_type": "",
    "action_apply_to": "",
    "action_scope": "",
    "action_amount": 0
  }
}, context)

Input

• input object
  • body required CartCouponAdd

Output

• output object
  • result object
    • coupon_id string
  • return_code integer
  • return_message string

CartCouponConditionAdd

Create new coupon condition

api2cart.CartCouponConditionAdd({
  "coupon_id": "",
  "entity": "",
  "key": "",
  "operator": "",
  "value": ""
}, context)

Input

• input object
  • store_id string: Store Id
  • coupon_id required string: Coupon Id
  • target string: Defines condition operator
  • entity required string (values: order, order_shipping_address, product, customer): Defines condition entity type
  • key required string (values: total, subtotal, shipping_total, total_quantity, total_weight, country, product_id, variant_id, category_id, customer_id, item_price, item_total_price, item_quantity): Defines condition entity attribute key
  • operator required string (values: ==, <, <=, >, >=, ONE_OF): Defines condition operator
  • value required string: Defines condition value, can be comma separated according to the operator.

Output

• output object
  • result object
    • status boolean
  • return_code integer
  • return_message string

CartCouponCount

Get cart coupons count.

api2cart.CartCouponCount({}, context)

Input

• input object
  • store_id string: Store Id
  • date_start_from string: Filter entity by date_start (greater or equal)
  • date_start_to string: Filter entity by date_start (less or equal)
  • date_end_from string: Filter entity by date_end (greater or equal)
  • date_end_to string: Filter entity by date_end (less or equal)
  • avail boolean: Defines category's visibility status

Output

• output object
  • result object
    • coupons_count string
  • return_code integer
  • return_message string

CartCouponDelete

Delete coupon

api2cart.CartCouponDelete({
  "id": ""
}, context)

Input

• input object
  • id required string: Entity id
  • store_id string: Store Id

Output

• output object
  • result object
    • deleted string
  • return_code integer
  • return_message string

CartCouponList

Get cart coupon discounts.

api2cart.CartCouponList({}, context)

Input

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

Output

• output Model_Response_Cart_Coupon_List

CartCreate

Add store to the account

api2cart.CartCreate({
  "cart_id": "",
  "store_url": "",
  "store_id": ""
}, context)

Input

• input object
  • cart_id required string (values: 3DCartApi, AceShop, Amazon, AspDotNetStorefront, BigcommerceApi, Creloaded, Cscart, Cubecart, Demandware, EBay, Ecwid, Etsy, Gambio, Interspire, JooCart, Magento1212, MijoShop, Neto, Opencart14, LightSpeed, Oscmax2, Oscommerce22ms2, Oxid, Pinnacle, Prestashop, SSPremium, Shopify, Squarespace, Shopware, Tomatocart, Ubercart, Virtuemart, Volusion, WPecommerce, Walmart, WebAsyst, Woocommerce, Xcart, Xtcommerce, XtcommerceVeyton, Zencart137): Store’s identifier which you can get from cart_list method
  • store_url required string: A web address of a store that you would like to connect to API2Cart
  • bridge_url string: This parameter allows to set up store with custom bridge url (also you must use store_root parameter if a bridge folder is not in the root folder of the store)
  • store_root string: Absolute path to the store root directory (used with "bridge_url" parameter)
  • store_key string: Set this parameter if bridge is already uploaded to store
  • shared_secret string: Shared secret
  • validate_version boolean: Specify if api2cart should validate cart version
  • verify boolean: Enables or disables cart's verification
  • db_tables_prefix string: This parameter is deprecated for this method. Please, use this parameter in method account.config.update
  • ftp_host string: FTP connection host
  • ftp_user string: FTP User
  • ftp_password string: FTP Password
  • ftp_port integer: FTP Port
  • ftp_store_dir string: FTP Store dir
  • apiKey_3dcart string: 3DCart API Key
  • AdminAccount string: It's a BigCommerce account for which API is enabled
  • ApiPath string: BigCommerce API URL
  • ApiKey string: Bigcommerce API Key
  • client_id string: Client ID of the requesting app
  • accessToken string: Access token authorizing the app to access resources on behalf of a user
  • context string: API Path section unique to the store
  • access_token string: Access token authorizing the app to access resources on behalf of a user
  • apiKey_shopify string: Shopify API Key
  • apiPassword string: Shopify API Password
  • accessToken_shopify string: Access token authorizing the app to access resources on behalf of a user
  • apiKey string: Neto API Key
  • apiUsername string: Neto User Name
  • EncryptedPassword string: Volusion API Password
  • Login string: It's a Volusion account for which API is enabled
  • apiUser_adnsf string: It's a AspDotNetStorefront account for which API is available
  • apiPass string: AspDotNetStorefront API Password
  • accessKey_scelite string: Shopping Cart Elite Access Key
  • apiKey_scelite string: Shopping Cart Elite API Key
  • apiSecretKey_scelite string: Shopping Cart Elite API Secret Key
  • privateKey string: 3DCart Application Private Key
  • appToken string: 3DCart Token from Application
  • etsy_keystring string: Etsy keystring
  • etsy_shared_secret string: Etsy shared secret
  • tokenSecret string: Secret token authorizing the app to access resources on behalf of a user
  • ebay_client_id string: Application ID (AppID).
  • ebay_client_secret string: Shared Secret from eBay application
  • ebay_runame string: The RuName value that eBay assigns to your application.
  • ebay_access_token string: Used to authenticate API requests.
  • ebay_refresh_token string: Used to renew the access token.
  • ebay_environment string: eBay environment
  • ebay_site_id integer: eBay global ID
  • dw_client_id string: Demandware client id
  • dw_api_pass string: Demandware api password
  • demandware_user_name string: Demandware user name
  • demandware_user_password string: Demandware user password
  • store_id required string: Store Id
  • seller_id string: Seller Id
  • amazon_secret_key string: Amazon Secret Key
  • amazon_access_key_id string: Amazon Secret Key Id
  • marketplaces_ids string: Comma separated marketplaces ids
  • environment string
  • hybris_client_id string: Omni Commerce Connector Client ID
  • hybris_client_secret string: Omni Commerce Connector Client Secret
  • hybris_username string: User Name
  • hybris_password string: User password
  • walmart_client_id string: Walmart client ID
  • walmart_client_secret string: Walmart client secret
  • lightspeed_api_key string: LightSpeed api key
  • lightspeed_api_secret string: LightSpeed api secret
  • shopware_api_key string: Shopware api key

Output

• output object
  • result object
    • store_key string
  • return_code integer
  • return_message string

CartDelete

Remove store from API2Cart

api2cart.CartDelete(null, context)

Input

This action has no parameters

Output

• output object
  • result object
    • store string
  • return_code integer
  • return_message string

CartDisconnect

Disconnect with the store and clear store session data.

api2cart.CartDisconnect({}, context)

Input

• input object
  • delete_bridge boolean: Identifies if there is a necessity to delete bridge

Output

• output object
  • result object
    • connection string
  • return_code integer
  • return_message string

CartGiftcardAdd

Create new gift card

api2cart.CartGiftcardAdd({
  "amount": 0
}, context)

Input

• input object
  • amount required number: Defines the gift card amount value.
  • code string: Gift card code
  • owner_email string: Gift card owner email

Output

• output object
  • result object
    • code string
    • id string
  • return_code integer
  • return_message string

CartGiftcardCount

Get gift cards count.

api2cart.CartGiftcardCount({}, context)

Input

• input object
  • store_id string: Store Id

Output

• output object
  • result object
    • gift_cards_count string
  • return_code integer
  • return_message string

CartGiftcardList

Get gift cards list.

api2cart.CartGiftcardList({}, context)

Input

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

Output

• output Model_Response_Cart_GiftCard_List

CartInfo

Get cart information

api2cart.CartInfo({}, context)

Input

• input object
  • params string: Set this parameter in order to choose which entity fields you want to retrieve
  • exclude string: 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: Store Id

Output

• output object
  • result Cart
  • return_code integer
  • return_message string

CartList

Get list of supported carts

api2cart.CartList(null, context)

Input

This action has no parameters

Output

• output object
  • result object
    • supported_carts array
      • items object
        • cart_id string
        • cart_name string
        • cart_versions string
        • params array
          • items string
  • return_code integer
  • return_message string

CartMetaDataList

Get entity meta data

api2cart.CartMetaDataList({
  "entity_id": ""
}, context)

Input

• input object
  • entity_id required string: Entity Id
  • entity string: Entity
  • store_id string: Store Id
  • key string: Key
  • count integer: This parameter sets the entity amount that has to be retrieved. Max allowed count=250
  • page_cursor string: Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)
  • params string: Set this parameter in order to choose which entity fields you want to retrieve
  • exclude string: Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter params equal force_all

Output

• output Model_Response_Cart_MetaData_List

CartMetaDataSet

Set meta data for a specific entity

api2cart.CartMetaDataSet({
  "entity_id": "",
  "key": "",
  "value": ""
}, context)

Input

• input object
  • entity_id required string: Entity Id
  • entity string: Entity
  • store_id string: Store Id
  • key required string: Key
  • value required string: Value

Output

• output object
  • result object
    • id string
  • return_code integer
  • return_message string

CartMetaDataUnset

Unset meta data for a specific entity

api2cart.CartMetaDataUnset({
  "entity_id": "",
  "key": ""
}, context)

Input

• input object
  • entity_id required string: Entity Id
  • entity string: Entity
  • store_id string: Store Id
  • key required string: Key

Output

• output object
  • result object
    • status boolean
  • return_code integer
  • return_message string

CartMethods

Get list of cart methods

api2cart.CartMethods(null, context)

Input

This action has no parameters

Output

• output object
  • result object
    • method array
      • items string
  • return_code integer
  • return_message string

CartPluginList

Get list of installed plugins

api2cart.CartPluginList({}, context)

Input

• input object
  • store_key string: Set this parameter if bridge is already uploaded to store
  • store_id string: Store Id
  • start integer: This parameter sets the number from which you want to get entities
  • count integer: This parameter sets the entity amount that has to be retrieved. Max allowed count=250

Output

• output object
  • result object
    • all_plugins integer
    • plugins array
      • items PluginList
  • return_code integer
  • return_message string

CartScriptAdd

Add new script to the storefront

api2cart.CartScriptAdd({}, context)

Input

• input object
  • name string: The user-friendly script name
  • description string: The user-friendly description
  • html string: An html string containing exactly one script tag.
  • src string: The URL of the remote script
  • load_method string: The load method to use for the script
  • scope string: The page or pages on the online store where the script should be included
  • store_id string: Store Id

Output

• output object
  • result object
    • script_id string
  • return_code integer
  • return_message string

CartScriptDelete

Remove script from the storefront

api2cart.CartScriptDelete({
  "id": ""
}, context)

Input

• input object
  • id required string: Entity id
  • store_id string: Store Id

Output

• output object
  • result object
    • deleted boolean
  • return_code integer
  • return_message string

CartScriptList

Get scripts installed to the storefront

api2cart.CartScriptList({}, context)

Input

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

Output

• output Model_Response_Cart_Script_List

CartShippingZonesList

Get list of shipping zones

api2cart.CartShippingZonesList({}, context)

Input

• input object
  • store_id string: Store Id

Output

• output object
  • result Cart_ShippingZone
  • return_code integer
  • return_message string

CartValidate

Check store availability, bridge connection for the downloadable carts, identify DB prefix, validate API accesses for API carts.

api2cart.CartValidate({}, context)

Input

• input object
  • validate_version boolean: Specify if api2cart should validate cart version

Output

• output object
  • result object
    • status string
  • return_code integer
  • return_message string

CategoryAdd

Add new category in store

api2cart.CategoryAdd({
  "name": ""
}, context)

Input

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

Output

• output object
  • result object
    • category_id string
  • return_code integer
  • return_message string

CategoryAssign

Assign category to product

api2cart.CategoryAssign({
  "product_id": "",
  "category_id": ""
}, context)

Input

• input object
  • product_id required string: Defines category assign to the product, specified by product id
  • category_id required string: Defines category assign, specified by category id

Output

• output object
  • result object
  • return_code integer
  • return_message string

CategoryCount

Count categories in store.

api2cart.CategoryCount({}, context)

Input

• input object
  • parent_id string: Counts categories specified by parent id
  • store_id string: Counts category specified by store id
  • lang_id string: Counts category specified by language id

Output

• output object
  • result object
    • categories_count integer
  • return_code integer
  • return_message string

CategoryDelete

Delete category in store

api2cart.CategoryDelete({
  "id": ""
}, context)

Input

• input object
  • id required string: Defines category removal, specified by category id

Output

• output object
  • result object
    • deleted string
  • return_code integer
  • return_message string

CategoryFind

Search category in store. "Laptop" is specified here by default.

api2cart.CategoryFind({
  "find_value": ""
}, context)

Input

• input object
  • find_value required string: Entity search that is specified by some value
  • find_where string: Entity search that is specified by the comma-separated unique fields
  • find_params string: Entity search that is specified by comma-separated parameters

Output

• output object
  • result object
    • category array
      • items object
        • description string
        • id string
        • name string
  • return_code integer
  • return_message string

CategoryImageAdd

Add image to category

api2cart.CategoryImageAdd({
  "category_id": "",
  "image_name": "",
  "url": "",
  "type": ""
}, context)

Input

• input object
  • category_id required string: Defines category id where the image should be added
  • image_name required string: Defines image's name
  • url required string: Defines URL of the image that has to be added
  • label string: Defines alternative text that has to be attached to the picture
  • mime string: Mime type of image http://en.wikipedia.org/wiki/Internet_media_type.
  • type required string (values: base, thumbnail): Defines image's types that are specified by comma-separated list
  • position integer: Defines image’s position in the list
  • store_id string: Store Id

Output

• output object
  • result object
    • image_path string
  • return_code integer
  • return_message string

CategoryImageDelete

Delete image

api2cart.CategoryImageDelete({
  "category_id": "",
  "image_id": ""
}, context)

Input

• input object
  • category_id required string: Defines category id where the image should be deleted
  • image_id required string: Define image id
  • store_id string: Store Id

Output

• output object
  • result object
    • deleted string
  • return_code integer
  • return_message string

CategoryInfo

Get category info about category ID*** or specify other category ID.

api2cart.CategoryInfo({
  "id": ""
}, context)

Input

• input object
  • id required string: Retrieves category's info specified by category id
  • params string: Set this parameter in order to choose which entity fields you want to retrieve
  • exclude string: 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: Retrieves category info specified by store id
  • lang_id string: Retrieves category info specified by language id

Output

• output object
  • result Category
  • return_code integer
  • return_message string

CategoryList

Get list of categories from store. Returns 4 categories by default.

api2cart.CategoryList({}, context)

Input

• input object
  • start integer: This parameter sets the number from which you want to get entities
  • count integer: This parameter sets the entity amount that has to be retrieved. Max allowed count=250
  • page_cursor string: Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)
  • parent_id string: Retrieves categories specified by parent id
  • params string: Set this parameter in order to choose which entity fields you want to retrieve
  • exclude string: 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: Retrieves categories specified by store id
  • lang_id string: Retrieves categorys specified by language id

Output

• output Model_Response_Category_List

CategoryUnassign

Unassign category to product

api2cart.CategoryUnassign({
  "category_id": "",
  "product_id": ""
}, context)

Input

• input object
  • category_id required string: Defines category unassign, specified by category id
  • product_id required string: Defines category unassign to the product, specified by product id

Output

• output object
  • result object
  • return_code integer
  • return_message string

CategoryUpdate

Update category in store

api2cart.CategoryUpdate({
  "id": ""
}, context)

Input

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

Output

• output object
  • result object
    • updated_items integer
  • return_code integer
  • return_message string

CustomerAdd

Add customer into store.

api2cart.CustomerAdd({
  "body": {
    "email": "",
    "first_name": "",
    "last_name": ""
  }
}, context)

Input

• input object
  • body required CustomerAdd

Output

• output object
  • result object
    • customer_id string
  • return_code integer
  • return_message string

CustomerAttributeList

Get attributes for specific customer

api2cart.CustomerAttributeList({
  "customer_id": ""
}, context)

Input

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

Output

• output Model_Response_Customer_Attribute_List

CustomerCount

Get number of customers from store.

api2cart.CustomerCount({}, context)

Input

• input object
  • group_id string: Customer group_id
  • created_from string: Retrieve entities from their creation date
  • created_to string: Retrieve entities to their creation date
  • modified_from string: Retrieve entities from their modification date
  • modified_to string: Retrieve entities to their modification date
  • store_id string: Counts customer specified by store id
  • customer_list_id string: The numeric ID of the customer list in Demandware.

Output

• output object
  • result object
    • customers_count integer
  • return_code integer
  • return_message string

CustomerFind

Find customers in store.

api2cart.CustomerFind({
  "find_value": ""
}, context)

Input

• input object
  • find_value required string: Entity search that is specified by some value
  • find_where string: Entity search that is specified by the comma-separated unique fields
  • find_params string: Entity search that is specified by comma-separated parameters
  • store_id string: Store Id

Output

• output object
  • result object
    • email string
    • first_name string
    • id string
    • last_name string
  • return_code integer
  • return_message string

CustomerGroupAdd

Create customer group.

api2cart.CustomerGroupAdd({
  "name": ""
}, context)

Input

• input object
  • name required string: Customer group name
  • store_id string: Store Id
  • stores_ids string: Assign customer group to the stores that is specified by comma-separated stores' id

Output

• output object
  • result object
    • items Customer_Group
  • return_code integer
  • return_message string

CustomerGroupList

Get list of customers groups.

api2cart.CustomerGroupList({}, context)

Input

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

Output

• output Model_Response_Customer_Group_List

CustomerInfo

Get customers' details from store.

api2cart.CustomerInfo({
  "id": ""
}, context)

Input

• input object
  • id required string: Retrieves customer's info specified by customer id
  • params string: Set this parameter in order to choose which entity fields you want to retrieve
  • exclude string: 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: Retrieves customer info specified by store id

Output

• output object
  • result Customer
  • return_code integer
  • return_message string

CustomerList

Get list of customers from store.

api2cart.CustomerList({}, context)

Input

• input object
  • page_cursor string: Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)
  • start integer: This parameter sets the number from which you want to get entities
  • count integer: This parameter sets the entity amount that has to be retrieved. Max allowed count=250
  • created_from string: Retrieve entities from their creation date
  • created_to string: Retrieve entities to their creation date
  • modified_from string: Retrieve entities from their modification date
  • modified_to string: Retrieve entities to their modification date
  • params string: Set this parameter in order to choose which entity fields you want to retrieve
  • exclude string: 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: Customer group_id
  • store_id string: Retrieves customers specified by store id
  • customer_list_id string: The numeric ID of the customer list in Demandware.

Output

• output Model_Response_Customer_List

OrderAbandonedList

Get list of orders that were left by customers before completing the order.

api2cart.OrderAbandonedList({}, context)

Input

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

Output

• output Model_Response_Order_Abandoned_List

OrderAdd

Add a new order to the cart.

api2cart.OrderAdd({
  "body": {
    "order_status": "",
    "customer_email": "",
    "bill_first_name": "",
    "bill_last_name": "",
    "bill_address_1": "",
    "bill_city": "",
    "bill_postcode": "",
    "bill_state": "",
    "bill_country": "",
    "order_item": []
  }
}, context)

Input

• input object
  • body required OrderAdd

Output

• output object
  • result object
    • order_id string
  • return_code integer
  • return_message string

OrderCount

Count orders in store

api2cart.OrderCount({}, context)

Input

• input object
  • customer_id string: Counts orders quantity specified by customer id
  • customer_email string: Counts orders quantity specified by customer email
  • order_status string: Counts orders quantity specified by order status
  • created_to string: Retrieve entities to their creation date
  • created_from string: Retrieve entities from their creation date
  • modified_to string: Retrieve entities to their modification date
  • modified_from string: Retrieve entities from their modification date
  • store_id string: Counts orders quantity specified by store id
  • ids string: Counts orders specified by ids
  • order_ids string: Counts orders specified by order ids
  • ebay_order_status string: Counts orders quantity specified by order status
  • financial_status string: Counts orders quantity specified by financial status
  • fulfillment_status string: Create order with fulfillment status
  • shipping_method string: Retrieve entities according to shipping method

Output

• output object
  • result object
    • orders_count integer
  • return_code integer
  • return_message string

OrderFinancialStatusList

Retrieve list of financial statuses

api2cart.OrderFinancialStatusList(null, context)

Input

This action has no parameters

Output

• output object
  • result object
    • order_financial_statuses array
      • items object
        • id string
        • name string
  • return_code integer
  • return_message string

OrderFind

Find orders

api2cart.OrderFind({}, context)

Input

• input object
  • customer_id string: Retrieves orders specified by customer id
  • customer_email string: Retrieves orders specified by customer email
  • order_status string: Retrieves orders specified by order status
  • start integer: This parameter sets the number from which you want to get entities
  • count integer: This parameter sets the entity amount that has to be retrieved. Max allowed count=250
  • params string: Set this parameter in order to choose which entity fields you want to retrieve
  • exclude string: 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: Retrieve entities to their creation date
  • created_from string: Retrieve entities from their creation date
  • modified_to string: Retrieve entities to their modification date
  • modified_from string: Retrieve entities from their modification date
  • financial_status string: Retrieves orders specified by financial status

Output

• output object
  • result object
    • order array
      • items Order
  • return_code integer
  • return_message string

OrderInfo

Info about a specific order by ID

api2cart.OrderInfo({}, context)

Input

• input object
  • order_id string: Retrieves order’s info specified by order id
  • id string: Retrieves order info specified by id
  • params string: Set this parameter in order to choose which entity fields you want to retrieve
  • exclude string: 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: Defines store id where the order should be found
  • enable_cache boolean: If the value is 'true' and order exist in our cache, we will return order.info response from cache

Output

• output object
  • result Order
  • return_code integer
  • return_message string

OrderList

Get list of orders from store. Returns 4 orders by default.

api2cart.OrderList({}, context)

Input

• input object
  • customer_id string: Retrieves orders specified by customer id
  • customer_email string: Retrieves orders specified by customer email
  • phone string: Filter orders by customer's phone number
  • order_status string: Retrieves orders specified by order status
  • order_status_ids array: Retrieves orders specified by order statuses
  • start integer: This parameter sets the number from which you want to get entities
  • count integer: This parameter sets the entity amount that has to be retrieved. Max allowed count=250
  • page_cursor string: Used to retrieve orders via cursor-based pagination (it can't be used with any other filtering parameter)
  • sort_by string: Set field to sort by
  • sort_direction string: Set sorting direction
  • params string: Set this parameter in order to choose which entity fields you want to retrieve
  • exclude string: 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: Retrieve entities to their creation date
  • created_from string: Retrieve entities from their creation date
  • modified_to string: Retrieve entities to their modification date
  • modified_from string: Retrieve entities from their modification date
  • store_id string: Store Id
  • ids string: Retrieves orders specified by ids
  • order_ids string: Retrieves orders specified by order ids
  • ebay_order_status string: Retrieves orders specified by order status
  • basket_id string: Retrieves order’s info specified by basket id.
  • financial_status string: Retrieves orders specified by financial status
  • fulfillment_status string: Create order with fulfillment status
  • shipping_method string: Retrieve entities according to shipping method
  • skip_order_ids string: Skipped orders by ids
  • since_id integer: Retrieve entities starting from the specified id.
  • is_deleted boolean: Filter deleted orders
  • shipping_country_iso3 string: Retrieve entities according to shipping country
  • enable_cache boolean: 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 and shoping platforms (for example order.shipment.add)

Output

• output Model_Response_Order_List

OrderRefundAdd

Add a refund to the order.

api2cart.OrderRefundAdd({
  "body": {}
}, context)

Input

• input object
  • body required OrderRefundAdd

Output

• output object
  • result object
    • refund_id string
  • return_code integer
  • return_message string

OrderShipmentAdd

Add a shipment to the order.

api2cart.OrderShipmentAdd({
  "body": {}
}, context)

Input

• input object
  • body required OrderShipmentAdd

Output

• output object
  • result object
    • shipment_id string
  • return_code integer
  • return_message string

OrderShipmentList

Get list of shipments by orders.

api2cart.OrderShipmentList({
  "order_id": ""
}, context)

Input

• input object
  • order_id required string: Retrieves shipments specified by order id
  • page_cursor string: Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)
  • start integer: This parameter sets the number from which you want to get entities
  • count integer: This parameter sets the entity amount that has to be retrieved. Max allowed count=250
  • params string: Set this parameter in order to choose which entity fields you want to retrieve
  • exclude string: 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: Retrieve entities from their creation date
  • created_to string: Retrieve entities to their creation date
  • store_id string: Store Id

Output

• output Model_Response_Order_Shipment_List

OrderShipmentTrackingAdd

Add order shipment's tracking info.

api2cart.OrderShipmentTrackingAdd({
  "body": {
    "shipment_id": "",
    "tracking_number": ""
  }
}, context)

Input

• input object
  • body required OrderShipmentTrackingAdd

Output

• output object
  • result object
    • tracking_id string
  • return_code integer
  • return_message string

OrderShipmentUpdate

Update order's shipment information.

api2cart.OrderShipmentUpdate({
  "body": {
    "shipment_id": ""
  }
}, context)

Input

• input object
  • body required OrderShipmentUpdate

Output

• output object
  • result object
    • updated_items integer
  • return_code integer
  • return_message string

OrderStatusList

Retrieve list of statuses

api2cart.OrderStatusList(null, context)

Input

This action has no parameters

Output

• output object
  • result object
    • cart_order_statuses array
      • items object
        • id string
        • name string
  • return_code integer
  • return_message string

OrderUpdate

Update existing order.

api2cart.OrderUpdate({
  "order_id": ""
}, context)

Input

• input object
  • order_id required string: Defines the orders specified by order id
  • store_id string: Defines store id where the order should be found
  • order_status string: Defines new order's status
  • comment string: Specifies order comment
  • admin_comment string: Specifies admin's order comment
  • admin_private_comment string: Specifies private admin's order comment
  • date_modified string: Specifies order's modification date
  • date_finished string: Specifies order's finished date
  • financial_status string: Update order financial status to specified
  • order_payment_method string: Defines order payment method.Setting order_payment_method on Shopify will also change financial_status field value to 'paid'
  • send_notifications boolean: Send notifications to customer after order was created

Output

• output object
  • result object
    • updated_items integer
  • return_code integer
  • return_message string

ProductAdd

Add new product to store.

api2cart.ProductAdd({
  "body": {
    "name": "",
    "model": "",
    "description": "",
    "price": 0
  }
}, context)

Input

• input object
  • body required ProductAdd

Output

• output object
  • result object
    • product_id string
  • return_code integer
  • return_message string

ProductAttributeList

Get list of attributes and values.

api2cart.ProductAttributeList({
  "product_id": ""
}, context)

Input

• input object
  • page_cursor string: Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)
  • start integer: This parameter sets the number from which you want to get entities
  • count integer: This parameter sets the entity amount that has to be retrieved. Max allowed count=250
  • product_id required string: Retrieves attributes specified by product id
  • variant_id string: Defines product's variants specified by variant id
  • attribute_id string: Retrieves info for specified attribute_id
  • attribute_group_id string: Filter by attribute_group_id
  • set_name string: Retrieves attributes specified by set_name in Magento
  • lang_id string: Retrieves attributes specified by language id
  • store_id string: Retrieves attributes specified by store id
  • sort_by string: Set field to sort by
  • sort_direction string: Set sorting direction
  • params string: Set this parameter in order to cho