Fields Description

account.config.update

id	The ordinal number of the client’s store in our database.
url	Store URL.
store_key	A unique key used to identify the store.
cart_id	The cart identifier.
total_calls	Number of calls made for each store. This field requires specifying request_from_date and request_to_date parameters. Otherwise, this field will return empty.

cart.create

store_key	A unique key used to identify the store.

cart.validate

status	Status (true/false) shows whether the store is validated.

cart.bridge

store_key	A unique key used to identify the store.
bridge	A download link to a bridge file.

cart.clear_cache

cache_cleared	Status (true/false) shows whether the cache was successfully cleared.

cart.delete

store	The message confirms that the store with a given url has been deleted.

cart.disconnect

connection	Status (closed) shows that the method is successfully performed.

cart.methods

method	The list of methods that can be used on a given platform.

cart.config

store_name	Store name, drawn from the client’s database.
store_url	Store URL link.
db_prefix	Prefix for the database, which is used by the store. This field is used only for open-source shopping carts, so when the method is performed on a hosted platform, this field will be empty.

cart.list

supported_carts_count	The number of shopping carts supported by API2Cart.
cart_id	Cart identifier.
cart_name	Cart name.
cart_versions	Versions of shopping carts supported by API2Cart.
params	The list of supported parameters for the cart.create method.

cart.info

name	Store name, drawn from the client’s database.
url	Store URL link.
version	The version of the shopping cart.
db_prefix	Prefix for the database, which is used by the store. This field is used only for open-source shopping carts, and when this method is performed for a hosted platform, this field will be empty.
stores_info	The object that contains detailed info about each store: store_id - store id in the client’s database name - store’s name language - the default language of the store (ISO 639-1) currency - the list of currencies supported by a store timezone - displays the time zone of the store country - the country where the store is located (ISO 3166-1 alpha-2) root_category_id - the identifier of the root category multi_store_url - the url link to the multistore active - the store status (true/false) weight_unit - the default weight unit for a given store dimension_unit - the default dimension unit for a given store prices_include_tax - shows whether prices include taxes on a given store (true/false) additional_fields - shows the array of fields that are unique for a given cart carrier_info - shows the list of carriers supported by a store store_owner_info - the object contains detailed info about the store owner
shipping_zones	The object contains delivery zones supported by the store: id - the shipping zone identifier code - the code of the country available for shipping (ISO 3166-1 alpha-2). If the value * is returned, it means that the given carrier delivers to all countries country - the country available for shipping

attribute.list / attribute.info

id	The attribute ID.
code	The unique attribute code.
type	The attribute type. You can get the list of supported attributes using attribute.type.list method.
name	The name of the attribute.
default_values	The list of typical values of the attribute.
position	The position of a given attribute regarding other attributes.
visible	Shows whether the attribute is active (true/false).
required	Shows whether a given attribute is required.
system	Shows whether it is a default attribute for a shopping cart.
values	The array of values of a certain attribute.
store_id	The ID of the store the attribute is connected to.
lang_id	The language of the attribute.
additional_attributes	Contains the list of attributes which are unique for a given cart

attribute.type.list

items_count	The number of supported attribute types.
attribute_type	The array of attribute types the given cart supports.

attribute.group.list

id	The attribute group identifier.
name	The name of the attribute group.
position	The position of the given attribute group regarding other attribute groups.
attribute_set_id	Identifies which of attribute sets the attribute belongs to.
assigned_attribute_ids	The list of attributes which a given attributes group contains.

customer.info / customer.list

id	The user identifier.
email	The email address of the user.
first_name	Customer first name.

customer.find

id	Customer ID.
email	Customer email address.
first_name	Customer first name.
last_name	Customer last name.

order.list / order.info / order.find

id	System order ID.
order_id	Order ID in the admin panel.
customer	The object which contains the customer data (id, email, first_name, last_name
create_at	The time when the order was created.
currency	The object that contains the info about the currency with which the order was paid.
billing_address	The object that contains billing info.
shipping_address	The object that contains shipping info.
payment_method	Payment method info.
shipping_method	Shipping method info.
status	The object that contains order status info id - status ID name - status name history - the object contains info about order status history refund_info - in case there is a status “refund” in status history, this object will contain info on what products were refunded and refund amounts.
totals	The object contains info about prices in the order: total - the final price with all discounts, taxes, etc. subtotal - the original price for the products shipping - shipping price tax - tax price discount - discount price shipping_tax_value - shipping tax price.
order_products	The object contains the list of products bought in the order.
modified_at	Time when any changes to the order were made.
finished_time	The time when the order was fulfilled (delivered).
comment	Comments to the order.
store_id	The ID of the store from which the order was made.

order.status.list

count	The number of order statuses on the store.
cart_order_statuses	The object contains the list of order statuses on the shopping cart: id - status identifier name - status name.

order.financial_status.list

count	The number of financial statuses on the store.
order_financial_statuses	The object contains the list of financial statuses on the shopping cart: id - status identifier name - status name.

order.abandoned.list

id	Identifier
customer	The object contains user info (id, email, first_name, last_name).
created_atThe path to the newly created image.	The time when products were added to the cart.
modified_at	Time when any changes in the given cart was made.
currency	The object contains info about in what currency products were added to the cart.
totals	The object contains info about prices of products in the cart.
order_products	The object contains the list of products that were added to the cart.

order.shipment.list

shipment_count	A number of shipments for the given order.
id	Shipment identifier.
order_id	Identifier of the order, for which the shipment was made.
tracking_numbers	The array of objects contains delivery data, such as: tracking_number carrier_id - carrier identificator.
created_at	The time when the shipment was created.
items	The object contains the list of products that were shipped.

category.image.add

image_path	The path to the newly created image.

category.list / category.info

id	Category ID.
parent_id	Parent category ID.
created_at	The time when the category was created.
modified_at	The last time when the category was modified.
name	The category name.
short_description	Short category description
description	The full category description.
stores_ids	Stores IDs which have the given category.
stores_ids	Stores IDs which have the given category.
stores_info	The object contains the list of stores, which have the given category, and additional info (store_id, name, avail).
keywords	The keywords for search engines.
meta_description	Meta description of the page, which may be used by search engines.
meta_title	Meta title of the page.
avail	Category status.
path	URL link to the category.
seo_url	SEO URL link to the category.
sort_order	The serial number of the category in the category list of the store.
images	The object contains the array of images for a certain category.

category.find

id	Category ID.
name	Category name.
description	The full category description.

product.option.list

id	The option ID.
type	The type of the option.
name	The name of the option.
description	Option description.
required	Shows whether this option is required.
avail	Shows whether this option is available.
sort_order	The position of the option regarding other options.
option_value	The object contains the list of product option values id - option value ID product_option_value_id - option value ID for the given product name - option value name price - option value price type_price - price type (value, percent) quantity - values quantity.
product_option_id	Product option ID.

product.attribute.list

attribute_id	Attribute ID.
code	Attribute code.
name	Attribute name.
lang_id	Language in which the attribute is returned.
store_id	Store ID that the attribute belongs to.
value	Attribute value.
required	Shows whether the attribute is required for the product
type	Attribute type.
position	The position of the attribute regarding other attributes.
attribute_group_id	ID of the attribute group that the given attribute belongs to.
product_id	Product ID that the attribute belongs to.

product.info / product.list / variant.info / variant.list

id	Product ID.
type	Product type.
u_model	Product model number.
u_sku	Stock-keeping unit.
name	Product name.
description	Full product description.
short_description	Short product description.
price	Product price.
quantity	Available product quantity.
u_brand	Product brand.
categories_ids	Categories ID that the product belongs to.
stores_ids	Stores ID that offer a given product.
url	URL path to the product.
seo_url	SEO URL path to the product.
meta_title	Meta title of the page.
meta_keywords	The keywords for search engines.
meta_description	Meta description of the page, which may be used by search engines.
avail_sale	Shows whether the product is available for sale.
avail_view	Shows whether the product is available for view.
weight	Product weight.
sort_order	The position of the product regarding other products.
backorders	If the product is not available now, it can be ordered later.
manage_stock	If the value is false, it means it is not possible to manage product quantity, so one can order unlimited number of product, and vice versa.
create_at	The time when the product was created.
modified_at	The last time when the product was modified.
tax_class_id	Tax class ID.
special_price	The object contains special price info, including the following: value avail - shows whether the special price is active created_at - time when the special price was created modified_at - time when the special price was modified expired_at - time when the special price expires
tier_price	The object contains the rules for tier_price tier_price_countX - the number of products tier_price_valueX - the value that will be set tier_prices_count - the number of rules for tier_price
group_price	The object contains the list of rules for group_price id - group price ID group_id - customer group ID price - the price for the given customer group store_id - Store ID that the group price belongs to quantity - the number of available products for this group start_time - time from which group price will be available expire_time - time when group price expires
images	The object contains info about product images http_path - url path to the image type - image type. Available image types: IMAGE_TYPE_BASE, IMAGE_TYPE_SMALL, IMAGE_TYPE_THUMBNAIL, IMAGE_TYPE_ADDITIONAL, IMAGE_TYPE_DESCRIPTION, IMAGE_TYPE_UNKNOWN mime-type - file format alt - alternative text for the image avail - shows whether the image is available for view file_name - image name create_at - time when the image was created modified_at - last time when the image was modified size - image size sort_order - the position of the image regarding other images
product_options	The object contains the list of the product options. More details are in product.option.list method.
product_variants	The object contains the list of product variants. The fields are the same as for product.info and product.list methods.
u_upc	Universal Product Code is the standard for general products and is used by almost all barcode systems.
u_mpn	Manufacturer Part Number.
related_products_ids	Product IDs attached to the given product.

product.currency.list

currencies_count	The number of currencies in a given store.
currency	The object contains info about available currencies: name - currency name iso3 - currency code in ISO format symbol_left - currency symbol located on the left symbol_right - currency symbol located on the right avail - shows whether the given currency is available default - shows whether it is a default value on the stor

product.attribute.value.set

product_id	The product ID that the attribute value was assigned to.
attribute_id	The attribute ID that is assigned to the product.
value_id	Value ID that was assigned to the product.

product.find

id	Product ID.
name	Product name.
description	Product description.
price	Product price.

product.fields

product_fields	The list of fields that will be in the product response.

tax.class.info

id	Tax class ID.
name	Tax class name.
avail	Status of the tax class which shows whether the tax class is active.
tax	Tax value.
tax_type	Tax type: 1 - percentage value, 0 - numeric value.
tax_rates	The object contains additional tax rules id - tax rate id name - tax rate name tax - tax value tax_type - tax type tax_based_on - Shows what to base the tax on (shipping/billing) countries - the object contains the list of countries and states that the tax rate will be assigned for cities - the list of cities the tax rate will be set for address - the list of addresses the tax rate will be set for zip_codes - the object contains values that the tax rate will be set for

For all COUNT methods

{entity}_count	The field returns the number of entities for the given method.

For all ADD methods

{entity}_id	The field returns the ID of the newly created entity.

For all UPDATE methods

updated_items	Shows whether items were updated and how many of them were updated

For all DELETE methods

deleted	Status (true/false) shows whether deletion was successfully made.

For all ASSIGN methods

assigned	Status (true/false) shows whether the assignment was successfully performed.

webhook.list

id	The webhook id.
label	The webhook name.
store_id	The store id the webhook is created on. For non-multistore instances, the returned value will always be “1”.
active	Webhook status.
callback	Callback URL that the webhook will send the POST request to when the event occurs.
fields	Fields that the webhook will send.
created_at	Webhook creation date.
updated_at	Last webhook update date.
entity	The entity that the webhook is created for.
action	The action that triggers the webhook.

Fields Description

Latest whitepaper

Getting started

Information

Developer Resources

Support