Skip to content

api2cart/powershell-sdk

BranchesTags

Repository files navigation

PSOpenAPITools - the PowerShell module for the API2Cart OpenAPI

API2Cart

This PowerShell module is automatically generated by the OpenAPI Generator project:

  • API version: 1.1
  • SDK version: 0.1.2
  • Generator version: 7.11.0
  • Build package: org.openapitools.codegen.languages.PowerShellClientCodegen

Frameworks supported

  • PowerShell 6.2 or later

Dependencies

Installation

To install from the source, run the following command to build and install the PowerShell module locally:

Build.ps1
Import-Module -Name '.\src\PSOpenAPITools' -Verbose

To avoid function name collision, one can use -Prefix, e.g. Import-Module -Name '.\src\PSOpenAPITools' -Prefix prefix

To uninstall the module, simply run:

Remove-Module -FullyQualifiedName @{ModuleName = "PSOpenAPITools"; ModuleVersion = "0.1.2"}

Tests

To install and run Pester, please execute the following commands in the terminal:

Install-module -name Pester -force

Invoke-Pester

For troubleshooting, please run $DebugPreference = 'Continue' to turn on debugging and disable it with $DebugPreference = 'SilentlyContinue' when done with the troubleshooting.

Documentation for API Endpoints

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

Class Method HTTP request Description
AccountApi Invoke-AccountCartAdd POST /account.cart.add.json account.cart.add
AccountApi Invoke-AccountCartList GET /account.cart.list.json account.cart.list
AccountApi Invoke-AccountConfigUpdate PUT /account.config.update.json account.config.update
AccountApi Invoke-AccountFailedWebhooks GET /account.failed_webhooks.json account.failed_webhooks
AccountApi Invoke-AccountSupportedPlatforms GET /account.supported_platforms.json account.supported_platforms
AttributeApi Invoke-AttributeAdd POST /attribute.add.json attribute.add
AttributeApi Invoke-AttributeAssignGroup POST /attribute.assign.group.json attribute.assign.group
AttributeApi Invoke-AttributeAssignSet POST /attribute.assign.set.json attribute.assign.set
AttributeApi Invoke-AttributeAttributesetList GET /attribute.attributeset.list.json attribute.attributeset.list
AttributeApi Invoke-AttributeCount GET /attribute.count.json attribute.count
AttributeApi Invoke-AttributeDelete DELETE /attribute.delete.json attribute.delete
AttributeApi Invoke-AttributeGroupList GET /attribute.group.list.json attribute.group.list
AttributeApi Invoke-AttributeInfo GET /attribute.info.json attribute.info
AttributeApi Invoke-AttributeList GET /attribute.list.json attribute.list
AttributeApi Invoke-AttributeTypeList GET /attribute.type.list.json attribute.type.list
AttributeApi Invoke-AttributeUnassignGroup POST /attribute.unassign.group.json attribute.unassign.group
AttributeApi Invoke-AttributeUnassignSet POST /attribute.unassign.set.json attribute.unassign.set
AttributeApi Invoke-AttributeUpdate PUT /attribute.update.json attribute.update
AttributeApi Invoke-AttributeValueAdd POST /attribute.value.add.json attribute.value.add
AttributeApi Invoke-AttributeValueDelete DELETE /attribute.value.delete.json attribute.value.delete
AttributeApi Invoke-AttributeValueUpdate PUT /attribute.value.update.json attribute.value.update
BasketApi Invoke-BasketInfo GET /basket.info.json basket.info
BasketApi Invoke-BasketItemAdd POST /basket.item.add.json basket.item.add
BasketApi Invoke-BasketLiveShippingServiceCreate POST /basket.live_shipping_service.create.json basket.live_shipping_service.create
BasketApi Invoke-BasketLiveShippingServiceDelete DELETE /basket.live_shipping_service.delete.json basket.live_shipping_service.delete
BasketApi Invoke-BasketLiveShippingServiceList GET /basket.live_shipping_service.list.json basket.live_shipping_service.list
BatchApi Invoke-BatchJobList GET /batch.job.list.json batch.job.list
BatchApi Invoke-BatchJobResult GET /batch.job.result.json batch.job.result
BridgeApi Invoke-BridgeDelete POST /bridge.delete.json bridge.delete
BridgeApi Invoke-BridgeDownload GET /bridge.download.file bridge.download
BridgeApi Invoke-BridgeUpdate POST /bridge.update.json bridge.update
CartApi Invoke-CartCatalogPriceRulesCount GET /cart.catalog_price_rules.count.json cart.catalog_price_rules.count
CartApi Invoke-CartCatalogPriceRulesList GET /cart.catalog_price_rules.list.json cart.catalog_price_rules.list
CartApi Invoke-CartCouponAdd POST /cart.coupon.add.json cart.coupon.add
CartApi Invoke-CartCouponConditionAdd POST /cart.coupon.condition.add.json cart.coupon.condition.add
CartApi Invoke-CartCouponCount GET /cart.coupon.count.json cart.coupon.count
CartApi Invoke-CartCouponDelete DELETE /cart.coupon.delete.json cart.coupon.delete
CartApi Invoke-CartCouponList GET /cart.coupon.list.json cart.coupon.list
CartApi Invoke-CartDelete DELETE /cart.delete.json cart.delete
CartApi Invoke-CartGiftcardAdd POST /cart.giftcard.add.json cart.giftcard.add
CartApi Invoke-CartGiftcardCount GET /cart.giftcard.count.json cart.giftcard.count
CartApi Invoke-CartGiftcardDelete DELETE /cart.giftcard.delete.json cart.giftcard.delete
CartApi Invoke-CartGiftcardList GET /cart.giftcard.list.json cart.giftcard.list
CartApi Invoke-CartInfo GET /cart.info.json cart.info
CartApi Invoke-CartMetaDataList GET /cart.meta_data.list.json cart.meta_data.list
CartApi Invoke-CartMetaDataSet POST /cart.meta_data.set.json cart.meta_data.set
CartApi Invoke-CartMetaDataUnset DELETE /cart.meta_data.unset.json cart.meta_data.unset
CartApi Invoke-CartMethods GET /cart.methods.json cart.methods
CartApi Invoke-CartPluginList GET /cart.plugin.list.json cart.plugin.list
CartApi Invoke-CartScriptAdd POST /cart.script.add.json cart.script.add
CartApi Invoke-CartScriptDelete DELETE /cart.script.delete.json cart.script.delete
CartApi Invoke-CartScriptList GET /cart.script.list.json cart.script.list
CartApi Invoke-CartShippingZonesList GET /cart.shipping_zones.list.json cart.shipping_zones.list
CartApi Invoke-CartValidate GET /cart.validate.json cart.validate
CategoryApi Get-egoryAdd POST /category.add.json category.add
CategoryApi Get-egoryAddBatch POST /category.add.batch.json category.add.batch
CategoryApi Get-egoryAssign POST /category.assign.json category.assign
CategoryApi Get-egoryCount GET /category.count.json category.count
CategoryApi Get-egoryDelete DELETE /category.delete.json category.delete
CategoryApi Get-egoryFind GET /category.find.json category.find
CategoryApi Get-egoryImageAdd POST /category.image.add.json category.image.add
CategoryApi Get-egoryImageDelete DELETE /category.image.delete.json category.image.delete
CategoryApi Get-egoryInfo GET /category.info.json category.info
CategoryApi Get-egoryList GET /category.list.json category.list
CategoryApi Get-egoryUnassign POST /category.unassign.json category.unassign
CategoryApi Get-egoryUpdate PUT /category.update.json category.update
CustomerApi Invoke-CustomerAdd POST /customer.add.json customer.add
CustomerApi Invoke-CustomerAddressAdd POST /customer.address.add.json customer.address.add
CustomerApi Invoke-CustomerAttributeList GET /customer.attribute.list.json customer.attribute.list
CustomerApi Invoke-CustomerCount GET /customer.count.json customer.count
CustomerApi Invoke-CustomerDelete DELETE /customer.delete.json customer.delete
CustomerApi Invoke-CustomerFind GET /customer.find.json customer.find
CustomerApi Invoke-CustomerGroupAdd POST /customer.group.add.json customer.group.add
CustomerApi Invoke-CustomerGroupList GET /customer.group.list.json customer.group.list
CustomerApi Invoke-CustomerInfo GET /customer.info.json customer.info
CustomerApi Invoke-CustomerList GET /customer.list.json customer.list
CustomerApi Invoke-CustomerUpdate PUT /customer.update.json customer.update
CustomerApi Invoke-CustomerWishlistList GET /customer.wishlist.list.json customer.wishlist.list
MarketplaceApi Invoke-MarketplaceProductFind GET /marketplace.product.find.json marketplace.product.find
OrderApi Invoke-OrderAbandonedList GET /order.abandoned.list.json order.abandoned.list
OrderApi Invoke-OrderAdd POST /order.add.json order.add
OrderApi Invoke-OrderCalculate POST /order.calculate.json order.calculate
OrderApi Invoke-OrderCount GET /order.count.json order.count
OrderApi Invoke-OrderFinancialStatusList GET /order.financial_status.list.json order.financial_status.list
OrderApi Invoke-OrderFulfillmentStatusList GET /order.fulfillment_status.list.json order.fulfillment_status.list
OrderApi Invoke-OrderInfo GET /order.info.json order.info
OrderApi Invoke-OrderList GET /order.list.json order.list
OrderApi Invoke-OrderPreestimateShippingList POST /order.preestimate_shipping.list.json order.preestimate_shipping.list
OrderApi Invoke-OrderRefundAdd POST /order.refund.add.json order.refund.add
OrderApi Invoke-OrderReturnAdd POST /order.return.add.json order.return.add
OrderApi Invoke-OrderReturnDelete DELETE /order.return.delete.json order.return.delete
OrderApi Invoke-OrderReturnUpdate PUT /order.return.update.json order.return.update
OrderApi Invoke-OrderShipmentAdd POST /order.shipment.add.json order.shipment.add
OrderApi Invoke-OrderShipmentAddBatch POST /order.shipment.add.batch.json order.shipment.add.batch
OrderApi Invoke-OrderShipmentDelete DELETE /order.shipment.delete.json order.shipment.delete
OrderApi Invoke-OrderShipmentInfo GET /order.shipment.info.json order.shipment.info
OrderApi Invoke-OrderShipmentList GET /order.shipment.list.json order.shipment.list
OrderApi Invoke-OrderShipmentTrackingAdd POST /order.shipment.tracking.add.json order.shipment.tracking.add
OrderApi Invoke-OrderShipmentUpdate PUT /order.shipment.update.json order.shipment.update
OrderApi Invoke-OrderStatusList GET /order.status.list.json order.status.list
OrderApi Invoke-OrderTransactionList GET /order.transaction.list.json order.transaction.list
OrderApi Invoke-OrderUpdate PUT /order.update.json order.update
ProductApi Invoke-ProductAdd POST /product.add.json product.add
ProductApi Invoke-ProductAddBatch POST /product.add.batch.json product.add.batch
ProductApi Invoke-ProductAttributeList GET /product.attribute.list.json product.attribute.list
ProductApi Invoke-ProductAttributeValueSet POST /product.attribute.value.set.json product.attribute.value.set
ProductApi Invoke-ProductAttributeValueUnset POST /product.attribute.value.unset.json product.attribute.value.unset
ProductApi Invoke-ProductBrandList GET /product.brand.list.json product.brand.list
ProductApi Invoke-ProductChildItemFind GET /product.child_item.find.json product.child_item.find
ProductApi Invoke-ProductChildItemInfo GET /product.child_item.info.json product.child_item.info
ProductApi Invoke-ProductChildItemList GET /product.child_item.list.json product.child_item.list
ProductApi Invoke-ProductCount GET /product.count.json product.count
ProductApi Invoke-ProductCurrencyAdd POST /product.currency.add.json product.currency.add
ProductApi Invoke-ProductCurrencyList GET /product.currency.list.json product.currency.list
ProductApi Invoke-ProductDelete DELETE /product.delete.json product.delete
ProductApi Invoke-ProductDeleteBatch POST /product.delete.batch.json product.delete.batch
ProductApi Invoke-ProductFind GET /product.find.json product.find
ProductApi Invoke-ProductImageAdd POST /product.image.add.json product.image.add
ProductApi Invoke-ProductImageDelete DELETE /product.image.delete.json product.image.delete
ProductApi Invoke-ProductImageUpdate PUT /product.image.update.json product.image.update
ProductApi Invoke-ProductInfo GET /product.info.json product.info
ProductApi Invoke-ProductList GET /product.list.json product.list
ProductApi Invoke-ProductManufacturerAdd POST /product.manufacturer.add.json product.manufacturer.add
ProductApi Invoke-ProductOptionAdd POST /product.option.add.json product.option.add
ProductApi Invoke-ProductOptionAssign POST /product.option.assign.json product.option.assign
ProductApi Invoke-ProductOptionDelete DELETE /product.option.delete.json product.option.delete
ProductApi Invoke-ProductOptionList GET /product.option.list.json product.option.list
ProductApi Invoke-ProductOptionValueAdd POST /product.option.value.add.json product.option.value.add
ProductApi Invoke-ProductOptionValueAssign POST /product.option.value.assign.json product.option.value.assign
ProductApi Invoke-ProductOptionValueDelete DELETE /product.option.value.delete.json product.option.value.delete
ProductApi Invoke-ProductOptionValueUpdate PUT /product.option.value.update.json product.option.value.update
ProductApi Invoke-ProductPriceAdd POST /product.price.add.json product.price.add
ProductApi Invoke-ProductPriceDelete DELETE /product.price.delete.json product.price.delete
ProductApi Invoke-ProductPriceUpdate PUT /product.price.update.json product.price.update
ProductApi Invoke-ProductReviewList GET /product.review.list.json product.review.list
ProductApi Invoke-ProductStoreAssign POST /product.store.assign.json product.store.assign
ProductApi Invoke-ProductTaxAdd POST /product.tax.add.json product.tax.add
ProductApi Invoke-ProductUpdate PUT /product.update.json product.update
ProductApi Invoke-ProductUpdateBatch POST /product.update.batch.json product.update.batch
ProductApi Invoke-ProductVariantAdd POST /product.variant.add.json product.variant.add
ProductApi Invoke-ProductVariantAddBatch POST /product.variant.add.batch.json product.variant.add.batch
ProductApi Invoke-ProductVariantDelete DELETE /product.variant.delete.json product.variant.delete
ProductApi Invoke-ProductVariantDeleteBatch POST /product.variant.delete.batch.json product.variant.delete.batch
ProductApi Invoke-ProductVariantImageAdd POST /product.variant.image.add.json product.variant.image.add
ProductApi Invoke-ProductVariantImageDelete DELETE /product.variant.image.delete.json product.variant.image.delete
ProductApi Invoke-ProductVariantPriceAdd POST /product.variant.price.add.json product.variant.price.add
ProductApi Invoke-ProductVariantPriceDelete DELETE /product.variant.price.delete.json product.variant.price.delete
ProductApi Invoke-ProductVariantPriceUpdate PUT /product.variant.price.update.json product.variant.price.update
ProductApi Invoke-ProductVariantUpdate PUT /product.variant.update.json product.variant.update
ProductApi Invoke-ProductVariantUpdateBatch POST /product.variant.update.batch.json product.variant.update.batch
ReturnApi Invoke-ReturnActionList GET /return.action.list.json return.action.list
ReturnApi Invoke-ReturnCount GET /return.count.json return.count
ReturnApi Invoke-ReturnInfo GET /return.info.json return.info
ReturnApi Invoke-ReturnList GET /return.list.json return.list
ReturnApi Invoke-ReturnReasonList GET /return.reason.list.json return.reason.list
ReturnApi Invoke-ReturnStatusList GET /return.status.list.json return.status.list
SubscriberApi Invoke-SubscriberList GET /subscriber.list.json subscriber.list
TaxApi Invoke-TaxClassInfo GET /tax.class.info.json tax.class.info
TaxApi Invoke-TaxClassList GET /tax.class.list.json tax.class.list
WebhookApi Invoke-WebhookCount GET /webhook.count.json webhook.count
WebhookApi Invoke-WebhookCreate POST /webhook.create.json webhook.create
WebhookApi Invoke-WebhookDelete DELETE /webhook.delete.json webhook.delete
WebhookApi Invoke-WebhookEvents GET /webhook.events.json webhook.events
WebhookApi Invoke-WebhookList GET /webhook.list.json webhook.list
WebhookApi Invoke-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

api2cart-powershell-sdk.vercel.app

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages