Skip to content

api2cart/c-sdk

Repository files navigation

C API client for api2cart_openapi

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI spec from a remote server, you can easily generate an API client.

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

Installation

You'll need the curl 7.58.0 package in order to build the API. To have code formatted nicely, you also need to have uncrustify version 0.67 or later.

Prerequisites

Install the curl 7.58.0 package with the following command on Linux.

sudo apt remove curl
wget http://curl.haxx.se/download/curl-7.58.0.tar.gz
tar -xvf curl-7.58.0.tar.gz
cd curl-7.58.0/
./configure
make
sudo make install

Install the uncrustify 0.67 package with the following command on Linux.

git clone https://github.com/uncrustify/uncrustify.git
cd uncrustify
mkdir build
cd build
cmake ..
make
sudo make install

Compile the sample:

This will compile the generated code and create a library in the build folder which has to be linked to the codes where API will be used.

mkdir build
cd build
// To install library to specific location, use following commands
cmake -DCMAKE_INSTALL_PREFIX=/pathtolocation ..
// for normal install use following command
cmake ..
make
sudo make install

How to use compiled library

Considering the test/source code which uses the API is written in main.c(respective api include is written and all objects necessary are defined and created)

To compile main.c(considering the file is present in build folder) use following command -L - location of the library(not required if cmake with normal installation is performed) -l library name

gcc main.c -L. -lapi2cart_openapi -o main

Once compiled, you can run it with ./main

Note: You don't need to specify includes for models and include folder separately as they are path linked. You just have to import the api.h file in your code, the include linking will work.

Documentation for API Endpoints

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

Category Method HTTP request Description
AccountAPI AccountAPI_accountCartAdd POST /account.cart.add.json account.cart.add
AccountAPI AccountAPI_accountCartList GET /account.cart.list.json account.cart.list
AccountAPI AccountAPI_accountConfigUpdate PUT /account.config.update.json account.config.update
AccountAPI AccountAPI_accountFailedWebhooks GET /account.failed_webhooks.json account.failed_webhooks
AccountAPI AccountAPI_accountSupportedPlatforms GET /account.supported_platforms.json account.supported_platforms
AttributeAPI AttributeAPI_attributeAdd POST /attribute.add.json attribute.add
AttributeAPI AttributeAPI_attributeAssignGroup POST /attribute.assign.group.json attribute.assign.group
AttributeAPI AttributeAPI_attributeAssignSet POST /attribute.assign.set.json attribute.assign.set
AttributeAPI AttributeAPI_attributeAttributesetList GET /attribute.attributeset.list.json attribute.attributeset.list
AttributeAPI AttributeAPI_attributeCount GET /attribute.count.json attribute.count
AttributeAPI AttributeAPI_attributeDelete DELETE /attribute.delete.json attribute.delete
AttributeAPI AttributeAPI_attributeGroupList GET /attribute.group.list.json attribute.group.list
AttributeAPI AttributeAPI_attributeInfo GET /attribute.info.json attribute.info
AttributeAPI AttributeAPI_attributeList GET /attribute.list.json attribute.list
AttributeAPI AttributeAPI_attributeTypeList GET /attribute.type.list.json attribute.type.list
AttributeAPI AttributeAPI_attributeUnassignGroup POST /attribute.unassign.group.json attribute.unassign.group
AttributeAPI AttributeAPI_attributeUnassignSet POST /attribute.unassign.set.json attribute.unassign.set
AttributeAPI AttributeAPI_attributeUpdate PUT /attribute.update.json attribute.update
AttributeAPI AttributeAPI_attributeValueAdd POST /attribute.value.add.json attribute.value.add
AttributeAPI AttributeAPI_attributeValueDelete DELETE /attribute.value.delete.json attribute.value.delete
AttributeAPI AttributeAPI_attributeValueUpdate PUT /attribute.value.update.json attribute.value.update
BasketAPI BasketAPI_basketInfo GET /basket.info.json basket.info
BasketAPI BasketAPI_basketItemAdd POST /basket.item.add.json basket.item.add
BasketAPI BasketAPI_basketLiveShippingServiceCreate POST /basket.live_shipping_service.create.json basket.live_shipping_service.create
BasketAPI BasketAPI_basketLiveShippingServiceDelete DELETE /basket.live_shipping_service.delete.json basket.live_shipping_service.delete
BasketAPI BasketAPI_basketLiveShippingServiceList GET /basket.live_shipping_service.list.json basket.live_shipping_service.list
BatchAPI BatchAPI_batchJobList GET /batch.job.list.json batch.job.list
BatchAPI BatchAPI_batchJobResult GET /batch.job.result.json batch.job.result
BridgeAPI BridgeAPI_bridgeDelete POST /bridge.delete.json bridge.delete
BridgeAPI BridgeAPI_bridgeDownload GET /bridge.download.file bridge.download
BridgeAPI BridgeAPI_bridgeUpdate POST /bridge.update.json bridge.update
CartAPI CartAPI_cartCatalogPriceRulesCount GET /cart.catalog_price_rules.count.json cart.catalog_price_rules.count
CartAPI CartAPI_cartCatalogPriceRulesList GET /cart.catalog_price_rules.list.json cart.catalog_price_rules.list
CartAPI CartAPI_cartCouponAdd POST /cart.coupon.add.json cart.coupon.add
CartAPI CartAPI_cartCouponConditionAdd POST /cart.coupon.condition.add.json cart.coupon.condition.add
CartAPI CartAPI_cartCouponCount GET /cart.coupon.count.json cart.coupon.count
CartAPI CartAPI_cartCouponDelete DELETE /cart.coupon.delete.json cart.coupon.delete
CartAPI CartAPI_cartCouponList GET /cart.coupon.list.json cart.coupon.list
CartAPI CartAPI_cartDelete DELETE /cart.delete.json cart.delete
CartAPI CartAPI_cartGiftcardAdd POST /cart.giftcard.add.json cart.giftcard.add
CartAPI CartAPI_cartGiftcardCount GET /cart.giftcard.count.json cart.giftcard.count
CartAPI CartAPI_cartGiftcardDelete DELETE /cart.giftcard.delete.json cart.giftcard.delete
CartAPI CartAPI_cartGiftcardList GET /cart.giftcard.list.json cart.giftcard.list
CartAPI CartAPI_cartInfo GET /cart.info.json cart.info
CartAPI CartAPI_cartMetaDataList GET /cart.meta_data.list.json cart.meta_data.list
CartAPI CartAPI_cartMetaDataSet POST /cart.meta_data.set.json cart.meta_data.set
CartAPI CartAPI_cartMetaDataUnset DELETE /cart.meta_data.unset.json cart.meta_data.unset
CartAPI CartAPI_cartMethods GET /cart.methods.json cart.methods
CartAPI CartAPI_cartPluginList GET /cart.plugin.list.json cart.plugin.list
CartAPI CartAPI_cartScriptAdd POST /cart.script.add.json cart.script.add
CartAPI CartAPI_cartScriptDelete DELETE /cart.script.delete.json cart.script.delete
CartAPI CartAPI_cartScriptList GET /cart.script.list.json cart.script.list
CartAPI CartAPI_cartShippingZonesList GET /cart.shipping_zones.list.json cart.shipping_zones.list
CartAPI CartAPI_cartValidate GET /cart.validate.json cart.validate
CategoryAPI CategoryAPI_categoryAdd POST /category.add.json category.add
CategoryAPI CategoryAPI_categoryAddBatch POST /category.add.batch.json category.add.batch
CategoryAPI CategoryAPI_categoryAssign POST /category.assign.json category.assign
CategoryAPI CategoryAPI_categoryCount GET /category.count.json category.count
CategoryAPI CategoryAPI_categoryDelete DELETE /category.delete.json category.delete
CategoryAPI CategoryAPI_categoryFind GET /category.find.json category.find
CategoryAPI CategoryAPI_categoryImageAdd POST /category.image.add.json category.image.add
CategoryAPI CategoryAPI_categoryImageDelete DELETE /category.image.delete.json category.image.delete
CategoryAPI CategoryAPI_categoryInfo GET /category.info.json category.info
CategoryAPI CategoryAPI_categoryList GET /category.list.json category.list
CategoryAPI CategoryAPI_categoryUnassign POST /category.unassign.json category.unassign
CategoryAPI CategoryAPI_categoryUpdate PUT /category.update.json category.update
CustomerAPI CustomerAPI_customerAdd POST /customer.add.json customer.add
CustomerAPI CustomerAPI_customerAddressAdd POST /customer.address.add.json customer.address.add
CustomerAPI CustomerAPI_customerAttributeList GET /customer.attribute.list.json customer.attribute.list
CustomerAPI CustomerAPI_customerCount GET /customer.count.json customer.count
CustomerAPI CustomerAPI_customerDelete DELETE /customer.delete.json customer.delete
CustomerAPI CustomerAPI_customerFind GET /customer.find.json customer.find
CustomerAPI CustomerAPI_customerGroupAdd POST /customer.group.add.json customer.group.add
CustomerAPI CustomerAPI_customerGroupList GET /customer.group.list.json customer.group.list
CustomerAPI CustomerAPI_customerInfo GET /customer.info.json customer.info
CustomerAPI CustomerAPI_customerList GET /customer.list.json customer.list
CustomerAPI CustomerAPI_customerUpdate PUT /customer.update.json customer.update
CustomerAPI CustomerAPI_customerWishlistList GET /customer.wishlist.list.json customer.wishlist.list
MarketplaceAPI MarketplaceAPI_marketplaceProductFind GET /marketplace.product.find.json marketplace.product.find
OrderAPI OrderAPI_orderAbandonedList GET /order.abandoned.list.json order.abandoned.list
OrderAPI OrderAPI_orderAdd POST /order.add.json order.add
OrderAPI OrderAPI_orderCalculate POST /order.calculate.json order.calculate
OrderAPI OrderAPI_orderCount GET /order.count.json order.count
OrderAPI OrderAPI_orderFinancialStatusList GET /order.financial_status.list.json order.financial_status.list
OrderAPI OrderAPI_orderFulfillmentStatusList GET /order.fulfillment_status.list.json order.fulfillment_status.list
OrderAPI OrderAPI_orderInfo GET /order.info.json order.info
OrderAPI OrderAPI_orderList GET /order.list.json order.list
OrderAPI OrderAPI_orderPreestimateShippingList POST /order.preestimate_shipping.list.json order.preestimate_shipping.list
OrderAPI OrderAPI_orderRefundAdd POST /order.refund.add.json order.refund.add
OrderAPI OrderAPI_orderReturnAdd POST /order.return.add.json order.return.add
OrderAPI OrderAPI_orderReturnDelete DELETE /order.return.delete.json order.return.delete
OrderAPI OrderAPI_orderReturnUpdate PUT /order.return.update.json order.return.update
OrderAPI OrderAPI_orderShipmentAdd POST /order.shipment.add.json order.shipment.add
OrderAPI OrderAPI_orderShipmentAddBatch POST /order.shipment.add.batch.json order.shipment.add.batch
OrderAPI OrderAPI_orderShipmentDelete DELETE /order.shipment.delete.json order.shipment.delete
OrderAPI OrderAPI_orderShipmentInfo GET /order.shipment.info.json order.shipment.info
OrderAPI OrderAPI_orderShipmentList GET /order.shipment.list.json order.shipment.list
OrderAPI OrderAPI_orderShipmentTrackingAdd POST /order.shipment.tracking.add.json order.shipment.tracking.add
OrderAPI OrderAPI_orderShipmentUpdate PUT /order.shipment.update.json order.shipment.update
OrderAPI OrderAPI_orderStatusList GET /order.status.list.json order.status.list
OrderAPI OrderAPI_orderTransactionList GET /order.transaction.list.json order.transaction.list
OrderAPI OrderAPI_orderUpdate PUT /order.update.json order.update
ProductAPI ProductAPI_productAdd POST /product.add.json product.add
ProductAPI ProductAPI_productAddBatch POST /product.add.batch.json product.add.batch
ProductAPI ProductAPI_productAttributeList GET /product.attribute.list.json product.attribute.list
ProductAPI ProductAPI_productAttributeValueSet POST /product.attribute.value.set.json product.attribute.value.set
ProductAPI ProductAPI_productAttributeValueUnset POST /product.attribute.value.unset.json product.attribute.value.unset
ProductAPI ProductAPI_productBrandList GET /product.brand.list.json product.brand.list
ProductAPI ProductAPI_productChildItemFind GET /product.child_item.find.json product.child_item.find
ProductAPI ProductAPI_productChildItemInfo GET /product.child_item.info.json product.child_item.info
ProductAPI ProductAPI_productChildItemList GET /product.child_item.list.json product.child_item.list
ProductAPI ProductAPI_productCount GET /product.count.json product.count
ProductAPI ProductAPI_productCurrencyAdd POST /product.currency.add.json product.currency.add
ProductAPI ProductAPI_productCurrencyList GET /product.currency.list.json product.currency.list
ProductAPI ProductAPI_productDelete DELETE /product.delete.json product.delete
ProductAPI ProductAPI_productDeleteBatch POST /product.delete.batch.json product.delete.batch
ProductAPI ProductAPI_productFind GET /product.find.json product.find
ProductAPI ProductAPI_productImageAdd POST /product.image.add.json product.image.add
ProductAPI ProductAPI_productImageDelete DELETE /product.image.delete.json product.image.delete
ProductAPI ProductAPI_productImageUpdate PUT /product.image.update.json product.image.update
ProductAPI ProductAPI_productInfo GET /product.info.json product.info
ProductAPI ProductAPI_productList GET /product.list.json product.list
ProductAPI ProductAPI_productManufacturerAdd POST /product.manufacturer.add.json product.manufacturer.add
ProductAPI ProductAPI_productOptionAdd POST /product.option.add.json product.option.add
ProductAPI ProductAPI_productOptionAssign POST /product.option.assign.json product.option.assign
ProductAPI ProductAPI_productOptionDelete DELETE /product.option.delete.json product.option.delete
ProductAPI ProductAPI_productOptionList GET /product.option.list.json product.option.list
ProductAPI ProductAPI_productOptionValueAdd POST /product.option.value.add.json product.option.value.add
ProductAPI ProductAPI_productOptionValueAssign POST /product.option.value.assign.json product.option.value.assign
ProductAPI ProductAPI_productOptionValueDelete DELETE /product.option.value.delete.json product.option.value.delete
ProductAPI ProductAPI_productOptionValueUpdate PUT /product.option.value.update.json product.option.value.update
ProductAPI ProductAPI_productPriceAdd POST /product.price.add.json product.price.add
ProductAPI ProductAPI_productPriceDelete DELETE /product.price.delete.json product.price.delete
ProductAPI ProductAPI_productPriceUpdate PUT /product.price.update.json product.price.update
ProductAPI ProductAPI_productReviewList GET /product.review.list.json product.review.list
ProductAPI ProductAPI_productStoreAssign POST /product.store.assign.json product.store.assign
ProductAPI ProductAPI_productTaxAdd POST /product.tax.add.json product.tax.add
ProductAPI ProductAPI_productUpdate PUT /product.update.json product.update
ProductAPI ProductAPI_productUpdateBatch POST /product.update.batch.json product.update.batch
ProductAPI ProductAPI_productVariantAdd POST /product.variant.add.json product.variant.add
ProductAPI ProductAPI_productVariantAddBatch POST /product.variant.add.batch.json product.variant.add.batch
ProductAPI ProductAPI_productVariantDelete DELETE /product.variant.delete.json product.variant.delete
ProductAPI ProductAPI_productVariantDeleteBatch POST /product.variant.delete.batch.json product.variant.delete.batch
ProductAPI ProductAPI_productVariantImageAdd POST /product.variant.image.add.json product.variant.image.add
ProductAPI ProductAPI_productVariantImageDelete DELETE /product.variant.image.delete.json product.variant.image.delete
ProductAPI ProductAPI_productVariantPriceAdd POST /product.variant.price.add.json product.variant.price.add
ProductAPI ProductAPI_productVariantPriceDelete DELETE /product.variant.price.delete.json product.variant.price.delete
ProductAPI ProductAPI_productVariantPriceUpdate PUT /product.variant.price.update.json product.variant.price.update
ProductAPI ProductAPI_productVariantUpdate PUT /product.variant.update.json product.variant.update
ProductAPI ProductAPI_productVariantUpdateBatch POST /product.variant.update.batch.json product.variant.update.batch
ReturnAPI ReturnAPI_returnActionList GET /return.action.list.json return.action.list
ReturnAPI ReturnAPI_returnCount GET /return.count.json return.count
ReturnAPI ReturnAPI_returnInfo GET /return.info.json return.info
ReturnAPI ReturnAPI_returnList GET /return.list.json return.list
ReturnAPI ReturnAPI_returnReasonList GET /return.reason.list.json return.reason.list
ReturnAPI ReturnAPI_returnStatusList GET /return.status.list.json return.status.list
SubscriberAPI SubscriberAPI_subscriberList GET /subscriber.list.json subscriber.list
TaxAPI TaxAPI_taxClassInfo GET /tax.class.info.json tax.class.info
TaxAPI TaxAPI_taxClassList GET /tax.class.list.json tax.class.list
WebhookAPI WebhookAPI_webhookCount GET /webhook.count.json webhook.count
WebhookAPI WebhookAPI_webhookCreate POST /webhook.create.json webhook.create
WebhookAPI WebhookAPI_webhookDelete DELETE /webhook.delete.json webhook.delete
WebhookAPI WebhookAPI_webhookEvents GET /webhook.events.json webhook.events
WebhookAPI WebhookAPI_webhookList GET /webhook.list.json webhook.list
WebhookAPI 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

Author

contact@api2cart.com

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors