Swagger API2Cart
API2CartTechnical Specifications
startFlow
- OnInit
- ./lib/triggers/startFlow.js
- OnStartup
- -
- OnClose
- -
Attributes
-
AccountCartList
Get list of carts.
- OnInit
- ./lib/actions/AccountCartList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
AccountConfigUpdate
Update configs in the API2Cart database.
- OnInit
- ./lib/actions/AccountConfigUpdate.js
- OnStartup
- -
- OnClose
- -
Attributes
-
AccountFailedWebhooks
List webhooks that was not delivered to the callback.
- OnInit
- ./lib/actions/AccountFailedWebhooks.js
- OnStartup
- -
- OnClose
- -
Attributes
-
AttributeAdd
Add new attribute
- OnInit
- ./lib/actions/AttributeAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
AttributeAssignGroup
Assign attribute to the group
- OnInit
- ./lib/actions/AttributeAssignGroup.js
- OnStartup
- -
- OnClose
- -
Attributes
-
AttributeAssignSet
Assign attribute to the attribute set
- OnInit
- ./lib/actions/AttributeAssignSet.js
- OnStartup
- -
- OnClose
- -
Attributes
-
AttributeAttributesetList
Get attribute_set list
- OnInit
- ./lib/actions/AttributeAttributesetList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
AttributeCount
Get attributes count
- OnInit
- ./lib/actions/AttributeCount.js
- OnStartup
- -
- OnClose
- -
Attributes
-
AttributeDelete
Delete attribute from store
- OnInit
- ./lib/actions/AttributeDelete.js
- OnStartup
- -
- OnClose
- -
Attributes
-
AttributeGroupList
Get attribute group list
- OnInit
- ./lib/actions/AttributeGroupList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
AttributeInfo
Get attribute info
- OnInit
- ./lib/actions/AttributeInfo.js
- OnStartup
- -
- OnClose
- -
Attributes
-
AttributeList
Get attributes list
- OnInit
- ./lib/actions/AttributeList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
AttributeTypeList
Get list of supported attributes types
- OnInit
- ./lib/actions/AttributeTypeList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
AttributeUnassignGroup
Unassign attribute from group
- OnInit
- ./lib/actions/AttributeUnassignGroup.js
- OnStartup
- -
- OnClose
- -
Attributes
-
AttributeUnassignSet
Unassign attribute from attribute set
- OnInit
- ./lib/actions/AttributeUnassignSet.js
- OnStartup
- -
- OnClose
- -
Attributes
-
BasketItemAdd
Add item to basket
- OnInit
- ./lib/actions/BasketItemAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
BridgeDelete
Delete bridge from the store.
- OnInit
- ./lib/actions/BridgeDelete.js
- OnStartup
- -
- OnClose
- -
Attributes
-
BridgeDownload
Download bridge for store
- OnInit
- ./lib/actions/BridgeDownload.js
- OnStartup
- -
- OnClose
- -
Attributes
-
BridgeUpdate
Update bridge in the store.
- OnInit
- ./lib/actions/BridgeUpdate.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CartBridge
Get bridge key and store key
- OnInit
- ./lib/actions/CartBridge.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CartClearCache
Clear cache on store.
- OnInit
- ./lib/actions/CartClearCache.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CartConfig
Get list of cart configs
- OnInit
- ./lib/actions/CartConfig.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CartConfigUpdate
Use this API method to update custom data in client database.
- OnInit
- ./lib/actions/CartConfigUpdate.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CartCouponAdd
Create new coupon
- OnInit
- ./lib/actions/CartCouponAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CartCouponCount
Get cart coupons count.
- OnInit
- ./lib/actions/CartCouponCount.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CartCouponDelete
Delete coupon
- OnInit
- ./lib/actions/CartCouponDelete.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CartCouponList
Get cart coupon discounts.
- OnInit
- ./lib/actions/CartCouponList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CartCreate
Add store to the account
- OnInit
- ./lib/actions/CartCreate.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CartDelete
Remove store from API2Cart
- OnInit
- ./lib/actions/CartDelete.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CartDisconnect
Disconnect with the store and clear store session data.
- OnInit
- ./lib/actions/CartDisconnect.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CartGiftcardAdd
Create new gift card
- OnInit
- ./lib/actions/CartGiftcardAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CartGiftcardCount
Get gift cards count.
- OnInit
- ./lib/actions/CartGiftcardCount.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CartGiftcardList
Get gift cards list.
- OnInit
- ./lib/actions/CartGiftcardList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CartInfo
Get cart information
- OnInit
- ./lib/actions/CartInfo.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CartList
Get list of supported carts
- OnInit
- ./lib/actions/CartList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CartMethods
Get list of cart methods
- OnInit
- ./lib/actions/CartMethods.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CartPluginList
Get list of installed plugins
- OnInit
- ./lib/actions/CartPluginList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CartValidate
Check store availability, bridge connection for the downloadable carts, identify DB prefix, validate API accesses for API carts.
- OnInit
- ./lib/actions/CartValidate.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CategoryAdd
Add new category in store
- OnInit
- ./lib/actions/CategoryAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CategoryAssign
Assign category to product
- OnInit
- ./lib/actions/CategoryAssign.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CategoryCount
Count categories in store.
- OnInit
- ./lib/actions/CategoryCount.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CategoryDelete
Delete category in store
- OnInit
- ./lib/actions/CategoryDelete.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CategoryFind
Search category in store. "Laptop" is specified here by default.
- OnInit
- ./lib/actions/CategoryFind.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CategoryImageAdd
Add image to category
- OnInit
- ./lib/actions/CategoryImageAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CategoryImageDelete
Delete image
- OnInit
- ./lib/actions/CategoryImageDelete.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CategoryInfo
Get category info about category ID*** or specify other category ID.
- OnInit
- ./lib/actions/CategoryInfo.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CategoryList
Get list of categories from store. Returns 4 categories by default.
- OnInit
- ./lib/actions/CategoryList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CategoryUnassign
Unassign category to product
- OnInit
- ./lib/actions/CategoryUnassign.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CategoryUpdate
Update category in store
- OnInit
- ./lib/actions/CategoryUpdate.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CustomerAdd
Add customer into store.
- OnInit
- ./lib/actions/CustomerAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CustomerCount
Get number of customers from store.
- OnInit
- ./lib/actions/CustomerCount.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CustomerFind
Find customers in store.
- OnInit
- ./lib/actions/CustomerFind.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CustomerInfo
Get customers' details from store.
- OnInit
- ./lib/actions/CustomerInfo.js
- OnStartup
- -
- OnClose
- -
Attributes
-
CustomerList
Get list of customers from store.
- OnInit
- ./lib/actions/CustomerList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
OrderAbandonedList
Get list of orders that were left by customers before completing the order.
- OnInit
- ./lib/actions/OrderAbandonedList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
OrderAdd
Add a new order to the cart.
- OnInit
- ./lib/actions/OrderAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
OrderCount
Count orders in store
- OnInit
- ./lib/actions/OrderCount.js
- OnStartup
- -
- OnClose
- -
Attributes
-
OrderFinancialStatusList
Retrieve list of financial statuses
- OnInit
- ./lib/actions/OrderFinancialStatusList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
OrderFind
Find orders
- OnInit
- ./lib/actions/OrderFind.js
- OnStartup
- -
- OnClose
- -
Attributes
-
OrderInfo
Info about a specific order by ID
- OnInit
- ./lib/actions/OrderInfo.js
- OnStartup
- -
- OnClose
- -
Attributes
-
OrderList
Get list of orders from store. Returns 4 orders by default.
- OnInit
- ./lib/actions/OrderList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
OrderRefundAdd
Add a refund to the order.
- OnInit
- ./lib/actions/OrderRefundAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
OrderShipmentAdd
Add a shipment to the order.
- OnInit
- ./lib/actions/OrderShipmentAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
OrderShipmentList
Get list of shipments by orders.
- OnInit
- ./lib/actions/OrderShipmentList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
OrderShipmentUpdate
Update order's shipment information.
- OnInit
- ./lib/actions/OrderShipmentUpdate.js
- OnStartup
- -
- OnClose
- -
Attributes
-
OrderStatusList
Retrieve list of statuses
- OnInit
- ./lib/actions/OrderStatusList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
OrderUpdate
Update existing order.
- OnInit
- ./lib/actions/OrderUpdate.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductAdd
Add new product to store.
- OnInit
- ./lib/actions/ProductAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductAttributeList
Get list of attributes.
- OnInit
- ./lib/actions/ProductAttributeList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductAttributeValueSet
Set attribute value to product.
- OnInit
- ./lib/actions/ProductAttributeValueSet.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductChildItemFind
Search product child item (bundled item or configurable product variant) in store catalog.
- OnInit
- ./lib/actions/ProductChildItemFind.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductChildItemList
Get child items list of specific product.
- OnInit
- ./lib/actions/ProductChildItemList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductCount
Count products in store.
- OnInit
- ./lib/actions/ProductCount.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductCurrencyAdd
Add currency and/or set default in store
- OnInit
- ./lib/actions/ProductCurrencyAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductCurrencyList
Get list of currencies
- OnInit
- ./lib/actions/ProductCurrencyList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductDelete
Product delete
- OnInit
- ./lib/actions/ProductDelete.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductFields
Retrieve all available fields for product item in store.
- OnInit
- ./lib/actions/ProductFields.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductFind
Search product in store catalog. "Apple" is specified here by default.
- OnInit
- ./lib/actions/ProductFind.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductImageAdd
Add image to product
- OnInit
- ./lib/actions/ProductImageAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductImageDelete
Delete image
- OnInit
- ./lib/actions/ProductImageDelete.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductImageUpdate
Update details of image
- OnInit
- ./lib/actions/ProductImageUpdate.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductInfo
Get product info about product ID *** or specify other product ID.
- OnInit
- ./lib/actions/ProductInfo.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductList
Get list of products from your store. Returns 4 products by default.
- OnInit
- ./lib/actions/ProductList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductManufacturerAdd
Add manufacturer to store and assign to product
- OnInit
- ./lib/actions/ProductManufacturerAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductOptionAdd
Add product option from store.
- OnInit
- ./lib/actions/ProductOptionAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductOptionAssign
Assign option from product.
- OnInit
- ./lib/actions/ProductOptionAssign.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductOptionList
Get list of options.
- OnInit
- ./lib/actions/ProductOptionList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductOptionValueAdd
Add product option item from option.
- OnInit
- ./lib/actions/ProductOptionValueAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductOptionValueAssign
Assign product option item from product.
- OnInit
- ./lib/actions/ProductOptionValueAssign.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductOptionValueUpdate
Update product option item from option.
- OnInit
- ./lib/actions/ProductOptionValueUpdate.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductPriceAdd
Add some prices to the product.
- OnInit
- ./lib/actions/ProductPriceAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductPriceDelete
Delete some prices of the product
- OnInit
- ./lib/actions/ProductPriceDelete.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductPriceUpdate
Update some prices of the product.
- OnInit
- ./lib/actions/ProductPriceUpdate.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductReviewList
Get reviews of a specific product.
- OnInit
- ./lib/actions/ProductReviewList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductTaxAdd
Add tax class and tax rate to store and assign to product.
- OnInit
- ./lib/actions/ProductTaxAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductUpdate
Update price and quantity for a specific product
- OnInit
- ./lib/actions/ProductUpdate.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductVariantAdd
Add variant to product.
- OnInit
- ./lib/actions/ProductVariantAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductVariantCount
Get count variants.
- OnInit
- ./lib/actions/ProductVariantCount.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductVariantDelete
Delete variant.
- OnInit
- ./lib/actions/ProductVariantDelete.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductVariantInfo
Get variant info.
- OnInit
- ./lib/actions/ProductVariantInfo.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductVariantList
Get list variants.
- OnInit
- ./lib/actions/ProductVariantList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductVariantPriceAdd
Add some prices to the product variant.
- OnInit
- ./lib/actions/ProductVariantPriceAdd.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductVariantPriceDelete
Delete some prices of the product variant.
- OnInit
- ./lib/actions/ProductVariantPriceDelete.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductVariantPriceUpdate
Update some prices of the product variant.
- OnInit
- ./lib/actions/ProductVariantPriceUpdate.js
- OnStartup
- -
- OnClose
- -
Attributes
-
ProductVariantUpdate
Update variant.
- OnInit
- ./lib/actions/ProductVariantUpdate.js
- OnStartup
- -
- OnClose
- -
Attributes
-
TaxClassInfo
Get info about tax
- OnInit
- ./lib/actions/TaxClassInfo.js
- OnStartup
- -
- OnClose
- -
Attributes
-
WebhookCount
Count registered webhooks on the store.
- OnInit
- ./lib/actions/WebhookCount.js
- OnStartup
- -
- OnClose
- -
Attributes
-
WebhookCreate
Create webhook on the store and subscribe to it.
- OnInit
- ./lib/actions/WebhookCreate.js
- OnStartup
- -
- OnClose
- -
Attributes
-
WebhookDelete
Delete registered webhook on the store.
- OnInit
- ./lib/actions/WebhookDelete.js
- OnStartup
- -
- OnClose
- -
Attributes
-
WebhookEvents
List all Webhooks that are available on this store.
- OnInit
- ./lib/actions/WebhookEvents.js
- OnStartup
- -
- OnClose
- -
Attributes
-
WebhookList
List registered webhook on the store.
- OnInit
- ./lib/actions/WebhookList.js
- OnStartup
- -
- OnClose
- -
Attributes
-
WebhookUpdate
Update Webhooks parameters.
- OnInit
- ./lib/actions/WebhookUpdate.js
- OnStartup
- -
- OnClose
- -
Attributes
-
Keine Daten für terms vorhanden
Keine Daten für environment vorhanden