Skip to content

api2cart/javascript-sdk

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
.github/workflows
.github/workflows
 
 
.openapi-generator
.openapi-generator
 
 
docs
docs
 
 
src
src
 
 
test
test
 
 
.babelrc
.babelrc
 
 
.gitignore
.gitignore
 
 
.openapi-generator-ignore
.openapi-generator-ignore
 
 
.travis.yml
.travis.yml
 
 
README.md
README.md
 
 
git_push.sh
git_push.sh
 
 
mocha.opts
mocha.opts
 
 
package.json
package.json
 
 

Repository files navigation

api2_cart_open_api

Api2CartOpenApi - JavaScript client for api2_cart_open_api API2Cart This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.1
  • Package version: 1.1
  • Generator version: 7.11.0
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install api2_cart_open_api --save

Finally, you need to build the module:

npm run build
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your api2_cart_open_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var Api2CartOpenApi = require('api2_cart_open_api');

var defaultClient = Api2CartOpenApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['x-api-key'] = "Token"

var api = new Api2CartOpenApi.AccountApi()
var accountCartAdd = new Api2CartOpenApi.AccountCartAdd(); // {AccountCartAdd} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountCartAdd(accountCartAdd, callback);

Documentation for API Endpoints

All URIs are relative to https://api.api2cart.local.com/v1.1

Class Method HTTP request Description
Api2CartOpenApi.AccountApi accountCartAdd POST /account.cart.add.json account.cart.add
Api2CartOpenApi.AccountApi accountCartList GET /account.cart.list.json account.cart.list
Api2CartOpenApi.AccountApi accountConfigUpdate PUT /account.config.update.json account.config.update
Api2CartOpenApi.AccountApi accountFailedWebhooks GET /account.failed_webhooks.json account.failed_webhooks
Api2CartOpenApi.AccountApi accountSupportedPlatforms GET /account.supported_platforms.json account.supported_platforms
Api2CartOpenApi.AttributeApi attributeAdd POST /attribute.add.json attribute.add
Api2CartOpenApi.AttributeApi attributeAssignGroup POST /attribute.assign.group.json attribute.assign.group
Api2CartOpenApi.AttributeApi attributeAssignSet POST /attribute.assign.set.json attribute.assign.set
Api2CartOpenApi.AttributeApi attributeAttributesetList GET /attribute.attributeset.list.json attribute.attributeset.list
Api2CartOpenApi.AttributeApi attributeCount GET /attribute.count.json attribute.count
Api2CartOpenApi.AttributeApi attributeDelete DELETE /attribute.delete.json attribute.delete
Api2CartOpenApi.AttributeApi attributeGroupList GET /attribute.group.list.json attribute.group.list
Api2CartOpenApi.AttributeApi attributeInfo GET /attribute.info.json attribute.info
Api2CartOpenApi.AttributeApi attributeList GET /attribute.list.json attribute.list
Api2CartOpenApi.AttributeApi attributeTypeList GET /attribute.type.list.json attribute.type.list
Api2CartOpenApi.AttributeApi attributeUnassignGroup POST /attribute.unassign.group.json attribute.unassign.group
Api2CartOpenApi.AttributeApi attributeUnassignSet POST /attribute.unassign.set.json attribute.unassign.set
Api2CartOpenApi.AttributeApi attributeUpdate PUT /attribute.update.json attribute.update
Api2CartOpenApi.AttributeApi attributeValueAdd POST /attribute.value.add.json attribute.value.add
Api2CartOpenApi.AttributeApi attributeValueDelete DELETE /attribute.value.delete.json attribute.value.delete
Api2CartOpenApi.AttributeApi attributeValueUpdate PUT /attribute.value.update.json attribute.value.update
Api2CartOpenApi.BasketApi basketInfo GET /basket.info.json basket.info
Api2CartOpenApi.BasketApi basketItemAdd POST /basket.item.add.json basket.item.add
Api2CartOpenApi.BasketApi basketLiveShippingServiceCreate POST /basket.live_shipping_service.create.json basket.live_shipping_service.create
Api2CartOpenApi.BasketApi basketLiveShippingServiceDelete DELETE /basket.live_shipping_service.delete.json basket.live_shipping_service.delete
Api2CartOpenApi.BasketApi basketLiveShippingServiceList GET /basket.live_shipping_service.list.json basket.live_shipping_service.list
Api2CartOpenApi.BatchApi batchJobList GET /batch.job.list.json batch.job.list
Api2CartOpenApi.BatchApi batchJobResult GET /batch.job.result.json batch.job.result
Api2CartOpenApi.BridgeApi bridgeDelete POST /bridge.delete.json bridge.delete
Api2CartOpenApi.BridgeApi bridgeDownload GET /bridge.download.file bridge.download
Api2CartOpenApi.BridgeApi bridgeUpdate POST /bridge.update.json bridge.update
Api2CartOpenApi.CartApi cartCatalogPriceRulesCount GET /cart.catalog_price_rules.count.json cart.catalog_price_rules.count
Api2CartOpenApi.CartApi cartCatalogPriceRulesList GET /cart.catalog_price_rules.list.json cart.catalog_price_rules.list
Api2CartOpenApi.CartApi cartCouponAdd POST /cart.coupon.add.json cart.coupon.add
Api2CartOpenApi.CartApi cartCouponConditionAdd POST /cart.coupon.condition.add.json cart.coupon.condition.add
Api2CartOpenApi.CartApi cartCouponCount GET /cart.coupon.count.json cart.coupon.count
Api2CartOpenApi.CartApi cartCouponDelete DELETE /cart.coupon.delete.json cart.coupon.delete
Api2CartOpenApi.CartApi cartCouponList GET /cart.coupon.list.json cart.coupon.list
Api2CartOpenApi.CartApi cartDelete DELETE /cart.delete.json cart.delete
Api2CartOpenApi.CartApi cartGiftcardAdd POST /cart.giftcard.add.json cart.giftcard.add
Api2CartOpenApi.CartApi cartGiftcardCount GET /cart.giftcard.count.json cart.giftcard.count
Api2CartOpenApi.CartApi cartGiftcardDelete DELETE /cart.giftcard.delete.json cart.giftcard.delete
Api2CartOpenApi.CartApi cartGiftcardList GET /cart.giftcard.list.json cart.giftcard.list
Api2CartOpenApi.CartApi cartInfo GET /cart.info.json cart.info
Api2CartOpenApi.CartApi cartMetaDataList GET /cart.meta_data.list.json cart.meta_data.list
Api2CartOpenApi.CartApi cartMetaDataSet POST /cart.meta_data.set.json cart.meta_data.set
Api2CartOpenApi.CartApi cartMetaDataUnset DELETE /cart.meta_data.unset.json cart.meta_data.unset
Api2CartOpenApi.CartApi cartMethods GET /cart.methods.json cart.methods
Api2CartOpenApi.CartApi cartPluginList GET /cart.plugin.list.json cart.plugin.list
Api2CartOpenApi.CartApi cartScriptAdd POST /cart.script.add.json cart.script.add
Api2CartOpenApi.CartApi cartScriptDelete DELETE /cart.script.delete.json cart.script.delete
Api2CartOpenApi.CartApi cartScriptList GET /cart.script.list.json cart.script.list
Api2CartOpenApi.CartApi cartShippingZonesList GET /cart.shipping_zones.list.json cart.shipping_zones.list
Api2CartOpenApi.CartApi cartValidate GET /cart.validate.json cart.validate
Api2CartOpenApi.CategoryApi categoryAdd POST /category.add.json category.add
Api2CartOpenApi.CategoryApi categoryAddBatch POST /category.add.batch.json category.add.batch
Api2CartOpenApi.CategoryApi categoryAssign POST /category.assign.json category.assign
Api2CartOpenApi.CategoryApi categoryCount GET /category.count.json category.count
Api2CartOpenApi.CategoryApi categoryDelete DELETE /category.delete.json category.delete
Api2CartOpenApi.CategoryApi categoryFind GET /category.find.json category.find
Api2CartOpenApi.CategoryApi categoryImageAdd POST /category.image.add.json category.image.add
Api2CartOpenApi.CategoryApi categoryImageDelete DELETE /category.image.delete.json category.image.delete
Api2CartOpenApi.CategoryApi categoryInfo GET /category.info.json category.info
Api2CartOpenApi.CategoryApi categoryList GET /category.list.json category.list
Api2CartOpenApi.CategoryApi categoryUnassign POST /category.unassign.json category.unassign
Api2CartOpenApi.CategoryApi categoryUpdate PUT /category.update.json category.update
Api2CartOpenApi.CustomerApi customerAdd POST /customer.add.json customer.add
Api2CartOpenApi.CustomerApi customerAddressAdd POST /customer.address.add.json customer.address.add
Api2CartOpenApi.CustomerApi customerAttributeList GET /customer.attribute.list.json customer.attribute.list
Api2CartOpenApi.CustomerApi customerCount GET /customer.count.json customer.count
Api2CartOpenApi.CustomerApi customerDelete DELETE /customer.delete.json customer.delete
Api2CartOpenApi.CustomerApi customerFind GET /customer.find.json customer.find
Api2CartOpenApi.CustomerApi customerGroupAdd POST /customer.group.add.json customer.group.add
Api2CartOpenApi.CustomerApi customerGroupList GET /customer.group.list.json customer.group.list
Api2CartOpenApi.CustomerApi customerInfo GET /customer.info.json customer.info
Api2CartOpenApi.CustomerApi customerList GET /customer.list.json customer.list
Api2CartOpenApi.CustomerApi customerUpdate PUT /customer.update.json customer.update
Api2CartOpenApi.CustomerApi customerWishlistList GET /customer.wishlist.list.json customer.wishlist.list
Api2CartOpenApi.MarketplaceApi marketplaceProductFind GET /marketplace.product.find.json marketplace.product.find
Api2CartOpenApi.OrderApi orderAbandonedList GET /order.abandoned.list.json order.abandoned.list
Api2CartOpenApi.OrderApi orderAdd POST /order.add.json order.add
Api2CartOpenApi.OrderApi orderCalculate POST /order.calculate.json order.calculate
Api2CartOpenApi.OrderApi orderCount GET /order.count.json order.count
Api2CartOpenApi.OrderApi orderFinancialStatusList GET /order.financial_status.list.json order.financial_status.list
Api2CartOpenApi.OrderApi orderFulfillmentStatusList GET /order.fulfillment_status.list.json order.fulfillment_status.list
Api2CartOpenApi.OrderApi orderInfo GET /order.info.json order.info
Api2CartOpenApi.OrderApi orderList GET /order.list.json order.list
Api2CartOpenApi.OrderApi orderPreestimateShippingList POST /order.preestimate_shipping.list.json order.preestimate_shipping.list
Api2CartOpenApi.OrderApi orderRefundAdd POST /order.refund.add.json order.refund.add
Api2CartOpenApi.OrderApi orderReturnAdd POST /order.return.add.json order.return.add
Api2CartOpenApi.OrderApi orderReturnDelete DELETE /order.return.delete.json order.return.delete
Api2CartOpenApi.OrderApi orderReturnUpdate PUT /order.return.update.json order.return.update
Api2CartOpenApi.OrderApi orderShipmentAdd POST /order.shipment.add.json order.shipment.add
Api2CartOpenApi.OrderApi orderShipmentAddBatch POST /order.shipment.add.batch.json order.shipment.add.batch
Api2CartOpenApi.OrderApi orderShipmentDelete DELETE /order.shipment.delete.json order.shipment.delete
Api2CartOpenApi.OrderApi orderShipmentInfo GET /order.shipment.info.json order.shipment.info
Api2CartOpenApi.OrderApi orderShipmentList GET /order.shipment.list.json order.shipment.list
Api2CartOpenApi.OrderApi orderShipmentTrackingAdd POST /order.shipment.tracking.add.json order.shipment.tracking.add
Api2CartOpenApi.OrderApi orderShipmentUpdate PUT /order.shipment.update.json order.shipment.update
Api2CartOpenApi.OrderApi orderStatusList GET /order.status.list.json order.status.list
Api2CartOpenApi.OrderApi orderTransactionList GET /order.transaction.list.json order.transaction.list
Api2CartOpenApi.OrderApi orderUpdate PUT /order.update.json order.update
Api2CartOpenApi.ProductApi productAdd POST /product.add.json product.add
Api2CartOpenApi.ProductApi productAddBatch POST /product.add.batch.json product.add.batch
Api2CartOpenApi.ProductApi productAttributeList GET /product.attribute.list.json product.attribute.list
Api2CartOpenApi.ProductApi productAttributeValueSet POST /product.attribute.value.set.json product.attribute.value.set
Api2CartOpenApi.ProductApi productAttributeValueUnset POST /product.attribute.value.unset.json product.attribute.value.unset
Api2CartOpenApi.ProductApi productBrandList GET /product.brand.list.json product.brand.list
Api2CartOpenApi.ProductApi productChildItemFind GET /product.child_item.find.json product.child_item.find
Api2CartOpenApi.ProductApi productChildItemInfo GET /product.child_item.info.json product.child_item.info
Api2CartOpenApi.ProductApi productChildItemList GET /product.child_item.list.json product.child_item.list
Api2CartOpenApi.ProductApi productCount GET /product.count.json product.count
Api2CartOpenApi.ProductApi productCurrencyAdd POST /product.currency.add.json product.currency.add
Api2CartOpenApi.ProductApi productCurrencyList GET /product.currency.list.json product.currency.list
Api2CartOpenApi.ProductApi productDelete DELETE /product.delete.json product.delete
Api2CartOpenApi.ProductApi productDeleteBatch POST /product.delete.batch.json product.delete.batch
Api2CartOpenApi.ProductApi productFind GET /product.find.json product.find
Api2CartOpenApi.ProductApi productImageAdd POST /product.image.add.json product.image.add
Api2CartOpenApi.ProductApi productImageDelete DELETE /product.image.delete.json product.image.delete
Api2CartOpenApi.ProductApi productImageUpdate PUT /product.image.update.json product.image.update
Api2CartOpenApi.ProductApi productInfo GET /product.info.json product.info
Api2CartOpenApi.ProductApi productList GET /product.list.json product.list
Api2CartOpenApi.ProductApi productManufacturerAdd POST /product.manufacturer.add.json product.manufacturer.add
Api2CartOpenApi.ProductApi productOptionAdd POST /product.option.add.json product.option.add
Api2CartOpenApi.ProductApi productOptionAssign POST /product.option.assign.json product.option.assign
Api2CartOpenApi.ProductApi productOptionDelete DELETE /product.option.delete.json product.option.delete
Api2CartOpenApi.ProductApi productOptionList GET /product.option.list.json product.option.list
Api2CartOpenApi.ProductApi productOptionValueAdd POST /product.option.value.add.json product.option.value.add
Api2CartOpenApi.ProductApi productOptionValueAssign POST /product.option.value.assign.json product.option.value.assign
Api2CartOpenApi.ProductApi productOptionValueDelete DELETE /product.option.value.delete.json product.option.value.delete
Api2CartOpenApi.ProductApi productOptionValueUpdate PUT /product.option.value.update.json product.option.value.update
Api2CartOpenApi.ProductApi productPriceAdd POST /product.price.add.json product.price.add
Api2CartOpenApi.ProductApi productPriceDelete DELETE /product.price.delete.json product.price.delete
Api2CartOpenApi.ProductApi productPriceUpdate PUT /product.price.update.json product.price.update
Api2CartOpenApi.ProductApi productReviewList GET /product.review.list.json product.review.list
Api2CartOpenApi.ProductApi productStoreAssign POST /product.store.assign.json product.store.assign
Api2CartOpenApi.ProductApi productTaxAdd POST /product.tax.add.json product.tax.add
Api2CartOpenApi.ProductApi productUpdate PUT /product.update.json product.update
Api2CartOpenApi.ProductApi productUpdateBatch POST /product.update.batch.json product.update.batch
Api2CartOpenApi.ProductApi productVariantAdd POST /product.variant.add.json product.variant.add
Api2CartOpenApi.ProductApi productVariantAddBatch POST /product.variant.add.batch.json product.variant.add.batch
Api2CartOpenApi.ProductApi productVariantDelete DELETE /product.variant.delete.json product.variant.delete
Api2CartOpenApi.ProductApi productVariantDeleteBatch POST /product.variant.delete.batch.json product.variant.delete.batch
Api2CartOpenApi.ProductApi productVariantImageAdd POST /product.variant.image.add.json product.variant.image.add
Api2CartOpenApi.ProductApi productVariantImageDelete DELETE /product.variant.image.delete.json product.variant.image.delete
Api2CartOpenApi.ProductApi productVariantPriceAdd POST /product.variant.price.add.json product.variant.price.add
Api2CartOpenApi.ProductApi productVariantPriceDelete DELETE /product.variant.price.delete.json product.variant.price.delete
Api2CartOpenApi.ProductApi productVariantPriceUpdate PUT /product.variant.price.update.json product.variant.price.update
Api2CartOpenApi.ProductApi productVariantUpdate PUT /product.variant.update.json product.variant.update
Api2CartOpenApi.ProductApi productVariantUpdateBatch POST /product.variant.update.batch.json product.variant.update.batch
Api2CartOpenApi.ReturnApi returnActionList GET /return.action.list.json return.action.list
Api2CartOpenApi.ReturnApi returnCount GET /return.count.json return.count
Api2CartOpenApi.ReturnApi returnInfo GET /return.info.json return.info
Api2CartOpenApi.ReturnApi returnList GET /return.list.json return.list
Api2CartOpenApi.ReturnApi returnReasonList GET /return.reason.list.json return.reason.list
Api2CartOpenApi.ReturnApi returnStatusList GET /return.status.list.json return.status.list
Api2CartOpenApi.SubscriberApi subscriberList GET /subscriber.list.json subscriber.list
Api2CartOpenApi.TaxApi taxClassInfo GET /tax.class.info.json tax.class.info
Api2CartOpenApi.TaxApi taxClassList GET /tax.class.list.json tax.class.list
Api2CartOpenApi.WebhookApi webhookCount GET /webhook.count.json webhook.count
Api2CartOpenApi.WebhookApi webhookCreate POST /webhook.create.json webhook.create
Api2CartOpenApi.WebhookApi webhookDelete DELETE /webhook.delete.json webhook.delete
Api2CartOpenApi.WebhookApi webhookEvents GET /webhook.events.json webhook.events
Api2CartOpenApi.WebhookApi webhookList GET /webhook.list.json webhook.list
Api2CartOpenApi.WebhookApi webhookUpdate PUT /webhook.update.json webhook.update

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

ApiKeyAuth

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

StoreKeyAuth

  • Type: API key
  • API key parameter name: x-store-key
  • Location: HTTP header

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages