woosignal 4.6.0

WooCommerce REST API for dart, connect a WooCommerce store and start developing with our interface for their API endpoints.

4.6.0 - 2026-10-12

Added

• setWpUserToken and a wpUserToken parameter for WooSignal.init(). When a customer is logged in, every request sends their wp_json_api token (WPJsonAPI.wpUserToken() in wp_json_api 5.x) in the X-WS-User-Token header so WooSignal can verify which customer is asking, e.g. to return only that customer's orders and to link the device to them for notifications. Pass null to clear it on logout
• ApiProvider.setWpUserToken, ApiProvider.hasWpUserToken and the ApiProvider.wpUserTokenHeader constant

Changed

• Debug logging hides wp_user_token values in request parameters (e.g. redeemPoints), and the token header is never logged
• In tests and on web, ApiProvider.init() no longer reads device info it doesn't use

Fixed

• A failed request (an error response, a network failure or an unexpected response) no longer throws an uncaught error. List methods such as getOrders return an empty list and other methods return null, as documented

4.5.0 - 2026-10-12

Added

• redeemPoints creates a Points and Rewards discount coupon for the logged in shopper. WooSignal checks the shopper's wp_json_api token (wp_json_api 5.0+, WP JSON API plugin 5.0+) and points balance with the store

Deprecated

• createCoupon. WooSignal no longer lets apps create coupons; use redeemPoints for points redemption

4.4.0 - 2026-09-12

4.3.0 and 4.3.1 were tagged but never published to pub.dev. If you are upgrading from 4.2.3, this release also includes the changes listed under those versions.

Added

• apiBaseUrl parameter for WooSignal.init() to use a custom API base URL (defaults to https://api.woosignal.com/v3)
• WooSignal.defaultApiBaseUrl and ApiProvider.defaultBaseUrl constants

Changed

• Debug logging now uses debugPrint instead of print
• Update dio dependency to ^5.11.1
• Update device_meta dependency to ^3.0.5
• Update intl dependency to ^0.20.3
• Add vibe_check ^1.0.1 dev dependency and adopt its analysis options
• Remove unused test dev dependency
• Add explicit type annotations to EnumValues maps, encryption helpers and tests
• Example app: const constructors and updated dev dependencies

Fixed

• WooSignal.instance.version (sent to the API as api_version) now matches the package version; 4.3.1 still reported 4.3.0

4.3.1 - 2026-05-23

Changed

• Update dio dependency to ^5.9.2
• Update device_meta dependency to ^3.0.2
• Update test dev dependency to ^1.31.0
• Bump copyright year to 2026

4.3.0 - 2026-02-10

Added

• Barrel exports for all models in woosignal.dart (no more individual imports needed)
• New parameters for getProducts(): modifiedAfter, modifiedBefore, datesAreGmt, virtual, downloadable, context
• New parameters for getProductVariations(): datesAreGmt, virtual, downloadable, context
• New parameters for getOrders(): datesAreGmt, createdVia, context
• New parameters for getRefunds(): context, datesAreGmt
• New parameters for getCoupons(): modifiedAfter, modifiedBefore, datesAreGmt, offset
• New context parameter for getCustomers()
• Comprehensive model unit tests

Fixed

• Refund model null safety for fromJson and toJson
• OrderWC.fromJson() parentId null check
• LineItems.toJson() total field check
• getRefunds() payload keys (offset, parent, parentExclude, dp were mapped incorrectly)
• getTaxRates() taxClass parameter key

Changed

• Remove invalid parameters from getCustomers() (hideEmpty, parent, product, slug)
• Update device_meta dependency to ^3.0.0
• Pubspec.yaml dependency updates

4.2.3 - 2025-12-13

• Pubspec.yaml dependency updates.

4.2.2 - 2025-09-06

• Pubspec.yaml dependency updates.

4.2.1 - 2025-07-17

• Pubspec.yaml dependency updates.

4.2.0 - 2025-05-23

• Add money formatter into library

4.1.6 - 2025-05-23

• Pubspec.yaml dependency updates.

4.1.5 - 2025-04-09

• Pubspec.yaml dependency updates.

4.1.4 - 2025-03-27

• Pubspec.yaml dependency updates.

4.1.3 - 2025-02-27

• Pubspec.yaml dependency updates.

4.1.2 - 2025-02-07

• Pubspec.yaml dependency updates.

4.1.1 - 2025-01-05

• Pubspec.yaml dependency updates.

4.1.0 - 2024-12-31

• Update copyright year
• Update example
• Pubspec.yaml dependency updates.

4.0.3 - 2024-12-16

• Pubspec.yaml dependency updates.

4.0.2 - 2024-11-25

• Pubspec.yaml dependency updates.

4.0.1 - 2024-11-23

• Pubspec.yaml dependency updates.

4.0.0 - 2024-11-06

• Update project to use device_meta v2
• Pubspec.yaml dependency updates.

3.14.10 - 2024-08-17

• Merge @paolodellaquila PR to fix product_variation image
• Update example

3.14.9 - 2024-08-17

• Pubspec.yaml dependency updates.

3.14.8 - 2024-07-08

• Pubspec.yaml dependency updates.

3.14.7 - 2024-06-15

• Pubspec.yaml dependency updates.

3.14.6 - 2024-05-13

• Pubspec.yaml dependency updates.

3.14.5 - 2024-05-10

• Pubspec.yaml dependency updates.

3.14.4 - 2024-05-02

• Pubspec.yaml dependency updates.

3.14.3 - 2024-04-26

• Pubspec.yaml dependency updates.

3.14.2 - 2024-04-23

• Pubspec.yaml dependency updates.

3.14.1 - 2024-04-09

• Pubspec.yaml dependency updates.

3.14.0 - 2024-04-06

• Add toJson method to Product class
• Pubspec.yaml dependency updates.

3.13.5 - 2024-04-03

• Pubspec.yaml dependency updates.

3.13.4 - 2024-03-27

• Pubspec.yaml dependency updates.

3.13.3 - 2024-03-27

• Pubspec.yaml dependency updates.

[3.13.3] - 2024-03-21

• Pubspec.yaml dependency updates.

3.13.2 - 2024-03-18

• Pubspec.yaml dependency updates.

3.13.1 - 2024-03-17

• Pubspec.yaml dependency updates.

3.13.0 - 2024-03-15

• New network method personalizationCategories to store personalization categories

3.12.0 - 2024-03-15

• Fix shipping zone method
• Change MetaData value to dynamic

3.11.1 - 2024-03-11

• Dart format

3.11.0 - 2024-03-11

• Ability to set the users WP User ID in the networking class

3.10.0 - 2024-03-07

• Added the ability to fetch the order of your product categories from WooSignal
• Pubspec.yaml dependency updates.

3.9.2 - 2024-02-28

• Pubspec.yaml dependency updates.

3.8.2 - 2024-01-01

• Update license date
• Fix Dart analysis issues
• Pubspec.yaml dependency updates.

3.8.1 - 2023-10-05

• Pubspec.yaml dependency updates.

3.8.0 - 2023-07-12

• Encryption for app info response.
• New Firebase config fields added to WooSignalApp class.
• Pubspec.yaml dependency updates.

3.7.1 - 2023-07-03

• Update parameters for creating orders.

3.7.0 - 2023-07-03

• Update parameters for creating orders.

3.6.1 - 2023-07-03

• Fix dart analysis refer_interpolation_to_compose_strings in project.

3.6.0 - 2023-07-03

• Fix orderBy parameter for getProducts().
• Add transactionId in OrderWC class.
• More parameters added for createCoupon().

3.5.0 - 2023-05-28

• Refactor products.dart to product.dart
• Pubspec.yaml dependency updates.

3.4.0 - 2023-05-18

• Add new attributes to Product class

• Pubspec.yaml dependency updates.

• [3.3.0] - 2023-03-04

• New endpoint for Stripe Payment Intents.

• Pubspec.yaml dependency updates.

3.2.3 - 2023-02-22

• Flutter version bump

3.2.2 - 2023-02-20

• Add logo to package
• Pubspec.yaml dependency updates.

3.2.1 - 2022-12-28

• Update copyright version

3.2.0 - 2022-11-03

• Add Menu Links to WooSignalApp class
• Fix expected API return types for Dimension
• Dependency updates

3.1.1 - 2022-08-29

• Dependency updates

3.1.0 - 2022-05-19

• New API for product tags
• Flutter format
• Dependency updates
• Dart version 2.17

3.0.5 - 2022-01-29

• Version added to woosignal.dart
• Flutter format
• Improvements as per Dart analysis

3.0.4 - 2022-01-28

• Add new variables to woosignal_app
• Update arguments for product review
• Dependency updates

3.0.3 - 2022-01-03

• Update coupon property types
• Improvements as per analysis

3.0.2 - 2021-12-19

• Update Readme

3.0.1 - 2021-12-18

• Gracefully handle bad responses
• Flutter format

3.0.0 - 2021-12-16

• Breaking changes
• Major refactor to woosignal.dart class
• Added CustomerDownload model
• Ability to store theme colors, theme font and social links in WooSignalApp class
• Dependency updates

2.2.1 - 2021-11-02

• Update readme

2.2.0 - 2021-11-02

• Add new variables to woosignal_app
• Dependency updates

2.1.0 - 2021-07-19

• Add locale var to woosignal_app
• Dependency updates

2.0.2 - 2021-04-11

• Add theme var to woosignal_app

2.0.1 - 2021-04-10

• null check on Order vars
• flutter format

2.0.0 - 2021-04-10

• Added null safety support
• Dependency updates

1.5.1+1 - 2021-03-27

• Update README

1.5.1 - 2021-03-27

• Fixed small issue with the image and product model

1.5.0 - 2021-03-17

• Refactor classes
• Ability to fetch app meta data
• Changes as per dart analysis log

1.4.0 - 2021-03-08

• Refactor classes
• Ability to fetch app meta data
• New method for initializing API

1.3.1 - 2020-12-20

• README updates

1.3.0 - 2020-12-20

• New WooCommerce APIs

1.2.1 - 2020-10-30

• Dependency updates

1.2.0 - 2020-09-05

• New method to retrieve a product

1.1.2 - 2020-07-22

• Update FreeShipping model for minimum spend
• New endpoint for app status

1.1.1 - 2020-07-03

• Fix MetaData for orders

1.1.0 - 2020-06-16

• New MetaData base class for models
• New update order method
• Bug fixes

1.0.9 - 2020-06-03

• Resolved bug with MetaData on models
• Removed Shipping Zone Methods (use Shipping Methods going forward for WooCommerce shipping)

1.0.8 - 2020-05-08

• Readme update

1.0.7 - 2020-05-08

• Tweaks and bugs resolved

1.0.6 - 2020-04-09

• Ability to create Product reviews

1.0.5 - 2020-04-03

• Tweaks to ProductReviews model

1.0.4 - 2020-03-28

• bug fix for ProductReviews

1.0.3 - 2020-03-28

• Changes to woosignal class and bug fixes

1.0.2 - 2019-10-31

• Tweaks and bugs resolved

1.0.1 - 2019-10-29

• Bugs resolved, added pubspec.yaml to example, new documentation URL

1.0.0 - 2019-06-15

• Tweaks and fixes

0.0.3 - 2019-06-15

• added example, formatting classes

0.0.2 - 2019-06-14

• Changes to pubspec description, formatting classes, example added, homepage URL update

0.0.1 - 2019-06-13

• Initial Release