Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Cleanup Metafields/Metadata split, rename metafields to `custom_fields` in API/SDK

Damian Legawiecb287dd0efca6
diff --git a/CLAUDE.md b/CLAUDE.md
index 6ab3deb591..3486896c53 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -34,6 +34,7 @@ Current plans:
- `5.4-disjunctive-option-faceting.md` — Per-option-type filter params with disjunctive facet counts (OR within option type, AND across)
- `5.5-option-type-enhancements.md` — Add `kind` (dropdown/color_swatch/buttons) to OptionType, `color_code` + `image` to OptionValue for swatch support
+- `5.4-6.0-custom-fields-rename.md` — Rename Metafields → Custom Fields (5.4 API bridge + 6.0 model rename)
Completed plans:
- `5.4-store-api-bridges.md` — Bridge 6.0 naming into 5.4 Store API (implemented, PR #13782)
diff --git a/docs/api-reference/store-api/metadata.mdx b/docs/api-reference/store-api/metadata.mdx
index dad830be01..de6ceb3808 100644
--- a/docs/api-reference/store-api/metadata.mdx
+++ b/docs/api-reference/store-api/metadata.mdx
@@ -160,13 +160,16 @@ Metadata is stored as a flat JSON object. You can use any keys and values:
## Metadata vs Metafields
+Spree has two permanent, complementary systems for custom data — **metadata for machines, metafields for humans**.
+
| | Metadata | Metafields |
|-|----------|------------|
-| **Structure** | Untyped JSON | Schema-defined, strongly typed |
+| **Purpose** | Developer escape hatch — integration IDs, sync state | Merchant-defined structured attributes |
+| **Schema** | Schemaless JSON — no definition required | Defined via MetafieldDefinitions (typed, validated) |
| **Validation** | None | Type-specific validation |
-| **Visibility** | Write-only in Store API | Configurable (public/private) |
+| **Visibility** | Write-only in Store API, readable in Admin API | Configurable (front-end, back-end, both) |
| **Admin UI** | JSON preview | Dedicated form fields |
-| **Best for** | Integration data, tracking, attribution | Product specs, custom fields, customer-facing data |
+| **Best for** | Integration data, tracking, attribution, write-and-forget | Product specs, custom attributes, customer-facing data |
| **API access** | Write via Store API, read via Admin API | Read/write via both APIs |
-For more details on metafields, see the [Metafields guide](/developer/core-concepts/metafields).
+Both systems are here to stay. For more details on metafields, see the [Metafields guide](/developer/core-concepts/metafields).
diff --git a/docs/api-reference/store.yaml b/docs/api-reference/store.yaml
index 7bfa49195d..4eeda1e668 100644
--- a/docs/api-reference/store.yaml
+++ b/docs/api-reference/store.yaml
@@ -590,17 +590,15 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjM2YWEyNmU4LTBiYTEtNGNiYi1iMmNlLWE5MDk0NTEzOWMwZiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc0NTM0NjM1fQ.WAESIdEKZGY2cxuB0u9mSiCvrdi4o3vJXSMnHiWiZts
- refresh_token: 6ny6XNK3Axb6dYEHKQdHwGwA
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjkxOGY5MzI4LWI0YzctNDU5Yi1iZTczLTIxMzMwZDhhMmM5YSIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc0NzAxODQ4fQ.cuuj2Oi6xGSBeNEYjr91DrFNQrWTvyTaTHTbXDhdeOQ
+ refresh_token: YGoDXXid6KGaL59iez28EoWL
user:
id: cus_UkLWZg9DAJ
- first_name: Jonelle
- last_name: Marvin
+ first_name: Jolynn
+ last_name: Stiedemann
phone:
accepts_email_marketing: false
- created_at: '2026-03-26T13:17:15.189Z'
- updated_at: '2026-03-26T13:17:15.189Z'
available_store_credit_total: '0'
display_available_store_credit_total: "$0.00"
addresses: []
@@ -673,17 +671,15 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6ImI3YjM0OWNmLThmNjYtNDg3Zi05ZTkzLWQ1MWExMDUzMmEyNiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc0NTM0NjM2fQ.nsbSTOARmXAivXATW5NzXjzyO68XgbC8KWTEKCyVdF8
- refresh_token: 7UsPBtQL8wrZmsffJsaA8rV7
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjRiYjIwZmViLTY1ZTAtNDJjNS1iMjFjLTQ4YzFmZGE1NjA5YiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc0NzAxODQ5fQ._gkuJGgjt3GcsGJNWPp4_uGDgrmxtKvHypsNFmFf2Lk
+ refresh_token: w4PMNQtBJA6VtTbuwBNn3FwB
user:
id: cus_UkLWZg9DAJ
- first_name: Betsey
- last_name: Carter
+ first_name: Jeanett
+ last_name: Collier
phone:
accepts_email_marketing: false
- created_at: '2026-03-26T13:17:16.619Z'
- updated_at: '2026-03-26T13:17:16.619Z'
available_store_credit_total: '0'
display_available_store_credit_total: "$0.00"
addresses: []
@@ -846,9 +842,9 @@ paths:
example:
data:
- id: cart_gbHJdmfrXB
- number: R890619335
- token: MGiu27DVcrewsgdRUSqy7qzhTwWZKtZNZuh
+ number: R561002699
+ token: hzQcBBtBok9WS9xnBHnAER2brr4vPRSWk7C
customer_note:
currency: USD
locale: en
@@ -874,8 +870,8 @@ paths:
delivery_total: '100.0'
display_delivery_total: "$100.00"
warnings: []
- created_at: '2026-03-26T13:17:19.183Z'
- updated_at: '2026-03-26T13:17:19.258Z'
+ created_at: '2026-03-28T11:44:12.058Z'
+ updated_at: '2026-03-28T11:44:12.100Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -892,8 +888,8 @@ paths:
variant_id: variant_gbHJdmfrXB
quantity: 1
currency: USD
- name: Product 25039
- slug: product-25039
+ name: Product 23272
+ slug: product-23272
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -912,21 +908,17 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-26T13:17:19.227Z'
- updated_at: '2026-03-26T13:17:19.227Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_gbHJdmfrXB
- number: H52819160675
+ number: H23500198126
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-26T13:17:19.238Z'
- updated_at: '2026-03-26T13:17:19.255Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -941,7 +933,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_32
- name: Kathryne Lockman
+ name: Millie Cremin
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -1001,9 +993,9 @@ paths:
payment_methods: []
gift_card:
- id: cart_UkLWZg9DAJ
- number: R060921158
- token: 5ZGGckKMn6G61c8vviF4p478HF9dwm7H8Qt
+ number: R602989118
+ token: FKvvr4nLfaqfdyHgXsffLGWRvZYUFhLqutp
customer_note:
currency: USD
locale: en
@@ -1029,8 +1021,8 @@ paths:
delivery_total: '100.0'
display_delivery_total: "$100.00"
warnings: []
- created_at: '2026-03-26T13:17:18.990Z'
- updated_at: '2026-03-26T13:17:19.176Z'
+ created_at: '2026-03-28T11:44:11.916Z'
+ updated_at: '2026-03-28T11:44:12.053Z'
store_credit_total: '0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -1047,8 +1039,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 15673
- slug: product-15673
+ name: Product 11869
+ slug: product-11869
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -1067,21 +1059,17 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-26T13:17:19.094Z'
- updated_at: '2026-03-26T13:17:19.094Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H11043534109
+ number: H32968497542
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-26T13:17:19.111Z'
- updated_at: '2026-03-26T13:17:19.170Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -1096,7 +1084,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_32
- name: Kathryne Lockman
+ name: Millie Cremin
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -1229,8 +1217,8 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R399356899
- token: fAxR7T5DcWLTMmJLZzTy2P7uBBa9VR7CVFn
+ number: R137499246
+ token: uM5hfB6Qg9aRjJPXWNiPvRx4wN3t2kV4SRi
email:
customer_note:
currency: USD
@@ -1257,8 +1245,8 @@ paths:
delivery_total: '0.0'
display_delivery_total: "$0.00"
warnings: []
- created_at: '2026-03-26T13:17:19.797Z'
- updated_at: '2026-03-26T13:17:19.797Z'
+ created_at: '2026-03-28T11:44:12.580Z'
+ updated_at: '2026-03-28T11:44:12.580Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -1385,9 +1373,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R080976194
- token: bWjdXthmNQLE9i2tHjXdMgk4Zp18FxataTK
+ number: R015039796
+ token: XB4rhoFyXKaTcht86w5wqN1oWdX86Nj5RZ1
customer_note:
currency: USD
locale: en
@@ -1414,11 +1402,11 @@ paths:
display_delivery_total: "$0.00"
warnings:
- code: line_item_removed
- message: Product 61855 was removed because it was sold out
+ message: Product 63270 was removed because it was sold out
line_item_id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
- created_at: '2026-03-26T13:17:20.585Z'
- updated_at: '2026-03-26T13:17:20.705Z'
+ created_at: '2026-03-28T11:44:13.239Z'
+ updated_at: '2026-03-28T11:44:13.346Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -1556,9 +1544,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R069274939
- token: 2eRWwBzSXTJcZhYDobPQjPGLfCDF7vspyqb
+ number: R496471280
+ token: 638VUJdoPTMjsXCgoYRrx8qTEwyjzLz5E6F
customer_note: Leave at door
currency: USD
locale: en
@@ -1584,8 +1572,8 @@ paths:
delivery_total: '10.0'
display_delivery_total: "$10.00"
warnings: []
- created_at: '2026-03-26T13:17:21.308Z'
- updated_at: '2026-03-26T13:17:21.465Z'
+ created_at: '2026-03-28T11:44:13.904Z'
+ updated_at: '2026-03-28T11:44:14.041Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -1604,8 +1592,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 73957
- slug: product-73957
+ name: Product 75671
+ slug: product-75671
options_text: ''
price: '19.99'
display_price: "$19.99"
@@ -1624,21 +1612,17 @@ paths:
discounted_amount: '19.99'
display_discounted_amount: "$19.99"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-26T13:17:21.345Z'
- updated_at: '2026-03-26T13:17:21.418Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_gbHJdmfrXB
- number: H64548007173
+ number: H40100996483
tracking:
tracking_url:
cost: '10.0'
display_cost: "$10.00"
- created_at: '2026-03-26T13:17:21.436Z'
- updated_at: '2026-03-26T13:17:21.449Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -1653,7 +1637,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_46
- name: Leo Heaney
+ name: Emmie Spencer
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -1880,9 +1864,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R682358623
- token: xmYQqvV2NHE69Eh9sEQvBtxBHsu4rLsbPV5
+ number: R452564608
+ token: oB8LvaYR4CV4kr6BEMFtHzfZsAyGxtx6r4z
customer_note:
currency: USD
locale: en
@@ -1908,8 +1892,8 @@ paths:
delivery_total: '100.0'
display_delivery_total: "$100.00"
warnings: []
- created_at: '2026-03-26T13:17:22.174Z'
- updated_at: '2026-03-26T13:17:22.251Z'
+ created_at: '2026-03-28T11:44:14.703Z'
+ updated_at: '2026-03-28T11:44:14.748Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -1926,8 +1910,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 92813
- slug: product-92813
+ name: Product 91401
+ slug: product-91401
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -1946,21 +1930,17 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-26T13:17:22.222Z'
- updated_at: '2026-03-26T13:17:22.222Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H77372385672
+ number: H90321795147
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-26T13:17:22.229Z'
- updated_at: '2026-03-26T13:17:22.248Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -1975,7 +1955,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_54
- name: Jillian Langworth
+ name: Sunny Hansen
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -2099,8 +2079,8 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R564613814
+ number: R148635323
customer_note:
currency: USD
locale: en
@@ -2127,9 +2107,9 @@ paths:
display_delivery_total: "$10.00"
fulfillment_status: backorder
payment_status: paid
- completed_at: '2026-03-26T13:17:23.842Z'
- created_at: '2026-03-26T13:17:23.521Z'
- updated_at: '2026-03-26T13:17:23.842Z'
+ completed_at: '2026-03-28T11:44:16.110Z'
+ created_at: '2026-03-28T11:44:15.917Z'
+ updated_at: '2026-03-28T11:44:16.110Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -2139,8 +2119,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 117877
- slug: product-117877
+ name: Product 113740
+ slug: product-113740
options_text: ''
price: '19.99'
display_price: "$19.99"
@@ -2159,21 +2139,17 @@ paths:
discounted_amount: '19.99'
display_discounted_amount: "$19.99"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-26T13:17:23.554Z'
- updated_at: '2026-03-26T13:17:23.846Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_gbHJdmfrXB
- number: H81976034124
+ number: H64114133913
tracking:
tracking_url:
cost: '10.0'
display_cost: "$10.00"
- created_at: '2026-03-26T13:17:23.624Z'
- updated_at: '2026-03-26T13:17:23.833Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -2188,7 +2164,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_60
- name: Toya Mueller
+ name: Christa Jacobson
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -2210,11 +2186,9 @@ paths:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
response_code: '12345'
- number: PWHRQU49
+ number: P0S8EZON
amount: '29.99'
display_amount: "$29.99"
- created_at: '2026-03-26T13:17:23.772Z'
- updated_at: '2026-03-26T13:17:23.802Z'
status: completed
source_type: credit_card
source_id: card_UkLWZg9DAJ
@@ -2352,8 +2326,8 @@ paths:
meta_description:
meta_keywords:
children_count: 1
- created_at: '2026-03-26T13:17:24.578Z'
- updated_at: '2026-03-26T13:17:24.641Z'
+ created_at: '2026-03-28T11:44:16.739Z'
+ updated_at: '2026-03-28T11:44:16.782Z'
parent_id:
description: ''
description_html: ''
@@ -2371,8 +2345,8 @@ paths:
meta_description:
meta_keywords:
children_count: 1
- created_at: '2026-03-26T13:17:24.587Z'
- updated_at: '2026-03-26T13:17:24.640Z'
+ created_at: '2026-03-28T11:44:16.745Z'
+ updated_at: '2026-03-28T11:44:16.782Z'
parent_id: ctg_UkLWZg9DAJ
description: ''
description_html: ''
@@ -2390,8 +2364,8 @@ paths:
meta_description:
meta_keywords:
children_count: 0
- created_at: '2026-03-26T13:17:24.598Z'
- updated_at: '2026-03-26T13:17:24.608Z'
+ created_at: '2026-03-28T11:44:16.753Z'
+ updated_at: '2026-03-28T11:44:16.758Z'
parent_id: ctg_gbHJdmfrXB
description: ''
description_html: ''
@@ -2467,7 +2441,7 @@ paths:
- name: expand
in: query
required: false
- description: Expand associations (children, parent, ancestors, metafields)
+ description: Expand associations (children, parent, ancestors, custom_fields)
schema:
type: string
- name: fields
@@ -2492,8 +2466,8 @@ paths:
meta_description:
meta_keywords:
children_count: 1
- created_at: '2026-03-26T13:17:25.053Z'
- updated_at: '2026-03-26T13:17:25.097Z'
+ created_at: '2026-03-28T11:44:17.119Z'
+ updated_at: '2026-03-28T11:44:17.155Z'
parent_id: ctg_UkLWZg9DAJ
description: ''
description_html: ''
@@ -3074,17 +3048,15 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjQ5MTE2MjA5LWQxZTQtNGVkYS1iNzYwLTUyZTk0NDM4MjdhNSIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc0NTM0NjUwfQ._SD0r2digP8X-XTIAqBJx_0z6QJO7NfGN2fkktwlMAg
- refresh_token: cJBa6amLeKxvGMuHS5aVmaWV
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjU0OWVlY2ZjLTBkNDItNDM3Mi1iZjIxLWU1YmEzNzg5YTUwMyIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc0NzAxODYyfQ.44KXETRVeBoqXrhWqHlILPqKsplefc2L5Pq6KCPbOZs
+ refresh_token: a4CSEMEK99SqC2oZE68EJZit
user:
id: cus_UkLWZg9DAJ
- first_name: Yuri
- last_name: Bergnaum
+ first_name: Sonya
+ last_name: Mraz
phone:
accepts_email_marketing: false
- created_at: '2026-03-26T13:17:30.401Z'
- updated_at: '2026-03-26T13:17:30.678Z'
available_store_credit_total: '0'
display_available_store_credit_total: "$0.00"
addresses: []
@@ -3253,8 +3225,8 @@ paths:
example:
data:
- id: or_UkLWZg9DAJ
- number: R173119594
+ number: R934867648
customer_note:
currency: USD
locale: en
@@ -3281,9 +3253,9 @@ paths:
display_delivery_total: "$100.00"
fulfillment_status:
payment_status:
- completed_at: '2026-03-26T13:17:31.625Z'
- created_at: '2026-03-26T13:17:31.566Z'
- updated_at: '2026-03-26T13:17:31.625Z'
+ completed_at: '2026-03-28T11:44:23.271Z'
+ created_at: '2026-03-28T11:44:23.227Z'
+ updated_at: '2026-03-28T11:44:23.271Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -3293,8 +3265,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 201875
- slug: product-201875
+ name: Product 209012
+ slug: product-209012
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -3313,21 +3285,17 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-26T13:17:31.600Z'
- updated_at: '2026-03-26T13:17:31.600Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H11477750949
+ number: H88162870948
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-26T13:17:31.605Z'
- updated_at: '2026-03-26T13:17:31.622Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -3342,7 +3310,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_87
- name: Kirstin Eichmann
+ name: Bernardo D'Amore
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -3494,8 +3462,8 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R355267086
+ number: R054468339
customer_note:
currency: USD
locale: en
@@ -3522,9 +3490,9 @@ paths:
display_delivery_total: "$100.00"
fulfillment_status:
payment_status:
- completed_at: '2026-03-26T13:17:32.347Z'
- created_at: '2026-03-26T13:17:32.289Z'
- updated_at: '2026-03-26T13:17:32.347Z'
+ completed_at: '2026-03-28T11:44:23.941Z'
+ created_at: '2026-03-28T11:44:23.896Z'
+ updated_at: '2026-03-28T11:44:23.941Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -3534,8 +3502,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 223305
- slug: product-223305
+ name: Product 223107
+ slug: product-223107
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -3554,21 +3522,17 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-26T13:17:32.324Z'
- updated_at: '2026-03-26T13:17:32.324Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H34449897674
+ number: H44182774077
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-26T13:17:32.330Z'
- updated_at: '2026-03-26T13:17:32.344Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -3583,7 +3547,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_93
- name: Lynnette Miller
+ name: Karin Marquardt
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -3694,8 +3658,8 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjAwYTRlNGUwLWE4NWUtNDY1ZS1iZDc3LTNlNzQ1ZTkyOGE3YiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc0NTM0NjUzfQ.YsgfqY9rRDSIwciI9L6ql2njPGpSocHyjIastM9DMBE
- refresh_token: ZUJDyc5bb4wUY1WKHtdUjgwB
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6ImIyZGZiZDFiLWE5NGItNDVhYi04Y2YxLTExNjVlZGI4OWQ5OSIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc0NzAxODY1fQ.EHiaf5YSt3nevdCg0WDb3j3oxg8K7JKUncwNBWrLhh4
+ refresh_token: sPsJbH7r4zV8hkctor6Vzv6L
user:
id: cus_UkLWZg9DAJ
@@ -3703,8 +3667,6 @@ paths:
last_name: Doe
phone: "+1234567890"
accepts_email_marketing: true
- created_at: '2026-03-26T13:17:33.628Z'
- updated_at: '2026-03-26T13:17:33.628Z'
available_store_credit_total: '0'
display_available_store_credit_total: "$0.00"
addresses: []
@@ -3810,13 +3772,11 @@ paths:
application/json:
example:
id: cus_UkLWZg9DAJ
- first_name: Brett
- last_name: Skiles
+ first_name: Merilyn
+ last_name: Connelly
phone: 555-555-0199
accepts_email_marketing: false
- created_at: '2026-03-26T13:17:34.185Z'
- updated_at: '2026-03-26T13:17:34.461Z'
available_store_credit_total: '0'
display_available_store_credit_total: "$0.00"
addresses:
@@ -3950,13 +3910,11 @@ paths:
application/json:
example:
id: cus_UkLWZg9DAJ
first_name: Updated
last_name: Name
phone: 555-555-0199
accepts_email_marketing: false
- created_at: '2026-03-26T13:17:34.767Z'
- updated_at: '2026-03-26T13:17:35.054Z'
available_store_credit_total: '0'
display_available_store_credit_total: "$0.00"
addresses:
@@ -4190,9 +4148,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R424138193
- token: DmSMeRw6o24Hy3MmhV5iizseP5UqcH9WXWE
+ number: R444503967
+ token: eiBwUd1gzUm9j2EPZDbfyufdPco4eLrNX3e
customer_note:
currency: USD
locale: en
@@ -4218,8 +4176,8 @@ paths:
delivery_total: '100.0'
display_delivery_total: "$100.00"
warnings: []
- created_at: '2026-03-26T13:17:38.570Z'
- updated_at: '2026-03-26T13:17:38.716Z'
+ created_at: '2026-03-28T11:44:29.782Z'
+ updated_at: '2026-03-28T11:44:29.901Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -4243,8 +4201,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 303585
- slug: product-303585
+ name: Product 304880
+ slug: product-304880
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -4263,21 +4221,17 @@ paths:
discounted_amount: '0.0'
display_discounted_amount: "$0.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-26T13:17:38.607Z'
- updated_at: '2026-03-26T13:17:38.700Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H47502051941
+ number: H75182966011
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-26T13:17:38.621Z'
- updated_at: '2026-03-26T13:17:38.639Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -4292,7 +4246,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_119
- name: Nannette Osinski
+ name: Breanna Shields
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -4436,9 +4390,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R440265836
- token: i3JUe7vJj9eq75i8sJBQFzW4GkHs2wjc3pK
+ number: R093153548
+ token: zcMpv8HYsaCytmyVS1TjE9uKCLPQ9CN65Dp
customer_note:
currency: USD
locale: en
@@ -4464,8 +4418,8 @@ paths:
delivery_total: '100.0'
display_delivery_total: "$100.00"
warnings: []
- created_at: '2026-03-26T13:17:40.007Z'
- updated_at: '2026-03-26T13:17:40.150Z'
+ created_at: '2026-03-28T11:44:31.091Z'
+ updated_at: '2026-03-28T11:44:31.190Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -4482,8 +4436,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 327861
- slug: product-327861
+ name: Product 32585
+ slug: product-32585
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -4502,21 +4456,17 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-26T13:17:40.050Z'
- updated_at: '2026-03-26T13:17:40.143Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H64436908692
+ number: H30384688007
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-26T13:17:40.056Z'
- updated_at: '2026-03-26T13:17:40.075Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -4531,7 +4481,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_127
- name: Allan Eichmann
+ name: Ursula Fahey
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -4664,9 +4614,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R335962190
- token: 4s4baRXbanveACc7BfkzTmq8mrMG6QTTdmo
+ number: R110309902
+ token: MGPrPetRsoMGoh7GCZg2oDXth6PE3xBsctq
customer_note:
currency: USD
locale: en
@@ -4692,8 +4642,8 @@ paths:
delivery_total: '100.0'
display_delivery_total: "$100.00"
warnings: []
- created_at: '2026-03-26T13:17:41.452Z'
- updated_at: '2026-03-26T13:17:41.567Z'
+ created_at: '2026-03-28T11:44:32.362Z'
+ updated_at: '2026-03-28T11:44:32.511Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -4712,8 +4662,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 344729
- slug: product-344729
+ name: Product 346829
+ slug: product-346829
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -4732,21 +4682,17 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-26T13:17:41.494Z'
- updated_at: '2026-03-26T13:17:41.494Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H31828066496
+ number: H78479855794
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-26T13:17:41.501Z'
- updated_at: '2026-03-26T13:17:41.546Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -4761,7 +4707,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_135
- name: Ferdinand Cormier
+ name: Pauletta Cassin
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -4908,9 +4854,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R054904771
- token: MqZG7gjTYDt7gbdb8Q7jLSDJzMfTTaWCNt9
+ number: R545542575
+ token: DW2dg4pAkWTJJcqTC2ud2swBBbTtYo7RRfU
customer_note:
currency: USD
locale: en
@@ -4936,8 +4882,8 @@ paths:
delivery_total: '100.0'
display_delivery_total: "$100.00"
warnings: []
- created_at: '2026-03-26T13:17:42.779Z'
- updated_at: '2026-03-26T13:17:42.895Z'
+ created_at: '2026-03-28T11:44:33.720Z'
+ updated_at: '2026-03-28T11:44:33.850Z'
store_credit_total: '50.0'
display_store_credit_total: "-$50.00"
covered_by_store_credit: false
@@ -4951,8 +4897,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 362603
- slug: product-362603
+ name: Product 365753
+ slug: product-365753
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -4971,21 +4917,17 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-26T13:17:42.813Z'
- updated_at: '2026-03-26T13:17:42.813Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H12121937504
+ number: H60316070046
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-26T13:17:42.819Z'
- updated_at: '2026-03-26T13:17:42.833Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -5000,7 +4942,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_143
- name: Raye Koch
+ name: Digna Turcotte
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -5021,12 +4963,10 @@ paths:
payments:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- response_code: 1-SC-20260326131742886447
- number: PEDLO6Y1
+ response_code: 1-SC-20260328114433841691
+ number: PGO2TT4V
amount: '50.0'
display_amount: "$50.00"
- created_at: '2026-03-26T13:17:42.888Z'
- updated_at: '2026-03-26T13:17:42.888Z'
status: checkout
source_type: store_credit
source_id: credit_UkLWZg9DAJ
@@ -5105,8 +5045,8 @@ paths:
redeemed_at:
expired: false
active: true
- created_at: '2026-03-26T13:17:42.840Z'
- updated_at: '2026-03-26T13:17:42.882Z'
+ created_at: '2026-03-28T11:44:33.792Z'
+ updated_at: '2026-03-28T11:44:33.837Z'
schema:
"$ref": "#/components/schemas/Cart"
'404':
@@ -5201,9 +5141,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R614064362
- token: CtiqXbps4iBDnfENnMxAxrmZschFR1vRPUi
+ number: R905284090
+ token: bTgK6d3CQwzXjqd2kQ2RicG37oXwFsiQCCt
customer_note:
currency: USD
locale: en
@@ -5229,8 +5169,8 @@ paths:
delivery_total: '100.0'
display_delivery_total: "$100.00"
warnings: []
- created_at: '2026-03-26T13:17:45.476Z'
- updated_at: '2026-03-26T13:17:45.594Z'
+ created_at: '2026-03-28T11:44:36.269Z'
+ updated_at: '2026-03-28T11:44:36.358Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -5247,8 +5187,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 40886
- slug: product-40886
+ name: Product 405163
+ slug: product-405163
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -5267,21 +5207,17 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-26T13:17:45.510Z'
- updated_at: '2026-03-26T13:17:45.510Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H23241885306
+ number: H92430188729
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-26T13:17:45.516Z'
- updated_at: '2026-03-26T13:17:45.531Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -5296,7 +5232,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_159
- name: Asa Roberts
+ name: Verda Boehm
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -5317,12 +5253,10 @@ paths:
payments:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- response_code: 1-SC-20260326131745556134
- number: PC0LZ26Y
+ response_code: 1-SC-20260328114436330511
+ number: PHLRKBG6
amount: '50.0'
display_amount: "$50.00"
- created_at: '2026-03-26T13:17:45.557Z'
- updated_at: '2026-03-26T13:17:45.582Z'
status: invalid
source_type: store_credit
source_id: credit_UkLWZg9DAJ
@@ -5442,7 +5376,7 @@ paths:
example:
data:
- id: gc_UkLWZg9DAJ
- code: 4DB5967400B70787
+ code: FBA16C8E6123587D
status: active
currency: USD
amount: '10.0'
@@ -5456,8 +5390,8 @@ paths:
redeemed_at:
expired: false
active: true
- created_at: '2026-03-26T13:17:46.184Z'
- updated_at: '2026-03-26T13:17:46.184Z'
+ created_at: '2026-03-28T11:44:36.916Z'
+ updated_at: '2026-03-28T11:44:36.916Z'
meta:
page: 1
limit: 25
@@ -5540,7 +5474,7 @@ paths:
application/json:
example:
id: gc_UkLWZg9DAJ
- code: 74A32810C6D971B9
+ code: 569C3E82B692C7E7
status: active
currency: USD
amount: '10.0'
@@ -5554,8 +5488,8 @@ paths:
redeemed_at:
expired: false
active: true
- created_at: '2026-03-26T13:17:47.339Z'
- updated_at: '2026-03-26T13:17:47.339Z'
+ created_at: '2026-03-28T11:44:37.997Z'
+ updated_at: '2026-03-28T11:44:37.997Z'
schema:
"$ref": "#/components/schemas/GiftCard"
'404':
@@ -5632,9 +5566,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R486004758
- token: bcfusmHFSjLGuxCF8Y4ZPQQndpDVJZBiLUX
+ number: R725896129
+ token: wSmPLJnZ9GK874o8L2STLPCy9796YBdY6gS
customer_note:
currency: USD
locale: en
@@ -5660,8 +5594,8 @@ paths:
delivery_total: '0.0'
display_delivery_total: "$0.00"
warnings: []
- created_at: '2026-03-26T13:17:49.163Z'
- updated_at: '2026-03-26T13:17:49.278Z'
+ created_at: '2026-03-28T11:44:39.810Z'
+ updated_at: '2026-03-28T11:44:39.914Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -5684,8 +5618,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 435752
- slug: product-435752
+ name: Product 439896
+ slug: product-439896
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -5704,8 +5638,6 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-26T13:17:49.199Z'
- updated_at: '2026-03-26T13:17:49.199Z'
compare_at_amount:
thumbnail_url:
option_values: []
@@ -5714,8 +5646,8 @@ paths:
variant_id: variant_gbHJdmfrXB
quantity: 1
currency: USD
- name: Product 443012
- slug: product-443012
+ name: Product 443194
+ slug: product-443194
options_text: ''
price: '19.99'
display_price: "$19.99"
@@ -5734,8 +5666,6 @@ paths:
discounted_amount: '19.99'
display_discounted_amount: "$19.99"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-26T13:17:49.245Z'
- updated_at: '2026-03-26T13:17:49.245Z'
compare_at_amount:
thumbnail_url:
option_values: []
@@ -5858,9 +5788,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R955327459
- token: VAgPPZ19UcA12TtLXAgamX8xsrF65CrVFMb
+ number: R205272356
+ token: Hj1DwwY7WR3KJ9Jo6mMdDdTGmn3KFr4XBdc
customer_note:
currency: USD
locale: en
@@ -5886,8 +5816,8 @@ paths:
delivery_total: '0.0'
display_delivery_total: "$0.00"
warnings: []
- created_at: '2026-03-26T13:17:51.158Z'
- updated_at: '2026-03-26T13:17:51.213Z'
+ created_at: '2026-03-28T11:44:41.729Z'
+ updated_at: '2026-03-28T11:44:41.769Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -5907,8 +5837,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 472222
- slug: product-472222
+ name: Product 47640
+ slug: product-47640
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -5927,8 +5857,6 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-26T13:17:51.194Z'
- updated_at: '2026-03-26T13:17:51.212Z'
compare_at_amount:
thumbnail_url:
option_values: []
@@ -6031,9 +5959,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R026635284
- token: YDheH8qmEXA8VLpCa8x4mfugzJ7RBfuzQTA
+ number: R447901517
+ token: byRB2Rwjz1NXHnLmJN8cUjH5P27q5MJdfpS
customer_note:
currency: USD
locale: en
@@ -6059,8 +5987,8 @@ paths:
delivery_total: '0.0'
display_delivery_total: "$0.00"
warnings: []
- created_at: '2026-03-26T13:17:51.776Z'
- updated_at: '2026-03-26T13:17:51.853Z'
+ created_at: '2026-03-28T11:44:42.311Z'
+ updated_at: '2026-03-28T11:44:42.361Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -6634,7 +6562,7 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R441563159
+ number: R452559491
customer_note:
currency: USD
@@ -6662,9 +6590,9 @@ paths:
display_delivery_total: "$100.00"
fulfillment_status:
payment_status:
- completed_at: '2026-03-26T13:17:53.818Z'
- created_at: '2026-03-26T13:17:53.765Z'
- updated_at: '2026-03-26T13:17:53.817Z'
+ completed_at: '2026-03-28T11:44:44.131Z'
+ created_at: '2026-03-28T11:44:44.079Z'
+ updated_at: '2026-03-28T11:44:44.131Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -6674,8 +6602,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 514412
- slug: product-514412
+ name: Product 51893
+ slug: product-51893
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -6694,21 +6622,17 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-26T13:17:53.796Z'
- updated_at: '2026-03-26T13:17:53.796Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H64091695031
+ number: H30111459725
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-26T13:17:53.802Z'
- updated_at: '2026-03-26T13:17:53.815Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -6723,7 +6647,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_196
- name: Chas Torp
+ name: Maynard Franecki
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -6859,13 +6783,13 @@ paths:
id: ps_gbHJdmfrXB
status: pending
currency: USD
- external_id: bogus_b55945f684e1fd976a66a0b2
+ external_id: bogus_132b1569948ecfadcdbe8874
external_data:
- client_secret: bogus_secret_4b95fcc58592cb77
+ client_secret: bogus_secret_d6b143775506dc90
customer_external_id:
expires_at:
- created_at: '2026-03-26T13:17:56.410Z'
- updated_at: '2026-03-26T13:17:56.410Z'
+ created_at: '2026-03-28T11:44:45.965Z'
+ updated_at: '2026-03-28T11:44:45.965Z'
amount: '110.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -6960,13 +6884,13 @@ paths:
id: ps_UkLWZg9DAJ
status: pending
currency: USD
- external_id: bogus_4c0db6e3141ae192f11e2471
+ external_id: bogus_c5cab895f3d52d70a29280ac
external_data:
client_secret: secret_123
customer_external_id:
expires_at:
- created_at: '2026-03-26T13:17:57.034Z'
- updated_at: '2026-03-26T13:17:57.034Z'
+ created_at: '2026-03-28T11:44:46.552Z'
+ updated_at: '2026-03-28T11:44:46.552Z'
amount: '110.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -7023,13 +6947,13 @@ paths:
id: ps_UkLWZg9DAJ
status: pending
currency: USD
- external_id: bogus_2a3f62f5b31408b23db9fffd
+ external_id: bogus_ccbdfd77500441200772517c
external_data:
client_secret: secret_123
customer_external_id:
expires_at:
- created_at: '2026-03-26T13:17:58.379Z'
- updated_at: '2026-03-26T13:17:58.397Z'
+ created_at: '2026-03-28T11:44:47.742Z'
+ updated_at: '2026-03-28T11:44:47.754Z'
amount: '50.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -7126,13 +7050,13 @@ paths:
id: ps_UkLWZg9DAJ
status: completed
currency: USD
- external_id: bogus_3d608c7c09fe2eb925fa46ac
+ external_id: bogus_aead88c358a7f75df7d4582e
external_data:
client_secret: secret_123
customer_external_id:
expires_at:
- created_at: '2026-03-26T13:17:59.041Z'
- updated_at: '2026-03-26T13:17:59.061Z'
+ created_at: '2026-03-28T11:44:48.354Z'
+ updated_at: '2026-03-28T11:44:48.370Z'
amount: '110.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -7212,11 +7136,11 @@ paths:
example:
id: pss_gbHJdmfrXB
status: pending
- external_id: bogus_seti_7935ee2a3299da26c85eddf9
- external_client_secret: bogus_seti_secret_b636a5bc0231ca06
+ external_id: bogus_seti_ffa887037b1a2d5db661acdb
+ external_client_secret: bogus_seti_secret_8d681b68e0390503
external_data: {}
- created_at: '2026-03-26T13:18:00.375Z'
- updated_at: '2026-03-26T13:18:00.375Z'
+ created_at: '2026-03-28T11:44:49.525Z'
+ updated_at: '2026-03-28T11:44:49.525Z'
payment_method_id: pm_UkLWZg9DAJ
payment_source_id:
payment_source_type:
@@ -7313,12 +7237,12 @@ paths:
example:
id: pss_UkLWZg9DAJ
status: pending
- external_id: seti_test_66c1c23db60ae8782e08e291
- external_client_secret: seti_secret_4eed61e48053229cd9fc06bc
+ external_id: seti_test_8f5449c51058d217b826df7c
+ external_client_secret: seti_secret_883bafc0d7c8fb731626611c
external_data:
client_secret: secret_123
- created_at: '2026-03-26T13:18:02.130Z'
- updated_at: '2026-03-26T13:18:02.130Z'
+ created_at: '2026-03-28T11:44:51.144Z'
+ updated_at: '2026-03-28T11:44:51.144Z'
payment_method_id: pm_UkLWZg9DAJ
payment_source_id:
payment_source_type:
@@ -7391,12 +7315,12 @@ paths:
example:
id: pss_UkLWZg9DAJ
status: completed
- external_id: seti_test_e15aba15a5e0d8c2f7739e38
- external_client_secret: seti_secret_57300fda99fa4e19a4999a5c
+ external_id: seti_test_d2579f547bf5dce4d54cf9d9
+ external_client_secret: seti_secret_fe3423a1c88419a37bfa407a
external_data:
client_secret: secret_123
- created_at: '2026-03-26T13:18:03.285Z'
- updated_at: '2026-03-26T13:18:03.303Z'
+ created_at: '2026-03-28T11:44:52.226Z'
+ updated_at: '2026-03-28T11:44:52.239Z'
payment_method_id: pm_UkLWZg9DAJ
payment_source_id: card_UkLWZg9DAJ
payment_source_type: Spree::CreditCard
@@ -7487,11 +7411,9 @@ paths:
id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
response_code:
- number: PX4UJ4MH
+ number: P4X4IXCS
amount: '110.0'
display_amount: "$110.00"
- created_at: '2026-03-26T13:18:04.515Z'
- updated_at: '2026-03-26T13:18:04.515Z'
status: checkout
source_type:
source_id:
@@ -7582,18 +7504,18 @@ paths:
slug: privacy-policy
body: ''
body_html: ''
- created_at: '2026-03-26T13:17:08.309Z'
- updated_at: '2026-03-26T13:17:08.309Z'
+ created_at: '2026-03-28T11:44:03.210Z'
+ updated_at: '2026-03-28T11:44:03.210Z'
- id: pol_OIJLhNcSbf
name: Privacy Policy
- slug: privacy-policy-46a31888-f229-427e-8422-4b86ac25188f
+ slug: privacy-policy-de29572b-500d-477e-aa78-5b62fb06af10
body: We respect your privacy.
body_html: |
<div class="trix-content">
We respect your privacy.
</div>
- created_at: '2026-03-26T13:18:05.163Z'
- updated_at: '2026-03-26T13:18:05.163Z'
+ created_at: '2026-03-28T11:44:54.121Z'
+ updated_at: '2026-03-28T11:44:54.124Z'
- id: pol_uw2YK1rnl0
name: Return Policy
slug: return-policy
@@ -7602,29 +7524,29 @@ paths:
<div class="trix-content">
You can return items within 30 days.
</div>
- created_at: '2026-03-26T13:18:05.156Z'
- updated_at: '2026-03-26T13:18:05.157Z'
+ created_at: '2026-03-28T11:44:54.113Z'
+ updated_at: '2026-03-28T11:44:54.114Z'
- id: pol_EfhxLZ9ck8
name: Returns Policy
slug: returns-policy
body: ''
body_html: ''
- created_at: '2026-03-26T13:17:08.316Z'
- updated_at: '2026-03-26T13:17:08.316Z'
+ created_at: '2026-03-28T11:44:03.215Z'
+ updated_at: '2026-03-28T11:44:03.215Z'
- id: pol_VqXmZF31wY
name: Shipping Policy
slug: shipping-policy
body: ''
body_html: ''
- created_at: '2026-03-26T13:17:08.327Z'
- updated_at: '2026-03-26T13:17:08.327Z'
+ created_at: '2026-03-28T11:44:03.219Z'
+ updated_at: '2026-03-28T11:44:03.219Z'
- id: pol_UkLWZg9DAJ
name: Terms of Service
slug: terms-of-service
body: ''
body_html: ''
- created_at: '2026-03-26T13:17:08.299Z'
- updated_at: '2026-03-26T13:17:08.299Z'
+ created_at: '2026-03-28T11:44:03.205Z'
+ updated_at: '2026-03-28T11:44:03.205Z'
meta:
page: 1
limit: 25
@@ -7707,8 +7629,8 @@ paths:
<div class="trix-content">
You can return items within 30 days.
</div>
- created_at: '2026-03-26T13:18:05.238Z'
- updated_at: '2026-03-26T13:18:05.239Z'
+ created_at: '2026-03-28T11:44:54.189Z'
+ updated_at: '2026-03-28T11:44:54.190Z'
schema:
"$ref": "#/components/schemas/Policy"
'404':
@@ -7842,14 +7764,12 @@ paths:
example:
data:
- id: prod_UkLWZg9DAJ
- name: Product 618407
- slug: product-618407
+ name: Product 613778
+ slug: product-613778
meta_description:
meta_keywords:
variant_count: 1
- available_on: '2025-03-26T13:18:05.332Z'
- created_at: '2026-03-26T13:18:05.349Z'
- updated_at: '2026-03-26T13:18:05.400Z'
+ available_on: '2025-03-28T11:44:54.314Z'
purchasable: true
in_stock: false
backorderable: true
@@ -7871,24 +7791,40 @@ paths:
price_list_id:
original_price:
- id: prod_gbHJdmfrXB
- name: Product 626275
- slug: product-626275
+ name: Product 628456
+ slug: product-628456
meta_description:
meta_keywords:
variant_count: 0
- available_on: '2025-03-26T13:18:05.406Z'
- created_at: '2026-03-26T13:18:05.417Z'
- updated_at: '2026-03-26T13:18:05.432Z'
+ available_on: '2025-03-28T11:44:54.437Z'
purchasable: true
in_stock: false
backorderable: true
available: true
- description: Quas qui quo autem nihil atque. Laborum id iusto at
- error. Impedit ipsum vitae odit aliquid blanditiis. Modi alias
- iste possimus labore.
- description_html: Quas qui quo autem nihil atque. Laborum id iusto
- at error. Impedit ipsum vitae odit aliquid blanditiis. Modi alias
- iste possimus labore.
+ description: Ab eveniet ex impedit consequatur. Veniam voluptatem
+ totam eligendi quasi. Rem nesciunt nostrum dolores non eius repellat.
+ Rerum et qui ipsum ducimus sint ullam mollitia sequi. Maiores
+ eaque ad molestias adipisci quae dolor minima tempore. Quae in
+ a reiciendis ipsum quibusdam voluptatem. Eveniet est quod id sit
+ nam. Quam ipsa officia ex perspiciatis consequuntur reprehenderit
+ dolor harum. Enim qui iusto facere magnam nihil. Ea laboriosam
+ laborum possimus doloremque non ad. Occaecati explicabo voluptatibus
+ fugit assumenda nesciunt eius totam est. Corporis fuga vero alias
+ cupiditate ipsum. Mollitia delectus deleniti repudiandae voluptas
+ natus eaque. Labore facilis quia nam quos. Facilis minus occaecati
+ reiciendis incidunt ullam. Quos eos dolorum voluptatibus facilis
+ quidem molestias. Neque nostrum autem laboriosam minima doloremque
+ veritatis. Quia id excepturi adipisci explicabo corporis magni
+ aperiam. Reprehenderit minima explicabo eligendi ratione officia
+ eum. Optio quibusdam sequi numquam quasi sint dolorum aut. Debitis
+ rem maiores eum eveniet labore laudantium libero placeat. Adipisci
+ culpa velit laboriosam veniam quisquam.
+ description_html: |-
+ Ab eveniet ex impedit consequatur. Veniam voluptatem totam eligendi quasi. Rem nesciunt nostrum dolores non eius repellat. Rerum et qui ipsum ducimus sint ullam mollitia sequi.
+ Maiores eaque ad molestias adipisci quae dolor minima tempore. Quae in a reiciendis ipsum quibusdam voluptatem. Eveniet est quod id sit nam. Quam ipsa officia ex perspiciatis consequuntur reprehenderit dolor harum. Enim qui iusto facere magnam nihil.
+ Ea laboriosam laborum possimus doloremque non ad. Occaecati explicabo voluptatibus fugit assumenda nesciunt eius totam est. Corporis fuga vero alias cupiditate ipsum. Mollitia delectus deleniti repudiandae voluptas natus eaque. Labore facilis quia nam quos.
+ Facilis minus occaecati reiciendis incidunt ullam. Quos eos dolorum voluptatibus facilis quidem molestias. Neque nostrum autem laboriosam minima doloremque veritatis. Quia id excepturi adipisci explicabo corporis magni aperiam. Reprehenderit minima explicabo eligendi ratione officia eum.
+ Optio quibusdam sequi numquam quasi sint dolorum aut. Debitis rem maiores eum eveniet labore laudantium libero placeat. Adipisci culpa velit laboriosam veniam quisquam.
default_variant_id: variant_EfhxLZ9ck8
thumbnail_url:
tags: []
@@ -7990,14 +7926,12 @@ paths:
application/json:
example:
id: prod_UkLWZg9DAJ
- name: Product 893938
- slug: product-893938
+ name: Product 898744
+ slug: product-898744
meta_description:
meta_keywords:
variant_count: 1
- available_on: '2025-03-26T13:18:07.143Z'
- created_at: '2026-03-26T13:18:07.160Z'
- updated_at: '2026-03-26T13:18:07.208Z'
+ available_on: '2025-03-28T11:44:56.202Z'
purchasable: true
in_stock: false
backorderable: true
@@ -8024,7 +7958,7 @@ paths:
amount_in_cents: 999
currency: USD
display_amount: "$9.99"
- recorded_at: '2026-03-11T13:18:07Z'
+ recorded_at: '2026-03-13T11:44:56Z'
schema:
"$ref": "#/components/schemas/Product"
'404':
@@ -8395,9 +8329,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R243711959
- token: XB4uoaX8fxRY3NUrazJnw2S7ZKd5KuBFfud
+ number: R470378577
+ token: EcFZWz7Ufqt4NtrvsFNsqSjHoiJTgn7viEX
customer_note:
currency: USD
locale: en
@@ -8423,8 +8357,8 @@ paths:
delivery_total: '100.0'
display_delivery_total: "$100.00"
warnings: []
- created_at: '2026-03-26T13:18:12.450Z'
- updated_at: '2026-03-26T13:18:12.507Z'
+ created_at: '2026-03-28T11:45:01.476Z'
+ updated_at: '2026-03-28T11:45:01.532Z'
store_credit_total: '10.0'
display_store_credit_total: "-$10.00"
covered_by_store_credit: false
@@ -8438,8 +8372,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 1094953
- slug: product-1094953
+ name: Product 1091188
+ slug: product-1091188
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -8458,21 +8392,17 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-26T13:18:12.483Z'
- updated_at: '2026-03-26T13:18:12.483Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H35216067938
+ number: H71663271461
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-26T13:18:12.490Z'
- updated_at: '2026-03-26T13:18:12.504Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -8487,7 +8417,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_270
- name: Kathi Schroeder
+ name: Elfreda Klocko
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -8508,12 +8438,10 @@ paths:
payments:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- response_code: 1-SC-20260326131812802814
- number: PFD4WVKW
+ response_code: 1-SC-20260328114501826734
+ number: PBHFJF30
amount: '10.0'
display_amount: "$10.00"
- created_at: '2026-03-26T13:18:12.806Z'
- updated_at: '2026-03-26T13:18:12.806Z'
status: checkout
source_type: store_credit
source_id: credit_UkLWZg9DAJ
@@ -8650,9 +8578,9 @@ paths:
application/json:
example:
id: cart_UkLWZg9DAJ
- number: R136455792
- token: Rj7DQ1rY7Xm7wMmiDxhUPK7Z1YP2856kAev
+ number: R622549951
+ token: MyY9rYwsF7BdLjFybQ5YrnLLomoUo19YEke
customer_note:
currency: USD
locale: en
@@ -8678,8 +8606,8 @@ paths:
delivery_total: '100.0'
display_delivery_total: "$100.00"
warnings: []
- created_at: '2026-03-26T13:18:14.046Z'
- updated_at: '2026-03-26T13:18:14.111Z'
+ created_at: '2026-03-28T11:45:03.029Z'
+ updated_at: '2026-03-28T11:45:03.079Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -8696,8 +8624,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 1113234
- slug: product-1113234
+ name: Product 1117073
+ slug: product-1117073
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -8716,21 +8644,17 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-03-26T13:18:14.085Z'
- updated_at: '2026-03-26T13:18:14.085Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H71197635883
+ number: H69554883339
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
- created_at: '2026-03-26T13:18:14.091Z'
- updated_at: '2026-03-26T13:18:14.108Z'
status: pending
fulfillment_type: shipping
fulfilled_at:
@@ -8745,7 +8669,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_278
- name: Brendon Cartwright
+ name: Shirl Spencer
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -8866,9 +8790,9 @@ paths:
data:
- id: wl_UkLWZg9DAJ
name: My Wishlist
- token: FTvjPQKa2NTfVxmes3KbbpUk
- created_at: '2026-03-26T13:18:14.700Z'
- updated_at: '2026-03-26T13:18:14.700Z'
+ token: f8eHPYcKdtoxCRsM88BQ2oiY
+ created_at: '2026-03-28T11:45:03.675Z'
+ updated_at: '2026-03-28T11:45:03.675Z'
is_default: false
is_private: true
meta:
@@ -8944,9 +8868,9 @@ paths:
example:
id: wl_gbHJdmfrXB
name: Birthday Ideas
- token: Cmj2moiAaXAve4TKWCxzGSQK
- created_at: '2026-03-26T13:18:15.943Z'
- updated_at: '2026-03-26T13:18:15.943Z'
+ token: H6fUUENRHresudGzrEcTNvML
+ created_at: '2026-03-28T11:45:04.902Z'
+ updated_at: '2026-03-28T11:45:04.902Z'
is_default: false
is_private: true
schema:
@@ -9042,9 +8966,9 @@ paths:
example:
id: wl_UkLWZg9DAJ
name: My Wishlist
- token: gAFtXpT19VrM7HyACA9MK55Q
- created_at: '2026-03-26T13:18:17.110Z'
- updated_at: '2026-03-26T13:18:17.110Z'
+ token: 6UiSjPZj1T76wAPtymUow9EQ
+ created_at: '2026-03-28T11:45:06.131Z'
+ updated_at: '2026-03-28T11:45:06.131Z'
is_default: false
is_private: true
schema:
@@ -9106,9 +9030,9 @@ paths:
example:
id: wl_UkLWZg9DAJ
name: Updated Name
- token: cmRnw1CLfYcHkto2xTUF6zMt
- created_at: '2026-03-26T13:18:18.310Z'
- updated_at: '2026-03-26T13:18:18.366Z'
+ token: jqmLoKfWNc6mkiCpwv1GyRH3
+ created_at: '2026-03-28T11:45:07.362Z'
+ updated_at: '2026-03-28T11:45:07.415Z'
is_default: false
is_private: true
schema:
@@ -9220,8 +9144,8 @@ paths:
variant_id: variant_gbHJdmfrXB
wishlist_id: wl_UkLWZg9DAJ
quantity: 1
- created_at: '2026-03-26T13:18:19.663Z'
- updated_at: '2026-03-26T13:18:19.663Z'
+ created_at: '2026-03-28T11:45:08.615Z'
+ updated_at: '2026-03-28T11:45:08.615Z'
variant:
id: variant_gbHJdmfrXB
product_id: prod_gbHJdmfrXB
@@ -9229,8 +9153,6 @@ paths:
options_text: ''
track_inventory: true
media_count: 0
- created_at: '2026-03-26T13:18:19.640Z'
- updated_at: '2026-03-26T13:18:19.650Z'
thumbnail_url:
purchasable: true
in_stock: false
@@ -9852,10 +9774,10 @@ components:
type: array
items:
"$ref": "#/components/schemas/Category"
- metafields:
+ custom_fields:
type: array
items:
- "$ref": "#/components/schemas/Metafield"
+ "$ref": "#/components/schemas/CustomField"
required:
- id
- name
@@ -9950,6 +9872,26 @@ components:
- name
- symbol
x-typelizer: true
+ CustomField:
+ type: object
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ type:
+ type: string
+ key:
+ type: string
+ value:
+ type: object
+ required:
+ - id
+ - name
+ - type
+ - key
+ - value
+ x-typelizer: true
Customer:
type: object
properties:
@@ -9968,10 +9910,6 @@ components:
nullable: true
accepts_email_marketing:
type: boolean
- created_at:
- type: string
- updated_at:
- type: string
available_store_credit_total:
type: string
display_available_store_credit_total:
@@ -9995,8 +9933,6 @@ components:
- last_name
- phone
- accepts_email_marketing
- - created_at
- - updated_at
- available_store_credit_total
- display_available_store_credit_total
- addresses
@@ -10055,10 +9991,6 @@ components:
type: string
content_type:
type: string
- created_at:
- type: string
- updated_at:
- type: string
download_url:
type: string
authorizable:
@@ -10072,8 +10004,6 @@ components:
- access_counter
- filename
- content_type
- - created_at
- - updated_at
- download_url
- authorizable
- expired
@@ -10142,10 +10072,6 @@ components:
type: string
display_cost:
type: string
- created_at:
- type: string
- updated_at:
- type: string
status:
type: string
fulfillment_type:
@@ -10172,8 +10098,6 @@ components:
- tracking_url
- cost
- display_cost
- - created_at
- - updated_at
- status
- fulfillment_type
- fulfilled_at
@@ -10385,10 +10309,6 @@ components:
display_compare_at_amount:
type: string
nullable: true
- created_at:
- type: string
- updated_at:
- type: string
compare_at_amount:
type: string
nullable: true
@@ -10428,8 +10348,6 @@ components:
- discounted_amount
- display_discounted_amount
- display_compare_at_amount
- - created_at
- - updated_at
- compare_at_amount
- thumbnail_url
- option_values
@@ -10506,10 +10424,6 @@ components:
external_video_url:
type: string
nullable: true
- created_at:
- type: string
- updated_at:
- type: string
original_url:
type: string
nullable: true
@@ -10541,8 +10455,6 @@ components:
- focal_point_x
- focal_point_y
- external_video_url
- - created_at
- - updated_at
- original_url
- mini_url
- small_url
@@ -10551,26 +10463,6 @@ components:
- xlarge_url
- og_image_url
x-typelizer: true
- Metafield:
- type: object
- properties:
- id:
- type: string
- name:
- type: string
- type:
- type: string
- key:
- type: string
- value:
- type: object
- required:
- - id
- - name
- - type
- - key
- - value
- x-typelizer: true
NewsletterSubscriber:
type: object
properties:
@@ -10829,10 +10721,6 @@ components:
type: string
display_amount:
type: string
- created_at:
- type: string
- updated_at:
- type: string
status:
type: string
source_type:
@@ -10860,8 +10748,6 @@ components:
- number
- amount
- display_amount
- - created_at
- - updated_at
- status
- source_type
- source_id
@@ -11086,10 +10972,6 @@ components:
available_on:
type: string
nullable: true
- created_at:
- type: string
- updated_at:
- type: string
purchasable:
type: boolean
in_stock:
@@ -11139,10 +11021,10 @@ components:
type: array
items:
"$ref": "#/components/schemas/Category"
- metafields:
+ custom_fields:
type: array
items:
- "$ref": "#/components/schemas/Metafield"
+ "$ref": "#/components/schemas/CustomField"
prior_price:
allOf:
- "$ref": "#/components/schemas/PriceHistory"
@@ -11155,8 +11037,6 @@ components:
- meta_keywords
- variant_count
- available_on
- - created_at
- - updated_at
- purchasable
- in_stock
- backorderable
@@ -11196,10 +11076,6 @@ components:
transaction_id:
type: string
nullable: true
- created_at:
- type: string
- updated_at:
- type: string
amount:
type: string
nullable: true
@@ -11215,8 +11091,6 @@ components:
required:
- id
- transaction_id
- - created_at
- - updated_at
- amount
- payment_id
- refund_reason_id
@@ -11229,10 +11103,6 @@ components:
type: string
number:
type: string
- created_at:
- type: string
- updated_at:
- type: string
status:
type: string
order_id:
@@ -11247,8 +11117,6 @@ components:
required:
- id
- number
- - created_at
- - updated_at
- status
- order_id
- stock_location_id
@@ -11403,10 +11271,6 @@ components:
type: boolean
media_count:
type: number
- created_at:
- type: string
- updated_at:
- type: string
thumbnail_url:
type: string
nullable: true
@@ -11444,10 +11308,10 @@ components:
type: array
items:
"$ref": "#/components/schemas/OptionValue"
- metafields:
+ custom_fields:
type: array
items:
- "$ref": "#/components/schemas/Metafield"
+ "$ref": "#/components/schemas/CustomField"
prior_price:
allOf:
- "$ref": "#/components/schemas/PriceHistory"
@@ -11459,8 +11323,6 @@ components:
- options_text
- track_inventory
- media_count
- - created_at
- - updated_at
- thumbnail_url
- purchasable
- in_stock
diff --git a/docs/developer/core-concepts/metafields.mdx b/docs/developer/core-concepts/metafields.mdx
index 2a5960636d..3b16e86b84 100644
--- a/docs/developer/core-concepts/metafields.mdx
+++ b/docs/developer/core-concepts/metafields.mdx
@@ -175,18 +175,22 @@ When editing a resource (e.g., a product), metafields appear in a dedicated sect
## Metafields vs Metadata
-| Feature | Metafields | Metadata |
+Spree has two permanent, complementary systems for custom data — **metadata for machines, metafields for humans**. They serve different purposes and are not interchangeable. Neither is going away.
+
+| Feature | Metafields | [Metadata](/developer/customization/metadata) |
|---------|-----------|----------|
-| Structure | Strongly typed, schema-defined | Flat key-value JSON |
-| Validation | Type-specific validation | None |
-| Visibility | Configurable (front/back/both) | Write-only in Store API |
-| Admin UI | Dedicated management forms | JSON preview |
-| Data Types | 6 specific types | Any JSON-serializable data |
-| Organization | Namespaced (`namespace.key`) | Flat structure |
+| **Purpose** | Merchant-defined structured attributes | Developer escape hatch — integration IDs, sync state |
+| **Schema** | Defined via MetafieldDefinitions | Schemaless JSON — no definition required |
+| **Validation** | Type-specific (text, number, boolean, etc.) | None — accepts any JSON-serializable data |
+| **Visibility** | Configurable (front-end, back-end, both) | Write-only in Store API, readable in Admin API |
+| **Admin UI** | Dedicated management forms | JSON preview |
+| **Data Types** | 6 specific types | Any JSON value |
+| **Organization** | Namespaced (`namespace.key`) | Flat key-value structure |
+| **Queryable** | Via SQL joins, Ransack scopes, search providers | Via JSONB operators (PostgreSQL) |
**Use Metafields** when you need type validation, visibility control, admin UI forms, or organized namespacing.
-**Use Metadata** for external system IDs, tracking attribution, or simple write-and-forget data.
+**Use [Metadata](/developer/customization/metadata)** for external system IDs, tracking attribution, syncing with integrations, or simple write-and-forget data that only backend systems need to read.
<Warning>
Product Properties are deprecated and will be removed in Spree 6.0. For new projects, always use Metafields. For existing projects, plan to migrate using the [migration guide](/developer/upgrades/5.1-to-5.2#3-migrate-to-metafields-or-keep-using-properties).
diff --git a/docs/developer/customization/dependencies.mdx b/docs/developer/customization/dependencies.mdx
index 2240c16ece..0a32e83e1b 100644
--- a/docs/developer/customization/dependencies.mdx
+++ b/docs/developer/customization/dependencies.mdx
@@ -35,7 +35,7 @@ And add the following code to it:
```ruby
class MyAddToCartService < Spree::Cart::AddItem
- def call(order:, variant:, quantity: nil, public_metadata: {}, private_metadata: {}, options: {})
+ def call(order:, variant:, quantity: nil, metadata: {}, options: {})
ApplicationRecord.transaction do
run :add_to_line_item
run Spree.cart_recalculate_service
diff --git a/docs/developer/customization/metadata.mdx b/docs/developer/customization/metadata.mdx
index b36b56a68c..1f710bf2fc 100644
--- a/docs/developer/customization/metadata.mdx
+++ b/docs/developer/customization/metadata.mdx
@@ -6,6 +6,8 @@ title: Metadata
Metadata provides simple, unstructured key-value storage on Spree resources — similar to [Stripe's metadata](https://docs.stripe.com/api/metadata). It's ideal for storing integration IDs, tracking data, or any arbitrary information that doesn't need validation or admin UI.
+Metadata is a **permanent, first-class system** in Spree. It is designed to coexist alongside [Metafields](/developer/core-concepts/metafields) (structured, typed, admin-managed). The two systems serve different purposes and are not interchangeable — think of it as **metadata for machines, metafields for humans**.
+
Metadata is **write-only** in the Store API — you can set it when creating or updating resources, but it is never returned in Store API responses. It is visible in Admin API responses for administrative use.
<Info>
@@ -146,7 +148,7 @@ When there is no metadata, the field is `null`.
### Reading and writing
-Every model that includes `Spree::Metadata` has a `metadata` accessor (alias for `private_metadata`):
+Every model that includes `Spree::Metadata` has a `metadata` accessor. Always use `metadata` — do not use `public_metadata` or `private_metadata` directly:
```ruby
order = Spree::Order.find_by!(number: 'R123456')
@@ -190,14 +192,17 @@ Metadata updates use **merge semantics** — existing keys are preserved, new ke
## Metadata vs Metafields
+Spree has two permanent, complementary systems for custom data. They are not interchangeable and neither is going away.
+
| | Metadata | [Metafields](/developer/core-concepts/metafields) |
|---|---|---|
-| **Use case** | Integration data, tracking, simple key-value | Structured custom attributes with admin UI |
-| **Validation** | None | Type-specific (text, number, boolean, JSON) |
+| **Purpose** | Developer escape hatch — integration data, sync state, ad-hoc flags | Merchant-defined structured attributes with admin UI |
+| **Schema** | Schemaless JSON — no definition required | Defined via MetafieldDefinitions (typed, validated) |
+| **Validation** | None — accepts any JSON-serializable data | Type-specific (text, number, boolean, rich text, JSON) |
| **Visibility** | Write-only in Store API, readable in Admin API | Configurable (front-end, back-end, both) |
-| **Admin UI** | Viewable in JSON preview | Full admin management |
-| **Schema** | Schemaless JSON | Defined via MetafieldDefinitions |
-| **API pattern** | Stripe-style flat key-value | Shopify-style typed resources |
+| **Admin UI** | JSON preview only | Dedicated management forms |
+| **API pattern** | Stripe-style: `metadata: { key: value }` | Expand-based: `?expand=metafields` |
+| **Queryable** | Via JSONB operators (PostgreSQL) | Via SQL joins, Ransack scopes, search providers |
### When to use metadata
@@ -205,13 +210,15 @@ Metadata updates use **merge semantics** — existing keys are preserved, new ke
- Tracking attribution data (UTM parameters, referral source)
- Passing context from the storefront that doesn't need validation
- Any write-and-forget data that only needs to be read by backend systems
+- Syncing state with external integrations (webhooks, ETL pipelines)
### When to use metafields
-- Custom product specifications shown to customers
-- Admin-managed fields with validation
-- Data that needs to appear in the admin UI
-- Querying/filtering by custom attributes
+- Custom product specifications shown to customers (material, dimensions, certifications)
+- Admin-managed fields with validation and type safety
+- Data that needs to appear in the admin UI with dedicated form inputs
+- Querying/filtering by custom attributes (search facets, product filtering)
+- CSV import/export of structured product data
## Supported resources
@@ -222,17 +229,23 @@ The Store API currently supports writing metadata on:
- **Carts** — on creation and update (`POST /api/v3/store/carts`, `PATCH /api/v3/store/carts/:id`)
- **Items** — on create and update (`POST/PATCH /api/v3/store/carts/:id/items`)
-## Migration from public_metadata
+## Deprecation: public_metadata
+
+<Warning>
+`public_metadata` is deprecated and will be removed in Spree 6.0. Use `metadata` instead.
+</Warning>
+
+The `public_metadata` column was never exposed in Store API responses and in practice served the same purpose as `private_metadata`. It will be removed in Spree 6.0 and calling `public_metadata=` will emit a deprecation warning.
-The `public_metadata` column is deprecated. Metadata is no longer returned in Store API responses. If you were using `public_metadata` for data that needs to be visible to customers, migrate to [Metafields](/developer/core-concepts/metafields) with `display_on: 'both'`.
+Always use the single `metadata` accessor for all schemaless key-value storage. If you need data visible to customers on the storefront, use [Metafields](/developer/core-concepts/metafields) instead.
```ruby
-# Before (deprecated)
+# Deprecated — will be removed in 6.0
order.public_metadata = { 'gift_message' => 'Happy Birthday!' }
-# After — use metadata for write-only storage
+# Use metadata for internal storage
order.metadata = { 'gift_message' => 'Happy Birthday!' }
-# After — use metafields for customer-visible structured data
+# Use metafields for customer-visible structured data
order.set_metafield('custom.gift_message', 'Happy Birthday!')
```
diff --git a/docs/plans/5.4-6.0-custom-fields-rename.md b/docs/plans/5.4-6.0-custom-fields-rename.md
new file mode 100644
index 0000000000..c2ae94b122
--- /dev/null
+++ b/docs/plans/5.4-6.0-custom-fields-rename.md
@@ -0,0 +1,412 @@
+# Metafields → Custom Fields Rename
+
+**Status:** Draft
+**Target:** 5.4 (API bridge) + 6.0 (model rename + visibility simplification)
+**Depends on:** None — 5.4 changes are serializer/prefix renames. 6.0 rename is part of the model rename wave.
+**Author:** Damian + Claude
+**Last updated:** 2026-03-28
+
+## Summary
+
+Rename the "Metafields" system to "Custom Fields" and simplify the visibility model. The term "metafields" (borrowed from Shopify) creates confusion with the separate "metadata" system. "Custom Fields" is self-explanatory, merchant-friendly, and industry-standard (used by Vendure, commercetools, Salesforce, HubSpot, Jira, Linear).
+
+In 6.0, simplify the three-way `display_on` (both/front_end/back_end) to a single boolean `storefront_visible` on definitions. This makes the two-system design razor-sharp:
+
+- **Custom Fields** — public structured data (storefront-visible by default, toggle off for admin-only)
+- **Metadata** — private developer-owned data (never exposed to customers)
+
+The rename ships in two phases:
+1. **5.4** — Bridge the Store API surface: prefix IDs, expand parameter, serializer response keys, Admin API endpoint paths. Pure serializer-layer changes, no schema changes.
+2. **6.0** — Rename models, tables, concerns, STI types, visibility simplification, and all internal code.
+
+## Key Decisions (do not deviate without discussion)
+
+- **"Custom Fields"** not "Attributes" — avoids ambiguity with built-in attributes (name, price, SKU are also "attributes"). Aligns with Vendure, commercetools, and non-ecommerce SaaS conventions.
+- **Metadata is permanent and private** — `metadata` JSON column is the developer escape hatch. Never exposed in Store API. Not going away. Not being consolidated into custom fields.
+- **`public_metadata` is deprecated** — never was exposed in Store API, served same purpose as `private_metadata`. Single `metadata` accessor going forward. Deprecation warning when writing to `public_metadata` in 5.4, column dropped in 6.0.
+- **Visibility simplifies to a boolean in 6.0** — `display_on` (both/front_end/back_end) → `storefront_visible` (boolean, default: true). The `front_end`-only option was already excluded from MetafieldDefinition::DISPLAY and never made sense. This is a schema change and ships with the 6.0 model rename wave.
+- **5.4 is a clean break on API surface** — no aliases, no deprecation on API naming. Same approach as the 5.4-store-api-bridges plan. The underlying `display_on` column stays until 6.0.
+- **Two systems, clear boundary:**
+ - **Metadata** — for machines. Schemaless JSON. Developer-owned. Private. Think: Stripe's `metadata`.
+ - **Custom Fields** — for humans. Typed, validated, schema-defined. Merchant-managed. Public by default, with opt-out for admin-only fields. Think: Salesforce custom fields.
+
+## Industry Comparison
+
+### Naming
+
+| Platform | Unstructured (developer) | Structured (merchant/admin) | Naming clarity |
+|----------|-------------------------|----------------------------|----------------|
+| **Shopify** | Metafields (no definition) | Metafields (with MetafieldDefinition) | Confusing — same name for both |
+| **Saleor** | `metadata` / `privateMetadata` | **Attributes** (via ProductType) | Clear, but "Attributes" is ambiguous |
+| **Vendure** | None built-in | **Custom Fields** (code config) | Clear |
+| **commercetools** | Custom Objects (JSON) | **Custom Fields** (via Type + FieldDefinition) | Clear |
+| **Medusa v2** | `metadata` JSON property | Custom Modules (code-based) | Clear for metadata, heavy for structured |
+| **Spree (current)** | `metadata` JSON column | **Metafields** (via MetafieldDefinition) | Confusing — "meta" prefix collision |
+| **Spree (proposed)** | `metadata` JSON column | **Custom Fields** (via CustomFieldDefinition) | Clear |
+
+### Visibility on structured fields
+
+| Platform | Visibility control | Private developer store |
+|----------|-------------------|------------------------|
+| **Shopify** | `access: { admin, storefront }` per MetafieldDefinition | Metafields without definitions |
+| **Saleor** | `visibleInStorefront: boolean` per Attribute | `metadata` / `privateMetadata` |
+| **Vendure** | `public: boolean` per Custom Field (default: true) | No built-in unstructured store |
+| **commercetools** | No visibility toggle on Custom Fields | Custom Objects (separate system) |
+| **Spree (current)** | `display_on: both/front_end/back_end` | `metadata` JSON column |
+| **Spree (6.0)** | `storefront_visible: boolean` (default: true) | `metadata` JSON column |
+
+Our proposed `storefront_visible` boolean matches Vendure and Saleor exactly. The three-way `display_on` was overengineered — `front_end`-only (visible to customers but not admins) was already excluded and makes no sense.
+
+## Design Details
+
+### Visibility Simplification (6.0)
+
+#### Why drop the three-way split?
+
+Current `display_on` options on MetafieldDefinition:
+- `both` — Store API + Admin API (the common case)
+- `back_end` — Admin API only (overlaps with metadata's purpose)
+- `front_end` — already excluded from `MetafieldDefinition::DISPLAY`, never used
+
+Problems:
+1. `back_end`-only metafields overlap with metadata's purpose — merchants creating a "back_end" metafield are essentially using typed metadata
+2. Three-way enum is harder to explain than a boolean
+3. The `public_metafields` / `private_metafields` associations on models add complexity
+
+#### New model (6.0)
+
+Replace `display_on` (string) with `storefront_visible` (boolean, default: true):
+
+| `storefront_visible` | Store API | Admin API | Use case |
+|---------------------|:---------:|:---------:|----------|
+| `true` (default) | Yes | Yes | Product specs, customer-facing attributes |
+| `false` | No | Yes | Internal notes, compliance classification, supplier data |
+
+The valid use case for admin-only structured fields (internal margin tier, supplier cost notes, compliance tags) is preserved via `storefront_visible: false`. These need schema enforcement and admin UI forms — metadata is wrong for them because it's schemaless and has no form inputs.
+
+#### Model changes (6.0)
+
+On `Spree::CustomFieldDefinition` (renamed from MetafieldDefinition):
+- Add `storefront_visible` boolean column (default: true, null: false)
+- Data migration: `display_on IN ('both', 'front_end')` → `storefront_visible: true`, `display_on = 'back_end'` → `storefront_visible: false`
+- Remove `display_on` column
+- Remove `include Spree::DisplayOn`
+
+On `Spree::HasCustomFields` concern (renamed from Metafields) — simplify associations:
+```ruby
+# Before
+has_many :metafields, ...
+has_many :public_metafields, -> { available_on_front_end }, ...
+has_many :private_metafields, -> { available_on_back_end }, ...
+
+# After
+has_many :custom_fields, ...
+has_many :storefront_custom_fields, -> { storefront_visible }, ...
+# private_metafields removed entirely
+```
+
+Scopes on `Spree::CustomField`:
+```ruby
+# Before
+scope :available_on_front_end, -> { joins(:metafield_definition).merge(MetafieldDefinition.available_on_front_end) }
+scope :available_on_back_end, -> { joins(:metafield_definition).merge(MetafieldDefinition.available_on_back_end) }
+
+# After
+scope :storefront_visible, -> { joins(:custom_field_definition).where(spree_custom_field_definitions: { storefront_visible: true }) }
+```
+
+### Phase 1: 5.4 API Bridge
+
+#### Scope assessment
+
+The Store API surface is **very small** — metafields have no dedicated endpoints, only expand-based inclusion on 3 serializers:
+
+| Layer | Files to change | Nature of change |
+|-------|:--------------:|-----------------|
+| Store API serializers | 4 | Rename expand param + response key + serializer class |
+| Admin API serializers | 4 | Same, keep `display_on` as-is |
+| Admin API controllers | 1 | Rename endpoint path |
+| Dependencies registry | 1 | Rename keys |
+| Prefix IDs (models) | 2 | Change prefix strings |
+| Integration specs | 1 | Update expand param |
+| Serializer unit tests | 2 | Update assertions |
+| SDK types (auto-generated) | 4 | Regenerated |
+| SDK Zod schemas (auto-generated) | 3 | Regenerated |
+| OpenAPI spec (auto-generated) | 1 | Regenerated |
+| **Total** | **~23** | |
+
+No migrations. No Store API controllers touch metafields — all access is via `?expand=` on products, variants, and categories. Zero client SDK methods to rename (no CRUD endpoints for metafields in Store API).
+
+#### Prefix ID changes
+
+| Model | Old prefix | New prefix |
+|-------|-----------|------------|
+| `Spree::Metafield` | `mf_` | `cf_` |
+| `Spree::MetafieldDefinition` | `mfdef_` | `cfdef_` |
+
+`find_by_prefix_id!` ignores the prefix during decoding (splits on `_` and decodes Sqids portion), so old IDs with old prefixes still resolve correctly.
+
+#### Store API serializer changes
+
+Rename expand parameter and response key from `metafields` to `custom_fields`:
+
+```ruby
+# ProductSerializer — before
+many :public_metafields,
+ key: :metafields,
+ resource: Spree.api.metafield_serializer,
+ if: proc { expand?('metafields') }
+
+# ProductSerializer — after
+many :public_metafields,
+ key: :custom_fields,
+ resource: Spree.api.custom_field_serializer,
+ if: proc { expand?('custom_fields') }
+```
+
+Same change on: `VariantSerializer`, `CategorySerializer`.
+
+The underlying `public_metafields` association stays unchanged — it still filters by `display_on` internally. Only the API surface (expand param, response key, serializer class) changes.
+
+#### Store API CustomFieldSerializer (rename from MetafieldSerializer)
+
+New file `api/app/serializers/spree/api/v3/custom_field_serializer.rb`:
+
+```ruby
+module Spree
+ module Api
+ module V3
+ class CustomFieldSerializer < BaseSerializer
+ typelize key: :string, name: :string, type: :string, value: :any
+
+ attributes :name, :type
+
+ attribute :key do |metafield|
+ metafield.full_key
+ end
+
+ attribute :value do |metafield|
+ metafield.serialize_value
+ end
+ end
+ end
+ end
+end
+```
+
+Serializes `Spree::Metafield` model — same data, new file name and class name. Old `MetafieldSerializer` file is deleted.
+
+#### Admin API serializer changes
+
+Rename expand parameter and response key. Keep `display_on` until 6.0:
+
+```ruby
+# Admin::ProductSerializer — before
+many :metafields,
+ resource: Spree.api.admin_metafield_serializer,
+ if: proc { expand?('metafields') }
+
+# Admin::ProductSerializer — after
+many :metafields,
+ key: :custom_fields,
+ resource: Spree.api.admin_custom_field_serializer,
+ if: proc { expand?('custom_fields') }
+```
+
+Same change on: `Admin::VariantSerializer`, `Admin::CategorySerializer`.
+
+New file `api/app/serializers/spree/api/v3/admin/custom_field_serializer.rb`:
+
+```ruby
+module Spree
+ module Api
+ module V3
+ module Admin
+ class CustomFieldSerializer < V3::CustomFieldSerializer
+ typelize display_on: :string
+
+ attributes :display_on
+ end
+ end
+ end
+ end
+end
+```
+
+In 6.0, `display_on` becomes `storefront_visible: boolean`.
+
+#### Admin API CustomFieldDefinitionSerializer
+
+Rename `metafield_type` → `field_type` in serializer output. Keep `display_on` until 6.0:
+
+```ruby
+# Before
+attributes :display_on, :metafield_type
+
+# After
+attributes :display_on
+attribute :field_type do |definition|
+ definition.metafield_type
+end
+```
+
+#### Admin API endpoint renames
+
+```
+# Before
+GET/POST /api/v3/admin/metafield_definitions
+GET/PATCH/DELETE /api/v3/admin/metafield_definitions/:id
+
+# After
+GET/POST /api/v3/admin/custom_field_definitions
+GET/PATCH/DELETE /api/v3/admin/custom_field_definitions/:id
+```
+
+Controller file rename: `admin/metafield_definitions_controller.rb` → `admin/custom_field_definitions_controller.rb`. Internally still uses `Spree::MetafieldDefinition` model.
+
+#### Dependencies registration
+
+```ruby
+# Before
+metafield_serializer: 'Spree::Api::V3::MetafieldSerializer',
+admin_metafield_serializer: 'Spree::Api::V3::Admin::MetafieldSerializer',
+
+# After — add new keys, remove old
+custom_field_serializer: 'Spree::Api::V3::CustomFieldSerializer',
+admin_custom_field_serializer: 'Spree::Api::V3::Admin::CustomFieldSerializer',
+custom_field_definition_serializer: 'Spree::Api::V3::Admin::CustomFieldDefinitionSerializer',
+```
+
+#### SDK / TypeScript type changes
+
+```typescript
+// Before
+interface StoreMetafield { id: string; name: string; type: string; key: string; value: any }
+client.products.list({ expand: ['metafields'] })
+product.metafields
+
+// After
+interface StoreCustomField { id: string; name: string; type: string; key: string; value: any }
+client.products.list({ expand: ['custom_fields'] })
+product.custom_fields
+```
+
+Generated types rename: `StoreMetafield` → `StoreCustomField`, `AdminMetafield` → `AdminCustomField`, `AdminMetafieldDefinition` → `AdminCustomFieldDefinition`.
+
+#### public_metadata deprecation (5.4)
+
+Add deprecation warning in the `Spree::Metadata` concern when `public_metadata=` is called:
+
+```ruby
+def public_metadata=(value)
+ Spree::Deprecation.warn(
+ "public_metadata is deprecated. Use metadata instead. " \
+ "For customer-visible structured data, use metafields with display_on: 'both'."
+ )
+ super
+end
+```
+
+Update docs to advise using only the `metadata` accessor.
+
+#### What does NOT change in 5.4
+
+- Model names (`Spree::Metafield`, `Spree::MetafieldDefinition`)
+- Table names (`spree_metafields`, `spree_metafield_definitions`)
+- Database schema (no migrations — `display_on` column stays)
+- STI type column values (`Spree::Metafields::ShortText`, etc.)
+- Concern names (`Spree::Metafields`, `Spree::Metadata`)
+- Association names on models (`has_many :metafields`, `has_many :public_metafields`)
+- Internal `Spree.metafields` configuration
+- Event names
+- Admin UI (uses internal model layer, not API naming)
+- CSV export headers (internal, not API surface)
+
+### Phase 2: 6.0 Model Rename + Visibility Simplification
+
+Full internal rename. Part of the 6.0 model rename wave alongside Shipment→Fulfillment, ShippingMethod→DeliveryMethod, etc.
+
+| Current | 6.0 | Notes |
+|---------|-----|-------|
+| `Spree::Metafield` | `Spree::CustomField` | |
+| `Spree::MetafieldDefinition` | `Spree::CustomFieldDefinition` | |
+| `Spree::Metafields::ShortText` | `Spree::CustomFields::ShortText` | STI subclass |
+| `Spree::Metafields::LongText` | `Spree::CustomFields::LongText` | STI subclass |
+| `Spree::Metafields::RichText` | `Spree::CustomFields::RichText` | STI subclass |
+| `Spree::Metafields::Number` | `Spree::CustomFields::Number` | STI subclass |
+| `Spree::Metafields::Boolean` | `Spree::CustomFields::Boolean` | STI subclass |
+| `Spree::Metafields::Json` | `Spree::CustomFields::Json` | STI subclass |
+| `Spree::Metafields` concern | `Spree::HasCustomFields` | |
+| `spree_metafields` table | `spree_custom_fields` | |
+| `spree_metafield_definitions` table | `spree_custom_field_definitions` | |
+| `metafield_definition_id` FK | `custom_field_definition_id` FK | |
+| `metafield_type` column | `field_type` column | On definitions table |
+| `display_on` column (string) | `storefront_visible` column (boolean) | On definitions table |
+| `Spree.metafields` config | `Spree.custom_fields` config | |
+| `set_metafield` / `get_metafield` | `set_custom_field` / `get_custom_field` | Instance methods |
+| `has_metafield?` | `has_custom_field?` | Instance method |
+| `with_metafield_key` scope | `with_custom_field_key` scope | |
+| `with_metafield_key_value` scope | `with_custom_field_key_value` scope | |
+| `public_metafields` assoc | `storefront_custom_fields` assoc | |
+| `private_metafields` assoc | removed | |
+| Admin serializer `display_on: string` | `storefront_visible: boolean` | |
+
+#### 6.0 Metadata cleanup
+
+- Drop `public_metadata` column from all tables
+- Rename `private_metadata` → `metadata` in the database
+- Simplify `Spree::Metadata` concern to single `metadata` column with no alias indirection
+
+#### 6.0 Migrations
+
+1. Rename tables: `spree_metafields` → `spree_custom_fields`, `spree_metafield_definitions` → `spree_custom_field_definitions`
+2. Rename columns: `metafield_definition_id` → `custom_field_definition_id`, `metafield_type` → `field_type`
+3. Replace `display_on` with `storefront_visible`:
+ ```ruby
+ add_column :spree_custom_field_definitions, :storefront_visible, :boolean, default: true, null: false
+ # Data migration: back_end → false, both/front_end → true
+ remove_column :spree_custom_field_definitions, :display_on
+ ```
+4. Update STI `type` column values: `Spree::Metafields::ShortText` → `Spree::CustomFields::ShortText`, etc.
+5. Drop `public_metadata`, rename `private_metadata` → `metadata` on all tables
+
+#### 6.0 CSV export headers
+
+`metafield.custom.id` → `custom_field.custom.id`
+
+## Migration Path
+
+### For storefront developers (5.4)
+1. Update SDK to new version
+2. Change `expand: ['metafields']` → `expand: ['custom_fields']` in all API calls
+3. Update TypeScript interfaces: `StoreMetafield` → `StoreCustomField`
+4. Prefix IDs change from `mf_` → `cf_`, `mfdef_` → `cfdef_` (lookup still works with old prefixes)
+5. Response key changes from `metafields` → `custom_fields`
+
+### For extension/plugin developers (6.0)
+1. Update any references to `Spree::Metafield` → `Spree::CustomField`
+2. Update concern includes: `include Spree::Metafields` → `include Spree::HasCustomFields`
+3. Update method calls: `set_metafield` → `set_custom_field`, etc.
+4. Update `Spree.metafields` → `Spree.custom_fields` configuration references
+5. Replace `public_metadata` / `private_metadata` with single `metadata`
+6. Replace `display_on` with `storefront_visible` boolean
+
+## Constraints on Current Work
+
+- **All new Store API code must use `custom_fields` naming** after the 5.4 bridge ships.
+- **All new Admin API code must use `custom_fields` / `custom_field_definitions` naming** after the 5.4 bridge ships.
+- **SDK examples and docs must use `custom_fields`** after this ships.
+- **Internal model code can still use `metafield`** naming until 6.0.
+- **Do not use `public_metadata`** — use `metadata` accessor instead. `public_metadata` will emit deprecation warnings in 5.4.
+
+## Open Questions
+
+- **Admin UI rename timing** — Should the Admin UI labels/navigation change from "Metafield Definitions" to "Custom Field Definitions" in 5.4 (purely cosmetic, i18n strings) or defer to 6.0? Leaning toward 5.4 — helps merchants see consistent terminology.
+
+## References
+
+- Prior art: `5.4-store-api-bridges.md` — same bridge pattern (API naming changed in 5.4, models renamed in 6.0)
+- Prior art: `5.4-6.0-product-media-system.md` — images→media bridge
+- `6.0-product-types.md` — ProductType gains `has_many :custom_field_definitions` (terminology updates needed)
+- `5.4-search-provider.md` — `CustomFieldDefinition.filterable` for faceting (terminology updates needed)
+- `decisions.md` — "Consolidate metadata" entry confirms two-system design
diff --git a/docs/plans/decisions.md b/docs/plans/decisions.md
index 6c330366ff..63f55bd72e 100644
--- a/docs/plans/decisions.md
+++ b/docs/plans/decisions.md
@@ -99,23 +99,39 @@ Models already correct (no change): Product, PriceList, PaymentSession,
PaymentSetupSession, Import, ImportRow, Invitation, ReturnItem
(`reception_status`/`acceptance_status`), Reimbursement (`reimbursement_status`).
+## 2026-03-28: Simplify metafield visibility — display_on → storefront_visible boolean (6.0)
+Replace three-way `display_on` (both/front_end/back_end) with `storefront_visible`
+boolean (default: true) on CustomFieldDefinition. `front_end`-only was already
+excluded from `MetafieldDefinition::DISPLAY` and never made sense.
+
+This makes the two-system boundary razor-sharp:
+- Custom Fields (storefront_visible: true) = public structured data
+- Custom Fields (storefront_visible: false) = admin-only structured data
+- Metadata = private developer-owned data (never exposed)
+
+Matches Vendure (`public: boolean`) and Saleor (`visibleInStorefront: boolean`).
+Ships with the 6.0 model rename wave. See `5.4-6.0-custom-fields-rename.md`.
+
## 2026-03-16: Consolidate metadata — drop public_metadata, keep metadata JSON column
Drop `public_metadata` column (never exposed in Store API, unused). Rename
`private_metadata` → `metadata` in the database. Simplify the `Spree::Metadata`
concern to a single `metadata` JSON column with no alias indirection.
-**Metadata** (JSON column) stays as a schemaless developer escape hatch —
-integration IDs, sync state, ad-hoc flags. No definition required, one-step API:
+**Metadata** (JSON column) is a permanent, first-class system — the schemaless
+developer escape hatch for integration IDs, sync state, ad-hoc flags. No
+definition required, one-step API:
`PATCH /product { metadata: { erp_id: "123" } }`. Never exposed in Store API
-(Stripe convention: write-only).
+(Stripe convention: write-only). Metadata is here to stay.
-**Metafields** stay as merchant-defined structured data — typed values
-(short_text, number, boolean, json, rich_text, long_text), require a
-`MetafieldDefinition`, have visibility control (front_end/back_end),
-searchable, CSV importable. With the ProductType plan (6.0-product-types.md),
-metafields become schema-enforced custom attributes driven by ProductType.
+**Metafields** (→ Custom Fields in 6.0, see `5.4-6.0-custom-fields-rename.md`)
+stay as merchant-defined structured data — typed values (short_text, number,
+boolean, json, rich_text, long_text), require a `MetafieldDefinition`, have
+`storefront_visible` boolean, searchable, CSV importable. With the
+ProductType plan (6.0-product-types.md), metafields become schema-enforced
+custom attributes driven by ProductType.
Two systems, two purposes, no overlap. No consolidation into one.
+Metadata for machines, metafields/custom fields for humans.
## 2026-03-10: Product descriptions stay as plain column
Considered Action Text. Rejected for API-first performance —
diff --git a/packages/admin-sdk/src/types/generated/AllowedOrigin.ts b/packages/admin-sdk/src/types/generated/AllowedOrigin.ts
index ad9c1d7c20..30a129831a 100644
--- a/packages/admin-sdk/src/types/generated/AllowedOrigin.ts
+++ b/packages/admin-sdk/src/types/generated/AllowedOrigin.ts
@@ -1,13 +1,13 @@
-// Typelizer digest 2340eabe63e24f397f46d39fcf103bde
+// Typelizer digest 7e678dcb95f976e68d167d03268f9556
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
interface AllowedOrigin {
id: string;
origin: unknown;
- store_id: string;
created_at: string;
updated_at: string;
+ store_id: string;
}
export default AllowedOrigin;
diff --git a/packages/admin-sdk/src/types/generated/Category.ts b/packages/admin-sdk/src/types/generated/Category.ts
index 45efdd0d19..6de4026b0f 100644
--- a/packages/admin-sdk/src/types/generated/Category.ts
+++ b/packages/admin-sdk/src/types/generated/Category.ts
@@ -1,7 +1,7 @@
-// Typelizer digest 20ede22f18045ffca2d5d1c5c6deabf6
+// Typelizer digest 5d8556c255cf95c9678b909a8f649929
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {Metafield} from '@/types'
+import type {CustomField} from '@/types'
interface Category {
id: string;
@@ -26,7 +26,7 @@ interface Category {
parent?: Category;
children?: Array<Category>;
ancestors?: Array<Category>;
- metafields?: Array<Metafield>;
+ custom_fields?: Array<CustomField>;
lft: number;
rgt: number;
}
diff --git a/packages/admin-sdk/src/types/generated/CustomField.ts b/packages/admin-sdk/src/types/generated/CustomField.ts
new file mode 100644
index 0000000000..f6ac4f163f
--- /dev/null
+++ b/packages/admin-sdk/src/types/generated/CustomField.ts
@@ -0,0 +1,16 @@
+// Typelizer digest 50cfb19ef5ce8cd71cf2f7c6721e3cc8
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+
+interface CustomField {
+ id: string;
+ name: string;
+ type: string;
+ key: string;
+ value: any;
+ created_at: string;
+ updated_at: string;
+ storefront_visible: boolean;
+}
+
+export default CustomField;
diff --git a/packages/admin-sdk/src/types/generated/Customer.ts b/packages/admin-sdk/src/types/generated/Customer.ts
index 1b12f75090..dbe58005e3 100644
--- a/packages/admin-sdk/src/types/generated/Customer.ts
+++ b/packages/admin-sdk/src/types/generated/Customer.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 4af376776a7a85e006e272e72b1607c6
+// Typelizer digest bb0830e64ea9b1cc4d3135ae5f295365
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {Address, Order} from '@/types'
@@ -10,8 +10,6 @@ interface Customer {
last_name: string | null;
phone: string | null;
accepts_email_marketing: boolean;
- created_at: string;
- updated_at: string;
available_store_credit_total: string;
display_available_store_credit_total: string;
addresses?: Array<Address>;
@@ -20,6 +18,8 @@ interface Customer {
login: string | null;
last_sign_in_at: string | null;
current_sign_in_at: string | null;
+ created_at: string;
+ updated_at: string;
sign_in_count: number;
failed_attempts: number;
last_sign_in_ip: string | null;
diff --git a/packages/admin-sdk/src/types/generated/DeliveryRate.ts b/packages/admin-sdk/src/types/generated/DeliveryRate.ts
index 2e74e35d14..e717a21609 100644
--- a/packages/admin-sdk/src/types/generated/DeliveryRate.ts
+++ b/packages/admin-sdk/src/types/generated/DeliveryRate.ts
@@ -1,4 +1,4 @@
-// Typelizer digest b38c6a7704dcf309289f09a2515d8dd3
+// Typelizer digest e07c27712a6898218144f3ad2c5de612
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {DeliveryMethod} from '@/types'
@@ -11,6 +11,8 @@ interface DeliveryRate {
cost: string;
display_cost: string;
delivery_method?: DeliveryMethod;
+ created_at: string;
+ updated_at: string;
}
export default DeliveryRate;
diff --git a/packages/admin-sdk/src/types/generated/DigitalLink.ts b/packages/admin-sdk/src/types/generated/DigitalLink.ts
index d27f8374e7..cc65e73260 100644
--- a/packages/admin-sdk/src/types/generated/DigitalLink.ts
+++ b/packages/admin-sdk/src/types/generated/DigitalLink.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 2ce18203b0394df6cbf05e00f34a64dd
+// Typelizer digest 7d22b35201e92223ecbfa24c5c249a20
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -7,12 +7,12 @@ interface DigitalLink {
access_counter: number;
filename: string;
content_type: string;
- created_at: string;
- updated_at: string;
download_url: string;
authorizable: boolean;
expired: boolean;
access_limit_exceeded: boolean;
+ created_at: string;
+ updated_at: string;
}
export default DigitalLink;
diff --git a/packages/admin-sdk/src/types/generated/Discount.ts b/packages/admin-sdk/src/types/generated/Discount.ts
index c03238cf90..7ccb268c78 100644
--- a/packages/admin-sdk/src/types/generated/Discount.ts
+++ b/packages/admin-sdk/src/types/generated/Discount.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 722e5b14b91abb060eb4ecdbc858e112
+// Typelizer digest a2f18de2c82d51339476e96c2780cd84
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -10,6 +10,8 @@ interface Discount {
code: string | null;
amount: string;
display_amount: string;
+ created_at: string;
+ updated_at: string;
}
export default Discount;
diff --git a/packages/admin-sdk/src/types/generated/Fulfillment.ts b/packages/admin-sdk/src/types/generated/Fulfillment.ts
index 3fe3368050..8e44e5c60f 100644
--- a/packages/admin-sdk/src/types/generated/Fulfillment.ts
+++ b/packages/admin-sdk/src/types/generated/Fulfillment.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 79f4335bafa83cc8ba1b06aec4f46240
+// Typelizer digest 58ec8707cf1abd5ae1fe20125dad1cf8
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {DeliveryMethod, StockLocation, DeliveryRate, Order, Adjustment} from '@/types'
@@ -10,8 +10,6 @@ interface Fulfillment {
tracking_url: string | null;
cost: string;
display_cost: string;
- created_at: string;
- updated_at: string;
status: string;
fulfillment_type: string;
fulfilled_at: string | null;
@@ -24,6 +22,8 @@ interface Fulfillment {
included_tax_total: string;
promo_total: string;
pre_tax_amount: string;
+ created_at: string;
+ updated_at: string;
metadata: Record<string, unknown> | null;
order_id: string | null;
stock_location_id: string | null;
diff --git a/packages/admin-sdk/src/types/generated/LineItem.ts b/packages/admin-sdk/src/types/generated/LineItem.ts
index e630a420c0..96f55cd95a 100644
--- a/packages/admin-sdk/src/types/generated/LineItem.ts
+++ b/packages/admin-sdk/src/types/generated/LineItem.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 8751efbed05eb944d2155294aeaf8b28
+// Typelizer digest 225c8426a63ada3623bc7974910926d4
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {OptionValue, DigitalLink, Order, Variant, TaxCategory, Adjustment} from '@/types'
@@ -28,12 +28,12 @@ interface LineItem {
discounted_amount: string;
display_discounted_amount: string;
display_compare_at_amount: string | null;
- created_at: string;
- updated_at: string;
compare_at_amount: string | null;
thumbnail_url: string | null;
option_values: Array<OptionValue>;
digital_links: Array<DigitalLink>;
+ created_at: string;
+ updated_at: string;
metadata: Record<string, unknown> | null;
cost_price: string | null;
tax_category_id: string | null;
diff --git a/packages/admin-sdk/src/types/generated/Media.ts b/packages/admin-sdk/src/types/generated/Media.ts
index 8771d1636d..46719f61ec 100644
--- a/packages/admin-sdk/src/types/generated/Media.ts
+++ b/packages/admin-sdk/src/types/generated/Media.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 87865bd0f729b8e029e9d1480f85e35b
+// Typelizer digest 37586f8a2f663d57141a69ea6db4b03c
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -12,8 +12,6 @@ interface Media {
focal_point_x: number | null;
focal_point_y: number | null;
external_video_url: string | null;
- created_at: string;
- updated_at: string;
original_url: string | null;
mini_url: string | null;
small_url: string | null;
@@ -21,6 +19,8 @@ interface Media {
large_url: string | null;
xlarge_url: string | null;
og_image_url: string | null;
+ created_at: string;
+ updated_at: string;
viewable_id: string;
viewable_type: string;
}
diff --git a/packages/admin-sdk/src/types/generated/Metafield.ts b/packages/admin-sdk/src/types/generated/Metafield.ts
deleted file mode 100644
index 29e8b591da..0000000000
--- a/packages/admin-sdk/src/types/generated/Metafield.ts
+++ /dev/null
@@ -1,14 +0,0 @@
-// Typelizer digest db0ebd33c5b5645134926a31605cd35e
-//
-// DO NOT MODIFY: This file was automatically generated by Typelizer.
-
-interface Metafield {
- id: string;
- name: string;
- type: string;
- key: string;
- value: any;
- display_on: string;
-}
-
-export default Metafield;
diff --git a/packages/admin-sdk/src/types/generated/OptionType.ts b/packages/admin-sdk/src/types/generated/OptionType.ts
index 90c2b668d9..602ea70600 100644
--- a/packages/admin-sdk/src/types/generated/OptionType.ts
+++ b/packages/admin-sdk/src/types/generated/OptionType.ts
@@ -1,4 +1,4 @@
-// Typelizer digest d11b90b320a0cfd070f04beb1fc459c9
+// Typelizer digest 417b6bff08abe4057131c4771136e22b
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {OptionValue} from '@/types'
@@ -8,6 +8,8 @@ interface OptionType {
name: string;
label: string;
position: number;
+ created_at: string;
+ updated_at: string;
option_values?: Array<OptionValue>;
}
diff --git a/packages/admin-sdk/src/types/generated/OptionValue.ts b/packages/admin-sdk/src/types/generated/OptionValue.ts
index b9cb980d6c..979f59e15a 100644
--- a/packages/admin-sdk/src/types/generated/OptionValue.ts
+++ b/packages/admin-sdk/src/types/generated/OptionValue.ts
@@ -1,4 +1,4 @@
-// Typelizer digest e9076f2df5f23f46ce7b4e04604bdc55
+// Typelizer digest 8c8614fb6bee0678b9cf4477dd0d59e4
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {OptionType} from '@/types'
@@ -11,6 +11,8 @@ interface OptionValue {
position: number;
option_type_name: string;
option_type_label: string;
+ created_at: string;
+ updated_at: string;
option_type?: OptionType;
}
diff --git a/packages/admin-sdk/src/types/generated/Order.ts b/packages/admin-sdk/src/types/generated/Order.ts
index ca9857939e..cc687b8b33 100644
--- a/packages/admin-sdk/src/types/generated/Order.ts
+++ b/packages/admin-sdk/src/types/generated/Order.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 7cfd29f58b2f8b0f45cf89897f24a319
+// Typelizer digest 706488fd74531682efe68e3a7b9c1df8
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {Discount, LineItem, Fulfillment, Payment, Address, GiftCard, PaymentMethod, Customer, Adjustment, ReturnAuthorization, Reimbursement} from '@/types'
@@ -46,7 +46,6 @@ interface Order {
billing_address?: Address | null;
shipping_address?: Address | null;
gift_card: GiftCard | null;
- channel: string | null;
last_ip_address: string | null;
considered_risky: boolean;
confirmation_delivered: boolean;
diff --git a/packages/admin-sdk/src/types/generated/Payment.ts b/packages/admin-sdk/src/types/generated/Payment.ts
index a0fcaf716c..43f7c00d51 100644
--- a/packages/admin-sdk/src/types/generated/Payment.ts
+++ b/packages/admin-sdk/src/types/generated/Payment.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 45cf73e2d05a8d2a9b9c489553261b79
+// Typelizer digest 9e58f5d94600ca1f0cffa3176b7b74d8
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {CreditCard, StoreCredit, PaymentSource, PaymentMethod, Order, Refund} from '@/types'
@@ -10,8 +10,6 @@ interface Payment {
number: string;
amount: string;
display_amount: string;
- created_at: string;
- updated_at: string;
status: string;
source_type: 'credit_card' | 'store_credit' | 'payment_source' | null;
source_id: string | null;
@@ -20,6 +18,8 @@ interface Payment {
avs_response: string | null;
cvv_response_code: string | null;
cvv_response_message: string | null;
+ created_at: string;
+ updated_at: string;
metadata: Record<string, unknown> | null;
captured_amount: string;
order_id: string | null;
diff --git a/packages/admin-sdk/src/types/generated/PaymentSource.ts b/packages/admin-sdk/src/types/generated/PaymentSource.ts
index eae88b72b0..8d3f89da1f 100644
--- a/packages/admin-sdk/src/types/generated/PaymentSource.ts
+++ b/packages/admin-sdk/src/types/generated/PaymentSource.ts
@@ -1,10 +1,12 @@
-// Typelizer digest a090566d1133c4c29bc1f262a7fd6604
+// Typelizer digest 5546618ce87498596dfb5c82d7524b93
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
interface PaymentSource {
id: string;
gateway_payment_profile_id: string | null;
+ created_at: string;
+ updated_at: string;
}
export default PaymentSource;
diff --git a/packages/admin-sdk/src/types/generated/Product.ts b/packages/admin-sdk/src/types/generated/Product.ts
index b1e91efc58..f57aa2b1c5 100644
--- a/packages/admin-sdk/src/types/generated/Product.ts
+++ b/packages/admin-sdk/src/types/generated/Product.ts
@@ -1,7 +1,7 @@
-// Typelizer digest bd7832f9418886d0390619311f47d31e
+// Typelizer digest 2924cca23864ab744b207ce314f34f14
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {Price, PriceHistory, Media, Variant, OptionType, Category, Metafield} from '@/types'
+import type {Price, PriceHistory, Media, Variant, OptionType, Category, CustomField} from '@/types'
interface Product {
id: string;
@@ -11,8 +11,6 @@ interface Product {
meta_keywords: string | null;
variant_count: number;
available_on: string | null;
- created_at: string;
- updated_at: string;
purchasable: boolean;
in_stock: boolean;
backorderable: boolean;
@@ -30,12 +28,14 @@ interface Product {
default_variant?: Variant;
option_types?: Array<OptionType>;
categories?: Array<Category>;
- metafields?: Array<Metafield>;
+ custom_fields?: Array<CustomField>;
prior_price?: PriceHistory | null;
status: string;
make_active_at: string | null;
discontinue_on: string | null;
deleted_at: string | null;
+ created_at: string;
+ updated_at: string;
cost_price: string | null;
cost_currency: string | null;
}
diff --git a/packages/admin-sdk/src/types/generated/Refund.ts b/packages/admin-sdk/src/types/generated/Refund.ts
index 6abb31bc15..f5335395d0 100644
--- a/packages/admin-sdk/src/types/generated/Refund.ts
+++ b/packages/admin-sdk/src/types/generated/Refund.ts
@@ -1,4 +1,4 @@
-// Typelizer digest bf6e1f404a447a7e26d57ff46fcb3710
+// Typelizer digest 9d5957d1cb8255a6a241c54a69b16331
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {Payment, Reimbursement} from '@/types'
@@ -6,12 +6,12 @@ import type {Payment, Reimbursement} from '@/types'
interface Refund {
id: string;
transaction_id: string | null;
- created_at: string;
- updated_at: string;
amount: string | null;
payment_id: string | null;
refund_reason_id: string | null;
reimbursement_id: string | null;
+ created_at: string;
+ updated_at: string;
payment?: Payment;
reimbursement?: Reimbursement;
}
diff --git a/packages/admin-sdk/src/types/generated/Reimbursement.ts b/packages/admin-sdk/src/types/generated/Reimbursement.ts
index 643cd1cba8..2fce106c9d 100644
--- a/packages/admin-sdk/src/types/generated/Reimbursement.ts
+++ b/packages/admin-sdk/src/types/generated/Reimbursement.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 6b998108c826a9ae29583722d55f4724
+// Typelizer digest 7f0c99245ccf647eed4193deb010b427
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {Order} from '@/types'
@@ -7,11 +7,11 @@ interface Reimbursement {
id: string;
number: string;
reimbursement_status: string | null;
- created_at: string;
- updated_at: string;
total: string | null;
order_id: string | null;
customer_return_id: string | null;
+ created_at: string;
+ updated_at: string;
order?: Order;
}
diff --git a/packages/admin-sdk/src/types/generated/ReturnAuthorization.ts b/packages/admin-sdk/src/types/generated/ReturnAuthorization.ts
index 4f54fcab7d..3ed2385600 100644
--- a/packages/admin-sdk/src/types/generated/ReturnAuthorization.ts
+++ b/packages/admin-sdk/src/types/generated/ReturnAuthorization.ts
@@ -1,4 +1,4 @@
-// Typelizer digest d170b4fef9b4ec56f59b39a9c5bc6e38
+// Typelizer digest 192376f59dbdd08a9bb6cb9747f7ffc9
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {Order, StockLocation} from '@/types'
@@ -6,12 +6,12 @@ import type {Order, StockLocation} from '@/types'
interface ReturnAuthorization {
id: string;
number: string;
- created_at: string;
- updated_at: string;
status: string;
order_id: string | null;
stock_location_id: string | null;
return_authorization_reason_id: string | null;
+ created_at: string;
+ updated_at: string;
order?: Order;
stock_location?: StockLocation;
}
diff --git a/packages/admin-sdk/src/types/generated/StockItem.ts b/packages/admin-sdk/src/types/generated/StockItem.ts
index 4b9fcb3d1b..cd800c304e 100644
--- a/packages/admin-sdk/src/types/generated/StockItem.ts
+++ b/packages/admin-sdk/src/types/generated/StockItem.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 2f58ef36250650ac566addace9fdf801
+// Typelizer digest 1bf13e390e69a23008e120ed93074c6b
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {StockLocation, Variant} from '@/types'
@@ -7,10 +7,10 @@ interface StockItem {
id: string;
count_on_hand: number;
backorderable: boolean;
- created_at: string;
- updated_at: string;
stock_location_id: string | null;
variant_id: string | null;
+ created_at: string;
+ updated_at: string;
stock_location?: StockLocation;
variant?: Variant;
}
diff --git a/packages/admin-sdk/src/types/generated/StoreCredit.ts b/packages/admin-sdk/src/types/generated/StoreCredit.ts
index c3f93926d6..718f0647d3 100644
--- a/packages/admin-sdk/src/types/generated/StoreCredit.ts
+++ b/packages/admin-sdk/src/types/generated/StoreCredit.ts
@@ -1,4 +1,4 @@
-// Typelizer digest cd86fec8db846529973a4c51798c5dcb
+// Typelizer digest 703c5e72241f2b5e7be5ccc793735f3a
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -11,11 +11,11 @@ interface StoreCredit {
display_amount_used: string;
display_amount_remaining: string;
currency: string;
+ created_at: string;
+ updated_at: string;
customer_id: string | null;
created_by_id: string | null;
metadata: Record<string, unknown> | null;
- created_at: string;
- updated_at: string;
}
export default StoreCredit;
diff --git a/packages/admin-sdk/src/types/generated/Variant.ts b/packages/admin-sdk/src/types/generated/Variant.ts
index 6c6db1b35b..998ccc33e0 100644
--- a/packages/admin-sdk/src/types/generated/Variant.ts
+++ b/packages/admin-sdk/src/types/generated/Variant.ts
@@ -1,7 +1,7 @@
-// Typelizer digest a27edb567399482cfff90ea1dbee2e80
+// Typelizer digest 1aecfc086e4cce3f916a556c9b27b960
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {Price, PriceHistory, Media, OptionValue, Metafield} from '@/types'
+import type {Price, PriceHistory, Media, OptionValue, CustomField} from '@/types'
interface Variant {
id: string;
@@ -10,8 +10,6 @@ interface Variant {
options_text: string;
track_inventory: boolean;
media_count: number;
- created_at: string;
- updated_at: string;
thumbnail_url: string | null;
purchasable: boolean;
in_stock: boolean;
@@ -25,14 +23,16 @@ interface Variant {
primary_media?: Media;
media?: Array<Media>;
option_values: Array<OptionValue>;
- metafields?: Array<Metafield>;
+ custom_fields?: Array<CustomField>;
prior_price?: PriceHistory | null;
position: number;
+ total_on_hand: number | null;
tax_category_id: string | null;
cost_price: string | null;
cost_currency: string | null;
deleted_at: string | null;
- total_on_hand: number | null;
+ created_at: string;
+ updated_at: string;
prices?: Array<Price>;
}
diff --git a/packages/admin-sdk/src/types/generated/index.ts b/packages/admin-sdk/src/types/generated/index.ts
index 309347a2cb..b23bc217d3 100644
--- a/packages/admin-sdk/src/types/generated/index.ts
+++ b/packages/admin-sdk/src/types/generated/index.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 73ade9587957872878b3a67628dc6db4
+// Typelizer digest 293ff4eaa7de393b2b0562c848bf36a6
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
export type { default as Address } from './Address'
@@ -8,6 +8,7 @@ export type { default as AllowedOrigin } from './AllowedOrigin'
export type { default as Asset } from './Asset'
export type { default as Category } from './Category'
export type { default as CreditCard } from './CreditCard'
+export type { default as CustomField } from './CustomField'
export type { default as Customer } from './Customer'
export type { default as DeliveryMethod } from './DeliveryMethod'
export type { default as DeliveryRate } from './DeliveryRate'
@@ -17,7 +18,6 @@ export type { default as Fulfillment } from './Fulfillment'
export type { default as GiftCard } from './GiftCard'
export type { default as LineItem } from './LineItem'
export type { default as Media } from './Media'
-export type { default as Metafield } from './Metafield'
export type { default as OptionType } from './OptionType'
export type { default as OptionValue } from './OptionValue'
export type { default as Order } from './Order'
diff --git a/packages/sdk/.changeset/metafields-to-custom-fields.md b/packages/sdk/.changeset/metafields-to-custom-fields.md
new file mode 100644
index 0000000000..0b433aee2d
--- /dev/null
+++ b/packages/sdk/.changeset/metafields-to-custom-fields.md
@@ -0,0 +1,5 @@
+---
+"@spree/sdk": patch
+---
+
+Rename metafields to custom_fields in Store API. The expand parameter changes from `metafields` to `custom_fields`, and the response key changes accordingly. Prefix IDs change from `mf_` to `cf_`. The `StoreMetafield` type is replaced by `StoreCustomField`.
diff --git a/packages/sdk/src/types/generated/Category.ts b/packages/sdk/src/types/generated/Category.ts
index fd3aa75e32..9616b1f0f7 100644
--- a/packages/sdk/src/types/generated/Category.ts
+++ b/packages/sdk/src/types/generated/Category.ts
@@ -1,7 +1,7 @@
-// Typelizer digest 7b585549662bf0388cb0eb3108e6b307
+// Typelizer digest a66cb3abca5a99e8c91a5384de1bf5d6
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {Metafield} from '@/types'
+import type {CustomField} from '@/types'
interface Category {
id: string;
@@ -26,7 +26,7 @@ interface Category {
parent?: Category;
children?: Array<Category>;
ancestors?: Array<Category>;
- metafields?: Array<Metafield>;
+ custom_fields?: Array<CustomField>;
}
export default Category;
diff --git a/packages/sdk/src/types/generated/Metafield.ts b/packages/sdk/src/types/generated/CustomField.ts
similarity index 59%
rename from packages/sdk/src/types/generated/Metafield.ts
rename to packages/sdk/src/types/generated/CustomField.ts
index 7c0c269211..96cccc2a9d 100644
--- a/packages/sdk/src/types/generated/Metafield.ts
+++ b/packages/sdk/src/types/generated/CustomField.ts
@@ -1,8 +1,8 @@
-// Typelizer digest 770202231a07810ad587029759dab9f8
+// Typelizer digest 3ac7ee503478b30fbadc8402bc8452bf
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-interface Metafield {
+interface CustomField {
id: string;
name: string;
type: string;
@@ -10,4 +10,4 @@ interface Metafield {
value: any;
}
-export default Metafield;
+export default CustomField;
diff --git a/packages/sdk/src/types/generated/Customer.ts b/packages/sdk/src/types/generated/Customer.ts
index fca0a01481..7d19db5bee 100644
--- a/packages/sdk/src/types/generated/Customer.ts
+++ b/packages/sdk/src/types/generated/Customer.ts
@@ -1,4 +1,4 @@
-// Typelizer digest cfc7405abc8e1bdebb0b500ec1adf80a
+// Typelizer digest 5111c001c78d6e769a3155686a150770
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {Address} from '@/types'
@@ -10,8 +10,6 @@ interface Customer {
last_name: string | null;
phone: string | null;
accepts_email_marketing: boolean;
- created_at: string;
- updated_at: string;
available_store_credit_total: string;
display_available_store_credit_total: string;
addresses: Array<Address>;
diff --git a/packages/sdk/src/types/generated/DigitalLink.ts b/packages/sdk/src/types/generated/DigitalLink.ts
index d27f8374e7..390e5faff2 100644
--- a/packages/sdk/src/types/generated/DigitalLink.ts
+++ b/packages/sdk/src/types/generated/DigitalLink.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 2ce18203b0394df6cbf05e00f34a64dd
+// Typelizer digest a87f85fa9733261f443b9236543566b8
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -7,8 +7,6 @@ interface DigitalLink {
access_counter: number;
filename: string;
content_type: string;
- created_at: string;
- updated_at: string;
download_url: string;
authorizable: boolean;
expired: boolean;
diff --git a/packages/sdk/src/types/generated/Fulfillment.ts b/packages/sdk/src/types/generated/Fulfillment.ts
index 04e4c72ebd..a7ead977dd 100644
--- a/packages/sdk/src/types/generated/Fulfillment.ts
+++ b/packages/sdk/src/types/generated/Fulfillment.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 7c5bd067b3b70f70649796aaa0a7457c
+// Typelizer digest a671c989604293ff2fd221f02ef80f44
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {DeliveryMethod, StockLocation, DeliveryRate} from '@/types'
@@ -10,8 +10,6 @@ interface Fulfillment {
tracking_url: string | null;
cost: string;
display_cost: string;
- created_at: string;
- updated_at: string;
status: string;
fulfillment_type: string;
fulfilled_at: string | null;
diff --git a/packages/sdk/src/types/generated/LineItem.ts b/packages/sdk/src/types/generated/LineItem.ts
index 13f720bfbd..2d8876d11d 100644
--- a/packages/sdk/src/types/generated/LineItem.ts
+++ b/packages/sdk/src/types/generated/LineItem.ts
@@ -1,4 +1,4 @@
-// Typelizer digest bcbddf9615a3d997e01ba78cc5469a3d
+// Typelizer digest 8c0b49f019367cedf7c6036ae7cf0c8b
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {OptionValue, DigitalLink} from '@/types'
@@ -28,8 +28,6 @@ interface LineItem {
discounted_amount: string;
display_discounted_amount: string;
display_compare_at_amount: string | null;
- created_at: string;
- updated_at: string;
compare_at_amount: string | null;
thumbnail_url: string | null;
option_values: Array<OptionValue>;
diff --git a/packages/sdk/src/types/generated/Media.ts b/packages/sdk/src/types/generated/Media.ts
index b427614266..2a0f23a56b 100644
--- a/packages/sdk/src/types/generated/Media.ts
+++ b/packages/sdk/src/types/generated/Media.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 625de791cc6aa03d537978d99bf32bd8
+// Typelizer digest a5e3fc9471b70defb20d943d458ef05d
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
@@ -12,8 +12,6 @@ interface Media {
focal_point_x: number | null;
focal_point_y: number | null;
external_video_url: string | null;
- created_at: string;
- updated_at: string;
original_url: string | null;
mini_url: string | null;
small_url: string | null;
diff --git a/packages/sdk/src/types/generated/Payment.ts b/packages/sdk/src/types/generated/Payment.ts
index 7cb971c965..87b05ab093 100644
--- a/packages/sdk/src/types/generated/Payment.ts
+++ b/packages/sdk/src/types/generated/Payment.ts
@@ -1,4 +1,4 @@
-// Typelizer digest ddc57d7a11ce548446095b5a859b55b3
+// Typelizer digest 9f3114bf5775cf48c19768b69d8db526
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {CreditCard, StoreCredit, PaymentSource, PaymentMethod} from '@/types'
@@ -10,8 +10,6 @@ interface Payment {
number: string;
amount: string;
display_amount: string;
- created_at: string;
- updated_at: string;
status: string;
source_type: 'credit_card' | 'store_credit' | 'payment_source' | null;
source_id: string | null;
diff --git a/packages/sdk/src/types/generated/Product.ts b/packages/sdk/src/types/generated/Product.ts
index 42d959b897..e9700ed93d 100644
--- a/packages/sdk/src/types/generated/Product.ts
+++ b/packages/sdk/src/types/generated/Product.ts
@@ -1,7 +1,7 @@
-// Typelizer digest 3563e4fe0a7588a9536848acd527ee84
+// Typelizer digest 46e3c9a583ee8b9c7ccda6cc8a7eec16
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {Price, PriceHistory, Media, Variant, OptionType, Category, Metafield} from '@/types'
+import type {Price, PriceHistory, Media, Variant, OptionType, Category, CustomField} from '@/types'
interface Product {
id: string;
@@ -11,8 +11,6 @@ interface Product {
meta_keywords: string | null;
variant_count: number;
available_on: string | null;
- created_at: string;
- updated_at: string;
purchasable: boolean;
in_stock: boolean;
backorderable: boolean;
@@ -30,7 +28,7 @@ interface Product {
default_variant?: Variant;
option_types?: Array<OptionType>;
categories?: Array<Category>;
- metafields?: Array<Metafield>;
+ custom_fields?: Array<CustomField>;
prior_price?: PriceHistory | null;
}
diff --git a/packages/sdk/src/types/generated/Refund.ts b/packages/sdk/src/types/generated/Refund.ts
index 6ef3a6d726..4156d5c767 100644
--- a/packages/sdk/src/types/generated/Refund.ts
+++ b/packages/sdk/src/types/generated/Refund.ts
@@ -1,12 +1,10 @@
-// Typelizer digest d6d272509ccfd00b45f7f93122c437be
+// Typelizer digest 40931f60bfccedfe93b2b8a88e91ef0d
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
interface Refund {
id: string;
transaction_id: string | null;
- created_at: string;
- updated_at: string;
amount: string | null;
payment_id: string | null;
refund_reason_id: string | null;
diff --git a/packages/sdk/src/types/generated/ReturnAuthorization.ts b/packages/sdk/src/types/generated/ReturnAuthorization.ts
index 5189f75dd5..e588b1ba86 100644
--- a/packages/sdk/src/types/generated/ReturnAuthorization.ts
+++ b/packages/sdk/src/types/generated/ReturnAuthorization.ts
@@ -1,12 +1,10 @@
-// Typelizer digest 9b984aa982bdc1fe82efa2543ab16015
+// Typelizer digest b74e9f7a9e52c3f023c46d097db79d93
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
interface ReturnAuthorization {
id: string;
number: string;
- created_at: string;
- updated_at: string;
status: string;
order_id: string | null;
stock_location_id: string | null;
diff --git a/packages/sdk/src/types/generated/Variant.ts b/packages/sdk/src/types/generated/Variant.ts
index 87f4a1feaf..1e67c4f036 100644
--- a/packages/sdk/src/types/generated/Variant.ts
+++ b/packages/sdk/src/types/generated/Variant.ts
@@ -1,7 +1,7 @@
-// Typelizer digest 2dcf2a0dd46a6186815dcb98b0624012
+// Typelizer digest e17442eb4fdbfeeb5bff74dc40dace30
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {Price, PriceHistory, Media, OptionValue, Metafield} from '@/types'
+import type {Price, PriceHistory, Media, OptionValue, CustomField} from '@/types'
interface Variant {
id: string;
@@ -10,8 +10,6 @@ interface Variant {
options_text: string;
track_inventory: boolean;
media_count: number;
- created_at: string;
- updated_at: string;
thumbnail_url: string | null;
purchasable: boolean;
in_stock: boolean;
@@ -25,7 +23,7 @@ interface Variant {
primary_media?: Media;
media?: Array<Media>;
option_values: Array<OptionValue>;
- metafields?: Array<Metafield>;
+ custom_fields?: Array<CustomField>;
prior_price?: PriceHistory | null;
}
diff --git a/packages/sdk/src/types/generated/index.ts b/packages/sdk/src/types/generated/index.ts
index 342a871ef9..fe870afe33 100644
--- a/packages/sdk/src/types/generated/index.ts
+++ b/packages/sdk/src/types/generated/index.ts
@@ -1,4 +1,4 @@
-// Typelizer digest b2f08773b4f76cd208d9941181d69ca6
+// Typelizer digest a5578d45f5defe3852c905a88af3d772
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
export type { default as Address } from './Address'
@@ -8,6 +8,7 @@ export type { default as Category } from './Category'
export type { default as Country } from './Country'
export type { default as CreditCard } from './CreditCard'
export type { default as Currency } from './Currency'
+export type { default as CustomField } from './CustomField'
export type { default as Customer } from './Customer'
export type { default as DeliveryMethod } from './DeliveryMethod'
export type { default as DeliveryRate } from './DeliveryRate'
@@ -22,7 +23,6 @@ export type { default as LineItem } from './LineItem'
export type { default as Locale } from './Locale'
export type { default as Market } from './Market'
export type { default as Media } from './Media'
-export type { default as Metafield } from './Metafield'
export type { default as NewsletterSubscriber } from './NewsletterSubscriber'
export type { default as OptionType } from './OptionType'
export type { default as OptionValue } from './OptionValue'
diff --git a/packages/sdk/src/types/index.ts b/packages/sdk/src/types/index.ts
index 39594895b6..91850f4b6b 100644
--- a/packages/sdk/src/types/index.ts
+++ b/packages/sdk/src/types/index.ts
@@ -21,7 +21,7 @@ export type {
LineItem,
Locale,
Market,
- Metafield,
+ CustomField,
NewsletterSubscriber,
OptionType,
OptionValue,
@@ -49,48 +49,6 @@ export type {
Wishlist,
} from './generated';
-// Backward compatibility aliases (Store* prefix)
-export type { Address as StoreAddress } from './generated';
-export type { Cart as StoreCart } from './generated';
-export type { Category as StoreCategory } from './generated';
-export type { Country as StoreCountry } from './generated';
-export type { CreditCard as StoreCreditCard } from './generated';
-export type { Currency as StoreCurrency } from './generated';
-export type { Customer as StoreCustomer } from './generated';
-export type { Discount as StoreDiscount } from './generated';
-export type { DigitalLink as StoreDigitalLink } from './generated';
-export type { Digital as StoreDigital } from './generated';
-export type { GiftCardBatch as StoreGiftCardBatch } from './generated';
-export type { GiftCard as StoreGiftCard } from './generated';
-export type { Media as StoreMedia } from './generated';
-export type { LineItem as StoreLineItem } from './generated';
-export type { Locale as StoreLocale } from './generated';
-export type { Market as StoreMarket } from './generated';
-export type { Metafield as StoreMetafield } from './generated';
-export type { OptionType as StoreOptionType } from './generated';
-export type { OptionValue as StoreOptionValue } from './generated';
-export type { Order as StoreOrder } from './generated';
-export type { PaymentMethod as StorePaymentMethod } from './generated';
-export type { Payment as StorePayment } from './generated';
-export type { PaymentSession as StorePaymentSession } from './generated';
-export type { PaymentSetupSession as StorePaymentSetupSession } from './generated';
-export type { PaymentSource as StorePaymentSource } from './generated';
-export type { Price as StorePrice } from './generated';
-export type { Product as StoreProduct } from './generated';
-export type { Promotion as StorePromotion } from './generated';
-export type { Refund as StoreRefund } from './generated';
-export type { ReturnAuthorization as StoreReturnAuthorization } from './generated';
-export type { ReturnItem as StoreReturnItem } from './generated';
-export type { DeliveryMethod as StoreDeliveryMethod } from './generated';
-export type { DeliveryRate as StoreDeliveryRate } from './generated';
-export type { Fulfillment as StoreFulfillment } from './generated';
-export type { State as StoreState } from './generated';
-export type { StockLocation as StoreStockLocation } from './generated';
-export type { StoreCredit as StoreStoreCredit } from './generated';
-export type { Variant as StoreVariant } from './generated';
-export type { WishlistItem as StoreWishlistItem } from './generated';
-export type { Wishlist as StoreWishlist } from './generated';
-
// Checkout requirement — a single unsatisfied checkout prerequisite
export interface CheckoutRequirement {
/** Checkout step this requirement belongs to (e.g. "address", "payment") */
diff --git a/packages/sdk/src/zod/generated/Category.ts b/packages/sdk/src/zod/generated/Category.ts
index e3152340f9..decdd33f0a 100644
--- a/packages/sdk/src/zod/generated/Category.ts
+++ b/packages/sdk/src/zod/generated/Category.ts
@@ -1,6 +1,6 @@
// This file is auto-generated. Do not edit directly.
import { z } from 'zod';
-import { MetafieldSchema } from './Metafield';
+import { CustomFieldSchema } from './CustomField';
export const CategorySchema: z.ZodObject<any> = z.object({
id: z.string(),
@@ -25,7 +25,7 @@ export const CategorySchema: z.ZodObject<any> = z.object({
parent: z.lazy(() => CategorySchema).optional(),
children: z.array(z.lazy(() => CategorySchema)).optional(),
ancestors: z.array(z.lazy(() => CategorySchema)).optional(),
- metafields: z.array(MetafieldSchema).optional(),
+ custom_fields: z.array(CustomFieldSchema).optional(),
});
export type Category = z.infer<typeof CategorySchema>;
diff --git a/packages/sdk/src/zod/generated/Metafield.ts b/packages/sdk/src/zod/generated/CustomField.ts
similarity index 63%
rename from packages/sdk/src/zod/generated/Metafield.ts
rename to packages/sdk/src/zod/generated/CustomField.ts
index 0e4de435ab..a8a4e75a9c 100644
--- a/packages/sdk/src/zod/generated/Metafield.ts
+++ b/packages/sdk/src/zod/generated/CustomField.ts
@@ -1,7 +1,7 @@
// This file is auto-generated. Do not edit directly.
import { z } from 'zod';
-export const MetafieldSchema = z.object({
+export const CustomFieldSchema = z.object({
id: z.string(),
name: z.string(),
type: z.string(),
@@ -9,4 +9,4 @@ export const MetafieldSchema = z.object({
value: z.any(),
});
-export type Metafield = z.infer<typeof MetafieldSchema>;
+export type CustomField = z.infer<typeof CustomFieldSchema>;
diff --git a/packages/sdk/src/zod/generated/Customer.ts b/packages/sdk/src/zod/generated/Customer.ts
index e826a9430a..f3cc45cda4 100644
--- a/packages/sdk/src/zod/generated/Customer.ts
+++ b/packages/sdk/src/zod/generated/Customer.ts
@@ -9,8 +9,6 @@ export const CustomerSchema = z.object({
last_name: z.string().nullable(),
phone: z.string().nullable(),
accepts_email_marketing: z.boolean(),
- created_at: z.string(),
- updated_at: z.string(),
available_store_credit_total: z.string(),
display_available_store_credit_total: z.string(),
addresses: z.array(AddressSchema),
diff --git a/packages/sdk/src/zod/generated/DigitalLink.ts b/packages/sdk/src/zod/generated/DigitalLink.ts
index 451f9a35c0..ce12ac2e45 100644
--- a/packages/sdk/src/zod/generated/DigitalLink.ts
+++ b/packages/sdk/src/zod/generated/DigitalLink.ts
@@ -6,8 +6,6 @@ export const DigitalLinkSchema = z.object({
access_counter: z.number(),
filename: z.string(),
content_type: z.string(),
- created_at: z.string(),
- updated_at: z.string(),
download_url: z.string(),
authorizable: z.boolean(),
expired: z.boolean(),
diff --git a/packages/sdk/src/zod/generated/Fulfillment.ts b/packages/sdk/src/zod/generated/Fulfillment.ts
index 4891269d2e..3e1ec97500 100644
--- a/packages/sdk/src/zod/generated/Fulfillment.ts
+++ b/packages/sdk/src/zod/generated/Fulfillment.ts
@@ -11,8 +11,6 @@ export const FulfillmentSchema = z.object({
tracking_url: z.string().nullable(),
cost: z.string(),
display_cost: z.string(),
- created_at: z.string(),
- updated_at: z.string(),
status: z.string(),
fulfillment_type: z.string(),
fulfilled_at: z.string().nullable(),
diff --git a/packages/sdk/src/zod/generated/LineItem.ts b/packages/sdk/src/zod/generated/LineItem.ts
index d58835954e..b133902aa5 100644
--- a/packages/sdk/src/zod/generated/LineItem.ts
+++ b/packages/sdk/src/zod/generated/LineItem.ts
@@ -28,8 +28,6 @@ export const LineItemSchema = z.object({
discounted_amount: z.string(),
display_discounted_amount: z.string(),
display_compare_at_amount: z.string().nullable(),
- created_at: z.string(),
- updated_at: z.string(),
compare_at_amount: z.string().nullable(),
thumbnail_url: z.string().nullable(),
option_values: z.array(OptionValueSchema),
diff --git a/packages/sdk/src/zod/generated/Media.ts b/packages/sdk/src/zod/generated/Media.ts
index 66965ec27a..dd152cc967 100644
--- a/packages/sdk/src/zod/generated/Media.ts
+++ b/packages/sdk/src/zod/generated/Media.ts
@@ -11,8 +11,6 @@ export const MediaSchema = z.object({
focal_point_x: z.number().nullable(),
focal_point_y: z.number().nullable(),
external_video_url: z.string().nullable(),
- created_at: z.string(),
- updated_at: z.string(),
original_url: z.string().nullable(),
mini_url: z.string().nullable(),
small_url: z.string().nullable(),
diff --git a/packages/sdk/src/zod/generated/Payment.ts b/packages/sdk/src/zod/generated/Payment.ts
index 2291dcf4e4..9aa60bcc4a 100644
--- a/packages/sdk/src/zod/generated/Payment.ts
+++ b/packages/sdk/src/zod/generated/Payment.ts
@@ -9,8 +9,6 @@ export const PaymentSchema = z.object({
number: z.string(),
amount: z.string(),
display_amount: z.string(),
- created_at: z.string(),
- updated_at: z.string(),
status: z.string(),
source_type: z.string().nullable(),
source_id: z.string().nullable(),
diff --git a/packages/sdk/src/zod/generated/Product.ts b/packages/sdk/src/zod/generated/Product.ts
index 112c64801b..75ba5788a1 100644
--- a/packages/sdk/src/zod/generated/Product.ts
+++ b/packages/sdk/src/zod/generated/Product.ts
@@ -1,8 +1,8 @@
// This file is auto-generated. Do not edit directly.
import { z } from 'zod';
import { CategorySchema } from './Category';
+import { CustomFieldSchema } from './CustomField';
import { MediaSchema } from './Media';
-import { MetafieldSchema } from './Metafield';
import { OptionTypeSchema } from './OptionType';
import { PriceSchema } from './Price';
import { PriceHistorySchema } from './PriceHistory';
@@ -16,8 +16,6 @@ export const ProductSchema = z.object({
meta_keywords: z.string().nullable(),
variant_count: z.number(),
available_on: z.string().nullable(),
- created_at: z.string(),
- updated_at: z.string(),
purchasable: z.boolean(),
in_stock: z.boolean(),
backorderable: z.boolean(),
@@ -35,7 +33,7 @@ export const ProductSchema = z.object({
default_variant: VariantSchema.optional(),
option_types: z.array(OptionTypeSchema).optional(),
categories: z.array(z.lazy(() => CategorySchema)).optional(),
- metafields: z.array(MetafieldSchema).optional(),
+ custom_fields: z.array(CustomFieldSchema).optional(),
prior_price: PriceHistorySchema.nullable().optional(),
});
diff --git a/packages/sdk/src/zod/generated/Refund.ts b/packages/sdk/src/zod/generated/Refund.ts
index 4176e1ef9e..b45749644b 100644
--- a/packages/sdk/src/zod/generated/Refund.ts
+++ b/packages/sdk/src/zod/generated/Refund.ts
@@ -4,8 +4,6 @@ import { z } from 'zod';
export const RefundSchema = z.object({
id: z.string(),
transaction_id: z.string().nullable(),
- created_at: z.string(),
- updated_at: z.string(),
amount: z.string().nullable(),
payment_id: z.string().nullable(),
refund_reason_id: z.string().nullable(),
diff --git a/packages/sdk/src/zod/generated/ReturnAuthorization.ts b/packages/sdk/src/zod/generated/ReturnAuthorization.ts
index abbaa6fe87..ebd43d3c9a 100644
--- a/packages/sdk/src/zod/generated/ReturnAuthorization.ts
+++ b/packages/sdk/src/zod/generated/ReturnAuthorization.ts
@@ -4,8 +4,6 @@ import { z } from 'zod';
export const ReturnAuthorizationSchema = z.object({
id: z.string(),
number: z.string(),
- created_at: z.string(),
- updated_at: z.string(),
status: z.string(),
order_id: z.string().nullable(),
stock_location_id: z.string().nullable(),
diff --git a/packages/sdk/src/zod/generated/Variant.ts b/packages/sdk/src/zod/generated/Variant.ts
index 9e00c44a75..40d11ae725 100644
--- a/packages/sdk/src/zod/generated/Variant.ts
+++ b/packages/sdk/src/zod/generated/Variant.ts
@@ -1,7 +1,7 @@
// This file is auto-generated. Do not edit directly.
import { z } from 'zod';
+import { CustomFieldSchema } from './CustomField';
import { MediaSchema } from './Media';
-import { MetafieldSchema } from './Metafield';
import { OptionValueSchema } from './OptionValue';
import { PriceSchema } from './Price';
import { PriceHistorySchema } from './PriceHistory';
@@ -13,8 +13,6 @@ export const VariantSchema = z.object({
options_text: z.string(),
track_inventory: z.boolean(),
media_count: z.number(),
- created_at: z.string(),
- updated_at: z.string(),
thumbnail_url: z.string().nullable(),
purchasable: z.boolean(),
in_stock: z.boolean(),
@@ -28,7 +26,7 @@ export const VariantSchema = z.object({
primary_media: MediaSchema.optional(),
media: z.array(MediaSchema).optional(),
option_values: z.array(OptionValueSchema),
- metafields: z.array(MetafieldSchema).optional(),
+ custom_fields: z.array(CustomFieldSchema).optional(),
prior_price: PriceHistorySchema.nullable().optional(),
});
diff --git a/packages/sdk/src/zod/generated/index.ts b/packages/sdk/src/zod/generated/index.ts
index c05757abc3..f9d1395a1e 100644
--- a/packages/sdk/src/zod/generated/index.ts
+++ b/packages/sdk/src/zod/generated/index.ts
@@ -6,6 +6,7 @@ export { CategorySchema, type Category } from './Category';
export { CountrySchema, type Country } from './Country';
export { CreditCardSchema, type CreditCard } from './CreditCard';
export { CurrencySchema, type Currency } from './Currency';
+export { CustomFieldSchema, type CustomField } from './CustomField';
export { CustomerSchema, type Customer } from './Customer';
export { DeliveryMethodSchema, type DeliveryMethod } from './DeliveryMethod';
export { DeliveryRateSchema, type DeliveryRate } from './DeliveryRate';
@@ -20,7 +21,6 @@ export { LineItemSchema, type LineItem } from './LineItem';
export { LocaleSchema, type Locale } from './Locale';
export { MarketSchema, type Market } from './Market';
export { MediaSchema, type Media } from './Media';
-export { MetafieldSchema, type Metafield } from './Metafield';
export { NewsletterSubscriberSchema, type NewsletterSubscriber } from './NewsletterSubscriber';
export { OptionTypeSchema, type OptionType } from './OptionType';
export { OptionValueSchema, type OptionValue } from './OptionValue';
diff --git a/spree/api/app/serializers/spree/api/v3/admin/allowed_origin_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/allowed_origin_serializer.rb
index d5d12d5c34..aed2acf731 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/allowed_origin_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/allowed_origin_serializer.rb
@@ -7,13 +7,11 @@ module Spree
class AllowedOriginSerializer < V3::BaseSerializer
typelize store_id: :string
- attributes :id, :origin
+ attributes :id, :origin, created_at: :iso8601, updated_at: :iso8601
attribute :store_id do |allowed_origin|
allowed_origin.store&.prefixed_id
end
-
- attributes created_at: :iso8601, updated_at: :iso8601
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/category_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/category_serializer.rb
index 3f385d3ba4..16561630ba 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/category_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/category_serializer.rb
@@ -8,7 +8,7 @@ module Spree
typelize lft: :number, rgt: :number
# Nested set columns for tree operations
- attributes :lft, :rgt
+ attributes :lft, :rgt, created_at: :iso8601, updated_at: :iso8601
# Override inherited associations to use admin serializers
one :parent,
@@ -24,8 +24,9 @@ module Spree
if: proc { expand?('ancestors') }
many :metafields,
- resource: Spree.api.admin_metafield_serializer,
- if: proc { expand?('metafields') }
+ key: :custom_fields,
+ resource: Spree.api.admin_custom_field_serializer,
+ if: proc { expand?('custom_fields') }
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/custom_field_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/custom_field_serializer.rb
new file mode 100644
index 0000000000..6910fd7028
--- /dev/null
+++ b/spree/api/app/serializers/spree/api/v3/admin/custom_field_serializer.rb
@@ -0,0 +1,19 @@
+module Spree
+ module Api
+ module V3
+ module Admin
+ # Admin API Custom Field Serializer
+ # Full custom field data including admin-only fields
+ class CustomFieldSerializer < V3::CustomFieldSerializer
+ typelize storefront_visible: :boolean
+
+ attributes created_at: :iso8601, updated_at: :iso8601
+
+ attribute :storefront_visible do |metafield|
+ metafield.display_on.in?(%w[both front_end])
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/customer_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/customer_serializer.rb
index 06cb299497..2b4c8a59fb 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/customer_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/customer_serializer.rb
@@ -12,7 +12,8 @@ module Spree
# Admin-only attributes
attributes :login,
- last_sign_in_at: :iso8601, current_sign_in_at: :iso8601
+ last_sign_in_at: :iso8601, current_sign_in_at: :iso8601,
+ created_at: :iso8601, updated_at: :iso8601
attribute :sign_in_count do |user|
user.sign_in_count
diff --git a/spree/api/app/serializers/spree/api/v3/admin/delivery_rate_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/delivery_rate_serializer.rb
index c0149d2a60..d568bf0a03 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/delivery_rate_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/delivery_rate_serializer.rb
@@ -3,6 +3,8 @@ module Spree
module V3
module Admin
class DeliveryRateSerializer < V3::DeliveryRateSerializer
+ attributes created_at: :iso8601, updated_at: :iso8601
+
one :shipping_method, key: :delivery_method, resource: Spree.api.admin_delivery_method_serializer, if: proc { expand?('delivery_method') }
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/digital_link_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/digital_link_serializer.rb
index cbf3344522..b9fd967f8a 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/digital_link_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/digital_link_serializer.rb
@@ -3,6 +3,7 @@ module Spree
module V3
module Admin
class DigitalLinkSerializer < V3::DigitalLinkSerializer
+ attributes created_at: :iso8601, updated_at: :iso8601
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/discount_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/discount_serializer.rb
index 86dff25be8..795a5c65b7 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/discount_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/discount_serializer.rb
@@ -3,6 +3,7 @@ module Spree
module V3
module Admin
class DiscountSerializer < V3::DiscountSerializer
+ attributes created_at: :iso8601, updated_at: :iso8601
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/fulfillment_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/fulfillment_serializer.rb
index 69024490b0..2373f59536 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/fulfillment_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/fulfillment_serializer.rb
@@ -11,7 +11,8 @@ module Spree
pre_tax_amount: :string
attributes :adjustment_total, :additional_tax_total,
- :included_tax_total, :promo_total, :pre_tax_amount
+ :included_tax_total, :promo_total, :pre_tax_amount,
+ created_at: :iso8601, updated_at: :iso8601
attribute :metadata do |shipment|
shipment.metadata.presence
diff --git a/spree/api/app/serializers/spree/api/v3/admin/line_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/line_item_serializer.rb
index 6dc26f44ad..918d8f202d 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/line_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/line_item_serializer.rb
@@ -10,6 +10,8 @@ module Spree
tax_category_id: [:string, nullable: true],
order_id: [:string, nullable: true]
+ attributes created_at: :iso8601, updated_at: :iso8601
+
attribute :metadata do |line_item|
line_item.metadata.presence
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/media_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/media_serializer.rb
index 82fec18faf..578b173d1c 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/media_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/media_serializer.rb
@@ -5,6 +5,8 @@ module Spree
class MediaSerializer < V3::MediaSerializer
typelize viewable_type: :string, viewable_id: :string
+ attributes created_at: :iso8601, updated_at: :iso8601
+
attribute :viewable_id do |asset|
asset.viewable&.prefixed_id
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/metafield_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/metafield_serializer.rb
deleted file mode 100644
index bd3795b3b6..0000000000
--- a/spree/api/app/serializers/spree/api/v3/admin/metafield_serializer.rb
+++ /dev/null
@@ -1,15 +0,0 @@
-module Spree
- module Api
- module V3
- module Admin
- # Admin API Metafield Serializer
- # Full metafield data including admin-only fields
- class MetafieldSerializer < V3::MetafieldSerializer
- typelize display_on: :string
-
- attributes :display_on
- end
- end
- end
- end
-end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/option_type_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/option_type_serializer.rb
index 9af55a0360..cad95f04d3 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/option_type_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/option_type_serializer.rb
@@ -3,6 +3,8 @@ module Spree
module V3
module Admin
class OptionTypeSerializer < V3::OptionTypeSerializer
+ attributes created_at: :iso8601, updated_at: :iso8601
+
many :option_values,
resource: Spree.api.admin_option_value_serializer,
if: proc { expand?('option_values') }
diff --git a/spree/api/app/serializers/spree/api/v3/admin/option_value_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/option_value_serializer.rb
index 65132da1b4..cdd5a089a4 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/option_value_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/option_value_serializer.rb
@@ -3,6 +3,8 @@ module Spree
module V3
module Admin
class OptionValueSerializer < V3::OptionValueSerializer
+ attributes created_at: :iso8601, updated_at: :iso8601
+
one :option_type,
resource: Spree.api.admin_option_type_serializer,
if: proc { expand?('option_type') }
diff --git a/spree/api/app/serializers/spree/api/v3/admin/order_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/order_serializer.rb
index 14bb8623fe..2decd86d31 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/order_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/order_serializer.rb
@@ -6,7 +6,7 @@ module Spree
# Full order data including admin-only fields
class OrderSerializer < V3::OrderSerializer
- typelize channel: [:string, nullable: true], last_ip_address: [:string, nullable: true],
+ typelize last_ip_address: [:string, nullable: true],
considered_risky: :boolean, confirmation_delivered: :boolean,
store_owner_notification_delivered: :boolean,
internal_note: [:string, nullable: true], approver_id: [:string, nullable: true],
@@ -17,7 +17,7 @@ module Spree
metadata: 'Record<string, unknown> | null'
# Admin-only attributes
- attributes :channel, :last_ip_address, :considered_risky,
+ attributes :last_ip_address, :considered_risky,
:confirmation_delivered, :store_owner_notification_delivered,
:internal_note, :payment_total, :display_payment_total,
canceled_at: :iso8601, approved_at: :iso8601
diff --git a/spree/api/app/serializers/spree/api/v3/admin/payment_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/payment_serializer.rb
index b92b0d02d5..671559a458 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/payment_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/payment_serializer.rb
@@ -10,7 +10,8 @@ module Spree
cvv_response_code: [:string, nullable: true],
cvv_response_message: [:string, nullable: true]
- attributes :avs_response, :cvv_response_code, :cvv_response_message
+ attributes :avs_response, :cvv_response_code, :cvv_response_message,
+ created_at: :iso8601, updated_at: :iso8601
attribute :metadata do |payment|
payment.metadata.presence
diff --git a/spree/api/app/serializers/spree/api/v3/admin/payment_source_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/payment_source_serializer.rb
index fd96843c4f..c177d69f87 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/payment_source_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/payment_source_serializer.rb
@@ -3,6 +3,7 @@ module Spree
module V3
module Admin
class PaymentSourceSerializer < V3::PaymentSourceSerializer
+ attributes created_at: :iso8601, updated_at: :iso8601
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb
index 3333308ad2..2e8ee285b4 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb
@@ -13,7 +13,8 @@ module Spree
deleted_at: [:string, nullable: true]
# Admin-only attributes
- attributes :status, :make_active_at, :discontinue_on, deleted_at: :iso8601
+ attributes :status, :make_active_at, :discontinue_on, deleted_at: :iso8601,
+ created_at: :iso8601, updated_at: :iso8601
attribute :cost_price do |product|
product.master&.cost_price
@@ -54,8 +55,9 @@ module Spree
if: proc { expand?('categories') }
many :metafields,
- resource: Spree.api.admin_metafield_serializer,
- if: proc { expand?('metafields') }
+ key: :custom_fields,
+ resource: Spree.api.admin_custom_field_serializer,
+ if: proc { expand?('custom_fields') }
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/refund_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/refund_serializer.rb
index a7dffab49f..38c1ab318b 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/refund_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/refund_serializer.rb
@@ -7,6 +7,8 @@ module Spree
refund_reason_id: [:string, nullable: true],
reimbursement_id: [:string, nullable: true]
+ attributes created_at: :iso8601, updated_at: :iso8601
+
one :payment,
resource: Spree.api.admin_payment_serializer,
if: proc { expand?('payment') }
diff --git a/spree/api/app/serializers/spree/api/v3/admin/reimbursement_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/reimbursement_serializer.rb
index f3d865cf35..bbb00a0172 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/reimbursement_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/reimbursement_serializer.rb
@@ -3,6 +3,8 @@ module Spree
module V3
module Admin
class ReimbursementSerializer < V3::ReimbursementSerializer
+ attributes created_at: :iso8601, updated_at: :iso8601
+
one :order,
resource: Spree.api.admin_order_serializer,
if: proc { expand?('order') }
diff --git a/spree/api/app/serializers/spree/api/v3/admin/return_authorization_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/return_authorization_serializer.rb
index b882c44d9c..0285967233 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/return_authorization_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/return_authorization_serializer.rb
@@ -3,6 +3,8 @@ module Spree
module V3
module Admin
class ReturnAuthorizationSerializer < V3::ReturnAuthorizationSerializer
+ attributes created_at: :iso8601, updated_at: :iso8601
+
one :order,
resource: Spree.api.admin_order_serializer,
if: proc { expand?('order') }
diff --git a/spree/api/app/serializers/spree/api/v3/admin/stock_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/stock_item_serializer.rb
index 65a268df83..fb002062a4 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/stock_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/stock_item_serializer.rb
@@ -3,6 +3,8 @@ module Spree
module V3
module Admin
class StockItemSerializer < V3::StockItemSerializer
+ attributes created_at: :iso8601, updated_at: :iso8601
+
one :stock_location,
resource: Spree.api.admin_stock_location_serializer,
if: proc { expand?('stock_location') }
diff --git a/spree/api/app/serializers/spree/api/v3/admin/store_credit_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/store_credit_serializer.rb
index e8eb1b2fe5..ab5d439154 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/store_credit_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/store_credit_serializer.rb
@@ -7,6 +7,8 @@ module Spree
created_by_id: [:string, nullable: true],
metadata: 'Record<string, unknown> | null'
+ attributes created_at: :iso8601, updated_at: :iso8601
+
attribute :customer_id do |store_credit|
store_credit.user&.prefixed_id
end
diff --git a/spree/api/app/serializers/spree/api/v3/admin/variant_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/variant_serializer.rb
index c022b776d0..86b45e8113 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/variant_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/variant_serializer.rb
@@ -13,11 +13,8 @@ module Spree
deleted_at: [:string, nullable: true]
# Admin-only attributes
- attributes :position, :tax_category_id, :cost_price, :cost_currency, deleted_at: :iso8601
-
- attribute :total_on_hand do |variant|
- variant.total_on_hand
- end
+ attributes :position, :total_on_hand, :tax_category_id, :cost_price, :cost_currency, deleted_at: :iso8601,
+ created_at: :iso8601, updated_at: :iso8601
# Override inherited associations to use admin serializers
one :primary_media,
@@ -37,8 +34,9 @@ module Spree
if: proc { expand?('prices') }
many :metafields,
- resource: Spree.api.admin_metafield_serializer,
- if: proc { expand?('metafields') }
+ key: :custom_fields,
+ resource: Spree.api.admin_custom_field_serializer,
+ if: proc { expand?('custom_fields') }
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/category_serializer.rb b/spree/api/app/serializers/spree/api/v3/category_serializer.rb
index d2393ca383..92ecc5cf18 100644
--- a/spree/api/app/serializers/spree/api/v3/category_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/category_serializer.rb
@@ -62,9 +62,9 @@ module Spree
if: proc { expand?('ancestors') }
many :public_metafields,
- key: :metafields,
- resource: Spree.api.metafield_serializer,
- if: proc { expand?('metafields') }
+ key: :custom_fields,
+ resource: Spree.api.custom_field_serializer,
+ if: proc { expand?('custom_fields') }
end
end
end
diff --git a/spree/api/app/serializers/spree/api/v3/metafield_serializer.rb b/spree/api/app/serializers/spree/api/v3/custom_field_serializer.rb
similarity index 68%
rename from spree/api/app/serializers/spree/api/v3/metafield_serializer.rb
rename to spree/api/app/serializers/spree/api/v3/custom_field_serializer.rb
index e06284091a..ba4cee61f4 100644
--- a/spree/api/app/serializers/spree/api/v3/metafield_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/custom_field_serializer.rb
@@ -1,9 +1,9 @@
module Spree
module Api
module V3
- # Store API Metafield Serializer
- # Customer-facing metafield data (public metafields only)
- class MetafieldSerializer < BaseSerializer
+ # Store API Custom Field Serializer
+ # Customer-facing custom field data (public metafields only)
+ class CustomFieldSerializer < BaseSerializer
typelize key: :string, name: :string, type: :string, value: :any
attributes :name, :type
diff --git a/spree/api/app/serializers/spree/api/v3/customer_serializer.rb b/spree/api/app/serializers/spree/api/v3/customer_serializer.rb
index 86b36c77ef..8f78c18abf 100644
--- a/spree/api/app/serializers/spree/api/v3/customer_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/customer_serializer.rb
@@ -9,8 +9,7 @@ module Spree
available_store_credit_total: :string, display_available_store_credit_total: :string,
default_billing_address: { nullable: true }, default_shipping_address: { nullable: true }
- attributes :email, :first_name, :last_name, :phone, :accepts_email_marketing,
- created_at: :iso8601, updated_at: :iso8601
+ attributes :email, :first_name, :last_name, :phone, :accepts_email_marketing
attribute :available_store_credit_total do |user, params|
store = params&.dig(:store) || Spree::Current.store
diff --git a/spree/api/app/serializers/spree/api/v3/digital_link_serializer.rb b/spree/api/app/serializers/spree/api/v3/digital_link_serializer.rb
index 7f655f4cb1..f72122fb38 100644
--- a/spree/api/app/serializers/spree/api/v3/digital_link_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/digital_link_serializer.rb
@@ -6,8 +6,7 @@ module Spree
download_url: :string,
authorizable: :boolean, expired: :boolean, access_limit_exceeded: :boolean
- attributes :access_counter, :filename, :content_type,
- created_at: :iso8601, updated_at: :iso8601
+ attributes :access_counter, :filename, :content_type
attribute :download_url do |digital_link|
Spree::Core::Engine.routes.url_helpers.api_v3_store_digital_download_path(token: digital_link.token)
diff --git a/spree/api/app/serializers/spree/api/v3/fulfillment_serializer.rb b/spree/api/app/serializers/spree/api/v3/fulfillment_serializer.rb
index 6786fb8355..c4853a230d 100644
--- a/spree/api/app/serializers/spree/api/v3/fulfillment_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/fulfillment_serializer.rb
@@ -9,8 +9,7 @@ module Spree
items: 'Array<{ item_id: string; variant_id: string; quantity: number }>'
attributes :number, :tracking, :tracking_url,
- :cost, :display_cost,
- created_at: :iso8601, updated_at: :iso8601
+ :cost, :display_cost
attribute :status do |shipment|
shipment.state
diff --git a/spree/api/app/serializers/spree/api/v3/line_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/line_item_serializer.rb
index 894a23d320..00787da208 100644
--- a/spree/api/app/serializers/spree/api/v3/line_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/line_item_serializer.rb
@@ -26,8 +26,7 @@ module Spree
:discount_total, :display_discount_total,
:pre_tax_amount, :display_pre_tax_amount,
:discounted_amount, :display_discounted_amount,
- :display_compare_at_amount,
- created_at: :iso8601, updated_at: :iso8601
+ :display_compare_at_amount
# Return compare_at_amount as string, nil if zero
attribute :compare_at_amount do |line_item|
diff --git a/spree/api/app/serializers/spree/api/v3/media_serializer.rb b/spree/api/app/serializers/spree/api/v3/media_serializer.rb
index 73d83331c2..c63d72aa4e 100644
--- a/spree/api/app/serializers/spree/api/v3/media_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/media_serializer.rb
@@ -29,8 +29,7 @@ module Spree
end
attributes :position, :alt, :media_type,
- :focal_point_x, :focal_point_y, :external_video_url,
- created_at: :iso8601, updated_at: :iso8601
+ :focal_point_x, :focal_point_y, :external_video_url
attribute :original_url do |asset|
image_url_for(asset)
diff --git a/spree/api/app/serializers/spree/api/v3/payment_serializer.rb b/spree/api/app/serializers/spree/api/v3/payment_serializer.rb
index 8eebdd1f12..d76c8f2783 100644
--- a/spree/api/app/serializers/spree/api/v3/payment_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/payment_serializer.rb
@@ -12,8 +12,7 @@ module Spree
payment.payment_method&.prefixed_id
end
- attributes :response_code, :number, :amount, :display_amount,
- created_at: :iso8601, updated_at: :iso8601
+ attributes :response_code, :number, :amount, :display_amount
attribute :status do |payment|
payment.state
diff --git a/spree/api/app/serializers/spree/api/v3/product_serializer.rb b/spree/api/app/serializers/spree/api/v3/product_serializer.rb
index a3d8a9c69d..26f45c9523 100644
--- a/spree/api/app/serializers/spree/api/v3/product_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/product_serializer.rb
@@ -18,7 +18,7 @@ module Spree
attributes :name, :slug,
:meta_description, :meta_keywords,
:variant_count,
- available_on: :iso8601, created_at: :iso8601, updated_at: :iso8601
+ available_on: :iso8601
attribute :purchasable do |product|
product.purchasable?
@@ -108,9 +108,9 @@ module Spree
if: proc { expand?('categories') }
many :public_metafields,
- key: :metafields,
- resource: Spree.api.metafield_serializer,
- if: proc { expand?('metafields') }
+ key: :custom_fields,
+ resource: Spree.api.custom_field_serializer,
+ if: proc { expand?('custom_fields') }
typelize prior_price: ['PriceHistory', nullable: true]
diff --git a/spree/api/app/serializers/spree/api/v3/refund_serializer.rb b/spree/api/app/serializers/spree/api/v3/refund_serializer.rb
index 77206937a6..a1333c1583 100644
--- a/spree/api/app/serializers/spree/api/v3/refund_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/refund_serializer.rb
@@ -8,7 +8,7 @@ module Spree
payment_id: [:string, nullable: true], refund_reason_id: [:string, nullable: true],
reimbursement_id: [:string, nullable: true]
- attributes :transaction_id, created_at: :iso8601, updated_at: :iso8601
+ attributes :transaction_id
attribute :amount do |refund|
refund.amount&.to_s
diff --git a/spree/api/app/serializers/spree/api/v3/reimbursement_serializer.rb b/spree/api/app/serializers/spree/api/v3/reimbursement_serializer.rb
index f64023f22c..c3022f3287 100644
--- a/spree/api/app/serializers/spree/api/v3/reimbursement_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/reimbursement_serializer.rb
@@ -8,8 +8,7 @@ module Spree
total: [:string, nullable: true],
order_id: [:string, nullable: true], customer_return_id: [:string, nullable: true]
- attributes :number, :reimbursement_status,
- created_at: :iso8601, updated_at: :iso8601
+ attributes :number, :reimbursement_status
attribute :total do |reimbursement|
reimbursement.total&.to_s
diff --git a/spree/api/app/serializers/spree/api/v3/return_authorization_serializer.rb b/spree/api/app/serializers/spree/api/v3/return_authorization_serializer.rb
index a6c3d4a212..89eb472c75 100644
--- a/spree/api/app/serializers/spree/api/v3/return_authorization_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/return_authorization_serializer.rb
@@ -8,7 +8,7 @@ module Spree
order_id: [:string, nullable: true], stock_location_id: [:string, nullable: true],
return_authorization_reason_id: [:string, nullable: true]
- attributes :number, created_at: :iso8601, updated_at: :iso8601
+ attributes :number
attribute :status do |return_authorization|
return_authorization.state.to_s
diff --git a/spree/api/app/serializers/spree/api/v3/stock_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/stock_item_serializer.rb
index 23a7b978d8..30b1d9c201 100644
--- a/spree/api/app/serializers/spree/api/v3/stock_item_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/stock_item_serializer.rb
@@ -7,8 +7,7 @@ module Spree
typelize count_on_hand: :number, backorderable: :boolean,
stock_location_id: [:string, nullable: true], variant_id: [:string, nullable: true]
- attributes :count_on_hand, :backorderable,
- created_at: :iso8601, updated_at: :iso8601
+ attributes :count_on_hand, :backorderable
attribute :stock_location_id do |stock_item|
stock_item.stock_location&.prefixed_id
diff --git a/spree/api/app/serializers/spree/api/v3/variant_serializer.rb b/spree/api/app/serializers/spree/api/v3/variant_serializer.rb
index 071f43596c..2ebc9de8fc 100644
--- a/spree/api/app/serializers/spree/api/v3/variant_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/variant_serializer.rb
@@ -16,8 +16,7 @@ module Spree
variant.product&.prefixed_id
end
- attributes :sku, :options_text, :track_inventory, :media_count,
- created_at: :iso8601, updated_at: :iso8601
+ attributes :sku, :options_text, :track_inventory, :media_count
# Main variant image URL for listings (cached primary_media)
attribute :thumbnail_url do |variant|
@@ -82,9 +81,9 @@ module Spree
many :option_values, resource: Spree.api.option_value_serializer
many :public_metafields,
- key: :metafields,
- resource: Spree.api.metafield_serializer,
- if: proc { expand?('metafields') }
+ key: :custom_fields,
+ resource: Spree.api.custom_field_serializer,
+ if: proc { expand?('custom_fields') }
typelize prior_price: ['PriceHistory', nullable: true]
diff --git a/spree/api/lib/spree/api/dependencies.rb b/spree/api/lib/spree/api/dependencies.rb
index 5176ceb44d..054bbd73c3 100644
--- a/spree/api/lib/spree/api/dependencies.rb
+++ b/spree/api/lib/spree/api/dependencies.rb
@@ -131,7 +131,7 @@ module Spree
currency_serializer: 'Spree::Api::V3::CurrencySerializer',
locale_serializer: 'Spree::Api::V3::LocaleSerializer',
policy_serializer: 'Spree::Api::V3::PolicySerializer',
- metafield_serializer: 'Spree::Api::V3::MetafieldSerializer',
+ custom_field_serializer: 'Spree::Api::V3::CustomFieldSerializer',
shipping_category_serializer: 'Spree::Api::V3::ShippingCategorySerializer',
tax_category_serializer: 'Spree::Api::V3::TaxCategorySerializer',
@@ -163,7 +163,7 @@ module Spree
admin_variant_serializer: 'Spree::Api::V3::Admin::VariantSerializer',
admin_price_serializer: 'Spree::Api::V3::Admin::PriceSerializer',
admin_price_history_serializer: 'Spree::Api::V3::Admin::PriceHistorySerializer',
- admin_metafield_serializer: 'Spree::Api::V3::Admin::MetafieldSerializer',
+ admin_custom_field_serializer: 'Spree::Api::V3::Admin::CustomFieldSerializer',
admin_category_serializer: 'Spree::Api::V3::Admin::CategorySerializer',
admin_line_item_serializer: 'Spree::Api::V3::Admin::LineItemSerializer',
admin_option_type_serializer: 'Spree::Api::V3::Admin::OptionTypeSerializer',
diff --git a/spree/api/spec/controllers/concerns/spree/api/v3/nested_expand_spec.rb b/spree/api/spec/controllers/concerns/spree/api/v3/nested_expand_spec.rb
index cd9dd854bb..2ac09f4afb 100644
--- a/spree/api/spec/controllers/concerns/spree/api/v3/nested_expand_spec.rb
+++ b/spree/api/spec/controllers/concerns/spree/api/v3/nested_expand_spec.rb
@@ -51,13 +51,13 @@ RSpec.describe Spree::Api::V3::Store::ProductsController, type: :controller do
end
it 'supports multiple nested expands' do
- get :show, params: { id: product.prefixed_id, expand: 'variants.media,variants.metafields' }
+ get :show, params: { id: product.prefixed_id, expand: 'variants.media,variants.custom_fields' }
data = JSON.parse(response.body)
expect(data).to have_key('variants')
data['variants'].each do |variant|
expect(variant).to have_key('media')
- expect(variant).to have_key('metafields')
+ expect(variant).to have_key('custom_fields')
end
end
diff --git a/spree/api/spec/integration/spree/api/v3/store/categories_spec.rb b/spree/api/spec/integration/spree/api/v3/store/categories_spec.rb
index 75ce9b0771..20ff220254 100644
--- a/spree/api/spec/integration/spree/api/v3/store/categories_spec.rb
+++ b/spree/api/spec/integration/spree/api/v3/store/categories_spec.rb
@@ -82,7 +82,7 @@ RSpec.describe 'Categories API', type: :request, swagger_doc: 'api-reference/sto
parameter name: :id, in: :path, type: :string, required: true,
description: 'Category permalink (e.g., clothing/shirts) or prefix ID (e.g., ctg_abc123)'
parameter name: :expand, in: :query, type: :string, required: false,
- description: 'Expand associations (children, parent, ancestors, metafields)'
+ description: 'Expand associations (children, parent, ancestors, custom_fields)'
parameter name: :fields, in: :query, type: :string, required: false,
description: 'Comma-separated list of fields to include (e.g., name,slug,price). id is always included.'
diff --git a/spree/api/spec/serializers/spree/api/v3/metafield_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/custom_field_serializer_spec.rb
similarity index 69%
rename from spree/api/spec/serializers/spree/api/v3/metafield_serializer_spec.rb
rename to spree/api/spec/serializers/spree/api/v3/custom_field_serializer_spec.rb
index a2729c8e7c..790069076e 100644
--- a/spree/api/spec/serializers/spree/api/v3/metafield_serializer_spec.rb
+++ b/spree/api/spec/serializers/spree/api/v3/custom_field_serializer_spec.rb
@@ -1,6 +1,6 @@
require 'spec_helper'
-RSpec.describe Spree::Api::V3::MetafieldSerializer do
+RSpec.describe Spree::Api::V3::CustomFieldSerializer do
let(:store) { @default_store }
let(:product) { create(:product, stores: [store]) }
let(:metafield_definition) { create(:metafield_definition, resource_type: 'Spree::Product', display_on: 'both') }
@@ -33,7 +33,7 @@ RSpec.describe Spree::Api::V3::MetafieldSerializer do
end
end
-RSpec.describe Spree::Api::V3::Admin::MetafieldSerializer do
+RSpec.describe Spree::Api::V3::Admin::CustomFieldSerializer do
let(:store) { @default_store }
let(:product) { create(:product, stores: [store]) }
let(:metafield_definition) { create(:metafield_definition, resource_type: 'Spree::Product', display_on: 'back_end') }
@@ -52,8 +52,19 @@ RSpec.describe Spree::Api::V3::Admin::MetafieldSerializer do
)
end
- it 'includes display_on' do
- expect(subject['display_on']).to eq('back_end')
+ it 'includes storefront_visible as false for back_end display_on' do
+ expect(subject['storefront_visible']).to be false
+ end
+
+ it 'includes storefront_visible as true for both display_on' do
+ public_definition = create(:metafield_definition, resource_type: 'Spree::Product', display_on: 'both')
+ public_metafield = create(:metafield, resource: product, metafield_definition: public_definition, value: 'public value')
+ result = described_class.new(public_metafield, params: base_params).to_h
+ expect(result['storefront_visible']).to be true
+ end
+
+ it 'does not include display_on' do
+ expect(subject).not_to have_key('display_on')
end
end
end
diff --git a/spree/api/spec/serializers/spree/api/v3/product_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/product_serializer_spec.rb
index 73f9504d9e..4098c66b5a 100644
--- a/spree/api/spec/serializers/spree/api/v3/product_serializer_spec.rb
+++ b/spree/api/spec/serializers/spree/api/v3/product_serializer_spec.rb
@@ -49,20 +49,20 @@ RSpec.describe Spree::Api::V3::ProductSerializer do
end
end
- describe 'metafields' do
+ describe 'custom_fields' do
let(:public_definition) { create(:metafield_definition, resource_type: 'Spree::Product', display_on: 'both') }
let(:private_definition) { create(:metafield_definition, :back_end_only, resource_type: 'Spree::Product') }
let!(:public_metafield) { create(:metafield, resource: product, metafield_definition: public_definition, value: 'public') }
let!(:private_metafield) { create(:metafield, resource: product, metafield_definition: private_definition, value: 'private') }
- it 'does not include metafields without include param' do
- expect(subject).not_to have_key('metafields')
+ it 'does not include custom_fields without expand param' do
+ expect(subject).not_to have_key('custom_fields')
end
- it 'includes only public metafields with include param' do
- result = described_class.new(product, params: base_params.merge(expand: ['metafields'])).to_h
- expect(result['metafields'].length).to eq(1)
- expect(result['metafields'].first['value']).to eq('public')
+ it 'includes only public custom fields with expand param' do
+ result = described_class.new(product, params: base_params.merge(expand: ['custom_fields'])).to_h
+ expect(result['custom_fields'].length).to eq(1)
+ expect(result['custom_fields'].first['value']).to eq('public')
end
end
end
@@ -80,15 +80,15 @@ RSpec.describe Spree::Api::V3::Admin::ProductSerializer do
expect(subject.keys).to include('cost_price', 'cost_currency', 'deleted_at', 'status')
end
- it 'includes all metafields with display_on when included' do
+ it 'includes all custom fields with storefront_visible when expanded' do
public_def = create(:metafield_definition, resource_type: 'Spree::Product', display_on: 'both')
private_def = create(:metafield_definition, :back_end_only, resource_type: 'Spree::Product')
create(:metafield, resource: product, metafield_definition: public_def, value: 'public')
create(:metafield, resource: product, metafield_definition: private_def, value: 'private')
- result = described_class.new(product, params: base_params.merge(expand: ['metafields'])).to_h
- expect(result['metafields'].length).to eq(2)
- expect(result['metafields']).to all(have_key('display_on'))
+ result = described_class.new(product, params: base_params.merge(expand: ['custom_fields'])).to_h
+ expect(result['custom_fields'].length).to eq(2)
+ expect(result['custom_fields']).to all(have_key('storefront_visible'))
end
end
end
diff --git a/spree/core/app/models/concerns/spree/metadata.rb b/spree/core/app/models/concerns/spree/metadata.rb
index 95772ec926..52456b84d3 100644
--- a/spree/core/app/models/concerns/spree/metadata.rb
+++ b/spree/core/app/models/concerns/spree/metadata.rb
@@ -22,6 +22,16 @@ module Spree
self.private_metadata = value
end
+ def public_metadata=(value)
+ unless value.blank? || value == {}
+ Spree::Deprecation.warn(
+ 'public_metadata is deprecated and will be removed in Spree 6.0. ' \
+ 'Use metadata instead. For customer-visible structured data, use metafields with display_on: \'both\'.'
+ )
+ end
+ super
+ end
+
# https://nandovieira.com/using-postgresql-and-jsonb-with-ruby-on-rails
class HashSerializer
def self.dump(hash)
diff --git a/spree/core/app/models/spree/metafield.rb b/spree/core/app/models/spree/metafield.rb
index 8fcfffc0ef..9421189be2 100644
--- a/spree/core/app/models/spree/metafield.rb
+++ b/spree/core/app/models/spree/metafield.rb
@@ -1,6 +1,6 @@
module Spree
class Metafield < Spree.base_class
- has_prefix_id :mf
+ has_prefix_id :cf
#
# Associations
diff --git a/spree/core/app/models/spree/metafield_definition.rb b/spree/core/app/models/spree/metafield_definition.rb
index 97c09275a1..20a99a0fc9 100644
--- a/spree/core/app/models/spree/metafield_definition.rb
+++ b/spree/core/app/models/spree/metafield_definition.rb
@@ -1,6 +1,6 @@
module Spree
class MetafieldDefinition < Spree.base_class
- has_prefix_id :mfdef
+ has_prefix_id :cfdef
include Spree::DisplayOn