woocommerce_client 1.0.6

Woocommerce Rest API Dart client package

woocommerce_client

A Dart package built using openapi. With further customization and changes to achieve ease of use and support for additional protocols such as http. All methods and types are implemented, enabling seamless integration with Dart applications.

• Woocommerce API v3
• HTTP and HTTPS support
• Null-Safety
• Supports all methods and models

Requirements

Dart 2.12 or later

Installation & Usage

Official repository

Include woocommerce_client in your pubspec.yaml file:

dependencies:
  woocommerce_client: ^1.0.6

Github

You can install this package using git like the following example:

dependencies:
  woocommerce_client:
    git: https://github.com/erfanshekari/woocommerce_client

Local

You can also clone this repository in your project and add it to your project like the following example:

dependencies:
  woocommerce_client:
    path: /path/to/woocommerce_client

Examples

Fetch products

import 'package:woocommerce_client/woocommerce_client.dart';

void main() async {
  final api = Woocommerce(
    baseURL: 'http://woocommerce.ir',
    consumerKey: 'consumer_key',
    consumerSecret: 'consumer_secret',
  );

  List<Product>? response = await api.productsGet(perPage: 10);

  print(response?.length);
}

Fetch customer by unique ID

import 'package:woocommerce_client/woocommerce_client.dart';

void main() async {

  final api = Woocommerce(
    baseURL: 'http://woocommerce.ir',
    consumerKey: 'consumer_key',
    consumerSecret: 'consumer_secret',
  );

  Customer? response = await api.customersIdGet(1);

}

Documentation For Models

• Customer
• Customer1
• Customer1Billing
• Customer1Shipping
• Customer2
• CustomerDownload
• CustomerDownloadFile
• DataContinents
• DataContinentsCountriesInner
• DataContinentsCountriesInnerStatesInner
• DataCountries
• DataCurrencies
• DataIndex
• OrderNote
• OrderNote1
• PaymentGateway
• PaymentGateway1
• PaymentGateway1Settings
• Product
• Product1
• Product1AttributesInner
• Product1CategoriesInner
• Product1DefaultAttributesInner
• Product1Dimensions
• Product1DownloadsInner
• Product1ImagesInner
• Product1TagsInner
• ProductAttribute
• ProductAttribute1
• ProductAttribute2
• ProductAttributeTerm
• ProductAttributeTerm1
• ProductAttributeTerm2
• ProductCat
• ProductCat1
• ProductCat1Image
• ProductCat2
• ProductReview
• ProductReview1
• ProductReview2
• ProductReviewReviewerAvatarUrls
• ProductShippingClass
• ProductShippingClass1
• ProductShippingClass2
• ProductTag
• ProductTag1
• ProductTag2
• ProductVariation
• ProductVariation1
• ProductVariation1Dimensions
• ProductVariation1Image
• Report
• ReportCouponTotal
• ReportCustomerTotal
• ReportOrderTotal
• ReportProductTotal
• ReportReviewTotal
• SalesReport
• Setting
• SettingGroup
• ShippingMethod
• ShippingZone
• ShippingZone1
• ShippingZoneLocation
• ShippingZoneLocation1
• ShippingZoneMethod
• ShippingZoneMethod1
• ShippingZoneMethod1Settings
• ShippingZoneMethod2
• ShopCoupon
• ShopCoupon1
• ShopCoupon1MetaDataInner
• ShopOrder
• ShopOrder1
• ShopOrder1Billing
• ShopOrder1CouponLinesInner
• ShopOrder1FeeLinesInner
• ShopOrder1LineItemsInner
• ShopOrder1LineItemsInnerMetaDataInner
• ShopOrder1LineItemsInnerTaxesInner
• ShopOrder1Shipping
• ShopOrder1ShippingLinesInner
• ShopOrder1ShippingLinesInnerTaxesInner
• ShopOrderRefund
• ShopOrderRefund1
• ShopOrderRefundLineItemsInner
• ShopOrderRefundLineItemsInnerTaxesInner
• ShopOrderRefundsInner
• ShopOrderTaxLinesInner
• SystemStatus
• SystemStatusDatabase
• SystemStatusEnvironment
• SystemStatusSecurity
• SystemStatusSettings
• SystemStatusTheme
• SystemStatusTool
• SystemStatusTool1
• Tax
• Tax1
• TaxClass
• TaxClass1
• TopSellersReport
• Webhook
• Webhook1
• Webhook2

Contributing

We welcome contributions from the community! If you'd like to contribute to this project, please follow these guidelines:

1. Fork the repository on GitHub.
2. Create a new branch with a descriptive name for your feature or bug fix.
3. Make your changes and commit them, providing a clear and concise commit message.
4. Push your changes to your fork.
5. Submit a pull request to the main repository's main branch.

Reporting Issues

If you encounter any issues with the project or have suggestions for improvements, please feel free to open an issue.