Add `/products` endpoint by oguzkocer · Pull Request #1289 · Automattic/wordpress-rs

oguzkocer · 2026-04-17T04:57:07Z

Implement GET /products with optional type filter parameter. The Product type covers all product variants (domain registrations, transfers, Jetpack plans, etc.) with optional fields for domain-specific data (tld, sale_coupon, HSTS) and non-domain data (introductory_offer, price tiers).

wpmobilebot · 2026-04-17T05:13:40Z

XCFramework Build

This PR's XCFramework is available for testing. Add to your Package.swift:

.package(url: "https://github.com/automattic/wordpress-rs", branch: "pr-build/1289")

_{Built from e022ffa}

jkmassel · 2026-04-17T20:42:00Z

+    /// Numeric sale price when a coupon applies.
+    #[serde(default)]
+    #[uniffi(default = None)]
+    pub sale_cost: Option<f64>,


#1283 has landed, so we could probably use Decimal2 here?

It hadn't landed yet when I worked on this. Let me make that change.

Addressed in 6b6b53d.

jkmassel

Some suggestions for you to work around the strangeness of this API shape.

jkmassel · 2026-04-17T20:44:51Z

+    #[uniffi(default = None)]
+    pub usage_limit: Option<u32>,
+    /// Cost per interval during the offer period.
+    pub cost_per_interval: f64,


Same point about Decimal2

Addressed in 900783a.

Note that upon reviewing the API implementation, I've also updated tld_rank to Option<f64> per Claude's suggestion.

jkmassel · 2026-04-20T19:47:17Z

+pub struct ProductsParams {
+    /// Filter by product type (e.g. `"domains"`).
+    #[uniffi(default = None)]
+    pub product_type: Option<String>,


This endpoint has a bunch of localized fields, so we need to provide the locale we want strings in.

The argument is locale, and it can be WPComLanguage – that should automatically handle serialization into query strings for you.

Addressed in bb3d213.

jkmassel · 2026-04-20T20:32:48Z

+pub struct ProductsParams {
+    /// Filter by product type (e.g. `"domains"`).
+    #[uniffi(default = None)]
+    pub product_type: Option<String>,


WDYT about introducing a ProductType enum for this?

It would need the Other case to handle any new values, but it'd avoid stringly-typing for an operation like "get all the domain registration products" – the API returns all results instead of no results if something is misspelled.

Addressed in f3b6c71.

jkmassel · 2026-04-20T20:43:55Z

+    /// Absent for non-registration products like domain mapping.
+    #[serde(default)]
+    #[uniffi(default = None)]
+    pub tld: Option<String>,


tld, is_privacy_protection_product_purchase_allowed, is_hsts_required, is_dot_gay_notice_required are all only defined on domains.

WDYT about defining DomainProductInfo to hold these?

Addressed in 8d88fb4.

jkmassel

Left some suggestions

jkmassel

Left some suggestions

jkmassel · 2026-04-24T15:05:14Z

+    /// Locale for localized product names and descriptions.
+    #[uniffi(default = None)]
+    pub locale: Option<WPComLanguage>,
+}


There's also a currency param that controls which currency is returned.

We should implement it, probably as an enum with USD, EUR, AUD, etc. We can have a catch-all Other for it. It can be a separate PR, but we should update the places where currency is emitted to use that too.

I'll address this in a separate PR to avoid some merge conflicts.

jkmassel · 2026-04-24T15:08:05Z

+    pub cost_smallest_unit: u64,
+    pub currency_code: CurrencyCode,
+    /// Billing period (e.g. `"year"`).
+    pub product_term: String,


This seems like a constrained set of values – should we make it an enum as well?

Addressed in a5ea0e1.

jkmassel · 2026-04-24T15:09:09Z

+/// Details of an active sale coupon applied to a product.
+#[derive(Debug, Clone, Serialize, Deserialize, uniffi::Record)]
+pub struct SaleCoupon {
+    pub start_date: String,


Based on the field name, I think I'd expect this to be a Date type?

Addressed in 229811b.

jkmassel · 2026-04-24T15:11:11Z

+    /// Domain-specific fields. Fields are populated only for domain
+    /// registration products; all will be `None` for other product types.
+    #[serde(flatten)]
+    pub domain_info: DomainProductInfo,


This should probably be optional, because not all products are domains. When it is, all of the fields can be non-optional because they're only populated for domain-shaped objects.

Addressed in 7b88560.

jkmassel · 2026-04-24T16:21:19Z

+#[derive(Debug, Clone, Serialize, Deserialize, uniffi::Record)]
+pub struct IntroductoryOffer {
+    /// Unit of the offer interval (e.g. `"month"`).
+    pub interval_unit: String,


This is actually an enum on the server too:

Value Meaning

"day" Daily interval

"week" Weekly interval

"month" Monthly interval

"year" Annual interval

"indefinite" No end / indefinite

Could have Other just in case but it seems nicely shaped.

Addressed in 18f6b59.

jkmassel

echoing @crazytonyli's approval

Implement `GET /products` with optional `type` filter parameter. The `Product` type covers all product variants (domain registrations, transfers, Jetpack plans, etc.) with optional fields for domain-specific data (`tld`, `sale_coupon`, HSTS) and non-domain data (`introductory_offer`, price tiers).

- Product.cost: f64 → Decimal2 - IntroductoryOffer.cost_per_interval: f64 → Decimal2 - SaleCoupon.tld_rank: Option<u32> → Option<f64> to match backend

Accept an optional WPComLanguage locale in ProductsParams to get localized product names and descriptions from the API.

Replace stringly-typed product_type filter with a ProductTypeFilter enum (Domains, Jetpack, Other) to prevent typos that silently return all results instead of a filtered set.

Group domain-specific optional fields (tld, is_privacy_protection_- product_purchase_allowed, is_hsts_required, is_dot_gay_notice_required) into a DomainProductInfo struct, flattened for JSON compatibility.

Match the DerivedRequest trait signature which requires &self.

CurrencyCode (in wp_com module) wraps an ISO 4217 string. ProductId (in products module) wraps a u64 with built-in deserialization from both numeric and string representations, since the API is inconsistent about the encoding.

Since tld and is_privacy_protection_product_purchase_allowed are always present for domain products, make them non-optional. With tld as a required String, serde(flatten) correctly produces None for non-domain products and Some for domain products.

Known values from the backend: month, year, two years, three years, hundred years, one time. Includes Other(String) fallback.

Matches the backend's `Time_Span_Unit` enum: day, week, month, year, indefinite. Includes Other(String) fallback.

The existing date deserializer already handles the MySQL format ("2025-01-01 00:00:00") used by the coupon start_date and expires fields.

oguzkocer added this to the 0.2 milestone Apr 17, 2026

oguzkocer added Rust Endpoint labels Apr 17, 2026

oguzkocer marked this pull request as ready for review April 17, 2026 19:48

oguzkocer requested a review from jkmassel April 17, 2026 19:49

jkmassel reviewed Apr 17, 2026

View reviewed changes

oguzkocer force-pushed the products-endpoint branch from bfea4c6 to 6b6b53d Compare April 17, 2026 22:13

oguzkocer mentioned this pull request Apr 18, 2026

Add saleCostDisplay to PaidDomainSuggestion #1287

Closed

jkmassel requested changes Apr 20, 2026

View reviewed changes

jkmassel requested changes Apr 21, 2026

View reviewed changes

oguzkocer force-pushed the products-endpoint branch from 6b6b53d to 8d88fb4 Compare April 21, 2026 02:05

oguzkocer requested a review from jkmassel April 21, 2026 04:16

jkmassel requested changes Apr 24, 2026

View reviewed changes

jkmassel reviewed Apr 24, 2026

View reviewed changes

oguzkocer requested review from crazytonyli and jkmassel April 27, 2026 16:22

crazytonyli approved these changes May 3, 2026

View reviewed changes

oguzkocer force-pushed the products-endpoint branch from 229811b to 2b257e8 Compare May 4, 2026 17:17

jkmassel requested review from jkmassel and removed request for jkmassel May 4, 2026 17:45

jkmassel approved these changes May 4, 2026

View reviewed changes

oguzkocer added 7 commits May 4, 2026 20:53

Change Product sale_cost to Decimal2

984d566

Use Decimal2 for Product cost fields and fix tld_rank type

9de3016

- Product.cost: f64 → Decimal2 - IntroductoryOffer.cost_per_interval: f64 → Decimal2 - SaleCoupon.tld_rank: Option<u32> → Option<f64> to match backend

Add locale param to products endpoint

04541d0

Accept an optional WPComLanguage locale in ProductsParams to get localized product names and descriptions from the API.

Add ProductTypeFilter enum for products endpoint

07bca0a

Replace stringly-typed product_type filter with a ProductTypeFilter enum (Domains, Jetpack, Other) to prevent typos that silently return all results instead of a filtered set.

Extract DomainProductInfo struct for domain-specific fields

cb6e09f

Group domain-specific optional fields (tld, is_privacy_protection_- product_purchase_allowed, is_hsts_required, is_dot_gay_notice_required) into a DomainProductInfo struct, flattened for JSON compatibility.

Fix missing &self in ProductsRequest::namespace

327cd48

Match the DerivedRequest trait signature which requires &self.

oguzkocer added 7 commits May 4, 2026 20:53

Cargo fmt

49b834e

Add CurrencyCode and ProductId newtypes

e07ceb7

CurrencyCode (in wp_com module) wraps an ISO 4217 string. ProductId (in products module) wraps a u64 with built-in deserialization from both numeric and string representations, since the API is inconsistent about the encoding.

Add ProductTerm enum for billing period

252f79c

Known values from the backend: month, year, two years, three years, hundred years, one time. Includes Other(String) fallback.

Add TimeSpanUnit enum for introductory offer interval

ba14767

Matches the backend's `Time_Span_Unit` enum: day, week, month, year, indefinite. Includes Other(String) fallback.

Use WpGmtDateTime for SaleCoupon date fields

b012005

The existing date deserializer already handles the MySQL format ("2025-01-01 00:00:00") used by the coupon start_date and expires fields.

Add changelog entry for /products endpoint

e022ffa

oguzkocer force-pushed the products-endpoint branch from ddbbdf7 to e022ffa Compare May 5, 2026 00:53

oguzkocer enabled auto-merge (squash) May 5, 2026 00:54

oguzkocer merged commit 7c40aa4 into trunk May 5, 2026
34 checks passed

oguzkocer deleted the products-endpoint branch May 5, 2026 01:21

Value	Meaning
`"day"`	Daily interval
`"week"`	Weekly interval
`"month"`	Monthly interval
`"year"`	Annual interval
`"indefinite"`	No end / indefinite

Conversation

oguzkocer commented Apr 17, 2026

Uh oh!

wpmobilebot commented Apr 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

XCFramework Build

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jkmassel left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jkmassel left a comment

Choose a reason for hiding this comment

Uh oh!

jkmassel left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jkmassel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

wpmobilebot commented Apr 17, 2026 •

edited

Loading