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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Show a seller's onboarding progress and addresses to the operator
Damian Legawiec50b2e562bb74
diff --git a/docs/api-reference/admin.yaml b/docs/api-reference/admin.yamlindex f4b8807142..9f94bc2c83 100644--- a/docs/api-reference/admin.yaml+++ b/docs/api-reference/admin.yaml@@ -92,16 +92,16 @@ paths:content:application/json:example:- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJhZG1pbiIsImp0aSI6IjNkYzVlOTMxLTc3MmMtNGRhNS1hOTZhLWQ4MWEwMDE3YjczOSIsImlzcyI6InNwcmVlIiwiYXVkIjoiYWRtaW5fYXBpIiwiZXhwIjoxNzg3MDg0MDk0fQ.M1B2Nwc7tMKjiM5Ad_bz1SCGA-yQ4bFxGI-c2tRJ2h0+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJhZG1pbiIsImp0aSI6IjBmNjk3ZDk5LTJkZGItNDBlNy05MmM1LTAzMmI0NDAwOGQ1YiIsImlzcyI6InNwcmVlIiwiYXVkIjoiYWRtaW5fYXBpIiwiZXhwIjoxNzg3MjM2Njk2fQ.N6V__-aOWKH-CJCp37THLQiwXY3WcKF-UFTWThOB7lUuser:id: adm_UkLWZg9DAJemail: [email protected]- first_name: Ariane- last_name: Prosacco- full_name: Ariane Prosacco+ first_name: Rickie+ last_name: Cassin+ full_name: Rickie Cassinselected_locale:- created_at: '2026-08-18T20:09:54.343Z'- updated_at: '2026-08-18T20:09:54.343Z'+ created_at: '2026-08-20T14:33:16.803Z'+ updated_at: '2026-08-20T14:33:16.803Z'avatar_url:roles:- id: role_UkLWZg9DAJ@@ -204,16 +204,16 @@ paths:content:application/json:example:- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJhZG1pbiIsImp0aSI6Ijg3ZTJjZjk3LTQzNzItNDExZS04ZDAwLTExYTUzNWVmMDY3OSIsImlzcyI6InNwcmVlIiwiYXVkIjoiYWRtaW5fYXBpIiwiZXhwIjoxNzg3MDg0MDk0fQ.pisGx-W0iborFroS_Bknblih_n3j9FNpGnrYrMDTrqM+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJhZG1pbiIsImp0aSI6IjdiNDkzNzIyLTM0YjgtNGViMy05NjQyLWUzMjI0NGUxZjkxNiIsImlzcyI6InNwcmVlIiwiYXVkIjoiYWRtaW5fYXBpIiwiZXhwIjoxNzg3MjM2Njk2fQ.wr3dzbrRkL9aP1To_NK0Bqj4Q-pT6ZH2Ag2B1SU9tf8user:id: adm_UkLWZg9DAJemail: [email protected]- first_name: Sonia- last_name: Bode- full_name: Sonia Bode+ first_name: Corliss+ last_name: Welch+ full_name: Corliss Welchselected_locale:- created_at: '2026-08-18T20:09:54.479Z'- updated_at: '2026-08-18T20:09:54.479Z'+ created_at: '2026-08-20T14:33:16.927Z'+ updated_at: '2026-08-20T14:33:16.927Z'avatar_url:roles:- id: role_UkLWZg9DAJ@@ -315,13 +315,13 @@ paths:example:user:id: adm_UkLWZg9DAJ- email: [email protected]- first_name: Mabel- last_name: Mueller- full_name: Mabel Mueller+ email: [email protected]+ first_name: Zena+ last_name: Senger+ full_name: Zena Sengerselected_locale:- created_at: '2026-08-18T20:10:19.903Z'- updated_at: '2026-08-18T20:10:19.903Z'+ created_at: '2026-08-20T14:33:30.348Z'+ updated_at: '2026-08-20T14:33:30.348Z'avatar_url:roles:- id: role_UkLWZg9DAJ@@ -438,13 +438,13 @@ paths:example:user:id: adm_UkLWZg9DAJ- email: [email protected]- first_name: Svetlana- last_name: Mueller- full_name: Svetlana Mueller+ email: [email protected]+ first_name: Prince+ last_name: Pagac+ full_name: Prince Pagacselected_locale: de- created_at: '2026-08-18T20:10:20.001Z'- updated_at: '2026-08-18T20:10:20.020Z'+ created_at: '2026-08-20T14:33:30.428Z'+ updated_at: '2026-08-20T14:33:30.445Z'avatar_url:roles:- id: role_UkLWZg9DAJ@@ -638,16 +638,16 @@ paths:content:application/json:example:- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJhZG1pbiIsImp0aSI6IjY0NmZiNGM2LTk0YjUtNGRmOS1iMDQyLWE2Y2MyOTNkYWQ4YiIsImlzcyI6InNwcmVlIiwiYXVkIjoiYWRtaW5fYXBpIiwiZXhwIjoxNzg3MDg3NDQ2fQ.ah5j5trNgNTKXSXUXnRf1_hH9uA11syIe825EC5IYaM+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJhZG1pbiIsImp0aSI6ImQ0ZTlhNzYwLTZmMjQtNGZiMi1iMzIwLTM3M2YwMzc5YmYyOSIsImlzcyI6InNwcmVlIiwiYXVkIjoiYWRtaW5fYXBpIiwiZXhwIjoxNzg3MjQwMDI2fQ.QDBZ-Yo8YixNJtl2PrZX8bY0S65mCm4etW_lnppu0h0user:id: adm_UkLWZg9DAJemail: [email protected]- first_name: Tracy- last_name: Marquardt- full_name: Tracy Marquardt+ first_name: Timmy+ last_name: Brekke+ full_name: Timmy Brekkeselected_locale:- created_at: '2026-08-18T20:10:46.419Z'- updated_at: '2026-08-18T20:10:46.440Z'+ created_at: '2026-08-20T14:33:46.897Z'+ updated_at: '2026-08-20T14:33:46.913Z'avatar_url:roles:- id: role_UkLWZg9DAJ@@ -716,7 +716,7 @@ paths:content:application/json:example:- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJhZG1pbiIsImp0aSI6IjE1NDRiYTMxLTE3MDQtNDZiMi1iMzM2LWI0MmY0NDVkMTA2YSIsImlzcyI6InNwcmVlIiwiYXVkIjoiYWRtaW5fYXBpIiwiZXhwIjoxNzg3MDg0MTU3fQ.WEmDwFbf4C539CVAxVaSHpTH2DdRFctwVX_iAsL6urg+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJhZG1pbiIsImp0aSI6ImJiYTEwYmNkLTgzYzMtNGU4NC05MWIwLWI0ZjFhMDBhODMyMiIsImlzcyI6InNwcmVlIiwiYXVkIjoiYWRtaW5fYXBpIiwiZXhwIjoxNzg3MjM2NzQ3fQ.KOG7mX4rn2ebWk-B2Zy1TSZcPXChroGCr1Nrlsa-U08user:id: adm_UkLWZg9DAJemail: [email protected]@@ -724,8 +724,8 @@ paths:last_name: Ownerfull_name: Olivia Ownerselected_locale:- created_at: '2026-08-18T20:10:57.395Z'- updated_at: '2026-08-18T20:10:57.395Z'+ created_at: '2026-08-20T14:34:06.914Z'+ updated_at: '2026-08-20T14:34:06.914Z'avatar_url:roles:- id: role_UkLWZg9DAJ@@ -2202,8 +2202,8 @@ paths:data:- id: ao_UkLWZg9DAJorigin: https://shop.example.com- created_at: '2026-08-18T20:09:52.850Z'- updated_at: '2026-08-18T20:09:52.850Z'+ created_at: '2026-08-20T14:33:15.717Z'+ updated_at: '2026-08-20T14:33:15.717Z'meta:page: 1limit: 25@@ -2287,8 +2287,8 @@ paths:example:id: ao_gbHJdmfrXBorigin: https://admin.example.com- created_at: '2026-08-18T20:09:53.036Z'- updated_at: '2026-08-18T20:09:53.036Z'+ created_at: '2026-08-20T14:33:15.909Z'+ updated_at: '2026-08-20T14:33:15.909Z'schema:"$ref": "#/components/schemas/AllowedOrigin"'422':@@ -2375,8 +2375,8 @@ paths:example:id: ao_UkLWZg9DAJorigin: https://shop.example.com- created_at: '2026-08-18T20:09:53.391Z'- updated_at: '2026-08-18T20:09:53.391Z'+ created_at: '2026-08-20T14:33:16.106Z'+ updated_at: '2026-08-20T14:33:16.106Z'schema:"$ref": "#/components/schemas/AllowedOrigin"'404':@@ -2437,8 +2437,8 @@ paths:example:id: ao_UkLWZg9DAJorigin: https://www.example.com- created_at: '2026-08-18T20:09:53.635Z'- updated_at: '2026-08-18T20:09:53.654Z'+ created_at: '2026-08-20T14:33:16.209Z'+ updated_at: '2026-08-20T14:33:16.252Z'schema:"$ref": "#/components/schemas/AllowedOrigin"'422':@@ -2558,34 +2558,34 @@ paths:key_type: publishabletoken_prefix:scopes: []- created_at: '2026-08-18T20:09:53.774Z'- updated_at: '2026-08-18T20:09:53.774Z'+ created_at: '2026-08-20T14:33:16.422Z'+ updated_at: '2026-08-20T14:33:16.422Z'revoked_at:last_used_at:channel_id:- plaintext_token: pk_XC2iQStmWm7PD64yxfUHPyhc+ plaintext_token: pk_ytfi8j6k8wZVFtiAGBAeVfHjcreated_by_email:- id: key_gbHJdmfrXBname: Backend integrationkey_type: secret- token_prefix: sk_JK1bU5Gfu+ token_prefix: sk_SPNbXfYvpscopes:- write_all- created_at: '2026-08-18T20:09:53.776Z'- updated_at: '2026-08-18T20:09:53.776Z'+ created_at: '2026-08-20T14:33:16.423Z'+ updated_at: '2026-08-20T14:33:16.423Z'revoked_at:last_used_at:channel_id:plaintext_token:created_by_email:- id: key_EfhxLZ9ck8- name: maxime+ name: evenietkey_type: secret- token_prefix: sk_mc5T69LgL+ token_prefix: sk_yebV5NgYdscopes:- write_all- created_at: '2026-08-18T20:09:53.777Z'- updated_at: '2026-08-18T20:09:53.777Z'+ created_at: '2026-08-20T14:33:16.424Z'+ updated_at: '2026-08-20T14:33:16.424Z'revoked_at:last_used_at:channel_id:@@ -2652,16 +2652,16 @@ paths:id: key_VqXmZF31wYname: CI keykey_type: secret- token_prefix: sk_VDNRQ4ZyR+ token_prefix: sk_FHkZ1HWJfscopes:- read_orders- created_at: '2026-08-18T20:09:53.881Z'- updated_at: '2026-08-18T20:09:53.881Z'+ created_at: '2026-08-20T14:33:16.491Z'+ updated_at: '2026-08-20T14:33:16.491Z'revoked_at:last_used_at:channel_id:- plaintext_token: sk_VDNRQ4ZyR4BnffoaKzvqRKdA- created_by_email: [email protected]+ plaintext_token: sk_FHkZ1HWJfkPwZ8BJEsVrx4WT+ created_by_email: [email protected]'422':description: validation errorcontent:@@ -2750,12 +2750,12 @@ paths:key_type: publishabletoken_prefix:scopes: []- created_at: '2026-08-18T20:09:53.916Z'- updated_at: '2026-08-18T20:09:53.916Z'+ created_at: '2026-08-20T14:33:16.534Z'+ updated_at: '2026-08-20T14:33:16.534Z'revoked_at:last_used_at:channel_id:- plaintext_token: pk_ANCTd4gDrG7oygV73GvcMjyw+ plaintext_token: pk_FmbuD41TsexHkspEFCHtTZ7pcreated_by_email:patch:summary: Update an API key@@ -2809,11 +2809,11 @@ paths:id: key_gbHJdmfrXBname: Backend integration (renamed)key_type: secret- token_prefix: sk_gHDuKFMe2+ token_prefix: sk_wAQ9etWLsscopes:- write_all- created_at: '2026-08-18T20:09:54.042Z'- updated_at: '2026-08-18T20:09:54.128Z'+ created_at: '2026-08-20T14:33:16.587Z'+ updated_at: '2026-08-20T14:33:16.636Z'revoked_at:last_used_at:channel_id:@@ -2910,13 +2910,13 @@ paths:application/json:example:id: key_EfhxLZ9ck8- name: ipsa+ name: atquekey_type: secret- token_prefix: sk_qmni8uegk+ token_prefix: sk_wzkh33jEWscopes:- write_all- created_at: '2026-08-18T20:09:54.204Z'- updated_at: '2026-08-18T20:09:54.204Z'+ created_at: '2026-08-20T14:33:16.680Z'+ updated_at: '2026-08-20T14:33:16.680Z'revoked_at:last_used_at:channel_id:@@ -2974,12 +2974,12 @@ paths:id: key_gbHJdmfrXBname: Backend integrationkey_type: secret- token_prefix: sk_pyA6Tzb5M+ token_prefix: sk_Jp12fnDcDscopes:- write_all- created_at: '2026-08-18T20:09:54.221Z'- updated_at: '2026-08-18T20:09:54.270Z'- revoked_at: '2026-08-18T20:09:54.269Z'+ created_at: '2026-08-20T14:33:16.718Z'+ updated_at: '2026-08-20T14:33:16.767Z'+ revoked_at: '2026-08-20T14:33:16.766Z'last_used_at:channel_id:plaintext_token:@@ -3056,8 +3056,8 @@ paths:lft: 1rgt: 2products_count: 0- created_at: '2026-08-18T20:09:54.760Z'- updated_at: '2026-08-18T20:09:54.760Z'+ created_at: '2026-08-20T14:33:17.201Z'+ updated_at: '2026-08-20T14:33:17.201Z'meta:page: 1limit: 25@@ -3131,8 +3131,8 @@ paths:lft: 2rgt: 3products_count: 0- created_at: '2026-08-18T20:09:54.934Z'- updated_at: '2026-08-18T20:09:54.942Z'+ created_at: '2026-08-20T14:33:17.327Z'+ updated_at: '2026-08-20T14:33:17.368Z'schema:"$ref": "#/components/schemas/Category"'422':@@ -3238,8 +3238,8 @@ paths:lft: 1rgt: 2products_count: 0- created_at: '2026-08-18T20:09:55.008Z'- updated_at: '2026-08-18T20:09:55.008Z'+ created_at: '2026-08-20T14:33:17.469Z'+ updated_at: '2026-08-20T14:33:17.469Z'schema:"$ref": "#/components/schemas/Category"'404':@@ -3309,8 +3309,8 @@ paths:lft: 1rgt: 2products_count: 0- created_at: '2026-08-18T20:09:55.312Z'- updated_at: '2026-08-18T20:09:55.368Z'+ created_at: '2026-08-20T14:33:17.600Z'+ updated_at: '2026-08-20T14:33:17.626Z'schema:"$ref": "#/components/schemas/Category"requestBody:@@ -3425,8 +3425,8 @@ paths:lft: 2rgt: 3products_count: 0- created_at: '2026-08-18T20:09:55.564Z'- updated_at: '2026-08-18T20:09:55.727Z'+ created_at: '2026-08-20T14:33:17.743Z'+ updated_at: '2026-08-20T14:33:17.867Z'schema:"$ref": "#/components/schemas/Category"requestBody:@@ -3538,8 +3538,8 @@ paths:application/json:example:id: prod_UkLWZg9DAJ- name: Product 12323- slug: product-12323+ name: Product 14614+ slug: product-14614meta_title:meta_description:meta_keywords:@@ -3551,12 +3551,19 @@ paths:in_stock: falsebackorderable: trueavailable: true- description: Dignissimos reprehenderit non voluptas aliquid. Tenetur- delectus aperiam eos ad nisi consequuntur illo. Ut commodi minus- voluptatibus voluptatum sapiente molestias.- description_html: Dignissimos reprehenderit non voluptas aliquid.- Tenetur delectus aperiam eos ad nisi consequuntur illo. Ut commodi- minus voluptatibus voluptatum sapiente molestias.+ description: Ullam sequi animi tenetur veritatis quis ipsam quia atque.+ Est occaecati provident culpa voluptate dicta incidunt. Ab sint+ nemo aut molestiae nobis fugit sunt dolore. Illo magnam deserunt+ repellat quas error tempora. Dolorum ea recusandae cupiditate nobis+ illum. Perferendis quis earum vel occaecati exercitationem ipsam+ nesciunt. Veritatis nam voluptas dolor quia. Unde nostrum nam modi+ reiciendis sint. Consequuntur minus autem aliquid debitis iusto.+ Assumenda quos incidunt magni placeat. Iure illum eligendi et magni+ pariatur.+ description_html: |-+ Ullam sequi animi tenetur veritatis quis ipsam quia atque. Est occaecati provident culpa voluptate dicta incidunt. Ab sint nemo aut molestiae nobis fugit sunt dolore. Illo magnam deserunt repellat quas error tempora.+ Dolorum ea recusandae cupiditate nobis illum. Perferendis quis earum vel occaecati exercitationem ipsam nesciunt. Veritatis nam voluptas dolor quia. Unde nostrum nam modi reiciendis sint.+ Consequuntur minus autem aliquid debitis iusto. Assumenda quos incidunt magni placeat. Iure illum eligendi et magni pariatur.default_variant_id: variant_UkLWZg9DAJbuy_box_variant_id: variant_UkLWZg9DAJthumbnail_url:@@ -3572,15 +3579,15 @@ paths:display_compare_at_amount:price_list_id:variant_id: variant_UkLWZg9DAJ- created_at: '2026-08-18T20:09:56.202Z'- updated_at: '2026-08-18T20:09:56.202Z'+ created_at: '2026-08-20T14:33:18.391Z'+ updated_at: '2026-08-20T14:33:18.391Z'original_price:seller_id:status: activemetadata: {}deleted_at:- created_at: '2026-08-18T20:09:56.142Z'- updated_at: '2026-08-18T20:09:56.282Z'+ created_at: '2026-08-20T14:33:18.335Z'+ updated_at: '2026-08-20T14:33:18.469Z'delivery_profile_id: fp_UkLWZg9DAJseller_name:product_type_id:@@ -3752,8 +3759,8 @@ paths:preferred_order_routing_strategy:preferred_storefront_access:preferred_guest_checkout:- created_at: '2026-08-18T20:09:51.305Z'- updated_at: '2026-08-18T20:09:51.305Z'+ created_at: '2026-08-20T14:33:15.024Z'+ updated_at: '2026-08-20T14:33:15.024Z'stock_location_ids: []- id: ch_gbHJdmfrXBname: Wholesale@@ -3765,8 +3772,8 @@ paths:preferred_order_routing_strategy:preferred_storefront_access:preferred_guest_checkout:- created_at: '2026-08-18T20:09:56.967Z'- updated_at: '2026-08-18T20:09:56.967Z'+ created_at: '2026-08-20T14:33:18.982Z'+ updated_at: '2026-08-20T14:33:18.982Z'stock_location_ids: []meta:page: 1@@ -3852,8 +3859,8 @@ paths:preferred_order_routing_strategy:preferred_storefront_access:preferred_guest_checkout:- created_at: '2026-08-18T20:09:57.242Z'- updated_at: '2026-08-18T20:09:57.242Z'+ created_at: '2026-08-20T14:33:19.354Z'+ updated_at: '2026-08-20T14:33:19.354Z'stock_location_ids: []requestBody:content:@@ -3952,8 +3959,8 @@ paths:preferred_order_routing_strategy:preferred_storefront_access:preferred_guest_checkout:- created_at: '2026-08-18T20:09:57.258Z'- updated_at: '2026-08-18T20:09:57.258Z'+ created_at: '2026-08-20T14:33:19.520Z'+ updated_at: '2026-08-20T14:33:19.520Z'stock_location_ids: []patch:summary: Update a channel@@ -4008,8 +4015,8 @@ paths:preferred_order_routing_strategy:preferred_storefront_access: login_requiredpreferred_guest_checkout: false- created_at: '2026-08-18T20:09:57.387Z'- updated_at: '2026-08-18T20:09:57.520Z'+ created_at: '2026-08-20T14:33:19.555Z'+ updated_at: '2026-08-20T14:33:19.668Z'stock_location_ids: []requestBody:content:@@ -4292,8 +4299,8 @@ paths:- id: orule_UkLWZg9DAJposition: 1active: true- created_at: '2026-08-18T20:09:51.378Z'- updated_at: '2026-08-18T20:09:51.378Z'+ created_at: '2026-08-20T14:33:15.030Z'+ updated_at: '2026-08-20T14:33:15.030Z'type: preferred_locationchannel_id: ch_UkLWZg9DAJpreferences: {}@@ -4304,8 +4311,8 @@ paths:- id: orule_gbHJdmfrXBposition: 2active: true- created_at: '2026-08-18T20:09:51.382Z'- updated_at: '2026-08-18T20:09:51.382Z'+ created_at: '2026-08-20T14:33:15.034Z'+ updated_at: '2026-08-20T14:33:15.034Z'type: minimize_splitschannel_id: ch_UkLWZg9DAJpreferences: {}@@ -4316,8 +4323,8 @@ paths:- id: orule_EfhxLZ9ck8position: 3active: true- created_at: '2026-08-18T20:09:51.427Z'- updated_at: '2026-08-18T20:09:51.427Z'+ created_at: '2026-08-20T14:33:15.077Z'+ updated_at: '2026-08-20T14:33:15.077Z'type: default_locationchannel_id: ch_UkLWZg9DAJpreferences: {}@@ -4382,8 +4389,8 @@ paths:id: orule_VqXmZF31wYposition: 3active: true- created_at: '2026-08-18T20:10:24.749Z'- updated_at: '2026-08-18T20:10:24.749Z'+ created_at: '2026-08-20T14:33:32.721Z'+ updated_at: '2026-08-20T14:33:32.721Z'type: default_locationchannel_id: ch_UkLWZg9DAJpreferences: {}@@ -4478,8 +4485,8 @@ paths:id: orule_UkLWZg9DAJposition: 2active: false- created_at: '2026-08-18T20:09:51.378Z'- updated_at: '2026-08-18T20:10:24.953Z'+ created_at: '2026-08-20T14:33:15.030Z'+ updated_at: '2026-08-20T14:33:32.856Z'type: preferred_locationchannel_id: ch_UkLWZg9DAJpreferences: {}@@ -4667,8 +4674,8 @@ paths:searchable: falsesortable: falsefilter_key: cf_specs_fabric- created_at: '2026-08-18T20:10:06.425Z'- updated_at: '2026-08-18T20:10:06.425Z'+ created_at: '2026-08-20T14:33:23.898Z'+ updated_at: '2026-08-20T14:33:23.898Z'- id: cfdef_gbHJdmfrXBnamespace: customkey: order_notes@@ -4679,8 +4686,8 @@ paths:searchable: falsesortable: falsefilter_key: cf_custom_order_notes- created_at: '2026-08-18T20:10:06.427Z'- updated_at: '2026-08-18T20:10:06.427Z'+ created_at: '2026-08-20T14:33:23.900Z'+ updated_at: '2026-08-20T14:33:23.900Z'meta:page: 1limit: 25@@ -4749,8 +4756,8 @@ paths:searchable: falsesortable: falsefilter_key: cf_specs_origin- created_at: '2026-08-18T20:10:06.604Z'- updated_at: '2026-08-18T20:10:06.604Z'+ created_at: '2026-08-20T14:33:24.028Z'+ updated_at: '2026-08-20T14:33:24.028Z'requestBody:content:application/json:@@ -4858,8 +4865,8 @@ paths:searchable: falsesortable: falsefilter_key: cf_specs_fabric- created_at: '2026-08-18T20:10:06.611Z'- updated_at: '2026-08-18T20:10:06.611Z'+ created_at: '2026-08-20T14:33:24.047Z'+ updated_at: '2026-08-20T14:33:24.047Z'patch:summary: Update a custom field definitiontags:@@ -4919,8 +4926,8 @@ paths:searchable: falsesortable: falsefilter_key: cf_specs_fabric- created_at: '2026-08-18T20:10:06.757Z'- updated_at: '2026-08-18T20:10:06.791Z'+ created_at: '2026-08-20T14:33:24.088Z'+ updated_at: '2026-08-20T14:33:24.119Z'requestBody:content:application/json:@@ -5066,14 +5073,14 @@ paths:name: VIPsdescription: Top spenderscustomers_count: 0- created_at: '2026-08-18T20:10:06.937Z'- updated_at: '2026-08-18T20:10:06.937Z'+ created_at: '2026-08-20T14:33:24.313Z'+ updated_at: '2026-08-20T14:33:24.313Z'- id: cg_gbHJdmfrXBname: Wholesaledescription:customers_count: 0- created_at: '2026-08-18T20:10:06.939Z'- updated_at: '2026-08-18T20:10:06.939Z'+ created_at: '2026-08-20T14:33:24.314Z'+ updated_at: '2026-08-20T14:33:24.314Z'meta:page: 1limit: 25@@ -5162,8 +5169,8 @@ paths:name: Wholesale 2description: B2B accountscustomers_count: 1- created_at: '2026-08-18T20:10:07.068Z'- updated_at: '2026-08-18T20:10:07.068Z'+ created_at: '2026-08-20T14:33:24.476Z'+ updated_at: '2026-08-20T14:33:24.476Z'schema:"$ref": "#/components/schemas/CustomerGroup"'422':@@ -5272,22 +5279,22 @@ paths:name: VIPsdescription: Top spenderscustomers_count: 1- created_at: '2026-08-18T20:10:07.307Z'- updated_at: '2026-08-18T20:10:07.307Z'+ created_at: '2026-08-20T14:33:24.572Z'+ updated_at: '2026-08-20T14:33:24.572Z'customers:- id: cust_UkLWZg9DAJ- email: [email protected]- first_name: Alona- last_name: Kemmer+ email: [email protected]+ first_name: Tamie+ last_name: Ullrichphone:accepts_email_marketing: false- full_name: Alona Kemmer+ full_name: Tamie Ullrichavailable_store_credit_total: '0'display_available_store_credit_total: "$0.00"failed_attempts: 0metadata: {}- created_at: '2026-08-18T20:10:07.311Z'- updated_at: '2026-08-18T20:10:07.311Z'+ created_at: '2026-08-20T14:33:24.576Z'+ updated_at: '2026-08-20T14:33:24.576Z'tags: []internal_note:internal_note_html:@@ -5367,8 +5374,8 @@ paths:name: VIP customers (Q1)description: Top spenderscustomers_count: 0- created_at: '2026-08-18T20:10:07.605Z'- updated_at: '2026-08-18T20:10:07.628Z'+ created_at: '2026-08-20T14:33:24.706Z'+ updated_at: '2026-08-20T14:33:24.744Z'schema:"$ref": "#/components/schemas/CustomerGroup"'422':@@ -5529,8 +5536,10 @@ paths:state_name: New Yorklabel:metadata: {}- created_at: '2026-08-18T20:10:07.872Z'- updated_at: '2026-08-18T20:10:07.872Z'+ created_at: '2026-08-20T14:33:24.920Z'+ updated_at: '2026-08-20T14:33:24.920Z'+ latitude:+ longitude:customer_id: cust_UkLWZg9DAJmeta:page: 1@@ -5625,8 +5634,10 @@ paths:state_name: New Yorklabel: Officemetadata: {}- created_at: '2026-08-18T20:10:08.168Z'- updated_at: '2026-08-18T20:10:08.168Z'+ created_at: '2026-08-20T14:33:25.118Z'+ updated_at: '2026-08-20T14:33:25.118Z'+ latitude:+ longitude:customer_id: cust_UkLWZg9DAJrequestBody:content:@@ -5742,8 +5753,10 @@ paths:state_name: New Yorklabel:metadata: {}- created_at: '2026-08-18T20:10:08.190Z'- updated_at: '2026-08-18T20:10:08.220Z'+ created_at: '2026-08-20T14:33:25.160Z'+ updated_at: '2026-08-20T14:33:25.210Z'+ latitude:+ longitude:customer_id: cust_UkLWZg9DAJrequestBody:content:@@ -5882,8 +5895,8 @@ paths:customer_id: cust_UkLWZg9DAJpayment_method_id: pm_UkLWZg9DAJmetadata: {}- created_at: '2026-08-18T20:10:08.570Z'- updated_at: '2026-08-18T20:10:08.570Z'+ created_at: '2026-08-20T14:33:25.322Z'+ updated_at: '2026-08-20T14:33:25.322Z'meta:page: 1limit: 25@@ -5973,8 +5986,8 @@ paths:customer_id: cust_UkLWZg9DAJpayment_method_id: pm_UkLWZg9DAJmetadata: {}- created_at: '2026-08-18T20:10:08.774Z'- updated_at: '2026-08-18T20:10:08.774Z'+ created_at: '2026-08-20T14:33:25.381Z'+ updated_at: '2026-08-20T14:33:25.381Z'delete:summary: Delete a customer credit cardtags:@@ -6099,8 +6112,8 @@ paths:currency: USDmemo:metadata: {}- created_at: '2026-08-18T20:10:08.962Z'- updated_at: '2026-08-18T20:10:08.962Z'+ created_at: '2026-08-20T14:33:25.538Z'+ updated_at: '2026-08-20T14:33:25.538Z'customer_id: cust_UkLWZg9DAJcreated_by_id: adm_UkLWZg9DAJmeta:@@ -6176,8 +6189,8 @@ paths:currency: USDmemo: Goodwillmetadata: {}- created_at: '2026-08-18T20:10:09.080Z'- updated_at: '2026-08-18T20:10:09.080Z'+ created_at: '2026-08-20T14:33:25.618Z'+ updated_at: '2026-08-20T14:33:25.618Z'customer_id: cust_UkLWZg9DAJcreated_by_id: adm_gbHJdmfrXBrequestBody:@@ -6266,8 +6279,8 @@ paths:currency: USDmemo: Updatedmetadata: {}- created_at: '2026-08-18T20:10:09.124Z'- updated_at: '2026-08-18T20:10:09.146Z'+ created_at: '2026-08-20T14:33:25.655Z'+ updated_at: '2026-08-20T14:33:25.682Z'customer_id: cust_UkLWZg9DAJcreated_by_id: adm_UkLWZg9DAJrequestBody:@@ -6422,8 +6435,8 @@ paths:display_available_store_credit_total: "$0.00"failed_attempts: 0metadata: {}- created_at: '2026-08-18T20:10:09.215Z'- updated_at: '2026-08-18T20:10:09.215Z'+ created_at: '2026-08-20T14:33:25.805Z'+ updated_at: '2026-08-20T14:33:25.805Z'tags: []internal_note:internal_note_html:@@ -6506,8 +6519,8 @@ paths:display_available_store_credit_total: "$0.00"failed_attempts: 0metadata: {}- created_at: '2026-08-18T20:10:09.445Z'- updated_at: '2026-08-18T20:10:09.445Z'+ created_at: '2026-08-20T14:33:25.870Z'+ updated_at: '2026-08-20T14:33:25.870Z'tags: []internal_note:internal_note_html:@@ -6622,8 +6635,8 @@ paths:display_available_store_credit_total: "$0.00"failed_attempts: 0metadata: {}- created_at: '2026-08-18T20:10:09.470Z'- updated_at: '2026-08-18T20:10:09.470Z'+ created_at: '2026-08-20T14:33:25.884Z'+ updated_at: '2026-08-20T14:33:25.884Z'tags: []internal_note:internal_note_html:@@ -6696,8 +6709,8 @@ paths:display_available_store_credit_total: "$0.00"failed_attempts: 0metadata: {}- created_at: '2026-08-18T20:10:09.790Z'- updated_at: '2026-08-18T20:10:09.886Z'+ created_at: '2026-08-20T14:33:25.944Z'+ updated_at: '2026-08-20T14:33:26.008Z'tags: []internal_note:internal_note_html:@@ -7145,8 +7158,8 @@ paths:- id: exp_UkLWZg9DAJnumber: EF1001format: csv- created_at: '2026-08-18T20:10:12.425Z'- updated_at: '2026-08-18T20:10:12.425Z'+ created_at: '2026-08-20T14:33:27.318Z'+ updated_at: '2026-08-20T14:33:27.318Z'type: productsuser_id: adm_UkLWZg9DAJdone: false@@ -7219,8 +7232,8 @@ paths:id: exp_gbHJdmfrXBnumber: EF1002format: csv- created_at: '2026-08-18T20:10:12.715Z'- updated_at: '2026-08-18T20:10:12.715Z'+ created_at: '2026-08-20T14:33:27.432Z'+ updated_at: '2026-08-20T14:33:27.432Z'type: productsuser_id: adm_UkLWZg9DAJdone: false@@ -7319,8 +7332,8 @@ paths:id: exp_UkLWZg9DAJnumber: EF1001format: csv- created_at: '2026-08-18T20:10:12.745Z'- updated_at: '2026-08-18T20:10:12.745Z'+ created_at: '2026-08-20T14:33:27.518Z'+ updated_at: '2026-08-20T14:33:27.518Z'type: productsuser_id: adm_UkLWZg9DAJdone: false@@ -7536,8 +7549,8 @@ paths:tracking_details:adjustment_total: '0.0'pre_tax_amount: '100.0'- created_at: '2026-08-18T20:10:25.651Z'- updated_at: '2026-08-18T20:10:25.664Z'+ created_at: '2026-08-20T14:33:33.334Z'+ updated_at: '2026-08-20T14:33:33.375Z'order_id: or_UkLWZg9DAJstock_location_id: sloc_UkLWZg9DAJdocuments: []@@ -7630,7 +7643,7 @@ paths:display_tax_total: "$0.00"status: fulfilledfulfillment_type: shipping- fulfilled_at: '2026-08-18T20:10:26.542Z'+ fulfilled_at: '2026-08-20T14:33:33.689Z'tracking_status:estimated_delivery_at:delivered_at:@@ -7642,8 +7655,8 @@ paths:tracking_details:adjustment_total: '0.0'pre_tax_amount: '0.0'- created_at: '2026-08-18T20:10:26.509Z'- updated_at: '2026-08-18T20:10:26.543Z'+ created_at: '2026-08-20T14:33:33.668Z'+ updated_at: '2026-08-20T14:33:33.689Z'order_id: or_UkLWZg9DAJstock_location_id: sloc_UkLWZg9DAJdocuments: []@@ -7818,8 +7831,8 @@ paths:tracking_details:adjustment_total: '0.0'pre_tax_amount: '100.0'- created_at: '2026-08-18T20:10:28.311Z'- updated_at: '2026-08-18T20:10:28.444Z'+ created_at: '2026-08-20T14:33:34.210Z'+ updated_at: '2026-08-20T14:33:34.225Z'order_id: or_UkLWZg9DAJstock_location_id: sloc_UkLWZg9DAJdocuments: []@@ -7916,8 +7929,8 @@ paths:tracking_details:adjustment_total: '0.0'pre_tax_amount: '100.0'- created_at: '2026-08-18T20:10:29.367Z'- updated_at: '2026-08-18T20:10:29.697Z'+ created_at: '2026-08-20T14:33:34.471Z'+ updated_at: '2026-08-20T14:33:34.553Z'order_id: or_UkLWZg9DAJstock_location_id: sloc_UkLWZg9DAJdocuments: []@@ -8016,7 +8029,7 @@ paths:display_tax_total: "$0.00"status: fulfilledfulfillment_type: shipping- fulfilled_at: '2026-08-18T20:10:30.170Z'+ fulfilled_at: '2026-08-20T14:33:34.786Z'tracking_status:estimated_delivery_at:delivered_at:@@ -8028,8 +8041,8 @@ paths:tracking_details:adjustment_total: '0.0'pre_tax_amount: '100.0'- created_at: '2026-08-18T20:10:29.856Z'- updated_at: '2026-08-18T20:10:30.171Z'+ created_at: '2026-08-20T14:33:34.654Z'+ updated_at: '2026-08-20T14:33:34.787Z'order_id: or_UkLWZg9DAJstock_location_id: sloc_UkLWZg9DAJdocuments: []@@ -8132,8 +8145,8 @@ paths:tracking_details:adjustment_total: '0.0'pre_tax_amount: '100.0'- created_at: '2026-08-18T20:10:30.490Z'- updated_at: '2026-08-18T20:10:30.642Z'+ created_at: '2026-08-20T14:33:34.946Z'+ updated_at: '2026-08-20T14:33:35.076Z'order_id: or_UkLWZg9DAJstock_location_id: sloc_UkLWZg9DAJdocuments:@@ -8232,10 +8245,10 @@ paths:display_tax_total: "$0.00"status: deliveredfulfillment_type: shipping- fulfilled_at: '2026-08-18T20:10:31.523Z'+ fulfilled_at: '2026-08-20T14:33:35.541Z'tracking_status:estimated_delivery_at:- delivered_at: '2026-08-18T20:10:31.571Z'+ delivered_at: '2026-08-20T14:33:35.569Z'items:- item_id: li_UkLWZg9DAJvariant_id: variant_UkLWZg9DAJ@@ -8244,8 +8257,8 @@ paths:tracking_details:adjustment_total: '0.0'pre_tax_amount: '100.0'- created_at: '2026-08-18T20:10:31.306Z'- updated_at: '2026-08-18T20:10:31.572Z'+ created_at: '2026-08-20T14:33:35.463Z'+ updated_at: '2026-08-20T14:33:35.572Z'order_id: or_UkLWZg9DAJstock_location_id: sloc_UkLWZg9DAJdocuments: []@@ -8364,8 +8377,8 @@ paths:tracking_details:adjustment_total: '0.0'pre_tax_amount: '100.0'- created_at: '2026-08-18T20:10:32.357Z'- updated_at: '2026-08-18T20:10:32.670Z'+ created_at: '2026-08-20T14:33:35.922Z'+ updated_at: '2026-08-20T14:33:36.035Z'order_id: or_UkLWZg9DAJstock_location_id: sloc_UkLWZg9DAJdocuments: []@@ -8462,8 +8475,8 @@ paths:tracking_details:adjustment_total: '0.0'pre_tax_amount: '100.0'- created_at: '2026-08-18T20:10:32.820Z'- updated_at: '2026-08-18T20:10:33.081Z'+ created_at: '2026-08-20T14:33:36.168Z'+ updated_at: '2026-08-20T14:33:36.520Z'order_id: or_UkLWZg9DAJstock_location_id: sloc_UkLWZg9DAJdocuments: []@@ -8571,8 +8584,8 @@ paths:tracking_details:adjustment_total: '0.0'pre_tax_amount: '0.0'- created_at: '2026-08-18T20:10:33.762Z'- updated_at: '2026-08-18T20:10:34.047Z'+ created_at: '2026-08-20T14:33:36.876Z'+ updated_at: '2026-08-20T14:33:36.938Z'order_id: or_UkLWZg9DAJstock_location_id: sloc_gbHJdmfrXBdocuments: []@@ -8673,8 +8686,8 @@ paths:codes_count: 2currency: USDprefix: WELCOME- created_at: '2026-08-18T20:10:13.098Z'- updated_at: '2026-08-18T20:10:13.098Z'+ created_at: '2026-08-20T14:33:27.838Z'+ updated_at: '2026-08-20T14:33:27.838Z'amount: '50.0'expires_at:created_by_id:@@ -8758,8 +8771,8 @@ paths:codes_count: 5currency: USDprefix: NEWCAMP- created_at: '2026-08-18T20:10:13.479Z'- updated_at: '2026-08-18T20:10:13.479Z'+ created_at: '2026-08-20T14:33:27.927Z'+ updated_at: '2026-08-20T14:33:27.927Z'amount: '25.0'expires_at: '2030-12-31'created_by_id: adm_UkLWZg9DAJ@@ -8863,8 +8876,8 @@ paths:codes_count: 2currency: USDprefix: WELCOME- created_at: '2026-08-18T20:10:13.687Z'- updated_at: '2026-08-18T20:10:13.687Z'+ created_at: '2026-08-20T14:33:28.004Z'+ updated_at: '2026-08-20T14:33:28.004Z'amount: '50.0'expires_at:created_by_id:@@ -8970,7 +8983,7 @@ paths:example:data:- id: gc_UkLWZg9DAJ- code: 9F9FCA2AED842104+ code: FEADD79F6388F8A8status: activecurrency: USDamount: '50.0'@@ -8984,12 +8997,12 @@ paths:redeemed_at:expired: falseactive: true- created_at: '2026-08-18T20:10:13.773Z'- updated_at: '2026-08-18T20:10:13.773Z'+ created_at: '2026-08-20T14:33:28.099Z'+ updated_at: '2026-08-20T14:33:28.099Z'customer_id:created_by_id:- id: gc_gbHJdmfrXB- code: F1D53201D0E3FC57+ code: A24315338B4CB100status: activecurrency: USDamount: '25.0'@@ -9003,8 +9016,8 @@ paths:redeemed_at:expired: falseactive: true- created_at: '2026-08-18T20:10:13.774Z'- updated_at: '2026-08-18T20:10:13.774Z'+ created_at: '2026-08-20T14:33:28.101Z'+ updated_at: '2026-08-20T14:33:28.101Z'customer_id:created_by_id:meta:@@ -9092,7 +9105,7 @@ paths:application/json:example:id: gc_EfhxLZ9ck8- code: 2DD7E4921BDA5D9F+ code: D8C75C0A997A3EA3status: activecurrency: USDamount: '25.0'@@ -9106,8 +9119,8 @@ paths:redeemed_at:expired: falseactive: true- created_at: '2026-08-18T20:10:14.204Z'- updated_at: '2026-08-18T20:10:14.204Z'+ created_at: '2026-08-20T14:33:28.181Z'+ updated_at: '2026-08-20T14:33:28.181Z'customer_id:created_by_id: adm_UkLWZg9DAJschema:@@ -9216,7 +9229,7 @@ paths:application/json:example:id: gc_UkLWZg9DAJ- code: 3B41699F6BE5F95E+ code: 4127736119AA7049status: activecurrency: USDamount: '50.0'@@ -9230,8 +9243,8 @@ paths:redeemed_at:expired: falseactive: true- created_at: '2026-08-18T20:10:14.329Z'- updated_at: '2026-08-18T20:10:14.329Z'+ created_at: '2026-08-20T14:33:28.226Z'+ updated_at: '2026-08-20T14:33:28.226Z'customer_id:created_by_id:schema:@@ -9294,7 +9307,7 @@ paths:application/json:example:id: gc_UkLWZg9DAJ- code: 222A3C4116238B69+ code: 655CA2714ED51640status: activecurrency: USDamount: '75.0'@@ -9308,8 +9321,8 @@ paths:redeemed_at:expired: falseactive: true- created_at: '2026-08-18T20:10:14.728Z'- updated_at: '2026-08-18T20:10:14.777Z'+ created_at: '2026-08-20T14:33:28.375Z'+ updated_at: '2026-08-20T14:33:28.406Z'customer_id:created_by_id:schema:@@ -9414,8 +9427,8 @@ paths:- id: imp_UkLWZg9DAJnumber: IM1001rows_count: 0- created_at: '2026-08-18T20:10:15.348Z'- updated_at: '2026-08-18T20:10:15.363Z'+ created_at: '2026-08-20T14:33:28.521Z'+ updated_at: '2026-08-20T14:33:28.534Z'type: productsstatus: pendingowner_type: store@@ -9602,8 +9615,8 @@ paths:id: imp_gbHJdmfrXBnumber: IM1002rows_count: 0- created_at: '2026-08-18T20:10:15.585Z'- updated_at: '2026-08-18T20:10:15.751Z'+ created_at: '2026-08-20T14:33:28.617Z'+ updated_at: '2026-08-20T14:33:28.744Z'type: productsstatus: mappingowner_type: store@@ -10061,8 +10074,8 @@ paths:id: imp_UkLWZg9DAJnumber: IM1001rows_count: 0- created_at: '2026-08-18T20:10:16.356Z'- updated_at: '2026-08-18T20:10:16.379Z'+ created_at: '2026-08-20T14:33:28.997Z'+ updated_at: '2026-08-20T14:33:29.008Z'type: productsstatus: pendingowner_type: store@@ -10307,8 +10320,8 @@ paths:id: imp_gbHJdmfrXBnumber: IM1002rows_count: 0- created_at: '2026-08-18T20:10:16.856Z'- updated_at: '2026-08-18T20:10:16.932Z'+ created_at: '2026-08-20T14:33:29.170Z'+ updated_at: '2026-08-20T14:33:29.275Z'type: productsstatus: completed_mappingowner_type: store@@ -10664,8 +10677,8 @@ paths:id: imp_gbHJdmfrXBnumber: IM1002rows_count: 1- created_at: '2026-08-18T20:10:17.116Z'- updated_at: '2026-08-18T20:10:17.140Z'+ created_at: '2026-08-20T14:33:29.328Z'+ updated_at: '2026-08-20T14:33:29.354Z'type: productsstatus: processingowner_type: store@@ -10847,8 +10860,8 @@ paths:row_number: 2status: failedvalidation_errors: boom- created_at: '2026-08-18T20:10:17.178Z'- updated_at: '2026-08-18T20:10:17.178Z'+ created_at: '2026-08-20T14:33:29.389Z'+ updated_at: '2026-08-20T14:33:29.389Z'import_id: imp_UkLWZg9DAJitem_type:item_id:@@ -10951,8 +10964,8 @@ paths:supported_locales:- entax_provider:- created_at: '2026-08-18T20:09:51.299Z'- updated_at: '2026-08-18T20:09:51.299Z'+ created_at: '2026-08-20T14:33:15.013Z'+ updated_at: '2026-08-20T14:33:15.013Z'- id: mkt_gbHJdmfrXBname: EUcurrency: USD@@ -10964,8 +10977,8 @@ paths:supported_locales:- entax_provider:- created_at: '2026-08-18T20:10:18.381Z'- updated_at: '2026-08-18T20:10:18.381Z'+ created_at: '2026-08-20T14:33:29.810Z'+ updated_at: '2026-08-20T14:33:29.810Z'meta:page: 1limit: 25@@ -11059,8 +11072,8 @@ paths:- en- frtax_provider:- created_at: '2026-08-18T20:10:18.579Z'- updated_at: '2026-08-18T20:10:18.579Z'+ created_at: '2026-08-20T14:33:29.927Z'+ updated_at: '2026-08-20T14:33:29.927Z'schema:"$ref": "#/components/schemas/Market"'422':@@ -11197,8 +11210,8 @@ paths:supported_locales:- entax_provider:- created_at: '2026-08-18T20:10:18.745Z'- updated_at: '2026-08-18T20:10:18.745Z'+ created_at: '2026-08-20T14:33:30.004Z'+ updated_at: '2026-08-20T14:33:30.004Z'schema:"$ref": "#/components/schemas/Market"'404':@@ -11278,8 +11291,8 @@ paths:supported_locales:- entax_provider:- created_at: '2026-08-18T20:10:19.174Z'- updated_at: '2026-08-18T20:10:19.266Z'+ created_at: '2026-08-20T14:33:30.129Z'+ updated_at: '2026-08-20T14:33:30.162Z'schema:"$ref": "#/components/schemas/Market"'422':@@ -11459,8 +11472,8 @@ paths:kind: dropdownmetadata: {}filterable: true- created_at: '2026-08-18T20:10:20.069Z'- updated_at: '2026-08-18T20:10:20.069Z'+ created_at: '2026-08-20T14:33:30.477Z'+ updated_at: '2026-08-20T14:33:30.477Z'meta:page: 1limit: 25@@ -11554,8 +11567,8 @@ paths:kind: dropdownmetadata: {}filterable: true- created_at: '2026-08-18T20:10:20.361Z'- updated_at: '2026-08-18T20:10:20.361Z'+ created_at: '2026-08-20T14:33:30.571Z'+ updated_at: '2026-08-20T14:33:30.571Z'schema:"$ref": "#/components/schemas/OptionType"'422':@@ -11679,8 +11692,8 @@ paths:kind: dropdownmetadata: {}filterable: true- created_at: '2026-08-18T20:10:20.489Z'- updated_at: '2026-08-18T20:10:20.489Z'+ created_at: '2026-08-20T14:33:30.612Z'+ updated_at: '2026-08-20T14:33:30.612Z'schema:"$ref": "#/components/schemas/OptionType"'404':@@ -11753,8 +11766,8 @@ paths:kind: dropdownmetadata: {}filterable: true- created_at: '2026-08-18T20:10:20.707Z'- updated_at: '2026-08-18T20:10:20.795Z'+ created_at: '2026-08-20T14:33:30.671Z'+ updated_at: '2026-08-20T14:33:30.694Z'schema:"$ref": "#/components/schemas/OptionType"'422':@@ -11918,8 +11931,8 @@ paths:country_code:state_code:data: {}- created_at: '2026-08-18T20:10:21.791Z'- updated_at: '2026-08-18T20:10:21.791Z'+ created_at: '2026-08-20T14:33:31.049Z'+ updated_at: '2026-08-20T14:33:31.049Z'meta:page: 1limit: 25@@ -11993,8 +12006,8 @@ paths:amount: "-2.0"display_amount: "-$2.00"metadata: {}- created_at: '2026-08-18T20:10:22.198Z'- updated_at: '2026-08-18T20:10:22.198Z'+ created_at: '2026-08-20T14:33:31.439Z'+ updated_at: '2026-08-20T14:33:31.439Z'meta:page: 1limit: 25@@ -12074,8 +12087,8 @@ paths:amount: "-3.0"display_amount: "-$3.00"metadata: {}- created_at: '2026-08-18T20:10:22.431Z'- updated_at: '2026-08-18T20:10:22.431Z'+ created_at: '2026-08-20T14:33:31.826Z'+ updated_at: '2026-08-20T14:33:31.826Z''422':description: invalid discountcontent:@@ -12172,8 +12185,8 @@ paths:amount: '4.0'display_amount: "$4.00"metadata: {}- created_at: '2026-08-18T20:10:24.170Z'- updated_at: '2026-08-18T20:10:24.170Z'+ created_at: '2026-08-20T14:33:32.199Z'+ updated_at: '2026-08-20T14:33:32.199Z''422':description: invalid feecontent:@@ -12271,7 +12284,7 @@ paths:application/json:example:id: gc_UkLWZg9DAJ- code: 80F5B09E8B3234B9+ code: 8F054E56AF4B2A0Bstatus: activecurrency: USDamount: '10.0'@@ -12285,8 +12298,8 @@ paths:redeemed_at:expired: falseactive: true- created_at: '2026-08-18T20:10:34.400Z'- updated_at: '2026-08-18T20:10:34.518Z'+ created_at: '2026-08-20T14:33:37.161Z'+ updated_at: '2026-08-20T14:33:37.218Z'customer_id:created_by_id:requestBody:@@ -12428,8 +12441,8 @@ paths:preorder_ships_at:quantity: 2currency: USD- name: Product 358283- slug: product-358283+ name: Product 351180+ slug: product-351180options_text: 'Size: S'price: '10.0'display_price: "$10.00"@@ -12461,12 +12474,12 @@ paths:option_type_label: Sizeimage_url:metadata: {}- created_at: '2026-08-18T20:10:35.395Z'- updated_at: '2026-08-18T20:10:35.395Z'+ created_at: '2026-08-20T14:33:37.615Z'+ updated_at: '2026-08-20T14:33:37.615Z'digital_links: []metadata: {}- created_at: '2026-08-18T20:10:35.429Z'- updated_at: '2026-08-18T20:10:35.429Z'+ created_at: '2026-08-20T14:33:37.652Z'+ updated_at: '2026-08-20T14:33:37.652Z'cost_price: '17.0'tax_category_id: taxcat_UkLWZg9DAJmeta:@@ -12539,8 +12552,8 @@ paths:preorder_ships_at:quantity: 3currency: USD- name: Product 375845- slug: product-375845+ name: Product 373451+ slug: product-373451options_text: 'Size: S'price: '19.99'display_price: "$19.99"@@ -12572,12 +12585,12 @@ paths:option_type_label: Sizeimage_url:metadata: {}- created_at: '2026-08-18T20:10:35.783Z'- updated_at: '2026-08-18T20:10:35.783Z'+ created_at: '2026-08-20T14:33:37.896Z'+ updated_at: '2026-08-20T14:33:37.896Z'digital_links: []metadata: {}- created_at: '2026-08-18T20:10:36.035Z'- updated_at: '2026-08-18T20:10:36.035Z'+ created_at: '2026-08-20T14:33:37.924Z'+ updated_at: '2026-08-20T14:33:37.924Z'cost_price: '17.0'tax_category_id: taxcat_UkLWZg9DAJrequestBody:@@ -12672,8 +12685,8 @@ paths:preorder_ships_at:quantity: 2currency: USD- name: Product 38691- slug: product-38691+ name: Product 382838+ slug: product-382838options_text: 'Size: S'price: '10.0'display_price: "$10.00"@@ -12705,12 +12718,12 @@ paths:option_type_label: Sizeimage_url:metadata: {}- created_at: '2026-08-18T20:10:36.384Z'- updated_at: '2026-08-18T20:10:36.384Z'+ created_at: '2026-08-20T14:33:38.050Z'+ updated_at: '2026-08-20T14:33:38.050Z'digital_links: []metadata: {}- created_at: '2026-08-18T20:10:36.619Z'- updated_at: '2026-08-18T20:10:36.619Z'+ created_at: '2026-08-20T14:33:38.090Z'+ updated_at: '2026-08-20T14:33:38.090Z'cost_price: '17.0'tax_category_id: taxcat_UkLWZg9DAJpatch:@@ -12778,8 +12791,8 @@ paths:preorder_ships_at:quantity: 5currency: USD- name: Product 392411- slug: product-392411+ name: Product 394622+ slug: product-394622options_text: 'Size: S'price: '19.99'display_price: "$19.99"@@ -12811,12 +12824,12 @@ paths:option_type_label: Sizeimage_url:metadata: {}- created_at: '2026-08-18T20:10:36.778Z'- updated_at: '2026-08-18T20:10:36.778Z'+ created_at: '2026-08-20T14:33:38.193Z'+ updated_at: '2026-08-20T14:33:38.193Z'digital_links: []metadata: {}- created_at: '2026-08-18T20:10:36.820Z'- updated_at: '2026-08-18T20:10:36.974Z'+ created_at: '2026-08-20T14:33:38.228Z'+ updated_at: '2026-08-20T14:33:38.277Z'cost_price: '17.0'tax_category_id: taxcat_UkLWZg9DAJrequestBody:@@ -12938,7 +12951,7 @@ paths:cart_id:channel_id: ch_UkLWZg9DAJnumber: R1001- email: [email protected]+ email: [email protected]customer_note:currency: USDlocale: en@@ -12985,8 +12998,8 @@ paths:supported_locales:- entax_provider:- created_at: '2026-08-18T20:09:51.299Z'- updated_at: '2026-08-18T20:09:51.299Z'+ created_at: '2026-08-20T14:33:15.013Z'+ updated_at: '2026-08-20T14:33:15.013Z'status: draftlast_ip_address:considered_risky: false@@ -12997,8 +13010,8 @@ paths:metadata: {}canceled_at:approved_at:- created_at: '2026-08-18T20:10:41.571Z'- updated_at: '2026-08-18T20:10:41.769Z'+ created_at: '2026-08-20T14:33:42.369Z'+ updated_at: '2026-08-20T14:33:42.525Z'preferred_stock_location_id:company_location_id:company_id:@@ -13180,7 +13193,7 @@ paths:cart_id:channel_id: ch_UkLWZg9DAJnumber: R1001- email: [email protected]+ email: [email protected]customer_note:currency: USDlocale: en@@ -13227,8 +13240,8 @@ paths:supported_locales:- entax_provider:- created_at: '2026-08-18T20:09:51.299Z'- updated_at: '2026-08-18T20:09:51.299Z'+ created_at: '2026-08-20T14:33:15.013Z'+ updated_at: '2026-08-20T14:33:15.013Z'status: draftlast_ip_address:considered_risky: false@@ -13239,8 +13252,8 @@ paths:metadata: {}canceled_at:approved_at:- created_at: '2026-08-18T20:10:42.197Z'- updated_at: '2026-08-18T20:10:42.197Z'+ created_at: '2026-08-20T14:33:43.087Z'+ updated_at: '2026-08-20T14:33:43.087Z'preferred_stock_location_id:company_location_id:company_id:@@ -13446,8 +13459,8 @@ paths:supported_locales:- entax_provider:- created_at: '2026-08-18T20:09:51.299Z'- updated_at: '2026-08-18T20:09:51.299Z'+ created_at: '2026-08-20T14:33:15.013Z'+ updated_at: '2026-08-20T14:33:15.013Z'status: draftlast_ip_address:considered_risky: false@@ -13458,8 +13471,8 @@ paths:metadata: {}canceled_at:approved_at:- created_at: '2026-08-18T20:10:42.546Z'- updated_at: '2026-08-18T20:10:42.561Z'+ created_at: '2026-08-20T14:33:43.756Z'+ updated_at: '2026-08-20T14:33:43.767Z'preferred_stock_location_id: sloc_UkLWZg9DAJcompany_location_id:company_id:@@ -13651,7 +13664,7 @@ paths:cart_id:channel_id: ch_UkLWZg9DAJnumber: R1001- email: [email protected]+ email: [email protected]customer_note:currency: USDlocale: en@@ -13698,8 +13711,8 @@ paths:supported_locales:- entax_provider:- created_at: '2026-08-18T20:09:51.299Z'- updated_at: '2026-08-18T20:09:51.299Z'+ created_at: '2026-08-20T14:33:15.013Z'+ updated_at: '2026-08-20T14:33:15.013Z'status: draftlast_ip_address:considered_risky: false@@ -13710,8 +13723,8 @@ paths:metadata: {}canceled_at:approved_at:- created_at: '2026-08-18T20:10:42.594Z'- updated_at: '2026-08-18T20:10:42.594Z'+ created_at: '2026-08-20T14:33:43.822Z'+ updated_at: '2026-08-20T14:33:43.822Z'preferred_stock_location_id:company_location_id:company_id:@@ -13838,8 +13851,8 @@ paths:supported_locales:- entax_provider:- created_at: '2026-08-18T20:09:51.299Z'- updated_at: '2026-08-18T20:09:51.299Z'+ created_at: '2026-08-20T14:33:15.013Z'+ updated_at: '2026-08-20T14:33:15.013Z'status: draftlast_ip_address:considered_risky: false@@ -13850,8 +13863,8 @@ paths:metadata: {}canceled_at:approved_at:- created_at: '2026-08-18T20:10:42.836Z'- updated_at: '2026-08-18T20:10:42.953Z'+ created_at: '2026-08-20T14:33:44.062Z'+ updated_at: '2026-08-20T14:33:44.180Z'preferred_stock_location_id:company_location_id:company_id:@@ -14043,7 +14056,7 @@ paths:cart_id:channel_id: ch_UkLWZg9DAJnumber: R1001- email: [email protected]+ email: [email protected]customer_note:currency: USDlocale: en@@ -14051,7 +14064,7 @@ paths:coupon_code:fulfillment_status: unfulfilledpayment_status: paid- completed_at: '2026-08-18T20:10:43.481Z'+ completed_at: '2026-08-20T14:33:44.654Z'item_total: '10.0'display_item_total: "$10.00"adjustment_total: '0.0'@@ -14090,8 +14103,8 @@ paths:supported_locales:- entax_provider:- created_at: '2026-08-18T20:09:51.299Z'- updated_at: '2026-08-18T20:09:51.299Z'+ created_at: '2026-08-20T14:33:15.013Z'+ updated_at: '2026-08-20T14:33:15.013Z'status: placedlast_ip_address:considered_risky: false@@ -14102,8 +14115,8 @@ paths:metadata: {}canceled_at:approved_at:- created_at: '2026-08-18T20:10:43.380Z'- updated_at: '2026-08-18T20:10:43.585Z'+ created_at: '2026-08-20T14:33:44.519Z'+ updated_at: '2026-08-20T14:33:44.681Z'preferred_stock_location_id:company_location_id:company_id:@@ -14195,7 +14208,7 @@ paths:cart_id:channel_id: ch_UkLWZg9DAJnumber: R1001- email: [email protected]+ email: [email protected]customer_note:currency: USDlocale: en@@ -14203,7 +14216,7 @@ paths:coupon_code:fulfillment_status: canceledpayment_status: none- completed_at: '2026-08-18T20:10:44.769Z'+ completed_at: '2026-08-20T14:33:45.332Z'item_total: '10.0'display_item_total: "$10.00"adjustment_total: '0.0'@@ -14242,8 +14255,8 @@ paths:supported_locales:- entax_provider:- created_at: '2026-08-18T20:09:51.299Z'- updated_at: '2026-08-18T20:09:51.299Z'+ created_at: '2026-08-20T14:33:15.013Z'+ updated_at: '2026-08-20T14:33:15.013Z'status: canceledlast_ip_address:considered_risky: false@@ -14252,10 +14265,10 @@ paths:payment_total: '0.0'display_payment_total: "$0.00"metadata: {}- canceled_at: '2026-08-18T20:10:44.849Z'+ canceled_at: '2026-08-20T14:33:45.445Z'approved_at:- created_at: '2026-08-18T20:10:44.312Z'- updated_at: '2026-08-18T20:10:44.902Z'+ created_at: '2026-08-20T14:33:45.162Z'+ updated_at: '2026-08-20T14:33:45.491Z'preferred_stock_location_id:company_location_id:company_id:@@ -14331,7 +14344,7 @@ paths:cart_id:channel_id: ch_UkLWZg9DAJnumber: R1001- email: [email protected]+ email: [email protected]customer_note:currency: USDlocale: en@@ -14339,7 +14352,7 @@ paths:coupon_code:fulfillment_status:payment_status:- completed_at: '2026-08-18T20:10:45.218Z'+ completed_at: '2026-08-20T14:33:45.838Z'item_total: '10.0'display_item_total: "$10.00"adjustment_total: '0.0'@@ -14378,8 +14391,8 @@ paths:supported_locales:- entax_provider:- created_at: '2026-08-18T20:09:51.299Z'- updated_at: '2026-08-18T20:09:51.299Z'+ created_at: '2026-08-20T14:33:15.013Z'+ updated_at: '2026-08-20T14:33:15.013Z'status: placedlast_ip_address:considered_risky: false@@ -14389,9 +14402,9 @@ paths:display_payment_total: "$0.00"metadata: {}canceled_at:- approved_at: '2026-08-18T20:10:45.483Z'- created_at: '2026-08-18T20:10:44.962Z'- updated_at: '2026-08-18T20:10:45.217Z'+ approved_at: '2026-08-20T14:33:45.958Z'+ created_at: '2026-08-20T14:33:45.666Z'+ updated_at: '2026-08-20T14:33:45.838Z'preferred_stock_location_id:company_location_id:company_id:@@ -14458,7 +14471,7 @@ paths:cart_id:channel_id: ch_UkLWZg9DAJnumber: R1001- email: [email protected]+ email: [email protected]customer_note:currency: USDlocale: en@@ -14466,7 +14479,7 @@ paths:coupon_code:fulfillment_status: unfulfilledpayment_status: none- completed_at: '2026-08-18T20:10:45.777Z'+ completed_at: '2026-08-20T14:33:46.272Z'item_total: '10.0'display_item_total: "$10.00"adjustment_total: '0.0'@@ -14505,8 +14518,8 @@ paths:supported_locales:- entax_provider:- created_at: '2026-08-18T20:09:51.299Z'- updated_at: '2026-08-18T20:09:51.299Z'+ created_at: '2026-08-20T14:33:15.013Z'+ updated_at: '2026-08-20T14:33:15.013Z'status: placedlast_ip_address:considered_risky: false@@ -14515,10 +14528,10 @@ paths:payment_total: '0.0'display_payment_total: "$0.00"metadata: {}- canceled_at: '2026-08-18T20:10:45.963Z'+ canceled_at: '2026-08-20T14:33:46.361Z'approved_at:- created_at: '2026-08-18T20:10:45.670Z'- updated_at: '2026-08-18T20:10:46.083Z'+ created_at: '2026-08-20T14:33:46.073Z'+ updated_at: '2026-08-20T14:33:46.449Z'preferred_stock_location_id:company_location_id:company_id:@@ -14585,7 +14598,7 @@ paths:cart_id:channel_id: ch_UkLWZg9DAJnumber: R1001- email: [email protected]+ email: [email protected]customer_note:currency: USDlocale: en@@ -14593,7 +14606,7 @@ paths:coupon_code:fulfillment_status:payment_status:- completed_at: '2026-08-18T20:10:46.257Z'+ completed_at: '2026-08-20T14:33:46.696Z'item_total: '10.0'display_item_total: "$10.00"adjustment_total: '0.0'@@ -14632,8 +14645,8 @@ paths:supported_locales:- entax_provider:- created_at: '2026-08-18T20:09:51.299Z'- updated_at: '2026-08-18T20:09:51.299Z'+ created_at: '2026-08-20T14:33:15.013Z'+ updated_at: '2026-08-20T14:33:15.013Z'status: placedlast_ip_address:considered_risky: false@@ -14644,8 +14657,8 @@ paths:metadata: {}canceled_at:approved_at:- created_at: '2026-08-18T20:10:46.142Z'- updated_at: '2026-08-18T20:10:46.256Z'+ created_at: '2026-08-20T14:33:46.539Z'+ updated_at: '2026-08-20T14:33:46.694Z'preferred_stock_location_id:company_location_id:company_id:@@ -14728,8 +14741,8 @@ paths:resolved_capture_method: checkoutstorefront_visible: trueposition: 1- created_at: '2026-08-18T20:10:46.489Z'- updated_at: '2026-08-18T20:10:46.489Z'+ created_at: '2026-08-20T14:33:46.960Z'+ updated_at: '2026-08-20T14:33:46.960Z'preferences: {}preference_schema: []meta:@@ -14877,8 +14890,8 @@ paths:resolved_capture_method: checkoutstorefront_visible: trueposition: 1- created_at: '2026-08-18T20:10:46.552Z'- updated_at: '2026-08-18T20:10:46.552Z'+ created_at: '2026-08-20T14:33:47.108Z'+ updated_at: '2026-08-20T14:33:47.108Z'preferences: {}preference_schema: []"/api/v3/admin/orders/{order_id}/payments":@@ -14949,11 +14962,11 @@ paths:data:- id: py_UkLWZg9DAJpayment_method_id: pm_UkLWZg9DAJ- response_code: BGS-f7c488f5ef89+ response_code: BGS-c009d4f45dd6number: R1001-P1+ status: completedamount: '110.0'display_amount: "$110.00"- status: completedsource_type: credit_cardsource_id: card_UkLWZg9DAJsource:@@ -14968,14 +14981,14 @@ paths:customer_id:payment_method_id: pm_gbHJdmfrXBmetadata: {}- created_at: '2026-08-18T20:10:38.083Z'- updated_at: '2026-08-18T20:10:38.083Z'+ created_at: '2026-08-20T14:33:39.337Z'+ updated_at: '2026-08-20T14:33:39.337Z'metadata: {}avs_response:cvv_response_code:cvv_response_message:- created_at: '2026-08-18T20:10:38.151Z'- updated_at: '2026-08-18T20:10:38.151Z'+ created_at: '2026-08-20T14:33:39.339Z'+ updated_at: '2026-08-20T14:33:39.339Z'captured_amount: '0.0'order_id: or_UkLWZg9DAJmeta:@@ -15046,9 +15059,9 @@ paths:payment_method_id: pm_EfhxLZ9ck8response_code:number: R1002-P1+ status: checkoutamount: '110.0'display_amount: "$110.00"- status: checkoutsource_type:source_id:source:@@ -15056,8 +15069,8 @@ paths:avs_response:cvv_response_code:cvv_response_message:- created_at: '2026-08-18T20:10:39.036Z'- updated_at: '2026-08-18T20:10:39.036Z'+ created_at: '2026-08-20T14:33:39.983Z'+ updated_at: '2026-08-20T14:33:39.983Z'captured_amount: '0.0'order_id: or_gbHJdmfrXBrequestBody:@@ -15150,11 +15163,11 @@ paths:example:id: py_UkLWZg9DAJpayment_method_id: pm_UkLWZg9DAJ- response_code: BGS-879d66a7f1fd+ response_code: BGS-3792cf31dd59number: R1001-P1+ status: completedamount: '110.0'display_amount: "$110.00"- status: completedsource_type: credit_cardsource_id: card_UkLWZg9DAJsource:@@ -15169,14 +15182,14 @@ paths:customer_id:payment_method_id: pm_gbHJdmfrXBmetadata: {}- created_at: '2026-08-18T20:10:39.364Z'- updated_at: '2026-08-18T20:10:39.364Z'+ created_at: '2026-08-20T14:33:40.254Z'+ updated_at: '2026-08-20T14:33:40.254Z'metadata: {}avs_response:cvv_response_code:cvv_response_message:- created_at: '2026-08-18T20:10:39.365Z'- updated_at: '2026-08-18T20:10:39.365Z'+ created_at: '2026-08-20T14:33:40.256Z'+ updated_at: '2026-08-20T14:33:40.256Z'captured_amount: '0.0'order_id: or_UkLWZg9DAJ"/api/v3/admin/orders/{order_id}/payments/{id}/capture":@@ -15239,11 +15252,11 @@ paths:example:id: py_UkLWZg9DAJpayment_method_id: pm_UkLWZg9DAJ- response_code: BGS-ee44bb0528f1+ response_code: BGS-f1b0a8210e13number: R1001-P1+ status: completedamount: '110.0'display_amount: "$110.00"- status: completedsource_type: credit_cardsource_id: card_UkLWZg9DAJsource:@@ -15258,14 +15271,14 @@ paths:customer_id:payment_method_id: pm_gbHJdmfrXBmetadata: {}- created_at: '2026-08-18T20:10:39.778Z'- updated_at: '2026-08-18T20:10:39.778Z'+ created_at: '2026-08-20T14:33:40.685Z'+ updated_at: '2026-08-20T14:33:40.685Z'metadata: {}avs_response:cvv_response_code:cvv_response_message:- created_at: '2026-08-18T20:10:39.780Z'- updated_at: '2026-08-18T20:10:39.884Z'+ created_at: '2026-08-20T14:33:40.686Z'+ updated_at: '2026-08-20T14:33:40.726Z'captured_amount: '110.0'order_id: or_UkLWZg9DAJ'422':@@ -15337,11 +15350,11 @@ paths:example:id: py_UkLWZg9DAJpayment_method_id: pm_UkLWZg9DAJ- response_code: void-BGS-cb1e49da0713+ response_code: void-BGS-909e9a843f32number: R1001-P1+ status: voidamount: '110.0'display_amount: "$110.00"- status: voidsource_type: credit_cardsource_id: card_UkLWZg9DAJsource:@@ -15356,14 +15369,14 @@ paths:customer_id:payment_method_id: pm_gbHJdmfrXBmetadata: {}- created_at: '2026-08-18T20:10:40.539Z'- updated_at: '2026-08-18T20:10:40.539Z'+ created_at: '2026-08-20T14:33:41.411Z'+ updated_at: '2026-08-20T14:33:41.411Z'metadata: {}avs_response:cvv_response_code:cvv_response_message:- created_at: '2026-08-18T20:10:40.541Z'- updated_at: '2026-08-18T20:10:40.660Z'+ created_at: '2026-08-20T14:33:41.413Z'+ updated_at: '2026-08-20T14:33:41.413Z'captured_amount: '0.0'order_id: or_UkLWZg9DAJ"/api/v3/admin/price_lists":@@ -15451,8 +15464,8 @@ paths:starts_at:ends_at:deleted_at:- created_at: '2026-08-18T20:10:46.625Z'- updated_at: '2026-08-18T20:10:46.625Z'+ created_at: '2026-08-20T14:33:47.291Z'+ updated_at: '2026-08-20T14:33:47.291Z'currently_active: falseproducts_count: 0prices_count: 0@@ -15466,8 +15479,8 @@ paths:starts_at:ends_at:deleted_at:- created_at: '2026-08-18T20:10:46.627Z'- updated_at: '2026-08-18T20:10:46.627Z'+ created_at: '2026-08-20T14:33:47.293Z'+ updated_at: '2026-08-20T14:33:47.293Z'currently_active: falseproducts_count: 0prices_count: 0@@ -15581,8 +15594,8 @@ paths:starts_at:ends_at:deleted_at:- created_at: '2026-08-18T20:10:47.043Z'- updated_at: '2026-08-18T20:10:47.049Z'+ created_at: '2026-08-20T14:33:48.037Z'+ updated_at: '2026-08-20T14:33:48.039Z'currently_active: falseproducts_count: 1prices_count: 2@@ -15745,8 +15758,8 @@ paths:starts_at:ends_at:deleted_at:- created_at: '2026-08-18T20:10:47.116Z'- updated_at: '2026-08-18T20:10:47.116Z'+ created_at: '2026-08-20T14:33:48.332Z'+ updated_at: '2026-08-20T14:33:48.332Z'currently_active: falseproducts_count: 0prices_count: 0@@ -15821,8 +15834,8 @@ paths:starts_at:ends_at:deleted_at:- created_at: '2026-08-18T20:10:47.582Z'- updated_at: '2026-08-18T20:10:47.630Z'+ created_at: '2026-08-20T14:33:49.278Z'+ updated_at: '2026-08-20T14:33:49.359Z'currently_active: falseproducts_count: 0prices_count: 0@@ -16010,8 +16023,8 @@ paths:starts_at:ends_at:deleted_at:- created_at: '2026-08-18T20:10:47.711Z'- updated_at: '2026-08-18T20:10:47.732Z'+ created_at: '2026-08-20T14:33:49.529Z'+ updated_at: '2026-08-20T14:33:49.574Z'currently_active: trueproducts_count: 0prices_count: 0@@ -16074,8 +16087,8 @@ paths:starts_at:ends_at:deleted_at:- created_at: '2026-08-18T20:10:47.748Z'- updated_at: '2026-08-18T20:10:47.769Z'+ created_at: '2026-08-20T14:33:49.606Z'+ updated_at: '2026-08-20T14:33:49.673Z'currently_active: falseproducts_count: 0prices_count: 0@@ -16189,8 +16202,8 @@ paths:display_compare_at_amount:price_list_id:variant_id: variant_UkLWZg9DAJ- created_at: '2026-08-18T20:10:47.822Z'- updated_at: '2026-08-18T20:10:47.822Z'+ created_at: '2026-08-20T14:33:49.792Z'+ updated_at: '2026-08-20T14:33:49.792Z'- id: price_gbHJdmfrXBamount: '19.99'amount_in_cents: 1999@@ -16201,8 +16214,8 @@ paths:display_compare_at_amount:price_list_id:variant_id: variant_gbHJdmfrXB- created_at: '2026-08-18T20:10:47.850Z'- updated_at: '2026-08-18T20:10:47.850Z'+ created_at: '2026-08-20T14:33:49.880Z'+ updated_at: '2026-08-20T14:33:49.880Z'- id: price_EfhxLZ9ck8amount: '5.0'amount_in_cents: 500@@ -16213,8 +16226,8 @@ paths:display_compare_at_amount:price_list_id: pl_UkLWZg9DAJvariant_id: variant_gbHJdmfrXB- created_at: '2026-08-18T20:10:47.854Z'- updated_at: '2026-08-18T20:10:47.854Z'+ created_at: '2026-08-20T14:33:49.887Z'+ updated_at: '2026-08-20T14:33:49.887Z'meta:page: 1limit: 25@@ -16296,8 +16309,8 @@ paths:display_compare_at_amount:price_list_id:variant_id: variant_EfhxLZ9ck8- created_at: '2026-08-18T20:10:48.196Z'- updated_at: '2026-08-18T20:10:48.196Z'+ created_at: '2026-08-20T14:33:50.318Z'+ updated_at: '2026-08-20T14:33:50.318Z'schema:"$ref": "#/components/schemas/Price"requestBody:@@ -16384,8 +16397,8 @@ paths:display_compare_at_amount:price_list_id: pl_UkLWZg9DAJvariant_id: variant_gbHJdmfrXB- created_at: '2026-08-18T20:10:48.323Z'- updated_at: '2026-08-18T20:10:48.323Z'+ created_at: '2026-08-20T14:33:50.557Z'+ updated_at: '2026-08-20T14:33:50.557Z'schema:"$ref": "#/components/schemas/Price"'404':@@ -16450,8 +16463,8 @@ paths:display_compare_at_amount:price_list_id: pl_UkLWZg9DAJvariant_id: variant_gbHJdmfrXB- created_at: '2026-08-18T20:10:48.653Z'- updated_at: '2026-08-18T20:10:48.675Z'+ created_at: '2026-08-20T14:33:51.172Z'+ updated_at: '2026-08-20T14:33:51.192Z'schema:"$ref": "#/components/schemas/Price"requestBody:@@ -16763,8 +16776,8 @@ paths:field_type: short_textkey: custom.titlevalue: wool- created_at: '2026-08-18T20:10:50.009Z'- updated_at: '2026-08-18T20:10:50.009Z'+ created_at: '2026-08-20T14:33:53.237Z'+ updated_at: '2026-08-20T14:33:53.237Z'storefront_visible: truecustom_field_definition_id: cfdef_UkLWZg9DAJmeta:@@ -16834,8 +16847,8 @@ paths:field_type: long_textkey: custom.descriptionvalue: A longer description- created_at: '2026-08-18T20:10:50.166Z'- updated_at: '2026-08-18T20:10:50.166Z'+ created_at: '2026-08-20T14:33:53.567Z'+ updated_at: '2026-08-20T14:33:53.567Z'storefront_visible: truecustom_field_definition_id: cfdef_gbHJdmfrXB'422':@@ -16934,8 +16947,8 @@ paths:field_type: short_textkey: custom.titlevalue: wool- created_at: '2026-08-18T20:10:50.346Z'- updated_at: '2026-08-18T20:10:50.346Z'+ created_at: '2026-08-20T14:33:54.063Z'+ updated_at: '2026-08-20T14:33:54.063Z'storefront_visible: truecustom_field_definition_id: cfdef_UkLWZg9DAJpatch:@@ -16999,8 +17012,8 @@ paths:field_type: short_textkey: custom.titlevalue: cotton- created_at: '2026-08-18T20:10:50.481Z'- updated_at: '2026-08-18T20:10:50.508Z'+ created_at: '2026-08-20T14:33:54.542Z'+ updated_at: '2026-08-20T14:33:54.671Z'storefront_visible: truecustom_field_definition_id: cfdef_UkLWZg9DAJrequestBody:@@ -17119,11 +17132,11 @@ paths:- key: descriptiontype: htmlsource: |-- Cupiditate libero error expedita aliquam inventore eos dolores earum. Possimus dolores at veniam corporis. Cum deleniti incidunt accusantium eos cupiditate et at odio.- Iusto praesentium dolorem consequuntur quo. Esse fugiat rem et nostrum deserunt quos explicabo dolores. Explicabo adipisci asperiores dolore eum veniam atque sequi debitis. Quod ex delectus cum reiciendis quaerat.- Eaque optio fuga nesciunt consequuntur possimus nam illum. Facere temporibus assumenda consequuntur cum adipisci expedita. Sint quam praesentium distinctio voluptatum libero consequuntur molestias tempora. Cupiditate laboriosam ipsam quisquam in nisi.- Distinctio voluptatum dignissimos ab asperiores. Unde iusto eligendi est nobis eos molestiae similique. Laudantium doloremque error nihil minima fugit soluta. Ut sunt fuga reiciendis facilis vitae accusamus. Nisi laboriosam dignissimos quos quas laudantium repellat omnis vero.- Fuga ut reprehenderit nobis dolores. Ipsa vitae earum pariatur sequi laudantium distinctio. Magnam minus quisquam aut eos in pariatur harum odio.+ Optio est possimus facilis labore nihil. Aliquam sequi cum aliquid veritatis labore. Similique consequuntur optio in fugit aliquam ex dolore.+ Sunt adipisci praesentium voluptates minus tempore voluptas. Laborum ea molestias quo possimus. Vitae natus esse dolor cupiditate impedit reiciendis voluptatem corporis.+ Ad dolorem consectetur eos iure perspiciatis explicabo. Illo modi unde molestiae deleniti itaque harum. Quia facere accusamus possimus ut quam.+ Odit harum blanditiis dolores exercitationem id at quia. Ex odio reprehenderit vitae molestiae distinctio veritatis nostrum. Cum odit ipsam assumenda numquam quibusdam tenetur blanditiis.+ Quos corrupti necessitatibus omnis sapiente rerum ea. Nihil quasi nemo voluptatibus facere officia perspiciatis officiis quos. Corporis laboriosam provident ipsa tempora nisi fugit. Accusantium expedita ratione tempore a.- key: slugtype: stringsource: espresso-machine@@ -17234,8 +17247,8 @@ paths:example:data:- id: prod_UkLWZg9DAJ- name: Product 809019- slug: product-809019+ name: Product 808480+ slug: product-808480meta_title:meta_description:meta_keywords:@@ -17247,26 +17260,29 @@ paths:in_stock: falsebackorderable: trueavailable: true- description: Quas reprehenderit illum sed neque sapiente. Cumque- quos debitis nemo aperiam aspernatur consequuntur ut ducimus.- Tempora rerum molestiae hic impedit beatae. Similique debitis- doloribus quidem veniam sed. Quidem fugit expedita rerum dicta- perferendis magni. Dolorum vel consectetur iusto nemo odio sapiente- maxime. Laboriosam eligendi tempore quam unde sint occaecati neque- fugiat. Eius incidunt explicabo dignissimos fugit quidem. Vel- sit eum autem corporis laudantium velit. Consectetur beatae repudiandae- dicta assumenda ut dignissimos. Ipsum magni labore ad natus nulla- nesciunt molestias eius. Odit ipsum asperiores modi ex officiis- quibusdam aperiam. Quae facilis soluta temporibus odit veniam.- Nostrum nulla fugit accusantium neque mollitia praesentium doloremque- ducimus. Eaque cum earum magni laboriosam voluptate. Incidunt- illum natus harum fugit. Illo dolores atque omnis architecto cum- aspernatur.+ description: Alias et vitae vel aspernatur aut pariatur eaque. Corporis+ ipsam sed nesciunt nemo porro. Inventore reiciendis eaque ea quo+ omnis doloribus. Dicta nulla occaecati totam assumenda quibusdam+ repellat enim distinctio. Enim tempora commodi praesentium illum+ corporis impedit eveniet. Hic quasi odit perferendis non voluptate+ repellat aperiam. Dolorum voluptatum molestias minima cum commodi+ necessitatibus nam quia. Exercitationem maxime magnam minus veritatis+ asperiores. Debitis quas ratione laboriosam ipsa unde. Provident+ illo dolorem maiores quia aliquam natus. Nulla corrupti ratione+ minima tempora. Exercitationem quibusdam nam rerum id totam. Et+ at reiciendis quia debitis ratione. Libero assumenda error unde+ occaecati quod tempora. Ullam nulla id cupiditate officia iure+ qui molestiae suscipit. Odio illo velit laboriosam pariatur temporibus+ vitae molestiae. Quos nulla nobis repellat aut dicta commodi.+ Suscipit reprehenderit quod esse alias. Sapiente ipsum similique+ aut eveniet quo. Dicta dignissimos dolorem deleniti eveniet veritatis+ eaque.description_html: |-- Quas reprehenderit illum sed neque sapiente. Cumque quos debitis nemo aperiam aspernatur consequuntur ut ducimus. Tempora rerum molestiae hic impedit beatae. Similique debitis doloribus quidem veniam sed.- Quidem fugit expedita rerum dicta perferendis magni. Dolorum vel consectetur iusto nemo odio sapiente maxime. Laboriosam eligendi tempore quam unde sint occaecati neque fugiat. Eius incidunt explicabo dignissimos fugit quidem. Vel sit eum autem corporis laudantium velit.- Consectetur beatae repudiandae dicta assumenda ut dignissimos. Ipsum magni labore ad natus nulla nesciunt molestias eius. Odit ipsum asperiores modi ex officiis quibusdam aperiam. Quae facilis soluta temporibus odit veniam.- Nostrum nulla fugit accusantium neque mollitia praesentium doloremque ducimus. Eaque cum earum magni laboriosam voluptate. Incidunt illum natus harum fugit. Illo dolores atque omnis architecto cum aspernatur.+ Alias et vitae vel aspernatur aut pariatur eaque. Corporis ipsam sed nesciunt nemo porro. Inventore reiciendis eaque ea quo omnis doloribus. Dicta nulla occaecati totam assumenda quibusdam repellat enim distinctio. Enim tempora commodi praesentium illum corporis impedit eveniet.+ Hic quasi odit perferendis non voluptate repellat aperiam. Dolorum voluptatum molestias minima cum commodi necessitatibus nam quia. Exercitationem maxime magnam minus veritatis asperiores. Debitis quas ratione laboriosam ipsa unde.+ Provident illo dolorem maiores quia aliquam natus. Nulla corrupti ratione minima tempora. Exercitationem quibusdam nam rerum id totam.+ Et at reiciendis quia debitis ratione. Libero assumenda error unde occaecati quod tempora. Ullam nulla id cupiditate officia iure qui molestiae suscipit.+ Odio illo velit laboriosam pariatur temporibus vitae molestiae. Quos nulla nobis repellat aut dicta commodi. Suscipit reprehenderit quod esse alias. Sapiente ipsum similique aut eveniet quo. Dicta dignissimos dolorem deleniti eveniet veritatis eaque.default_variant_id: variant_UkLWZg9DAJbuy_box_variant_id: variant_UkLWZg9DAJthumbnail_url:@@ -17282,15 +17298,15 @@ paths:display_compare_at_amount:price_list_id:variant_id: variant_UkLWZg9DAJ- created_at: '2026-08-18T20:10:50.810Z'- updated_at: '2026-08-18T20:10:50.810Z'+ created_at: '2026-08-20T14:33:55.404Z'+ updated_at: '2026-08-20T14:33:55.404Z'original_price:seller_id:status: activemetadata: {}deleted_at:- created_at: '2026-08-18T20:10:50.797Z'- updated_at: '2026-08-18T20:10:50.830Z'+ created_at: '2026-08-20T14:33:55.355Z'+ updated_at: '2026-08-20T14:33:55.438Z'delivery_profile_id: fp_UkLWZg9DAJseller_name:product_type_id:@@ -17370,7 +17386,7 @@ paths:{ currency: 'USD', amount: '29.99' },{ currency: 'EUR', amount: '27.99' },],- stock_items: [{ stock_location_id: 'sloc_UkLWZg9DAJ', count_on_hand: 50 }],+ stock_levels: [{ stock_location_id: 'sloc_UkLWZg9DAJ', count_on_hand: 50 }],},{sku: 'TSHIRT-M-NAVY',@@ -17379,14 +17395,14 @@ paths:{ name: 'color', value: 'navy' },],prices: [{ currency: 'USD', amount: '29.99' }],- stock_items: [{ stock_location_id: 'sloc_UkLWZg9DAJ', count_on_hand: 30 }],+ stock_levels: [{ stock_location_id: 'sloc_UkLWZg9DAJ', count_on_hand: 30 }],},],})- lang: bashlabel: Spree CLIsource: spree api post /products -d '{"name":"Premium T-Shirt","description":"<p>Soft,- organic cotton.</p>","status":"active","variants":[{"sku":"TSHIRT-S-NAVY","options":[{"name":"size","value":"Small"},{"name":"color","value":"navy"}],"prices":[{"currency":"USD","amount":"29.99"},{"currency":"EUR","amount":"27.99"}],"stock_items":[{"stock_location_id":"sloc_UkLWZg9DAJ","count_on_hand":50}]},{"sku":"TSHIRT-M-NAVY","options":[{"name":"size","value":"Medium"},{"name":"color","value":"navy"}],"prices":[{"currency":"USD","amount":"29.99"}],"stock_items":[{"stock_location_id":"sloc_UkLWZg9DAJ","count_on_hand":30}]}]}'+ organic cotton.</p>","status":"active","variants":[{"sku":"TSHIRT-S-NAVY","options":[{"name":"size","value":"Small"},{"name":"color","value":"navy"}],"prices":[{"currency":"USD","amount":"29.99"},{"currency":"EUR","amount":"27.99"}],"stock_levels":[{"stock_location_id":"sloc_UkLWZg9DAJ","count_on_hand":50}]},{"sku":"TSHIRT-M-NAVY","options":[{"name":"size","value":"Medium"},{"name":"color","value":"navy"}],"prices":[{"currency":"USD","amount":"29.99"}],"stock_levels":[{"stock_location_id":"sloc_UkLWZg9DAJ","count_on_hand":30}]}]}'parameters:- name: x-spree-api-keyin: header@@ -17431,8 +17447,8 @@ paths:status: draftmetadata: {}deleted_at:- created_at: '2026-08-18T20:10:51.087Z'- updated_at: '2026-08-18T20:10:51.097Z'+ created_at: '2026-08-20T14:33:55.943Z'+ updated_at: '2026-08-20T14:33:55.983Z'delivery_profile_id: fp_UkLWZg9DAJseller_name:product_type_id:@@ -17511,7 +17527,7 @@ paths:type: arraydescription: Array of variant payloads. Variants can declare multipleoption pairs via `options:` and per-currency prices via `prices:`.- Stock counts go in `stock_items:` (per stock location).+ Stock counts go in `stock_levels:` (per stock location).items:type: objectproperties:@@ -17553,7 +17569,7 @@ paths:type: stringnullable: trueexample: '39.99'- stock_items:+ stock_levels:type: arraydescription: Per-stock-location inventory. Upserted by stock_location_id.items:@@ -17640,8 +17656,8 @@ paths:application/json:example:id: prod_UkLWZg9DAJ- name: Product 844524- slug: product-844524+ name: Product 841016+ slug: product-841016meta_title:meta_description:meta_keywords:@@ -17653,25 +17669,14 @@ paths:in_stock: falsebackorderable: trueavailable: true- description: Quis quisquam atque tempora accusantium. Animi necessitatibus- voluptatum unde error mollitia repudiandae ab. Ipsa porro error- minus excepturi itaque. Nemo eaque quaerat exercitationem non quos- blanditiis iusto. Temporibus esse impedit accusamus numquam occaecati- nobis laudantium cum. Quibusdam doloremque accusamus est perspiciatis- a quas iure. Possimus deleniti nobis nostrum fugiat amet in molestias- aliquid. Accusantium nobis reiciendis dolorum quae. Ipsum delectus- soluta nesciunt repudiandae molestiae. Numquam ratione qui quos- debitis nam. Iure atque doloribus molestias eaque. Omnis expedita- animi voluptatum veniam. Quos impedit natus dolore inventore quisquam.- Quasi voluptate natus illum dolor aperiam recusandae. Quo accusamus- culpa nesciunt magnam. Exercitationem eveniet ipsa corporis iste.- Exercitationem totam eius et culpa ab nisi at illum. Facere voluptate- pariatur repellat provident eos.- description_html: |-- Quis quisquam atque tempora accusantium. Animi necessitatibus voluptatum unde error mollitia repudiandae ab. Ipsa porro error minus excepturi itaque. Nemo eaque quaerat exercitationem non quos blanditiis iusto. Temporibus esse impedit accusamus numquam occaecati nobis laudantium cum.- Quibusdam doloremque accusamus est perspiciatis a quas iure. Possimus deleniti nobis nostrum fugiat amet in molestias aliquid. Accusantium nobis reiciendis dolorum quae. Ipsum delectus soluta nesciunt repudiandae molestiae. Numquam ratione qui quos debitis nam.- Iure atque doloribus molestias eaque. Omnis expedita animi voluptatum veniam. Quos impedit natus dolore inventore quisquam. Quasi voluptate natus illum dolor aperiam recusandae.- Quo accusamus culpa nesciunt magnam. Exercitationem eveniet ipsa corporis iste. Exercitationem totam eius et culpa ab nisi at illum. Facere voluptate pariatur repellat provident eos.+ description: Omnis maiores delectus quo rem cumque provident. Inventore+ debitis animi omnis dolores. Illum sit officiis asperiores quos+ veritatis. Voluptates veniam amet inventore illum harum praesentium.+ Nobis distinctio sed blanditiis hic dicta quisquam.+ description_html: Omnis maiores delectus quo rem cumque provident.+ Inventore debitis animi omnis dolores. Illum sit officiis asperiores+ quos veritatis. Voluptates veniam amet inventore illum harum praesentium.+ Nobis distinctio sed blanditiis hic dicta quisquam.default_variant_id: variant_UkLWZg9DAJbuy_box_variant_id: variant_UkLWZg9DAJthumbnail_url:@@ -17687,15 +17692,15 @@ paths:display_compare_at_amount:price_list_id:variant_id: variant_UkLWZg9DAJ- created_at: '2026-08-18T20:10:51.292Z'- updated_at: '2026-08-18T20:10:51.292Z'+ created_at: '2026-08-20T14:33:56.413Z'+ updated_at: '2026-08-20T14:33:56.413Z'original_price:seller_id:status: activemetadata: {}deleted_at:- created_at: '2026-08-18T20:10:51.274Z'- updated_at: '2026-08-18T20:10:51.306Z'+ created_at: '2026-08-20T14:33:56.379Z'+ updated_at: '2026-08-20T14:33:56.470Z'delivery_profile_id: fp_UkLWZg9DAJseller_name:product_type_id:@@ -17768,7 +17773,7 @@ paths:example:id: prod_UkLWZg9DAJname: Updated Name- slug: product-868790+ slug: product-865716meta_title:meta_description:meta_keywords:@@ -17780,24 +17785,30 @@ paths:in_stock: falsebackorderable: trueavailable: true- description: Ipsum placeat commodi accusantium sit. Alias ab quibusdam- totam dignissimos libero nobis. Eius nesciunt deserunt beatae provident- ad fugiat exercitationem. Asperiores veritatis placeat itaque cum- iure totam reprehenderit fugit. Magni similique necessitatibus autem- provident facilis asperiores. Debitis atque aliquid provident iste- numquam neque. Quas nihil eaque corrupti modi. Dolore autem minus- nesciunt libero modi. Quae odit earum cum temporibus sequi voluptatibus- explicabo. Corporis odit ab ducimus fuga officiis in at. Nemo aperiam- consequuntur vel ab quasi. Quisquam id non ipsam minus. Odio similique- et illum repudiandae ipsam labore magnam. Unde repellendus distinctio- blanditiis cumque commodi suscipit. Sequi sint iste ea quis explicabo- est molestiae. Quo facilis libero adipisci deserunt quidem. Sit- aspernatur magnam dolore deserunt numquam voluptatibus quam aliquid.+ description: Pariatur doloribus quam iste illo nihil est. Consequatur+ ab excepturi in quam nulla rerum consequuntur modi. Alias ex sunt+ nulla reprehenderit id. Quis ipsa fuga libero modi quia praesentium+ distinctio. Itaque repellendus ab hic voluptatem id. Quo natus voluptate+ similique voluptas facilis esse. Veniam eveniet nulla vel velit+ maiores dolorum. Consectetur porro veritatis sint unde commodi.+ A quaerat praesentium enim maxime repudiandae veritatis eos. Nemo+ consequuntur rem culpa alias vero dolores numquam consequatur. Animi+ sapiente maxime fugit dignissimos fuga. Ipsam eaque voluptatum atque+ non consequatur explicabo fugit. Ipsa assumenda nulla nostrum quis.+ Eum atque odit pariatur ut. Minima quisquam nulla officiis atque+ ipsam. Architecto commodi eveniet ipsa voluptatibus quam. Voluptatum+ vero suscipit sequi placeat nostrum. Beatae voluptatibus voluptate+ repudiandae quis adipisci nesciunt ipsum. Commodi aut nihil maxime+ explicabo nemo vel veritatis necessitatibus. Nesciunt deserunt placeat+ sapiente velit eligendi facere. Nisi quidem dolore accusantium a+ consectetur eum iusto. Quibusdam aspernatur itaque enim maxime ipsa+ repudiandae.description_html: |-- Ipsum placeat commodi accusantium sit. Alias ab quibusdam totam dignissimos libero nobis. Eius nesciunt deserunt beatae provident ad fugiat exercitationem.- Asperiores veritatis placeat itaque cum iure totam reprehenderit fugit. Magni similique necessitatibus autem provident facilis asperiores. Debitis atque aliquid provident iste numquam neque. Quas nihil eaque corrupti modi. Dolore autem minus nesciunt libero modi.- Quae odit earum cum temporibus sequi voluptatibus explicabo. Corporis odit ab ducimus fuga officiis in at. Nemo aperiam consequuntur vel ab quasi. Quisquam id non ipsam minus. Odio similique et illum repudiandae ipsam labore magnam.- Unde repellendus distinctio blanditiis cumque commodi suscipit. Sequi sint iste ea quis explicabo est molestiae. Quo facilis libero adipisci deserunt quidem. Sit aspernatur magnam dolore deserunt numquam voluptatibus quam aliquid.+ Pariatur doloribus quam iste illo nihil est. Consequatur ab excepturi in quam nulla rerum consequuntur modi. Alias ex sunt nulla reprehenderit id. Quis ipsa fuga libero modi quia praesentium distinctio. Itaque repellendus ab hic voluptatem id.+ Quo natus voluptate similique voluptas facilis esse. Veniam eveniet nulla vel velit maiores dolorum. Consectetur porro veritatis sint unde commodi. A quaerat praesentium enim maxime repudiandae veritatis eos.+ Nemo consequuntur rem culpa alias vero dolores numquam consequatur. Animi sapiente maxime fugit dignissimos fuga. Ipsam eaque voluptatum atque non consequatur explicabo fugit.+ Ipsa assumenda nulla nostrum quis. Eum atque odit pariatur ut. Minima quisquam nulla officiis atque ipsam. Architecto commodi eveniet ipsa voluptatibus quam. Voluptatum vero suscipit sequi placeat nostrum.+ Beatae voluptatibus voluptate repudiandae quis adipisci nesciunt ipsum. Commodi aut nihil maxime explicabo nemo vel veritatis necessitatibus. Nesciunt deserunt placeat sapiente velit eligendi facere. Nisi quidem dolore accusantium a consectetur eum iusto. Quibusdam aspernatur itaque enim maxime ipsa repudiandae.default_variant_id: variant_UkLWZg9DAJbuy_box_variant_id: variant_UkLWZg9DAJthumbnail_url:@@ -17813,15 +17824,15 @@ paths:display_compare_at_amount:price_list_id:variant_id: variant_UkLWZg9DAJ- created_at: '2026-08-18T20:10:51.577Z'- updated_at: '2026-08-18T20:10:51.577Z'+ created_at: '2026-08-20T14:33:56.872Z'+ updated_at: '2026-08-20T14:33:56.872Z'original_price:seller_id:status: activemetadata: {}deleted_at:- created_at: '2026-08-18T20:10:51.561Z'- updated_at: '2026-08-18T20:10:51.644Z'+ created_at: '2026-08-20T14:33:56.832Z'+ updated_at: '2026-08-20T14:33:56.975Z'delivery_profile_id: fp_UkLWZg9DAJseller_name:product_type_id:@@ -17900,7 +17911,7 @@ paths:type: arraydescription: Array of variant payloads. Variants can declare multipleoption pairs via `options:` and per-currency prices via `prices:`.- Stock counts go in `stock_items:` (per stock location).+ Stock counts go in `stock_levels:` (per stock location).items:type: objectproperties:@@ -17942,7 +17953,7 @@ paths:type: stringnullable: trueexample: '39.99'- stock_items:+ stock_levels:type: arraydescription: Per-stock-location inventory. Upserted by stock_location_id.items:@@ -18767,15 +18778,15 @@ paths:- id: coupon_UkLWZg9DAJcode: AAA111state: unused- created_at: '2026-08-18T20:10:06.129Z'- updated_at: '2026-08-18T20:10:06.129Z'+ created_at: '2026-08-20T14:33:23.833Z'+ updated_at: '2026-08-20T14:33:23.833Z'promotion_id: promo_UkLWZg9DAJorder_id:- id: coupon_gbHJdmfrXBcode: BBB222state: unused- created_at: '2026-08-18T20:10:06.140Z'- updated_at: '2026-08-18T20:10:06.140Z'+ created_at: '2026-08-20T14:33:23.835Z'+ updated_at: '2026-08-20T14:33:23.835Z'promotion_id: promo_UkLWZg9DAJorder_id:meta:@@ -18837,8 +18848,8 @@ paths:example:data:- id: pact_UkLWZg9DAJ- created_at: '2026-08-18T20:10:54.901Z'- updated_at: '2026-08-18T20:10:54.901Z'+ created_at: '2026-08-20T14:34:00.940Z'+ updated_at: '2026-08-20T14:34:00.940Z'type: free_shippingpromotion_id: promo_UkLWZg9DAJpreferences: {}@@ -18902,8 +18913,8 @@ paths:application/json:example:id: pact_UkLWZg9DAJ- created_at: '2026-08-18T20:10:55.042Z'- updated_at: '2026-08-18T20:10:55.042Z'+ created_at: '2026-08-20T14:34:01.224Z'+ updated_at: '2026-08-20T14:34:01.224Z'type: free_shippingpromotion_id: promo_UkLWZg9DAJpreferences: {}@@ -19031,8 +19042,8 @@ paths:example:data:- id: prorule_UkLWZg9DAJ- created_at: '2026-08-18T20:10:55.196Z'- updated_at: '2026-08-18T20:10:55.196Z'+ created_at: '2026-08-20T14:34:01.542Z'+ updated_at: '2026-08-20T14:34:01.542Z'type: currencypromotion_id: promo_UkLWZg9DAJpreferences:@@ -19102,8 +19113,8 @@ paths:application/json:example:id: prorule_UkLWZg9DAJ- created_at: '2026-08-18T20:10:55.295Z'- updated_at: '2026-08-18T20:10:55.295Z'+ created_at: '2026-08-20T14:34:01.666Z'+ updated_at: '2026-08-20T14:34:01.666Z'type: currencypromotion_id: promo_UkLWZg9DAJpreferences:@@ -19194,8 +19205,8 @@ paths:application/json:example:id: prorule_UkLWZg9DAJ- created_at: '2026-08-18T20:10:55.349Z'- updated_at: '2026-08-18T20:10:55.414Z'+ created_at: '2026-08-20T14:34:01.806Z'+ updated_at: '2026-08-20T14:34:01.827Z'type: currencypromotion_id: promo_UkLWZg9DAJpreferences:@@ -19303,7 +19314,7 @@ paths:name: Summer Saledescription:code: summer- starts_at: '2026-08-18T20:10:55.528Z'+ starts_at: '2026-08-20T14:34:01.953Z'expires_at:usage_limit:match_policy: all@@ -19314,8 +19325,8 @@ paths:code_prefix:promotion_category_id:metadata: {}- created_at: '2026-08-18T20:10:55.528Z'- updated_at: '2026-08-18T20:10:55.528Z'+ created_at: '2026-08-20T14:34:01.953Z'+ updated_at: '2026-08-20T14:34:01.953Z'action_ids: []rule_ids: []meta:@@ -19422,7 +19433,7 @@ paths:name: Black Fridaydescription:code: blackfriday-os- starts_at: '2026-08-18T20:10:55.752Z'+ starts_at: '2026-08-20T14:34:02.546Z'expires_at:usage_limit:match_policy: all@@ -19433,8 +19444,8 @@ paths:code_prefix:promotion_category_id:metadata: {}- created_at: '2026-08-18T20:10:55.752Z'- updated_at: '2026-08-18T20:10:55.780Z'+ created_at: '2026-08-20T14:34:02.546Z'+ updated_at: '2026-08-20T14:34:02.590Z'action_ids:- pact_UkLWZg9DAJ- pact_gbHJdmfrXB@@ -19600,7 +19611,7 @@ paths:name: Summer Saledescription:code: summer- starts_at: '2026-08-18T20:10:55.899Z'+ starts_at: '2026-08-20T14:34:02.729Z'expires_at:usage_limit:match_policy: all@@ -19611,8 +19622,8 @@ paths:code_prefix:promotion_category_id:metadata: {}- created_at: '2026-08-18T20:10:55.899Z'- updated_at: '2026-08-18T20:10:55.899Z'+ created_at: '2026-08-20T14:34:02.729Z'+ updated_at: '2026-08-20T14:34:02.729Z'action_ids: []rule_ids: []patch:@@ -19709,7 +19720,7 @@ paths:name: Summer Saledescription:code: summer- starts_at: '2026-08-18T20:10:56.107Z'+ starts_at: '2026-08-20T14:34:03.251Z'expires_at:usage_limit:match_policy: all@@ -19720,8 +19731,8 @@ paths:code_prefix:promotion_category_id:metadata: {}- created_at: '2026-08-18T20:10:56.107Z'- updated_at: '2026-08-18T20:10:56.127Z'+ created_at: '2026-08-20T14:34:03.252Z'+ updated_at: '2026-08-20T14:34:03.445Z'action_ids: []rule_ids: []requestBody:@@ -20193,15 +20204,15 @@ paths:application/json:example:id: re_UkLWZg9DAJ- transaction_id: BGS-8c3e7433825e+ transaction_id: BGS-0501d3b28773amount: '5.0'payment_id: py_UkLWZg9DAJrefund_reason_id: rr_UkLWZg9DAJoriginator_id:originator_type:metadata: {}- created_at: '2026-08-18T20:10:41.516Z'- updated_at: '2026-08-18T20:10:41.516Z'+ created_at: '2026-08-20T14:33:42.320Z'+ updated_at: '2026-08-20T14:33:42.320Z'requestBody:content:application/json:@@ -20334,6 +20345,7 @@ paths:preferred_capture_method: checkoutpreferred_track_inventory_levels: truepreferred_stock_reservations_enabled: true+ preferred_tax_using_ship_address: truepreferred_track_price_history: truepreferred_show_products_without_price: falsepreferred_disable_sku_validation: false@@ -20342,8 +20354,8 @@ paths:preferred_order_number_prefix: Rpreferred_order_number_suffix: ''preferred_order_number_sequence_start: 1001- created_at: '2026-08-18T20:09:51.250Z'- updated_at: '2026-08-18T20:10:58.350Z'+ created_at: '2026-08-20T14:33:14.994Z'+ updated_at: '2026-08-20T14:34:10.271Z'order_number_sequence_started: falseurl: http://www.example.com:3000api_url: http://www.example.com:3000@@ -20650,6 +20662,7 @@ paths:preferred_capture_method: checkoutpreferred_track_inventory_levels: truepreferred_stock_reservations_enabled: true+ preferred_tax_using_ship_address: truepreferred_track_price_history: truepreferred_show_products_without_price: falsepreferred_disable_sku_validation: false@@ -20658,8 +20671,8 @@ paths:preferred_order_number_prefix: Rpreferred_order_number_suffix: ''preferred_order_number_sequence_start: 1001- created_at: '2026-08-18T20:09:51.250Z'- updated_at: '2026-08-18T20:10:58.539Z'+ created_at: '2026-08-20T14:33:14.994Z'+ updated_at: '2026-08-20T14:34:10.522Z'order_number_sequence_started: falseurl: http://www.example.com:3000api_url: http://www.example.com:3000@@ -21056,12 +21069,12 @@ paths:example:data:- id: tax_UkLWZg9DAJ- name: TaxRate - 890476+ name: TaxRate - 583380included_in_price: trueshow_rate_in_label: truemetadata: {}- created_at: '2026-08-18T20:10:58.845Z'- updated_at: '2026-08-18T20:10:58.845Z'+ created_at: '2026-08-20T14:34:10.964Z'+ updated_at: '2026-08-20T14:34:10.964Z'deleted_at:amount: '0.19'amount_percentage: 19.0@@ -21143,8 +21156,8 @@ paths:included_in_price: trueshow_rate_in_label: truemetadata: {}- created_at: '2026-08-18T20:10:59.013Z'- updated_at: '2026-08-18T20:10:59.013Z'+ created_at: '2026-08-20T14:34:11.207Z'+ updated_at: '2026-08-20T14:34:11.207Z'deleted_at:amount: '0.19'amount_percentage: 19.0@@ -21235,12 +21248,12 @@ paths:application/json:example:id: tax_UkLWZg9DAJ- name: TaxRate - 46118+ name: TaxRate - 999625included_in_price: trueshow_rate_in_label: truemetadata: {}- created_at: '2026-08-18T20:10:59.117Z'- updated_at: '2026-08-18T20:10:59.117Z'+ created_at: '2026-08-20T14:34:11.449Z'+ updated_at: '2026-08-20T14:34:11.449Z'deleted_at:amount: '0.19'amount_percentage: 19.0@@ -21277,12 +21290,12 @@ paths:application/json:example:id: tax_UkLWZg9DAJ- name: TaxRate - 368613+ name: TaxRate - 345782included_in_price: trueshow_rate_in_label: truemetadata: {}- created_at: '2026-08-18T20:10:59.157Z'- updated_at: '2026-08-18T20:10:59.187Z'+ created_at: '2026-08-20T14:34:11.594Z'+ updated_at: '2026-08-20T14:34:11.679Z'deleted_at:amount: '0.07'amount_percentage: 7.0@@ -21595,13 +21608,13 @@ paths:example:data:- id: adm_UkLWZg9DAJ- email: [email protected]- first_name: Roma- last_name: Mosciski- full_name: Roma Mosciski+ email: [email protected]+ first_name: Elise+ last_name: Ernser+ full_name: Elise Ernserselected_locale:- created_at: '2026-08-18T20:09:51.685Z'- updated_at: '2026-08-18T20:09:51.685Z'+ created_at: '2026-08-20T14:33:15.188Z'+ updated_at: '2026-08-20T14:33:15.188Z'avatar_url:roles:- id: role_UkLWZg9DAJ@@ -21667,13 +21680,13 @@ paths:application/json:example:id: adm_UkLWZg9DAJ- email: [email protected]- first_name: Annis- last_name: Streich- full_name: Annis Streich+ email: [email protected]+ first_name: Edyth+ last_name: Dicki+ full_name: Edyth Dickiselected_locale:- created_at: '2026-08-18T20:09:52.492Z'- updated_at: '2026-08-18T20:09:52.492Z'+ created_at: '2026-08-20T14:33:15.521Z'+ updated_at: '2026-08-20T14:33:15.521Z'avatar_url:roles:- id: role_UkLWZg9DAJ@@ -21734,13 +21747,13 @@ paths:application/json:example:id: adm_UkLWZg9DAJ- email: [email protected]+ email: [email protected]first_name: Renamed- last_name: Bailey- full_name: Renamed Bailey+ last_name: Fritsch+ full_name: Renamed Fritschselected_locale:- created_at: '2026-08-18T20:09:52.587Z'- updated_at: '2026-08-18T20:09:52.639Z'+ created_at: '2026-08-20T14:33:15.574Z'+ updated_at: '2026-08-20T14:33:15.632Z'avatar_url:roles:- id: role_UkLWZg9DAJ@@ -21856,15 +21869,15 @@ paths:example:data:- id: inv_UkLWZg9DAJ- email: [email protected]+ email: [email protected]status: pending- created_at: '2026-08-18T20:10:17.654Z'- updated_at: '2026-08-18T20:10:17.654Z'- expires_at: '2026-09-01T20:10:17.652Z'+ created_at: '2026-08-20T14:33:29.578Z'+ updated_at: '2026-08-20T14:33:29.578Z'+ expires_at: '2026-09-03T14:33:29.570Z'role_id: role_UkLWZg9DAJrole_name: admin- inviter_email: [email protected]- acceptance_url: "/accept-invitation/inv_UkLWZg9DAJ?token=krL489JtRGFfJ1T6CWxQT4wr"+ inviter_email: [email protected]+ acceptance_url: "/accept-invitation/inv_UkLWZg9DAJ?token=pAkmVMyZpmb1Zp1MvctiGGq6"invitee_exists: falsestore:id: store_UkLWZg9DAJ@@ -21928,13 +21941,13 @@ paths:id: inv_gbHJdmfrXBemail: [email protected]status: pending- created_at: '2026-08-18T20:10:17.888Z'- updated_at: '2026-08-18T20:10:17.888Z'- expires_at: '2026-09-01T20:10:17.885Z'+ created_at: '2026-08-20T14:33:29.641Z'+ updated_at: '2026-08-20T14:33:29.641Z'+ expires_at: '2026-09-03T14:33:29.637Z'role_id: role_UkLWZg9DAJrole_name: admin- inviter_email: [email protected]- acceptance_url: "/accept-invitation/inv_gbHJdmfrXB?token=WmyQGMU1JgGZkrEm7TYs67bC"+ inviter_email: [email protected]+ acceptance_url: "/accept-invitation/inv_gbHJdmfrXB?token=tU8fjgHKqPurnUNfnCAExpdp"invitee_exists: falsestore:id: store_UkLWZg9DAJ@@ -22047,15 +22060,15 @@ paths:application/json:example:id: inv_UkLWZg9DAJ- email: [email protected]+ email: [email protected]status: pending- created_at: '2026-08-18T20:10:17.989Z'- updated_at: '2026-08-18T20:10:17.989Z'- expires_at: '2026-09-01T20:10:17.989Z'+ created_at: '2026-08-20T14:33:29.694Z'+ updated_at: '2026-08-20T14:33:29.694Z'+ expires_at: '2026-09-03T14:33:29.693Z'role_id: role_UkLWZg9DAJrole_name: admin- inviter_email: [email protected]- acceptance_url: "/accept-invitation/inv_UkLWZg9DAJ?token=Dd6bFPk2uD3G4d3yyNb86Ksj"+ inviter_email: [email protected]+ acceptance_url: "/accept-invitation/inv_UkLWZg9DAJ?token=ntjkH6r9V9dfzmaVpScBK9ds"invitee_exists: falsestore:id: store_UkLWZg9DAJ@@ -22442,8 +22455,8 @@ paths:- id: role_UkLWZg9DAJname: admindescription:- created_at: '2026-08-18T20:10:56.269Z'- updated_at: '2026-08-18T20:10:56.269Z'+ created_at: '2026-08-20T14:34:04.020Z'+ updated_at: '2026-08-20T14:34:04.020Z'permissions:- read_orders- write_orders@@ -22549,8 +22562,8 @@ paths:id: role_gbHJdmfrXBname: order_managerdescription: Handles daily orders- created_at: '2026-08-18T20:10:56.340Z'- updated_at: '2026-08-18T20:10:56.340Z'+ created_at: '2026-08-20T14:34:04.242Z'+ updated_at: '2026-08-20T14:34:04.242Z'permissions:- write_orders- read_customers@@ -22644,8 +22657,8 @@ paths:id: role_gbHJdmfrXBname: supportdescription:- created_at: '2026-08-18T20:10:56.407Z'- updated_at: '2026-08-18T20:10:56.436Z'+ created_at: '2026-08-20T14:34:04.440Z'+ updated_at: '2026-08-20T14:34:04.456Z'permissions:- read_orders- read_customers@@ -22841,8 +22854,8 @@ paths:kind: warehousepickup_enabled: falsepickup_stock_policy: local- created_at: '2026-08-18T20:10:57.707Z'- updated_at: '2026-08-18T20:10:57.707Z'+ created_at: '2026-08-20T14:34:07.610Z'+ updated_at: '2026-08-20T14:34:07.610Z'meta:page: 1limit: 25@@ -22956,8 +22969,8 @@ paths:kind: storepickup_enabled: truepickup_stock_policy: local- created_at: '2026-08-18T20:10:57.885Z'- updated_at: '2026-08-18T20:10:57.885Z'+ created_at: '2026-08-20T14:34:08.239Z'+ updated_at: '2026-08-20T14:34:08.239Z'schema:"$ref": "#/components/schemas/StockLocation"'422':@@ -23134,8 +23147,8 @@ paths:kind: warehousepickup_enabled: falsepickup_stock_policy: local- created_at: '2026-08-18T20:10:57.984Z'- updated_at: '2026-08-18T20:10:57.984Z'+ created_at: '2026-08-20T14:34:08.413Z'+ updated_at: '2026-08-20T14:34:08.413Z'schema:"$ref": "#/components/schemas/StockLocation"'404':@@ -23224,8 +23237,8 @@ paths:kind: warehousepickup_enabled: truepickup_stock_policy: local- created_at: '2026-08-18T20:10:58.119Z'- updated_at: '2026-08-18T20:10:58.199Z'+ created_at: '2026-08-20T14:34:08.593Z'+ updated_at: '2026-08-20T14:34:08.673Z'schema:"$ref": "#/components/schemas/StockLocation"'422':@@ -23375,11 +23388,11 @@ paths:})const { data: variants } = await client.products.variants.list('prod_86Rf07xd4z', {- expand: ['prices', 'stock_items'],+ expand: ['prices', 'stock_levels'],})- lang: bashlabel: Spree CLI- source: spree api get /products/{product_id}/variants -d '{"expand":["prices","stock_items"]}'+ source: spree api get /products/{product_id}/variants -d '{"expand":["prices","stock_levels"]}'parameters:- name: x-spree-api-keyin: header@@ -23414,7 +23427,8 @@ paths:in: queryrequired: falsedescription: Comma-separated associations to expand (e.g., images, prices,- stock_items, option_values). Use dot notation for nested expand (max 4 levels).+ stock_levels, option_values). Use dot notation for nested expand (max 4+ levels).schema:type: string- name: fields@@ -23433,7 +23447,7 @@ paths:data:- id: variant_UkLWZg9DAJproduct_id: prod_UkLWZg9DAJ- sku: SKU-124+ sku: SKU-132options_text: ''track_inventory: truemedia_count: 0@@ -23472,18 +23486,18 @@ paths:country_of_origin:customs_description:deleted_at:- created_at: '2026-08-18T20:10:59.489Z'- updated_at: '2026-08-18T20:10:59.511Z'+ created_at: '2026-08-20T14:34:12.158Z'+ updated_at: '2026-08-20T14:34:12.170Z'preorderable: falsetax_category_id: taxcat_UkLWZg9DAJavailable_stock: 0reserved_quantity: 0total_on_hand: 0- product_name: Product 1059062+ product_name: Product 1091399delivery_profile_id: fp_UkLWZg9DAJ- id: variant_gbHJdmfrXBproduct_id: prod_UkLWZg9DAJ- sku: SKU-125+ sku: SKU-133options_text: 'Size: S'track_inventory: truemedia_count: 0@@ -23493,10 +23507,10 @@ paths:in_stock: falsebackorderable: truepreorder: false- weight: 25.39- height: 108.91- width: 169.38- depth: 120.62+ weight: 42.97+ height: 131.82+ width: 34.72+ depth: 9.47price:id: price_gbHJdmfrXBamount: '19.99'@@ -23512,16 +23526,16 @@ paths:option_values:- id: optval_UkLWZg9DAJoption_type_id: opt_UkLWZg9DAJ- name: size-19+ name: size-23label: Sposition: 1color_code:- option_type_name: foo-size-28+ option_type_name: foo-size-32option_type_label: Sizeimage_url:metadata: {}- created_at: '2026-08-18T20:10:59.530Z'- updated_at: '2026-08-18T20:10:59.530Z'+ created_at: '2026-08-20T14:34:12.355Z'+ updated_at: '2026-08-20T14:34:12.355Z'metadata: {}position: 2cost_price: '17.0'@@ -23534,14 +23548,14 @@ paths:country_of_origin:customs_description:deleted_at:- created_at: '2026-08-18T20:10:59.527Z'- updated_at: '2026-08-18T20:10:59.553Z'+ created_at: '2026-08-20T14:34:12.338Z'+ updated_at: '2026-08-20T14:34:12.394Z'preorderable: falsetax_category_id: taxcat_UkLWZg9DAJavailable_stock: 0reserved_quantity: 0total_on_hand: 0- product_name: Product 1059062+ product_name: Product 1091399delivery_profile_id: fp_UkLWZg9DAJmeta:page: 1@@ -23589,11 +23603,11 @@ paths:{ currency: 'USD', amount: '29.99', compare_at_amount: '34.99' },{ currency: 'EUR', amount: '27.99' },],- stock_items: [{ stock_location_id: 'sloc_UkLWZg9DAJ', count_on_hand: 25 }],+ stock_levels: [{ stock_location_id: 'sloc_UkLWZg9DAJ', count_on_hand: 25 }],})- lang: bashlabel: Spree CLI- source: spree api post /products/{product_id}/variants -d '{"sku":"TSHIRT-L-NAVY","options":[{"name":"size","value":"Large"},{"name":"color","value":"navy"}],"prices":[{"currency":"USD","amount":"29.99","compare_at_amount":"34.99"},{"currency":"EUR","amount":"27.99"}],"stock_items":[{"stock_location_id":"sloc_UkLWZg9DAJ","count_on_hand":25}]}'+ source: spree api post /products/{product_id}/variants -d '{"sku":"TSHIRT-L-NAVY","options":[{"name":"size","value":"Large"},{"name":"color","value":"navy"}],"prices":[{"currency":"USD","amount":"29.99","compare_at_amount":"34.99"},{"currency":"EUR","amount":"27.99"}],"stock_levels":[{"stock_location_id":"sloc_UkLWZg9DAJ","count_on_hand":25}]}'parameters:- name: x-spree-api-keyin: header@@ -23657,8 +23671,8 @@ paths:option_type_label: Sizeimage_url:metadata: {}- created_at: '2026-08-18T20:10:59.938Z'- updated_at: '2026-08-18T20:10:59.938Z'+ created_at: '2026-08-20T14:34:12.716Z'+ updated_at: '2026-08-20T14:34:12.716Z'metadata: {}position: 3cost_price:@@ -23671,14 +23685,14 @@ paths:country_of_origin:customs_description:deleted_at:- created_at: '2026-08-18T20:10:59.943Z'- updated_at: '2026-08-18T20:10:59.946Z'+ created_at: '2026-08-20T14:34:12.762Z'+ updated_at: '2026-08-20T14:34:12.773Z'preorderable: falsetax_category_id: taxcat_UkLWZg9DAJavailable_stock: 0reserved_quantity: 0total_on_hand: 0- product_name: Product 1064268+ product_name: Product 1107140delivery_profile_id: fp_UkLWZg9DAJ'422':description: validation error@@ -23764,7 +23778,7 @@ paths:type: stringnullable: trueexample: '39.99'- stock_items:+ stock_levels:type: arraydescription: Per-stock-location inventory. Upserted by stock_location_id.items:@@ -23805,11 +23819,11 @@ paths:})const variant = await client.products.variants.get('prod_86Rf07xd4z', 'variant_k5nR8xLq', {- expand: ['prices', 'stock_items'],+ expand: ['prices', 'stock_levels'],})- lang: bashlabel: Spree CLI- source: spree api get /products/{product_id}/variants/{id} -d '{"expand":["prices","stock_items"]}'+ source: spree api get /products/{product_id}/variants/{id} -d '{"expand":["prices","stock_levels"]}'parameters:- name: x-spree-api-keyin: header@@ -23838,7 +23852,8 @@ paths:in: queryrequired: falsedescription: Comma-separated associations to expand (e.g., images, prices,- stock_items, option_values). Use dot notation for nested expand (max 4 levels).+ stock_levels, option_values). Use dot notation for nested expand (max 4+ levels).schema:type: string- name: fields@@ -23856,7 +23871,7 @@ paths:example:id: variant_gbHJdmfrXBproduct_id: prod_UkLWZg9DAJ- sku: SKU-131+ sku: SKU-139options_text: 'Size: S'track_inventory: truemedia_count: 0@@ -23866,10 +23881,10 @@ paths:in_stock: falsebackorderable: truepreorder: false- weight: 118.81- height: 16.74- width: 160.21- depth: 131.52+ weight: 77.4+ height: 20.57+ width: 140.59+ depth: 52.27price:id: price_gbHJdmfrXBamount: '19.99'@@ -23885,16 +23900,16 @@ paths:option_values:- id: optval_UkLWZg9DAJoption_type_id: opt_UkLWZg9DAJ- name: size-22+ name: size-26label: Sposition: 1color_code:- option_type_name: foo-size-31+ option_type_name: foo-size-35option_type_label: Sizeimage_url:metadata: {}- created_at: '2026-08-18T20:11:00.405Z'- updated_at: '2026-08-18T20:11:00.405Z'+ created_at: '2026-08-20T14:34:13.272Z'+ updated_at: '2026-08-20T14:34:13.272Z'metadata: {}position: 2cost_price: '17.0'@@ -23907,14 +23922,14 @@ paths:country_of_origin:customs_description:deleted_at:- created_at: '2026-08-18T20:11:00.402Z'- updated_at: '2026-08-18T20:11:00.416Z'+ created_at: '2026-08-20T14:34:13.268Z'+ updated_at: '2026-08-20T14:34:13.300Z'preorderable: falsetax_category_id: taxcat_UkLWZg9DAJavailable_stock: 0reserved_quantity: 0total_on_hand: 0- product_name: Product 108738+ product_name: Product 1127387delivery_profile_id: fp_UkLWZg9DAJ'404':description: variant not found@@ -23950,13 +23965,11 @@ paths:const variant = await client.products.variants.update('prod_86Rf07xd4z', 'variant_k5nR8xLq', {sku: 'UPDATED-SKU',- stock_items: [- { stock_location_id: 'sloc_UkLWZg9DAJ', count_on_hand: 75 },- ],+ stock_levels: [{ stock_location_id: 'sloc_UkLWZg9DAJ', count_on_hand: 75 }],})- lang: bashlabel: Spree CLI- source: spree api patch /products/{product_id}/variants/{id} -d '{"sku":"UPDATED-SKU","stock_items":[{"stock_location_id":"sloc_UkLWZg9DAJ","count_on_hand":75}]}'+ source: spree api patch /products/{product_id}/variants/{id} -d '{"sku":"UPDATED-SKU","stock_levels":[{"stock_location_id":"sloc_UkLWZg9DAJ","count_on_hand":75}]}'parameters:- name: x-spree-api-keyin: header@@ -23999,10 +24012,10 @@ paths:in_stock: falsebackorderable: truepreorder: false- weight: 93.9- height: 182.5- width: 26.16- depth: 181.45+ weight: 156.86+ height: 164.63+ width: 167.42+ depth: 97.24price:id: price_gbHJdmfrXBamount: '19.99'@@ -24018,16 +24031,16 @@ paths:option_values:- id: optval_UkLWZg9DAJoption_type_id: opt_UkLWZg9DAJ- name: size-24+ name: size-28label: Sposition: 1color_code:- option_type_name: foo-size-33+ option_type_name: foo-size-37option_type_label: Sizeimage_url:metadata: {}- created_at: '2026-08-18T20:11:00.619Z'- updated_at: '2026-08-18T20:11:00.619Z'+ created_at: '2026-08-20T14:34:13.798Z'+ updated_at: '2026-08-20T14:34:13.798Z'metadata: {}position: 2cost_price: '17.0'@@ -24040,14 +24053,14 @@ paths:country_of_origin:customs_description:deleted_at:- created_at: '2026-08-18T20:11:00.616Z'- updated_at: '2026-08-18T20:11:00.649Z'+ created_at: '2026-08-20T14:34:13.795Z'+ updated_at: '2026-08-20T14:34:13.833Z'preorderable: falsetax_category_id: taxcat_UkLWZg9DAJavailable_stock: 0reserved_quantity: 0total_on_hand: 0- product_name: Product 1105374+ product_name: Product 1142592delivery_profile_id: fp_UkLWZg9DAJrequestBody:content:@@ -24120,7 +24133,7 @@ paths:type: stringnullable: trueexample: '39.99'- stock_items:+ stock_levels:type: arraydescription: Per-stock-location inventory. Upserted by stock_location_id.items:@@ -24293,9 +24306,9 @@ paths:request_errors:response_body:success: false- created_at: '2026-08-18T20:11:01.089Z'- updated_at: '2026-08-18T20:11:01.089Z'- delivered_at: '2026-08-18T20:11:01.088Z'+ created_at: '2026-08-20T14:34:14.247Z'+ updated_at: '2026-08-20T14:34:14.247Z'+ delivered_at: '2026-08-20T14:34:14.247Z'payload:event: order.createddata:@@ -24311,9 +24324,9 @@ paths:request_errors:response_body:success: true- created_at: '2026-08-18T20:11:01.087Z'- updated_at: '2026-08-18T20:11:01.087Z'- delivered_at: '2026-08-18T20:11:01.087Z'+ created_at: '2026-08-20T14:34:14.245Z'+ updated_at: '2026-08-20T14:34:14.245Z'+ delivered_at: '2026-08-20T14:34:14.245Z'payload:event: order.createddata:@@ -24416,9 +24429,9 @@ paths:request_errors:response_body:success: false- created_at: '2026-08-18T20:11:01.494Z'- updated_at: '2026-08-18T20:11:01.494Z'- delivered_at: '2026-08-18T20:11:01.494Z'+ created_at: '2026-08-20T14:34:14.620Z'+ updated_at: '2026-08-20T14:34:14.620Z'+ delivered_at: '2026-08-20T14:34:14.620Z'payload:event: order.createddata:@@ -24507,8 +24520,8 @@ paths:request_errors:response_body:success:- created_at: '2026-08-18T20:11:01.843Z'- updated_at: '2026-08-18T20:11:01.843Z'+ created_at: '2026-08-20T14:34:14.997Z'+ updated_at: '2026-08-20T14:34:14.997Z'delivered_at:payload:event: order.created@@ -24611,8 +24624,8 @@ paths:- order.completed- product.createddisabled_reason:- created_at: '2026-08-18T20:11:02.072Z'- updated_at: '2026-08-18T20:11:02.072Z'+ created_at: '2026-08-20T14:34:15.142Z'+ updated_at: '2026-08-20T14:34:15.142Z'disabled_at:secret_key:last_delivery_at:@@ -24707,10 +24720,10 @@ paths:subscriptions:- order.placeddisabled_reason:- created_at: '2026-08-18T20:11:02.589Z'- updated_at: '2026-08-18T20:11:02.589Z'+ created_at: '2026-08-20T14:34:15.387Z'+ updated_at: '2026-08-20T14:34:15.387Z'disabled_at:- secret_key: 3e51d901fbe3e9c732a239fe6c272bdecbc16d35d2949b49bfd3fa1d8d424412+ secret_key: 90eee345da63c9c2af0d75fac3259afcd7f09695df45d28b798e25d803c99380last_delivery_at:recent_delivery_count: 0recent_failure_count: 0@@ -24833,8 +24846,8 @@ paths:- order.completed- product.createddisabled_reason:- created_at: '2026-08-18T20:11:02.894Z'- updated_at: '2026-08-18T20:11:02.894Z'+ created_at: '2026-08-20T14:34:15.532Z'+ updated_at: '2026-08-20T14:34:15.532Z'disabled_at:secret_key:last_delivery_at:@@ -24913,8 +24926,8 @@ paths:- order.completed- product.createddisabled_reason:- created_at: '2026-08-18T20:11:03.319Z'- updated_at: '2026-08-18T20:11:03.348Z'+ created_at: '2026-08-20T14:34:15.712Z'+ updated_at: '2026-08-20T14:34:15.749Z'disabled_at:secret_key:last_delivery_at:@@ -25071,13 +25084,13 @@ paths:request_errors:response_body:success:- created_at: '2026-08-18T20:11:04.075Z'- updated_at: '2026-08-18T20:11:04.075Z'+ created_at: '2026-08-20T14:34:15.935Z'+ updated_at: '2026-08-20T14:34:15.935Z'delivered_at:payload:- id: 5282d0d7-e410-401c-a97b-98734cd91840+ id: e3ebb508-c19e-4638-b313-43966d0cbb68name: webhook.test- created_at: '2026-08-18T20:11:04Z'+ created_at: '2026-08-20T14:34:15Z'data:message: This is a test webhook from Spree.metadata:@@ -25146,8 +25159,8 @@ paths:- order.completed- product.createddisabled_reason:- created_at: '2026-08-18T20:11:04.260Z'- updated_at: '2026-08-18T20:11:04.278Z'+ created_at: '2026-08-20T14:34:15.959Z'+ updated_at: '2026-08-20T14:34:15.996Z'disabled_at:secret_key:last_delivery_at:@@ -25224,9 +25237,9 @@ paths:- order.completed- product.createddisabled_reason: Investigating- created_at: '2026-08-18T20:11:04.566Z'- updated_at: '2026-08-18T20:11:04.584Z'- disabled_at: '2026-08-18T20:11:04.584Z'+ created_at: '2026-08-20T14:34:16.016Z'+ updated_at: '2026-08-20T14:34:16.117Z'+ disabled_at: '2026-08-20T14:34:16.117Z'secret_key:last_delivery_at:recent_delivery_count: 0@@ -25309,8 +25322,8 @@ paths:automatic: falserules_match_policy: allmetadata: {}- created_at: '2026-08-18T20:09:58.052Z'- updated_at: '2026-08-18T20:09:58.052Z'+ created_at: '2026-08-20T14:33:20.179Z'+ updated_at: '2026-08-20T14:33:20.179Z'meta:page: 1limit: 25@@ -25378,8 +25391,8 @@ paths:automatic: truerules_match_policy: anymetadata: {}- created_at: '2026-08-18T20:09:58.153Z'- updated_at: '2026-08-18T20:09:58.154Z'+ created_at: '2026-08-20T14:33:20.321Z'+ updated_at: '2026-08-20T14:33:20.322Z'schema:"$ref": "#/components/schemas/Collection"'422':@@ -25506,8 +25519,8 @@ paths:automatic: falserules_match_policy: allmetadata: {}- created_at: '2026-08-18T20:09:58.418Z'- updated_at: '2026-08-18T20:09:58.418Z'+ created_at: '2026-08-20T14:33:20.413Z'+ updated_at: '2026-08-20T14:33:20.413Z'schema:"$ref": "#/components/schemas/Collection"'404':@@ -25571,8 +25584,8 @@ paths:automatic: falserules_match_policy: allmetadata: {}- created_at: '2026-08-18T20:09:58.716Z'- updated_at: '2026-08-18T20:09:58.747Z'+ created_at: '2026-08-20T14:33:20.546Z'+ updated_at: '2026-08-20T14:33:20.582Z'schema:"$ref": "#/components/schemas/Collection"requestBody:@@ -25747,8 +25760,8 @@ paths:application/json:example:id: prod_UkLWZg9DAJ- name: Product 63406- slug: product-63406+ name: Product 6178+ slug: product-6178meta_title:meta_description:meta_keywords:@@ -25760,14 +25773,15 @@ paths:in_stock: falsebackorderable: trueavailable: true- description: Impedit nostrum ea soluta dolorem totam corporis beatae.- Rem adipisci eum quasi officiis assumenda quos. Quaerat numquam- totam soluta repellat ducimus. Fugit iusto at reiciendis beatae- unde officiis.- description_html: Impedit nostrum ea soluta dolorem totam corporis- beatae. Rem adipisci eum quasi officiis assumenda quos. Quaerat- numquam totam soluta repellat ducimus. Fugit iusto at reiciendis- beatae unde officiis.+ description: Quas omnis impedit molestiae quod rerum tempore. Corrupti+ expedita esse possimus omnis reiciendis. Harum ratione nihil officia+ deleniti distinctio atque. Explicabo quia harum tempora non minima+ atque. Quos eaque reprehenderit amet esse. Voluptatibus nam sequi+ iste suscipit maxime repellendus reiciendis quaerat. Natus similique+ dicta voluptas occaecati a libero.+ description_html: |-+ Quas omnis impedit molestiae quod rerum tempore. Corrupti expedita esse possimus omnis reiciendis. Harum ratione nihil officia deleniti distinctio atque.+ Explicabo quia harum tempora non minima atque. Quos eaque reprehenderit amet esse. Voluptatibus nam sequi iste suscipit maxime repellendus reiciendis quaerat. Natus similique dicta voluptas occaecati a libero.default_variant_id: variant_UkLWZg9DAJbuy_box_variant_id: variant_UkLWZg9DAJthumbnail_url:@@ -25783,15 +25797,15 @@ paths:display_compare_at_amount:price_list_id:variant_id: variant_UkLWZg9DAJ- created_at: '2026-08-18T20:09:59.046Z'- updated_at: '2026-08-18T20:09:59.046Z'+ created_at: '2026-08-20T14:33:20.734Z'+ updated_at: '2026-08-20T14:33:20.734Z'original_price:seller_id:status: activemetadata: {}deleted_at:- created_at: '2026-08-18T20:09:59.022Z'- updated_at: '2026-08-18T20:09:59.153Z'+ created_at: '2026-08-20T14:33:20.719Z'+ updated_at: '2026-08-20T14:33:20.743Z'delivery_profile_id: fp_UkLWZg9DAJseller_name:product_type_id:@@ -26038,8 +26052,8 @@ paths:taxability_reason:country_code:state_code:- created_at: '2026-08-18T20:10:00.536Z'- updated_at: '2026-08-18T20:10:00.536Z'+ created_at: '2026-08-20T14:33:21.351Z'+ updated_at: '2026-08-20T14:33:21.351Z'rate: '10.0'tax_rate: '0.0'amount: '10.0'@@ -26125,8 +26139,8 @@ paths:taxability_reason:country_code:state_code:- created_at: '2026-08-18T20:10:01.090Z'- updated_at: '2026-08-18T20:10:01.090Z'+ created_at: '2026-08-20T14:33:21.621Z'+ updated_at: '2026-08-20T14:33:21.621Z'rate: '10.0'tax_rate: '0.0'amount: '10.0'@@ -26251,8 +26265,8 @@ paths:include_shipping: falsemetadata: {}deleted_at:- created_at: '2026-08-18T20:10:01.577Z'- updated_at: '2026-08-18T20:10:01.577Z'+ created_at: '2026-08-20T14:33:21.866Z'+ updated_at: '2026-08-20T14:33:21.866Z'value: '10.0'commission_tax_rate:amounts: {}@@ -26367,8 +26381,8 @@ paths:include_shipping: falsemetadata: {}deleted_at:- created_at: '2026-08-18T20:10:01.808Z'- updated_at: '2026-08-18T20:10:01.808Z'+ created_at: '2026-08-20T14:33:22.018Z'+ updated_at: '2026-08-20T14:33:22.018Z'value: '12.5'commission_tax_rate:amounts: {}@@ -26651,8 +26665,8 @@ paths:include_shipping: falsemetadata: {}deleted_at:- created_at: '2026-08-18T20:10:02.025Z'- updated_at: '2026-08-18T20:10:02.025Z'+ created_at: '2026-08-20T14:33:22.137Z'+ updated_at: '2026-08-20T14:33:22.137Z'value: '10.0'commission_tax_rate:amounts: {}@@ -26739,8 +26753,8 @@ paths:include_shipping: falsemetadata: {}deleted_at:- created_at: '2026-08-18T20:10:02.243Z'- updated_at: '2026-08-18T20:10:02.315Z'+ created_at: '2026-08-20T14:33:22.288Z'+ updated_at: '2026-08-20T14:33:22.319Z'value: '15.0'commission_tax_rate:amounts: {}@@ -26878,8 +26892,8 @@ paths:name: Berlinexternal_id:metadata: {}- created_at: '2026-08-18T20:10:02.527Z'- updated_at: '2026-08-18T20:10:02.527Z'+ created_at: '2026-08-20T14:33:22.380Z'+ updated_at: '2026-08-20T14:33:22.380Z'company_id: comp_UkLWZg9DAJcontacts_count: 0billing_address:@@ -26958,8 +26972,8 @@ paths:name: Hamburg warehouseexternal_id:metadata: {}- created_at: '2026-08-18T20:10:02.723Z'- updated_at: '2026-08-18T20:10:02.723Z'+ created_at: '2026-08-20T14:33:22.500Z'+ updated_at: '2026-08-20T14:33:22.500Z'company_id: comp_UkLWZg9DAJcontacts_count: 0billing_address:@@ -26985,8 +26999,10 @@ paths:state_name:label:metadata: {}- created_at: '2026-08-18T20:10:02.722Z'- updated_at: '2026-08-18T20:10:02.722Z'+ created_at: '2026-08-20T14:33:22.500Z'+ updated_at: '2026-08-20T14:33:22.500Z'+ latitude:+ longitude:customer_id:shipping_address:'422':@@ -27085,8 +27101,8 @@ paths:name: Berlinexternal_id:metadata: {}- created_at: '2026-08-18T20:10:02.757Z'- updated_at: '2026-08-18T20:10:02.757Z'+ created_at: '2026-08-20T14:33:22.562Z'+ updated_at: '2026-08-20T14:33:22.562Z'company_id: comp_UkLWZg9DAJcontacts_count: 0billing_address:@@ -27132,8 +27148,8 @@ paths:name: Berlin Mitteexternal_id:metadata: {}- created_at: '2026-08-18T20:10:02.895Z'- updated_at: '2026-08-18T20:10:02.916Z'+ created_at: '2026-08-20T14:33:22.601Z'+ updated_at: '2026-08-20T14:33:22.628Z'company_id: comp_UkLWZg9DAJcontacts_count: 0billing_address:@@ -27248,8 +27264,8 @@ paths:issued_at:expires_at:verified_at:- created_at: '2026-08-18T20:10:03.138Z'- updated_at: '2026-08-18T20:10:03.138Z'+ created_at: '2026-08-20T14:33:22.698Z'+ updated_at: '2026-08-20T14:33:22.698Z'company_id: comp_UkLWZg9DAJcountry_code:state_code:@@ -27333,8 +27349,8 @@ paths:issued_at:expires_at:verified_at:- created_at: '2026-08-18T20:10:03.477Z'- updated_at: '2026-08-18T20:10:03.481Z'+ created_at: '2026-08-20T14:33:22.791Z'+ updated_at: '2026-08-20T14:33:22.795Z'company_id: comp_UkLWZg9DAJcountry_code: DEstate_code:@@ -27463,9 +27479,9 @@ paths:metadata: {}issued_at:expires_at:- verified_at: '2026-08-18T20:10:04.095Z'- created_at: '2026-08-18T20:10:03.920Z'- updated_at: '2026-08-18T20:10:04.100Z'+ verified_at: '2026-08-20T14:33:22.924Z'+ created_at: '2026-08-20T14:33:22.904Z'+ updated_at: '2026-08-20T14:33:22.925Z'company_id: comp_UkLWZg9DAJcountry_code:state_code:@@ -27543,9 +27559,9 @@ paths:metadata: {}issued_at:expires_at:- verified_at: '2026-08-18T20:10:04.238Z'- created_at: '2026-08-18T20:10:04.238Z'- updated_at: '2026-08-18T20:10:04.365Z'+ verified_at: '2026-08-20T14:33:22.950Z'+ created_at: '2026-08-20T14:33:22.950Z'+ updated_at: '2026-08-20T14:33:22.981Z'company_id: comp_UkLWZg9DAJcountry_code:state_code:@@ -27663,8 +27679,8 @@ paths:validation_evidence:source:validated_at:- created_at: '2026-08-18T20:10:04.610Z'- updated_at: '2026-08-18T20:10:04.610Z'+ created_at: '2026-08-20T14:33:23.100Z'+ updated_at: '2026-08-20T14:33:23.100Z'validatable: falsecustomer_id:cart_id:@@ -27726,8 +27742,8 @@ paths:validation_evidence:source:validated_at:- created_at: '2026-08-18T20:10:04.794Z'- updated_at: '2026-08-18T20:10:04.794Z'+ created_at: '2026-08-20T14:33:23.168Z'+ updated_at: '2026-08-20T14:33:23.168Z'validatable: falsecustomer_id:cart_id:@@ -27874,8 +27890,8 @@ paths:name: Acme Industrialexternal_id: ACME-1metadata: {}- created_at: '2026-08-18T20:10:04.974Z'- updated_at: '2026-08-18T20:10:04.974Z'+ created_at: '2026-08-20T14:33:23.344Z'+ updated_at: '2026-08-20T14:33:23.344Z'locations_count: 0meta:page: 1@@ -27937,8 +27953,8 @@ paths:name: Globex Corporationexternal_id: GLBX-42metadata: {}- created_at: '2026-08-18T20:10:05.240Z'- updated_at: '2026-08-18T20:10:05.240Z'+ created_at: '2026-08-20T14:33:23.431Z'+ updated_at: '2026-08-20T14:33:23.431Z'locations_count: 0'422':description: invalid request@@ -28020,8 +28036,8 @@ paths:data:- id: cc_UkLWZg9DAJrole: buyer- created_at: '2026-08-18T20:10:05.476Z'- updated_at: '2026-08-18T20:10:05.476Z'+ created_at: '2026-08-20T14:33:23.524Z'+ updated_at: '2026-08-20T14:33:23.524Z'company_location_id: cloc_UkLWZg9DAJcustomer_id: cust_UkLWZg9DAJemail: [email protected]@@ -28077,11 +28093,11 @@ paths:example:id: cc_gbHJdmfrXBrole: admin- created_at: '2026-08-18T20:10:05.629Z'- updated_at: '2026-08-18T20:10:05.629Z'+ created_at: '2026-08-20T14:33:23.607Z'+ updated_at: '2026-08-20T14:33:23.607Z'company_location_id: cloc_UkLWZg9DAJcustomer_id: cust_gbHJdmfrXB- email: [email protected]+ email: [email protected]'422':description: invalid requestcontent:@@ -28156,8 +28172,8 @@ paths:example:id: cc_UkLWZg9DAJrole: buyer- created_at: '2026-08-18T20:10:05.857Z'- updated_at: '2026-08-18T20:10:05.857Z'+ created_at: '2026-08-20T14:33:23.694Z'+ updated_at: '2026-08-20T14:33:23.694Z'company_location_id: cloc_UkLWZg9DAJcustomer_id: cust_UkLWZg9DAJemail: [email protected]@@ -28191,6 +28207,140 @@ paths:responses:'204':description: contact deleted+ "/api/v3/admin/custom_field_definitions/resource_types":+ get:+ summary: List what custom fields can be attached to+ tags:+ - Custom Field Definitions+ security:+ - api_key: []+ bearer_auth: []+ description: |-+ The resources a definition can describe, from the server's own+ registry (`Spree.custom_fields.enabled_resources`).++ Read this rather than carrying a list: a resource an extension+ registers appears here without a client release, and a `resource_type`+ that is not listed is refused on create.++ `resource_type` is the value to send; `name` is what a merchant calls+ it. The two differ where a class has been renamed — categories are+ stored under `Spree::Taxon` and shown as "Categories" — so send the+ value back verbatim rather than deriving it from the name.+++ **Required scope:** `read_settings` (for API-key authentication).+ x-codeSamples:+ - lang: javascript+ label: Spree Admin SDK+ source: |-+ import { createAdminClient } from '@spree/admin-sdk'++ const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+ })++ // What a definition can be attached to. Comes from the server's registry, so+ // a resource an extension adds shows up here without a client release.+ const { data: resourceTypes } = await client.customFieldDefinitions.resourceTypes()+ - lang: bash+ label: Spree CLI+ source: spree api get /custom_field_definitions/resource_types+ parameters:+ - name: x-spree-api-key+ in: header+ required: true+ schema:+ type: string+ - name: Authorization+ in: header+ required: true+ schema:+ type: string+ responses:+ '200':+ description: resource types found+ content:+ application/json:+ example:+ data:+ - resource_type: Spree::Address+ name: Addresses+ - resource_type: Spree::Taxon+ name: Categories+ - resource_type: Spree::Claim+ name: Claims+ - resource_type: Spree::Collection+ name: Collections+ - resource_type: Spree::CreditCard+ name: Credit Cards+ - resource_type: Spree::Customer+ name: Customers+ - resource_type: Spree::DeliveryMethod+ name: Delivery Methods+ - resource_type: Spree::Exchange+ name: Exchanges+ - resource_type: Spree::Fulfillment+ name: Fulfillments+ - resource_type: Spree::GiftCard+ name: Gift Cards+ - resource_type: Spree::LineItem+ name: Line Items+ - resource_type: Spree::Media+ name: Media+ - resource_type: Spree::NewsletterSubscriber+ name: Newsletter Subscribers+ - resource_type: Spree::OptionType+ name: Option Types+ - resource_type: Spree::OptionValue+ name: Option Values+ - resource_type: Spree::Order+ name: Orders+ - resource_type: Spree::PaymentMethod+ name: Payment Methods+ - resource_type: Spree::PaymentSource+ name: Payment Sources+ - resource_type: Spree::Payment+ name: Payments+ - resource_type: Spree::ProductType+ name: Product Types+ - resource_type: Spree::Product+ name: Products+ - resource_type: Spree::Promotion+ name: Promotions+ - resource_type: Spree::Refund+ name: Refunds+ - resource_type: Spree::Return+ name: Returns+ - resource_type: Spree::Seller+ name: Sellers+ - resource_type: Spree::StockLevel+ name: Stock Levels+ - resource_type: Spree::StockTransfer+ name: Stock Transfers+ - resource_type: Spree::StoreCredit+ name: Store Credits+ - resource_type: Spree::Store+ name: Stores+ - resource_type: Spree::TaxRate+ name: Tax Rates+ - resource_type: Spree::Variant+ name: Variants+ schema:+ type: object+ properties:+ data:+ type: array+ items:+ type: object+ properties:+ resource_type:+ type: string+ example: Spree::Seller+ name:+ type: string+ example: Sellers"/api/v3/admin/delivery_profiles":get:summary: List delivery profiles@@ -28240,8 +28390,8 @@ paths:name: Generaldefault: trueposition: 1- created_at: '2026-08-18T20:09:51.565Z'- updated_at: '2026-08-18T20:09:51.565Z'+ created_at: '2026-08-20T14:33:15.133Z'+ updated_at: '2026-08-20T14:33:15.133Z'kind: shippingdigital: falseoffers_pickup: false@@ -28312,11 +28462,11 @@ paths:application/json:example:id: fp_gbHJdmfrXB- name: Oversized 1787083811.1511612+ name: Oversized 1787236406.677613default: falseposition: 2- created_at: '2026-08-18T20:10:11.155Z'- updated_at: '2026-08-18T20:10:11.155Z'+ created_at: '2026-08-20T14:33:26.682Z'+ updated_at: '2026-08-20T14:33:26.682Z'kind: shippingdigital: falseoffers_pickup: false@@ -28420,8 +28570,8 @@ paths:id: og_EfhxLZ9ck8name: EU warehouseposition: 2- created_at: '2026-08-18T20:10:11.435Z'- updated_at: '2026-08-18T20:10:11.435Z'+ created_at: '2026-08-20T14:33:26.777Z'+ updated_at: '2026-08-20T14:33:26.777Z'delivery_profile_id: fp_gbHJdmfrXBstock_location_ids:- sloc_UkLWZg9DAJ@@ -28496,11 +28646,11 @@ paths:application/json:example:id: fp_gbHJdmfrXB- name: Bulky 1787083811.538343+ name: Bulky 1787236406.78592default: falseposition: 2- created_at: '2026-08-18T20:10:11.539Z'- updated_at: '2026-08-18T20:10:11.539Z'+ created_at: '2026-08-20T14:33:26.786Z'+ updated_at: '2026-08-20T14:33:26.786Z'kind: shippingdigital: falseoffers_pickup: false@@ -28631,8 +28781,8 @@ paths:tracking_url:markup_flat: '0.0'markup_percent: '0.0'- created_at: '2026-08-18T20:10:11.791Z'- updated_at: '2026-08-18T20:10:11.792Z'+ created_at: '2026-08-20T14:33:26.962Z'+ updated_at: '2026-08-20T14:33:26.977Z'deleted_at:services: []rules: []@@ -28720,8 +28870,8 @@ paths:tracking_url:markup_flat: '0.0'markup_percent: '0.0'- created_at: '2026-08-18T20:10:11.907Z'- updated_at: '2026-08-18T20:10:11.911Z'+ created_at: '2026-08-20T14:33:27.164Z'+ updated_at: '2026-08-20T14:33:27.165Z'deleted_at:services: []rules: []@@ -28851,6 +29001,9 @@ paths:- type: Spree::Calculator::Shipping::FlexiRatename: Flexible Rate per package itempreference_schema:+ - key: first_item+ type: decimal+ default: 0.0- key: additional_itemtype: decimaldefault: 0.0@@ -28860,21 +29013,18 @@ paths:- key: currencytype: stringdefault: USD- - key: first_item- type: decimal- default: 0.0- type: Spree::Calculator::Shipping::PerItemname: Flat rate per package itempreference_schema:+ - key: currency+ type: string+ default: USD- key: amountstype: hashdefault: {}- key: amounttype: decimaldefault: 0- - key: currency- type: string- default: USD- type: Spree::Calculator::Shipping::PriceSackname: Price sackpreference_schema:@@ -28884,24 +29034,24 @@ paths:- key: normal_amounttype: decimaldefault: 0- - key: currency- type: string- default: USD- key: discount_amounttype: decimaldefault: 0+ - key: currency+ type: string+ default: USD- type: Spree::Calculator::Shipping::DigitalDeliveryname: Digital Deliverypreference_schema:+ - key: currency+ type: string+ default: USD- key: amountstype: hashdefault: {}- key: amounttype: decimaldefault: 0- - key: currency- type: string- default: USD"/api/v3/admin/delivery_zones":post:summary: Create delivery zone@@ -28971,8 +29121,8 @@ paths:postal_code_to:country_name: United Statesstate_name:- created_at: '2026-08-18T20:10:12.338Z'- updated_at: '2026-08-18T20:10:12.338Z'+ created_at: '2026-08-20T14:33:27.273Z'+ updated_at: '2026-08-20T14:33:27.273Z'- id: dzm_gbHJdmfrXBmember_type: postal_codecountry_code: US@@ -28982,10 +29132,10 @@ paths:postal_code_to:country_name: United Statesstate_name:- created_at: '2026-08-18T20:10:12.338Z'- updated_at: '2026-08-18T20:10:12.338Z'- created_at: '2026-08-18T20:10:12.337Z'- updated_at: '2026-08-18T20:10:12.337Z'+ created_at: '2026-08-20T14:33:27.274Z'+ updated_at: '2026-08-20T14:33:27.274Z'+ created_at: '2026-08-20T14:33:27.266Z'+ updated_at: '2026-08-20T14:33:27.266Z'delivery_profile_id: fp_UkLWZg9DAJdelivery_origin_group_id: og_UkLWZg9DAJdelivery_method_ids: []@@ -29080,8 +29230,8 @@ paths:- id: int_UkLWZg9DAJname: Carrieractive: false- created_at: '2026-08-18T20:10:17.208Z'- updated_at: '2026-08-18T20:10:17.208Z'+ created_at: '2026-08-20T14:33:29.418Z'+ updated_at: '2026-08-20T14:33:29.418Z'type: carriergroup: shippingpreferences:@@ -29153,8 +29303,8 @@ paths:id: int_UkLWZg9DAJname: Carrieractive: false- created_at: '2026-08-18T20:10:17.335Z'- updated_at: '2026-08-18T20:10:17.335Z'+ created_at: '2026-08-20T14:33:29.482Z'+ updated_at: '2026-08-20T14:33:29.482Z'type: carriergroup: shippingpreferences:@@ -29346,8 +29496,8 @@ paths:- id: pt_UkLWZg9DAJname: T-Shirtproducts_count: 0- created_at: '2026-08-18T20:10:49.281Z'- updated_at: '2026-08-18T20:10:49.281Z'+ created_at: '2026-08-20T14:33:52.369Z'+ updated_at: '2026-08-20T14:33:52.369Z'delivery_profile_id:option_type_ids: []category_ids: []@@ -29422,8 +29572,8 @@ paths:id: pt_gbHJdmfrXBname: Hoodieproducts_count: 0- created_at: '2026-08-18T20:10:49.399Z'- updated_at: '2026-08-18T20:10:49.399Z'+ created_at: '2026-08-20T14:33:52.593Z'+ updated_at: '2026-08-20T14:33:52.593Z'delivery_profile_id:option_type_ids: []category_ids: []@@ -29523,8 +29673,8 @@ paths:id: pt_UkLWZg9DAJname: T-Shirtproducts_count: 0- created_at: '2026-08-18T20:10:49.468Z'- updated_at: '2026-08-18T20:10:49.468Z'+ created_at: '2026-08-20T14:33:52.683Z'+ updated_at: '2026-08-20T14:33:52.683Z'delivery_profile_id:option_type_ids: []category_ids: []@@ -29577,8 +29727,8 @@ paths:id: pt_UkLWZg9DAJname: Premium T-Shirtproducts_count: 0- created_at: '2026-08-18T20:10:49.558Z'- updated_at: '2026-08-18T20:10:49.583Z'+ created_at: '2026-08-20T14:33:52.889Z'+ updated_at: '2026-08-20T14:33:52.932Z'delivery_profile_id:option_type_ids: []category_ids: []@@ -29691,6 +29841,604 @@ paths:properties:products_count:type: integer+ "/api/v3/admin/seller_requirements":+ get:+ summary: List seller requirements+ tags:+ - Seller Requirements+ security:+ - api_key: []+ bearer_auth: []+ description: |-+ What this marketplace asks of a seller before it will let them trade,+ in the order sellers work through it.++ Each row is one configured requirement. `required` says whether it+ stands between the seller and approval — the others are shown as+ recommended and counted in their progress, but never block. `active`+ switches one off without losing how it was worded.+++ **Required scope:** `read_sellers` (for API-key authentication).+ x-codeSamples:+ - lang: javascript+ label: Spree Admin SDK+ source: |-+ import { createAdminClient } from '@spree/admin-sdk'++ const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+ })++ // The checklist in the order sellers work through it. `required` items block+ // approval; the rest are shown as recommended.+ const { data: sellerRequirements } = await client.sellerRequirements.list({ page: 1, limit: 25 })+ - lang: bash+ label: Spree CLI+ source: spree api get /seller_requirements -d '{"page":1,"limit":25}'+ parameters:+ - name: x-spree-api-key+ in: header+ required: true+ schema:+ type: string+ - name: Authorization+ in: header+ required: true+ schema:+ type: string+ - name: page+ in: query+ required: false+ schema:+ type: integer+ - name: limit+ in: query+ required: false+ schema:+ type: integer+ responses:+ '200':+ description: seller requirements found+ content:+ application/json:+ example:+ data:+ - id: selreq_UkLWZg9DAJ+ position: 1+ active: true+ required: true+ metadata: {}+ created_at: '2026-08-20T14:34:04.727Z'+ updated_at: '2026-08-20T14:34:04.727Z'+ kind: accept_terms+ name: Accept terms+ description: The seller has accepted your marketplace terms+ preferences:+ terms_effective_from:+ custom_field_definition_ids: []+ allow_multiple: false+ accepts_submissions: false+ reviewed_by_operator: false+ meta:+ page: 1+ limit: 25+ count: 1+ pages: 1+ from: 1+ to: 1+ in: 1+ previous:+ next:+ schema:+ type: object+ properties:+ data:+ type: array+ items:+ "$ref": "#/components/schemas/SellerRequirement"+ meta:+ "$ref": "#/components/schemas/PaginationMeta"+ post:+ summary: Add a seller requirement+ tags:+ - Seller Requirements+ security:+ - api_key: []+ bearer_auth: []+ description: |-+ Adds something the marketplace asks of its sellers.++ `type` comes from `GET /seller_requirements/types`, which also+ describes the configuration each kind takes. Most kinds answer one+ question and can be added once; the open-ended ones — a seller+ confirmation, a manual check, a document — carry the question in your+ own `name` and `description`, so a store may add as many as it needs.++ A kind that reads the seller's own data (their addresses, their+ products, whether they accepted the terms) needs nothing from the+ seller beyond doing it. The others wait for the seller to submit+ something, and the ones you review wait for you.+++ **Required scope:** `write_sellers` (for API-key authentication).+ x-codeSamples:+ - lang: javascript+ label: Spree Admin SDK+ source: |-+ import { createAdminClient } from '@spree/admin-sdk'++ const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+ })++ // Asks every seller for a business registration before they can be approved.+ // The wording is yours — `document` is one of the open-ended kinds, so a store+ // can add as many as it needs, each with its own instructions.+ const sellerRequirement = await client.sellerRequirements.create({+ type: 'document',+ name: 'Business registration',+ description: 'A copy of your certificate of incorporation.',+ required: true,+ preferences: { accepted_content_types: ['application/pdf'] },+ })+ - lang: bash+ label: Spree CLI+ source: spree api post /seller_requirements -d '{"type":"document","name":"Business+ registration","description":"A copy of your certificate of incorporation.","required":true,"preferences":{"accepted_content_types":["application/pdf"]}}'+ parameters:+ - name: x-spree-api-key+ in: header+ required: true+ schema:+ type: string+ - name: Authorization+ in: header+ required: true+ schema:+ type: string+ responses:+ '201':+ description: seller requirement created+ content:+ application/json:+ example:+ id: selreq_UkLWZg9DAJ+ position: 1+ active: true+ required: true+ metadata: {}+ created_at: '2026-08-20T14:34:04.875Z'+ updated_at: '2026-08-20T14:34:04.875Z'+ kind: document+ name: Business registration+ description: A file the seller uploads and you review+ preferences: {}+ custom_field_definition_ids: []+ allow_multiple: true+ accepts_submissions: true+ reviewed_by_operator: true+ schema:+ "$ref": "#/components/schemas/SellerRequirement"+ '422':+ description: kind is not registered+ content:+ application/json:+ example:+ error:+ code: unknown_seller_requirement_type+ message: Unknown type+ schema:+ "$ref": "#/components/schemas/ErrorResponse"+ requestBody:+ content:+ application/json:+ schema:+ type: object+ required:+ - type+ properties:+ type:+ type: string+ example: document+ description: The kind, from `GET /seller_requirements/types`.+ name:+ type: string+ example: Business registration+ description: What the seller sees. Required for kinds that can be+ added more than once, since the wording is the only thing telling+ them apart. Left blank on the others, the kind names itself.+ description:+ type: string+ example: A copy of your certificate of incorporation.+ description: Instructions shown to the seller.+ required:+ type: boolean+ example: true+ description: Whether this blocks approval. Off means recommended.+ active:+ type: boolean+ example: true+ position:+ type: integer+ example: 1+ description: Place in the checklist.+ preferences:+ type: object+ example:+ accepted_content_types:+ - application/pdf+ description: Configuration for this kind, per its `preference_schema`.+ "/api/v3/admin/seller_requirements/types":+ get:+ summary: List seller requirement kinds+ tags:+ - Seller Requirements+ security:+ - api_key: []+ bearer_auth: []+ description: |-+ The kinds you can add, and the shape of each one's configuration form.++ `configured` says the store already has this kind — meaningful only+ where `allow_multiple` is false. `accepts_submissions` says the seller+ records having done it rather than it being read from their data, and+ `reviewed_by_operator` says what they send waits for you.++ A marketplace that registers its own kind server-side sees it here+ without this endpoint changing.+++ **Required scope:** `read_sellers` (for API-key authentication).+ x-codeSamples:+ - lang: javascript+ label: Spree Admin SDK+ source: |-+ import { createAdminClient } from '@spree/admin-sdk'++ const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+ })++ // What you can ask for, and the configuration each kind takes. A kind your own+ // code registers server-side shows up here too.+ const { data: requirementTypes } = await client.sellerRequirements.types()+ - lang: bash+ label: Spree CLI+ source: spree api get /seller_requirements/types+ parameters:+ - name: x-spree-api-key+ in: header+ required: true+ schema:+ type: string+ - name: Authorization+ in: header+ required: true+ schema:+ type: string+ responses:+ '200':+ description: kinds found+ content:+ application/json:+ example:+ data:+ - type: accept_terms+ name: Accept terms+ description: The seller has accepted your marketplace terms+ allow_multiple: false+ accepts_submissions: false+ reviewed_by_operator: false+ configured: false+ addable: true+ accepted_content_types: []+ association_fields: []+ preference_schema:+ - key: terms_effective_from+ type: string+ default:+ - type: complete_profile+ name: Complete profile+ description: The seller has filled in their public profile+ allow_multiple: false+ accepts_submissions: false+ reviewed_by_operator: false+ configured: false+ addable: true+ accepted_content_types: []+ association_fields: []+ preference_schema:+ - key: require_contact_email+ type: boolean+ default: true+ - key: require_about+ type: boolean+ default: true+ - key: require_logo+ type: boolean+ default: true+ - key: require_cover_photo+ type: boolean+ default: false+ - type: billing_address+ name: Billing address+ description: The seller has given a billing address+ allow_multiple: false+ accepts_submissions: false+ reviewed_by_operator: false+ configured: false+ addable: true+ accepted_content_types: []+ association_fields: []+ preference_schema: []+ - type: returns_address+ name: Returns address+ description: The seller has given an address for customer returns+ allow_multiple: false+ accepts_submissions: false+ reviewed_by_operator: false+ configured: false+ addable: true+ accepted_content_types: []+ association_fields: []+ preference_schema: []+ - type: minimum_products+ name: Minimum products+ description: The seller has listed at least this many products+ allow_multiple: false+ accepts_submissions: false+ reviewed_by_operator: false+ configured: false+ addable: true+ accepted_content_types: []+ association_fields: []+ preference_schema:+ - key: minimum_count+ type: integer+ default: 1+ - type: required_custom_fields+ name: Required custom fields+ description: The seller has filled in the custom fields you ask+ for+ allow_multiple: false+ accepts_submissions: false+ reviewed_by_operator: false+ configured: false+ addable: true+ accepted_content_types: []+ association_fields:+ - custom_field_definition_ids+ preference_schema: []+ - type: attestation+ name: Seller confirmation+ description: Something you ask the seller to confirm themselves+ allow_multiple: true+ accepts_submissions: true+ reviewed_by_operator: false+ configured: false+ addable: true+ accepted_content_types: []+ association_fields: []+ preference_schema: []+ - type: operator_review+ name: Manual check+ description: Something you check by hand before admitting the seller+ allow_multiple: true+ accepts_submissions: true+ reviewed_by_operator: true+ configured: false+ addable: true+ accepted_content_types: []+ association_fields: []+ preference_schema: []+ - type: document+ name: Document+ description: A file the seller uploads and you review+ allow_multiple: true+ accepts_submissions: true+ reviewed_by_operator: true+ configured: false+ addable: true+ accepted_content_types:+ - application/pdf+ - image/jpeg+ - image/png+ - image/heic+ - image/webp+ - application/msword+ - application/vnd.openxmlformats-officedocument.wordprocessingml.document+ association_fields: []+ preference_schema: []+ schema:+ type: object+ properties:+ data:+ type: array+ items:+ type: object+ properties:+ type:+ type: string+ example: document+ name:+ type: string+ example: Document+ description:+ type: string+ example: A file the seller uploads and you review+ allow_multiple:+ type: boolean+ example: true+ accepts_submissions:+ type: boolean+ example: true+ reviewed_by_operator:+ type: boolean+ example: true+ configured:+ type: boolean+ example: false+ addable:+ type: boolean+ example: true+ description: Whether the operator may add one now. The uniqueness+ rule is the server's, so clients filter on this rather+ than deriving it.+ preference_schema:+ type: array+ items:+ type: object+ "/api/v3/admin/seller_requirements/{id}":+ parameters:+ - name: id+ in: path+ required: true+ schema:+ type: string+ patch:+ summary: Update a seller requirement+ tags:+ - Seller Requirements+ security:+ - api_key: []+ bearer_auth: []+ description: |-+ Changes how a requirement is worded, what it asks for, where it sits in+ the checklist, and whether it blocks approval.++ `type` is not accepted: a saved row's kind never changes, because+ anything a seller already submitted answered the old one.+++ **Required scope:** `write_sellers` (for API-key authentication).+ x-codeSamples:+ - lang: javascript+ label: Spree Admin SDK+ source: |-+ import { createAdminClient } from '@spree/admin-sdk'++ const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+ })++ // Asks for three products instead of one. Sellers who already met the old+ // number see this return to their checklist.+ const sellerRequirement = await client.sellerRequirements.update('selreq_a1b2c3', {+ preferences: { minimum_count: 3 },+ })+ - lang: bash+ label: Spree CLI+ source: spree api patch /seller_requirements/{id} -d '{"preferences":{"minimum_count":3}}'+ parameters:+ - name: x-spree-api-key+ in: header+ required: true+ schema:+ type: string+ - name: Authorization+ in: header+ required: true+ schema:+ type: string+ responses:+ '200':+ description: seller requirement updated+ content:+ application/json:+ example:+ id: selreq_UkLWZg9DAJ+ position: 1+ active: true+ required: true+ metadata: {}+ created_at: '2026-08-20T14:34:05.092Z'+ updated_at: '2026-08-20T14:34:05.163Z'+ kind: minimum_products+ name: Minimum products+ description: The seller has listed at least this many products+ preferences:+ minimum_count: 3+ custom_field_definition_ids: []+ allow_multiple: false+ accepts_submissions: false+ reviewed_by_operator: false+ schema:+ "$ref": "#/components/schemas/SellerRequirement"+ requestBody:+ content:+ application/json:+ schema:+ type: object+ properties:+ name:+ type: string+ example: Proof of business registration+ description:+ type: string+ example: A copy of your certificate of incorporation.+ required:+ type: boolean+ example: false+ active:+ type: boolean+ example: true+ position:+ type: integer+ example: 2+ preferences:+ type: object+ example:+ minimum_count: 3+ delete:+ summary: Delete a seller requirement+ tags:+ - Seller Requirements+ security:+ - api_key: []+ bearer_auth: []+ description: |-+ Stops asking for this. Anything sellers already submitted against it+ goes too — to keep the record while pausing the ask, set `active` to+ false instead.+++ **Required scope:** `write_sellers` (for API-key authentication).+ x-codeSamples:+ - lang: javascript+ label: Spree Admin SDK+ source: |-+ import { createAdminClient } from '@spree/admin-sdk'++ const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+ })++ // Stops asking for this, and deletes what sellers submitted against it. To+ // keep the record while pausing the ask, update it with `active: false`.+ await client.sellerRequirements.delete('selreq_a1b2c3')+ - lang: bash+ label: Spree CLI+ source: spree api delete /seller_requirements/{id}+ parameters:+ - name: x-spree-api-key+ in: header+ required: true+ schema:+ type: string+ - name: Authorization+ in: header+ required: true+ schema:+ type: string+ responses:+ '204':+ description: seller requirement deleted"/api/v3/admin/sellers":get:summary: List sellers@@ -29789,14 +30537,19 @@ paths:metadata: {}holiday_mode_until:terms_accepted_at:- created_at: '2026-08-18T20:10:56.545Z'- updated_at: '2026-08-18T20:10:56.545Z'+ created_at: '2026-08-20T14:34:05.324Z'+ updated_at: '2026-08-20T14:34:05.324Z'deleted_at:minimum_payout_amount:on_holiday: falsesellable: falseproducts_count: 0users_count: 0+ onboarding_progress:+ done: 0+ total: 0+ percentage: 100+ onboarding_complete: truemeta:page: 1limit: 25@@ -29899,14 +30652,19 @@ paths:metadata: {}holiday_mode_until:terms_accepted_at:- created_at: '2026-08-18T20:10:56.691Z'- updated_at: '2026-08-18T20:10:56.691Z'+ created_at: '2026-08-20T14:34:05.492Z'+ updated_at: '2026-08-20T14:34:05.492Z'deleted_at:minimum_payout_amount:on_holiday: falsesellable: falseproducts_count: 0users_count: 0+ onboarding_progress:+ done: 0+ total: 0+ percentage: 100+ onboarding_complete: trueschema:"$ref": "#/components/schemas/Seller"'422':@@ -30037,14 +30795,19 @@ paths:metadata: {}holiday_mode_until:terms_accepted_at:- created_at: '2026-08-18T20:10:56.742Z'- updated_at: '2026-08-18T20:10:56.742Z'+ created_at: '2026-08-20T14:34:05.579Z'+ updated_at: '2026-08-20T14:34:05.579Z'deleted_at:minimum_payout_amount:on_holiday: falsesellable: falseproducts_count: 0users_count: 0+ onboarding_progress:+ done: 0+ total: 0+ percentage: 100+ onboarding_complete: trueschema:"$ref": "#/components/schemas/Seller"'404':@@ -30125,14 +30888,19 @@ paths:metadata: {}holiday_mode_until:terms_accepted_at:- created_at: '2026-08-18T20:10:56.895Z'- updated_at: '2026-08-18T20:10:56.948Z'+ created_at: '2026-08-20T14:34:05.811Z'+ updated_at: '2026-08-20T14:34:05.891Z'deleted_at:minimum_payout_amount:on_holiday: falsesellable: falseproducts_count: 0users_count: 0+ onboarding_progress:+ done: 0+ total: 0+ percentage: 100+ onboarding_complete: truebilling_address:id: addr_UkLWZg9DAJfirst_name: Ada@@ -30156,8 +30924,10 @@ paths:state_name:label:metadata: {}- created_at: '2026-08-18T20:10:56.946Z'- updated_at: '2026-08-18T20:10:56.946Z'+ created_at: '2026-08-20T14:34:05.891Z'+ updated_at: '2026-08-20T14:34:05.891Z'+ latitude:+ longitude:customer_id:schema:"$ref": "#/components/schemas/Seller"@@ -30423,14 +31193,19 @@ paths:metadata: {}holiday_mode_until:terms_accepted_at:- created_at: '2026-08-18T20:10:57.074Z'- updated_at: '2026-08-18T20:10:57.117Z'+ created_at: '2026-08-20T14:34:06.122Z'+ updated_at: '2026-08-20T14:34:06.211Z'deleted_at:minimum_payout_amount:on_holiday: falsesellable: falseproducts_count: 0users_count: 0+ onboarding_progress:+ done: 0+ total: 0+ percentage: 100+ onboarding_complete: trueschema:"$ref": "#/components/schemas/Seller"requestBody:@@ -30520,14 +31295,19 @@ paths:metadata: {}holiday_mode_until:terms_accepted_at:- created_at: '2026-08-18T20:10:57.160Z'- updated_at: '2026-08-18T20:10:57.213Z'+ created_at: '2026-08-20T14:34:06.231Z'+ updated_at: '2026-08-20T14:34:06.354Z'deleted_at:minimum_payout_amount:on_holiday: falsesellable: trueproducts_count: 0users_count: 0+ onboarding_progress:+ done: 0+ total: 0+ percentage: 100+ onboarding_complete: trueschema:"$ref": "#/components/schemas/Seller"'422':@@ -30616,14 +31396,19 @@ paths:suspension_reason: Counterfeit goodsholiday_mode_until:terms_accepted_at:- created_at: '2026-08-18T20:10:57.255Z'- updated_at: '2026-08-18T20:10:57.276Z'+ created_at: '2026-08-20T14:34:06.498Z'+ updated_at: '2026-08-20T14:34:06.643Z'deleted_at:minimum_payout_amount:on_holiday: falsesellable: falseproducts_count: 0users_count: 0+ onboarding_progress:+ done: 0+ total: 0+ percentage: 100+ onboarding_complete: trueschema:"$ref": "#/components/schemas/Seller"requestBody:@@ -30709,14 +31494,19 @@ paths:rejection_reason: Incomplete paperworkholiday_mode_until:terms_accepted_at:- created_at: '2026-08-18T20:10:57.290Z'- updated_at: '2026-08-18T20:10:57.321Z'+ created_at: '2026-08-20T14:34:06.763Z'+ updated_at: '2026-08-20T14:34:06.811Z'deleted_at:minimum_payout_amount:on_holiday: falsesellable: falseproducts_count: 0users_count: 0+ onboarding_progress:+ done: 0+ total: 0+ percentage: 100+ onboarding_complete: trueschema:"$ref": "#/components/schemas/Seller"requestBody:@@ -30728,6 +31518,230 @@ paths:reason:type: stringexample: Incomplete paperwork+ "/api/v3/admin/stock_movements":+ get:+ summary: List stock movements+ tags:+ - Stock Movements+ security:+ - api_key: []+ bearer_auth: []+ description: |-+ Returns the stock ledger, newest first. Every row says what happened to+ stock (`kind`) and carries a direct reference to what caused it, so a+ merchant can answer "why is this number what it is?" from the data.++ Kinds are `received` (goods arrived), `allocated` (stock promised to a+ placed order), `shipped` (promised stock left), `released` (a promise+ withdrawn) and `adjusted` (a manual correction, which always carries a+ `reason`).++ Movements are immutable — reversing one means writing its counterpart+ through the resource that caused it, which is why there is no create,+ update or delete here.++ Filter with Ransack predicates such as `q[kind_eq]`,+ `q[stock_level_id_eq]`, `q[order_id_eq]`, `q[fulfillment_id_eq]` or+ `q[created_at_gteq]`.++ `kind` is null on rows written before Spree 6.0 until+ `spree:migrate_stock_movements_to_typed_rows` has run.+++ **Required scope:** `read_stock` (for API-key authentication).+ x-codeSamples:+ - lang: javascript+ label: Spree Admin SDK+ source: |-+ import { createAdminClient } from '@spree/admin-sdk'++ const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+ })++ const { data: stockMovements } = await client.stockMovements.list({+ q: { kind_eq: 'allocated' },+ })+ - lang: bash+ label: Spree CLI+ source: spree api get /stock_movements -d '{"q":{"kind_eq":"allocated"}}'+ parameters:+ - name: x-spree-api-key+ in: header+ required: true+ schema:+ type: string+ - name: Authorization+ in: header+ required: true+ description: Bearer token for admin authentication+ schema:+ type: string+ - name: page+ in: query+ required: false+ description: Page number+ schema:+ type: integer+ - name: limit+ in: query+ required: false+ description: Number of records per page+ schema:+ type: integer+ - name: q[kind_eq]+ in: query+ required: false+ description: Filter by kind ('received', 'allocated', 'shipped', 'released',+ 'adjusted')+ schema:+ type: string+ - name: q[stock_level_id_eq]+ in: query+ required: false+ description: Filter by stock level, e.g. sl_1234567890+ schema:+ type: string+ - name: fields+ in: query+ required: false+ description: Comma-separated list of fields to include. id is always included.+ schema:+ type: string+ responses:+ '200':+ description: stock movements found+ content:+ application/json:+ example:+ data:+ - id: sm_UkLWZg9DAJ+ quantity: 5+ kind: adjusted+ reason: Cycle count+ created_at: '2026-08-20T14:34:09.041Z'+ updated_at: '2026-08-20T14:34:09.041Z'+ stock_level_id: sl_gbHJdmfrXB+ order_id:+ fulfillment_id:+ return_id:+ exchange_id:+ stock_transfer_id:+ meta:+ page: 1+ limit: 25+ count: 1+ pages: 1+ from: 1+ to: 1+ in: 1+ previous:+ next:+ schema:+ type: object+ properties:+ data:+ type: array+ items:+ "$ref": "#/components/schemas/StockMovement"+ meta:+ "$ref": "#/components/schemas/PaginationMeta"+ required:+ - data+ - meta+ '401':+ description: unauthorized+ content:+ application/json:+ example:+ error:+ code: authentication_required+ message: Authentication required+ schema:+ "$ref": "#/components/schemas/ErrorResponse"+ "/api/v3/admin/stock_movements/{id}":+ parameters:+ - name: id+ in: path+ required: true+ description: Stock movement ID+ schema:+ type: string+ get:+ summary: Get a stock movement+ tags:+ - Stock Movements+ security:+ - api_key: []+ bearer_auth: []+ description: |-+ Returns a single stock movement by prefixed ID.++ **Required scope:** `read_stock` (for API-key authentication).+ x-codeSamples:+ - lang: javascript+ label: Spree Admin SDK+ source: |-+ import { createAdminClient } from '@spree/admin-sdk'++ const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+ })++ const stockMovement = await client.stockMovements.get('sm_k5nR8xLq')+ - lang: bash+ label: Spree CLI+ source: spree api get /stock_movements/{id}+ parameters:+ - name: x-spree-api-key+ in: header+ required: true+ schema:+ type: string+ - name: Authorization+ in: header+ required: true+ description: Bearer token for admin authentication+ schema:+ type: string+ - name: fields+ in: query+ required: false+ description: Comma-separated list of fields to include. id is always included.+ schema:+ type: string+ responses:+ '200':+ description: stock movement found+ content:+ application/json:+ example:+ id: sm_UkLWZg9DAJ+ quantity: 5+ kind: adjusted+ reason: Cycle count+ created_at: '2026-08-20T14:34:09.707Z'+ updated_at: '2026-08-20T14:34:09.707Z'+ stock_level_id: sl_gbHJdmfrXB+ order_id:+ fulfillment_id:+ return_id:+ exchange_id:+ stock_transfer_id:+ schema:+ "$ref": "#/components/schemas/StockMovement"+ '404':+ description: stock movement not found+ content:+ application/json:+ example:+ error:+ code: record_not_found+ message: Stock movement not found+ schema:+ "$ref": "#/components/schemas/ErrorResponse"servers:- url: http://{defaultHost}variables:@@ -31191,6 +32205,12 @@ components:type: stringupdated_at:type: string+ latitude:+ type: number+ nullable: true+ longitude:+ type: number+ nullable: truecustomer_id:type: stringnullable: true@@ -31219,6 +32239,8 @@ components:- metadata- created_at- updated_at+ - latitude+ - longitude- customer_idx-typelizer: trueAdminUser:@@ -34587,12 +35609,12 @@ components:nullable: truenumber:type: string+ status:+ type: stringamount:type: stringdisplay_amount:type: string- status:- type: stringsource_type:type: stringnullable: true@@ -34642,9 +35664,9 @@ components:- payment_method_id- response_code- number+ - status- amount- display_amount- - status- source_type- source_id- source@@ -35628,6 +36650,150 @@ components:- mutable- users_countx-typelizer: true+ SellerRequirement:+ type: object+ properties:+ id:+ type: string+ position:+ type: number+ active:+ type: boolean+ required:+ type: boolean+ metadata:+ type: object+ nullable: true+ created_at:+ type: string+ updated_at:+ type: string+ kind:+ type: string+ name:+ type: string+ description:+ type: string+ nullable: true+ preferences:+ type: object+ custom_field_definition_ids:+ type: array+ items:+ type: string+ allow_multiple:+ type: boolean+ accepts_submissions:+ type: boolean+ reviewed_by_operator:+ type: boolean+ required:+ - id+ - position+ - active+ - required+ - metadata+ - created_at+ - updated_at+ - kind+ - name+ - description+ - preferences+ - custom_field_definition_ids+ - allow_multiple+ - accepts_submissions+ - reviewed_by_operator+ x-typelizer: true+ SellerRequirementStatus:+ type: object+ properties:+ id:+ type: string+ kind:+ type: string+ name:+ type: string+ description:+ type: string+ nullable: true+ required:+ type: boolean+ position:+ type: number+ status:+ type: string+ action_url:+ type: string+ nullable: true+ blocking:+ type: boolean+ submission:+ "$ref": "#/components/schemas/SellerRequirementSubmission"+ required:+ - id+ - kind+ - name+ - description+ - required+ - position+ - status+ - action_url+ - blocking+ x-typelizer: true+ SellerRequirementSubmission:+ type: object+ properties:+ id:+ type: string+ status:+ type: string+ note:+ type: string+ nullable: true+ review_note:+ type: string+ nullable: true+ reference:+ type: string+ nullable: true+ metadata:+ type: object+ nullable: true+ reviewed_at:+ type: string+ nullable: true+ created_at:+ type: string+ updated_at:+ type: string+ seller_id:+ type: string+ requirement_id:+ type: string+ requirement_name:+ type: string+ file_url:+ type: string+ nullable: true+ file_name:+ type: string+ nullable: true+ required:+ - id+ - status+ - note+ - review_note+ - reference+ - metadata+ - reviewed_at+ - created_at+ - updated_at+ - seller_id+ - requirement_id+ - requirement_name+ - file_url+ - file_name+ x-typelizer: trueSeller:type: objectproperties:@@ -35690,6 +36856,10 @@ components:type: numberusers_count:type: number+ onboarding_progress:+ type: object+ onboarding_complete:+ type: booleanbilling_address:"$ref": "#/components/schemas/Address"returns_address:@@ -35719,6 +36889,8 @@ components:- sellable- products_count- users_count+ - onboarding_progress+ - onboarding_completex-typelizer: trueSetupTask:type: object@@ -35742,7 +36914,7 @@ components:- abbr- namex-typelizer: true- StockItem:+ StockLevel:type: objectproperties:id:@@ -35877,12 +37049,61 @@ components:- created_at- updated_atx-typelizer: true+ StockMovement:+ type: object+ properties:+ id:+ type: string+ quantity:+ type: number+ kind:+ type: string+ nullable: true+ reason:+ type: string+ nullable: true+ created_at:+ type: string+ updated_at:+ type: string+ stock_level_id:+ type: string+ nullable: true+ order_id:+ type: string+ nullable: true+ fulfillment_id:+ type: string+ nullable: true+ return_id:+ type: string+ nullable: true+ exchange_id:+ type: string+ nullable: true+ stock_transfer_id:+ type: string+ nullable: true+ required:+ - id+ - quantity+ - kind+ - reason+ - created_at+ - updated_at+ - stock_level_id+ - order_id+ - fulfillment_id+ - return_id+ - exchange_id+ - stock_transfer_id+ x-typelizer: trueStockReservation:type: objectproperties:id:type: string- stock_item_id:+ stock_level_id:type: stringline_item_id:type: string@@ -35906,7 +37127,7 @@ components:type: stringrequired:- id- - stock_item_id+ - stock_level_id- line_item_id- order_id- variant_id@@ -36065,6 +37286,8 @@ components:type: booleanpreferred_stock_reservations_enabled:type: boolean+ preferred_tax_using_ship_address:+ type: booleanpreferred_track_price_history:type: booleanpreferred_show_products_without_price:@@ -36141,6 +37364,7 @@ components:- preferred_capture_method- preferred_track_inventory_levels- preferred_stock_reservations_enabled+ - preferred_tax_using_ship_address- preferred_track_price_history- preferred_show_products_without_price- preferred_disable_sku_validation@@ -36566,10 +37790,10 @@ components:type: arrayitems:"$ref": "#/components/schemas/Price"- stock_items:+ stock_levels:type: arrayitems:- "$ref": "#/components/schemas/StockItem"+ "$ref": "#/components/schemas/StockLevel"required:- id- product_iddiff --git a/packages/cli/src/generated/admin-spec.json b/packages/cli/src/generated/admin-spec.jsonindex d4342d7d74..87f55a8aff 100644--- a/packages/cli/src/generated/admin-spec.json+++ b/packages/cli/src/generated/admin-spec.json@@ -1 +1 @@-{"info":{"title":"Admin API","contact":{"name":"Spree Commerce","url":"https://spreecommerce.org","email":"[email protected]"},"description":"Spree Admin API v3 - Administrative API for managing products, orders, and store settings.\n\n## Authentication\n\nThe Admin API requires a secret API key passed in the `x-spree-api-key` header.\nSecret API keys can be generated in the Spree admin dashboard.\n\n## Response Format\n\nAll responses are JSON. List endpoints return paginated responses with `data` and `meta` keys.\nSingle resource endpoints return a flat JSON object.\n\n## Resource IDs\n\nEvery resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`,\n`variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths,\nrequest bodies, and Ransack filters all accept them directly.\n\n## Error Handling\n\nErrors return a consistent format:\n```json\n{\n \"error\": {\n \"code\": \"validation_error\",\n \"message\": \"Validation failed\",\n \"details\": { \"name\": [\"can't be blank\"] }\n }\n}\n```\n","version":"v3"},"paths":{"/api/v3/admin/auth/login":{"post":{"summary":"Login","tags":["Authentication"],"security":[{"api_key":[]}],"description":"Authenticates an admin user and returns a short-lived JWT access token.\nThe rotatable refresh token is set in an HttpOnly cookie — it is not\nincluded in the response body.\n\nThe `provider` field selects the authentication method. When omitted it\ndefaults to `email`, the built-in email/password login.\n\nTo authenticate against a third-party identity provider (Okta, Azure AD,\nGoogle Workspace SSO, a custom JWT issuer, SAML, etc.), send\n`{ \"provider\": \"<your_key>\", ... }` with the fields that provider\nrequires. The endpoint returns the same JWT regardless of which provider\nauthenticated the request. See\n[Custom API Authentication](https://spreecommerce.org/docs/developer/how-to/custom-api-authentication)\nfor the list of configured providers and their required fields.\n","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"login successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthResponse"}}}},"401":{"description":"invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"title":"EmailPasswordLogin","description":"Built-in email/password authentication (default when `provider` is omitted).","type":"object","properties":{"provider":{"type":"string","enum":["email"],"default":"email"},"email":{"type":"string","format":"email"},"password":{"type":"string"}},"required":["email","password"]},{"title":"ProviderLogin","description":"Provider-dispatched login. The `provider` key selects a configured\nauthentication provider; the remaining fields are forwarded to it.\nRequired fields depend on the provider — see\n[Custom API Authentication](https://spreecommerce.org/docs/developer/how-to/custom-api-authentication).\n","type":"object","properties":{"provider":{"type":"string","description":"Registered provider key (anything other than `email`).","not":{"enum":["email"]}}},"required":["provider"],"additionalProperties":true}]}}}}}},"/api/v3/admin/auth/refresh":{"post":{"summary":"Refresh token","tags":["Authentication"],"security":[{"api_key":[]}],"description":"Exchanges the HttpOnly refresh-token cookie for a new access JWT and a\nrotated refresh token cookie. No request body or Authorization header\nis required — the cookie alone authenticates the call.\n","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"refresh successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthResponse"}}}},"401":{"description":"missing or invalid refresh-token cookie","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/auth/logout":{"post":{"summary":"Logout","tags":["Authentication"],"security":[{"api_key":[]}],"description":"Revokes the refresh-token cookie, effectively logging the admin out.","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"logout successful"}}}},"/api/v3/admin/me":{"get":{"summary":"Get current admin user and permissions","tags":["Authentication"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the current admin user profile and a serialized list of permissions (CanCanCan rules). The SPA uses these to drive UI permission checks.","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"current admin user and permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeResponse"}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update the current admin profile","tags":["Authentication"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Self-service update of the signed-in admin's own profile, such as their admin UI display language (`selected_locale`).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"profile updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"selected_locale":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}}}}}}}},"/api/v3/admin/auth/password_resets":{"post":{"summary":"Request password reset","tags":["Authentication"],"security":[{"api_key":[]}],"description":"Requests a password reset email for an admin user. Always returns `202`\nwhether or not the email matches an account, to prevent enumeration.\n\n`redirect_url` is where the emailed link should point (the reset token\nis appended as a `token` query param). It must match one of the store's\nallowed origins — otherwise it is silently ignored and the server-side\ndefault is used. The email is delivered by Spree itself via the\n`admin_user.password_reset_requested` event; this event is never\nforwarded to webhook endpoints.\n","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"reset requested","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email"},"redirect_url":{"type":"string","description":"Must match an allowed origin of the store; ignored otherwise."}},"required":["email"]}}}}}},"/api/v3/admin/auth/password_resets/{id}":{"patch":{"summary":"Reset password","tags":["Authentication"],"security":[{"api_key":[]}],"description":"Consumes a password reset token (the `token` query param from the\nemailed link), sets the new password, and signs the admin in: the\nresponse carries a JWT access token and the rotatable refresh token is\nset in an HttpOnly cookie. The token is single-use — it invalidates as\nsoon as the password changes.\n","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The reset token from the emailed link","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"password reset","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthResponse"}}}},"422":{"description":"invalid or expired token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string"},"password_confirmation":{"type":"string"}},"required":["password","password_confirmation"]}}}}}},"/api/v3/admin/auth/setup":{"get":{"summary":"Check first-run setup availability","tags":["Authentication"],"description":"Reports whether first-run setup is still available — true only while\nthe installation has no admin user. Unauthenticated; the dashboard\nlogin page uses it to offer the setup screen.\n","responses":{"200":{"description":"setup status","content":{"application/json":{}}}}},"post":{"summary":"Complete first-run setup","tags":["Authentication"],"description":"Creates the first admin account and adopts the seeded store, authorized\nby the one-time setup token printed at install time (rotate it with\n`bin/rails spree:setup:token`). Issues a JWT access token and a\nrefresh-token cookie exactly like login. Returns 404 once any admin\nuser exists — the flow is closed permanently after setup.\n","parameters":[],"responses":{"200":{"description":"setup completed","content":{"application/json":{}}},"404":{"description":"setup not available","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["setup_token","email","password","country_code"],"properties":{"setup_token":{"type":"string","description":"One-time token from the install output."},"email":{"type":"string","format":"email"},"password":{"type":"string"},"password_confirmation":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"store_name":{"type":"string"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country the store sells from. Determines the default market, the warehouse, the delivery zones and the currency."},"locale":{"type":"string","description":"Storefront locale. Defaults to the country's own language."},"currency":{"type":"string","description":"ISO 4217 currency. Defaults to the country's own currency — pass one only when the store prices in something else."}}}}}}}},"/api/v3/admin/auth/setup/countries":{"get":{"summary":"List countries for first-run setup","tags":["Authentication"],"description":"Countries the store can be set up in, each with the currency and\nofficial languages derived from it. Unauthenticated, because the setup\nscreen runs before any credential exists. Returns 404 once any admin\nuser exists.\n","responses":{"200":{"description":"countries","content":{"application/json":{}}}}}},"/api/v3/admin/allowed_origins":{"get":{"summary":"List allowed origins","tags":["Allowed Origins"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the CORS allowlist for the current store. Each entry is a\nbare `scheme://host[:port]` permitted to call the admin API from a\nbrowser. Backs the `Rack::Cors` allowlist and the CSRF boundary of\nthe admin cookie session (see\n`docs/plans/5.5-admin-auth-cookie-refresh.md`).\n\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[origin_cont]","in":"query","required":false,"description":"Filter by origin (contains)","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-created_at`).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"allowed origins found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AllowedOrigin"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create an allowed origin","tags":["Allowed Origins"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Adds an origin to the admin CORS allowlist. The value must be a bare\n`scheme://host[:port]` (no path, query, or fragment) and use `http` or\n`https`.\n\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"allowed origin created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllowedOrigin"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"origin":{"type":"string"}},"required":["origin"]}}}}}},"/api/v3/admin/allowed_origins/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Allowed origin ID","schema":{"type":"string"}}],"get":{"summary":"Get an allowed origin","tags":["Allowed Origins"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single allowed origin by prefixed ID.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"allowed origin found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllowedOrigin"}}}},"404":{"description":"allowed origin not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update an allowed origin","tags":["Allowed Origins"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates an existing allowed origin.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"allowed origin updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllowedOrigin"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"origin":{"type":"string"}}}}}}},"delete":{"summary":"Delete an allowed origin","tags":["Allowed Origins"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes an origin from the admin CORS allowlist. After deletion the\nadmin SPA running at that origin will no longer be able to call the\nadmin API from a browser.\n\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"204":{"description":"allowed origin deleted"}}}},"/api/v3/admin/api_keys":{"get":{"summary":"List API keys","tags":["API Keys"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns publishable and secret API keys for the current store. Secret keys are listed by `token_prefix` only — the plaintext token is delivered exactly once on create.\n\n**Required scope:** `read_api_keys` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"API keys found","content":{"application/json":{}}}}},"post":{"summary":"Create an API key","tags":["API Keys"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a publishable or secret API key. The plaintext token is included in the response **once** for secret keys; publishable keys expose their token on every read since they are intended for client-side use.\n\n**Required scope:** `write_api_keys` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"secret key created — plaintext token returned once","content":{"application/json":{}}},"422":{"description":"validation error","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","key_type"],"properties":{"name":{"type":"string"},"key_type":{"type":"string","enum":["publishable","secret"]},"scopes":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/api_keys/{id}":{"get":{"summary":"Show an API key","tags":["API Keys"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_api_keys` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"API key found","content":{"application/json":{}}}}},"patch":{"summary":"Update an API key","tags":["API Keys"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Renames a key. `key_type` and `scopes` are fixed at creation — to change a key's authority, create a new key and revoke the old one.\n\n**Required scope:** `write_api_keys` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"API key renamed","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}}}}}},"delete":{"summary":"Delete an API key","tags":["API Keys"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_api_keys` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"API key deleted"}}}},"/api/v3/admin/api_keys/current":{"get":{"summary":"Describe the current API key","tags":["API Keys"],"security":[{"api_key":[]}],"description":"Returns the secret key that authenticated this request, including its live scopes. Useful to confirm a key's real, current authority. Only secret-key principals have a single key to describe.\n\n**Required scope:** none — any key can describe itself (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"current API key","content":{"application/json":{}}}}}},"/api/v3/admin/api_keys/{id}/revoke":{"patch":{"summary":"Revoke an API key","tags":["API Keys"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Marks the key revoked. Future requests using its token will fail; the row is preserved for audit.\n\n**Required scope:** `write_api_keys` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"API key revoked","content":{"application/json":{}}}}}},"/api/v3/admin/categories":{"get":{"summary":"List categories","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a paginated list of the store's categories (manual hierarchical taxons; rule-based collections are excluded).\n\n**Required scope:** `read_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., children, parent, ancestors).","schema":{"type":"string"}}],"responses":{"200":{"description":"categories found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}}}},"post":{"summary":"Create a category","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a category. Nests under the parent when parent_id is given, otherwise creates a top-level category.\n\n**Required scope:** `write_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"category created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"parent_id":{"type":"string","description":"Prefixed ID of the parent category"},"description":{"type":"string"},"permalink":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"meta_keywords":{"type":"string"}},"required":["name"]}}}}}},"/api/v3/admin/categories/{id}":{"get":{"summary":"Get a category","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single category by ID.\n\n**Required scope:** `read_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Category ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., children, parent, ancestors).","schema":{"type":"string"}}],"responses":{"200":{"description":"category found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}},"404":{"description":"category not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a category","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a category.\n\n**Required scope:** `write_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Category ID","schema":{"type":"string"}}],"responses":{"200":{"description":"category updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"parent_id":{"type":"string","description":"Prefixed ID of the parent category"},"description":{"type":"string"},"permalink":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"meta_keywords":{"type":"string"}}}}}}},"delete":{"summary":"Delete a category","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes a category and its descendants.\n\n**Required scope:** `write_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Category ID","schema":{"type":"string"}}],"responses":{"204":{"description":"category deleted"}}}},"/api/v3/admin/categories/{id}/reposition":{"patch":{"summary":"Reposition a category","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Moves a category to a new parent and/or index within the tree.\n\n**Required scope:** `write_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Category ID","schema":{"type":"string"}}],"responses":{"200":{"description":"category repositioned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"new_parent_id":{"type":"string","description":"Prefixed ID of the new parent (omit for top level)"},"new_position":{"type":"integer","description":"0-based index among the new parent's children"}},"required":["new_position"]}}}}}},"/api/v3/admin/categories/{category_id}/products":{"get":{"summary":"List category products","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Products classified under the category, ordered by their classification position.\n\n**Required scope:** `read_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"category_id","in":"path","required":true,"description":"Category ID","schema":{"type":"string"}}],"responses":{"200":{"description":"products found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}}}},"post":{"summary":"Add a product to a category","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Classifies a product under the category (appended to the end).\n\n**Required scope:** `write_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"category_id","in":"path","required":true,"description":"Category ID","schema":{"type":"string"}}],"responses":{"201":{"description":"product added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"product_id":{"type":"string"}},"required":["product_id"]}}}}}},"/api/v3/admin/categories/{category_id}/products/{id}":{"delete":{"summary":"Remove a product from a category","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes a product from the category's manual classification.\n\n**Required scope:** `write_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"category_id","in":"path","required":true,"description":"Category ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}}],"responses":{"204":{"description":"product removed"}}}},"/api/v3/admin/categories/{category_id}/products/{id}/reposition":{"patch":{"summary":"Reposition a category product","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Moves a product to a new index among the category's products.\n\n**Required scope:** `write_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"category_id","in":"path","required":true,"description":"Category ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}}],"responses":{"204":{"description":"product repositioned"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"new_position":{"type":"integer","description":"0-based index among the category's products"}},"required":["new_position"]}}}}}},"/api/v3/admin/channels":{"get":{"summary":"List channels","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the channels configured for the current store.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"channels found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}}}},"post":{"summary":"Create a channel","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new channel on the current store. `code` is normalized to a\nURL-safe slug (`Point of Sale` → `point-of-sale`); when omitted it's\nderived from `name`.\n\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"channel created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"code":{"type":"string","description":"Slug — auto-derived from `name` when blank."},"active":{"type":"boolean","default":true},"default":{"type":"boolean","default":false},"preferred_order_routing_strategy":{"type":"string","nullable":true,"description":"Routing strategy class name. `null` inherits the store setting."},"preferred_storefront_access":{"type":"string","nullable":true,"enum":["public","prices_hidden","login_required"],"description":"Anonymous-visitor access posture. `null` inherits the store setting."},"preferred_guest_checkout":{"type":"boolean","nullable":true,"description":"Whether guests can check out without an account. `null` inherits the store setting."}}}}}}}},"/api/v3/admin/channels/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a channel","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"channel found","content":{"application/json":{}}}}},"patch":{"summary":"Update a channel","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"channel updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"code":{"type":"string"},"active":{"type":"boolean"},"default":{"type":"boolean"},"preferred_order_routing_strategy":{"type":"string","nullable":true,"description":"Routing strategy class name. `null` inherits the store setting."},"preferred_storefront_access":{"type":"string","nullable":true,"enum":["public","prices_hidden","login_required"],"description":"Anonymous-visitor access posture. `null` inherits the store setting."},"preferred_guest_checkout":{"type":"boolean","nullable":true,"description":"Whether guests can check out without an account. `null` inherits the store setting."}}}}}}},"delete":{"summary":"Delete a channel","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"channel deleted"}}}},"/api/v3/admin/channels/{id}/add_products":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"post":{"summary":"Publish products on a channel","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Publishes the listed products on this channel. Idempotent — re-publishing\nan already-published product updates its publication window. Products from\nsibling stores are silently dropped.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"products published","content":{"application/json":{"schema":{"type":"object","properties":{"product_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["product_ids"],"properties":{"product_ids":{"type":"array","items":{"type":"string"}},"published_at":{"type":"string","format":"date-time","nullable":true,"description":"When the publications go live. `null` means immediately."},"unpublished_at":{"type":"string","format":"date-time","nullable":true,"description":"When the publications come down. `null` means never."}}}}}}}},"/api/v3/admin/channels/{id}/remove_products":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"post":{"summary":"Unpublish products from a channel","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Unpublishes the listed products from this channel.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"products unpublished","content":{"application/json":{"schema":{"type":"object","properties":{"product_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["product_ids"],"properties":{"product_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/channels/{channel_id}/order_routing_rules":{"parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"List order routing rules for a channel","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the channel's routing rules in priority order. The rules engine walks them top-down; see the Order Routing guide.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"rules found","content":{"application/json":{}}}}},"post":{"summary":"Create an order routing rule on a channel","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Adds a rule to the channel's routing list. The `type` is the wire shorthand from `GET /order_routing_rules/types` (e.g. `preferred_location`). Omitting `position` appends the rule at the end of the list. Each rule kind can appear at most once per channel — a duplicate `type` is rejected with a validation error.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"rule created","content":{"application/json":{}}},"422":{"description":"unknown rule type","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"active":{"type":"boolean"},"position":{"type":"integer"},"preferences":{"type":"object","additionalProperties":true}},"required":["type"]}}}}}},"/api/v3/admin/channels/{channel_id}/order_routing_rules/{id}":{"parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"patch":{"summary":"Update an order routing rule","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a rule's `active` flag, `position` (the list reorders around it), or `preferences`. The rule kind cannot be changed — delete and re-create instead.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"rule updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"active":{"type":"boolean"},"position":{"type":"integer"},"preferences":{"type":"object","additionalProperties":true}}}}}}},"delete":{"summary":"Delete an order routing rule","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"rule deleted"}}}},"/api/v3/admin/order_routing_rules/types":{"get":{"summary":"List available order routing rule types","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Enumerates the registered rule kinds with their labels, descriptions and preference schemas — drives the \"Add rule\" picker in the admin dashboard. Plugins extend the list by registering `Spree::OrderRoutingRule` subclasses via `Spree.order_routing.rules`.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"types found","content":{"application/json":{}}}}}},"/api/v3/admin/custom_field_definitions":{"get":{"summary":"List custom field definitions","tags":["Custom Fields"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns all defined custom fields. Filter by `?q[resource_type_eq]=Spree::Product` to narrow to one parent type.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand. Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., key,label,field_type). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"definitions returned","content":{"application/json":{}}}}},"post":{"summary":"Create a custom field definition","tags":["Custom Fields"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"definition created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["key","field_type","resource_type"],"properties":{"namespace":{"type":"string","description":"Defaults to `custom`"},"key":{"type":"string"},"label":{"type":"string","description":"Human-readable name; defaults to titleized `key`"},"field_type":{"type":"string","description":"Custom field type identifier (one of the registered field-type class names)."},"resource_type":{"type":"string","description":"Owner class, e.g. `Spree::Product`"},"storefront_visible":{"type":"boolean","description":"When false, the definition is admin-only and never exposed in the Store API"},"searchable":{"type":"boolean","description":"When true, values are included in storefront product text search"},"sortable":{"type":"boolean","description":"When true, storefront product listings can sort by this field"}}}}}}}},"/api/v3/admin/custom_field_definitions/{id}":{"get":{"summary":"Show a custom field definition","tags":["Custom Fields"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand. Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., key,label,field_type). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"definition found","content":{"application/json":{}}}}},"patch":{"summary":"Update a custom field definition","tags":["Custom Fields"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"definition updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string"},"storefront_visible":{"type":"boolean"},"searchable":{"type":"boolean"},"sortable":{"type":"boolean"}}}}}}},"delete":{"summary":"Delete a custom field definition","tags":["Custom Fields"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes the definition and cascades to all custom field values referencing it.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"definition deleted"}}}},"/api/v3/admin/customer_groups":{"get":{"summary":"List customer groups","tags":["Customer Groups"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the customer groups configured for the current store. Groups\nsegment customers for targeted promotions (see the `customer_group`\npromotion rule) and reporting. The list endpoint never embeds the\nmember list — fetch a single group with `?expand=customers` if you\nneed them inline, or query `/admin/customers?customer_group_id_in=…`\nfor paginated membership.\n\n\n**Required scope:** `read_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[name_cont]","in":"query","required":false,"description":"Filter by name (contains)","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-created_at`).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"customer groups found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerGroup"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a customer group","tags":["Customer Groups"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a customer group in the current store. `customer_ids` is\noptional; when present, customers are attached at create time.\nPass prefixed IDs (e.g. `cus_…`) — the server decodes them\nautomatically.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"customer group created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerGroup"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true},"customer_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/customer_groups/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Customer group prefixed ID","schema":{"type":"string"}}],"get":{"summary":"Get a customer group","tags":["Customer Groups"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single customer group. Pass `?expand=customers` to embed\nthe full member list inline (recommended only for single-record\nreads — embed cost scales with membership size).\n\n\n**Required scope:** `read_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to embed. Supported: `customers`.","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"customer group with embedded customers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerGroup"}}}},"404":{"description":"customer group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a customer group","tags":["Customer Groups"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates name, description, or membership. `customer_ids` is a\nfull-set replacement — the server reconciles the membership to\nmatch the array, adding new IDs and removing ones not present.\nSend `customer_ids: []` to clear all members.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"customer group updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerGroup"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true},"customer_ids":{"type":"array","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete a customer group","tags":["Customer Groups"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes the group. Member users are not deleted; their `customer_group_users` rows are dropped.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"customer group deleted"}}}},"/api/v3/admin/customers/{customer_id}/addresses":{"get":{"summary":"List customer addresses","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the customer's saved addresses.\n\n**Required scope:** `read_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., country, state). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., first_name,last_name,address1,city). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"addresses found","content":{"application/json":{}}}}},"post":{"summary":"Create a customer address","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Adds a new address to the customer's address book. Pass `is_default_billing: true` or `is_default_shipping: true` to set as the default — the previous default loses its flag in the same transaction.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"address created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"country_code":{"type":"string","description":"ISO-2 country code (e.g. US)"},"state_code":{"type":"string","description":"State/province abbreviation (e.g. NY)"},"phone":{"type":"string"},"company":{"type":"string"},"label":{"type":"string"},"is_default_billing":{"type":"boolean"},"is_default_shipping":{"type":"boolean"}}}}}}}},"/api/v3/admin/customers/{customer_id}/addresses/{id}":{"patch":{"summary":"Update a customer address","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a customer address.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"address updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"city":{"type":"string"},"is_default_billing":{"type":"boolean"},"is_default_shipping":{"type":"boolean"}}}}}}},"delete":{"summary":"Delete a customer address","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes the address. If it was a default, the customer loses that default (no auto-promotion).\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"address deleted"}}}},"/api/v3/admin/customers/{customer_id}/credit_cards":{"get":{"summary":"List customer credit cards","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the customer's saved credit cards. Useful for off-session admin charges via `POST /admin/orders/:id/payments { source_id }`.\n\n**Required scope:** `read_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., payment_method). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., brand,last4,month,year). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"credit cards found","content":{"application/json":{}}}}}},"/api/v3/admin/customers/{customer_id}/credit_cards/{id}":{"get":{"summary":"Show a customer credit card","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a saved credit card by ID.\n\n**Required scope:** `read_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., payment_method). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., brand,last4,month,year). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"credit card found","content":{"application/json":{}}}}},"delete":{"summary":"Delete a customer credit card","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes a saved credit card.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"credit card deleted"}}}},"/api/v3/admin/customers/{customer_id}/store_credits":{"get":{"summary":"List customer store credits","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns store credits issued to the customer.\n\n**Required scope:** `read_store_credits` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., store, created_by). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., amount,amount_used,memo,currency). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"store credits found","content":{"application/json":{}}}}},"post":{"summary":"Issue a store credit to a customer","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"`created_by` is set automatically from the authenticated admin.\n\n**Required scope:** `write_store_credits` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"store credit created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"string"},"currency":{"type":"string"},"memo":{"type":"string"}}}}}}}},"/api/v3/admin/customers/{customer_id}/store_credits/{id}":{"patch":{"summary":"Update a store credit","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Update memo / amount. The amount can only be changed if `amount_used == 0`.\n\n**Required scope:** `write_store_credits` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"store credit updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"string"},"memo":{"type":"string"}}}}}}},"delete":{"summary":"Delete a store credit","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes an unused store credit (amount_used == 0). Returns 422 otherwise.\n\n**Required scope:** `write_store_credits` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"store credit deleted"}}}},"/api/v3/admin/customers":{"get":{"summary":"List customers","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a paginated list of customers. Supports Ransack search/filters.\n\n**Required scope:** `read_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"}},{"name":"q[search]","in":"query","required":false,"description":"Email + name full-text-ish search","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., addresses, store_credits). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., email,first_name,last_name). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"customers found","content":{"application/json":{}}}}},"post":{"summary":"Create a customer","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a customer. No welcome email is sent automatically.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"customer created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"phone":{"type":"string"},"accepts_email_marketing":{"type":"boolean"},"internal_note":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"metadata":{"type":"object"}}}}}}}},"/api/v3/admin/customers/{id}":{"get":{"summary":"Show a customer","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns full customer details including computed order stats (orders_count, total_spent, last_order_completed_at).\n\n**Required scope:** `read_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Customer ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations: addresses, orders, store_credits, default_billing_address, default_shipping_address","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., email,first_name,last_name). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"customer found","content":{"application/json":{}}}}},"patch":{"summary":"Update a customer","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates customer attributes. `tags` replaces the full set.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"customer updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"phone":{"type":"string"},"accepts_email_marketing":{"type":"boolean"},"internal_note":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"metadata":{"type":"object"}}}}}}},"delete":{"summary":"Delete a customer","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes a customer. Returns 422 if the customer has any orders.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"customer deleted"}}}},"/api/v3/admin/customers/bulk_add_to_groups":{"post":{"summary":"Bulk-add customers to groups","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Attaches each customer in `ids` to every group in `customer_group_ids`.\nIdempotent — customers already in a group are skipped server-side.\nGroups from sibling stores are silently ignored. Returns counts of\ncustomers and groups that were processed (post store-scoping).\n\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"customers added to groups","content":{"application/json":{"schema":{"type":"object","properties":{"customer_count":{"type":"integer"},"customer_group_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","customer_group_ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"customer_group_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/customers/bulk_remove_from_groups":{"post":{"summary":"Bulk-remove customers from groups","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Detaches each customer in `ids` from every group in `customer_group_ids`.\nNo-op for non-members. Groups from sibling stores are silently ignored.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"customers removed from groups","content":{"application/json":{"schema":{"type":"object","properties":{"customer_count":{"type":"integer"},"customer_group_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","customer_group_ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"customer_group_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/customers/bulk_add_tags":{"post":{"summary":"Bulk-add tags to customers","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Adds each tag name in `tags` to every customer in `ids`. Tags are\nupserted by name; re-adding an existing tag is a no-op.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"tags added","content":{"application/json":{"schema":{"type":"object","properties":{"customer_count":{"type":"integer"},"tag_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","tags"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/customers/bulk_remove_tags":{"post":{"summary":"Bulk-remove tags from customers","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes each tag name in `tags` from every customer in `ids`. No-op\nfor customers that don't carry the tag.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"tags removed","content":{"application/json":{"schema":{"type":"object","properties":{"customer_count":{"type":"integer"},"tag_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","tags"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/exports":{"get":{"summary":"List exports","tags":["Exports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns CSV exports queued or completed for the current store. Polled by the admin SPA to detect when an export finishes (`done: true`).\n\n**Required scope:** the read scope of the exported resource — `read_products` for product exports, `read_customers` for customer exports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"exports found","content":{"application/json":{}}}}},"post":{"summary":"Create an export","tags":["Exports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Queues a CSV export. The `type` selects the dataset; `search_params` is an\noptional Ransack query (same shape used by the `q[...]` params on list endpoints)\nthat filters which records are exported. Pass `record_selection: \"all\"` to\nclear the filter server-side and export everything in scope.\n\nGeneration is asynchronous. Poll `GET /admin/exports/{id}` until `done` is `true`,\nthen redirect the browser to `download_url` to fetch the file.\n\n\n**Required scope:** the read scope of the exported resource — `read_products` for product exports, `read_customers` for customer exports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"export queued","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["products","orders","customers","product_translations","gift_cards","coupon_codes","newsletter_subscribers"]},"record_selection":{"type":"string","enum":["filtered","all"],"description":"Set to \"all\" to ignore search_params and export everything in scope."},"search_params":{"type":"object","description":"Ransack query hash. Same predicates accepted by the list endpoint.","additionalProperties":true},"results_url":{"type":"string","description":"Absolute URL of your admin exports view; the export-done email uses it as the download button target. Only honored when it matches one of the store's configured allowed origins."}}}}}}}},"/api/v3/admin/exports/{id}":{"get":{"summary":"Show an export","tags":["Exports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns export status. While `done` is `false`, the SPA continues polling.\n\n**Required scope:** the read scope of the exported resource — `read_products` for product exports, `read_customers` for customer exports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"export found","content":{"application/json":{}}}}},"delete":{"summary":"Delete an export","tags":["Exports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes the export and purges its attachment.\n\n**Required scope:** the read scope of the exported resource — `read_products` for product exports, `read_customers` for customer exports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"export deleted"}}}},"/api/v3/admin/exports/{id}/download":{"get":{"summary":"Download an export","tags":["Exports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Streams the exported CSV with `Content-Disposition: attachment`. Returns 422 with `code: export_not_ready` while `done` is still `false`. The endpoint is JWT/API-key protected, so SPA clients must fetch it (with `Authorization` header) and trigger the browser download via a Blob URL — a top-level navigation cannot carry the JWT.\n\n**Required scope:** the read scope of the exported resource — `read_products` for product exports, `read_customers` for customer exports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"CSV file","content":{"application/json":{},"text/csv":{"schema":{"type":"string","format":"binary"}}}}}}},"/api/v3/admin/orders/{order_id}/fulfillments":{"get":{"summary":"List fulfillments","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns all shipments for an order.\n\n**Required scope:** `read_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., inventory_units, stock_location, shipping_rates). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., number,status,tracking,cost). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"fulfillments found","content":{"application/json":{}}}}},"post":{"summary":"Create a fulfillment","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Manually creates a fulfillment on a completed order, bypassing order routing — for example to mirror a shipment handled by an external carrier or 3PL. Moves the requested line item quantities out of their current fulfillments; when `items` is omitted, every not-yet-shipped unit is moved. Pass `status: 'shipped'` to register an already-shipped fulfillment (fires shipped webhooks and freezes cost/carrier). When `delivery_method_id` is omitted, the fulfillment inherits the delivery method and cost of the source fulfillment(s) it fully drains — keeping the order total unchanged; partially drained splits get no carrier when shipped, and pending fulfillments are otherwise (re)priced by the standard rate engine, which selects the lowest-cost available rate. Pass `cost` to set an explicit shipping cost instead (e.g. the 3PL price) — note this changes the order total and payment state, and is guaranteed to persist only with `status: 'shipped'` (pending fulfillments are re-priced by the rate engine).\n\n**Required scope:** `write_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"201":{"description":"fulfillment created","content":{"application/json":{}}},"422":{"description":"order not completed","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["stock_location_id"],"properties":{"stock_location_id":{"type":"string","description":"Stock location the fulfillment ships from"},"tracking":{"type":"string","description":"Carrier tracking number, or a full https:// tracking link — a full URL is served back as tracking_url unchanged instead of being templated into the delivery method tracking URL"},"delivery_method_id":{"type":"string","description":"Delivery method (carrier) to attach as the selected rate. Defaults to the delivery method of the fully drained source fulfillment(s)"},"cost":{"type":"string","description":"Explicit shipping cost. Defaults to the summed cost of the fully drained source fulfillment(s), which keeps the order total unchanged; an explicit cost changes the order total and payment state. Guaranteed to persist only with status: 'shipped' — pending fulfillments are re-priced by the rate engine"},"status":{"type":"string","enum":["shipped"],"description":"Pass 'shipped' to register the fulfillment as already shipped"},"items":{"type":"array","description":"Line item quantities to fulfill. Omit to fulfill every not-yet-shipped unit.","items":{"type":"object","required":["item_id","quantity"],"properties":{"item_id":{"type":"string","description":"Line item ID"},"quantity":{"type":"integer"}}}},"metadata":{"type":"object","additionalProperties":true}}}}}}}},"/api/v3/admin/orders/{order_id}/fulfillments/{id}":{"get":{"summary":"Show a shipment","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns details of a specific shipment.\n\n**Required scope:** `read_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Fulfillment ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., inventory_units, stock_location, shipping_rates). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., number,status,tracking,cost). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"shipment found","content":{"application/json":{}}}}},"patch":{"summary":"Update a shipment","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a fulfillment (tracking, delivery rate).\n\n**Required scope:** `write_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Fulfillment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"shipment updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"tracking":{"type":"string","description":"Carrier tracking number, or a full https:// tracking link served back as tracking_url unchanged"},"selected_delivery_rate_id":{"type":"string","description":"Delivery rate ID (dr_...) to select"}}}}}}}},"/api/v3/admin/orders/{order_id}/fulfillments/{id}/fulfill":{"patch":{"summary":"Fulfill a fulfillment","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Marks a fulfillment as fulfilled.\n\n**Required scope:** `write_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Fulfillment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"fulfillment fulfilled","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{order_id}/fulfillments/{id}/purchase_label":{"patch":{"summary":"Buy the shipping label","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Buys the shipping label for a parcel that has not shipped yet — print it, pack the box, then mark the fulfillment fulfilled. Only delivery methods whose provider produces labels accept this.\n\n**Required scope:** `write_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Fulfillment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"label purchased","content":{"application/json":{}}},"422":{"description":"provider does not produce labels","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{order_id}/fulfillments/{id}/mark_delivered":{"patch":{"summary":"Mark a fulfillment delivered","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Records that the customer received the goods. Only a fulfilled shipment can be marked delivered.\n\n**Required scope:** `write_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Fulfillment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"fulfillment delivered","content":{"application/json":{}}},"422":{"description":"fulfillment has not shipped","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"delivered_at":{"type":"string","format":"date-time","description":"When the goods arrived. Defaults to now."},"notify_customer":{"type":"boolean","description":"Whether the customer gets a delivery notification. Defaults to true."}}}}}}}},"/api/v3/admin/orders/{order_id}/fulfillments/{id}/cancel":{"patch":{"summary":"Cancel a fulfillment","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Cancels a fulfillment.\n\n**Required scope:** `write_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Fulfillment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"fulfillment canceled","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{order_id}/fulfillments/{id}/resume":{"patch":{"summary":"Resume a fulfillment","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Resumes a canceled fulfillment.\n\n**Required scope:** `write_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Fulfillment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"fulfillment resumed","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{order_id}/fulfillments/{id}/split":{"patch":{"summary":"Split a fulfillment","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Transfers items from this shipment to a new shipment at a different stock location.\n\n**Required scope:** `write_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Fulfillment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"fulfillment split","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["variant_id","quantity"],"properties":{"variant_id":{"type":"string","description":"Variant ID"},"quantity":{"type":"integer"},"stock_location_id":{"type":"string","description":"Target stock location ID"}}}}}}}},"/api/v3/admin/gift_card_batches":{"get":{"summary":"List gift card batches","tags":["Gift Cards"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the gift card batches issued by the current store. Each batch\ngroups the cards generated together for a campaign or bulk-issuance\n— the cards themselves live under `/admin/gift_cards` and reference\nthe batch via `gift_card_batch_id`.\n\n\n**Required scope:** `read_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Records per page","schema":{"type":"integer"}},{"name":"q[prefix_cont]","in":"query","required":false,"description":"Filter by prefix (contains)","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending.","schema":{"type":"string"}}],"responses":{"200":{"description":"gift card batches found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GiftCardBatch"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}}}},"post":{"summary":"Create a gift card batch","tags":["Gift Cards"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Issues a batch of gift cards in a single call. The server generates\n`codes_count` cards inline for small batches (configurable via\n`Spree.config.gift_card_batch_web_limit`, default 500) or enqueues\na background job for larger ones. Each card's code is the batch\n`prefix` followed by random hex.\n\n\n**Required scope:** `write_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"gift card batch created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCardBatch"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["prefix","amount","codes_count"],"properties":{"prefix":{"type":"string","description":"Lowercased and prepended to every generated code."},"amount":{"type":"string","description":"Decimal amount per card, greater than zero."},"currency":{"type":"string","description":"ISO 4217 currency code. Defaults to the store currency."},"codes_count":{"type":"integer","description":"Number of cards to generate. Capped at `gift_card_batch_limit`."},"expires_at":{"type":"string","nullable":true}}}}}}}},"/api/v3/admin/gift_card_batches/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Gift card batch prefixed ID","schema":{"type":"string"}}],"get":{"summary":"Get a gift card batch","tags":["Gift Cards"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single batch.\n\n**Required scope:** `read_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"gift card batch found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCardBatch"}}}},"404":{"description":"gift card batch not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/gift_cards":{"get":{"summary":"List gift cards","tags":["Gift Cards"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the gift cards issued by the current store. Filter by\n`q[code_cont]` for code search, `q[user_id_eq]` for cards issued\nto a specific customer, or `q[state_eq]` for status filtering.\n\n\n**Required scope:** `read_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[code_cont]","in":"query","required":false,"description":"Filter by gift card code (contains)","schema":{"type":"string"}},{"name":"q[state_eq]","in":"query","required":false,"description":"Filter by status (active, redeemed, partially_redeemed, canceled)","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-created_at`).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"gift cards found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GiftCard"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a gift card","tags":["Gift Cards"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Issues a gift card scoped to the current store. The code is\nauto-generated when omitted. `currency` defaults to the store's\nconfigured currency. Pass `user_id` (prefixed ID) to attach the\ncard to a specific customer.\n\n\n**Required scope:** `write_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"gift card created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCard"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["amount"],"properties":{"amount":{"type":"string","description":"Decimal amount, greater than zero."},"currency":{"type":"string","description":"ISO 4217 currency code. Defaults to the store currency."},"code":{"type":"string","description":"Optional caller-supplied code. Auto-generated when omitted."},"expires_at":{"type":"string","description":"ISO 8601 date.","nullable":true},"user_id":{"type":"string","description":"Optional customer prefixed ID.","nullable":true}}}}}}}},"/api/v3/admin/gift_cards/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Gift card prefixed ID","schema":{"type":"string"}}],"get":{"summary":"Get a gift card","tags":["Gift Cards"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single gift card.\n\n**Required scope:** `read_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"gift card found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCard"}}}},"404":{"description":"gift card not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a gift card","tags":["Gift Cards"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates an active gift card's editable attributes. Redeemed or\npartially-redeemed cards cannot be edited.\n\n\n**Required scope:** `write_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"gift card updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCard"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"string"},"expires_at":{"type":"string","nullable":true},"user_id":{"type":"string","nullable":true}}}}}}},"delete":{"summary":"Delete a gift card","tags":["Gift Cards"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes an unused gift card. Cards that have been redeemed or\npartially redeemed cannot be deleted and return 422.\n\n\n**Required scope:** `write_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"gift card deleted"},"422":{"description":"redeemed gift card cannot be deleted","content":{"application/json":{}}}}}},"/api/v3/admin/imports":{"get":{"summary":"List imports","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns CSV imports queued or completed for the current store.\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"imports found","content":{"application/json":{}}}}},"post":{"summary":"Create an import","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Queues a CSV import. Upload the file first via `POST /api/v3/admin/direct_uploads`\nand pass the returned `signed_id` as `attachment`. On success the import is in the\n`mapping` state and the response carries the mapping payload: `schema_fields`\n(the canonical columns for the type), `csv_headers`, a `sample_row`, and the\nauto-assigned `mappings`.\n\nAdjust mappings if needed, then call `PATCH /admin/imports/{id}/complete_mapping`\nto start processing. Poll `GET /admin/imports/{id}` while `status` is\n`completed_mapping`/`processing`; terminal statuses are `completed` and `failed`.\n\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"import created in mapping state","content":{"application/json":{}}},"422":{"description":"unknown import type","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type","attachment"],"properties":{"type":{"type":"string","enum":["products","customers","product_translations"]},"attachment":{"type":"string","description":"ActiveStorage signed blob id from POST /api/v3/admin/direct_uploads."},"preferred_delimiter":{"type":"string","enum":[",",";","|","\t"],"description":"CSV column separator. Defaults to a comma."},"results_url":{"type":"string","description":"Absolute URL of your admin imports view; the import-done email links back to it with `?import=<id>` appended. Only honored when it matches one of the store's configured allowed origins."}}}}}}}},"/api/v3/admin/imports/template":{"get":{"summary":"Download an import template","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a CSV header row for the given import type, including the custom field columns available for the model.\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":true,"description":"Registered import type, e.g. products.","schema":{"type":"string"}}],"responses":{"200":{"description":"CSV template","content":{"application/json":{},"text/csv":{"schema":{"type":"string","format":"binary"}}}}}}},"/api/v3/admin/imports/example":{"get":{"summary":"Download an example import file","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Redirects to a populated example CSV for the given import type — the same sample data `rake spree:load_sample_data` uses, pinned to the installed Spree version. Returns 404 for a type that ships no example file.\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":true,"description":"Registered import type, e.g. products.","schema":{"type":"string"}}],"responses":{"302":{"description":"Redirect to the example CSV"}}}},"/api/v3/admin/imports/{id}":{"get":{"summary":"Show an import","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns import status and row counters. The admin dashboard polls this endpoint while `status` is `completed_mapping` or `processing`; `rows_count`, `completed_rows_count` and `failed_rows_count` drive the progress bar. The mapping payload (`csv_headers`, `sample_row`) is only present while `status` is `mapping`.\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"import found","content":{"application/json":{}}}}},"delete":{"summary":"Delete an import","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes the import, its rows and the uploaded file. Returns 422 while the import is being processed.\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"import deleted"}}}},"/api/v3/admin/imports/{id}/download":{"get":{"summary":"Download the originally uploaded file","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Streams the CSV exactly as it was uploaded — the audit trail for what was imported. JWT/API-key protected; SPA clients fetch it with the Authorization header and trigger the browser download via a Blob URL.\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"CSV file","content":{"application/json":{},"text/csv":{"schema":{"type":"string","format":"binary"}}}}}}},"/api/v3/admin/imports/{id}/complete_mapping":{"patch":{"summary":"Complete mapping and start processing","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Applies the submitted column mappings, then starts row processing. Omit `mappings`\nto accept the auto-assigned ones from the create response. Returns 422 when a\nrequired schema field is left unmapped (`details.missing_required_fields`) or a\nfile column is assigned twice.\n\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"mapping completed, processing queued","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"mappings":{"type":"array","description":"Column assignments to apply before starting. `file_column: null` unmaps a field.","items":{"type":"object","required":["schema_field"],"properties":{"schema_field":{"type":"string"},"file_column":{"type":"string","nullable":true}}}}}}}}}}},"/api/v3/admin/imports/{id}/retry_failed_rows":{"patch":{"summary":"Retry failed rows","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Re-processes the rows that failed. The import re-enters `processing`; poll `GET /admin/imports/{id}` until it completes again. Returns 422 when the import is not `completed` or has no failed rows.\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"retry queued","content":{"application/json":{}}}}}},"/api/v3/admin/imports/{import_id}/rows":{"get":{"summary":"List import rows","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Paginated rows of an import — the failure report. Filter with `q[status_eq]=failed` to list only rows that could not be imported; each row carries the raw CSV `data` and its `validation_errors`.\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"import_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"q[status_eq]","in":"query","required":false,"description":"Filter rows by status: pending, processing, completed, failed.","schema":{"type":"string"}}],"responses":{"200":{"description":"rows found","content":{"application/json":{}}}}}},"/api/v3/admin/markets":{"get":{"summary":"List markets","tags":["Markets"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the markets configured for the current store. Markets are\nstore-scoped and ordered by `position` (an `acts_as_list` column —\nupdate the order via `PATCH /markets/{id}` with `position`).\n\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"}},{"name":"q[name_cont]","in":"query","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to embed. Supported: `countries`.","schema":{"type":"string"}}],"responses":{"200":{"description":"markets found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Market"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}}}},"post":{"summary":"Create a market","tags":["Markets"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new market for the current store.\n\n- `country_codes` accepts 2-letter ISO country codes (e.g. `[\"DE\", \"FR\"]`);\n the market must contain at least one country. Unknown codes are\n silently dropped.\n- `supported_locales` accepts an array of locale codes; the\n `default_locale` is always implicitly included.\n- Setting `default: true` automatically demotes the previous default\n market in the store.\n\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"market created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Market"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"currency":{"type":"string","description":"ISO 4217 currency code."},"default_locale":{"type":"string","description":"IETF locale tag used as the market default."},"supported_locales":{"type":"array","items":{"type":"string"},"description":"Locale codes available in this market. The default is always implicitly included."},"tax_inclusive":{"type":"boolean","default":false,"description":"Display prices with tax included."},"default":{"type":"boolean","default":false,"description":"Setting to true demotes the previous default."},"position":{"type":"integer","description":"Sort order within the store; lower = first."},"country_codes":{"type":"array","items":{"type":"string"},"description":"2-letter ISO country codes assigned to this market. At least one is required."}},"required":["name","currency","default_locale","country_codes"]}}}}}},"/api/v3/admin/markets/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a market","tags":["Markets"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"market found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Market"}}}},"404":{"description":"market not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a market","tags":["Markets"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates an existing market. Pass `country_codes` to replace the\nmarket's country list (full-set update), `supported_locales` to\nreplace the supported locales, or `position` to reorder the market\nwithin the store.\n\nSetting `default: true` automatically demotes the previous default.\n\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"market updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Market"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"currency":{"type":"string"},"default_locale":{"type":"string"},"supported_locales":{"type":"array","items":{"type":"string"}},"tax_inclusive":{"type":"boolean"},"default":{"type":"boolean"},"position":{"type":"integer"},"country_codes":{"type":"array","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete a market","tags":["Markets"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes the market (sets `deleted_at`). The default market and\nthe last remaining market in a store cannot be deleted — both return\n422 with a `validation_error`.\n\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"market deleted"},"422":{"description":"cannot delete default or last market","content":{"application/json":{}}}}}},"/api/v3/admin/option_types":{"get":{"summary":"List option types","tags":["Option Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a paginated list of option types.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[name_cont]","in":"query","required":false,"description":"Filter by name (contains)","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., option_values). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., name,label,position). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"option types found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OptionType"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create an option type","tags":["Option Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new option type. Supports nested option values.\n\nOption values can be provided inline and will be created or updated by name.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"option type created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionType"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"position":{"type":"integer"},"filterable":{"type":"boolean"},"option_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"position":{"type":"integer"}}}}},"required":["name","label"]}}}}}},"/api/v3/admin/option_types/{id}":{"get":{"summary":"Get an option type","tags":["Option Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single option type by ID, including its option values.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Option type ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., option_values). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., name,label,position). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"option type found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionType"}}}},"404":{"description":"option type not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update an option type","tags":["Option Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates an option type. Supports updating nested option values.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Option type ID","schema":{"type":"string"}}],"responses":{"200":{"description":"option type updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionType"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"position":{"type":"integer"},"filterable":{"type":"boolean"},"option_values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Existing option value ID to update"},"name":{"type":"string"},"label":{"type":"string"},"position":{"type":"integer"}}}}}}}}}},"delete":{"summary":"Delete an option type","tags":["Option Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes an option type.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Option type ID","schema":{"type":"string"}}],"responses":{"204":{"description":"option type deleted"}}}},"/api/v3/admin/orders/{order_id}/tax_lines":{"get":{"summary":"List tax lines","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Typed tax rows on the order. Read-only — written exclusively by the tax provider.\n\n**Required scope:** `read_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order prefixed ID","schema":{"type":"string"}}],"responses":{"200":{"description":"tax lines found","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{order_id}/discounts":{"get":{"summary":"List discounts","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Typed discount rows (promotion-sourced and manual) on the order.\n\n**Required scope:** `read_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order prefixed ID","schema":{"type":"string"}}],"responses":{"200":{"description":"discounts found","content":{"application/json":{}}}}},"post":{"summary":"Create manual discount","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a manual discount. With line_item_id a single row is created; without it the amount is distributed across line items (largest remainder). This is the sanctioned post-placement discount path and works on completed orders.\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order prefixed ID","schema":{"type":"string"}}],"responses":{"201":{"description":"discount created","content":{"application/json":{}}},"422":{"description":"invalid discount","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"number"},"value_type":{"type":"string","enum":["flat","percent"]},"line_item_id":{"type":"string","nullable":true,"description":"Target line item; omit to distribute order-level"}},"required":["label","value"]}}}}}},"/api/v3/admin/orders/{order_id}/fees":{"post":{"summary":"Create fee","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a fee (surcharge, handling, gift wrap, COD, payment fee). Order-level when no target is given. Works on completed orders.\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order prefixed ID","schema":{"type":"string"}}],"responses":{"201":{"description":"fee created","content":{"application/json":{}}},"422":{"description":"invalid fee","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string"},"amount":{"type":"number"},"kind":{"type":"string","enum":["surcharge","handling","gift_wrap","cod","payment","duty"],"description":"Defaults to 'surcharge'"},"line_item_id":{"type":"string","nullable":true},"fulfillment_id":{"type":"string","nullable":true}},"required":["label","amount"]}}}}}},"/api/v3/admin/orders/{order_id}/gift_cards":{"post":{"summary":"Apply a gift card to an order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Applies a gift card by code to the order. Returns the gift card.\n\n**Required scope:** `write_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"201":{"description":"gift card applied","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"Gift card code"}}}}}}}},"/api/v3/admin/orders/{order_id}/gift_cards/{id}":{"delete":{"summary":"Remove a gift card from an order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes the gift card from the order.\n\n**Required scope:** `write_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Gift card ID","schema":{"type":"string"}}],"responses":{"204":{"description":"gift card removed"}}}},"/api/v3/admin/orders/{order_id}/items":{"get":{"summary":"List order items","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns all line items for an order.\n\n**Required scope:** `read_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., variant, variant.product). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., quantity,price,total). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"items found","content":{"application/json":{}}}}},"post":{"summary":"Add an item","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Adds a new line item to the order.\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"201":{"description":"item added","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["variant_id"],"properties":{"variant_id":{"type":"string","description":"Prefixed variant ID"},"quantity":{"type":"integer","default":1}}}}}}}},"/api/v3/admin/orders/{order_id}/items/{id}":{"get":{"summary":"Show an item","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns details of a specific line item.\n\n**Required scope:** `read_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Item ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., variant, variant.product). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., quantity,price,total). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"item found","content":{"application/json":{}}}}},"patch":{"summary":"Update an item","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates an order item quantity or metadata.\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Item ID","schema":{"type":"string"}}],"responses":{"200":{"description":"item updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"quantity":{"type":"integer"}}}}}}},"delete":{"summary":"Remove an item","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes an item from the order.\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Item ID","schema":{"type":"string"}}],"responses":{"204":{"description":"line item removed"}}}},"/api/v3/admin/orders/{order_id}/store_credits":{"post":{"summary":"Apply customer's store credit to an order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Applies the order customer's available store credit. When `amount` is omitted, applies up to the order outstanding balance.\n\n**Required scope:** `write_store_credits` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"201":{"description":"store credit applied","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"string","description":"Optional explicit amount; defaults to order outstanding balance"}}}}}}},"delete":{"summary":"Remove store credit from an order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes any applied store credit from the order.\n\n**Required scope:** `write_store_credits` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"204":{"description":"store credit removed"}}}},"/api/v3/admin/orders":{"get":{"summary":"List orders","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a paginated list of orders for the current store.\n\n**Required scope:** `read_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"sort","in":"query","required":false,"description":"Sort field (e.g., created_at, -created_at, completed_at)","schema":{"type":"string"}},{"name":"q[state_eq]","in":"query","required":false,"description":"Filter by state (cart, address, delivery, payment, confirm, complete, canceled)","schema":{"type":"string"}},{"name":"q[email_cont]","in":"query","required":false,"description":"Filter by email (contains)","schema":{"type":"string"}},{"name":"q[number_eq]","in":"query","required":false,"description":"Filter by order number","schema":{"type":"string"}},{"name":"q[completed_at_gt]","in":"query","required":false,"description":"Filter by completed after date","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., items, fulfillments, payments, customer, discounts, billing_address, shipping_address). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., number,total,status,completed_at). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"orders found","content":{"application/json":{}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a draft order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new draft order in one shot. Customer, items, addresses, currency,\nmarket, channel, locale, notes, metadata, and a coupon code can all be\nprovided inline.\n\nSetting `preferred_stock_location_id` pins the order's preferred fulfillment\nlocation — Order Routing's built-in `PreferredLocation` rule consumes it\nwhen picking which stock location ships each shipment.\n\nInvalid coupon codes are non-fatal — the order is created and the failure\nis reported on the service result (not in the API response body for now).\n\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"order created with preferred_stock_location_id","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"customer_id":{"type":"string","description":"Customer ID. Alias: user_id (legacy)."},"use_customer_default_address":{"type":"boolean","description":"When true with customer_id, copies the customer's saved billing/shipping addresses onto the order."},"currency":{"type":"string"},"market_id":{"type":"string","description":"Market ID"},"channel_id":{"type":"string","description":"Channel ID. Defaults to the store primary channel when omitted."},"preferred_stock_location_id":{"type":"string","description":"Stock Location ID to prefer for fulfillment. Order Routing's built-in PreferredLocation rule reads this and ranks the location first; routing falls back to the next rule when the preferred location can't cover the cart."},"locale":{"type":"string"},"customer_note":{"type":"string","description":"Public, customer-visible note"},"internal_note":{"type":"string","description":"Staff-only note"},"metadata":{"type":"object","description":"Arbitrary key/value metadata"},"shipping_address":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"address1":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"country_code":{"type":"string"},"state_code":{"type":"string"},"phone":{"type":"string"}}},"shipping_address_id":{"type":"string","description":"Existing customer address ID"},"billing_address":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"address1":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"country_code":{"type":"string"},"state_code":{"type":"string"},"phone":{"type":"string"}}},"billing_address_id":{"type":"string","description":"Existing customer address ID"},"items":{"type":"array","items":{"type":"object","required":["variant_id","quantity"],"properties":{"variant_id":{"type":"string","description":"Variant ID"},"quantity":{"type":"integer"},"metadata":{"type":"object"}}}},"coupon_code":{"type":"string","description":"Optional. Applied non-fatally; invalid codes do not block creation."}}}}}}}},"/api/v3/admin/orders/{id}":{"get":{"summary":"Show an order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns full order details including admin-only fields.\n\n**Required scope:** `read_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Order ID (e.g., or_xxx)","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., items, fulfillments, payments, customer, discounts, billing_address, shipping_address). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., number,total,status,completed_at). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"order found","content":{"application/json":{}}},"404":{"description":"order not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update an order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates an order. Supports updating email, addresses, special instructions, and line items.\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"200":{"description":"order updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"customer_note":{"type":"string"},"internal_note":{"type":"string"},"channel_id":{"type":"string","description":"Channel ID"},"preferred_stock_location_id":{"type":"string","description":"Stock Location ID to prefer for fulfillment. Re-runs Order Routing's PreferredLocation rule on subsequent shipment rebuilds."},"ship_address":{"type":"object","properties":{"firstname":{"type":"string"},"lastname":{"type":"string"},"address1":{"type":"string"},"city":{"type":"string"},"zipcode":{"type":"string"},"country_code":{"type":"string"},"state_code":{"type":"string"},"phone":{"type":"string"}}},"bill_address":{"type":"object","properties":{"firstname":{"type":"string"},"lastname":{"type":"string"},"address1":{"type":"string"},"city":{"type":"string"},"zipcode":{"type":"string"},"country_code":{"type":"string"},"state_code":{"type":"string"},"phone":{"type":"string"}}},"items":{"type":"array","items":{"type":"object","required":["variant_id"],"properties":{"variant_id":{"type":"string","description":"Variant ID"},"quantity":{"type":"integer"},"metadata":{"type":"object"}}}}}}}}}},"delete":{"summary":"Delete a draft order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes a draft order. Completed orders cannot be deleted.\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"204":{"description":"order deleted"}}}},"/api/v3/admin/orders/{id}/complete":{"patch":{"summary":"Complete an order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Completes an order in the `confirm` state, marking it as placed.\n\nSet `notify_customer: true` to send the order confirmation email.\n\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"200":{"description":"order completed","content":{"application/json":{}}},"422":{"description":"order cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"notify_customer":{"type":"boolean","description":"Send the order confirmation email after completion."}}}}}}}},"/api/v3/admin/orders/{id}/cancel":{"patch":{"summary":"Cancel an order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Cancels a completed order.\n\nSet `notify_customer: true` to send the order cancellation email.\n\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"200":{"description":"order canceled","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"notify_customer":{"type":"boolean","description":"Send the order cancellation email after canceling."}}}}}}}},"/api/v3/admin/orders/{id}/approve":{"patch":{"summary":"Approve an order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Approves an order (e.g., for fraud review).\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"200":{"description":"order approved","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{id}/resume":{"patch":{"summary":"Resume a canceled order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Resumes a previously canceled order.\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"200":{"description":"order resumed","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{id}/resend_confirmation":{"post":{"summary":"Resend confirmation email","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Publishes the order.completed event to trigger confirmation email delivery.\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"200":{"description":"confirmation resent","content":{"application/json":{}}}}}},"/api/v3/admin/payment_methods":{"get":{"summary":"List payment methods","tags":["Payment Methods"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the store's configured payment methods. Use `source_required: true` to know which methods need a saved source.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand. Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., name,type,active). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"payment methods found","content":{"application/json":{}}}}}},"/api/v3/admin/payment_methods/types":{"get":{"summary":"List available payment provider types","tags":["Payment Methods"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the registered Spree::PaymentMethod subclasses that can be used to create new payment methods. Useful for populating a \"Provider\" dropdown in admin UIs.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"provider types found","content":{"application/json":{}}}}}},"/api/v3/admin/payment_methods/{id}":{"get":{"summary":"Show a payment method","tags":["Payment Methods"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a payment method by ID.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand. Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., name,type,active). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"payment method found","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{order_id}/payments":{"get":{"summary":"List payments","tags":["Payments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns all payments for an order.\n\n**Required scope:** `read_payments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., payment_method, source). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., amount,status,number,response_code). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"payments found","content":{"application/json":{}}}}},"post":{"summary":"Create a payment","tags":["Payments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new payment for the order.\n\n**Required scope:** `write_payments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"201":{"description":"payment created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["payment_method_id"],"properties":{"payment_method_id":{"type":"string","description":"Payment method ID"},"amount":{"type":"string"},"source_id":{"type":"string","description":"Payment source ID"}}}}}}}},"/api/v3/admin/orders/{order_id}/payments/{id}":{"get":{"summary":"Show a payment","tags":["Payments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns details of a specific payment.\n\n**Required scope:** `read_payments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Payment ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., payment_method, source). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., amount,status,number,response_code). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"payment found","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{order_id}/payments/{id}/capture":{"patch":{"summary":"Capture a payment","tags":["Payments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Captures a pending payment.\n\n**Required scope:** `write_payments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Payment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"payment captured","content":{"application/json":{}}},"422":{"description":"capture failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/orders/{order_id}/payments/{id}/void":{"patch":{"summary":"Void a payment","tags":["Payments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Voids a payment.\n\n**Required scope:** `write_payments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Payment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"payment voided","content":{"application/json":{}}}}}},"/api/v3/admin/price_lists":{"get":{"summary":"List price lists","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the price lists configured for the current store.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"}},{"name":"q[name_cont]","in":"query","required":false,"schema":{"type":"string"}},{"name":"q[status_eq]","in":"query","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to embed. Supported: `price_rules`.","schema":{"type":"string"}}],"responses":{"200":{"description":"price lists found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PriceList"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}}}},"post":{"summary":"Create a price list","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new draft price list.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"price list created (server-to-server — rules + prices, no product_ids)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceList"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true},"starts_at":{"type":"string","nullable":true},"ends_at":{"type":"string","nullable":true},"match_policy":{"type":"string","enum":["all","any"]},"position":{"type":"integer"},"product_ids":{"type":"array","items":{"type":"string"},"description":"Prefixed product ids to seed the list with."},"rules":{"type":"array","description":"STI-typed price rules to attach on create. Existing rules on the same payload via PATCH reconcile by id.","items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true}}}},"prices":{"type":"array","description":"Server-to-server alternative to `product_ids`: ship the exact per-variant prices the list should contain. Each row upserts on the unique key `(variant_id, currency, price_list_id)`. Mix-and-match with `product_ids` is supported but typically unnecessary — `prices` alone tells the server which variants belong to the list and what the override amount is.","items":{"type":"object","required":["variant_id","currency"],"properties":{"variant_id":{"type":"string"},"currency":{"type":"string"},"amount":{"type":"string","nullable":true},"compare_at_amount":{"type":"string","nullable":true}}}}}}}}}}},"/api/v3/admin/price_lists/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a price list","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"price list found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceList"}}}},"404":{"description":"price list not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a price list","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a price list. The optional `rules:` array reconciles nested\nSTI-typed price rules in a single round-trip — existing rules update\nby `id`, new rules build, missing rules destroy. Mirrors the\npromotion editor's \"save the whole thing on Save\" pattern.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"price list updated with nested rules","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceList"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true},"starts_at":{"type":"string","nullable":true},"ends_at":{"type":"string","nullable":true},"match_policy":{"type":"string","enum":["all","any"]},"position":{"type":"integer"},"product_ids":{"type":"array","items":{"type":"string"},"description":"Prefixed product ids — reconciles list membership (adds + removes)."},"rules":{"type":"array","items":{"type":"object","required":["type"],"properties":{"id":{"type":"string","nullable":true},"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true}}}},"prices":{"type":"array","description":"Individual price overrides (the spreadsheet payload). Each row updates by `id` if shipped, otherwise upserts on the unique key `(variant_id, currency, price_list_id)`.","items":{"type":"object","oneOf":[{"required":["id"]},{"required":["variant_id","currency"]}],"properties":{"id":{"type":"string"},"variant_id":{"type":"string"},"currency":{"type":"string"},"amount":{"type":"string","nullable":true},"compare_at_amount":{"type":"string","nullable":true}}}}}}}}}},"delete":{"summary":"Delete a price list","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes the price list. Associated prices are removed asynchronously.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"price list deleted"}}}},"/api/v3/admin/price_lists/{id}/activate":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"patch":{"summary":"Activate a price list","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Transitions a draft / inactive list to `active`. If `starts_at` is\nin the future the list is marked `scheduled` instead, matching the\nlegacy admin behaviour.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"price list activated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceList"}}}}}}},"/api/v3/admin/price_lists/{id}/deactivate":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"patch":{"summary":"Deactivate a price list","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"price list deactivated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceList"}}}}}}},"/api/v3/admin/prices":{"get":{"summary":"List prices","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Generic prices endpoint covering both base prices and price-list\noverrides. Filter with Ransack: `q[price_list_id_eq]=…`,\n`q[currency_eq]=USD`, `q[price_list_id_null]=true` (base prices only).\n\nThe admin spreadsheet uses this with server-side pagination so it\nscales past the metadata-PATCH path on `/price_lists/:id`.\n\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"}},{"name":"q[price_list_id_eq]","in":"query","required":false,"schema":{"type":"string"}},{"name":"q[price_list_id_null]","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"q[currency_eq]","in":"query","required":false,"schema":{"type":"string"}},{"name":"q[variant_id_eq]","in":"query","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Comma-separated sort keys. Supports e.g. `variant_product_name,variant_id`.","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to embed. Supported: `variant`.","schema":{"type":"string"}}],"responses":{"200":{"description":"prices found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Price"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}}}},"post":{"summary":"Create a price","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a single price. Omit `price_list_id` to create a base price.\nFor more than a handful of rows, prefer `POST /admin/prices/bulk_upsert`.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"price created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Price"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["variant_id","currency"],"properties":{"variant_id":{"type":"string"},"currency":{"type":"string"},"amount":{"type":"string","nullable":true},"compare_at_amount":{"type":"string","nullable":true},"price_list_id":{"type":"string","nullable":true}}}}}}}},"/api/v3/admin/prices/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a price","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"price found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Price"}}}},"404":{"description":"price not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a price","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"price updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Price"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"string","nullable":true},"compare_at_amount":{"type":"string","nullable":true}}}}}}},"delete":{"summary":"Delete a price","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes the price (acts_as_paranoid).\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"price deleted"}}}},"/api/v3/admin/prices/bulk_upsert":{"post":{"summary":"Bulk-upsert prices","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Upserts a batch of prices in a single SQL round trip.\n\nEach row either:\n* targets an existing price by `id`, OR\n* matches on the unique key `(variant_id, currency, price_list_id)` —\n updating the existing row if one exists, creating one otherwise.\n\nModel callbacks (e.g. PriceHistory) are bypassed; this is a\nbulk-write fast path for the admin spreadsheet. The response\ncarries `price_count` — the number of rows touched.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"prices upserted","content":{"application/json":{"schema":{"type":"object","properties":{"price_count":{"type":"integer"}}}}}},"422":{"description":"missing prices key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["prices"],"properties":{"prices":{"type":"array","items":{"type":"object","required":["variant_id","currency"],"properties":{"id":{"type":"string","nullable":true},"variant_id":{"type":"string"},"currency":{"type":"string"},"price_list_id":{"type":"string","nullable":true},"amount":{"type":"string","nullable":true},"compare_at_amount":{"type":"string","nullable":true}}}}}}}}}}},"/api/v3/admin/prices/bulk_destroy":{"delete":{"summary":"Bulk-delete prices","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes each price in `ids`. Returns the count actually destroyed.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"prices deleted","content":{"application/json":{"schema":{"type":"object","properties":{"price_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/products/{product_id}/custom_fields":{"get":{"summary":"List product custom fields","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the product's custom field values.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., custom_field_definition). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., key,value,namespace). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"custom fields found","content":{"application/json":{}}}}},"post":{"summary":"Create a product custom field","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Sets a custom field value on the product. Requires an existing CustomFieldDefinition; pass its prefixed `cfdef_…` id.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"custom field created","content":{"application/json":{}}},"422":{"description":"duplicate definition for the same product","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["custom_field_definition_id","value"],"properties":{"custom_field_definition_id":{"type":"string","description":"Prefixed `cfdef_…` id"},"value":{"description":"Value matching the definition's `field_type`"}}}}}}}},"/api/v3/admin/products/{product_id}/custom_fields/{id}":{"get":{"summary":"Show a product custom field","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., custom_field_definition). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., key,value,namespace). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"custom field found","content":{"application/json":{}}}}},"patch":{"summary":"Update a product custom field","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates the custom field's `value`. The linked definition cannot be changed — delete and recreate to switch.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"custom field updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["value"],"properties":{"value":{"description":"New value"}}}}}}},"delete":{"summary":"Delete a product custom field","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"custom field deleted"}}}},"/api/v3/admin/products/{product_id}/translations":{"get":{"summary":"List product translations","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the full translation matrix for the product: the source value and content type per translatable field, plus the translated value for every supported locale.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"translations found","content":{"application/json":{}}}}}},"/api/v3/admin/products":{"get":{"summary":"List products","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a paginated list of products for the current store.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"sort","in":"query","required":false,"description":"Sort field (e.g., name, -name, price, -price, best_selling)","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., variants, media, option_types, categories). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., name,slug,price,status). id is always included.","schema":{"type":"string"}},{"name":"q[name_cont]","in":"query","required":false,"description":"Filter by name (contains)","schema":{"type":"string"}},{"name":"q[status_eq]","in":"query","required":false,"description":"Filter by status","schema":{"type":"string"}}],"responses":{"200":{"description":"products found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a product","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new product. Supports nested variants with prices and option types.\n\nOption types and values are auto-created if they don't exist.\nPrices are upserted by currency. Stock items are upserted by stock location.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"product created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"slug":{"type":"string"},"status":{"type":"string","enum":["draft","active","archived"]},"tax_category_id":{"type":"string","description":"Tax category ID"},"category_ids":{"type":"array","items":{"type":"string"},"description":"Array of category IDs"},"tags":{"type":"array","items":{"type":"string"}},"prices":{"type":"array","description":"Shorthand for a simple (no-options) product: per-currency prices that forward to the product's sole variant. For products with options, set prices per variant under `variants:` instead.","items":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"string"},"amount":{"type":"string"},"compare_at_amount":{"type":"string","nullable":true}}}},"variants":{"type":"array","description":"Array of variant payloads. Variants can declare multiple option pairs via `options:` and per-currency prices via `prices:`. Stock counts go in `stock_items:` (per stock location).","items":{"type":"object","properties":{"sku":{"type":"string"},"options":{"type":"array","description":"One pair per option type the variant participates in (e.g. size + color). Option types and values are auto-created if missing.","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"prices":{"type":"array","description":"Per-currency prices. Upserted by currency.","items":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"string"},"amount":{"type":"string"},"compare_at_amount":{"type":"string","nullable":true}}}},"stock_items":{"type":"array","description":"Per-stock-location inventory. Upserted by stock_location_id.","items":{"type":"object","required":["stock_location_id","count_on_hand"],"properties":{"stock_location_id":{"type":"string","description":"Stock location ID (e.g. sloc_xxx)"},"count_on_hand":{"type":"integer"},"backorderable":{"type":"boolean"}}}}}}}},"required":["name"]}}}}}},"/api/v3/admin/products/{id}":{"get":{"summary":"Get a product","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single product by ID.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Product ID (e.g., prod_xxx)","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., variants, media, option_types, categories). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., name,slug,price,status). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"product found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"404":{"description":"product not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a product","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a product. Only provided fields are updated.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}}],"responses":{"200":{"description":"product updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"slug":{"type":"string"},"status":{"type":"string","enum":["draft","active","archived"]},"tax_category_id":{"type":"string","description":"Tax category ID"},"category_ids":{"type":"array","items":{"type":"string"},"description":"Array of category IDs"},"tags":{"type":"array","items":{"type":"string"}},"prices":{"type":"array","description":"Shorthand for a simple (no-options) product: per-currency prices that forward to the product's sole variant. For products with options, set prices per variant under `variants:` instead.","items":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"string"},"amount":{"type":"string"},"compare_at_amount":{"type":"string","nullable":true}}}},"variants":{"type":"array","description":"Array of variant payloads. Variants can declare multiple option pairs via `options:` and per-currency prices via `prices:`. Stock counts go in `stock_items:` (per stock location).","items":{"type":"object","properties":{"sku":{"type":"string"},"options":{"type":"array","description":"One pair per option type the variant participates in (e.g. size + color). Option types and values are auto-created if missing.","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"prices":{"type":"array","description":"Per-currency prices. Upserted by currency.","items":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"string"},"amount":{"type":"string"},"compare_at_amount":{"type":"string","nullable":true}}}},"stock_items":{"type":"array","description":"Per-stock-location inventory. Upserted by stock_location_id.","items":{"type":"object","required":["stock_location_id","count_on_hand"],"properties":{"stock_location_id":{"type":"string","description":"Stock location ID (e.g. sloc_xxx)"},"count_on_hand":{"type":"integer"},"backorderable":{"type":"boolean"}}}}}}}}}}}}},"delete":{"summary":"Delete a product","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes a product.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}}],"responses":{"204":{"description":"product deleted"},"422":{"description":"deletion refused by a store rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/products/bulk_status_update":{"post":{"summary":"Bulk-update product status","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Sets `status` on each product in `ids`. Reindexes the affected products\nfor search. Cross-store IDs are silently dropped. Returns counts.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"cross-store products silently dropped","content":{"application/json":{"schema":{"type":"object","properties":{"product_count":{"type":"integer"},"status":{"type":"string"}}}}}},"422":{"description":"invalid status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","status"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"status":{"type":"string","enum":["draft","active","archived"]}}}}}}}},"/api/v3/admin/products/bulk_add_to_categories":{"post":{"summary":"Bulk-add products to categories","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Attaches each product in `ids` to every category (category) in `category_ids`.\nCategories from sibling stores are silently ignored.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"products added to categories","content":{"application/json":{"schema":{"type":"object","properties":{"product_count":{"type":"integer"},"category_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","category_ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"category_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/products/bulk_remove_from_categories":{"post":{"summary":"Bulk-remove products from categories","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Detaches each product in `ids` from every category in `category_ids`.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"products removed from categories","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","category_ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"category_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/products/bulk_add_to_collections":{"post":{"summary":"Bulk-add products to collections","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Attaches each product in `ids` to every manual collection in `collection_ids`.\nAutomatic (rule-based) and sibling-store collections are silently ignored.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"products added to collections","content":{"application/json":{"schema":{"type":"object","properties":{"product_count":{"type":"integer"},"collection_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","collection_ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"collection_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/products/bulk_remove_from_collections":{"post":{"summary":"Bulk-remove products from collections","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Detaches each product in `ids` from every collection in `collection_ids`.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"products removed from collections","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","collection_ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"collection_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/products/bulk_add_to_channels":{"post":{"summary":"Bulk-add products to channels","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Publishes each product in `ids` on every channel in `channel_ids`. Idempotent —\nre-publishing on an existing channel is a no-op. Channels from sibling stores\nare silently ignored.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"products published on channels","content":{"application/json":{"schema":{"type":"object","properties":{"product_count":{"type":"integer"},"channel_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","channel_ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"channel_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/products/bulk_remove_from_channels":{"post":{"summary":"Bulk-remove products from channels","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Unpublishes each product in `ids` from every channel in `channel_ids`.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"products unpublished from channels","content":{"application/json":{"schema":{"type":"object","properties":{"product_count":{"type":"integer"},"channel_count":{"type":"integer"},"removed":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","channel_ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"channel_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/products/bulk_add_tags":{"post":{"summary":"Bulk-add tags to products","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Adds each tag name in `tags` to every product in `ids`. Tags are upserted by name.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"tags added","content":{"application/json":{"schema":{"type":"object","properties":{"product_count":{"type":"integer"},"tag_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","tags"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/products/bulk_remove_tags":{"post":{"summary":"Bulk-remove tags from products","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes each tag in `tags` from every product in `ids`.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"tags removed","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","tags"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/products/bulk_destroy":{"delete":{"summary":"Bulk-delete products","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes each product in `ids`. Returns the count actually destroyed.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"products deleted","content":{"application/json":{"schema":{"type":"object","properties":{"product_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/promotions/{promotion_id}/coupon_codes":{"parameters":[{"name":"promotion_id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"List coupon codes for a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the auto-generated coupon codes for a multi-code promotion. Single-code promotions store the code on the promotion itself; this endpoint returns an empty list for them.\n\n**Required scope:** `read_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"coupon codes found","content":{"application/json":{}}}}}},"/api/v3/admin/promotions/{promotion_id}/promotion_actions":{"parameters":[{"name":"promotion_id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"List actions for a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"actions found","content":{"application/json":{}}}}},"post":{"summary":"Create an action on a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Adds a new action to a promotion. The `type` is the wire shorthand from `GET /promotion_actions/types` (e.g. `free_shipping`, `create_item_adjustments`). Fully-qualified Ruby class names are also accepted for backward compatibility.\n\n**Required scope:** `write_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"action created","content":{"application/json":{}}},"422":{"description":"unknown action type","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true}},"required":["type"]}}}}}},"/api/v3/admin/promotions/{promotion_id}/promotion_actions/{id}":{"parameters":[{"name":"promotion_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"delete":{"summary":"Delete an action from a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"action deleted"}}}},"/api/v3/admin/promotions/{promotion_id}/promotion_rules":{"parameters":[{"name":"promotion_id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"List rules for a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"rules found","content":{"application/json":{}}}}},"post":{"summary":"Create a rule on a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Adds a new rule to a promotion. The `type` is the wire shorthand from `GET /promotion_rules/types` (e.g. `currency`, `item_total`, `product`). Fully-qualified Ruby class names are also accepted for backward compatibility.\n\n**Required scope:** `write_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"rule created with preferences","content":{"application/json":{}}},"422":{"description":"unknown rule type","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true}},"required":["type"]}}}}}},"/api/v3/admin/promotions/{promotion_id}/promotion_rules/{id}":{"parameters":[{"name":"promotion_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"patch":{"summary":"Update a rule's preferences","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"rule updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"preferences":{"type":"object","additionalProperties":true}}}}}}},"delete":{"summary":"Delete a rule from a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"rule deleted"}}}},"/api/v3/admin/promotions":{"get":{"summary":"List promotions","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the store's promotions, including manual coupon and automatic promotions.\n\n**Required scope:** `read_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"promotions found","content":{"application/json":{}}}}},"post":{"summary":"Create a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new promotion. `code` is required for single-code coupon promotions;\npass `multi_codes: true` with `number_of_codes` to auto-generate a batch.\n\nRules and actions can be created in the same request by passing arrays of\n`{ type, preferences, ... }` rows. The server reconciles to the desired set:\nnew rows are built, existing rows (by `id`) are updated, omitted rows are removed.\n\n\n**Required scope:** `write_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"promotion created with rules and actions","content":{"application/json":{}}},"422":{"description":"invalid params","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"starts_at":{"type":"string","format":"date-time","nullable":true},"expires_at":{"type":"string","format":"date-time","nullable":true},"usage_limit":{"type":"integer","nullable":true},"match_policy":{"type":"string","enum":["all","any"]},"kind":{"type":"string","enum":["coupon_code","automatic"]},"multi_codes":{"type":"boolean"},"number_of_codes":{"type":"integer","nullable":true},"code_prefix":{"type":"string","nullable":true},"promotion_category_id":{"type":"string","nullable":true},"rules":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true},"product_ids":{"type":"array","items":{"type":"string"}},"category_ids":{"type":"array","items":{"type":"string"}},"customer_ids":{"type":"array","items":{"type":"string"}}},"required":["type"]}},"actions":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true},"calculator":{"type":"object","properties":{"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true}}}},"required":["type"]}}},"required":["name"]}}}}}},"/api/v3/admin/promotions/{id}":{"get":{"summary":"Show a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"promotion found","content":{"application/json":{}}}}},"patch":{"summary":"Update a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a promotion. The `rules` and `actions` arrays are treated as\na *desired set* — rows with `id` update in place, rows without `id` are\nbuilt fresh, and any existing row not present in the array is destroyed.\nPass `rules: []` or `actions: []` to clear them.\n\n\n**Required scope:** `write_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"rules and actions cleared with empty arrays","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"starts_at":{"type":"string","format":"date-time","nullable":true},"expires_at":{"type":"string","format":"date-time","nullable":true},"usage_limit":{"type":"integer","nullable":true},"match_policy":{"type":"string","enum":["all","any"]},"kind":{"type":"string","enum":["coupon_code","automatic"]},"promotion_category_id":{"type":"string","nullable":true},"rules":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"description":"Pass to update an existing rule; omit to build a new one"},"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true},"product_ids":{"type":"array","items":{"type":"string"}},"category_ids":{"type":"array","items":{"type":"string"}},"customer_ids":{"type":"array","items":{"type":"string"}}},"required":["type"]}},"actions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true},"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true},"calculator":{"type":"object","properties":{"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true}}}},"required":["type"]}}}}}}}},"delete":{"summary":"Delete a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"promotion deleted"}}}},"/api/v3/admin/promotion_actions/types":{"get":{"summary":"List available promotion action types","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the registered Spree::PromotionAction subclasses with their preference schemas. Used by admin UIs to populate the \"Add action\" picker and render generic preference forms.\n\n**Required scope:** `read_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"action types found","content":{"application/json":{}}}}}},"/api/v3/admin/promotion_rules/types":{"get":{"summary":"List available promotion rule types","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the registered Spree::PromotionRule subclasses with their preference schemas.\n\n**Required scope:** `read_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"rule types found","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{order_id}/refunds":{"get":{"summary":"List refunds","tags":["Refunds"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns all refunds for an order.\n\n**Required scope:** `read_refunds` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., payment, refund_reason). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., amount,reason,transaction_id). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"refunds found","content":{"application/json":{}}}}},"post":{"summary":"Create a refund","tags":["Refunds"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a refund for a payment on the order. The refund is automatically processed via the payment gateway.\n\n**Required scope:** `write_refunds` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"201":{"description":"refund created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["payment_id","amount"],"properties":{"payment_id":{"type":"string","description":"Payment ID"},"amount":{"type":"string"},"refund_reason_id":{"type":"string","description":"Refund reason ID"}}}}}}}},"/api/v3/admin/locales":{"get":{"summary":"List supported locales","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the locales a merchant can translate content into for the current store, with the default and right-to-left flags.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"locales found","content":{"application/json":{}}}}}},"/api/v3/admin/store":{"get":{"summary":"Get the current store","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the current store configuration. The store is resolved from the request context (host or admin selection); there is no `id` parameter.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"current store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update the current store","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates the current store configuration.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"store updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"preferred_admin_locale":{"type":"string"},"preferred_timezone":{"type":"string"},"preferred_weight_unit":{"type":"string"},"preferred_unit_system":{"type":"string"}}}}}}}},"/api/v3/admin/tags":{"get":{"summary":"List tags","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns tag names for a given taggable type. Used for autocomplete in tag inputs on products, orders, and customers.","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"taggable_type","in":"query","required":true,"description":"Taggable type (`Spree::Product`, `Spree::Order`, or `Spree::User`)","schema":{"type":"string"}},{"name":"q","in":"query","required":false,"description":"Optional case-insensitive substring filter","schema":{"type":"string"}}],"responses":{"200":{"description":"tags found","content":{"application/json":{}}},"422":{"description":"invalid taggable type","content":{"application/json":{}}}}}},"/api/v3/admin/tax_rates":{"get":{"summary":"List tax rates","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the store's tax rates. Rates are the entire configuration of\nthe built-in tax provider: each pairs a tax category with a jurisdiction\n(a country, optionally narrowed to one state) and a percentage, and\ndecides whether the tax is already included in the product price\n(VAT-style) or added on top (US-style).\n\nMarkets using an external tax provider ignore these rows — that\nprovider carries its own jurisdiction data.\n\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[name_cont]","in":"query","required":false,"description":"Filter by name (contains)","schema":{"type":"string"}},{"name":"q[included_in_price_true]","in":"query","required":false,"description":"Only rates included in the product price","schema":{"type":"boolean"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-created_at`).","schema":{"type":"string"}}],"responses":{"200":{"description":"tax rates found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TaxRate"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a tax rate","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a tax rate for the current store. Give either `amount` as a\ndecimal (`0.19`) or `amount_percentage` as a percentage (`19`).\n\nName the jurisdiction with `country_code` (and `state_code` for a\nstate-level rate). Omitting the country makes the rate apply everywhere.\n\nSet `included_in_price` for VAT-style pricing, where the rate is backed\nout of the displayed price rather than added to it.\n\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"tax rate created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRate"}}}},"422":{"description":"validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Customer-facing rate name, e.g. \"VAT\""},"amount":{"type":"string","description":"Rate as a decimal, e.g. \"0.19\""},"amount_percentage":{"type":"number","description":"Rate as a percentage, e.g. 19"},"included_in_price":{"type":"boolean"},"show_rate_in_label":{"type":"boolean"},"tax_category_id":{"type":"string"},"country_code":{"type":"string","description":"ISO code, e.g. \"DE\". Omit for every country."},"state_code":{"type":"string","description":"State abbreviation within that country, e.g. \"CA\"."}},"required":["name","tax_category_id"]}}},"required":true}}},"/api/v3/admin/tax_rates/{id}":{"parameters":[{"name":"id","in":"path","description":"Tax rate ID","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a tax rate","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"tax rate found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRate"}}}}}},"patch":{"summary":"Update a tax rate","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"tax rate updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRate"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"amount":{"type":"string"},"amount_percentage":{"type":"number"},"included_in_price":{"type":"boolean"},"show_rate_in_label":{"type":"boolean"},"tax_category_id":{"type":"string"},"country_code":{"type":"string"},"state_code":{"type":"string"}}}}},"required":true}},"delete":{"summary":"Delete a tax rate","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes the rate. Tax lines it already produced keep their own rate snapshot.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"204":{"description":"tax rate deleted"}}}},"/api/v3/admin/translatable_resources":{"get":{"summary":"List translatable resources","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns every translatable resource type and its translatable fields (key + content type), so clients can render translation editors generically.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"translatable resources found","content":{"application/json":{}}}}}},"/api/v3/admin/translations/batch":{"post":{"summary":"Batch upsert translations","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Atomically upserts translations across many records of (possibly) different translatable resource types in one request — e.g. an option type and all its option values in one save. A flat list of independent registry writes; all entries succeed or none do.\n\n**Required scope:** `write_<resource>` for every resource type in the batch (for API-key authentication) (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"translations upserted","content":{"application/json":{}}},"422":{"description":"unsupported locale rolls back the whole batch","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["translations"],"properties":{"translations":{"type":"array","items":{"type":"object","required":["resource_type","resource_id","values"],"properties":{"resource_type":{"type":"string","description":"Translatable resource type token, e.g. `option_type`"},"resource_id":{"type":"string","description":"Prefixed id of the record"},"values":{"type":"object","description":"Map of locale code to { field: value }","additionalProperties":{"type":"object","additionalProperties":true}}}}}}}}}}}},"/api/v3/admin/admin_users":{"get":{"summary":"List staff","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns admin users with at least one role assignment on the current store.\n\n**Required scope:** `read_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"staff found","content":{"application/json":{}}}}}},"/api/v3/admin/admin_users/{id}":{"get":{"summary":"Show a staff member","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"staff member found","content":{"application/json":{}}}}},"patch":{"summary":"Update a staff member","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates name fields and reassigns roles for the current store. `role_ids` is a complete replacement — roles not in the array are removed for this store.\n\n**Required scope:** `write_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"staff member updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"role_ids":{"type":"array","items":{"type":"string"}}}}}}}},"delete":{"summary":"Remove a staff member from this store","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes the user's role assignments on the current store. The account is preserved — the user keeps access to any other stores.\n\n**Required scope:** `write_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"staff removed from store"}}}},"/api/v3/admin/invitations":{"get":{"summary":"List invitations","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns invitations for the current store, including pending and accepted.\n\n**Required scope:** `read_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"invitations found","content":{"application/json":{}}}}},"post":{"summary":"Create an invitation","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Invites a teammate by email. The invitation is scoped to the current store and carries the chosen role; on accept, a `RoleUser` is created via the invitation's `after_accept` callback.\n\n**Required scope:** `write_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"invitation created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email","role_id"],"properties":{"email":{"type":"string"},"role_id":{"type":"string"}}}}}}}},"/api/v3/admin/invitations/{id}":{"delete":{"summary":"Revoke an invitation","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"invitation revoked"}}}},"/api/v3/admin/invitations/{id}/resend":{"patch":{"summary":"Resend an invitation","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Issues a fresh token and dispatches the invitation email again.\n\n**Required scope:** `write_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"invitation resent","content":{"application/json":{}}}}}},"/api/v3/admin/permissions":{"get":{"summary":"List the permission catalog","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the permission catalog — the grant vocabulary shared by staff role permissions and secret API key scopes. Entries are grouped for permission pickers; labels and descriptions are localized. Readable by any authenticated admin credential.","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"catalog returned","content":{"application/json":{}}}}}},"/api/v3/admin/roles":{"get":{"summary":"List roles","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns staff roles with their catalog permissions. Roles are global, not per-store; `mutable: false` marks the protected admin role and host-locked rows.\n\n**Required scope:** `read_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"roles found","content":{"application/json":{}}}}},"post":{"summary":"Create a role","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a staff role. `permissions` holds catalog keys (see GET /admin/permissions); a caller may only grant keys they effectively hold.\n\n**Required scope:** `write_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"role created","content":{"application/json":{}}},"422":{"description":"invalid request","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true},"permissions":{"type":"array","items":{"type":"string"}}},"required":["name"]}}}}}},"/api/v3/admin/roles/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"patch":{"summary":"Update a role","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a role name, description or permissions. The admin role and host-locked roles (`mutable: false`) reject changes.\n\n**Required scope:** `write_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"role updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true},"permissions":{"type":"array","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete a role","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes a role. Fails with 422 while the role is protected or still referenced by staff members or pending invitations.\n\n**Required scope:** `write_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"role deleted"},"422":{"description":"role cannot be deleted","content":{"application/json":{}}}}}},"/api/v3/admin/stock_locations":{"get":{"summary":"List stock locations","tags":["Stock Locations"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the configured stock locations. Stock locations are global\n(shared across stores). Filter with Ransack predicates such as\n`q[active_eq]`, `q[kind_eq]`, `q[pickup_enabled_eq]`, or\n`q[name_cont]`.\n\nPickup-related attributes (`kind`, `pickup_enabled`,\n`pickup_stock_policy`, `pickup_ready_in_minutes`,\n`pickup_instructions`) drive merchant pickup support at checkout —\ncustomers can collect orders from any active location with\n`pickup_enabled: true`.\n\n\n**Required scope:** `read_stock` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[name_cont]","in":"query","required":false,"description":"Filter by name (contains)","schema":{"type":"string"}},{"name":"q[active_eq]","in":"query","required":false,"description":"Filter by active status","schema":{"type":"boolean"}},{"name":"q[kind_eq]","in":"query","required":false,"description":"Filter by kind (built-in: 'warehouse', 'store', 'fulfillment_center')","schema":{"type":"string"}},{"name":"q[pickup_enabled_eq]","in":"query","required":false,"description":"Filter by pickup-enabled flag","schema":{"type":"boolean"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-created_at`).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"stock locations found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/StockLocation"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a stock location","tags":["Stock Locations"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new stock location.\n\nSetting `default: true` automatically demotes the previous default\nlocation.\n\n\n**Required scope:** `write_stock` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"stock location created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockLocation"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"admin_name":{"type":"string","nullable":true,"description":"Internal name shown only in the admin"},"active":{"type":"boolean"},"default":{"type":"boolean","description":"Setting to true demotes the previous default."},"kind":{"type":"string","enum":["warehouse","store","fulfillment_center"],"description":"Categorizes the location."},"propagate_all_variants":{"type":"boolean"},"backorderable_default":{"type":"boolean"},"address1":{"type":"string","nullable":true},"address2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"zipcode":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"country_code":{"type":"string","nullable":true,"description":"ISO-3166 alpha-2 country code (e.g. \"US\")."},"state_code":{"type":"string","nullable":true,"description":"State / province abbreviation (e.g. \"NY\"). Resolved against the selected country."},"state_name":{"type":"string","nullable":true,"description":"Free-text state for countries without a states list."},"pickup_enabled":{"type":"boolean"},"pickup_stock_policy":{"type":"string","enum":["local","any"],"description":"'local' = items at this location only; 'any' = transfer-eligible (ship-to-store)."},"pickup_ready_in_minutes":{"type":"number","nullable":true,"minimum":0},"pickup_instructions":{"type":"string","nullable":true}},"required":["name"]}}}}}},"/api/v3/admin/stock_locations/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Stock location ID","schema":{"type":"string"}}],"get":{"summary":"Get a stock location","tags":["Stock Locations"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single stock location by prefixed ID.\n\n**Required scope:** `read_stock` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"stock location found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockLocation"}}}},"404":{"description":"stock location not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a stock location","tags":["Stock Locations"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates an existing stock location. Same address-field conventions as\nthe create endpoint.\n\nSetting `default: true` automatically demotes the previous default.\n\n\n**Required scope:** `write_stock` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"stock location updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockLocation"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"admin_name":{"type":"string","nullable":true},"active":{"type":"boolean"},"default":{"type":"boolean"},"kind":{"type":"string","enum":["warehouse","store","fulfillment_center"]},"propagate_all_variants":{"type":"boolean"},"backorderable_default":{"type":"boolean"},"address1":{"type":"string","nullable":true},"address2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"zipcode":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"country_code":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true},"state_name":{"type":"string","nullable":true},"pickup_enabled":{"type":"boolean"},"pickup_stock_policy":{"type":"string","enum":["local","any"]},"pickup_ready_in_minutes":{"type":"number","nullable":true,"minimum":0},"pickup_instructions":{"type":"string","nullable":true}}}}}}},"delete":{"summary":"Delete a stock location","tags":["Stock Locations"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes the stock location (sets `deleted_at`). Existing\nfulfillments that referenced it keep the historical record via\n`Spree::StockLocation.with_deleted`.\n\n\n**Required scope:** `write_stock` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"204":{"description":"stock location deleted"}}}},"/api/v3/admin/products/{product_id}/variants":{"get":{"summary":"List product variants","tags":["Variants"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a paginated list of variants for a product, including the default variant.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., images, prices, stock_items, option_values). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., sku,price,stock). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"variants found","content":{"application/json":{}}}}},"post":{"summary":"Create a variant","tags":["Variants"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new variant for a product. Supports nested prices and stock items.\n\nOption types and values are auto-created if they don't exist.\nPrices are upserted by currency. Stock items are upserted by stock location.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}}],"responses":{"201":{"description":"variant created","content":{"application/json":{}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"cost_price":{"type":"string"},"cost_currency":{"type":"string"},"weight":{"type":"number"},"height":{"type":"number"},"width":{"type":"number"},"depth":{"type":"number"},"weight_unit":{"type":"string"},"dimensions_unit":{"type":"string"},"track_inventory":{"type":"boolean"},"tax_category_id":{"type":"string"},"options":{"type":"array","description":"A variant on a product with option types should declare its option pairs (e.g. size + color) — one per option type it participates in. Option types and values are auto-created if missing.","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"position":{"type":"integer"},"barcode":{"type":"string"},"prices":{"type":"array","description":"Per-currency prices. Upserted by currency.","items":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"string"},"amount":{"type":"string"},"compare_at_amount":{"type":"string","nullable":true}}}},"stock_items":{"type":"array","description":"Per-stock-location inventory. Upserted by stock_location_id.","items":{"type":"object","required":["stock_location_id","count_on_hand"],"properties":{"stock_location_id":{"type":"string","description":"Stock location ID (e.g. sloc_xxx)"},"count_on_hand":{"type":"integer"},"backorderable":{"type":"boolean"}}}}}}}}}}},"/api/v3/admin/products/{product_id}/variants/{id}":{"get":{"summary":"Get a variant","tags":["Variants"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single variant by ID.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Variant ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., images, prices, stock_items, option_values). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., sku,price,stock). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"variant found","content":{"application/json":{}}},"404":{"description":"variant not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a variant","tags":["Variants"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a variant. Only provided fields are updated.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Variant ID","schema":{"type":"string"}}],"responses":{"200":{"description":"variant updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"cost_price":{"type":"string"},"cost_currency":{"type":"string"},"weight":{"type":"number"},"height":{"type":"number"},"width":{"type":"number"},"depth":{"type":"number"},"weight_unit":{"type":"string"},"dimensions_unit":{"type":"string"},"track_inventory":{"type":"boolean"},"tax_category_id":{"type":"string"},"options":{"type":"array","description":"One pair per option type the variant participates in (e.g. size + color). Option types and values are auto-created if missing.","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"position":{"type":"integer"},"barcode":{"type":"string"},"prices":{"type":"array","description":"Per-currency prices. Upserted by currency.","items":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"string"},"amount":{"type":"string"},"compare_at_amount":{"type":"string","nullable":true}}}},"stock_items":{"type":"array","description":"Per-stock-location inventory. Upserted by stock_location_id.","items":{"type":"object","required":["stock_location_id","count_on_hand"],"properties":{"stock_location_id":{"type":"string","description":"Stock location ID (e.g. sloc_xxx)"},"count_on_hand":{"type":"integer"},"backorderable":{"type":"boolean"}}}}}}}}}},"delete":{"summary":"Delete a variant","tags":["Variants"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes a variant.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Variant ID","schema":{"type":"string"}}],"responses":{"204":{"description":"variant deleted"}}}},"/api/v3/admin/webhook_endpoints/{webhook_endpoint_id}/deliveries":{"parameters":[{"name":"webhook_endpoint_id","in":"path","required":true,"description":"Parent webhook endpoint ID","schema":{"type":"string"}}],"get":{"summary":"List webhook deliveries","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns delivery attempts for the given endpoint, most recent first.\nEach row carries the original request payload, the response code\n(when the receiver replied), the execution time, and any transport\nerror — everything needed to audit failures and decide whether to\nredeliver.\n\n\n**Required scope:** `read_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[event_name_eq]","in":"query","required":false,"description":"Filter by event name (exact)","schema":{"type":"string"}},{"name":"q[success_eq]","in":"query","required":false,"description":"Filter by success flag","schema":{"type":"boolean"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-delivered_at`).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"deliveries found","content":{"application/json":{}}},"404":{"description":"parent webhook endpoint not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/webhook_endpoints/{webhook_endpoint_id}/deliveries/{id}":{"parameters":[{"name":"webhook_endpoint_id","in":"path","required":true,"description":"Parent webhook endpoint ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Webhook delivery ID","schema":{"type":"string"}}],"get":{"summary":"Get a webhook delivery","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single delivery attempt with the full request payload and\nthe response body the receiver returned. Use this for ad-hoc debug\nof failed deliveries.\n\n\n**Required scope:** `read_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"delivery found","content":{"application/json":{}}},"404":{"description":"delivery not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/webhook_endpoints/{webhook_endpoint_id}/deliveries/{id}/redeliver":{"parameters":[{"name":"webhook_endpoint_id","in":"path","required":true,"description":"Parent webhook endpoint ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Webhook delivery ID to redeliver","schema":{"type":"string"}}],"post":{"summary":"Redeliver a webhook delivery","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new delivery row with the same payload + event_name and\nqueues it. The original row is preserved for audit history.\n\n\n**Required scope:** `write_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"redelivery queued","content":{"application/json":{}}}}}},"/api/v3/admin/webhook_endpoints":{"get":{"summary":"List webhook endpoints","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns outbound webhook subscriptions for the current store. Each\nendpoint receives a signed POST when any subscribed event fires.\n`secret_key` is `null` on list reads — the plaintext is delivered\nexactly once on create.\n\n\n**Required scope:** `read_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[name_cont]","in":"query","required":false,"description":"Filter by name (contains)","schema":{"type":"string"}},{"name":"q[url_cont]","in":"query","required":false,"description":"Filter by URL (contains)","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-created_at`).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"webhook endpoints found","content":{"application/json":{}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a webhook endpoint","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new outbound webhook subscription. The plaintext\n`secret_key` is returned **once** in this response — persist it\nimmediately to verify incoming webhook signatures. Subsequent reads\nreturn `null` for the secret. Pass an empty `subscriptions` array or\nomit it to receive every event.\n\n\n**Required scope:** `write_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"webhook endpoint created — secret_key returned once","content":{"application/json":{}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"name":{"type":"string"},"url":{"type":"string"},"active":{"type":"boolean"},"subscriptions":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/webhook_endpoints/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Webhook endpoint ID","schema":{"type":"string"}}],"get":{"summary":"Get a webhook endpoint","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single webhook endpoint by prefixed ID.\n\n**Required scope:** `read_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"webhook endpoint found","content":{"application/json":{}}},"404":{"description":"webhook endpoint not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a webhook endpoint","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates name, URL, active flag, or the event subscription list.\nToggling `active` here is equivalent to calling `disable`/`enable`\nwithout an audit reason.\n\n\n**Required scope:** `write_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"webhook endpoint updated","content":{"application/json":{}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"},"active":{"type":"boolean"},"subscriptions":{"type":"array","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete a webhook endpoint","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes the endpoint and stops future deliveries.\n\n**Required scope:** `write_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"204":{"description":"webhook endpoint deleted"}}}},"/api/v3/admin/webhook_endpoints/{id}/send_test":{"parameters":[{"name":"id","in":"path","required":true,"description":"Webhook endpoint ID","schema":{"type":"string"}}],"post":{"summary":"Send a test delivery","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a `webhook.test` delivery record and queues it. Use this to\nverify the endpoint is reachable and your signature verification\naccepts Spree's payloads.\n\n\n**Required scope:** `write_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"test delivery queued","content":{"application/json":{}}}}}},"/api/v3/admin/webhook_endpoints/{id}/enable":{"parameters":[{"name":"id","in":"path","required":true,"description":"Webhook endpoint ID","schema":{"type":"string"}}],"patch":{"summary":"Re-enable a webhook endpoint","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Re-enables an endpoint that was manually or automatically disabled.\n\n**Required scope:** `write_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"webhook endpoint enabled","content":{"application/json":{}}}}}},"/api/v3/admin/webhook_endpoints/{id}/disable":{"parameters":[{"name":"id","in":"path","required":true,"description":"Webhook endpoint ID","schema":{"type":"string"}}],"patch":{"summary":"Disable a webhook endpoint","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Manually pauses an endpoint. Unlike auto-disable (triggered after\nrepeated delivery failures), no notification email is sent.\n\n\n**Required scope:** `write_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"webhook endpoint disabled","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string"}}}}}}}},"/api/v3/admin/collections":{"get":{"summary":"List collections","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a paginated list of the store's collections.\n\n**Required scope:** `read_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., rules, custom_fields, translations).","schema":{"type":"string"}}],"responses":{"200":{"description":"collections found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Collection"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}}}},"post":{"summary":"Create a collection","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a manual or automatic (rule-based) collection. For automatic collections, send the full desired rule set under `rules`.\n\n**Required scope:** `write_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"collection created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collection"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"automatic":{"type":"boolean"},"rules_match_policy":{"type":"string","enum":["all","any"]},"sort_order":{"type":"string"},"permalink":{"type":"string"},"description":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"meta_keywords":{"type":"string"},"rules":{"type":"array","description":"Full desired rule set. Entries with an id update, id-less entries create, omitted rules are removed.","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"},"match_policy":{"type":"string"}}}}},"required":["name"]}}}}}},"/api/v3/admin/collections/{id}":{"get":{"summary":"Get a collection","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single collection by ID, including its rules.\n\n**Required scope:** `read_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Collection ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., rules, custom_fields, translations).","schema":{"type":"string"}}],"responses":{"200":{"description":"collection found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collection"}}}},"404":{"description":"collection not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a collection","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a collection. Send `position` to reorder it within the flat list; send the full `rules` set to sync automatic rules.\n\n**Required scope:** `write_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Collection ID","schema":{"type":"string"}}],"responses":{"200":{"description":"collection updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collection"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"permalink":{"type":"string"},"description":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"meta_keywords":{"type":"string"},"sort_order":{"type":"string"},"automatic":{"type":"boolean"},"rules_match_policy":{"type":"string","enum":["all","any"]},"position":{"type":"integer","description":"Reorders the collection within the flat list (acts_as_list)"},"rules":{"type":"array","description":"Full desired rule set (see create).","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"},"match_policy":{"type":"string"}}}}}}}}}},"delete":{"summary":"Delete a collection","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes a collection.\n\n**Required scope:** `write_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Collection ID","schema":{"type":"string"}}],"responses":{"204":{"description":"collection deleted"}}}},"/api/v3/admin/collections/{collection_id}/products":{"get":{"summary":"List collection products","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Products curated in the collection, ordered by their membership position.\n\n**Required scope:** `read_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"collection_id","in":"path","required":true,"description":"Collection ID","schema":{"type":"string"}}],"responses":{"200":{"description":"products found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}}}},"post":{"summary":"Add a product to a collection","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Curates a product into the collection (appended to the end).\n\n**Required scope:** `write_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"collection_id","in":"path","required":true,"description":"Collection ID","schema":{"type":"string"}}],"responses":{"201":{"description":"product added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"product_id":{"type":"string"}},"required":["product_id"]}}}}}},"/api/v3/admin/collections/{collection_id}/products/{id}":{"delete":{"summary":"Remove a product from a collection","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes a product from the collection's manual curation.\n\n**Required scope:** `write_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"collection_id","in":"path","required":true,"description":"Collection ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}}],"responses":{"204":{"description":"product removed"}}}},"/api/v3/admin/collections/{collection_id}/products/{id}/reposition":{"patch":{"summary":"Reposition a collection product","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Moves a product to a new index among the collection's products.\n\n**Required scope:** `write_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"collection_id","in":"path","required":true,"description":"Collection ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}}],"responses":{"204":{"description":"product repositioned"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"new_position":{"type":"integer","description":"0-based index among the collection's products"}},"required":["new_position"]}}}}}},"/api/v3/admin/collection_rules/types":{"get":{"summary":"List available collection rule types","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Enumerates the registered rule kinds with their labels and descriptions — drives the rule picker on an automatic collection. Plugins extend the list by registering `Spree::CollectionRule` subclasses via `config.spree.collection_rules`. The `type` returned here is the wire shorthand accepted when writing a collection's `rules`.\n\n**Required scope:** `read_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"types found","content":{"application/json":{}}}}}},"/api/v3/admin/commission_lines":{"get":{"summary":"List commission lines","tags":["Commission Lines"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"What each sale actually earned the marketplace, frozen when the order\nwas placed. A later change to a commission rate never reaches these.\n\n`amount` is the fee charged to the seller and `tax_amount` is the VAT on\nthat fee — the marketplace's own service to the seller, a supply\nseparate from the sale itself, which is why the two are not folded\ntogether. `total` is their sum.\n\nOne line per commissioned item, plus one per delivery when the rate that\napplied charges shipping too — read `line_item_id` and `fulfillment_id`\nto tell them apart.\n\nRead-only: correcting a charge is a reversal, not an edit.\n\n\n**Required scope:** `read_commissions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[seller_id_eq]","in":"query","required":false,"description":"Filter to one seller","schema":{"type":"string"}},{"name":"q[order_id_eq]","in":"query","required":false,"description":"Filter to one order","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-created_at`).","schema":{"type":"string"}}],"responses":{"200":{"description":"commission lines found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CommissionLine"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/commission_lines/{id}":{"parameters":[{"name":"id","in":"path","description":"Commission line ID","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a commission line","tags":["Commission Lines"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_commissions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"commission line found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissionLine"}}}},"404":{"description":"commission line not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/commission_rates":{"get":{"summary":"List commission rates","tags":["Commission Rates"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"What the marketplace charges its sellers.\n\nRates are returned in resolution order: the list is walked top-down and\nthe first rate whose targeting matches the sale wins, so the order you\nsee is the precedence. Move a rate with `position` on update.\n\nA rate carrying no rules matches every sale — `global` says so — which\nis how a marketplace expresses a single default. Because resolution\nstops at the first match, a global rate makes everything below it\nunreachable, so it belongs at the bottom.\n\n\n**Required scope:** `read_commissions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[name_cont]","in":"query","required":false,"description":"Filter by name (contains)","schema":{"type":"string"}},{"name":"q[enabled_eq]","in":"query","required":false,"description":"Filter by whether the rate is in use","schema":{"type":"boolean"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-position`).","schema":{"type":"string"}}],"responses":{"200":{"description":"commission rates found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CommissionRate"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a commission rate","tags":["Commission Rates"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Sets what the marketplace charges, and which sales it applies to.\n\n`rules` is the rate's whole targeting, sent inline. Every rule has to\nhold, and a rule naming several records means any of them — so\n\"(Cameras OR Audio) AND that seller\" is a category rule holding two ids\nbeside a seller rule holding one. Send no rules to charge every sale.\n\nRule kinds come from `GET /commission_rates/rule_types`, which also\ndescribes the configuration each one takes. A marketplace that adds its\nown kind sees it there without this endpoint changing.\n\n`commission_tax_rate` is VAT on the commission itself — the\nmarketplace's own service to the seller, a separate supply from the\nsale. Leave it null to let the store's tax engine answer for wherever\nthe seller's business sits.\n\n\n**Required scope:** `write_commissions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"commission rate created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissionRate"}}}},"422":{"description":"validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","kind","value"],"properties":{"name":{"type":"string"},"code":{"type":"string","nullable":true,"description":"Your own identifier for this rate; unique per store."},"enabled":{"type":"boolean"},"position":{"type":"integer","description":"Place in the list. Rates resolve top-down, so 1 is tried first. New rates are created at the top; send this to move one."},"kind":{"type":"string","enum":["percentage","fixed"]},"value":{"type":"string","description":"A percentage (10 = 10%) or a flat amount, per `kind`."},"amounts":{"type":"object","additionalProperties":{"type":"string"},"description":"What a flat fee charges, keyed by currency. A currency with no amount is one this rate does not charge — those sales fall to the next rate. Ignored for a percentage."},"tax_inclusive":{"type":"boolean","description":"Charge on the price including the customer's VAT. Left off, commission is charged on the seller's net revenue, which is the usual basis where the fee is taxed as its own supply."},"include_shipping":{"type":"boolean","description":"Also charge commission on the seller's delivery revenue."},"bounds":{"type":"object","additionalProperties":{"type":"object","properties":{"min_amount":{"type":"string","nullable":true},"max_amount":{"type":"string","nullable":true}}},"description":"The floor and cap a percentage charges within, keyed by currency. Each holds only in its own currency; a sale in a currency with no bounds is charged unbounded."},"commission_tax_rate":{"type":"string","nullable":true,"description":"A fraction, not a percentage. Null asks the tax engine."},"rules":{"type":"array","description":"The full targeting; what you send replaces what the rate holds.","items":{"type":"object","properties":{"id":{"type":"string","description":"Present for an existing rule; omit to create one."},"type":{"type":"string","description":"A kind from /commission_rates/rule_types."},"preferences":{"type":"object","description":"Configuration for the kind, per its preference_schema."},"product_ids":{"type":"array","items":{"type":"string"},"description":"For kinds that name products, which are kept outside preferences."}}}}}}}}}}},"/api/v3/admin/commission_rates/rule_types":{"get":{"summary":"List the commission rule kinds","tags":["Commission Rates"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Every rule kind a rate can be narrowed by, with the schema describing\nthe configuration it takes — so a client builds its editor from what\nthis marketplace has rather than a list hardcoded to match core's.\n\n`association_fields` names any catalog-scale reference a kind keeps\noutside its preferences, so an editor knows to render a picker for it.\n\n\n**Required scope:** `read_commissions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"subject types found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"preference_schema":{"type":"array","items":{"type":"object"}},"association_fields":{"type":"array","items":{"type":"string"}}}}}}}}}}}}},"/api/v3/admin/commission_rates/{id}":{"parameters":[{"name":"id","in":"path","description":"Commission rate ID","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a commission rate","tags":["Commission Rates"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_commissions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"commission rate found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissionRate"}}}},"404":{"description":"commission rate not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a commission rate","tags":["Commission Rates"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Editing a rate changes what the next sale is charged, never what a past\none was: commission lines keep their own snapshot of the rate that\napplied.\n\n\n**Required scope:** `write_commissions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"commission rate updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissionRate"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"enabled":{"type":"boolean"},"position":{"type":"integer"},"value":{"type":"string"},"rules":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"preferences":{"type":"object"},"product_ids":{"type":"array","items":{"type":"string"}}}}}}}}}}},"delete":{"summary":"Delete a commission rate","tags":["Commission Rates"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_commissions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"commission rate deleted"}}}},"/api/v3/admin/companies/{company_id}/locations":{"get":{"summary":"List company locations","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the branches of a business customer. Each branch owns its own addresses and the buyers authorised to purchase for it.\n\n**Required scope:** `read_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"locations found","content":{"application/json":{}}}}},"post":{"summary":"Create a company location","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a branch. Addresses are supplied inline and belong to the branch, so editing one later changes the branch's own record rather than an address the buyer also uses.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"location created","content":{"application/json":{}}},"422":{"description":"invalid request","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"external_id":{"type":"string","nullable":true},"billing_address":{"type":"object","description":"Created inline and owned by the branch.","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"address1":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"country_code":{"type":"string"}}}},"required":["name"]}}}}}},"/api/v3/admin/company_locations/{id}":{"parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a company location","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Branches are addressed by their own id once you hold one — the company id is not needed.\n\n**Required scope:** `read_customers` (for API-key authentication).","responses":{"200":{"description":"location found","content":{"application/json":{}}}}},"patch":{"summary":"Update a company location","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Address fields sent here edit the branch's existing address in place; send only what changes.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[],"responses":{"200":{"description":"location updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"billing_address":{"type":"object","properties":{"city":{"type":"string"}}}}}}}}},"delete":{"summary":"Delete a company location","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes the branch, its buyers and the addresses it owned.\n\n**Required scope:** `write_customers` (for API-key authentication).","responses":{"204":{"description":"location deleted"}}}},"/api/v3/admin/companies/{company_id}/tax_exemption_certificates":{"parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"List tax exemption certificates","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a business's exemption evidence. `active` is the field that decides whether a certificate\nexempts a sale: a verified certificate stops counting once its expiry date passes, so the status\nalone does not answer it.\n\n\n**Required scope:** `read_customers` (for API-key authentication).","responses":{"200":{"description":"certificates found","content":{"application/json":{}}}}},"post":{"summary":"Create a tax exemption certificate","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Records exemption evidence against a business. Certificates start `pending` and exempt nothing\nuntil verified.\n\n`country_code` and `state_code` say where the certificate holds — omit both for one valid\neverywhere, give only the country for one valid throughout it. `document` takes an ActiveStorage\nsigned blob id obtained from `POST /api/v3/admin/direct_uploads`.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[],"responses":{"201":{"description":"certificate created","content":{"application/json":{}}},"422":{"description":"invalid request","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"certificate_number":{"type":"string"},"reason_code":{"type":"string","description":"Becomes the tax provider's entity use code."},"country_code":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true},"expires_at":{"type":"string","format":"date-time","nullable":true},"issuing_authority":{"type":"string","nullable":true},"document":{"type":"string","description":"ActiveStorage signed blob id from POST /api/v3/admin/direct_uploads."}},"required":["certificate_number","reason_code"]}}}}}},"/api/v3/admin/companies/{company_id}/tax_exemption_certificates/{id}/verify":{"parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"patch":{"summary":"Verify a tax exemption certificate","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Accepts the certificate as evidence, which is what makes it exempt sales. Only a pending\ncertificate can be accepted — re-accepting a revoked one would restore evidence that was\ndeliberately withdrawn. An installation that checks numbers against a registry, or requires a\nsecond approval, can refuse here, and the refusal is returned as a validation error.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","responses":{"200":{"description":"certificate verified","content":{"application/json":{}}}}}},"/api/v3/admin/companies/{company_id}/tax_exemption_certificates/{id}/revoke":{"parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"patch":{"summary":"Revoke a tax exemption certificate","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Withdraws accepted evidence. A verified certificate cannot be deleted — how a sale was taxed has to remain explainable — so revoking is the way out.\n\n**Required scope:** `write_customers` (for API-key authentication).","responses":{"200":{"description":"certificate revoked","content":{"application/json":{}}}}}},"/api/v3/admin/companies/{company_id}/tax_exemption_certificates/{id}/download":{"parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Download a certificate document","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Streams the uploaded document. Deliberately not a storage link: the bytes come through the API so\nthe same credentials apply to every read of a confidential document. Requires only read access.\n\n\n**Required scope:** `read_customers` (for API-key authentication).","responses":{"200":{"description":"document streamed","content":{"application/json":{}}},"422":{"description":"no document attached","content":{"application/json":{}}}}}},"/api/v3/admin/companies/{company_id}/tax_identifiers":{"parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"List company tax registrations","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the business's tax registrations, one per kind. A business registration takes precedence\nover the buyer's own when a sale is for that business, because the invoice is addressed to the\nentity rather than the person who placed the order.\n\n\n**Required scope:** `read_customers` (for API-key authentication).","responses":{"200":{"description":"registrations found","content":{"application/json":{}}}}},"post":{"summary":"Create a company tax registration","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Registers a tax number against the business. Verification against the relevant registry runs in\nthe background where a validator is installed for the kind; a stock installation registers none,\nleaving the status unattempted.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[],"responses":{"201":{"description":"registration created","content":{"application/json":{}}},"422":{"description":"invalid request","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","description":"The regime the number belongs to."},"value":{"type":"string"}},"required":["kind","value"]}}}}}},"/api/v3/admin/companies/{company_id}/tax_identifiers/{id}/validate":{"parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"post":{"summary":"Re-check a company tax registration","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Asks the registry again. Manual because a registry answers only \"valid now\" — a number verified\nlast year may have been deregistered since — and because a check that came back unavailable\ncannot otherwise be retried without editing the number.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","responses":{"422":{"description":"no validator installed for this kind","content":{"application/json":{}}}}}},"/api/v3/admin/companies":{"get":{"summary":"List companies","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the business customers of the current store.\n\n**Required scope:** `read_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"companies found","content":{"application/json":{}}}}},"post":{"summary":"Create a company","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a business customer. Exemption certificates and tax registrations hang off it.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"company created","content":{"application/json":{}}},"422":{"description":"invalid request","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"external_id":{"type":"string","nullable":true,"description":"Your own reference for this business, unique within the store."}},"required":["name"]}}}}}},"/api/v3/admin/company_locations/{company_location_id}/contacts":{"parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"company_location_id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"List company contacts","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the customers authorised to purchase for a branch. A customer may act for more than one branch.\n\n**Required scope:** `read_customers` (for API-key authentication).","responses":{"200":{"description":"contacts found","content":{"application/json":{}}}}},"post":{"summary":"Create a company contact","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Authorises a customer to purchase for a branch. A customer who acts for exactly one branch has\ntheir orders attributed to it automatically; one who acts for several needs the branch set on\nthe order, because guessing would invoice the wrong business.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[],"responses":{"201":{"description":"contact created","content":{"application/json":{}}},"422":{"description":"invalid request","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string"},"role":{"type":"string","description":"Free-form label; carries no permissions in 6.0."}},"required":["customer_id"]}}}}}},"/api/v3/admin/company_contacts/{id}":{"parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a company contact","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_customers` (for API-key authentication).","responses":{"200":{"description":"contact found","content":{"application/json":{}}}}},"delete":{"summary":"Delete a company contact","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Withdraws the customer's authority to purchase for the branch. The customer account itself is untouched.\n\n**Required scope:** `write_customers` (for API-key authentication).","responses":{"204":{"description":"contact deleted"}}}},"/api/v3/admin/delivery_profiles":{"get":{"summary":"List delivery profiles","tags":["Delivery"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Fulfillment profiles group products with the stock locations, delivery zones and delivery methods that fulfill them. Every store has exactly one default profile.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"delivery profiles found","content":{"application/json":{}}}}},"post":{"summary":"Create a delivery profile","tags":["Delivery"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a delivery profile. `kind` selects the registered profile kind (shipping, digital, extension kinds); `stock_location_ids` limits fulfillment to those locations — empty means every store location.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"delivery profile created","content":{"application/json":{}}},"422":{"description":"validation error","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"kind":{"type":"string","description":"Registered profile kind; defaults to shipping."},"default":{"type":"boolean"},"stock_location_ids":{"type":"array","items":{"type":"string"},"description":"Empty means every store location."}},"required":["name"]}}}}}},"/api/v3/admin/delivery_profiles/{delivery_profile_id}/origin_groups":{"parameters":[{"name":"delivery_profile_id","in":"path","required":true,"schema":{"type":"string"}}],"post":{"summary":"Create an origin group","tags":["Delivery"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Origin groups partition a profile's fulfillment origins: zones and methods belong to a group, so the same products can quote different rate tables per warehouse. `stock_location_ids` replaces the full membership; empty means every store location.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"origin group created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true},"position":{"type":"integer","nullable":true},"stock_location_ids":{"type":"array","items":{"type":"string"},"description":"Empty means every store location."}}}}}}}},"/api/v3/admin/delivery_profiles/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"patch":{"summary":"Update a delivery profile","tags":["Delivery"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"delivery profile updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"default":{"type":"boolean"},"stock_location_ids":{"type":"array","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete a delivery profile","tags":["Delivery"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"The default profile and profiles still referenced by products cannot be deleted.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"delivery profile deleted"}}}},"/api/v3/admin/delivery_methods":{"get":{"summary":"List delivery methods","tags":["Delivery"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns all delivery methods with calculator and zone configuration.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"delivery methods found","content":{"application/json":{}}}}},"post":{"summary":"Create delivery method","tags":["Delivery"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a delivery method inside a delivery profile (defaults to the store default profile). Delivery behavior comes from the fulfillment provider.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"delivery method created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"admin_name":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"fulfillment_provider":{"type":"string","nullable":true},"delivery_profile_id":{"type":"string","nullable":true},"storefront_visible":{"type":"boolean"},"tracking_url":{"type":"string","nullable":true},"estimated_transit_business_days_min":{"type":"integer","nullable":true},"estimated_transit_business_days_max":{"type":"integer","nullable":true},"tax_category_id":{"type":"string","nullable":true},"calculator_type":{"type":"string"},"calculator_preferences":{"type":"object"},"delivery_zone_id":{"type":"string","nullable":true}},"required":["name"]}}}}}},"/api/v3/admin/delivery_methods/calculators":{"get":{"summary":"List delivery calculators","tags":["Delivery"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Registered delivery calculator classes with preference schemas for building configuration forms.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"calculators found","content":{"application/json":{}}}}}},"/api/v3/admin/delivery_zones":{"post":{"summary":"Create delivery zone","tags":["Delivery"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a delivery zone with typed members: country, state, or postal_code (prefix or from/to range).\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to embed, e.g. `members`","schema":{"type":"string"}}],"responses":{"201":{"description":"delivery zone created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true},"members":{"type":"array","items":{"type":"object","properties":{"member_type":{"type":"string","enum":["country","state","postal_code"]},"country_code":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true},"postal_code_prefix":{"type":"string","nullable":true},"postal_code_from":{"type":"string","nullable":true},"postal_code_to":{"type":"string","nullable":true}},"required":["member_type"]}}},"required":["name"]}}}}}},"/api/v3/admin/integrations":{"get":{"summary":"List integrations","tags":["Integrations"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the integrations connected to the current store. Secret preference values are masked.\n\n**Required scope:** `read_integrations` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"integrations found","content":{"application/json":{}}}}},"post":{"summary":"Connect integration","tags":["Integrations"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Connects an integration type to the current store. Setting active: true verifies the connection and fails with 422 when it cannot connect. Submitting a masked secret value back keeps the stored secret.\n\n**Required scope:** `write_integrations` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"integration connected","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Wire shorthand from GET /integrations/types"},"active":{"type":"boolean"},"preferences":{"type":"object"}},"required":["type"]}}}}}},"/api/v3/admin/integrations/types":{"get":{"summary":"List integration types","tags":["Integrations"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Every registered integration type with its gallery metadata and configuration schema. Pure registry discovery — read live connection state from GET /integrations.\n\n**Required scope:** `read_integrations` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"integration types found","content":{"application/json":{}}}}}},"/api/v3/admin/integrations/{id}/test":{"post":{"summary":"Test integration connection","tags":["Integrations"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Runs a live connection check against the provider. Nothing is persisted; a failed check reports the seller error message.\n\n**Required scope:** `write_integrations` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"connection checked","content":{"application/json":{}}}}}},"/api/v3/admin/product_types":{"get":{"summary":"List product types","tags":["Product Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a paginated list of product types.\n\nA product type is a back-office template: it seeds option types and\ncategories onto products created with it, and defines which custom\nfields those products' forms show. It is not exposed on the Store API.\n\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}}],"responses":{"200":{"description":"product types found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProductType"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a product type","tags":["Product Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a product type.\n\n`option_type_ids` and `category_ids` seed products created with this\ntype. `custom_field_definitions` is a replace-set of the definitions the\nproduct form renders, in `sort_order`. `required` is advisory — the\ndashboard marks the field, but a blank value is never rejected.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"product type created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductType"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"delivery_profile_id":{"type":"string","nullable":true,"description":"Fulfillment profile stamped onto products created with this type. Null leaves new products on the store default profile."},"option_type_ids":{"type":"array","items":{"type":"string"},"description":"Option types seeded onto products created with this type."},"category_ids":{"type":"array","items":{"type":"string"},"description":"Categories seeded onto products created with this type."},"custom_field_definitions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Prefixed custom field definition id."},"required":{"type":"boolean"},"sort_order":{"type":"integer"}}}}},"required":["name"]}}}}}},"/api/v3/admin/product_types/{id}":{"parameters":[{"name":"id","in":"path","description":"Product type ID","required":true,"schema":{"type":"string"}}],"get":{"summary":"Retrieve a product type","tags":["Product Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single product type with its option types, categories and custom fields.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"product type found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductType"}}}},"404":{"description":"product type not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a product type","tags":["Product Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a product type.\n\nChanges never modify products that already carry the type — use\n`apply_to_products` to backfill those.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"product type updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductType"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"delivery_profile_id":{"type":"string","nullable":true},"option_type_ids":{"type":"array","items":{"type":"string"}},"category_ids":{"type":"array","items":{"type":"string"}},"custom_field_definitions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"required":{"type":"boolean"},"sort_order":{"type":"integer"}}}}}}}}}},"delete":{"summary":"Delete a product type","tags":["Product Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes a product type. Types still used by products cannot be deleted.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"204":{"description":"product type deleted"}}}},"/api/v3/admin/product_types/{id}/apply_to_products":{"parameters":[{"name":"id","in":"path","description":"Product type ID","required":true,"schema":{"type":"string"}}],"post":{"summary":"Apply a product type to its existing products","tags":["Product Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Backfills the type's option types and categories onto the products that\nalready carry it. Additive and idempotent — nothing is removed, and\nre-running is safe.\n\nRuns in the background; the response reports how many products the type\ncurrently has.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"202":{"description":"backfill accepted","content":{"application/json":{"schema":{"type":"object","properties":{"products_count":{"type":"integer"}}}}}}}}},"/api/v3/admin/sellers":{"get":{"summary":"List sellers","tags":["Sellers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the sellers on this marketplace. `status` says where each one\nis in its life on the marketplace, and `sellable` answers the question\nthe status alone cannot: an approved seller who is away cannot be\nbought from either.\n\n\n**Required scope:** `read_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[name_cont]","in":"query","required":false,"description":"Filter by name (contains)","schema":{"type":"string"}},{"name":"q[status_eq]","in":"query","required":false,"description":"Filter by status","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-created_at`).","schema":{"type":"string"}}],"responses":{"200":{"description":"sellers found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Seller"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a seller","tags":["Sellers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Opens a seller record. The seller starts as `pending` and has no team\nyet — invite someone to run it with the `invite` action below.\n\n`status` is deliberately not writable here or on update: every move\nthrough the lifecycle is its own action, because each one does more\nthan set a column.\n\n\n**Required scope:** `write_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"seller created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Seller"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"slug":{"type":"string","description":"Derived from the name when omitted."},"contact_email":{"type":"string","nullable":true},"billing_email":{"type":"string","nullable":true},"about":{"type":"string","nullable":true},"tax_remittance":{"type":"string","enum":["seller","platform"]},"payouts_schedule_interval":{"type":"string","enum":["daily","weekly","biweekly","monthly","manual"],"nullable":true},"minimum_payout_amount":{"type":"string","nullable":true}}}}}}}},"/api/v3/admin/sellers/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Seller prefixed ID","schema":{"type":"string"}}],"get":{"summary":"Get a seller","tags":["Sellers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single seller, including its settlement and tax configuration.\n\n**Required scope:** `read_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"seller found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Seller"}}}},"404":{"description":"seller not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a seller","tags":["Sellers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates the seller's profile and the settlement configuration the\noperator owns. A `status` sent here is ignored — use the lifecycle\nactions.\n\n\n**Required scope:** `write_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"seller address written inline","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Seller"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"billing_email":{"type":"string","nullable":true},"payouts_schedule_interval":{"type":"string","enum":["daily","weekly","biweekly","monthly","manual"],"nullable":true},"minimum_payout_amount":{"type":"string","nullable":true},"holiday_mode_until":{"type":"string","format":"date-time","nullable":true},"logo":{"type":"string","nullable":true,"description":"ActiveStorage signed id of a direct-uploaded file. Send `null` to remove the attachment, or omit the key to leave it alone. Same for `square_logo` and `cover_photo`."},"square_logo":{"type":"string","nullable":true},"cover_photo":{"type":"string","nullable":true},"billing_address":{"type":"object","description":"The seller's own address, written inline. There is no `billing_address_id` — an address belongs to whoever it was created for, so it is never referenced by id here.","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"company":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"phone":{"type":"string"},"country_code":{"type":"string"},"state_code":{"type":"string"},"state_name":{"type":"string"},"label":{"type":"string"}}},"returns_address":{"type":"object","description":"The seller's own address, written inline. There is no `billing_address_id` — an address belongs to whoever it was created for, so it is never referenced by id here.","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"company":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"phone":{"type":"string"},"country_code":{"type":"string"},"state_code":{"type":"string"},"state_name":{"type":"string"},"label":{"type":"string"}}}}}}}}},"delete":{"summary":"Delete a seller","tags":["Sellers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes the seller. Their products are kept and left without a\nseller rather than deleted — what happens to a departed seller's\ncatalog is the operator's decision.\n\n\n**Required scope:** `write_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"seller deleted"}}}},"/api/v3/admin/sellers/{id}/invite":{"parameters":[{"name":"id","in":"path","required":true,"description":"Seller prefixed ID","schema":{"type":"string"}}],"post":{"summary":"Invite someone to run a seller","tags":["Sellers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Sends an invitation to the seller's own team and moves the seller to\n`invited`. The person becomes a member when they accept, and can then\nsign in to the seller panel.\n\n`role_id` must name a role this seller owns; omit it for the seller's\nown admin role. Re-inviting is allowed — an invitation expires, or the\nfirst one goes to the wrong address.\n\n\n**Required scope:** `write_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"invitation sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Seller"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string"},"role_id":{"type":"string","nullable":true}}}}}}}},"/api/v3/admin/sellers/{id}/approve":{"parameters":[{"name":"id","in":"path","required":true,"description":"Seller prefixed ID","schema":{"type":"string"}}],"patch":{"summary":"Approve a seller","tags":["Sellers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Lets the seller sell. This is also the way back for one that was\nsuspended or turned down, and it clears any holiday along with the\nsuspension.\n\n\n**Required scope:** `write_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"seller approved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Seller"}}}},"422":{"description":"seller cannot be approved from its current status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/sellers/{id}/suspend":{"parameters":[{"name":"id","in":"path","required":true,"description":"Seller prefixed ID","schema":{"type":"string"}}],"patch":{"summary":"Suspend a seller","tags":["Sellers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Stops a trading seller from selling. Their catalog and history stay,\nand approving reinstates them. Use this rather than `reject` for a\nseller already on the marketplace — it says something different, and\nit can be undone.\n\n\n**Required scope:** `write_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"seller suspended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Seller"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string"}}}}}}}},"/api/v3/admin/sellers/{id}/reject":{"parameters":[{"name":"id","in":"path","required":true,"description":"Seller prefixed ID","schema":{"type":"string"}}],"patch":{"summary":"Reject a seller","tags":["Sellers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Turns down an applicant who never traded. A seller already selling is\nsuspended instead; rejecting one is refused.\n\n\n**Required scope:** `write_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"seller rejected","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Seller"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string"}}}}}}}}},"components":{"schemas":{"PaginationMeta":{"type":"object","properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"count":{"type":"integer","description":"Total number of records"},"pages":{"type":"integer","description":"Total number of pages"},"from":{"type":"integer","description":"Index of first record on this page"},"to":{"type":"integer","description":"Index of last record on this page"},"in":{"type":"integer","description":"Number of records on this page"},"previous":{"type":"integer","nullable":true,"description":"Previous page number"},"next":{"type":"integer","nullable":true,"description":"Next page number"}},"required":["page","limit","count","pages","from","to","in"]},"ErrorResponse":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","description":"Field-specific validation errors","nullable":true}},"required":["code","message"]}},"required":["error"]},"AuthResponse":{"type":"object","properties":{"token":{"type":"string","description":"JWT access token"},"user":{"$ref":"#/components/schemas/AdminUser"}},"required":["token","user"]},"PermissionRule":{"type":"object","description":"A single permission rule (CanCanCan rule). Rules are applied in order, last-matching-wins.","properties":{"allow":{"type":"boolean","description":"true for `can`, false for `cannot`"},"actions":{"type":"array","items":{"type":"string"},"description":"Action names, e.g. [\"read\", \"update\"] or [\"manage\"]"},"subjects":{"type":"array","items":{"type":"string"},"description":"Subject class names, e.g. [\"Spree::Product\"] or [\"all\"]"},"has_conditions":{"type":"boolean","description":"True if the server-side rule has per-record conditions. The SPA shows the action optimistically and handles 403 from the API."}},"required":["allow","actions","subjects","has_conditions"]},"MeResponse":{"type":"object","description":"Current admin user profile and serialized permissions","properties":{"user":{"$ref":"#/components/schemas/AdminUser"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/PermissionRule"}}},"required":["user","permissions"]},"ImportSchemaField":{"type":"object","description":"A canonical column of an import type, including per-store custom field columns","properties":{"name":{"type":"string","description":"Canonical field name used in mappings"},"label":{"type":"string","description":"Human-readable label"},"required":{"type":"boolean","description":"Whether the field must be mapped before processing"}},"required":["name","label","required"]},"CheckoutRequirement":{"type":"object","properties":{"step":{"type":"string","description":"Checkout step this requirement belongs to"},"field":{"type":"string","description":"Field that needs to be satisfied"},"message":{"type":"string","description":"Human-readable requirement message"}},"required":["step","field","message"]},"CartWarning":{"type":"object","description":"A warning about a cart issue (e.g., item removed due to stock change)","properties":{"code":{"type":"string","description":"Machine-readable warning code"},"message":{"type":"string","description":"Human-readable warning message"},"line_item_id":{"type":"string","nullable":true,"description":"Prefixed line item ID (when applicable)"},"variant_id":{"type":"string","nullable":true,"description":"Prefixed variant ID (when applicable)"},"item_index":{"type":"integer","nullable":true,"description":"Position in the submitted items array, for warnings raised while applying a batch of item changes"}},"required":["code","message"]},"FulfillmentManifestItem":{"type":"object","description":"An item within a fulfillment — which line item and how many units are in this fulfillment","properties":{"item_id":{"type":"string","description":"Line item ID"},"variant_id":{"type":"string","description":"Variant ID"},"quantity":{"type":"integer","description":"Quantity in this fulfillment"}},"required":["item_id","variant_id","quantity"]},"AdminUserRoleAssignment":{"type":"object","description":"A role assignment for the current store on a staff member","properties":{"id":{"type":"string","description":"Prefixed role ID"},"name":{"type":"string","description":"Role name"}},"required":["id","name"]},"AdminUserStore":{"type":"object","description":"A store the staff member can access through a role assignment","properties":{"id":{"type":"string","description":"Prefixed store ID"},"name":{"type":"string","description":"Store name"},"code":{"type":"string","description":"Store code"}},"required":["id","name","code"]},"PreferenceField":{"type":"object","description":"A single configurable preference on a payment method, promotion rule/action, or calculator. The frontend uses `type` + `default` to render a sensible input.","properties":{"key":{"type":"string"},"type":{"type":"string","description":"string | text | password | integer | decimal | boolean | array | hash"},"default":{"description":"Default value (any JSON type), null when there is no default","nullable":true}},"required":["key","type"]},"PromotionActionCalculator":{"type":"object","description":"The action's nested calculator (when the action carries one — null for actions like `free_shipping`)","properties":{"type":{"type":"string","description":"Wire shorthand for the calculator subclass"},"label":{"type":"string"},"preferences":{"type":"object","additionalProperties":true},"preference_schema":{"type":"array","items":{"$ref":"#/components/schemas/PreferenceField"}}},"required":["type","label","preferences","preference_schema"]},"PromotionActionLineItem":{"type":"object","description":"One row in a `create_line_items` action — the variant added to the order and how many","properties":{"variant_id":{"type":"string"},"quantity":{"type":"integer"}},"required":["variant_id","quantity"]},"Address":{"type":"object","properties":{"id":{"type":"string"},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"full_name":{"type":"string"},"address1":{"type":"string","nullable":true},"address2":{"type":"string","nullable":true},"postal_code":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"country_name":{"type":"string"},"country_code":{"type":"string"},"state_text":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true},"quick_checkout":{"type":"boolean"},"is_default_billing":{"type":"boolean"},"is_default_shipping":{"type":"boolean"},"state_abbr":{"type":"string","nullable":true},"country_iso":{"type":"string"},"state_name":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"customer_id":{"type":"string","nullable":true}},"required":["id","first_name","last_name","full_name","address1","address2","postal_code","city","phone","company","country_name","country_code","state_text","state_code","quick_checkout","is_default_billing","is_default_shipping","state_abbr","country_iso","state_name","label","metadata","created_at","updated_at","customer_id"],"x-typelizer":true},"AdminUser":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"full_name":{"type":"string","nullable":true},"selected_locale":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"avatar_url":{"type":"string","nullable":true},"roles":{"type":"array","items":{"$ref":"#/components/schemas/AdminUserRoleAssignment"}},"stores":{"type":"array","items":{"$ref":"#/components/schemas/AdminUserStore"}}},"required":["id","email","first_name","last_name","full_name","selected_locale","created_at","updated_at","avatar_url","roles","stores"],"x-typelizer":true},"AllowedOrigin":{"type":"object","properties":{"id":{"type":"string"},"origin":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","origin","created_at","updated_at"],"x-typelizer":true},"ApiKey":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"key_type":{"type":"string"},"token_prefix":{"type":"string","nullable":true},"scopes":{"type":"array","items":{"type":"string"}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"revoked_at":{"type":"string","nullable":true},"last_used_at":{"type":"string","nullable":true},"channel_id":{"type":"string","nullable":true},"plaintext_token":{"type":"string","nullable":true},"created_by_email":{"type":"string","nullable":true}},"required":["id","name","key_type","token_prefix","scopes","created_at","updated_at","revoked_at","last_used_at","channel_id","plaintext_token","created_by_email"],"x-typelizer":true},"AppliedPromotion":{"type":"object","properties":{"id":{"type":"string"},"promotion_id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"amount":{"type":"string"},"display_amount":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","promotion_id","name","description","code","amount","display_amount","created_at","updated_at"],"x-typelizer":true},"Cart":{"type":"object","properties":{"id":{"type":"string"},"market_id":{"type":"string","nullable":true},"channel_id":{"type":"string","nullable":true},"preferred_stock_location_id":{"type":"string","nullable":true},"number":{"type":"string"},"token":{"type":"string"},"email":{"type":"string","nullable":true},"customer_note":{"type":"string","nullable":true},"currency":{"type":"string"},"locale":{"type":"string","nullable":true},"total_quantity":{"type":"number"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/CartWarning"}},"coupon_code":{"type":"string","nullable":true},"item_total":{"type":"string","nullable":true},"display_item_total":{"type":"string","nullable":true},"adjustment_total":{"type":"string","nullable":true},"display_adjustment_total":{"type":"string","nullable":true},"discount_total":{"type":"string","nullable":true},"display_discount_total":{"type":"string","nullable":true},"tax_total":{"type":"string","nullable":true},"display_tax_total":{"type":"string","nullable":true},"included_tax_total":{"type":"string","nullable":true},"display_included_tax_total":{"type":"string","nullable":true},"additional_tax_total":{"type":"string","nullable":true},"display_additional_tax_total":{"type":"string","nullable":true},"total":{"type":"string","nullable":true},"display_total":{"type":"string","nullable":true},"gift_card_total":{"type":"string","nullable":true},"display_gift_card_total":{"type":"string","nullable":true},"amount_due":{"type":"string","nullable":true},"display_amount_due":{"type":"string","nullable":true},"delivery_total":{"type":"string","nullable":true},"display_delivery_total":{"type":"string","nullable":true},"fee_total":{"type":"string","nullable":true},"display_fee_total":{"type":"string","nullable":true},"store_credit_total":{"type":"string","nullable":true},"display_store_credit_total":{"type":"string","nullable":true},"covered_by_store_credit":{"type":"boolean"},"current_step":{"type":"string"},"completed_steps":{"type":"array","items":{"type":"string"}},"requirements":{"type":"array","items":{"$ref":"#/components/schemas/CheckoutRequirement"}},"shipping_eq_billing_address":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"billing_address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"nullable":true},"shipping_address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"nullable":true},"market":{"allOf":[{"$ref":"#/components/schemas/Market"}],"nullable":true},"completed_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"applied_promotions":{"type":"array","items":{"$ref":"#/components/schemas/AppliedPromotion"}}},"required":["id","market_id","channel_id","preferred_stock_location_id","number","token","email","customer_note","currency","locale","total_quantity","warnings","coupon_code","item_total","display_item_total","adjustment_total","display_adjustment_total","discount_total","display_discount_total","tax_total","display_tax_total","included_tax_total","display_included_tax_total","additional_tax_total","display_additional_tax_total","total","display_total","gift_card_total","display_gift_card_total","amount_due","display_amount_due","delivery_total","display_delivery_total","fee_total","display_fee_total","store_credit_total","display_store_credit_total","covered_by_store_credit","current_step","completed_steps","requirements","shipping_eq_billing_address","items","billing_address","shipping_address","market","completed_at","created_at","updated_at","applied_promotions"],"x-typelizer":true},"Category":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"permalink":{"type":"string"},"position":{"type":"number"},"depth":{"type":"number"},"meta_title":{"type":"string","nullable":true},"meta_description":{"type":"string","nullable":true},"meta_keywords":{"type":"string","nullable":true},"children_count":{"type":"number"},"parent_id":{"type":"string","nullable":true},"description":{"type":"string"},"description_html":{"type":"string"},"image_url":{"type":"string","nullable":true},"square_image_url":{"type":"string","nullable":true},"is_root":{"type":"boolean"},"is_child":{"type":"boolean"},"is_leaf":{"type":"boolean"},"parent":{"$ref":"#/components/schemas/Category"},"children":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"translations":{"type":"object"},"metadata":{"type":"object"},"pretty_name":{"type":"string"},"lft":{"type":"number"},"rgt":{"type":"number"},"products_count":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","name","permalink","position","depth","meta_title","meta_description","meta_keywords","children_count","parent_id","description","description_html","image_url","square_image_url","is_root","is_child","is_leaf","metadata","pretty_name","lft","rgt","products_count","created_at","updated_at"],"x-typelizer":true},"Channel":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"code":{"type":"string"},"active":{"type":"boolean"},"default":{"type":"boolean"},"storefront_access":{"type":"string"},"guest_checkout":{"type":"boolean"},"preferred_order_routing_strategy":{"type":"string","nullable":true},"preferred_storefront_access":{"type":"string","nullable":true},"preferred_guest_checkout":{"type":"boolean","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"stock_location_ids":{"type":"array","items":{"type":"string"}}},"required":["id","name","code","active","default","storefront_access","guest_checkout","preferred_order_routing_strategy","preferred_storefront_access","preferred_guest_checkout","created_at","updated_at","stock_location_ids"],"x-typelizer":true},"ClaimLineItem":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"number"},"send_replacement":{"type":"boolean"},"description":{"type":"string","nullable":true},"refund_amount":{"type":"string"},"paid_amount":{"type":"string"},"display_refund_amount":{"type":"string"},"variant_id":{"type":"string","nullable":true},"replacement_variant_id":{"type":"string","nullable":true},"line_item_id":{"type":"string","nullable":true},"variant":{"$ref":"#/components/schemas/Variant"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"replacement_variant":{"$ref":"#/components/schemas/Variant"}},"required":["id","quantity","send_replacement","description","refund_amount","paid_amount","display_refund_amount","variant_id","replacement_variant_id","line_item_id","created_at","updated_at"],"x-typelizer":true},"ClaimReason":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"active":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"can_be_deleted":{"type":"boolean"}},"required":["id","name","active","created_at","updated_at","can_be_deleted"],"x-typelizer":true},"Claim":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"status":{"type":"string"},"resolution":{"type":"string","nullable":true},"order_id":{"type":"string","nullable":true},"reason_id":{"type":"string","nullable":true},"refund_total":{"type":"string"},"display_refund_total":{"type":"string"},"approved_at":{"type":"string","nullable":true},"resolved_at":{"type":"string","nullable":true},"denied_at":{"type":"string","nullable":true},"canceled_at":{"type":"string","nullable":true},"reason":{"$ref":"#/components/schemas/ClaimReason"},"claim_line_items":{"type":"array","items":{"$ref":"#/components/schemas/ClaimLineItem"}},"memo":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"created_by_id":{"type":"string","nullable":true},"order":{"$ref":"#/components/schemas/Order"},"refunds":{"type":"array","items":{"$ref":"#/components/schemas/Refund"}}},"required":["id","number","status","resolution","order_id","reason_id","refund_total","display_refund_total","approved_at","resolved_at","denied_at","canceled_at","memo","metadata","created_at","updated_at","created_by_id"],"x-typelizer":true},"CollectionRule":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"value":{"type":"string","nullable":true},"match_policy":{"type":"string"}},"required":["id","type","value","match_policy"],"x-typelizer":true},"Collection":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"permalink":{"type":"string"},"position":{"type":"number"},"sort_order":{"type":"string"},"meta_title":{"type":"string","nullable":true},"meta_description":{"type":"string","nullable":true},"meta_keywords":{"type":"string","nullable":true},"products_count":{"type":"number"},"description":{"type":"string"},"description_html":{"type":"string"},"image_url":{"type":"string","nullable":true},"square_image_url":{"type":"string","nullable":true},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"translations":{"type":"object"},"automatic":{"type":"boolean"},"rules_match_policy":{"type":"string"},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/CollectionRule"}}},"required":["id","name","permalink","position","sort_order","meta_title","meta_description","meta_keywords","products_count","description","description_html","image_url","square_image_url","automatic","rules_match_policy","metadata","created_at","updated_at"],"x-typelizer":true},"CommissionLine":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"currency":{"type":"string"},"taxability_reason":{"type":"string","nullable":true},"country_code":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"rate":{"type":"string"},"tax_rate":{"type":"string"},"amount":{"type":"string"},"tax_amount":{"type":"string"},"total":{"type":"string"},"display_amount":{"type":"string"},"display_tax_amount":{"type":"string"},"display_total":{"type":"string"},"order_id":{"type":"string"},"seller_id":{"type":"string"},"line_item_id":{"type":"string","nullable":true},"fulfillment_id":{"type":"string","nullable":true},"commission_rate_id":{"type":"string","nullable":true},"seller_name":{"type":"string","nullable":true}},"required":["id","kind","currency","taxability_reason","country_code","state_code","created_at","updated_at","rate","tax_rate","amount","tax_amount","total","display_amount","display_tax_amount","display_total","order_id","seller_id","line_item_id","fulfillment_id","commission_rate_id","seller_name"],"x-typelizer":true},"CommissionRate":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"code":{"type":"string","nullable":true},"enabled":{"type":"boolean"},"position":{"type":"number"},"kind":{"type":"string"},"tax_inclusive":{"type":"boolean"},"include_shipping":{"type":"boolean"},"metadata":{"type":"object","nullable":true},"deleted_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"value":{"type":"string"},"commission_tax_rate":{"type":"string","nullable":true},"amounts":{"type":"object"},"bounds":{"type":"object"},"global":{"type":"boolean"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/CommissionRule"}}},"required":["id","name","code","enabled","position","kind","tax_inclusive","include_shipping","metadata","deleted_at","created_at","updated_at","value","commission_tax_rate","amounts","bounds","global","rules"],"x-typelizer":true},"CommissionRule":{"type":"object","properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"type":{"type":"string"},"commission_rate_id":{"type":"string"},"preferences":{"type":"object"},"preference_schema":{"type":"object"},"label":{"type":"string"},"description":{"type":"string","nullable":true},"product_ids":{"type":"array","items":{"type":"string"}}},"required":["id","created_at","updated_at","type","commission_rate_id","preferences","preference_schema","label","description"],"x-typelizer":true},"CompanyContact":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"company_location_id":{"type":"string"},"customer_id":{"type":"string"},"email":{"type":"string","nullable":true}},"required":["id","role","created_at","updated_at","company_location_id","customer_id","email"],"x-typelizer":true},"CompanyLocation":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"external_id":{"type":"string","nullable":true},"metadata":{"type":"object","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"company_id":{"type":"string"},"contacts_count":{"type":"number"},"billing_address":{"$ref":"#/components/schemas/Address"},"shipping_address":{"$ref":"#/components/schemas/Address"},"company_contacts":{"type":"array","items":{"$ref":"#/components/schemas/CompanyContact"}}},"required":["id","name","external_id","metadata","created_at","updated_at","company_id","contacts_count","billing_address","shipping_address"],"x-typelizer":true},"Company":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"external_id":{"type":"string","nullable":true},"metadata":{"type":"object","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"locations_count":{"type":"number"},"company_locations":{"type":"array","items":{"$ref":"#/components/schemas/CompanyLocation"}}},"required":["id","name","external_id","metadata","created_at","updated_at","locations_count"],"x-typelizer":true},"Country":{"type":"object","properties":{"iso":{"type":"string"},"iso3":{"type":"string"},"name":{"type":"string"},"states_required":{"type":"boolean"},"zipcode_required":{"type":"boolean"},"states":{"type":"array","items":{"$ref":"#/components/schemas/State"}},"market":{"allOf":[{"$ref":"#/components/schemas/Market"}],"nullable":true}},"required":["iso","iso3","name","states_required","zipcode_required"],"x-typelizer":true},"CouponCode":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"state":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"promotion_id":{"type":"string"},"order_id":{"type":"string","nullable":true}},"required":["id","code","state","created_at","updated_at","promotion_id","order_id"],"x-typelizer":true},"CreditCard":{"type":"object","properties":{"id":{"type":"string"},"brand":{"type":"string"},"last4":{"type":"string"},"month":{"type":"number"},"year":{"type":"number"},"name":{"type":"string","nullable":true},"default":{"type":"boolean"},"gateway_payment_profile_id":{"type":"string","nullable":true},"customer_id":{"type":"string","nullable":true},"payment_method_id":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","brand","last4","month","year","name","default","gateway_payment_profile_id","customer_id","payment_method_id","metadata","created_at","updated_at"],"x-typelizer":true},"CustomFieldDefinition":{"type":"object","properties":{"id":{"type":"string"},"namespace":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"},"field_type":{"type":"string","enum":["short_text","long_text","rich_text","number","boolean","json"]},"resource_type":{"type":"string"},"storefront_visible":{"type":"boolean"},"searchable":{"type":"boolean"},"sortable":{"type":"boolean"},"filter_key":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","namespace","key","label","field_type","resource_type","storefront_visible","searchable","sortable","filter_key","created_at","updated_at"],"x-typelizer":true},"CustomField":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"type":{"type":"string","deprecated":true},"field_type":{"type":"string","enum":["short_text","long_text","rich_text","number","boolean","json"]},"key":{"type":"string"},"value":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"storefront_visible":{"type":"boolean"},"custom_field_definition_id":{"type":"string"}},"required":["id","label","type","field_type","key","value","created_at","updated_at","storefront_visible","custom_field_definition_id"],"x-typelizer":true},"CustomerGroup":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"customers_count":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"customers":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}}},"required":["id","name","description","customers_count","created_at","updated_at"],"x-typelizer":true},"Customer":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"accepts_email_marketing":{"type":"boolean"},"full_name":{"type":"string"},"available_store_credit_total":{"type":"string"},"display_available_store_credit_total":{"type":"string"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"default_billing_address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"nullable":true},"default_shipping_address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"nullable":true},"newsletter_subscriber":{"allOf":[{"$ref":"#/components/schemas/NewsletterSubscriber"}],"nullable":true},"customer_groups":{"type":"array","items":{"$ref":"#/components/schemas/CustomerGroup"}},"failed_attempts":{"type":"number"},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"internal_note":{"type":"string","nullable":true},"internal_note_html":{"type":"string","nullable":true},"default_billing_address_id":{"type":"string","nullable":true},"default_shipping_address_id":{"type":"string","nullable":true},"orders_count":{"type":"number"},"total_spent":{"type":"string"},"display_total_spent":{"type":"string"},"last_order_completed_at":{"type":"string","nullable":true},"orders":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"store_credits":{"type":"array","items":{"$ref":"#/components/schemas/StoreCredit"}},"customer_group_ids":{"type":"array","items":{"type":"string"}}},"required":["id","email","first_name","last_name","phone","accepts_email_marketing","full_name","available_store_credit_total","display_available_store_credit_total","failed_attempts","metadata","created_at","updated_at","tags","internal_note","internal_note_html","default_billing_address_id","default_shipping_address_id","orders_count","total_spent","display_total_spent","last_order_completed_at","customer_group_ids"],"x-typelizer":true},"DeliveryMethodRule":{"type":"object","properties":{"id":{"type":"string"},"active":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"preferences":{"type":"object"},"preference_schema":{"type":"object"},"product_ids":{"type":"array","items":{"type":"string"}}},"required":["id","active","created_at","updated_at","type","name","description","preferences","preference_schema","product_ids"],"x-typelizer":true},"DeliveryMethod":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"code":{"type":"string","nullable":true},"estimated_transit_business_days_min":{"type":"number","nullable":true},"estimated_transit_business_days_max":{"type":"number","nullable":true},"digital":{"type":"boolean"},"pickup":{"type":"boolean"},"pickup_point":{"type":"boolean"},"admin_name":{"type":"string","nullable":true},"fulfillment_provider":{"type":"string"},"pickup_point_provider":{"type":"string","nullable":true},"rate_provider":{"type":"string","nullable":true},"storefront_visible":{"type":"boolean"},"tracking_url":{"type":"string","nullable":true},"markup_flat":{"type":"string","nullable":true},"markup_percent":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"services":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryMethodService"}},"rules":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryMethodRule"}},"tax_category_id":{"type":"string","nullable":true},"delivery_profile_id":{"type":"string"},"delivery_origin_group_id":{"type":"string","nullable":true},"delivery_zone_id":{"type":"string","nullable":true},"stock_location_ids":{"type":"array","items":{"type":"string"}},"calculator_type":{"type":"string","nullable":true},"calculator_preferences":{"type":"object","nullable":true}},"required":["id","name","code","estimated_transit_business_days_min","estimated_transit_business_days_max","digital","pickup","pickup_point","admin_name","fulfillment_provider","pickup_point_provider","rate_provider","storefront_visible","tracking_url","markup_flat","markup_percent","created_at","updated_at","deleted_at","services","rules","tax_category_id","delivery_profile_id","delivery_origin_group_id","delivery_zone_id","stock_location_ids","calculator_type","calculator_preferences"],"x-typelizer":true},"DeliveryMethodService":{"type":"object","properties":{"id":{"type":"string"},"carrier":{"type":"string"},"service":{"type":"string"},"label":{"type":"string","nullable":true},"markup_flat":{"type":"string","nullable":true},"markup_percent":{"type":"string","nullable":true},"position":{"type":"number"}},"required":["id","carrier","service","label","markup_flat","markup_percent","position"],"x-typelizer":true},"DeliveryOriginGroup":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"position":{"type":"number","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"delivery_profile_id":{"type":"string"},"stock_location_ids":{"type":"array","items":{"type":"string"}},"delivery_zones_count":{"type":"number"},"delivery_methods_count":{"type":"number"}},"required":["id","name","position","created_at","updated_at","delivery_profile_id","stock_location_ids","delivery_zones_count","delivery_methods_count"],"x-typelizer":true},"DeliveryProfile":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"default":{"type":"boolean"},"position":{"type":"number","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"kind":{"type":"string"},"digital":{"type":"boolean"},"offers_pickup":{"type":"boolean"},"offers_shipping":{"type":"boolean"},"stock_location_ids":{"type":"array","items":{"type":"string"}},"origin_groups":{"type":"object"},"products_count":{"type":"number"},"delivery_methods_count":{"type":"number"},"delivery_zones_count":{"type":"number"}},"required":["id","name","default","position","created_at","updated_at","kind","digital","offers_pickup","offers_shipping","stock_location_ids","origin_groups","products_count","delivery_methods_count","delivery_zones_count"],"x-typelizer":true},"DeliveryRate":{"type":"object","properties":{"id":{"type":"string"},"delivery_method_id":{"type":"string"},"name":{"type":"string"},"selected":{"type":"boolean"},"cost":{"type":"string"},"total":{"type":"string"},"additional_tax_total":{"type":"string"},"included_tax_total":{"type":"string"},"tax_total":{"type":"string"},"carrier":{"type":"string","nullable":true},"service_level":{"type":"string","nullable":true},"estimated_delivery_date":{"type":"string","nullable":true},"display_cost":{"type":"string"},"display_total":{"type":"string"},"display_additional_tax_total":{"type":"string"},"display_included_tax_total":{"type":"string"},"display_tax_total":{"type":"string"},"delivery_method":{"$ref":"#/components/schemas/DeliveryMethod"},"metadata":{"type":"object","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","delivery_method_id","name","selected","cost","total","additional_tax_total","included_tax_total","tax_total","carrier","service_level","estimated_delivery_date","display_cost","display_total","display_additional_tax_total","display_included_tax_total","display_tax_total","metadata","created_at","updated_at"],"x-typelizer":true},"DeliveryZoneMember":{"type":"object","properties":{"id":{"type":"string"},"member_type":{"type":"string"},"country_code":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true},"postal_code_prefix":{"type":"string","nullable":true},"postal_code_from":{"type":"string","nullable":true},"postal_code_to":{"type":"string","nullable":true},"country_name":{"type":"string","nullable":true},"state_name":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","member_type","country_code","state_code","postal_code_prefix","postal_code_from","postal_code_to","country_name","state_name","created_at","updated_at"],"x-typelizer":true},"DeliveryZone":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"members":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryZoneMember"}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"delivery_profile_id":{"type":"string"},"delivery_origin_group_id":{"type":"string","nullable":true},"delivery_method_ids":{"type":"array","items":{"type":"string"}}},"required":["id","name","description","created_at","updated_at","delivery_profile_id","delivery_origin_group_id","delivery_method_ids"],"x-typelizer":true},"DigitalLink":{"type":"object","properties":{"id":{"type":"string"},"access_counter":{"type":"number"},"filename":{"type":"string"},"content_type":{"type":"string"},"download_url":{"type":"string"},"authorizable":{"type":"boolean"},"expired":{"type":"boolean"},"access_limit_exceeded":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","access_counter","filename","content_type","download_url","authorizable","expired","access_limit_exceeded","created_at","updated_at"],"x-typelizer":true},"Discount":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"kind":{"type":"string"},"code":{"type":"string","nullable":true},"value_type":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"promotion_id":{"type":"string","nullable":true},"line_item_id":{"type":"string","nullable":true},"fulfillment_id":{"type":"string","nullable":true},"amount":{"type":"string"},"display_amount":{"type":"string"},"metadata":{"type":"object","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","label","kind","code","value_type","value","promotion_id","line_item_id","fulfillment_id","amount","display_amount","metadata","created_at","updated_at"],"x-typelizer":true},"ExchangeLineItem":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"number"},"received_quantity":{"type":"number"},"resellable":{"type":"boolean"},"original_price":{"type":"string"},"new_variant_price":{"type":"string"},"price_difference":{"type":"string"},"original_variant_id":{"type":"string","nullable":true},"new_variant_id":{"type":"string","nullable":true},"line_item_id":{"type":"string","nullable":true},"fulfillment_item_id":{"type":"string","nullable":true},"original_variant":{"$ref":"#/components/schemas/Variant"},"new_variant":{"$ref":"#/components/schemas/Variant"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","quantity","received_quantity","resellable","original_price","new_variant_price","price_difference","original_variant_id","new_variant_id","line_item_id","fulfillment_item_id","created_at","updated_at"],"x-typelizer":true},"Exchange":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"status":{"type":"string"},"order_id":{"type":"string","nullable":true},"reason_id":{"type":"string","nullable":true},"price_difference":{"type":"string"},"display_price_difference":{"type":"string"},"approved_at":{"type":"string","nullable":true},"received_at":{"type":"string","nullable":true},"fulfilled_at":{"type":"string","nullable":true},"canceled_at":{"type":"string","nullable":true},"reason":{"$ref":"#/components/schemas/ReturnReason"},"exchange_line_items":{"type":"array","items":{"$ref":"#/components/schemas/ExchangeLineItem"}},"memo":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"stock_location_id":{"type":"string","nullable":true},"created_by_id":{"type":"string","nullable":true},"order":{"$ref":"#/components/schemas/Order"},"stock_location":{"$ref":"#/components/schemas/StockLocation"},"refunds":{"type":"array","items":{"$ref":"#/components/schemas/Refund"}}},"required":["id","number","status","order_id","reason_id","price_difference","display_price_difference","approved_at","received_at","fulfilled_at","canceled_at","memo","metadata","created_at","updated_at","stock_location_id","created_by_id"],"x-typelizer":true},"Export":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"format":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"type":{"type":"string","nullable":true},"user_id":{"type":"string","nullable":true},"done":{"type":"boolean"},"filename":{"type":"string","nullable":true},"byte_size":{"type":"number","nullable":true},"download_url":{"type":"string","nullable":true}},"required":["id","number","format","created_at","updated_at","type","user_id","done","filename","byte_size","download_url"],"x-typelizer":true},"Fee":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"kind":{"type":"string"},"line_item_id":{"type":"string","nullable":true},"fulfillment_id":{"type":"string","nullable":true},"amount":{"type":"string"},"display_amount":{"type":"string"},"metadata":{"type":"object","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","label","kind","line_item_id","fulfillment_id","amount","display_amount","metadata","created_at","updated_at"],"x-typelizer":true},"FulfillmentItem":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"number"},"status":{"type":"string"},"variant_id":{"type":"string","nullable":true},"line_item_id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"options_text":{"type":"string","nullable":true}},"required":["id","quantity","status","variant_id","line_item_id","name","options_text"],"x-typelizer":true},"Fulfillment":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"tracking":{"type":"string","nullable":true},"tracking_url":{"type":"string","nullable":true},"tracking_carrier":{"type":"string","nullable":true},"tracking_carrier_name":{"type":"string","nullable":true},"pickup_point_data":{"type":"object","nullable":true},"selected_delivery_rate_id":{"type":"string","nullable":true},"cost":{"type":"string"},"display_cost":{"type":"string"},"total":{"type":"string"},"display_total":{"type":"string"},"discount_total":{"type":"string"},"display_discount_total":{"type":"string"},"additional_tax_total":{"type":"string"},"display_additional_tax_total":{"type":"string"},"included_tax_total":{"type":"string"},"display_included_tax_total":{"type":"string"},"tax_total":{"type":"string"},"display_tax_total":{"type":"string"},"status":{"type":"string"},"fulfillment_type":{"type":"string"},"fulfilled_at":{"type":"string","nullable":true},"tracking_status":{"type":"string","nullable":true},"estimated_delivery_at":{"type":"string","nullable":true},"delivered_at":{"type":"string","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentManifestItem"}},"delivery_method":{"$ref":"#/components/schemas/DeliveryMethod"},"stock_location":{"$ref":"#/components/schemas/StockLocation"},"delivery_rates":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryRate"}},"tax_lines":{"type":"array","items":{"$ref":"#/components/schemas/TaxLine"}},"metadata":{"type":"object"},"tracking_details":{"type":"object","nullable":true},"adjustment_total":{"type":"string"},"pre_tax_amount":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"order_id":{"type":"string","nullable":true},"stock_location_id":{"type":"string","nullable":true},"documents":{"type":"object"},"provider_generates_labels":{"type":"boolean"},"fulfillment_items":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentItem"}},"order":{"$ref":"#/components/schemas/Order"}},"required":["id","number","tracking","tracking_url","tracking_carrier","tracking_carrier_name","pickup_point_data","selected_delivery_rate_id","cost","display_cost","total","display_total","discount_total","display_discount_total","additional_tax_total","display_additional_tax_total","included_tax_total","display_included_tax_total","tax_total","display_tax_total","status","fulfillment_type","fulfilled_at","tracking_status","estimated_delivery_at","delivered_at","items","metadata","tracking_details","adjustment_total","pre_tax_amount","created_at","updated_at","order_id","stock_location_id","documents","provider_generates_labels"],"x-typelizer":true},"GiftCardBatch":{"type":"object","properties":{"id":{"type":"string"},"codes_count":{"type":"number"},"currency":{"type":"string","nullable":true},"prefix":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"amount":{"type":"string","nullable":true},"expires_at":{"type":"string","nullable":true},"created_by_id":{"type":"string","nullable":true}},"required":["id","codes_count","currency","prefix","created_at","updated_at","amount","expires_at","created_by_id"],"x-typelizer":true},"GiftCard":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"status":{"type":"string"},"currency":{"type":"string"},"amount":{"type":"string"},"amount_used":{"type":"string"},"amount_authorized":{"type":"string"},"amount_remaining":{"type":"string"},"display_amount":{"type":"string"},"display_amount_used":{"type":"string"},"display_amount_remaining":{"type":"string"},"expires_at":{"type":"string","nullable":true},"redeemed_at":{"type":"string","nullable":true},"expired":{"type":"boolean"},"active":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"customer_id":{"type":"string","nullable":true},"created_by_id":{"type":"string","nullable":true},"customer":{"$ref":"#/components/schemas/Customer"},"created_by":{"$ref":"#/components/schemas/AdminUser"},"gift_card_batch":{"$ref":"#/components/schemas/GiftCardBatch"},"orders":{"type":"array","items":{"$ref":"#/components/schemas/Order"}}},"required":["id","code","status","currency","amount","amount_used","amount_authorized","amount_remaining","display_amount","display_amount_used","display_amount_remaining","expires_at","redeemed_at","expired","active","created_at","updated_at","customer_id","created_by_id"],"x-typelizer":true},"ImportMapping":{"type":"object","properties":{"id":{"type":"string"},"schema_field":{"type":"string"},"file_column":{"type":"string","nullable":true},"required":{"type":"boolean"}},"required":["id","schema_field","file_column","required"],"x-typelizer":true},"ImportRow":{"type":"object","properties":{"id":{"type":"string"},"row_number":{"type":"number"},"status":{"type":"string"},"validation_errors":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"import_id":{"type":"string","nullable":true},"item_type":{"type":"string","nullable":true},"item_id":{"type":"string","nullable":true},"data":{"type":"object"}},"required":["id","row_number","status","validation_errors","created_at","updated_at","import_id","item_type","item_id","data"],"x-typelizer":true},"Import":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"rows_count":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"type":{"type":"string","nullable":true},"status":{"type":"string"},"owner_type":{"type":"string","nullable":true},"owner_id":{"type":"string","nullable":true},"user_id":{"type":"string","nullable":true},"processing_errors":{"type":"string","nullable":true},"preferred_delimiter":{"type":"string"},"original_filename":{"type":"string","nullable":true},"original_byte_size":{"type":"number","nullable":true},"original_file_url":{"type":"string","nullable":true},"completed_rows_count":{"type":"number"},"failed_rows_count":{"type":"number"},"schema_fields":{"type":"array","items":{"$ref":"#/components/schemas/ImportSchemaField"}},"csv_headers":{"type":"array","items":{"type":"string"}},"sample_row":{"type":"object"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/ImportMapping"}}},"required":["id","number","rows_count","created_at","updated_at","type","status","owner_type","owner_id","user_id","processing_errors","preferred_delimiter","original_filename","original_byte_size","original_file_url","completed_rows_count","failed_rows_count","schema_fields","csv_headers","sample_row","mappings"],"x-typelizer":true},"Integration":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"active":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"type":{"type":"string"},"group":{"type":"string","nullable":true},"preferences":{"type":"object"},"preference_schema":{"type":"object"}},"required":["id","name","active","created_at","updated_at","type","group","preferences","preference_schema"],"x-typelizer":true},"Invitation":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"status":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"expires_at":{"type":"string"},"role_id":{"type":"string"},"role_name":{"type":"string"},"inviter_email":{"type":"string"},"acceptance_url":{"type":"string"},"invitee_exists":{"type":"boolean"},"store":{"type":"object"}},"required":["id","email","status","created_at","updated_at","expires_at","role_id","role_name","inviter_email","acceptance_url","invitee_exists","store"],"x-typelizer":true},"LineItem":{"type":"object","properties":{"id":{"type":"string"},"variant_id":{"type":"string"},"seller_id":{"type":"string","nullable":true},"preorder":{"type":"boolean"},"preorder_ships_at":{"type":"string","nullable":true},"quantity":{"type":"number"},"currency":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"options_text":{"type":"string"},"price":{"type":"string"},"display_price":{"type":"string"},"total":{"type":"string"},"display_total":{"type":"string"},"adjustment_total":{"type":"string"},"display_adjustment_total":{"type":"string"},"additional_tax_total":{"type":"string"},"display_additional_tax_total":{"type":"string"},"included_tax_total":{"type":"string"},"display_included_tax_total":{"type":"string"},"discount_total":{"type":"string"},"display_discount_total":{"type":"string"},"pre_tax_amount":{"type":"string"},"display_pre_tax_amount":{"type":"string"},"discounted_amount":{"type":"string"},"display_discounted_amount":{"type":"string"},"display_compare_at_amount":{"type":"string","nullable":true},"compare_at_amount":{"type":"string","nullable":true},"thumbnail_url":{"type":"string","nullable":true},"seller":{"$ref":"#/components/schemas/Seller"},"option_values":{"type":"array","items":{"$ref":"#/components/schemas/OptionValue"}},"digital_links":{"type":"array","items":{"$ref":"#/components/schemas/DigitalLink"}},"tax_lines":{"type":"array","items":{"$ref":"#/components/schemas/TaxLine"}},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"cost_price":{"type":"string","nullable":true},"tax_category_id":{"type":"string","nullable":true},"variant":{"$ref":"#/components/schemas/Variant"},"tax_category":{"$ref":"#/components/schemas/TaxCategory"}},"required":["id","variant_id","seller_id","preorder","preorder_ships_at","quantity","currency","name","slug","options_text","price","display_price","total","display_total","adjustment_total","display_adjustment_total","additional_tax_total","display_additional_tax_total","included_tax_total","display_included_tax_total","discount_total","display_discount_total","pre_tax_amount","display_pre_tax_amount","discounted_amount","display_discounted_amount","display_compare_at_amount","compare_at_amount","thumbnail_url","option_values","digital_links","metadata","created_at","updated_at","cost_price","tax_category_id"],"x-typelizer":true},"Market":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"currency":{"type":"string"},"default_locale":{"type":"string"},"tax_inclusive":{"type":"boolean"},"default":{"type":"boolean"},"country_codes":{"type":"array","items":{"type":"string"}},"supported_locales":{"type":"array","items":{"type":"string"}},"countries":{"type":"array","items":{"$ref":"#/components/schemas/Country"}},"tax_provider":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","name","currency","default_locale","tax_inclusive","default","country_codes","supported_locales","tax_provider","created_at","updated_at"],"x-typelizer":true},"Media":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string","nullable":true},"variant_ids":{"type":"array","items":{"type":"string"}},"position":{"type":"number"},"alt":{"type":"string","nullable":true},"media_type":{"type":"string"},"focal_point_x":{"type":"number","nullable":true},"focal_point_y":{"type":"number","nullable":true},"external_video_url":{"type":"string","nullable":true},"video_provider":{"type":"string","nullable":true},"video_embed_url":{"type":"string","nullable":true},"video_url":{"type":"string","nullable":true},"poster_url":{"type":"string","nullable":true},"original_url":{"type":"string","nullable":true},"mini_url":{"type":"string","nullable":true},"small_url":{"type":"string","nullable":true},"medium_url":{"type":"string","nullable":true},"large_url":{"type":"string","nullable":true},"xlarge_url":{"type":"string","nullable":true},"og_image_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"viewable_id":{"type":"string"},"download_url":{"type":"string","nullable":true},"metadata":{"type":"object"},"viewable_type":{"type":"string"}},"required":["id","product_id","variant_ids","position","alt","media_type","focal_point_x","focal_point_y","external_video_url","video_provider","video_embed_url","video_url","poster_url","original_url","mini_url","small_url","medium_url","large_url","xlarge_url","og_image_url","created_at","updated_at","viewable_id","download_url","metadata","viewable_type"],"x-typelizer":true},"NewsletterSubscriber":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"verified":{"type":"boolean"},"verified_at":{"type":"string","nullable":true},"customer_id":{"type":"string","nullable":true}},"required":["id","email","created_at","updated_at","verified","verified_at","customer_id"],"x-typelizer":true},"OptionType":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"label":{"type":"string"},"position":{"type":"number"},"kind":{"type":"string"},"translations":{"type":"object"},"metadata":{"type":"object"},"filterable":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"option_values":{"type":"array","items":{"$ref":"#/components/schemas/OptionValue"}}},"required":["id","name","label","position","kind","metadata","filterable","created_at","updated_at"],"x-typelizer":true},"OptionValue":{"type":"object","properties":{"id":{"type":"string"},"option_type_id":{"type":"string"},"name":{"type":"string"},"label":{"type":"string"},"position":{"type":"number"},"color_code":{"type":"string","nullable":true},"option_type_name":{"type":"string"},"option_type_label":{"type":"string"},"image_url":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"option_type":{"$ref":"#/components/schemas/OptionType"}},"required":["id","option_type_id","name","label","position","color_code","option_type_name","option_type_label","image_url","metadata","created_at","updated_at"],"x-typelizer":true},"OrderRoutingRule":{"type":"object","properties":{"id":{"type":"string"},"position":{"type":"number"},"active":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"type":{"type":"string"},"channel_id":{"type":"string"},"preferences":{"type":"object"},"preference_schema":{"type":"object"},"label":{"type":"string"},"description":{"type":"string"}},"required":["id","position","active","created_at","updated_at","type","channel_id","preferences","preference_schema","label","description"],"x-typelizer":true},"Order":{"type":"object","properties":{"id":{"type":"string"},"market_id":{"type":"string","nullable":true},"cart_id":{"type":"string","nullable":true},"channel_id":{"type":"string","nullable":true},"number":{"type":"string"},"email":{"type":"string"},"customer_note":{"type":"string","nullable":true},"currency":{"type":"string"},"locale":{"type":"string","nullable":true},"total_quantity":{"type":"number"},"coupon_code":{"type":"string","nullable":true},"fulfillment_status":{"type":"string","nullable":true},"payment_status":{"type":"string","nullable":true},"completed_at":{"type":"string","nullable":true},"item_total":{"type":"string"},"display_item_total":{"type":"string"},"adjustment_total":{"type":"string"},"display_adjustment_total":{"type":"string"},"discount_total":{"type":"string"},"display_discount_total":{"type":"string"},"tax_total":{"type":"string"},"display_tax_total":{"type":"string"},"included_tax_total":{"type":"string"},"display_included_tax_total":{"type":"string"},"additional_tax_total":{"type":"string"},"display_additional_tax_total":{"type":"string"},"total":{"type":"string"},"display_total":{"type":"string"},"gift_card_total":{"type":"string"},"display_gift_card_total":{"type":"string"},"amount_due":{"type":"string"},"display_amount_due":{"type":"string"},"delivery_total":{"type":"string"},"display_delivery_total":{"type":"string"},"fee_total":{"type":"string"},"display_fee_total":{"type":"string"},"store_credit_total":{"type":"string"},"display_store_credit_total":{"type":"string"},"covered_by_store_credit":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"fulfillments":{"type":"array","items":{"$ref":"#/components/schemas/Fulfillment"}},"payments":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}},"billing_address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"nullable":true},"shipping_address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"nullable":true},"gift_card":{"allOf":[{"$ref":"#/components/schemas/GiftCard"}],"nullable":true},"market":{"allOf":[{"$ref":"#/components/schemas/Market"}],"nullable":true},"status":{"type":"string"},"last_ip_address":{"type":"string","nullable":true},"considered_risky":{"type":"boolean"},"confirmation_delivered":{"type":"boolean"},"store_owner_notification_delivered":{"type":"boolean"},"payment_total":{"type":"string"},"display_payment_total":{"type":"string"},"metadata":{"type":"object"},"canceled_at":{"type":"string","nullable":true},"approved_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"preferred_stock_location_id":{"type":"string","nullable":true},"company_location_id":{"type":"string","nullable":true},"company_id":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"}},"internal_note":{"type":"string","nullable":true},"internal_note_html":{"type":"string","nullable":true},"approver_id":{"type":"string","nullable":true},"canceler_id":{"type":"string","nullable":true},"created_by_id":{"type":"string","nullable":true},"customer_id":{"type":"string","nullable":true},"applied_promotions":{"type":"array","items":{"$ref":"#/components/schemas/AppliedPromotion"}},"cart":{"$ref":"#/components/schemas/Cart"},"channel":{"$ref":"#/components/schemas/Channel"},"preferred_stock_location":{"$ref":"#/components/schemas/StockLocation"},"payment_methods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"customer":{"$ref":"#/components/schemas/Customer"},"approver":{"$ref":"#/components/schemas/Customer"},"canceler":{"$ref":"#/components/schemas/Customer"},"created_by":{"$ref":"#/components/schemas/Customer"},"returns":{"type":"array","items":{"$ref":"#/components/schemas/Return"}},"exchanges":{"type":"array","items":{"$ref":"#/components/schemas/Exchange"}},"claims":{"type":"array","items":{"$ref":"#/components/schemas/Claim"}}},"required":["id","market_id","cart_id","channel_id","number","email","customer_note","currency","locale","total_quantity","coupon_code","fulfillment_status","payment_status","completed_at","item_total","display_item_total","adjustment_total","display_adjustment_total","discount_total","display_discount_total","tax_total","display_tax_total","included_tax_total","display_included_tax_total","additional_tax_total","display_additional_tax_total","total","display_total","gift_card_total","display_gift_card_total","amount_due","display_amount_due","delivery_total","display_delivery_total","fee_total","display_fee_total","store_credit_total","display_store_credit_total","covered_by_store_credit","gift_card","market","status","last_ip_address","considered_risky","confirmation_delivered","store_owner_notification_delivered","payment_total","display_payment_total","metadata","canceled_at","approved_at","created_at","updated_at","preferred_stock_location_id","company_location_id","company_id","tags","internal_note","internal_note_html","approver_id","canceler_id","created_by_id","customer_id"],"x-typelizer":true},"PaymentMethod":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"type":{"type":"string"},"session_required":{"type":"boolean"},"source_required":{"type":"boolean"},"metadata":{"type":"object"},"active":{"type":"boolean"},"auto_capture":{"type":"boolean","nullable":true},"capture_method":{"type":"string","enum":["checkout","on_dispatch","manual"],"nullable":true},"resolved_capture_method":{"type":"string","enum":["checkout","on_dispatch","manual"]},"storefront_visible":{"type":"boolean"},"position":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"preferences":{"type":"object"},"preference_schema":{"type":"object"}},"required":["id","name","description","type","session_required","source_required","metadata","active","auto_capture","capture_method","resolved_capture_method","storefront_visible","position","created_at","updated_at","preferences","preference_schema"],"x-typelizer":true},"Payment":{"type":"object","properties":{"id":{"type":"string"},"payment_method_id":{"type":"string"},"response_code":{"type":"string","nullable":true},"number":{"type":"string"},"amount":{"type":"string"},"display_amount":{"type":"string"},"status":{"type":"string"},"source_type":{"type":"string","nullable":true,"enum":["credit_card","store_credit","payment_source"]},"source_id":{"type":"string","nullable":true},"source":{"anyOf":[{"$ref":"#/components/schemas/CreditCard"},{"$ref":"#/components/schemas/StoreCredit"},{"$ref":"#/components/schemas/PaymentSource"}],"nullable":true},"payment_method":{"$ref":"#/components/schemas/PaymentMethod"},"metadata":{"type":"object"},"avs_response":{"type":"string","nullable":true},"cvv_response_code":{"type":"string","nullable":true},"cvv_response_message":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"captured_amount":{"type":"string"},"order_id":{"type":"string","nullable":true},"order":{"$ref":"#/components/schemas/Order"},"refunds":{"type":"array","items":{"$ref":"#/components/schemas/Refund"}}},"required":["id","payment_method_id","response_code","number","amount","display_amount","status","source_type","source_id","source","metadata","avs_response","cvv_response_code","cvv_response_message","created_at","updated_at","captured_amount","order_id"],"x-typelizer":true},"PaymentSource":{"type":"object","properties":{"id":{"type":"string"},"gateway_payment_profile_id":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","gateway_payment_profile_id","metadata","created_at","updated_at"],"x-typelizer":true},"Permission":{"type":"object","properties":{"key":{"type":"string"},"resource":{"type":"string"},"kind":{"type":"string"},"group":{"type":"string"},"group_label":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}},"required":["key","resource","kind","group","group_label","label","description"],"x-typelizer":true},"PriceHistory":{"type":"object","properties":{"id":{"type":"string"},"amount":{"type":"string"},"amount_in_cents":{"type":"number"},"currency":{"type":"string"},"display_amount":{"type":"string"},"recorded_at":{"type":"string"},"variant_id":{"type":"string"},"price_id":{"type":"string"},"compare_at_amount":{"type":"string","nullable":true},"created_at":{"type":"string"}},"required":["id","amount","amount_in_cents","currency","display_amount","recorded_at","variant_id","price_id","compare_at_amount","created_at"],"x-typelizer":true},"PriceList":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"status":{"type":"string"},"position":{"type":"number"},"match_policy":{"type":"string"},"starts_at":{"type":"string","nullable":true},"ends_at":{"type":"string","nullable":true},"deleted_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"currently_active":{"type":"boolean"},"products_count":{"type":"number"},"prices_count":{"type":"number"},"product_ids":{"type":"array","items":{"type":"string"}},"price_rules":{"type":"array","items":{"$ref":"#/components/schemas/PriceRule"}}},"required":["id","name","description","status","position","match_policy","starts_at","ends_at","deleted_at","created_at","updated_at","currently_active","products_count","prices_count","product_ids"],"x-typelizer":true},"PriceRule":{"type":"object","properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"type":{"type":"string"},"price_list_id":{"type":"string"},"preferences":{"type":"object"},"preference_schema":{"type":"array","items":{"$ref":"#/components/schemas/PreferenceField"}},"label":{"type":"string"},"description":{"type":"string","nullable":true},"markets":{"type":"array","items":{"$ref":"#/components/schemas/Market"}},"customer_groups":{"type":"array","items":{"$ref":"#/components/schemas/CustomerGroup"}},"channels":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}},"customers":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}}},"required":["id","created_at","updated_at","type","price_list_id","preferences","preference_schema","label","description"],"x-typelizer":true},"Price":{"type":"object","properties":{"id":{"type":"string"},"amount":{"type":"string","nullable":true},"amount_in_cents":{"type":"number","nullable":true},"compare_at_amount":{"type":"string","nullable":true},"compare_at_amount_in_cents":{"type":"number","nullable":true},"currency":{"type":"string","nullable":true},"display_amount":{"type":"string","nullable":true},"display_compare_at_amount":{"type":"string","nullable":true},"price_list_id":{"type":"string","nullable":true},"variant_id":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"variant":{"$ref":"#/components/schemas/Variant"}},"required":["id","amount","amount_in_cents","compare_at_amount","compare_at_amount_in_cents","currency","display_amount","display_compare_at_amount","price_list_id","variant_id","created_at","updated_at"],"x-typelizer":true},"ProductPublication":{"type":"object","properties":{"id":{"type":"string"},"published_at":{"type":"string","nullable":true},"unpublished_at":{"type":"string","nullable":true},"product_id":{"type":"string"},"channel_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","published_at","unpublished_at","product_id","channel_id","created_at","updated_at"],"x-typelizer":true},"Product":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"meta_title":{"type":"string","nullable":true},"meta_description":{"type":"string","nullable":true},"meta_keywords":{"type":"string","nullable":true},"variant_count":{"type":"number"},"available_on":{"type":"string","nullable":true},"preorder_ships_at":{"type":"string","nullable":true},"purchasable":{"type":"boolean"},"preorder":{"type":"boolean"},"in_stock":{"type":"boolean"},"backorderable":{"type":"boolean"},"available":{"type":"boolean"},"description":{"type":"string","nullable":true},"description_html":{"type":"string","nullable":true},"default_variant_id":{"type":"string"},"buy_box_variant_id":{"type":"string","nullable":true},"thumbnail_url":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"}},"price":{"allOf":[{"$ref":"#/components/schemas/Price"}],"nullable":true},"original_price":{"allOf":[{"$ref":"#/components/schemas/Price"}],"nullable":true},"seller_id":{"type":"string","nullable":true},"seller":{"$ref":"#/components/schemas/Seller"},"primary_media":{"$ref":"#/components/schemas/Media"},"media":{"type":"array","items":{"$ref":"#/components/schemas/Media"}},"variants":{"type":"array","items":{"$ref":"#/components/schemas/Variant"}},"default_variant":{"$ref":"#/components/schemas/Variant"},"option_types":{"type":"array","items":{"$ref":"#/components/schemas/OptionType"}},"option_values":{"type":"array","items":{"$ref":"#/components/schemas/OptionValue"}},"categories":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"prior_price":{"allOf":[{"$ref":"#/components/schemas/PriceHistory"}],"nullable":true},"translations":{"type":"object"},"status":{"type":"string"},"metadata":{"type":"object"},"deleted_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"delivery_profile_id":{"type":"string","nullable":true},"seller_name":{"type":"string","nullable":true},"product_type_id":{"type":"string","nullable":true},"tax_category_id":{"type":"string","nullable":true},"collections":{"type":"array","items":{"$ref":"#/components/schemas/Collection"}},"product_publications":{"type":"array","items":{"$ref":"#/components/schemas/ProductPublication"}},"channels":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}},"product_type":{"$ref":"#/components/schemas/ProductType"}},"required":["id","name","slug","meta_title","meta_description","meta_keywords","variant_count","available_on","preorder_ships_at","purchasable","preorder","in_stock","backorderable","available","description","description_html","default_variant_id","buy_box_variant_id","thumbnail_url","tags","price","original_price","seller_id","status","metadata","deleted_at","created_at","updated_at","delivery_profile_id","seller_name","product_type_id","tax_category_id"],"x-typelizer":true},"ProductTypeCustomFieldDefinition":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"namespace":{"type":"string"},"label":{"type":"string"},"field_type":{"type":"string","enum":["short_text","long_text","rich_text","number","boolean","json"]},"required":{"type":"boolean"},"sort_order":{"type":"number"}},"required":["id","key","namespace","label","field_type","required","sort_order"],"x-typelizer":true},"ProductType":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"translations":{"type":"object"},"products_count":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"delivery_profile_id":{"type":"string","nullable":true},"option_type_ids":{"type":"array","items":{"type":"string"}},"category_ids":{"type":"array","items":{"type":"string"}},"custom_field_definitions":{"type":"array","items":{"$ref":"#/components/schemas/ProductTypeCustomFieldDefinition"}}},"required":["id","name","products_count","created_at","updated_at","delivery_profile_id","option_type_ids","category_ids","custom_field_definitions"],"x-typelizer":true},"PromotionAction":{"type":"object","properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"type":{"type":"string"},"promotion_id":{"type":"string"},"preferences":{"type":"object"},"preference_schema":{"type":"array","items":{"$ref":"#/components/schemas/PreferenceField"}},"label":{"type":"string"},"calculator":{"allOf":[{"$ref":"#/components/schemas/PromotionActionCalculator"}],"nullable":true},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/PromotionActionLineItem"},"nullable":true}},"required":["id","created_at","updated_at","type","promotion_id","preferences","preference_schema","label","calculator","line_items"],"x-typelizer":true},"PromotionRule":{"type":"object","properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"type":{"type":"string"},"promotion_id":{"type":"string"},"preferences":{"type":"object"},"preference_schema":{"type":"array","items":{"$ref":"#/components/schemas/PreferenceField"}},"label":{"type":"string"},"product_ids":{"type":"array","items":{"type":"string"},"nullable":true},"category_ids":{"type":"array","items":{"type":"string"},"nullable":true},"customer_ids":{"type":"array","items":{"type":"string"},"nullable":true},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"categories":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"customers":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}},"customer_groups":{"type":"array","items":{"$ref":"#/components/schemas/CustomerGroup"}},"countries":{"type":"array","items":{"$ref":"#/components/schemas/Country"}},"channels":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}},"markets":{"type":"array","items":{"$ref":"#/components/schemas/Market"}}},"required":["id","created_at","updated_at","type","promotion_id","preferences","preference_schema","label","product_ids","category_ids","customer_ids"],"x-typelizer":true},"Promotion":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"starts_at":{"type":"string","nullable":true},"expires_at":{"type":"string","nullable":true},"usage_limit":{"type":"number","nullable":true},"match_policy":{"type":"string","enum":["all","any"]},"path":{"type":"string","nullable":true},"kind":{"type":"string","enum":["coupon_code","automatic"]},"multi_codes":{"type":"boolean"},"number_of_codes":{"type":"number","nullable":true},"code_prefix":{"type":"string","nullable":true},"promotion_category_id":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"action_ids":{"type":"array","items":{"type":"string"}},"rule_ids":{"type":"array","items":{"type":"string"}}},"required":["id","name","description","code","starts_at","expires_at","usage_limit","match_policy","path","kind","multi_codes","number_of_codes","code_prefix","promotion_category_id","metadata","created_at","updated_at","action_ids","rule_ids"],"x-typelizer":true},"RefundReason":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"active":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"can_be_deleted":{"type":"boolean"}},"required":["id","name","active","created_at","updated_at","can_be_deleted"],"x-typelizer":true},"Refund":{"type":"object","properties":{"id":{"type":"string"},"transaction_id":{"type":"string","nullable":true},"amount":{"type":"string","nullable":true},"payment_id":{"type":"string","nullable":true},"refund_reason_id":{"type":"string","nullable":true},"originator_id":{"type":"string","nullable":true},"originator_type":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"payment":{"$ref":"#/components/schemas/Payment"}},"required":["id","transaction_id","amount","payment_id","refund_reason_id","originator_id","originator_type","metadata","created_at","updated_at"],"x-typelizer":true},"ReturnLineItem":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"number"},"received_quantity":{"type":"number"},"resellable":{"type":"boolean"},"pre_tax_amount":{"type":"string"},"display_pre_tax_amount":{"type":"string"},"variant_id":{"type":"string","nullable":true},"line_item_id":{"type":"string","nullable":true},"fulfillment_item_id":{"type":"string","nullable":true},"variant":{"$ref":"#/components/schemas/Variant"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"line_item":{"$ref":"#/components/schemas/LineItem"}},"required":["id","quantity","received_quantity","resellable","pre_tax_amount","display_pre_tax_amount","variant_id","line_item_id","fulfillment_item_id","created_at","updated_at"],"x-typelizer":true},"ReturnReason":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"active":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"can_be_deleted":{"type":"boolean"}},"required":["id","name","active","created_at","updated_at","can_be_deleted"],"x-typelizer":true},"Return":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"status":{"type":"string"},"order_id":{"type":"string","nullable":true},"reason_id":{"type":"string","nullable":true},"refund_total":{"type":"string"},"display_refund_total":{"type":"string"},"approved_at":{"type":"string","nullable":true},"received_at":{"type":"string","nullable":true},"refunded_at":{"type":"string","nullable":true},"canceled_at":{"type":"string","nullable":true},"reason":{"$ref":"#/components/schemas/ReturnReason"},"return_line_items":{"type":"array","items":{"$ref":"#/components/schemas/ReturnLineItem"}},"memo":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"stock_location_id":{"type":"string","nullable":true},"created_by_id":{"type":"string","nullable":true},"refunded_total":{"type":"string"},"refundable_total":{"type":"string"},"order":{"$ref":"#/components/schemas/Order"},"stock_location":{"$ref":"#/components/schemas/StockLocation"},"refunds":{"type":"array","items":{"$ref":"#/components/schemas/Refund"}}},"required":["id","number","status","order_id","reason_id","refund_total","display_refund_total","approved_at","received_at","refunded_at","canceled_at","memo","metadata","created_at","updated_at","stock_location_id","created_by_id","refunded_total","refundable_total"],"x-typelizer":true},"Role":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"permissions":{"type":"array","items":{"type":"string"}},"mutable":{"type":"boolean"},"users_count":{"type":"number"}},"required":["id","name","description","created_at","updated_at","permissions","mutable","users_count"],"x-typelizer":true},"Seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"about":{"type":"string"},"about_html":{"type":"string"},"logo_url":{"type":"string","nullable":true},"square_logo_url":{"type":"string","nullable":true},"cover_photo_url":{"type":"string","nullable":true},"status":{"type":"string"},"contact_email":{"type":"string","nullable":true},"billing_email":{"type":"string","nullable":true},"tax_remittance":{"type":"string"},"payouts_schedule_interval":{"type":"string","nullable":true},"metadata":{"type":"object","nullable":true},"holiday_mode_until":{"type":"string","nullable":true},"terms_accepted_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string","nullable":true},"minimum_payout_amount":{"type":"string","nullable":true},"on_holiday":{"type":"boolean"},"sellable":{"type":"boolean"},"products_count":{"type":"number"},"users_count":{"type":"number"},"billing_address":{"$ref":"#/components/schemas/Address"},"returns_address":{"$ref":"#/components/schemas/Address"}},"required":["id","name","slug","about","about_html","logo_url","square_logo_url","cover_photo_url","status","contact_email","billing_email","tax_remittance","payouts_schedule_interval","metadata","holiday_mode_until","terms_accepted_at","created_at","updated_at","deleted_at","minimum_payout_amount","on_holiday","sellable","products_count","users_count"],"x-typelizer":true},"SetupTask":{"type":"object","properties":{"name":{"type":"string"},"done":{"type":"boolean"}},"required":["name","done"],"x-typelizer":true},"State":{"type":"object","properties":{"abbr":{"type":"string"},"name":{"type":"string"}},"required":["abbr","name"],"x-typelizer":true},"StockItem":{"type":"object","properties":{"id":{"type":"string"},"count_on_hand":{"type":"number"},"backorderable":{"type":"boolean"},"stock_location_id":{"type":"string","nullable":true},"variant_id":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"allocated_count":{"type":"number"},"available_count":{"type":"number"},"stock_location":{"$ref":"#/components/schemas/StockLocation"},"variant":{"$ref":"#/components/schemas/Variant"}},"required":["id","count_on_hand","backorderable","stock_location_id","variant_id","metadata","created_at","updated_at","allocated_count","available_count"],"x-typelizer":true},"StockLocation":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address1":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"zipcode":{"type":"string","nullable":true},"country_code":{"type":"string","nullable":true},"country_name":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true},"state_text":{"type":"string","nullable":true},"pickup_ready_in_minutes":{"type":"number","nullable":true},"pickup_instructions":{"type":"string","nullable":true},"admin_name":{"type":"string","nullable":true},"address2":{"type":"string","nullable":true},"state_name":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"active":{"type":"boolean"},"default":{"type":"boolean"},"backorderable_default":{"type":"boolean"},"propagate_all_variants":{"type":"boolean"},"kind":{"type":"string"},"pickup_enabled":{"type":"boolean"},"pickup_stock_policy":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","name","address1","city","zipcode","country_code","country_name","state_code","state_text","pickup_ready_in_minutes","pickup_instructions","admin_name","address2","state_name","phone","company","active","default","backorderable_default","propagate_all_variants","kind","pickup_enabled","pickup_stock_policy","created_at","updated_at"],"x-typelizer":true},"StockReservation":{"type":"object","properties":{"id":{"type":"string"},"stock_item_id":{"type":"string"},"line_item_id":{"type":"string"},"order_id":{"type":"string"},"variant_id":{"type":"string","nullable":true},"stock_location_id":{"type":"string","nullable":true},"quantity":{"type":"number"},"expires_at":{"type":"string"},"active":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","stock_item_id","line_item_id","order_id","variant_id","stock_location_id","quantity","expires_at","active","created_at","updated_at"],"x-typelizer":true},"StockTransfer":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"reference":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"source_location_id":{"type":"string","nullable":true},"destination_location_id":{"type":"string","nullable":true},"source_location":{"$ref":"#/components/schemas/StockLocation"},"destination_location":{"$ref":"#/components/schemas/StockLocation"}},"required":["id","number","reference","metadata","created_at","updated_at","source_location_id","destination_location_id"],"x-typelizer":true},"StoreCredit":{"type":"object","properties":{"id":{"type":"string"},"amount":{"type":"string"},"amount_used":{"type":"string"},"amount_remaining":{"type":"string"},"display_amount":{"type":"string"},"display_amount_used":{"type":"string"},"display_amount_remaining":{"type":"string"},"currency":{"type":"string"},"memo":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"customer_id":{"type":"string","nullable":true},"created_by_id":{"type":"string","nullable":true}},"required":["id","amount","amount_used","amount_remaining","display_amount","display_amount_used","display_amount_remaining","currency","memo","metadata","created_at","updated_at","customer_id","created_by_id"],"x-typelizer":true},"Store":{"type":"object","properties":{"id":{"type":"string"},"metadata":{"type":"object"},"name":{"type":"string"},"code":{"type":"string"},"preferred_storefront_url":{"type":"string","nullable":true},"default_currency":{"type":"string"},"default_locale":{"type":"string"},"mail_from_address":{"type":"string","nullable":true},"customer_support_email":{"type":"string","nullable":true},"new_order_notifications_email":{"type":"string","nullable":true},"preferred_send_consumer_transactional_emails":{"type":"boolean"},"preferred_admin_locale":{"type":"string","nullable":true},"preferred_timezone":{"type":"string"},"preferred_weight_unit":{"type":"string"},"preferred_default_package_weight":{"type":"number"},"preferred_default_package_length":{"type":"number"},"preferred_default_package_width":{"type":"number"},"preferred_default_package_height":{"type":"number"},"preferred_unit_system":{"type":"string"},"preferred_storefront_access":{"type":"string"},"preferred_guest_checkout":{"type":"boolean"},"preferred_company_field_enabled":{"type":"boolean"},"preferred_address_requires_company":{"type":"boolean"},"preferred_address_requires_phone":{"type":"boolean"},"preferred_capture_method":{"type":"string"},"preferred_track_inventory_levels":{"type":"boolean"},"preferred_stock_reservations_enabled":{"type":"boolean"},"preferred_track_price_history":{"type":"boolean"},"preferred_show_products_without_price":{"type":"boolean"},"preferred_disable_sku_validation":{"type":"boolean"},"preferred_order_routing_strategy":{"type":"string"},"preferred_document_number_format":{"type":"string"},"preferred_order_number_prefix":{"type":"string"},"preferred_order_number_suffix":{"type":"string"},"preferred_order_number_sequence_start":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"order_number_sequence_started":{"type":"boolean"},"url":{"type":"string"},"api_url":{"type":"string"},"setup_tasks":{"type":"array","items":{"$ref":"#/components/schemas/SetupTask"}},"supported_currencies":{"type":"array","items":{"type":"string"}},"supported_locales":{"type":"array","items":{"type":"string"}},"available_locales":{"type":"array","items":{"type":"string"}},"logo_url":{"type":"string","nullable":true},"mailer_logo_url":{"type":"string","nullable":true}},"required":["id","metadata","name","code","preferred_storefront_url","default_currency","default_locale","mail_from_address","customer_support_email","new_order_notifications_email","preferred_send_consumer_transactional_emails","preferred_admin_locale","preferred_timezone","preferred_weight_unit","preferred_default_package_weight","preferred_default_package_length","preferred_default_package_width","preferred_default_package_height","preferred_unit_system","preferred_storefront_access","preferred_guest_checkout","preferred_company_field_enabled","preferred_address_requires_company","preferred_address_requires_phone","preferred_capture_method","preferred_track_inventory_levels","preferred_stock_reservations_enabled","preferred_track_price_history","preferred_show_products_without_price","preferred_disable_sku_validation","preferred_order_routing_strategy","preferred_document_number_format","preferred_order_number_prefix","preferred_order_number_suffix","preferred_order_number_sequence_start","created_at","updated_at","order_number_sequence_started","url","api_url","setup_tasks","supported_currencies","supported_locales","available_locales","logo_url","mailer_logo_url"],"x-typelizer":true},"TaxCategory":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"tax_code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"is_default":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","name","tax_code","description","is_default","created_at","updated_at"],"x-typelizer":true},"TaxExemptionCertificate":{"type":"object","properties":{"id":{"type":"string"},"certificate_number":{"type":"string"},"reason_code":{"type":"string"},"status":{"type":"string"},"issuing_authority":{"type":"string","nullable":true},"metadata":{"type":"object","nullable":true},"issued_at":{"type":"string"},"expires_at":{"type":"string"},"verified_at":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"company_id":{"type":"string"},"country_code":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true},"active":{"type":"boolean"},"lapsed":{"type":"boolean"},"can_be_deleted":{"type":"boolean"},"document_filename":{"type":"string","nullable":true},"document_byte_size":{"type":"number","nullable":true},"document_url":{"type":"string","nullable":true}},"required":["id","certificate_number","reason_code","status","issuing_authority","metadata","issued_at","expires_at","verified_at","created_at","updated_at","company_id","country_code","state_code","active","lapsed","can_be_deleted","document_filename","document_byte_size","document_url"],"x-typelizer":true},"TaxIdentifier":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"value":{"type":"string"},"validation_status":{"type":"string","nullable":true},"validation_evidence":{"type":"object","nullable":true},"source":{"type":"string","nullable":true},"validated_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"validatable":{"type":"boolean"},"customer_id":{"type":"string","nullable":true},"cart_id":{"type":"string","nullable":true},"order_id":{"type":"string","nullable":true}},"required":["id","kind","value","validation_status","validation_evidence","source","validated_at","created_at","updated_at","validatable","customer_id","cart_id","order_id"],"x-typelizer":true},"TaxLine":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"included":{"type":"boolean"},"rate":{"type":"string"},"tax_rate_id":{"type":"string","nullable":true},"line_item_id":{"type":"string","nullable":true},"fulfillment_id":{"type":"string","nullable":true},"fee_id":{"type":"string","nullable":true},"amount":{"type":"string"},"display_amount":{"type":"string"},"provider_id":{"type":"string","nullable":true},"metadata":{"type":"object","nullable":true},"taxability_reason":{"type":"string","nullable":true},"country_code":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true},"data":{"type":"object","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","label","included","rate","tax_rate_id","line_item_id","fulfillment_id","fee_id","amount","display_amount","provider_id","metadata","taxability_reason","country_code","state_code","data","created_at","updated_at"],"x-typelizer":true},"TaxRate":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"included_in_price":{"type":"boolean"},"show_rate_in_label":{"type":"boolean"},"metadata":{"type":"object","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string","nullable":true},"amount":{"type":"string"},"amount_percentage":{"type":"number","nullable":true},"tax_category_id":{"type":"string","nullable":true},"store_id":{"type":"string","nullable":true},"country_code":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true}},"required":["id","name","included_in_price","show_rate_in_label","metadata","created_at","updated_at","deleted_at","amount","amount_percentage","tax_category_id","store_id","country_code","state_code"],"x-typelizer":true},"Variant":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"sku":{"type":"string","nullable":true},"options_text":{"type":"string"},"track_inventory":{"type":"boolean"},"media_count":{"type":"number"},"preorder_ships_at":{"type":"string","nullable":true},"thumbnail_url":{"type":"string","nullable":true},"purchasable":{"type":"boolean"},"in_stock":{"type":"boolean"},"backorderable":{"type":"boolean"},"preorder":{"type":"boolean"},"weight":{"type":"number","nullable":true},"height":{"type":"number","nullable":true},"width":{"type":"number","nullable":true},"depth":{"type":"number","nullable":true},"price":{"$ref":"#/components/schemas/Price"},"original_price":{"allOf":[{"$ref":"#/components/schemas/Price"}],"nullable":true},"seller_id":{"type":"string","nullable":true},"seller":{"$ref":"#/components/schemas/Seller"},"primary_media":{"$ref":"#/components/schemas/Media"},"media":{"type":"array","items":{"$ref":"#/components/schemas/Media"}},"option_values":{"type":"array","items":{"$ref":"#/components/schemas/OptionValue"}},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"prior_price":{"allOf":[{"$ref":"#/components/schemas/PriceHistory"}],"nullable":true},"metadata":{"type":"object"},"position":{"type":"number"},"cost_price":{"type":"string","nullable":true},"cost_currency":{"type":"string","nullable":true},"barcode":{"type":"string","nullable":true},"weight_unit":{"type":"string","nullable":true},"dimensions_unit":{"type":"string","nullable":true},"backorder_limit":{"type":"number","nullable":true},"hs_code":{"type":"string","nullable":true},"country_of_origin":{"type":"string","nullable":true},"customs_description":{"type":"string","nullable":true},"deleted_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"preorderable":{"type":"boolean"},"tax_category_id":{"type":"string","nullable":true},"available_stock":{"type":"number","nullable":true},"reserved_quantity":{"type":"number"},"total_on_hand":{"type":"number","nullable":true},"product_name":{"type":"string"},"delivery_profile_id":{"type":"string","nullable":true},"prices":{"type":"array","items":{"$ref":"#/components/schemas/Price"}},"stock_items":{"type":"array","items":{"$ref":"#/components/schemas/StockItem"}}},"required":["id","product_id","sku","options_text","track_inventory","media_count","preorder_ships_at","thumbnail_url","purchasable","in_stock","backorderable","preorder","weight","height","width","depth","price","original_price","seller_id","option_values","metadata","position","cost_price","cost_currency","barcode","weight_unit","dimensions_unit","backorder_limit","hs_code","country_of_origin","customs_description","deleted_at","created_at","updated_at","preorderable","tax_category_id","available_stock","reserved_quantity","total_on_hand","product_name","delivery_profile_id"],"x-typelizer":true},"WebhookDelivery":{"type":"object","properties":{"id":{"type":"string"},"event_name":{"type":"string"},"event_id":{"type":"string","nullable":true},"response_code":{"type":"number","nullable":true},"execution_time":{"type":"number","nullable":true},"error_type":{"type":"string","nullable":true},"request_errors":{"type":"string","nullable":true},"response_body":{"type":"string","nullable":true},"success":{"type":"boolean","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"delivered_at":{"type":"string","nullable":true},"payload":{"type":"object"},"webhook_endpoint_id":{"type":"string"},"webhook_endpoint_url":{"type":"string"}},"required":["id","event_name","event_id","response_code","execution_time","error_type","request_errors","response_body","success","created_at","updated_at","delivered_at","payload","webhook_endpoint_id","webhook_endpoint_url"],"x-typelizer":true},"WebhookEndpoint":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"url":{"type":"string"},"active":{"type":"boolean"},"subscriptions":{"type":"array","items":{"type":"string"}},"disabled_reason":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"disabled_at":{"type":"string","nullable":true},"secret_key":{"type":"string","nullable":true},"last_delivery_at":{"type":"string","nullable":true},"recent_delivery_count":{"type":"number"},"recent_failure_count":{"type":"number"},"total_delivery_count":{"type":"number"},"successful_delivery_count":{"type":"number"},"failed_delivery_count":{"type":"number"}},"required":["id","name","url","active","subscriptions","disabled_reason","created_at","updated_at","disabled_at","secret_key","last_delivery_at","recent_delivery_count","recent_failure_count","total_delivery_count","successful_delivery_count","failed_delivery_count"],"x-typelizer":true}}}}\ No newline at end of file+{"info":{"title":"Admin API","contact":{"name":"Spree Commerce","url":"https://spreecommerce.org","email":"[email protected]"},"description":"Spree Admin API v3 - Administrative API for managing products, orders, and store settings.\n\n## Authentication\n\nThe Admin API requires a secret API key passed in the `x-spree-api-key` header.\nSecret API keys can be generated in the Spree admin dashboard.\n\n## Response Format\n\nAll responses are JSON. List endpoints return paginated responses with `data` and `meta` keys.\nSingle resource endpoints return a flat JSON object.\n\n## Resource IDs\n\nEvery resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`,\n`variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths,\nrequest bodies, and Ransack filters all accept them directly.\n\n## Error Handling\n\nErrors return a consistent format:\n```json\n{\n \"error\": {\n \"code\": \"validation_error\",\n \"message\": \"Validation failed\",\n \"details\": { \"name\": [\"can't be blank\"] }\n }\n}\n```\n","version":"v3"},"paths":{"/api/v3/admin/auth/login":{"post":{"summary":"Login","tags":["Authentication"],"security":[{"api_key":[]}],"description":"Authenticates an admin user and returns a short-lived JWT access token.\nThe rotatable refresh token is set in an HttpOnly cookie — it is not\nincluded in the response body.\n\nThe `provider` field selects the authentication method. When omitted it\ndefaults to `email`, the built-in email/password login.\n\nTo authenticate against a third-party identity provider (Okta, Azure AD,\nGoogle Workspace SSO, a custom JWT issuer, SAML, etc.), send\n`{ \"provider\": \"<your_key>\", ... }` with the fields that provider\nrequires. The endpoint returns the same JWT regardless of which provider\nauthenticated the request. See\n[Custom API Authentication](https://spreecommerce.org/docs/developer/how-to/custom-api-authentication)\nfor the list of configured providers and their required fields.\n","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"login successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthResponse"}}}},"401":{"description":"invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"title":"EmailPasswordLogin","description":"Built-in email/password authentication (default when `provider` is omitted).","type":"object","properties":{"provider":{"type":"string","enum":["email"],"default":"email"},"email":{"type":"string","format":"email"},"password":{"type":"string"}},"required":["email","password"]},{"title":"ProviderLogin","description":"Provider-dispatched login. The `provider` key selects a configured\nauthentication provider; the remaining fields are forwarded to it.\nRequired fields depend on the provider — see\n[Custom API Authentication](https://spreecommerce.org/docs/developer/how-to/custom-api-authentication).\n","type":"object","properties":{"provider":{"type":"string","description":"Registered provider key (anything other than `email`).","not":{"enum":["email"]}}},"required":["provider"],"additionalProperties":true}]}}}}}},"/api/v3/admin/auth/refresh":{"post":{"summary":"Refresh token","tags":["Authentication"],"security":[{"api_key":[]}],"description":"Exchanges the HttpOnly refresh-token cookie for a new access JWT and a\nrotated refresh token cookie. No request body or Authorization header\nis required — the cookie alone authenticates the call.\n","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"refresh successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthResponse"}}}},"401":{"description":"missing or invalid refresh-token cookie","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/auth/logout":{"post":{"summary":"Logout","tags":["Authentication"],"security":[{"api_key":[]}],"description":"Revokes the refresh-token cookie, effectively logging the admin out.","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"logout successful"}}}},"/api/v3/admin/me":{"get":{"summary":"Get current admin user and permissions","tags":["Authentication"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the current admin user profile and a serialized list of permissions (CanCanCan rules). The SPA uses these to drive UI permission checks.","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"current admin user and permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeResponse"}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update the current admin profile","tags":["Authentication"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Self-service update of the signed-in admin's own profile, such as their admin UI display language (`selected_locale`).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"profile updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"selected_locale":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}}}}}}}},"/api/v3/admin/auth/password_resets":{"post":{"summary":"Request password reset","tags":["Authentication"],"security":[{"api_key":[]}],"description":"Requests a password reset email for an admin user. Always returns `202`\nwhether or not the email matches an account, to prevent enumeration.\n\n`redirect_url` is where the emailed link should point (the reset token\nis appended as a `token` query param). It must match one of the store's\nallowed origins — otherwise it is silently ignored and the server-side\ndefault is used. The email is delivered by Spree itself via the\n`admin_user.password_reset_requested` event; this event is never\nforwarded to webhook endpoints.\n","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"reset requested","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email"},"redirect_url":{"type":"string","description":"Must match an allowed origin of the store; ignored otherwise."}},"required":["email"]}}}}}},"/api/v3/admin/auth/password_resets/{id}":{"patch":{"summary":"Reset password","tags":["Authentication"],"security":[{"api_key":[]}],"description":"Consumes a password reset token (the `token` query param from the\nemailed link), sets the new password, and signs the admin in: the\nresponse carries a JWT access token and the rotatable refresh token is\nset in an HttpOnly cookie. The token is single-use — it invalidates as\nsoon as the password changes.\n","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The reset token from the emailed link","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"password reset","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthResponse"}}}},"422":{"description":"invalid or expired token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string"},"password_confirmation":{"type":"string"}},"required":["password","password_confirmation"]}}}}}},"/api/v3/admin/auth/setup":{"get":{"summary":"Check first-run setup availability","tags":["Authentication"],"description":"Reports whether first-run setup is still available — true only while\nthe installation has no admin user. Unauthenticated; the dashboard\nlogin page uses it to offer the setup screen.\n","responses":{"200":{"description":"setup status","content":{"application/json":{}}}}},"post":{"summary":"Complete first-run setup","tags":["Authentication"],"description":"Creates the first admin account and adopts the seeded store, authorized\nby the one-time setup token printed at install time (rotate it with\n`bin/rails spree:setup:token`). Issues a JWT access token and a\nrefresh-token cookie exactly like login. Returns 404 once any admin\nuser exists — the flow is closed permanently after setup.\n","parameters":[],"responses":{"200":{"description":"setup completed","content":{"application/json":{}}},"404":{"description":"setup not available","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["setup_token","email","password","country_code"],"properties":{"setup_token":{"type":"string","description":"One-time token from the install output."},"email":{"type":"string","format":"email"},"password":{"type":"string"},"password_confirmation":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"store_name":{"type":"string"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country the store sells from. Determines the default market, the warehouse, the delivery zones and the currency."},"locale":{"type":"string","description":"Storefront locale. Defaults to the country's own language."},"currency":{"type":"string","description":"ISO 4217 currency. Defaults to the country's own currency — pass one only when the store prices in something else."}}}}}}}},"/api/v3/admin/auth/setup/countries":{"get":{"summary":"List countries for first-run setup","tags":["Authentication"],"description":"Countries the store can be set up in, each with the currency and\nofficial languages derived from it. Unauthenticated, because the setup\nscreen runs before any credential exists. Returns 404 once any admin\nuser exists.\n","responses":{"200":{"description":"countries","content":{"application/json":{}}}}}},"/api/v3/admin/allowed_origins":{"get":{"summary":"List allowed origins","tags":["Allowed Origins"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the CORS allowlist for the current store. Each entry is a\nbare `scheme://host[:port]` permitted to call the admin API from a\nbrowser. Backs the `Rack::Cors` allowlist and the CSRF boundary of\nthe admin cookie session (see\n`docs/plans/5.5-admin-auth-cookie-refresh.md`).\n\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[origin_cont]","in":"query","required":false,"description":"Filter by origin (contains)","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-created_at`).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"allowed origins found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AllowedOrigin"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create an allowed origin","tags":["Allowed Origins"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Adds an origin to the admin CORS allowlist. The value must be a bare\n`scheme://host[:port]` (no path, query, or fragment) and use `http` or\n`https`.\n\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"allowed origin created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllowedOrigin"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"origin":{"type":"string"}},"required":["origin"]}}}}}},"/api/v3/admin/allowed_origins/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Allowed origin ID","schema":{"type":"string"}}],"get":{"summary":"Get an allowed origin","tags":["Allowed Origins"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single allowed origin by prefixed ID.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"allowed origin found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllowedOrigin"}}}},"404":{"description":"allowed origin not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update an allowed origin","tags":["Allowed Origins"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates an existing allowed origin.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"allowed origin updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllowedOrigin"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"origin":{"type":"string"}}}}}}},"delete":{"summary":"Delete an allowed origin","tags":["Allowed Origins"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes an origin from the admin CORS allowlist. After deletion the\nadmin SPA running at that origin will no longer be able to call the\nadmin API from a browser.\n\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"204":{"description":"allowed origin deleted"}}}},"/api/v3/admin/api_keys":{"get":{"summary":"List API keys","tags":["API Keys"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns publishable and secret API keys for the current store. Secret keys are listed by `token_prefix` only — the plaintext token is delivered exactly once on create.\n\n**Required scope:** `read_api_keys` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"API keys found","content":{"application/json":{}}}}},"post":{"summary":"Create an API key","tags":["API Keys"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a publishable or secret API key. The plaintext token is included in the response **once** for secret keys; publishable keys expose their token on every read since they are intended for client-side use.\n\n**Required scope:** `write_api_keys` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"secret key created — plaintext token returned once","content":{"application/json":{}}},"422":{"description":"validation error","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","key_type"],"properties":{"name":{"type":"string"},"key_type":{"type":"string","enum":["publishable","secret"]},"scopes":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/api_keys/{id}":{"get":{"summary":"Show an API key","tags":["API Keys"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_api_keys` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"API key found","content":{"application/json":{}}}}},"patch":{"summary":"Update an API key","tags":["API Keys"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Renames a key. `key_type` and `scopes` are fixed at creation — to change a key's authority, create a new key and revoke the old one.\n\n**Required scope:** `write_api_keys` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"API key renamed","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}}}}}},"delete":{"summary":"Delete an API key","tags":["API Keys"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_api_keys` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"API key deleted"}}}},"/api/v3/admin/api_keys/current":{"get":{"summary":"Describe the current API key","tags":["API Keys"],"security":[{"api_key":[]}],"description":"Returns the secret key that authenticated this request, including its live scopes. Useful to confirm a key's real, current authority. Only secret-key principals have a single key to describe.\n\n**Required scope:** none — any key can describe itself (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"current API key","content":{"application/json":{}}}}}},"/api/v3/admin/api_keys/{id}/revoke":{"patch":{"summary":"Revoke an API key","tags":["API Keys"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Marks the key revoked. Future requests using its token will fail; the row is preserved for audit.\n\n**Required scope:** `write_api_keys` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"API key revoked","content":{"application/json":{}}}}}},"/api/v3/admin/categories":{"get":{"summary":"List categories","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a paginated list of the store's categories (manual hierarchical taxons; rule-based collections are excluded).\n\n**Required scope:** `read_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., children, parent, ancestors).","schema":{"type":"string"}}],"responses":{"200":{"description":"categories found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}}}},"post":{"summary":"Create a category","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a category. Nests under the parent when parent_id is given, otherwise creates a top-level category.\n\n**Required scope:** `write_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"category created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"parent_id":{"type":"string","description":"Prefixed ID of the parent category"},"description":{"type":"string"},"permalink":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"meta_keywords":{"type":"string"}},"required":["name"]}}}}}},"/api/v3/admin/categories/{id}":{"get":{"summary":"Get a category","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single category by ID.\n\n**Required scope:** `read_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Category ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., children, parent, ancestors).","schema":{"type":"string"}}],"responses":{"200":{"description":"category found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}},"404":{"description":"category not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a category","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a category.\n\n**Required scope:** `write_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Category ID","schema":{"type":"string"}}],"responses":{"200":{"description":"category updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"parent_id":{"type":"string","description":"Prefixed ID of the parent category"},"description":{"type":"string"},"permalink":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"meta_keywords":{"type":"string"}}}}}}},"delete":{"summary":"Delete a category","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes a category and its descendants.\n\n**Required scope:** `write_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Category ID","schema":{"type":"string"}}],"responses":{"204":{"description":"category deleted"}}}},"/api/v3/admin/categories/{id}/reposition":{"patch":{"summary":"Reposition a category","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Moves a category to a new parent and/or index within the tree.\n\n**Required scope:** `write_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Category ID","schema":{"type":"string"}}],"responses":{"200":{"description":"category repositioned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"new_parent_id":{"type":"string","description":"Prefixed ID of the new parent (omit for top level)"},"new_position":{"type":"integer","description":"0-based index among the new parent's children"}},"required":["new_position"]}}}}}},"/api/v3/admin/categories/{category_id}/products":{"get":{"summary":"List category products","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Products classified under the category, ordered by their classification position.\n\n**Required scope:** `read_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"category_id","in":"path","required":true,"description":"Category ID","schema":{"type":"string"}}],"responses":{"200":{"description":"products found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}}}},"post":{"summary":"Add a product to a category","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Classifies a product under the category (appended to the end).\n\n**Required scope:** `write_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"category_id","in":"path","required":true,"description":"Category ID","schema":{"type":"string"}}],"responses":{"201":{"description":"product added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"product_id":{"type":"string"}},"required":["product_id"]}}}}}},"/api/v3/admin/categories/{category_id}/products/{id}":{"delete":{"summary":"Remove a product from a category","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes a product from the category's manual classification.\n\n**Required scope:** `write_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"category_id","in":"path","required":true,"description":"Category ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}}],"responses":{"204":{"description":"product removed"}}}},"/api/v3/admin/categories/{category_id}/products/{id}/reposition":{"patch":{"summary":"Reposition a category product","tags":["Categories"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Moves a product to a new index among the category's products.\n\n**Required scope:** `write_categories` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"category_id","in":"path","required":true,"description":"Category ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}}],"responses":{"204":{"description":"product repositioned"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"new_position":{"type":"integer","description":"0-based index among the category's products"}},"required":["new_position"]}}}}}},"/api/v3/admin/channels":{"get":{"summary":"List channels","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the channels configured for the current store.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"channels found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}}}},"post":{"summary":"Create a channel","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new channel on the current store. `code` is normalized to a\nURL-safe slug (`Point of Sale` → `point-of-sale`); when omitted it's\nderived from `name`.\n\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"channel created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"code":{"type":"string","description":"Slug — auto-derived from `name` when blank."},"active":{"type":"boolean","default":true},"default":{"type":"boolean","default":false},"preferred_order_routing_strategy":{"type":"string","nullable":true,"description":"Routing strategy class name. `null` inherits the store setting."},"preferred_storefront_access":{"type":"string","nullable":true,"enum":["public","prices_hidden","login_required"],"description":"Anonymous-visitor access posture. `null` inherits the store setting."},"preferred_guest_checkout":{"type":"boolean","nullable":true,"description":"Whether guests can check out without an account. `null` inherits the store setting."}}}}}}}},"/api/v3/admin/channels/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a channel","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"channel found","content":{"application/json":{}}}}},"patch":{"summary":"Update a channel","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"channel updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"code":{"type":"string"},"active":{"type":"boolean"},"default":{"type":"boolean"},"preferred_order_routing_strategy":{"type":"string","nullable":true,"description":"Routing strategy class name. `null` inherits the store setting."},"preferred_storefront_access":{"type":"string","nullable":true,"enum":["public","prices_hidden","login_required"],"description":"Anonymous-visitor access posture. `null` inherits the store setting."},"preferred_guest_checkout":{"type":"boolean","nullable":true,"description":"Whether guests can check out without an account. `null` inherits the store setting."}}}}}}},"delete":{"summary":"Delete a channel","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"channel deleted"}}}},"/api/v3/admin/channels/{id}/add_products":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"post":{"summary":"Publish products on a channel","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Publishes the listed products on this channel. Idempotent — re-publishing\nan already-published product updates its publication window. Products from\nsibling stores are silently dropped.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"products published","content":{"application/json":{"schema":{"type":"object","properties":{"product_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["product_ids"],"properties":{"product_ids":{"type":"array","items":{"type":"string"}},"published_at":{"type":"string","format":"date-time","nullable":true,"description":"When the publications go live. `null` means immediately."},"unpublished_at":{"type":"string","format":"date-time","nullable":true,"description":"When the publications come down. `null` means never."}}}}}}}},"/api/v3/admin/channels/{id}/remove_products":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"post":{"summary":"Unpublish products from a channel","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Unpublishes the listed products from this channel.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"products unpublished","content":{"application/json":{"schema":{"type":"object","properties":{"product_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["product_ids"],"properties":{"product_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/channels/{channel_id}/order_routing_rules":{"parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"List order routing rules for a channel","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the channel's routing rules in priority order. The rules engine walks them top-down; see the Order Routing guide.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"rules found","content":{"application/json":{}}}}},"post":{"summary":"Create an order routing rule on a channel","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Adds a rule to the channel's routing list. The `type` is the wire shorthand from `GET /order_routing_rules/types` (e.g. `preferred_location`). Omitting `position` appends the rule at the end of the list. Each rule kind can appear at most once per channel — a duplicate `type` is rejected with a validation error.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"rule created","content":{"application/json":{}}},"422":{"description":"unknown rule type","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"active":{"type":"boolean"},"position":{"type":"integer"},"preferences":{"type":"object","additionalProperties":true}},"required":["type"]}}}}}},"/api/v3/admin/channels/{channel_id}/order_routing_rules/{id}":{"parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"patch":{"summary":"Update an order routing rule","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a rule's `active` flag, `position` (the list reorders around it), or `preferences`. The rule kind cannot be changed — delete and re-create instead.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"rule updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"active":{"type":"boolean"},"position":{"type":"integer"},"preferences":{"type":"object","additionalProperties":true}}}}}}},"delete":{"summary":"Delete an order routing rule","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"rule deleted"}}}},"/api/v3/admin/order_routing_rules/types":{"get":{"summary":"List available order routing rule types","tags":["Channels"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Enumerates the registered rule kinds with their labels, descriptions and preference schemas — drives the \"Add rule\" picker in the admin dashboard. Plugins extend the list by registering `Spree::OrderRoutingRule` subclasses via `Spree.order_routing.rules`.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"types found","content":{"application/json":{}}}}}},"/api/v3/admin/custom_field_definitions":{"get":{"summary":"List custom field definitions","tags":["Custom Fields"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns all defined custom fields. Filter by `?q[resource_type_eq]=Spree::Product` to narrow to one parent type.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand. Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., key,label,field_type). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"definitions returned","content":{"application/json":{}}}}},"post":{"summary":"Create a custom field definition","tags":["Custom Fields"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"definition created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["key","field_type","resource_type"],"properties":{"namespace":{"type":"string","description":"Defaults to `custom`"},"key":{"type":"string"},"label":{"type":"string","description":"Human-readable name; defaults to titleized `key`"},"field_type":{"type":"string","description":"Custom field type identifier (one of the registered field-type class names)."},"resource_type":{"type":"string","description":"Owner class, e.g. `Spree::Product`"},"storefront_visible":{"type":"boolean","description":"When false, the definition is admin-only and never exposed in the Store API"},"searchable":{"type":"boolean","description":"When true, values are included in storefront product text search"},"sortable":{"type":"boolean","description":"When true, storefront product listings can sort by this field"}}}}}}}},"/api/v3/admin/custom_field_definitions/{id}":{"get":{"summary":"Show a custom field definition","tags":["Custom Fields"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand. Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., key,label,field_type). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"definition found","content":{"application/json":{}}}}},"patch":{"summary":"Update a custom field definition","tags":["Custom Fields"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"definition updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string"},"storefront_visible":{"type":"boolean"},"searchable":{"type":"boolean"},"sortable":{"type":"boolean"}}}}}}},"delete":{"summary":"Delete a custom field definition","tags":["Custom Fields"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes the definition and cascades to all custom field values referencing it.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"definition deleted"}}}},"/api/v3/admin/customer_groups":{"get":{"summary":"List customer groups","tags":["Customer Groups"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the customer groups configured for the current store. Groups\nsegment customers for targeted promotions (see the `customer_group`\npromotion rule) and reporting. The list endpoint never embeds the\nmember list — fetch a single group with `?expand=customers` if you\nneed them inline, or query `/admin/customers?customer_group_id_in=…`\nfor paginated membership.\n\n\n**Required scope:** `read_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[name_cont]","in":"query","required":false,"description":"Filter by name (contains)","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-created_at`).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"customer groups found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerGroup"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a customer group","tags":["Customer Groups"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a customer group in the current store. `customer_ids` is\noptional; when present, customers are attached at create time.\nPass prefixed IDs (e.g. `cus_…`) — the server decodes them\nautomatically.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"customer group created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerGroup"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true},"customer_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/customer_groups/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Customer group prefixed ID","schema":{"type":"string"}}],"get":{"summary":"Get a customer group","tags":["Customer Groups"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single customer group. Pass `?expand=customers` to embed\nthe full member list inline (recommended only for single-record\nreads — embed cost scales with membership size).\n\n\n**Required scope:** `read_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to embed. Supported: `customers`.","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"customer group with embedded customers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerGroup"}}}},"404":{"description":"customer group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a customer group","tags":["Customer Groups"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates name, description, or membership. `customer_ids` is a\nfull-set replacement — the server reconciles the membership to\nmatch the array, adding new IDs and removing ones not present.\nSend `customer_ids: []` to clear all members.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"customer group updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerGroup"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true},"customer_ids":{"type":"array","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete a customer group","tags":["Customer Groups"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes the group. Member users are not deleted; their `customer_group_users` rows are dropped.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"customer group deleted"}}}},"/api/v3/admin/customers/{customer_id}/addresses":{"get":{"summary":"List customer addresses","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the customer's saved addresses.\n\n**Required scope:** `read_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., country, state). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., first_name,last_name,address1,city). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"addresses found","content":{"application/json":{}}}}},"post":{"summary":"Create a customer address","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Adds a new address to the customer's address book. Pass `is_default_billing: true` or `is_default_shipping: true` to set as the default — the previous default loses its flag in the same transaction.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"address created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"country_code":{"type":"string","description":"ISO-2 country code (e.g. US)"},"state_code":{"type":"string","description":"State/province abbreviation (e.g. NY)"},"phone":{"type":"string"},"company":{"type":"string"},"label":{"type":"string"},"is_default_billing":{"type":"boolean"},"is_default_shipping":{"type":"boolean"}}}}}}}},"/api/v3/admin/customers/{customer_id}/addresses/{id}":{"patch":{"summary":"Update a customer address","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a customer address.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"address updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"city":{"type":"string"},"is_default_billing":{"type":"boolean"},"is_default_shipping":{"type":"boolean"}}}}}}},"delete":{"summary":"Delete a customer address","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes the address. If it was a default, the customer loses that default (no auto-promotion).\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"address deleted"}}}},"/api/v3/admin/customers/{customer_id}/credit_cards":{"get":{"summary":"List customer credit cards","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the customer's saved credit cards. Useful for off-session admin charges via `POST /admin/orders/:id/payments { source_id }`.\n\n**Required scope:** `read_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., payment_method). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., brand,last4,month,year). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"credit cards found","content":{"application/json":{}}}}}},"/api/v3/admin/customers/{customer_id}/credit_cards/{id}":{"get":{"summary":"Show a customer credit card","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a saved credit card by ID.\n\n**Required scope:** `read_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., payment_method). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., brand,last4,month,year). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"credit card found","content":{"application/json":{}}}}},"delete":{"summary":"Delete a customer credit card","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes a saved credit card.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"credit card deleted"}}}},"/api/v3/admin/customers/{customer_id}/store_credits":{"get":{"summary":"List customer store credits","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns store credits issued to the customer.\n\n**Required scope:** `read_store_credits` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., store, created_by). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., amount,amount_used,memo,currency). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"store credits found","content":{"application/json":{}}}}},"post":{"summary":"Issue a store credit to a customer","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"`created_by` is set automatically from the authenticated admin.\n\n**Required scope:** `write_store_credits` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"store credit created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"string"},"currency":{"type":"string"},"memo":{"type":"string"}}}}}}}},"/api/v3/admin/customers/{customer_id}/store_credits/{id}":{"patch":{"summary":"Update a store credit","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Update memo / amount. The amount can only be changed if `amount_used == 0`.\n\n**Required scope:** `write_store_credits` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"store credit updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"string"},"memo":{"type":"string"}}}}}}},"delete":{"summary":"Delete a store credit","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes an unused store credit (amount_used == 0). Returns 422 otherwise.\n\n**Required scope:** `write_store_credits` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"store credit deleted"}}}},"/api/v3/admin/customers":{"get":{"summary":"List customers","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a paginated list of customers. Supports Ransack search/filters.\n\n**Required scope:** `read_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"}},{"name":"q[search]","in":"query","required":false,"description":"Email + name full-text-ish search","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., addresses, store_credits). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., email,first_name,last_name). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"customers found","content":{"application/json":{}}}}},"post":{"summary":"Create a customer","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a customer. No welcome email is sent automatically.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"customer created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"phone":{"type":"string"},"accepts_email_marketing":{"type":"boolean"},"internal_note":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"metadata":{"type":"object"}}}}}}}},"/api/v3/admin/customers/{id}":{"get":{"summary":"Show a customer","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns full customer details including computed order stats (orders_count, total_spent, last_order_completed_at).\n\n**Required scope:** `read_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Customer ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations: addresses, orders, store_credits, default_billing_address, default_shipping_address","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., email,first_name,last_name). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"customer found","content":{"application/json":{}}}}},"patch":{"summary":"Update a customer","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates customer attributes. `tags` replaces the full set.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"customer updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"phone":{"type":"string"},"accepts_email_marketing":{"type":"boolean"},"internal_note":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"metadata":{"type":"object"}}}}}}},"delete":{"summary":"Delete a customer","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes a customer. Returns 422 if the customer has any orders.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"customer deleted"}}}},"/api/v3/admin/customers/bulk_add_to_groups":{"post":{"summary":"Bulk-add customers to groups","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Attaches each customer in `ids` to every group in `customer_group_ids`.\nIdempotent — customers already in a group are skipped server-side.\nGroups from sibling stores are silently ignored. Returns counts of\ncustomers and groups that were processed (post store-scoping).\n\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"customers added to groups","content":{"application/json":{"schema":{"type":"object","properties":{"customer_count":{"type":"integer"},"customer_group_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","customer_group_ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"customer_group_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/customers/bulk_remove_from_groups":{"post":{"summary":"Bulk-remove customers from groups","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Detaches each customer in `ids` from every group in `customer_group_ids`.\nNo-op for non-members. Groups from sibling stores are silently ignored.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"customers removed from groups","content":{"application/json":{"schema":{"type":"object","properties":{"customer_count":{"type":"integer"},"customer_group_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","customer_group_ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"customer_group_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/customers/bulk_add_tags":{"post":{"summary":"Bulk-add tags to customers","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Adds each tag name in `tags` to every customer in `ids`. Tags are\nupserted by name; re-adding an existing tag is a no-op.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"tags added","content":{"application/json":{"schema":{"type":"object","properties":{"customer_count":{"type":"integer"},"tag_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","tags"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/customers/bulk_remove_tags":{"post":{"summary":"Bulk-remove tags from customers","tags":["Customers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes each tag name in `tags` from every customer in `ids`. No-op\nfor customers that don't carry the tag.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"tags removed","content":{"application/json":{"schema":{"type":"object","properties":{"customer_count":{"type":"integer"},"tag_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","tags"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/exports":{"get":{"summary":"List exports","tags":["Exports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns CSV exports queued or completed for the current store. Polled by the admin SPA to detect when an export finishes (`done: true`).\n\n**Required scope:** the read scope of the exported resource — `read_products` for product exports, `read_customers` for customer exports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"exports found","content":{"application/json":{}}}}},"post":{"summary":"Create an export","tags":["Exports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Queues a CSV export. The `type` selects the dataset; `search_params` is an\noptional Ransack query (same shape used by the `q[...]` params on list endpoints)\nthat filters which records are exported. Pass `record_selection: \"all\"` to\nclear the filter server-side and export everything in scope.\n\nGeneration is asynchronous. Poll `GET /admin/exports/{id}` until `done` is `true`,\nthen redirect the browser to `download_url` to fetch the file.\n\n\n**Required scope:** the read scope of the exported resource — `read_products` for product exports, `read_customers` for customer exports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"export queued","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["products","orders","customers","product_translations","gift_cards","coupon_codes","newsletter_subscribers"]},"record_selection":{"type":"string","enum":["filtered","all"],"description":"Set to \"all\" to ignore search_params and export everything in scope."},"search_params":{"type":"object","description":"Ransack query hash. Same predicates accepted by the list endpoint.","additionalProperties":true},"results_url":{"type":"string","description":"Absolute URL of your admin exports view; the export-done email uses it as the download button target. Only honored when it matches one of the store's configured allowed origins."}}}}}}}},"/api/v3/admin/exports/{id}":{"get":{"summary":"Show an export","tags":["Exports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns export status. While `done` is `false`, the SPA continues polling.\n\n**Required scope:** the read scope of the exported resource — `read_products` for product exports, `read_customers` for customer exports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"export found","content":{"application/json":{}}}}},"delete":{"summary":"Delete an export","tags":["Exports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes the export and purges its attachment.\n\n**Required scope:** the read scope of the exported resource — `read_products` for product exports, `read_customers` for customer exports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"export deleted"}}}},"/api/v3/admin/exports/{id}/download":{"get":{"summary":"Download an export","tags":["Exports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Streams the exported CSV with `Content-Disposition: attachment`. Returns 422 with `code: export_not_ready` while `done` is still `false`. The endpoint is JWT/API-key protected, so SPA clients must fetch it (with `Authorization` header) and trigger the browser download via a Blob URL — a top-level navigation cannot carry the JWT.\n\n**Required scope:** the read scope of the exported resource — `read_products` for product exports, `read_customers` for customer exports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"CSV file","content":{"application/json":{},"text/csv":{"schema":{"type":"string","format":"binary"}}}}}}},"/api/v3/admin/orders/{order_id}/fulfillments":{"get":{"summary":"List fulfillments","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns all shipments for an order.\n\n**Required scope:** `read_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., inventory_units, stock_location, shipping_rates). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., number,status,tracking,cost). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"fulfillments found","content":{"application/json":{}}}}},"post":{"summary":"Create a fulfillment","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Manually creates a fulfillment on a completed order, bypassing order routing — for example to mirror a shipment handled by an external carrier or 3PL. Moves the requested line item quantities out of their current fulfillments; when `items` is omitted, every not-yet-shipped unit is moved. Pass `status: 'shipped'` to register an already-shipped fulfillment (fires shipped webhooks and freezes cost/carrier). When `delivery_method_id` is omitted, the fulfillment inherits the delivery method and cost of the source fulfillment(s) it fully drains — keeping the order total unchanged; partially drained splits get no carrier when shipped, and pending fulfillments are otherwise (re)priced by the standard rate engine, which selects the lowest-cost available rate. Pass `cost` to set an explicit shipping cost instead (e.g. the 3PL price) — note this changes the order total and payment state, and is guaranteed to persist only with `status: 'shipped'` (pending fulfillments are re-priced by the rate engine).\n\n**Required scope:** `write_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"201":{"description":"fulfillment created","content":{"application/json":{}}},"422":{"description":"order not completed","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["stock_location_id"],"properties":{"stock_location_id":{"type":"string","description":"Stock location the fulfillment ships from"},"tracking":{"type":"string","description":"Carrier tracking number, or a full https:// tracking link — a full URL is served back as tracking_url unchanged instead of being templated into the delivery method tracking URL"},"delivery_method_id":{"type":"string","description":"Delivery method (carrier) to attach as the selected rate. Defaults to the delivery method of the fully drained source fulfillment(s)"},"cost":{"type":"string","description":"Explicit shipping cost. Defaults to the summed cost of the fully drained source fulfillment(s), which keeps the order total unchanged; an explicit cost changes the order total and payment state. Guaranteed to persist only with status: 'shipped' — pending fulfillments are re-priced by the rate engine"},"status":{"type":"string","enum":["shipped"],"description":"Pass 'shipped' to register the fulfillment as already shipped"},"items":{"type":"array","description":"Line item quantities to fulfill. Omit to fulfill every not-yet-shipped unit.","items":{"type":"object","required":["item_id","quantity"],"properties":{"item_id":{"type":"string","description":"Line item ID"},"quantity":{"type":"integer"}}}},"metadata":{"type":"object","additionalProperties":true}}}}}}}},"/api/v3/admin/orders/{order_id}/fulfillments/{id}":{"get":{"summary":"Show a shipment","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns details of a specific shipment.\n\n**Required scope:** `read_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Fulfillment ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., inventory_units, stock_location, shipping_rates). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., number,status,tracking,cost). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"shipment found","content":{"application/json":{}}}}},"patch":{"summary":"Update a shipment","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a fulfillment (tracking, delivery rate).\n\n**Required scope:** `write_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Fulfillment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"shipment updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"tracking":{"type":"string","description":"Carrier tracking number, or a full https:// tracking link served back as tracking_url unchanged"},"selected_delivery_rate_id":{"type":"string","description":"Delivery rate ID (dr_...) to select"}}}}}}}},"/api/v3/admin/orders/{order_id}/fulfillments/{id}/fulfill":{"patch":{"summary":"Fulfill a fulfillment","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Marks a fulfillment as fulfilled.\n\n**Required scope:** `write_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Fulfillment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"fulfillment fulfilled","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{order_id}/fulfillments/{id}/purchase_label":{"patch":{"summary":"Buy the shipping label","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Buys the shipping label for a parcel that has not shipped yet — print it, pack the box, then mark the fulfillment fulfilled. Only delivery methods whose provider produces labels accept this.\n\n**Required scope:** `write_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Fulfillment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"label purchased","content":{"application/json":{}}},"422":{"description":"provider does not produce labels","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{order_id}/fulfillments/{id}/mark_delivered":{"patch":{"summary":"Mark a fulfillment delivered","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Records that the customer received the goods. Only a fulfilled shipment can be marked delivered.\n\n**Required scope:** `write_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Fulfillment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"fulfillment delivered","content":{"application/json":{}}},"422":{"description":"fulfillment has not shipped","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"delivered_at":{"type":"string","format":"date-time","description":"When the goods arrived. Defaults to now."},"notify_customer":{"type":"boolean","description":"Whether the customer gets a delivery notification. Defaults to true."}}}}}}}},"/api/v3/admin/orders/{order_id}/fulfillments/{id}/cancel":{"patch":{"summary":"Cancel a fulfillment","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Cancels a fulfillment.\n\n**Required scope:** `write_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Fulfillment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"fulfillment canceled","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{order_id}/fulfillments/{id}/resume":{"patch":{"summary":"Resume a fulfillment","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Resumes a canceled fulfillment.\n\n**Required scope:** `write_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Fulfillment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"fulfillment resumed","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{order_id}/fulfillments/{id}/split":{"patch":{"summary":"Split a fulfillment","tags":["Fulfillments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Transfers items from this shipment to a new shipment at a different stock location.\n\n**Required scope:** `write_fulfillments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Fulfillment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"fulfillment split","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["variant_id","quantity"],"properties":{"variant_id":{"type":"string","description":"Variant ID"},"quantity":{"type":"integer"},"stock_location_id":{"type":"string","description":"Target stock location ID"}}}}}}}},"/api/v3/admin/gift_card_batches":{"get":{"summary":"List gift card batches","tags":["Gift Cards"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the gift card batches issued by the current store. Each batch\ngroups the cards generated together for a campaign or bulk-issuance\n— the cards themselves live under `/admin/gift_cards` and reference\nthe batch via `gift_card_batch_id`.\n\n\n**Required scope:** `read_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Records per page","schema":{"type":"integer"}},{"name":"q[prefix_cont]","in":"query","required":false,"description":"Filter by prefix (contains)","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending.","schema":{"type":"string"}}],"responses":{"200":{"description":"gift card batches found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GiftCardBatch"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}}}},"post":{"summary":"Create a gift card batch","tags":["Gift Cards"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Issues a batch of gift cards in a single call. The server generates\n`codes_count` cards inline for small batches (configurable via\n`Spree.config.gift_card_batch_web_limit`, default 500) or enqueues\na background job for larger ones. Each card's code is the batch\n`prefix` followed by random hex.\n\n\n**Required scope:** `write_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"gift card batch created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCardBatch"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["prefix","amount","codes_count"],"properties":{"prefix":{"type":"string","description":"Lowercased and prepended to every generated code."},"amount":{"type":"string","description":"Decimal amount per card, greater than zero."},"currency":{"type":"string","description":"ISO 4217 currency code. Defaults to the store currency."},"codes_count":{"type":"integer","description":"Number of cards to generate. Capped at `gift_card_batch_limit`."},"expires_at":{"type":"string","nullable":true}}}}}}}},"/api/v3/admin/gift_card_batches/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Gift card batch prefixed ID","schema":{"type":"string"}}],"get":{"summary":"Get a gift card batch","tags":["Gift Cards"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single batch.\n\n**Required scope:** `read_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"gift card batch found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCardBatch"}}}},"404":{"description":"gift card batch not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/gift_cards":{"get":{"summary":"List gift cards","tags":["Gift Cards"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the gift cards issued by the current store. Filter by\n`q[code_cont]` for code search, `q[user_id_eq]` for cards issued\nto a specific customer, or `q[status_eq]` for status filtering.\n\n\n**Required scope:** `read_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[code_cont]","in":"query","required":false,"description":"Filter by gift card code (contains)","schema":{"type":"string"}},{"name":"q[status_eq]","in":"query","required":false,"description":"Filter by status (active, redeemed, partially_redeemed, canceled)","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-created_at`).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"gift cards found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GiftCard"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a gift card","tags":["Gift Cards"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Issues a gift card scoped to the current store. The code is\nauto-generated when omitted. `currency` defaults to the store's\nconfigured currency. Pass `user_id` (prefixed ID) to attach the\ncard to a specific customer.\n\n\n**Required scope:** `write_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"gift card created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCard"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["amount"],"properties":{"amount":{"type":"string","description":"Decimal amount, greater than zero."},"currency":{"type":"string","description":"ISO 4217 currency code. Defaults to the store currency."},"code":{"type":"string","description":"Optional caller-supplied code. Auto-generated when omitted."},"expires_at":{"type":"string","description":"ISO 8601 date.","nullable":true},"user_id":{"type":"string","description":"Optional customer prefixed ID.","nullable":true}}}}}}}},"/api/v3/admin/gift_cards/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Gift card prefixed ID","schema":{"type":"string"}}],"get":{"summary":"Get a gift card","tags":["Gift Cards"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single gift card.\n\n**Required scope:** `read_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"gift card found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCard"}}}},"404":{"description":"gift card not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a gift card","tags":["Gift Cards"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates an active gift card's editable attributes. Redeemed or\npartially-redeemed cards cannot be edited.\n\n\n**Required scope:** `write_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"gift card updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCard"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"string"},"expires_at":{"type":"string","nullable":true},"user_id":{"type":"string","nullable":true}}}}}}},"delete":{"summary":"Delete a gift card","tags":["Gift Cards"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes an unused gift card. Cards that have been redeemed or\npartially redeemed cannot be deleted and return 422.\n\n\n**Required scope:** `write_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"gift card deleted"},"422":{"description":"redeemed gift card cannot be deleted","content":{"application/json":{}}}}}},"/api/v3/admin/imports":{"get":{"summary":"List imports","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns CSV imports queued or completed for the current store.\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"imports found","content":{"application/json":{}}}}},"post":{"summary":"Create an import","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Queues a CSV import. Upload the file first via `POST /api/v3/admin/direct_uploads`\nand pass the returned `signed_id` as `attachment`. On success the import is in the\n`mapping` state and the response carries the mapping payload: `schema_fields`\n(the canonical columns for the type), `csv_headers`, a `sample_row`, and the\nauto-assigned `mappings`.\n\nAdjust mappings if needed, then call `PATCH /admin/imports/{id}/complete_mapping`\nto start processing. Poll `GET /admin/imports/{id}` while `status` is\n`completed_mapping`/`processing`; terminal statuses are `completed` and `failed`.\n\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"import created in mapping state","content":{"application/json":{}}},"422":{"description":"unknown import type","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type","attachment"],"properties":{"type":{"type":"string","enum":["products","customers","product_translations"]},"attachment":{"type":"string","description":"ActiveStorage signed blob id from POST /api/v3/admin/direct_uploads."},"preferred_delimiter":{"type":"string","enum":[",",";","|","\t"],"description":"CSV column separator. Defaults to a comma."},"results_url":{"type":"string","description":"Absolute URL of your admin imports view; the import-done email links back to it with `?import=<id>` appended. Only honored when it matches one of the store's configured allowed origins."}}}}}}}},"/api/v3/admin/imports/template":{"get":{"summary":"Download an import template","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a CSV header row for the given import type, including the custom field columns available for the model.\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":true,"description":"Registered import type, e.g. products.","schema":{"type":"string"}}],"responses":{"200":{"description":"CSV template","content":{"application/json":{},"text/csv":{"schema":{"type":"string","format":"binary"}}}}}}},"/api/v3/admin/imports/example":{"get":{"summary":"Download an example import file","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Redirects to a populated example CSV for the given import type — the same sample data `rake spree:load_sample_data` uses, pinned to the installed Spree version. Returns 404 for a type that ships no example file.\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":true,"description":"Registered import type, e.g. products.","schema":{"type":"string"}}],"responses":{"302":{"description":"Redirect to the example CSV"}}}},"/api/v3/admin/imports/{id}":{"get":{"summary":"Show an import","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns import status and row counters. The admin dashboard polls this endpoint while `status` is `completed_mapping` or `processing`; `rows_count`, `completed_rows_count` and `failed_rows_count` drive the progress bar. The mapping payload (`csv_headers`, `sample_row`) is only present while `status` is `mapping`.\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"import found","content":{"application/json":{}}}}},"delete":{"summary":"Delete an import","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes the import, its rows and the uploaded file. Returns 422 while the import is being processed.\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"import deleted"}}}},"/api/v3/admin/imports/{id}/download":{"get":{"summary":"Download the originally uploaded file","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Streams the CSV exactly as it was uploaded — the audit trail for what was imported. JWT/API-key protected; SPA clients fetch it with the Authorization header and trigger the browser download via a Blob URL.\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"CSV file","content":{"application/json":{},"text/csv":{"schema":{"type":"string","format":"binary"}}}}}}},"/api/v3/admin/imports/{id}/complete_mapping":{"patch":{"summary":"Complete mapping and start processing","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Applies the submitted column mappings, then starts row processing. Omit `mappings`\nto accept the auto-assigned ones from the create response. Returns 422 when a\nrequired schema field is left unmapped (`details.missing_required_fields`) or a\nfile column is assigned twice.\n\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"mapping completed, processing queued","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"mappings":{"type":"array","description":"Column assignments to apply before starting. `file_column: null` unmaps a field.","items":{"type":"object","required":["schema_field"],"properties":{"schema_field":{"type":"string"},"file_column":{"type":"string","nullable":true}}}}}}}}}}},"/api/v3/admin/imports/{id}/retry_failed_rows":{"patch":{"summary":"Retry failed rows","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Re-processes the rows that failed. The import re-enters `processing`; poll `GET /admin/imports/{id}` until it completes again. Returns 422 when the import is not `completed` or has no failed rows.\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"retry queued","content":{"application/json":{}}}}}},"/api/v3/admin/imports/{import_id}/rows":{"get":{"summary":"List import rows","tags":["Imports"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Paginated rows of an import — the failure report. Filter with `q[status_eq]=failed` to list only rows that could not be imported; each row carries the raw CSV `data` and its `validation_errors`.\n\n**Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"import_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"q[status_eq]","in":"query","required":false,"description":"Filter rows by status: pending, processing, completed, failed.","schema":{"type":"string"}}],"responses":{"200":{"description":"rows found","content":{"application/json":{}}}}}},"/api/v3/admin/markets":{"get":{"summary":"List markets","tags":["Markets"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the markets configured for the current store. Markets are\nstore-scoped and ordered by `position` (an `acts_as_list` column —\nupdate the order via `PATCH /markets/{id}` with `position`).\n\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"}},{"name":"q[name_cont]","in":"query","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to embed. Supported: `countries`.","schema":{"type":"string"}}],"responses":{"200":{"description":"markets found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Market"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}}}},"post":{"summary":"Create a market","tags":["Markets"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new market for the current store.\n\n- `country_codes` accepts 2-letter ISO country codes (e.g. `[\"DE\", \"FR\"]`);\n the market must contain at least one country. Unknown codes are\n silently dropped.\n- `supported_locales` accepts an array of locale codes; the\n `default_locale` is always implicitly included.\n- Setting `default: true` automatically demotes the previous default\n market in the store.\n\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"market created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Market"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"currency":{"type":"string","description":"ISO 4217 currency code."},"default_locale":{"type":"string","description":"IETF locale tag used as the market default."},"supported_locales":{"type":"array","items":{"type":"string"},"description":"Locale codes available in this market. The default is always implicitly included."},"tax_inclusive":{"type":"boolean","default":false,"description":"Display prices with tax included."},"default":{"type":"boolean","default":false,"description":"Setting to true demotes the previous default."},"position":{"type":"integer","description":"Sort order within the store; lower = first."},"country_codes":{"type":"array","items":{"type":"string"},"description":"2-letter ISO country codes assigned to this market. At least one is required."}},"required":["name","currency","default_locale","country_codes"]}}}}}},"/api/v3/admin/markets/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a market","tags":["Markets"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"market found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Market"}}}},"404":{"description":"market not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a market","tags":["Markets"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates an existing market. Pass `country_codes` to replace the\nmarket's country list (full-set update), `supported_locales` to\nreplace the supported locales, or `position` to reorder the market\nwithin the store.\n\nSetting `default: true` automatically demotes the previous default.\n\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"market updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Market"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"currency":{"type":"string"},"default_locale":{"type":"string"},"supported_locales":{"type":"array","items":{"type":"string"}},"tax_inclusive":{"type":"boolean"},"default":{"type":"boolean"},"position":{"type":"integer"},"country_codes":{"type":"array","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete a market","tags":["Markets"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes the market (sets `deleted_at`). The default market and\nthe last remaining market in a store cannot be deleted — both return\n422 with a `validation_error`.\n\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"market deleted"},"422":{"description":"cannot delete default or last market","content":{"application/json":{}}}}}},"/api/v3/admin/option_types":{"get":{"summary":"List option types","tags":["Option Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a paginated list of option types.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[name_cont]","in":"query","required":false,"description":"Filter by name (contains)","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., option_values). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., name,label,position). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"option types found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OptionType"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create an option type","tags":["Option Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new option type. Supports nested option values.\n\nOption values can be provided inline and will be created or updated by name.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"option type created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionType"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"position":{"type":"integer"},"filterable":{"type":"boolean"},"option_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"position":{"type":"integer"}}}}},"required":["name","label"]}}}}}},"/api/v3/admin/option_types/{id}":{"get":{"summary":"Get an option type","tags":["Option Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single option type by ID, including its option values.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Option type ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., option_values). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., name,label,position). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"option type found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionType"}}}},"404":{"description":"option type not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update an option type","tags":["Option Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates an option type. Supports updating nested option values.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Option type ID","schema":{"type":"string"}}],"responses":{"200":{"description":"option type updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionType"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"position":{"type":"integer"},"filterable":{"type":"boolean"},"option_values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Existing option value ID to update"},"name":{"type":"string"},"label":{"type":"string"},"position":{"type":"integer"}}}}}}}}}},"delete":{"summary":"Delete an option type","tags":["Option Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes an option type.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Option type ID","schema":{"type":"string"}}],"responses":{"204":{"description":"option type deleted"}}}},"/api/v3/admin/orders/{order_id}/tax_lines":{"get":{"summary":"List tax lines","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Typed tax rows on the order. Read-only — written exclusively by the tax provider.\n\n**Required scope:** `read_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order prefixed ID","schema":{"type":"string"}}],"responses":{"200":{"description":"tax lines found","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{order_id}/discounts":{"get":{"summary":"List discounts","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Typed discount rows (promotion-sourced and manual) on the order.\n\n**Required scope:** `read_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order prefixed ID","schema":{"type":"string"}}],"responses":{"200":{"description":"discounts found","content":{"application/json":{}}}}},"post":{"summary":"Create manual discount","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a manual discount. With line_item_id a single row is created; without it the amount is distributed across line items (largest remainder). This is the sanctioned post-placement discount path and works on completed orders.\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order prefixed ID","schema":{"type":"string"}}],"responses":{"201":{"description":"discount created","content":{"application/json":{}}},"422":{"description":"invalid discount","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"number"},"value_type":{"type":"string","enum":["flat","percent"]},"line_item_id":{"type":"string","nullable":true,"description":"Target line item; omit to distribute order-level"}},"required":["label","value"]}}}}}},"/api/v3/admin/orders/{order_id}/fees":{"post":{"summary":"Create fee","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a fee (surcharge, handling, gift wrap, COD, payment fee). Order-level when no target is given. Works on completed orders.\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order prefixed ID","schema":{"type":"string"}}],"responses":{"201":{"description":"fee created","content":{"application/json":{}}},"422":{"description":"invalid fee","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string"},"amount":{"type":"number"},"kind":{"type":"string","enum":["surcharge","handling","gift_wrap","cod","payment","duty"],"description":"Defaults to 'surcharge'"},"line_item_id":{"type":"string","nullable":true},"fulfillment_id":{"type":"string","nullable":true}},"required":["label","amount"]}}}}}},"/api/v3/admin/orders/{order_id}/gift_cards":{"post":{"summary":"Apply a gift card to an order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Applies a gift card by code to the order. Returns the gift card.\n\n**Required scope:** `write_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"201":{"description":"gift card applied","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"Gift card code"}}}}}}}},"/api/v3/admin/orders/{order_id}/gift_cards/{id}":{"delete":{"summary":"Remove a gift card from an order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes the gift card from the order.\n\n**Required scope:** `write_gift_cards` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Gift card ID","schema":{"type":"string"}}],"responses":{"204":{"description":"gift card removed"}}}},"/api/v3/admin/orders/{order_id}/items":{"get":{"summary":"List order items","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns all line items for an order.\n\n**Required scope:** `read_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., variant, variant.product). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., quantity,price,total). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"items found","content":{"application/json":{}}}}},"post":{"summary":"Add an item","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Adds a new line item to the order.\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"201":{"description":"item added","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["variant_id"],"properties":{"variant_id":{"type":"string","description":"Prefixed variant ID"},"quantity":{"type":"integer","default":1}}}}}}}},"/api/v3/admin/orders/{order_id}/items/{id}":{"get":{"summary":"Show an item","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns details of a specific line item.\n\n**Required scope:** `read_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Item ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., variant, variant.product). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., quantity,price,total). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"item found","content":{"application/json":{}}}}},"patch":{"summary":"Update an item","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates an order item quantity or metadata.\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Item ID","schema":{"type":"string"}}],"responses":{"200":{"description":"item updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"quantity":{"type":"integer"}}}}}}},"delete":{"summary":"Remove an item","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes an item from the order.\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Item ID","schema":{"type":"string"}}],"responses":{"204":{"description":"line item removed"}}}},"/api/v3/admin/orders/{order_id}/store_credits":{"post":{"summary":"Apply customer's store credit to an order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Applies the order customer's available store credit. When `amount` is omitted, applies up to the order outstanding balance.\n\n**Required scope:** `write_store_credits` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"201":{"description":"store credit applied","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"string","description":"Optional explicit amount; defaults to order outstanding balance"}}}}}}},"delete":{"summary":"Remove store credit from an order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes any applied store credit from the order.\n\n**Required scope:** `write_store_credits` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"204":{"description":"store credit removed"}}}},"/api/v3/admin/orders":{"get":{"summary":"List orders","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a paginated list of orders for the current store.\n\n**Required scope:** `read_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"sort","in":"query","required":false,"description":"Sort field (e.g., created_at, -created_at, completed_at)","schema":{"type":"string"}},{"name":"q[state_eq]","in":"query","required":false,"description":"Filter by state (cart, address, delivery, payment, confirm, complete, canceled)","schema":{"type":"string"}},{"name":"q[email_cont]","in":"query","required":false,"description":"Filter by email (contains)","schema":{"type":"string"}},{"name":"q[number_eq]","in":"query","required":false,"description":"Filter by order number","schema":{"type":"string"}},{"name":"q[completed_at_gt]","in":"query","required":false,"description":"Filter by completed after date","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., items, fulfillments, payments, customer, discounts, billing_address, shipping_address). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., number,total,status,completed_at). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"orders found","content":{"application/json":{}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a draft order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new draft order in one shot. Customer, items, addresses, currency,\nmarket, channel, locale, notes, metadata, and a coupon code can all be\nprovided inline.\n\nSetting `preferred_stock_location_id` pins the order's preferred fulfillment\nlocation — Order Routing's built-in `PreferredLocation` rule consumes it\nwhen picking which stock location ships each shipment.\n\nInvalid coupon codes are non-fatal — the order is created and the failure\nis reported on the service result (not in the API response body for now).\n\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"order created with preferred_stock_location_id","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"customer_id":{"type":"string","description":"Customer ID. Alias: user_id (legacy)."},"use_customer_default_address":{"type":"boolean","description":"When true with customer_id, copies the customer's saved billing/shipping addresses onto the order."},"currency":{"type":"string"},"market_id":{"type":"string","description":"Market ID"},"channel_id":{"type":"string","description":"Channel ID. Defaults to the store primary channel when omitted."},"preferred_stock_location_id":{"type":"string","description":"Stock Location ID to prefer for fulfillment. Order Routing's built-in PreferredLocation rule reads this and ranks the location first; routing falls back to the next rule when the preferred location can't cover the cart."},"locale":{"type":"string"},"customer_note":{"type":"string","description":"Public, customer-visible note"},"internal_note":{"type":"string","description":"Staff-only note"},"metadata":{"type":"object","description":"Arbitrary key/value metadata"},"shipping_address":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"address1":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"country_code":{"type":"string"},"state_code":{"type":"string"},"phone":{"type":"string"}}},"shipping_address_id":{"type":"string","description":"Existing customer address ID"},"billing_address":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"address1":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"country_code":{"type":"string"},"state_code":{"type":"string"},"phone":{"type":"string"}}},"billing_address_id":{"type":"string","description":"Existing customer address ID"},"items":{"type":"array","items":{"type":"object","required":["variant_id","quantity"],"properties":{"variant_id":{"type":"string","description":"Variant ID"},"quantity":{"type":"integer"},"metadata":{"type":"object"}}}},"coupon_code":{"type":"string","description":"Optional. Applied non-fatally; invalid codes do not block creation."}}}}}}}},"/api/v3/admin/orders/{id}":{"get":{"summary":"Show an order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns full order details including admin-only fields.\n\n**Required scope:** `read_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Order ID (e.g., or_xxx)","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., items, fulfillments, payments, customer, discounts, billing_address, shipping_address). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., number,total,status,completed_at). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"order found","content":{"application/json":{}}},"404":{"description":"order not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update an order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates an order. Supports updating email, addresses, special instructions, and line items.\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"200":{"description":"order updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"customer_note":{"type":"string"},"internal_note":{"type":"string"},"channel_id":{"type":"string","description":"Channel ID"},"preferred_stock_location_id":{"type":"string","description":"Stock Location ID to prefer for fulfillment. Re-runs Order Routing's PreferredLocation rule on subsequent shipment rebuilds."},"ship_address":{"type":"object","properties":{"firstname":{"type":"string"},"lastname":{"type":"string"},"address1":{"type":"string"},"city":{"type":"string"},"zipcode":{"type":"string"},"country_code":{"type":"string"},"state_code":{"type":"string"},"phone":{"type":"string"}}},"bill_address":{"type":"object","properties":{"firstname":{"type":"string"},"lastname":{"type":"string"},"address1":{"type":"string"},"city":{"type":"string"},"zipcode":{"type":"string"},"country_code":{"type":"string"},"state_code":{"type":"string"},"phone":{"type":"string"}}},"items":{"type":"array","items":{"type":"object","required":["variant_id"],"properties":{"variant_id":{"type":"string","description":"Variant ID"},"quantity":{"type":"integer"},"metadata":{"type":"object"}}}}}}}}}},"delete":{"summary":"Delete a draft order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes a draft order. Completed orders cannot be deleted.\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"204":{"description":"order deleted"}}}},"/api/v3/admin/orders/{id}/complete":{"patch":{"summary":"Complete an order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Completes an order in the `confirm` state, marking it as placed.\n\nSet `notify_customer: true` to send the order confirmation email.\n\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"200":{"description":"order completed","content":{"application/json":{}}},"422":{"description":"order cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"notify_customer":{"type":"boolean","description":"Send the order confirmation email after completion."}}}}}}}},"/api/v3/admin/orders/{id}/cancel":{"patch":{"summary":"Cancel an order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Cancels a completed order.\n\nSet `notify_customer: true` to send the order cancellation email.\n\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"200":{"description":"order canceled","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"notify_customer":{"type":"boolean","description":"Send the order cancellation email after canceling."}}}}}}}},"/api/v3/admin/orders/{id}/approve":{"patch":{"summary":"Approve an order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Approves an order (e.g., for fraud review).\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"200":{"description":"order approved","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{id}/resume":{"patch":{"summary":"Resume a canceled order","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Resumes a previously canceled order.\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"200":{"description":"order resumed","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{id}/resend_confirmation":{"post":{"summary":"Resend confirmation email","tags":["Orders"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Publishes the order.completed event to trigger confirmation email delivery.\n\n**Required scope:** `write_orders` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"200":{"description":"confirmation resent","content":{"application/json":{}}}}}},"/api/v3/admin/payment_methods":{"get":{"summary":"List payment methods","tags":["Payment Methods"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the store's configured payment methods. Use `source_required: true` to know which methods need a saved source.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand. Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., name,type,active). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"payment methods found","content":{"application/json":{}}}}}},"/api/v3/admin/payment_methods/types":{"get":{"summary":"List available payment provider types","tags":["Payment Methods"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the registered Spree::PaymentMethod subclasses that can be used to create new payment methods. Useful for populating a \"Provider\" dropdown in admin UIs.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"provider types found","content":{"application/json":{}}}}}},"/api/v3/admin/payment_methods/{id}":{"get":{"summary":"Show a payment method","tags":["Payment Methods"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a payment method by ID.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand. Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., name,type,active). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"payment method found","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{order_id}/payments":{"get":{"summary":"List payments","tags":["Payments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns all payments for an order.\n\n**Required scope:** `read_payments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., payment_method, source). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., amount,status,number,response_code). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"payments found","content":{"application/json":{}}}}},"post":{"summary":"Create a payment","tags":["Payments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new payment for the order.\n\n**Required scope:** `write_payments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"201":{"description":"payment created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["payment_method_id"],"properties":{"payment_method_id":{"type":"string","description":"Payment method ID"},"amount":{"type":"string"},"source_id":{"type":"string","description":"Payment source ID"}}}}}}}},"/api/v3/admin/orders/{order_id}/payments/{id}":{"get":{"summary":"Show a payment","tags":["Payments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns details of a specific payment.\n\n**Required scope:** `read_payments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Payment ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., payment_method, source). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., amount,status,number,response_code). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"payment found","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{order_id}/payments/{id}/capture":{"patch":{"summary":"Capture a payment","tags":["Payments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Captures a pending payment.\n\n**Required scope:** `write_payments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Payment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"payment captured","content":{"application/json":{}}},"422":{"description":"capture failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/orders/{order_id}/payments/{id}/void":{"patch":{"summary":"Void a payment","tags":["Payments"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Voids a payment.\n\n**Required scope:** `write_payments` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Payment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"payment voided","content":{"application/json":{}}}}}},"/api/v3/admin/price_lists":{"get":{"summary":"List price lists","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the price lists configured for the current store.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"}},{"name":"q[name_cont]","in":"query","required":false,"schema":{"type":"string"}},{"name":"q[status_eq]","in":"query","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to embed. Supported: `price_rules`.","schema":{"type":"string"}}],"responses":{"200":{"description":"price lists found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PriceList"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}}}},"post":{"summary":"Create a price list","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new draft price list.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"price list created (server-to-server — rules + prices, no product_ids)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceList"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true},"starts_at":{"type":"string","nullable":true},"ends_at":{"type":"string","nullable":true},"match_policy":{"type":"string","enum":["all","any"]},"position":{"type":"integer"},"product_ids":{"type":"array","items":{"type":"string"},"description":"Prefixed product ids to seed the list with."},"rules":{"type":"array","description":"STI-typed price rules to attach on create. Existing rules on the same payload via PATCH reconcile by id.","items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true}}}},"prices":{"type":"array","description":"Server-to-server alternative to `product_ids`: ship the exact per-variant prices the list should contain. Each row upserts on the unique key `(variant_id, currency, price_list_id)`. Mix-and-match with `product_ids` is supported but typically unnecessary — `prices` alone tells the server which variants belong to the list and what the override amount is.","items":{"type":"object","required":["variant_id","currency"],"properties":{"variant_id":{"type":"string"},"currency":{"type":"string"},"amount":{"type":"string","nullable":true},"compare_at_amount":{"type":"string","nullable":true}}}}}}}}}}},"/api/v3/admin/price_lists/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a price list","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"price list found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceList"}}}},"404":{"description":"price list not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a price list","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a price list. The optional `rules:` array reconciles nested\nSTI-typed price rules in a single round-trip — existing rules update\nby `id`, new rules build, missing rules destroy. Mirrors the\npromotion editor's \"save the whole thing on Save\" pattern.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"price list updated with nested rules","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceList"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true},"starts_at":{"type":"string","nullable":true},"ends_at":{"type":"string","nullable":true},"match_policy":{"type":"string","enum":["all","any"]},"position":{"type":"integer"},"product_ids":{"type":"array","items":{"type":"string"},"description":"Prefixed product ids — reconciles list membership (adds + removes)."},"rules":{"type":"array","items":{"type":"object","required":["type"],"properties":{"id":{"type":"string","nullable":true},"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true}}}},"prices":{"type":"array","description":"Individual price overrides (the spreadsheet payload). Each row updates by `id` if shipped, otherwise upserts on the unique key `(variant_id, currency, price_list_id)`.","items":{"type":"object","oneOf":[{"required":["id"]},{"required":["variant_id","currency"]}],"properties":{"id":{"type":"string"},"variant_id":{"type":"string"},"currency":{"type":"string"},"amount":{"type":"string","nullable":true},"compare_at_amount":{"type":"string","nullable":true}}}}}}}}}},"delete":{"summary":"Delete a price list","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes the price list. Associated prices are removed asynchronously.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"price list deleted"}}}},"/api/v3/admin/price_lists/{id}/activate":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"patch":{"summary":"Activate a price list","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Transitions a draft / inactive list to `active`. If `starts_at` is\nin the future the list is marked `scheduled` instead, matching the\nlegacy admin behaviour.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"price list activated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceList"}}}}}}},"/api/v3/admin/price_lists/{id}/deactivate":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"patch":{"summary":"Deactivate a price list","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"price list deactivated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceList"}}}}}}},"/api/v3/admin/prices":{"get":{"summary":"List prices","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Generic prices endpoint covering both base prices and price-list\noverrides. Filter with Ransack: `q[price_list_id_eq]=…`,\n`q[currency_eq]=USD`, `q[price_list_id_null]=true` (base prices only).\n\nThe admin spreadsheet uses this with server-side pagination so it\nscales past the metadata-PATCH path on `/price_lists/:id`.\n\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"}},{"name":"q[price_list_id_eq]","in":"query","required":false,"schema":{"type":"string"}},{"name":"q[price_list_id_null]","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"q[currency_eq]","in":"query","required":false,"schema":{"type":"string"}},{"name":"q[variant_id_eq]","in":"query","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Comma-separated sort keys. Supports e.g. `variant_product_name,variant_id`.","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to embed. Supported: `variant`.","schema":{"type":"string"}}],"responses":{"200":{"description":"prices found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Price"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}}}},"post":{"summary":"Create a price","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a single price. Omit `price_list_id` to create a base price.\nFor more than a handful of rows, prefer `POST /admin/prices/bulk_upsert`.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"price created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Price"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["variant_id","currency"],"properties":{"variant_id":{"type":"string"},"currency":{"type":"string"},"amount":{"type":"string","nullable":true},"compare_at_amount":{"type":"string","nullable":true},"price_list_id":{"type":"string","nullable":true}}}}}}}},"/api/v3/admin/prices/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a price","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"price found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Price"}}}},"404":{"description":"price not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a price","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"price updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Price"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"string","nullable":true},"compare_at_amount":{"type":"string","nullable":true}}}}}}},"delete":{"summary":"Delete a price","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes the price (acts_as_paranoid).\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"price deleted"}}}},"/api/v3/admin/prices/bulk_upsert":{"post":{"summary":"Bulk-upsert prices","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Upserts a batch of prices in a single SQL round trip.\n\nEach row either:\n* targets an existing price by `id`, OR\n* matches on the unique key `(variant_id, currency, price_list_id)` —\n updating the existing row if one exists, creating one otherwise.\n\nModel callbacks (e.g. PriceHistory) are bypassed; this is a\nbulk-write fast path for the admin spreadsheet. The response\ncarries `price_count` — the number of rows touched.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"prices upserted","content":{"application/json":{"schema":{"type":"object","properties":{"price_count":{"type":"integer"}}}}}},"422":{"description":"missing prices key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["prices"],"properties":{"prices":{"type":"array","items":{"type":"object","required":["variant_id","currency"],"properties":{"id":{"type":"string","nullable":true},"variant_id":{"type":"string"},"currency":{"type":"string"},"price_list_id":{"type":"string","nullable":true},"amount":{"type":"string","nullable":true},"compare_at_amount":{"type":"string","nullable":true}}}}}}}}}}},"/api/v3/admin/prices/bulk_destroy":{"delete":{"summary":"Bulk-delete prices","tags":["Pricing"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes each price in `ids`. Returns the count actually destroyed.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"prices deleted","content":{"application/json":{"schema":{"type":"object","properties":{"price_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/products/{product_id}/custom_fields":{"get":{"summary":"List product custom fields","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the product's custom field values.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., custom_field_definition). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., key,value,namespace). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"custom fields found","content":{"application/json":{}}}}},"post":{"summary":"Create a product custom field","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Sets a custom field value on the product. Requires an existing CustomFieldDefinition; pass its prefixed `cfdef_…` id.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"custom field created","content":{"application/json":{}}},"422":{"description":"duplicate definition for the same product","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["custom_field_definition_id","value"],"properties":{"custom_field_definition_id":{"type":"string","description":"Prefixed `cfdef_…` id"},"value":{"description":"Value matching the definition's `field_type`"}}}}}}}},"/api/v3/admin/products/{product_id}/custom_fields/{id}":{"get":{"summary":"Show a product custom field","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., custom_field_definition). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., key,value,namespace). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"custom field found","content":{"application/json":{}}}}},"patch":{"summary":"Update a product custom field","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates the custom field's `value`. The linked definition cannot be changed — delete and recreate to switch.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"custom field updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["value"],"properties":{"value":{"description":"New value"}}}}}}},"delete":{"summary":"Delete a product custom field","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"custom field deleted"}}}},"/api/v3/admin/products/{product_id}/translations":{"get":{"summary":"List product translations","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the full translation matrix for the product: the source value and content type per translatable field, plus the translated value for every supported locale.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"translations found","content":{"application/json":{}}}}}},"/api/v3/admin/products":{"get":{"summary":"List products","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a paginated list of products for the current store.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"sort","in":"query","required":false,"description":"Sort field (e.g., name, -name, price, -price, best_selling)","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., variants, media, option_types, categories). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., name,slug,price,status). id is always included.","schema":{"type":"string"}},{"name":"q[name_cont]","in":"query","required":false,"description":"Filter by name (contains)","schema":{"type":"string"}},{"name":"q[status_eq]","in":"query","required":false,"description":"Filter by status","schema":{"type":"string"}}],"responses":{"200":{"description":"products found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a product","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new product. Supports nested variants with prices and option types.\n\nOption types and values are auto-created if they don't exist.\nPrices are upserted by currency. Stock items are upserted by stock location.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"product created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"slug":{"type":"string"},"status":{"type":"string","enum":["draft","active","archived"]},"tax_category_id":{"type":"string","description":"Tax category ID"},"category_ids":{"type":"array","items":{"type":"string"},"description":"Array of category IDs"},"tags":{"type":"array","items":{"type":"string"}},"prices":{"type":"array","description":"Shorthand for a simple (no-options) product: per-currency prices that forward to the product's sole variant. For products with options, set prices per variant under `variants:` instead.","items":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"string"},"amount":{"type":"string"},"compare_at_amount":{"type":"string","nullable":true}}}},"variants":{"type":"array","description":"Array of variant payloads. Variants can declare multiple option pairs via `options:` and per-currency prices via `prices:`. Stock counts go in `stock_levels:` (per stock location).","items":{"type":"object","properties":{"sku":{"type":"string"},"options":{"type":"array","description":"One pair per option type the variant participates in (e.g. size + color). Option types and values are auto-created if missing.","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"prices":{"type":"array","description":"Per-currency prices. Upserted by currency.","items":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"string"},"amount":{"type":"string"},"compare_at_amount":{"type":"string","nullable":true}}}},"stock_levels":{"type":"array","description":"Per-stock-location inventory. Upserted by stock_location_id.","items":{"type":"object","required":["stock_location_id","count_on_hand"],"properties":{"stock_location_id":{"type":"string","description":"Stock location ID (e.g. sloc_xxx)"},"count_on_hand":{"type":"integer"},"backorderable":{"type":"boolean"}}}}}}}},"required":["name"]}}}}}},"/api/v3/admin/products/{id}":{"get":{"summary":"Get a product","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single product by ID.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Product ID (e.g., prod_xxx)","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., variants, media, option_types, categories). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., name,slug,price,status). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"product found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"404":{"description":"product not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a product","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a product. Only provided fields are updated.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}}],"responses":{"200":{"description":"product updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"slug":{"type":"string"},"status":{"type":"string","enum":["draft","active","archived"]},"tax_category_id":{"type":"string","description":"Tax category ID"},"category_ids":{"type":"array","items":{"type":"string"},"description":"Array of category IDs"},"tags":{"type":"array","items":{"type":"string"}},"prices":{"type":"array","description":"Shorthand for a simple (no-options) product: per-currency prices that forward to the product's sole variant. For products with options, set prices per variant under `variants:` instead.","items":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"string"},"amount":{"type":"string"},"compare_at_amount":{"type":"string","nullable":true}}}},"variants":{"type":"array","description":"Array of variant payloads. Variants can declare multiple option pairs via `options:` and per-currency prices via `prices:`. Stock counts go in `stock_levels:` (per stock location).","items":{"type":"object","properties":{"sku":{"type":"string"},"options":{"type":"array","description":"One pair per option type the variant participates in (e.g. size + color). Option types and values are auto-created if missing.","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"prices":{"type":"array","description":"Per-currency prices. Upserted by currency.","items":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"string"},"amount":{"type":"string"},"compare_at_amount":{"type":"string","nullable":true}}}},"stock_levels":{"type":"array","description":"Per-stock-location inventory. Upserted by stock_location_id.","items":{"type":"object","required":["stock_location_id","count_on_hand"],"properties":{"stock_location_id":{"type":"string","description":"Stock location ID (e.g. sloc_xxx)"},"count_on_hand":{"type":"integer"},"backorderable":{"type":"boolean"}}}}}}}}}}}}},"delete":{"summary":"Delete a product","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes a product.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}}],"responses":{"204":{"description":"product deleted"},"422":{"description":"deletion refused by a store rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/products/bulk_status_update":{"post":{"summary":"Bulk-update product status","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Sets `status` on each product in `ids`. Reindexes the affected products\nfor search. Cross-store IDs are silently dropped. Returns counts.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"cross-store products silently dropped","content":{"application/json":{"schema":{"type":"object","properties":{"product_count":{"type":"integer"},"status":{"type":"string"}}}}}},"422":{"description":"invalid status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","status"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"status":{"type":"string","enum":["draft","active","archived"]}}}}}}}},"/api/v3/admin/products/bulk_add_to_categories":{"post":{"summary":"Bulk-add products to categories","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Attaches each product in `ids` to every category (category) in `category_ids`.\nCategories from sibling stores are silently ignored.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"products added to categories","content":{"application/json":{"schema":{"type":"object","properties":{"product_count":{"type":"integer"},"category_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","category_ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"category_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/products/bulk_remove_from_categories":{"post":{"summary":"Bulk-remove products from categories","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Detaches each product in `ids` from every category in `category_ids`.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"products removed from categories","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","category_ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"category_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/products/bulk_add_to_collections":{"post":{"summary":"Bulk-add products to collections","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Attaches each product in `ids` to every manual collection in `collection_ids`.\nAutomatic (rule-based) and sibling-store collections are silently ignored.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"products added to collections","content":{"application/json":{"schema":{"type":"object","properties":{"product_count":{"type":"integer"},"collection_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","collection_ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"collection_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/products/bulk_remove_from_collections":{"post":{"summary":"Bulk-remove products from collections","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Detaches each product in `ids` from every collection in `collection_ids`.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"products removed from collections","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","collection_ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"collection_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/products/bulk_add_to_channels":{"post":{"summary":"Bulk-add products to channels","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Publishes each product in `ids` on every channel in `channel_ids`. Idempotent —\nre-publishing on an existing channel is a no-op. Channels from sibling stores\nare silently ignored.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"products published on channels","content":{"application/json":{"schema":{"type":"object","properties":{"product_count":{"type":"integer"},"channel_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","channel_ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"channel_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/products/bulk_remove_from_channels":{"post":{"summary":"Bulk-remove products from channels","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Unpublishes each product in `ids` from every channel in `channel_ids`.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"products unpublished from channels","content":{"application/json":{"schema":{"type":"object","properties":{"product_count":{"type":"integer"},"channel_count":{"type":"integer"},"removed":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","channel_ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"channel_ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/products/bulk_add_tags":{"post":{"summary":"Bulk-add tags to products","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Adds each tag name in `tags` to every product in `ids`. Tags are upserted by name.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"tags added","content":{"application/json":{"schema":{"type":"object","properties":{"product_count":{"type":"integer"},"tag_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","tags"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/products/bulk_remove_tags":{"post":{"summary":"Bulk-remove tags from products","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes each tag in `tags` from every product in `ids`.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"tags removed","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids","tags"],"properties":{"ids":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/products/bulk_destroy":{"delete":{"summary":"Bulk-delete products","tags":["Products"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes each product in `ids`. Returns the count actually destroyed.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"products deleted","content":{"application/json":{"schema":{"type":"object","properties":{"product_count":{"type":"integer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/promotions/{promotion_id}/coupon_codes":{"parameters":[{"name":"promotion_id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"List coupon codes for a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the auto-generated coupon codes for a multi-code promotion. Single-code promotions store the code on the promotion itself; this endpoint returns an empty list for them.\n\n**Required scope:** `read_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"coupon codes found","content":{"application/json":{}}}}}},"/api/v3/admin/promotions/{promotion_id}/promotion_actions":{"parameters":[{"name":"promotion_id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"List actions for a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"actions found","content":{"application/json":{}}}}},"post":{"summary":"Create an action on a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Adds a new action to a promotion. The `type` is the wire shorthand from `GET /promotion_actions/types` (e.g. `free_shipping`, `create_item_adjustments`). Fully-qualified Ruby class names are also accepted for backward compatibility.\n\n**Required scope:** `write_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"action created","content":{"application/json":{}}},"422":{"description":"unknown action type","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true}},"required":["type"]}}}}}},"/api/v3/admin/promotions/{promotion_id}/promotion_actions/{id}":{"parameters":[{"name":"promotion_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"delete":{"summary":"Delete an action from a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"action deleted"}}}},"/api/v3/admin/promotions/{promotion_id}/promotion_rules":{"parameters":[{"name":"promotion_id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"List rules for a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"rules found","content":{"application/json":{}}}}},"post":{"summary":"Create a rule on a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Adds a new rule to a promotion. The `type` is the wire shorthand from `GET /promotion_rules/types` (e.g. `currency`, `item_total`, `product`). Fully-qualified Ruby class names are also accepted for backward compatibility.\n\n**Required scope:** `write_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"rule created with preferences","content":{"application/json":{}}},"422":{"description":"unknown rule type","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true}},"required":["type"]}}}}}},"/api/v3/admin/promotions/{promotion_id}/promotion_rules/{id}":{"parameters":[{"name":"promotion_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"patch":{"summary":"Update a rule's preferences","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"rule updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"preferences":{"type":"object","additionalProperties":true}}}}}}},"delete":{"summary":"Delete a rule from a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"rule deleted"}}}},"/api/v3/admin/promotions":{"get":{"summary":"List promotions","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the store's promotions, including manual coupon and automatic promotions.\n\n**Required scope:** `read_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"promotions found","content":{"application/json":{}}}}},"post":{"summary":"Create a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new promotion. `code` is required for single-code coupon promotions;\npass `multi_codes: true` with `number_of_codes` to auto-generate a batch.\n\nRules and actions can be created in the same request by passing arrays of\n`{ type, preferences, ... }` rows. The server reconciles to the desired set:\nnew rows are built, existing rows (by `id`) are updated, omitted rows are removed.\n\n\n**Required scope:** `write_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"promotion created with rules and actions","content":{"application/json":{}}},"422":{"description":"invalid params","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"starts_at":{"type":"string","format":"date-time","nullable":true},"expires_at":{"type":"string","format":"date-time","nullable":true},"usage_limit":{"type":"integer","nullable":true},"match_policy":{"type":"string","enum":["all","any"]},"kind":{"type":"string","enum":["coupon_code","automatic"]},"multi_codes":{"type":"boolean"},"number_of_codes":{"type":"integer","nullable":true},"code_prefix":{"type":"string","nullable":true},"promotion_category_id":{"type":"string","nullable":true},"rules":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true},"product_ids":{"type":"array","items":{"type":"string"}},"category_ids":{"type":"array","items":{"type":"string"}},"customer_ids":{"type":"array","items":{"type":"string"}}},"required":["type"]}},"actions":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true},"calculator":{"type":"object","properties":{"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true}}}},"required":["type"]}}},"required":["name"]}}}}}},"/api/v3/admin/promotions/{id}":{"get":{"summary":"Show a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"promotion found","content":{"application/json":{}}}}},"patch":{"summary":"Update a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a promotion. The `rules` and `actions` arrays are treated as\na *desired set* — rows with `id` update in place, rows without `id` are\nbuilt fresh, and any existing row not present in the array is destroyed.\nPass `rules: []` or `actions: []` to clear them.\n\n\n**Required scope:** `write_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"rules and actions cleared with empty arrays","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"starts_at":{"type":"string","format":"date-time","nullable":true},"expires_at":{"type":"string","format":"date-time","nullable":true},"usage_limit":{"type":"integer","nullable":true},"match_policy":{"type":"string","enum":["all","any"]},"kind":{"type":"string","enum":["coupon_code","automatic"]},"promotion_category_id":{"type":"string","nullable":true},"rules":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"description":"Pass to update an existing rule; omit to build a new one"},"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true},"product_ids":{"type":"array","items":{"type":"string"}},"category_ids":{"type":"array","items":{"type":"string"}},"customer_ids":{"type":"array","items":{"type":"string"}}},"required":["type"]}},"actions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true},"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true},"calculator":{"type":"object","properties":{"type":{"type":"string"},"preferences":{"type":"object","additionalProperties":true}}}},"required":["type"]}}}}}}}},"delete":{"summary":"Delete a promotion","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"promotion deleted"}}}},"/api/v3/admin/promotion_actions/types":{"get":{"summary":"List available promotion action types","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the registered Spree::PromotionAction subclasses with their preference schemas. Used by admin UIs to populate the \"Add action\" picker and render generic preference forms.\n\n**Required scope:** `read_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"action types found","content":{"application/json":{}}}}}},"/api/v3/admin/promotion_rules/types":{"get":{"summary":"List available promotion rule types","tags":["Promotions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the registered Spree::PromotionRule subclasses with their preference schemas.\n\n**Required scope:** `read_promotions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"rule types found","content":{"application/json":{}}}}}},"/api/v3/admin/orders/{order_id}/refunds":{"get":{"summary":"List refunds","tags":["Refunds"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns all refunds for an order.\n\n**Required scope:** `read_refunds` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., payment, refund_reason). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., amount,reason,transaction_id). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"refunds found","content":{"application/json":{}}}}},"post":{"summary":"Create a refund","tags":["Refunds"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a refund for a payment on the order. The refund is automatically processed via the payment gateway.\n\n**Required scope:** `write_refunds` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"description":"Order ID","schema":{"type":"string"}}],"responses":{"201":{"description":"refund created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["payment_id","amount"],"properties":{"payment_id":{"type":"string","description":"Payment ID"},"amount":{"type":"string"},"refund_reason_id":{"type":"string","description":"Refund reason ID"}}}}}}}},"/api/v3/admin/locales":{"get":{"summary":"List supported locales","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the locales a merchant can translate content into for the current store, with the default and right-to-left flags.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"locales found","content":{"application/json":{}}}}}},"/api/v3/admin/store":{"get":{"summary":"Get the current store","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the current store configuration. The store is resolved from the request context (host or admin selection); there is no `id` parameter.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"current store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update the current store","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates the current store configuration.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"store updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"preferred_admin_locale":{"type":"string"},"preferred_timezone":{"type":"string"},"preferred_weight_unit":{"type":"string"},"preferred_unit_system":{"type":"string"}}}}}}}},"/api/v3/admin/tags":{"get":{"summary":"List tags","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns tag names for a given taggable type. Used for autocomplete in tag inputs on products, orders, and customers.","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"taggable_type","in":"query","required":true,"description":"Taggable type (`Spree::Product`, `Spree::Order`, or `Spree::User`)","schema":{"type":"string"}},{"name":"q","in":"query","required":false,"description":"Optional case-insensitive substring filter","schema":{"type":"string"}}],"responses":{"200":{"description":"tags found","content":{"application/json":{}}},"422":{"description":"invalid taggable type","content":{"application/json":{}}}}}},"/api/v3/admin/tax_rates":{"get":{"summary":"List tax rates","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the store's tax rates. Rates are the entire configuration of\nthe built-in tax provider: each pairs a tax category with a jurisdiction\n(a country, optionally narrowed to one state) and a percentage, and\ndecides whether the tax is already included in the product price\n(VAT-style) or added on top (US-style).\n\nMarkets using an external tax provider ignore these rows — that\nprovider carries its own jurisdiction data.\n\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[name_cont]","in":"query","required":false,"description":"Filter by name (contains)","schema":{"type":"string"}},{"name":"q[included_in_price_true]","in":"query","required":false,"description":"Only rates included in the product price","schema":{"type":"boolean"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-created_at`).","schema":{"type":"string"}}],"responses":{"200":{"description":"tax rates found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TaxRate"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a tax rate","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a tax rate for the current store. Give either `amount` as a\ndecimal (`0.19`) or `amount_percentage` as a percentage (`19`).\n\nName the jurisdiction with `country_code` (and `state_code` for a\nstate-level rate). Omitting the country makes the rate apply everywhere.\n\nSet `included_in_price` for VAT-style pricing, where the rate is backed\nout of the displayed price rather than added to it.\n\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"tax rate created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRate"}}}},"422":{"description":"validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Customer-facing rate name, e.g. \"VAT\""},"amount":{"type":"string","description":"Rate as a decimal, e.g. \"0.19\""},"amount_percentage":{"type":"number","description":"Rate as a percentage, e.g. 19"},"included_in_price":{"type":"boolean"},"show_rate_in_label":{"type":"boolean"},"tax_category_id":{"type":"string"},"country_code":{"type":"string","description":"ISO code, e.g. \"DE\". Omit for every country."},"state_code":{"type":"string","description":"State abbreviation within that country, e.g. \"CA\"."}},"required":["name","tax_category_id"]}}},"required":true}}},"/api/v3/admin/tax_rates/{id}":{"parameters":[{"name":"id","in":"path","description":"Tax rate ID","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a tax rate","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"tax rate found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRate"}}}}}},"patch":{"summary":"Update a tax rate","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"tax rate updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRate"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"amount":{"type":"string"},"amount_percentage":{"type":"number"},"included_in_price":{"type":"boolean"},"show_rate_in_label":{"type":"boolean"},"tax_category_id":{"type":"string"},"country_code":{"type":"string"},"state_code":{"type":"string"}}}}},"required":true}},"delete":{"summary":"Delete a tax rate","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes the rate. Tax lines it already produced keep their own rate snapshot.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"204":{"description":"tax rate deleted"}}}},"/api/v3/admin/translatable_resources":{"get":{"summary":"List translatable resources","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns every translatable resource type and its translatable fields (key + content type), so clients can render translation editors generically.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"translatable resources found","content":{"application/json":{}}}}}},"/api/v3/admin/translations/batch":{"post":{"summary":"Batch upsert translations","tags":["Settings"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Atomically upserts translations across many records of (possibly) different translatable resource types in one request — e.g. an option type and all its option values in one save. A flat list of independent registry writes; all entries succeed or none do.\n\n**Required scope:** `write_<resource>` for every resource type in the batch (for API-key authentication) (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"translations upserted","content":{"application/json":{}}},"422":{"description":"unsupported locale rolls back the whole batch","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["translations"],"properties":{"translations":{"type":"array","items":{"type":"object","required":["resource_type","resource_id","values"],"properties":{"resource_type":{"type":"string","description":"Translatable resource type token, e.g. `option_type`"},"resource_id":{"type":"string","description":"Prefixed id of the record"},"values":{"type":"object","description":"Map of locale code to { field: value }","additionalProperties":{"type":"object","additionalProperties":true}}}}}}}}}}}},"/api/v3/admin/admin_users":{"get":{"summary":"List staff","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns admin users with at least one role assignment on the current store.\n\n**Required scope:** `read_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"staff found","content":{"application/json":{}}}}}},"/api/v3/admin/admin_users/{id}":{"get":{"summary":"Show a staff member","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"staff member found","content":{"application/json":{}}}}},"patch":{"summary":"Update a staff member","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates name fields and reassigns roles for the current store. `role_ids` is a complete replacement — roles not in the array are removed for this store.\n\n**Required scope:** `write_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"staff member updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"role_ids":{"type":"array","items":{"type":"string"}}}}}}}},"delete":{"summary":"Remove a staff member from this store","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes the user's role assignments on the current store. The account is preserved — the user keeps access to any other stores.\n\n**Required scope:** `write_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"staff removed from store"}}}},"/api/v3/admin/invitations":{"get":{"summary":"List invitations","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns invitations for the current store, including pending and accepted.\n\n**Required scope:** `read_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"invitations found","content":{"application/json":{}}}}},"post":{"summary":"Create an invitation","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Invites a teammate by email. The invitation is scoped to the current store and carries the chosen role; on accept, a `RoleUser` is created via the invitation's `after_accept` callback.\n\n**Required scope:** `write_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"invitation created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email","role_id"],"properties":{"email":{"type":"string"},"role_id":{"type":"string"}}}}}}}},"/api/v3/admin/invitations/{id}":{"delete":{"summary":"Revoke an invitation","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"invitation revoked"}}}},"/api/v3/admin/invitations/{id}/resend":{"patch":{"summary":"Resend an invitation","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Issues a fresh token and dispatches the invitation email again.\n\n**Required scope:** `write_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"invitation resent","content":{"application/json":{}}}}}},"/api/v3/admin/permissions":{"get":{"summary":"List the permission catalog","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the permission catalog — the grant vocabulary shared by staff role permissions and secret API key scopes. Entries are grouped for permission pickers; labels and descriptions are localized. Readable by any authenticated admin credential.","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"catalog returned","content":{"application/json":{}}}}}},"/api/v3/admin/roles":{"get":{"summary":"List roles","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns staff roles with their catalog permissions. Roles are global, not per-store; `mutable: false` marks the protected admin role and host-locked rows.\n\n**Required scope:** `read_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"roles found","content":{"application/json":{}}}}},"post":{"summary":"Create a role","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a staff role. `permissions` holds catalog keys (see GET /admin/permissions); a caller may only grant keys they effectively hold.\n\n**Required scope:** `write_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"role created","content":{"application/json":{}}},"422":{"description":"invalid request","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true},"permissions":{"type":"array","items":{"type":"string"}}},"required":["name"]}}}}}},"/api/v3/admin/roles/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"patch":{"summary":"Update a role","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a role name, description or permissions. The admin role and host-locked roles (`mutable: false`) reject changes.\n\n**Required scope:** `write_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"role updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true},"permissions":{"type":"array","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete a role","tags":["Staff"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes a role. Fails with 422 while the role is protected or still referenced by staff members or pending invitations.\n\n**Required scope:** `write_staff` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"role deleted"},"422":{"description":"role cannot be deleted","content":{"application/json":{}}}}}},"/api/v3/admin/stock_locations":{"get":{"summary":"List stock locations","tags":["Stock Locations"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the configured stock locations. Stock locations are global\n(shared across stores). Filter with Ransack predicates such as\n`q[active_eq]`, `q[kind_eq]`, `q[pickup_enabled_eq]`, or\n`q[name_cont]`.\n\nPickup-related attributes (`kind`, `pickup_enabled`,\n`pickup_stock_policy`, `pickup_ready_in_minutes`,\n`pickup_instructions`) drive merchant pickup support at checkout —\ncustomers can collect orders from any active location with\n`pickup_enabled: true`.\n\n\n**Required scope:** `read_stock` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[name_cont]","in":"query","required":false,"description":"Filter by name (contains)","schema":{"type":"string"}},{"name":"q[active_eq]","in":"query","required":false,"description":"Filter by active status","schema":{"type":"boolean"}},{"name":"q[kind_eq]","in":"query","required":false,"description":"Filter by kind (built-in: 'warehouse', 'store', 'fulfillment_center')","schema":{"type":"string"}},{"name":"q[pickup_enabled_eq]","in":"query","required":false,"description":"Filter by pickup-enabled flag","schema":{"type":"boolean"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-created_at`).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"stock locations found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/StockLocation"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a stock location","tags":["Stock Locations"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new stock location.\n\nSetting `default: true` automatically demotes the previous default\nlocation.\n\n\n**Required scope:** `write_stock` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"stock location created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockLocation"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"admin_name":{"type":"string","nullable":true,"description":"Internal name shown only in the admin"},"active":{"type":"boolean"},"default":{"type":"boolean","description":"Setting to true demotes the previous default."},"kind":{"type":"string","enum":["warehouse","store","fulfillment_center"],"description":"Categorizes the location."},"propagate_all_variants":{"type":"boolean"},"backorderable_default":{"type":"boolean"},"address1":{"type":"string","nullable":true},"address2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"zipcode":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"country_code":{"type":"string","nullable":true,"description":"ISO-3166 alpha-2 country code (e.g. \"US\")."},"state_code":{"type":"string","nullable":true,"description":"State / province abbreviation (e.g. \"NY\"). Resolved against the selected country."},"state_name":{"type":"string","nullable":true,"description":"Free-text state for countries without a states list."},"pickup_enabled":{"type":"boolean"},"pickup_stock_policy":{"type":"string","enum":["local","any"],"description":"'local' = items at this location only; 'any' = transfer-eligible (ship-to-store)."},"pickup_ready_in_minutes":{"type":"number","nullable":true,"minimum":0},"pickup_instructions":{"type":"string","nullable":true}},"required":["name"]}}}}}},"/api/v3/admin/stock_locations/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Stock location ID","schema":{"type":"string"}}],"get":{"summary":"Get a stock location","tags":["Stock Locations"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single stock location by prefixed ID.\n\n**Required scope:** `read_stock` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"stock location found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockLocation"}}}},"404":{"description":"stock location not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a stock location","tags":["Stock Locations"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates an existing stock location. Same address-field conventions as\nthe create endpoint.\n\nSetting `default: true` automatically demotes the previous default.\n\n\n**Required scope:** `write_stock` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"stock location updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockLocation"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"admin_name":{"type":"string","nullable":true},"active":{"type":"boolean"},"default":{"type":"boolean"},"kind":{"type":"string","enum":["warehouse","store","fulfillment_center"]},"propagate_all_variants":{"type":"boolean"},"backorderable_default":{"type":"boolean"},"address1":{"type":"string","nullable":true},"address2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"zipcode":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"country_code":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true},"state_name":{"type":"string","nullable":true},"pickup_enabled":{"type":"boolean"},"pickup_stock_policy":{"type":"string","enum":["local","any"]},"pickup_ready_in_minutes":{"type":"number","nullable":true,"minimum":0},"pickup_instructions":{"type":"string","nullable":true}}}}}}},"delete":{"summary":"Delete a stock location","tags":["Stock Locations"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes the stock location (sets `deleted_at`). Existing\nfulfillments that referenced it keep the historical record via\n`Spree::StockLocation.with_deleted`.\n\n\n**Required scope:** `write_stock` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"204":{"description":"stock location deleted"}}}},"/api/v3/admin/products/{product_id}/variants":{"get":{"summary":"List product variants","tags":["Variants"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a paginated list of variants for a product, including the default variant.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., images, prices, stock_levels, option_values). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., sku,price,stock). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"variants found","content":{"application/json":{}}}}},"post":{"summary":"Create a variant","tags":["Variants"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new variant for a product. Supports nested prices and stock items.\n\nOption types and values are auto-created if they don't exist.\nPrices are upserted by currency. Stock items are upserted by stock location.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}}],"responses":{"201":{"description":"variant created","content":{"application/json":{}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"cost_price":{"type":"string"},"cost_currency":{"type":"string"},"weight":{"type":"number"},"height":{"type":"number"},"width":{"type":"number"},"depth":{"type":"number"},"weight_unit":{"type":"string"},"dimensions_unit":{"type":"string"},"track_inventory":{"type":"boolean"},"tax_category_id":{"type":"string"},"options":{"type":"array","description":"A variant on a product with option types should declare its option pairs (e.g. size + color) — one per option type it participates in. Option types and values are auto-created if missing.","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"position":{"type":"integer"},"barcode":{"type":"string"},"prices":{"type":"array","description":"Per-currency prices. Upserted by currency.","items":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"string"},"amount":{"type":"string"},"compare_at_amount":{"type":"string","nullable":true}}}},"stock_levels":{"type":"array","description":"Per-stock-location inventory. Upserted by stock_location_id.","items":{"type":"object","required":["stock_location_id","count_on_hand"],"properties":{"stock_location_id":{"type":"string","description":"Stock location ID (e.g. sloc_xxx)"},"count_on_hand":{"type":"integer"},"backorderable":{"type":"boolean"}}}}}}}}}}},"/api/v3/admin/products/{product_id}/variants/{id}":{"get":{"summary":"Get a variant","tags":["Variants"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single variant by ID.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Variant ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., images, prices, stock_levels, option_values). Use dot notation for nested expand (max 4 levels).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include (e.g., sku,price,stock). id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"variant found","content":{"application/json":{}}},"404":{"description":"variant not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a variant","tags":["Variants"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a variant. Only provided fields are updated.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Variant ID","schema":{"type":"string"}}],"responses":{"200":{"description":"variant updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"cost_price":{"type":"string"},"cost_currency":{"type":"string"},"weight":{"type":"number"},"height":{"type":"number"},"width":{"type":"number"},"depth":{"type":"number"},"weight_unit":{"type":"string"},"dimensions_unit":{"type":"string"},"track_inventory":{"type":"boolean"},"tax_category_id":{"type":"string"},"options":{"type":"array","description":"One pair per option type the variant participates in (e.g. size + color). Option types and values are auto-created if missing.","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"position":{"type":"integer"},"barcode":{"type":"string"},"prices":{"type":"array","description":"Per-currency prices. Upserted by currency.","items":{"type":"object","required":["currency","amount"],"properties":{"currency":{"type":"string"},"amount":{"type":"string"},"compare_at_amount":{"type":"string","nullable":true}}}},"stock_levels":{"type":"array","description":"Per-stock-location inventory. Upserted by stock_location_id.","items":{"type":"object","required":["stock_location_id","count_on_hand"],"properties":{"stock_location_id":{"type":"string","description":"Stock location ID (e.g. sloc_xxx)"},"count_on_hand":{"type":"integer"},"backorderable":{"type":"boolean"}}}}}}}}}},"delete":{"summary":"Delete a variant","tags":["Variants"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes a variant.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"product_id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Variant ID","schema":{"type":"string"}}],"responses":{"204":{"description":"variant deleted"}}}},"/api/v3/admin/webhook_endpoints/{webhook_endpoint_id}/deliveries":{"parameters":[{"name":"webhook_endpoint_id","in":"path","required":true,"description":"Parent webhook endpoint ID","schema":{"type":"string"}}],"get":{"summary":"List webhook deliveries","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns delivery attempts for the given endpoint, most recent first.\nEach row carries the original request payload, the response code\n(when the receiver replied), the execution time, and any transport\nerror — everything needed to audit failures and decide whether to\nredeliver.\n\n\n**Required scope:** `read_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[event_name_eq]","in":"query","required":false,"description":"Filter by event name (exact)","schema":{"type":"string"}},{"name":"q[success_eq]","in":"query","required":false,"description":"Filter by success flag","schema":{"type":"boolean"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-delivered_at`).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"deliveries found","content":{"application/json":{}}},"404":{"description":"parent webhook endpoint not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/webhook_endpoints/{webhook_endpoint_id}/deliveries/{id}":{"parameters":[{"name":"webhook_endpoint_id","in":"path","required":true,"description":"Parent webhook endpoint ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Webhook delivery ID","schema":{"type":"string"}}],"get":{"summary":"Get a webhook delivery","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single delivery attempt with the full request payload and\nthe response body the receiver returned. Use this for ad-hoc debug\nof failed deliveries.\n\n\n**Required scope:** `read_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"delivery found","content":{"application/json":{}}},"404":{"description":"delivery not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/webhook_endpoints/{webhook_endpoint_id}/deliveries/{id}/redeliver":{"parameters":[{"name":"webhook_endpoint_id","in":"path","required":true,"description":"Parent webhook endpoint ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Webhook delivery ID to redeliver","schema":{"type":"string"}}],"post":{"summary":"Redeliver a webhook delivery","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new delivery row with the same payload + event_name and\nqueues it. The original row is preserved for audit history.\n\n\n**Required scope:** `write_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"redelivery queued","content":{"application/json":{}}}}}},"/api/v3/admin/webhook_endpoints":{"get":{"summary":"List webhook endpoints","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns outbound webhook subscriptions for the current store. Each\nendpoint receives a signed POST when any subscribed event fires.\n`secret_key` is `null` on list reads — the plaintext is delivered\nexactly once on create.\n\n\n**Required scope:** `read_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[name_cont]","in":"query","required":false,"description":"Filter by name (contains)","schema":{"type":"string"}},{"name":"q[url_cont]","in":"query","required":false,"description":"Filter by URL (contains)","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-created_at`).","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"webhook endpoints found","content":{"application/json":{}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a webhook endpoint","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a new outbound webhook subscription. The plaintext\n`secret_key` is returned **once** in this response — persist it\nimmediately to verify incoming webhook signatures. Subsequent reads\nreturn `null` for the secret. Pass an empty `subscriptions` array or\nomit it to receive every event.\n\n\n**Required scope:** `write_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"webhook endpoint created — secret_key returned once","content":{"application/json":{}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"name":{"type":"string"},"url":{"type":"string"},"active":{"type":"boolean"},"subscriptions":{"type":"array","items":{"type":"string"}}}}}}}}},"/api/v3/admin/webhook_endpoints/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Webhook endpoint ID","schema":{"type":"string"}}],"get":{"summary":"Get a webhook endpoint","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single webhook endpoint by prefixed ID.\n\n**Required scope:** `read_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"webhook endpoint found","content":{"application/json":{}}},"404":{"description":"webhook endpoint not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a webhook endpoint","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates name, URL, active flag, or the event subscription list.\nToggling `active` here is equivalent to calling `disable`/`enable`\nwithout an audit reason.\n\n\n**Required scope:** `write_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"webhook endpoint updated","content":{"application/json":{}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"},"active":{"type":"boolean"},"subscriptions":{"type":"array","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete a webhook endpoint","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes the endpoint and stops future deliveries.\n\n**Required scope:** `write_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"204":{"description":"webhook endpoint deleted"}}}},"/api/v3/admin/webhook_endpoints/{id}/send_test":{"parameters":[{"name":"id","in":"path","required":true,"description":"Webhook endpoint ID","schema":{"type":"string"}}],"post":{"summary":"Send a test delivery","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a `webhook.test` delivery record and queues it. Use this to\nverify the endpoint is reachable and your signature verification\naccepts Spree's payloads.\n\n\n**Required scope:** `write_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"test delivery queued","content":{"application/json":{}}}}}},"/api/v3/admin/webhook_endpoints/{id}/enable":{"parameters":[{"name":"id","in":"path","required":true,"description":"Webhook endpoint ID","schema":{"type":"string"}}],"patch":{"summary":"Re-enable a webhook endpoint","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Re-enables an endpoint that was manually or automatically disabled.\n\n**Required scope:** `write_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"webhook endpoint enabled","content":{"application/json":{}}}}}},"/api/v3/admin/webhook_endpoints/{id}/disable":{"parameters":[{"name":"id","in":"path","required":true,"description":"Webhook endpoint ID","schema":{"type":"string"}}],"patch":{"summary":"Disable a webhook endpoint","tags":["Webhooks"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Manually pauses an endpoint. Unlike auto-disable (triggered after\nrepeated delivery failures), no notification email is sent.\n\n\n**Required scope:** `write_webhooks` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"webhook endpoint disabled","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string"}}}}}}}},"/api/v3/admin/collections":{"get":{"summary":"List collections","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a paginated list of the store's collections.\n\n**Required scope:** `read_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., rules, custom_fields, translations).","schema":{"type":"string"}}],"responses":{"200":{"description":"collections found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Collection"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}}}},"post":{"summary":"Create a collection","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a manual or automatic (rule-based) collection. For automatic collections, send the full desired rule set under `rules`.\n\n**Required scope:** `write_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"collection created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collection"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"automatic":{"type":"boolean"},"rules_match_policy":{"type":"string","enum":["all","any"]},"sort_order":{"type":"string"},"permalink":{"type":"string"},"description":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"meta_keywords":{"type":"string"},"rules":{"type":"array","description":"Full desired rule set. Entries with an id update, id-less entries create, omitted rules are removed.","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"},"match_policy":{"type":"string"}}}}},"required":["name"]}}}}}},"/api/v3/admin/collections/{id}":{"get":{"summary":"Get a collection","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single collection by ID, including its rules.\n\n**Required scope:** `read_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Collection ID","schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to expand (e.g., rules, custom_fields, translations).","schema":{"type":"string"}}],"responses":{"200":{"description":"collection found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collection"}}}},"404":{"description":"collection not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a collection","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a collection. Send `position` to reorder it within the flat list; send the full `rules` set to sync automatic rules.\n\n**Required scope:** `write_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Collection ID","schema":{"type":"string"}}],"responses":{"200":{"description":"collection updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collection"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"permalink":{"type":"string"},"description":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"meta_keywords":{"type":"string"},"sort_order":{"type":"string"},"automatic":{"type":"boolean"},"rules_match_policy":{"type":"string","enum":["all","any"]},"position":{"type":"integer","description":"Reorders the collection within the flat list (acts_as_list)"},"rules":{"type":"array","description":"Full desired rule set (see create).","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"},"match_policy":{"type":"string"}}}}}}}}}},"delete":{"summary":"Delete a collection","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes a collection.\n\n**Required scope:** `write_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Collection ID","schema":{"type":"string"}}],"responses":{"204":{"description":"collection deleted"}}}},"/api/v3/admin/collections/{collection_id}/products":{"get":{"summary":"List collection products","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Products curated in the collection, ordered by their membership position.\n\n**Required scope:** `read_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"collection_id","in":"path","required":true,"description":"Collection ID","schema":{"type":"string"}}],"responses":{"200":{"description":"products found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}}}},"post":{"summary":"Add a product to a collection","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Curates a product into the collection (appended to the end).\n\n**Required scope:** `write_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"collection_id","in":"path","required":true,"description":"Collection ID","schema":{"type":"string"}}],"responses":{"201":{"description":"product added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"product_id":{"type":"string"}},"required":["product_id"]}}}}}},"/api/v3/admin/collections/{collection_id}/products/{id}":{"delete":{"summary":"Remove a product from a collection","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes a product from the collection's manual curation.\n\n**Required scope:** `write_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"collection_id","in":"path","required":true,"description":"Collection ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}}],"responses":{"204":{"description":"product removed"}}}},"/api/v3/admin/collections/{collection_id}/products/{id}/reposition":{"patch":{"summary":"Reposition a collection product","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Moves a product to a new index among the collection's products.\n\n**Required scope:** `write_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"collection_id","in":"path","required":true,"description":"Collection ID","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Product ID","schema":{"type":"string"}}],"responses":{"204":{"description":"product repositioned"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"new_position":{"type":"integer","description":"0-based index among the collection's products"}},"required":["new_position"]}}}}}},"/api/v3/admin/collection_rules/types":{"get":{"summary":"List available collection rule types","tags":["Collections"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Enumerates the registered rule kinds with their labels and descriptions — drives the rule picker on an automatic collection. Plugins extend the list by registering `Spree::CollectionRule` subclasses via `config.spree.collection_rules`. The `type` returned here is the wire shorthand accepted when writing a collection's `rules`.\n\n**Required scope:** `read_collections` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"types found","content":{"application/json":{}}}}}},"/api/v3/admin/commission_lines":{"get":{"summary":"List commission lines","tags":["Commission Lines"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"What each sale actually earned the marketplace, frozen when the order\nwas placed. A later change to a commission rate never reaches these.\n\n`amount` is the fee charged to the seller and `tax_amount` is the VAT on\nthat fee — the marketplace's own service to the seller, a supply\nseparate from the sale itself, which is why the two are not folded\ntogether. `total` is their sum.\n\nOne line per commissioned item, plus one per delivery when the rate that\napplied charges shipping too — read `line_item_id` and `fulfillment_id`\nto tell them apart.\n\nRead-only: correcting a charge is a reversal, not an edit.\n\n\n**Required scope:** `read_commissions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[seller_id_eq]","in":"query","required":false,"description":"Filter to one seller","schema":{"type":"string"}},{"name":"q[order_id_eq]","in":"query","required":false,"description":"Filter to one order","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-created_at`).","schema":{"type":"string"}}],"responses":{"200":{"description":"commission lines found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CommissionLine"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/commission_lines/{id}":{"parameters":[{"name":"id","in":"path","description":"Commission line ID","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a commission line","tags":["Commission Lines"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_commissions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"commission line found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissionLine"}}}},"404":{"description":"commission line not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/commission_rates":{"get":{"summary":"List commission rates","tags":["Commission Rates"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"What the marketplace charges its sellers.\n\nRates are returned in resolution order: the list is walked top-down and\nthe first rate whose targeting matches the sale wins, so the order you\nsee is the precedence. Move a rate with `position` on update.\n\nA rate carrying no rules matches every sale — `global` says so — which\nis how a marketplace expresses a single default. Because resolution\nstops at the first match, a global rate makes everything below it\nunreachable, so it belongs at the bottom.\n\n\n**Required scope:** `read_commissions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[name_cont]","in":"query","required":false,"description":"Filter by name (contains)","schema":{"type":"string"}},{"name":"q[enabled_eq]","in":"query","required":false,"description":"Filter by whether the rate is in use","schema":{"type":"boolean"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-position`).","schema":{"type":"string"}}],"responses":{"200":{"description":"commission rates found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CommissionRate"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a commission rate","tags":["Commission Rates"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Sets what the marketplace charges, and which sales it applies to.\n\n`rules` is the rate's whole targeting, sent inline. Every rule has to\nhold, and a rule naming several records means any of them — so\n\"(Cameras OR Audio) AND that seller\" is a category rule holding two ids\nbeside a seller rule holding one. Send no rules to charge every sale.\n\nRule kinds come from `GET /commission_rates/rule_types`, which also\ndescribes the configuration each one takes. A marketplace that adds its\nown kind sees it there without this endpoint changing.\n\n`commission_tax_rate` is VAT on the commission itself — the\nmarketplace's own service to the seller, a separate supply from the\nsale. Leave it null to let the store's tax engine answer for wherever\nthe seller's business sits.\n\n\n**Required scope:** `write_commissions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"commission rate created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissionRate"}}}},"422":{"description":"validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","kind","value"],"properties":{"name":{"type":"string"},"code":{"type":"string","nullable":true,"description":"Your own identifier for this rate; unique per store."},"enabled":{"type":"boolean"},"position":{"type":"integer","description":"Place in the list. Rates resolve top-down, so 1 is tried first. New rates are created at the top; send this to move one."},"kind":{"type":"string","enum":["percentage","fixed"]},"value":{"type":"string","description":"A percentage (10 = 10%) or a flat amount, per `kind`."},"amounts":{"type":"object","additionalProperties":{"type":"string"},"description":"What a flat fee charges, keyed by currency. A currency with no amount is one this rate does not charge — those sales fall to the next rate. Ignored for a percentage."},"tax_inclusive":{"type":"boolean","description":"Charge on the price including the customer's VAT. Left off, commission is charged on the seller's net revenue, which is the usual basis where the fee is taxed as its own supply."},"include_shipping":{"type":"boolean","description":"Also charge commission on the seller's delivery revenue."},"bounds":{"type":"object","additionalProperties":{"type":"object","properties":{"min_amount":{"type":"string","nullable":true},"max_amount":{"type":"string","nullable":true}}},"description":"The floor and cap a percentage charges within, keyed by currency. Each holds only in its own currency; a sale in a currency with no bounds is charged unbounded."},"commission_tax_rate":{"type":"string","nullable":true,"description":"A fraction, not a percentage. Null asks the tax engine."},"rules":{"type":"array","description":"The full targeting; what you send replaces what the rate holds.","items":{"type":"object","properties":{"id":{"type":"string","description":"Present for an existing rule; omit to create one."},"type":{"type":"string","description":"A kind from /commission_rates/rule_types."},"preferences":{"type":"object","description":"Configuration for the kind, per its preference_schema."},"product_ids":{"type":"array","items":{"type":"string"},"description":"For kinds that name products, which are kept outside preferences."}}}}}}}}}}},"/api/v3/admin/commission_rates/rule_types":{"get":{"summary":"List the commission rule kinds","tags":["Commission Rates"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Every rule kind a rate can be narrowed by, with the schema describing\nthe configuration it takes — so a client builds its editor from what\nthis marketplace has rather than a list hardcoded to match core's.\n\n`association_fields` names any catalog-scale reference a kind keeps\noutside its preferences, so an editor knows to render a picker for it.\n\n\n**Required scope:** `read_commissions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"subject types found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"preference_schema":{"type":"array","items":{"type":"object"}},"association_fields":{"type":"array","items":{"type":"string"}}}}}}}}}}}}},"/api/v3/admin/commission_rates/{id}":{"parameters":[{"name":"id","in":"path","description":"Commission rate ID","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a commission rate","tags":["Commission Rates"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_commissions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"commission rate found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissionRate"}}}},"404":{"description":"commission rate not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a commission rate","tags":["Commission Rates"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Editing a rate changes what the next sale is charged, never what a past\none was: commission lines keep their own snapshot of the rate that\napplied.\n\n\n**Required scope:** `write_commissions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"commission rate updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissionRate"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"enabled":{"type":"boolean"},"position":{"type":"integer"},"value":{"type":"string"},"rules":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"preferences":{"type":"object"},"product_ids":{"type":"array","items":{"type":"string"}}}}}}}}}}},"delete":{"summary":"Delete a commission rate","tags":["Commission Rates"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_commissions` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"commission rate deleted"}}}},"/api/v3/admin/companies/{company_id}/locations":{"get":{"summary":"List company locations","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the branches of a business customer. Each branch owns its own addresses and the buyers authorised to purchase for it.\n\n**Required scope:** `read_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"locations found","content":{"application/json":{}}}}},"post":{"summary":"Create a company location","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a branch. Addresses are supplied inline and belong to the branch, so editing one later changes the branch's own record rather than an address the buyer also uses.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"location created","content":{"application/json":{}}},"422":{"description":"invalid request","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"external_id":{"type":"string","nullable":true},"billing_address":{"type":"object","description":"Created inline and owned by the branch.","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"address1":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"country_code":{"type":"string"}}}},"required":["name"]}}}}}},"/api/v3/admin/company_locations/{id}":{"parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a company location","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Branches are addressed by their own id once you hold one — the company id is not needed.\n\n**Required scope:** `read_customers` (for API-key authentication).","responses":{"200":{"description":"location found","content":{"application/json":{}}}}},"patch":{"summary":"Update a company location","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Address fields sent here edit the branch's existing address in place; send only what changes.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[],"responses":{"200":{"description":"location updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"billing_address":{"type":"object","properties":{"city":{"type":"string"}}}}}}}}},"delete":{"summary":"Delete a company location","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Removes the branch, its buyers and the addresses it owned.\n\n**Required scope:** `write_customers` (for API-key authentication).","responses":{"204":{"description":"location deleted"}}}},"/api/v3/admin/companies/{company_id}/tax_exemption_certificates":{"parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"List tax exemption certificates","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a business's exemption evidence. `active` is the field that decides whether a certificate\nexempts a sale: a verified certificate stops counting once its expiry date passes, so the status\nalone does not answer it.\n\n\n**Required scope:** `read_customers` (for API-key authentication).","responses":{"200":{"description":"certificates found","content":{"application/json":{}}}}},"post":{"summary":"Create a tax exemption certificate","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Records exemption evidence against a business. Certificates start `pending` and exempt nothing\nuntil verified.\n\n`country_code` and `state_code` say where the certificate holds — omit both for one valid\neverywhere, give only the country for one valid throughout it. `document` takes an ActiveStorage\nsigned blob id obtained from `POST /api/v3/admin/direct_uploads`.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[],"responses":{"201":{"description":"certificate created","content":{"application/json":{}}},"422":{"description":"invalid request","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"certificate_number":{"type":"string"},"reason_code":{"type":"string","description":"Becomes the tax provider's entity use code."},"country_code":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true},"expires_at":{"type":"string","format":"date-time","nullable":true},"issuing_authority":{"type":"string","nullable":true},"document":{"type":"string","description":"ActiveStorage signed blob id from POST /api/v3/admin/direct_uploads."}},"required":["certificate_number","reason_code"]}}}}}},"/api/v3/admin/companies/{company_id}/tax_exemption_certificates/{id}/verify":{"parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"patch":{"summary":"Verify a tax exemption certificate","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Accepts the certificate as evidence, which is what makes it exempt sales. Only a pending\ncertificate can be accepted — re-accepting a revoked one would restore evidence that was\ndeliberately withdrawn. An installation that checks numbers against a registry, or requires a\nsecond approval, can refuse here, and the refusal is returned as a validation error.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","responses":{"200":{"description":"certificate verified","content":{"application/json":{}}}}}},"/api/v3/admin/companies/{company_id}/tax_exemption_certificates/{id}/revoke":{"parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"patch":{"summary":"Revoke a tax exemption certificate","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Withdraws accepted evidence. A verified certificate cannot be deleted — how a sale was taxed has to remain explainable — so revoking is the way out.\n\n**Required scope:** `write_customers` (for API-key authentication).","responses":{"200":{"description":"certificate revoked","content":{"application/json":{}}}}}},"/api/v3/admin/companies/{company_id}/tax_exemption_certificates/{id}/download":{"parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Download a certificate document","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Streams the uploaded document. Deliberately not a storage link: the bytes come through the API so\nthe same credentials apply to every read of a confidential document. Requires only read access.\n\n\n**Required scope:** `read_customers` (for API-key authentication).","responses":{"200":{"description":"document streamed","content":{"application/json":{}}},"422":{"description":"no document attached","content":{"application/json":{}}}}}},"/api/v3/admin/companies/{company_id}/tax_identifiers":{"parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"List company tax registrations","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the business's tax registrations, one per kind. A business registration takes precedence\nover the buyer's own when a sale is for that business, because the invoice is addressed to the\nentity rather than the person who placed the order.\n\n\n**Required scope:** `read_customers` (for API-key authentication).","responses":{"200":{"description":"registrations found","content":{"application/json":{}}}}},"post":{"summary":"Create a company tax registration","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Registers a tax number against the business. Verification against the relevant registry runs in\nthe background where a validator is installed for the kind; a stock installation registers none,\nleaving the status unattempted.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[],"responses":{"201":{"description":"registration created","content":{"application/json":{}}},"422":{"description":"invalid request","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","description":"The regime the number belongs to."},"value":{"type":"string"}},"required":["kind","value"]}}}}}},"/api/v3/admin/companies/{company_id}/tax_identifiers/{id}/validate":{"parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"post":{"summary":"Re-check a company tax registration","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Asks the registry again. Manual because a registry answers only \"valid now\" — a number verified\nlast year may have been deregistered since — and because a check that came back unavailable\ncannot otherwise be retried without editing the number.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","responses":{"422":{"description":"no validator installed for this kind","content":{"application/json":{}}}}}},"/api/v3/admin/companies":{"get":{"summary":"List companies","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the business customers of the current store.\n\n**Required scope:** `read_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"companies found","content":{"application/json":{}}}}},"post":{"summary":"Create a company","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a business customer. Exemption certificates and tax registrations hang off it.\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"company created","content":{"application/json":{}}},"422":{"description":"invalid request","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"external_id":{"type":"string","nullable":true,"description":"Your own reference for this business, unique within the store."}},"required":["name"]}}}}}},"/api/v3/admin/company_locations/{company_location_id}/contacts":{"parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"company_location_id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"List company contacts","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the customers authorised to purchase for a branch. A customer may act for more than one branch.\n\n**Required scope:** `read_customers` (for API-key authentication).","responses":{"200":{"description":"contacts found","content":{"application/json":{}}}}},"post":{"summary":"Create a company contact","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Authorises a customer to purchase for a branch. A customer who acts for exactly one branch has\ntheir orders attributed to it automatically; one who acts for several needs the branch set on\nthe order, because guessing would invoice the wrong business.\n\n\n**Required scope:** `write_customers` (for API-key authentication).","parameters":[],"responses":{"201":{"description":"contact created","content":{"application/json":{}}},"422":{"description":"invalid request","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string"},"role":{"type":"string","description":"Free-form label; carries no permissions in 6.0."}},"required":["customer_id"]}}}}}},"/api/v3/admin/company_contacts/{id}":{"parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get a company contact","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `read_customers` (for API-key authentication).","responses":{"200":{"description":"contact found","content":{"application/json":{}}}}},"delete":{"summary":"Delete a company contact","tags":["Companies"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Withdraws the customer's authority to purchase for the branch. The customer account itself is untouched.\n\n**Required scope:** `write_customers` (for API-key authentication).","responses":{"204":{"description":"contact deleted"}}}},"/api/v3/admin/custom_field_definitions/resource_types":{"get":{"summary":"List what custom fields can be attached to","tags":["Custom Field Definitions"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"The resources a definition can describe, from the server's own\nregistry (`Spree.custom_fields.enabled_resources`).\n\nRead this rather than carrying a list: a resource an extension\nregisters appears here without a client release, and a `resource_type`\nthat is not listed is refused on create.\n\n`resource_type` is the value to send; `name` is what a merchant calls\nit. The two differ where a class has been renamed — categories are\nstored under `Spree::Taxon` and shown as \"Categories\" — so send the\nvalue back verbatim rather than deriving it from the name.\n\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"resource types found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"resource_type":{"type":"string"},"name":{"type":"string"}}}}}}}}}}}},"/api/v3/admin/delivery_profiles":{"get":{"summary":"List delivery profiles","tags":["Delivery"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Fulfillment profiles group products with the stock locations, delivery zones and delivery methods that fulfill them. Every store has exactly one default profile.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"delivery profiles found","content":{"application/json":{}}}}},"post":{"summary":"Create a delivery profile","tags":["Delivery"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a delivery profile. `kind` selects the registered profile kind (shipping, digital, extension kinds); `stock_location_ids` limits fulfillment to those locations — empty means every store location.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"delivery profile created","content":{"application/json":{}}},"422":{"description":"validation error","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"kind":{"type":"string","description":"Registered profile kind; defaults to shipping."},"default":{"type":"boolean"},"stock_location_ids":{"type":"array","items":{"type":"string"},"description":"Empty means every store location."}},"required":["name"]}}}}}},"/api/v3/admin/delivery_profiles/{delivery_profile_id}/origin_groups":{"parameters":[{"name":"delivery_profile_id","in":"path","required":true,"schema":{"type":"string"}}],"post":{"summary":"Create an origin group","tags":["Delivery"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Origin groups partition a profile's fulfillment origins: zones and methods belong to a group, so the same products can quote different rate tables per warehouse. `stock_location_ids` replaces the full membership; empty means every store location.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"origin group created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true},"position":{"type":"integer","nullable":true},"stock_location_ids":{"type":"array","items":{"type":"string"},"description":"Empty means every store location."}}}}}}}},"/api/v3/admin/delivery_profiles/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"patch":{"summary":"Update a delivery profile","tags":["Delivery"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"delivery profile updated","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"default":{"type":"boolean"},"stock_location_ids":{"type":"array","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete a delivery profile","tags":["Delivery"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"The default profile and profiles still referenced by products cannot be deleted.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"delivery profile deleted"}}}},"/api/v3/admin/delivery_methods":{"get":{"summary":"List delivery methods","tags":["Delivery"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns all delivery methods with calculator and zone configuration.\n\n**Required scope:** `read_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"delivery methods found","content":{"application/json":{}}}}},"post":{"summary":"Create delivery method","tags":["Delivery"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a delivery method inside a delivery profile (defaults to the store default profile). Delivery behavior comes from the fulfillment provider.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"delivery method created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"admin_name":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"fulfillment_provider":{"type":"string","nullable":true},"delivery_profile_id":{"type":"string","nullable":true},"storefront_visible":{"type":"boolean"},"tracking_url":{"type":"string","nullable":true},"estimated_transit_business_days_min":{"type":"integer","nullable":true},"estimated_transit_business_days_max":{"type":"integer","nullable":true},"tax_category_id":{"type":"string","nullable":true},"calculator_type":{"type":"string"},"calculator_preferences":{"type":"object"},"delivery_zone_id":{"type":"string","nullable":true}},"required":["name"]}}}}}},"/api/v3/admin/delivery_methods/calculators":{"get":{"summary":"List delivery calculators","tags":["Delivery"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Registered delivery calculator classes with preference schemas for building configuration forms.\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"calculators found","content":{"application/json":{}}}}}},"/api/v3/admin/delivery_zones":{"post":{"summary":"Create delivery zone","tags":["Delivery"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a delivery zone with typed members: country, state, or postal_code (prefix or from/to range).\n\n**Required scope:** `write_settings` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","required":false,"description":"Comma-separated associations to embed, e.g. `members`","schema":{"type":"string"}}],"responses":{"201":{"description":"delivery zone created","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true},"members":{"type":"array","items":{"type":"object","properties":{"member_type":{"type":"string","enum":["country","state","postal_code"]},"country_code":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true},"postal_code_prefix":{"type":"string","nullable":true},"postal_code_from":{"type":"string","nullable":true},"postal_code_to":{"type":"string","nullable":true}},"required":["member_type"]}}},"required":["name"]}}}}}},"/api/v3/admin/integrations":{"get":{"summary":"List integrations","tags":["Integrations"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the integrations connected to the current store. Secret preference values are masked.\n\n**Required scope:** `read_integrations` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"integrations found","content":{"application/json":{}}}}},"post":{"summary":"Connect integration","tags":["Integrations"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Connects an integration type to the current store. Setting active: true verifies the connection and fails with 422 when it cannot connect. Submitting a masked secret value back keeps the stored secret.\n\n**Required scope:** `write_integrations` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"integration connected","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Wire shorthand from GET /integrations/types"},"active":{"type":"boolean"},"preferences":{"type":"object"}},"required":["type"]}}}}}},"/api/v3/admin/integrations/types":{"get":{"summary":"List integration types","tags":["Integrations"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Every registered integration type with its gallery metadata and configuration schema. Pure registry discovery — read live connection state from GET /integrations.\n\n**Required scope:** `read_integrations` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"integration types found","content":{"application/json":{}}}}}},"/api/v3/admin/integrations/{id}/test":{"post":{"summary":"Test integration connection","tags":["Integrations"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Runs a live connection check against the provider. Nothing is persisted; a failed check reports the seller error message.\n\n**Required scope:** `write_integrations` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"connection checked","content":{"application/json":{}}}}}},"/api/v3/admin/product_types":{"get":{"summary":"List product types","tags":["Product Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a paginated list of product types.\n\nA product type is a back-office template: it seeds option types and\ncategories onto products created with it, and defines which custom\nfields those products' forms show. It is not exposed on the Store API.\n\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}}],"responses":{"200":{"description":"product types found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProductType"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a product type","tags":["Product Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Creates a product type.\n\n`option_type_ids` and `category_ids` seed products created with this\ntype. `custom_field_definitions` is a replace-set of the definitions the\nproduct form renders, in `sort_order`. `required` is advisory — the\ndashboard marks the field, but a blank value is never rejected.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"201":{"description":"product type created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductType"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"delivery_profile_id":{"type":"string","nullable":true,"description":"Fulfillment profile stamped onto products created with this type. Null leaves new products on the store default profile."},"option_type_ids":{"type":"array","items":{"type":"string"},"description":"Option types seeded onto products created with this type."},"category_ids":{"type":"array","items":{"type":"string"},"description":"Categories seeded onto products created with this type."},"custom_field_definitions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Prefixed custom field definition id."},"required":{"type":"boolean"},"sort_order":{"type":"integer"}}}}},"required":["name"]}}}}}},"/api/v3/admin/product_types/{id}":{"parameters":[{"name":"id","in":"path","description":"Product type ID","required":true,"schema":{"type":"string"}}],"get":{"summary":"Retrieve a product type","tags":["Product Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single product type with its option types, categories and custom fields.\n\n**Required scope:** `read_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"product type found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductType"}}}},"404":{"description":"product type not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a product type","tags":["Product Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates a product type.\n\nChanges never modify products that already carry the type — use\n`apply_to_products` to backfill those.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"200":{"description":"product type updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductType"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"delivery_profile_id":{"type":"string","nullable":true},"option_type_ids":{"type":"array","items":{"type":"string"}},"category_ids":{"type":"array","items":{"type":"string"}},"custom_field_definitions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"required":{"type":"boolean"},"sort_order":{"type":"integer"}}}}}}}}}},"delete":{"summary":"Delete a product type","tags":["Product Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Deletes a product type. Types still used by products cannot be deleted.\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"204":{"description":"product type deleted"}}}},"/api/v3/admin/product_types/{id}/apply_to_products":{"parameters":[{"name":"id","in":"path","description":"Product type ID","required":true,"schema":{"type":"string"}}],"post":{"summary":"Apply a product type to its existing products","tags":["Product Types"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Backfills the type's option types and categories onto the products that\nalready carry it. Additive and idempotent — nothing is removed, and\nre-running is safe.\n\nRuns in the background; the response reports how many products the type\ncurrently has.\n\n\n**Required scope:** `write_products` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}}],"responses":{"202":{"description":"backfill accepted","content":{"application/json":{"schema":{"type":"object","properties":{"products_count":{"type":"integer"}}}}}}}}},"/api/v3/admin/seller_requirements":{"get":{"summary":"List seller requirements","tags":["Seller Requirements"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"What this marketplace asks of a seller before it will let them trade,\nin the order sellers work through it.\n\nEach row is one configured requirement. `required` says whether it\nstands between the seller and approval — the others are shown as\nrecommended and counted in their progress, but never block. `active`\nswitches one off without losing how it was worded.\n\n\n**Required scope:** `read_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"seller requirements found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SellerRequirement"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}}}}}}}},"post":{"summary":"Add a seller requirement","tags":["Seller Requirements"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Adds something the marketplace asks of its sellers.\n\n`type` comes from `GET /seller_requirements/types`, which also\ndescribes the configuration each kind takes. Most kinds answer one\nquestion and can be added once; the open-ended ones — a seller\nconfirmation, a manual check, a document — carry the question in your\nown `name` and `description`, so a store may add as many as it needs.\n\nA kind that reads the seller's own data (their addresses, their\nproducts, whether they accepted the terms) needs nothing from the\nseller beyond doing it. The others wait for the seller to submit\nsomething, and the ones you review wait for you.\n\n\n**Required scope:** `write_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"seller requirement created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerRequirement"}}}},"422":{"description":"kind is not registered","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The kind, from `GET /seller_requirements/types`."},"name":{"type":"string","description":"What the seller sees. Required for kinds that can be added more than once, since the wording is the only thing telling them apart. Left blank on the others, the kind names itself."},"description":{"type":"string","description":"Instructions shown to the seller."},"required":{"type":"boolean","description":"Whether this blocks approval. Off means recommended."},"active":{"type":"boolean"},"position":{"type":"integer","description":"Place in the checklist."},"preferences":{"type":"object","description":"Configuration for this kind, per its `preference_schema`."}}}}}}}},"/api/v3/admin/seller_requirements/types":{"get":{"summary":"List seller requirement kinds","tags":["Seller Requirements"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"The kinds you can add, and the shape of each one's configuration form.\n\n`configured` says the store already has this kind — meaningful only\nwhere `allow_multiple` is false. `accepts_submissions` says the seller\nrecords having done it rather than it being read from their data, and\n`reviewed_by_operator` says what they send waits for you.\n\nA marketplace that registers its own kind server-side sees it here\nwithout this endpoint changing.\n\n\n**Required scope:** `read_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"kinds found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"allow_multiple":{"type":"boolean"},"accepts_submissions":{"type":"boolean"},"reviewed_by_operator":{"type":"boolean"},"configured":{"type":"boolean"},"addable":{"type":"boolean","description":"Whether the operator may add one now. The uniqueness rule is the server's, so clients filter on this rather than deriving it."},"preference_schema":{"type":"array","items":{"type":"object"}}}}}}}}}}}}},"/api/v3/admin/seller_requirements/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"patch":{"summary":"Update a seller requirement","tags":["Seller Requirements"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Changes how a requirement is worded, what it asks for, where it sits in\nthe checklist, and whether it blocks approval.\n\n`type` is not accepted: a saved row's kind never changes, because\nanything a seller already submitted answered the old one.\n\n\n**Required scope:** `write_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"seller requirement updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerRequirement"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"required":{"type":"boolean"},"active":{"type":"boolean"},"position":{"type":"integer"},"preferences":{"type":"object"}}}}}}},"delete":{"summary":"Delete a seller requirement","tags":["Seller Requirements"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Stops asking for this. Anything sellers already submitted against it\ngoes too — to keep the record while pausing the ask, set `active` to\nfalse instead.\n\n\n**Required scope:** `write_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"seller requirement deleted"}}}},"/api/v3/admin/sellers":{"get":{"summary":"List sellers","tags":["Sellers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the sellers on this marketplace. `status` says where each one\nis in its life on the marketplace, and `sellable` answers the question\nthe status alone cannot: an approved seller who is away cannot be\nbought from either.\n\n\n**Required scope:** `read_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[name_cont]","in":"query","required":false,"description":"Filter by name (contains)","schema":{"type":"string"}},{"name":"q[status_eq]","in":"query","required":false,"description":"Filter by status","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Sort by field. Prefix with `-` for descending (e.g., `-created_at`).","schema":{"type":"string"}}],"responses":{"200":{"description":"sellers found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Seller"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"Create a seller","tags":["Sellers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Opens a seller record. The seller starts as `pending` and has no team\nyet — invite someone to run it with the `invite` action below.\n\n`status` is deliberately not writable here or on update: every move\nthrough the lifecycle is its own action, because each one does more\nthan set a column.\n\n\n**Required scope:** `write_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"seller created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Seller"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"slug":{"type":"string","description":"Derived from the name when omitted."},"contact_email":{"type":"string","nullable":true},"billing_email":{"type":"string","nullable":true},"about":{"type":"string","nullable":true},"tax_remittance":{"type":"string","enum":["seller","platform"]},"payouts_schedule_interval":{"type":"string","enum":["daily","weekly","biweekly","monthly","manual"],"nullable":true},"minimum_payout_amount":{"type":"string","nullable":true}}}}}}}},"/api/v3/admin/sellers/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Seller prefixed ID","schema":{"type":"string"}}],"get":{"summary":"Get a seller","tags":["Sellers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single seller, including its settlement and tax configuration.\n\n**Required scope:** `read_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"seller found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Seller"}}}},"404":{"description":"seller not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"summary":"Update a seller","tags":["Sellers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Updates the seller's profile and the settlement configuration the\noperator owns. A `status` sent here is ignored — use the lifecycle\nactions.\n\n\n**Required scope:** `write_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"seller address written inline","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Seller"}}}},"422":{"description":"validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"billing_email":{"type":"string","nullable":true},"payouts_schedule_interval":{"type":"string","enum":["daily","weekly","biweekly","monthly","manual"],"nullable":true},"minimum_payout_amount":{"type":"string","nullable":true},"holiday_mode_until":{"type":"string","format":"date-time","nullable":true},"logo":{"type":"string","nullable":true,"description":"ActiveStorage signed id of a direct-uploaded file. Send `null` to remove the attachment, or omit the key to leave it alone. Same for `square_logo` and `cover_photo`."},"square_logo":{"type":"string","nullable":true},"cover_photo":{"type":"string","nullable":true},"billing_address":{"type":"object","description":"The seller's own address, written inline. There is no `billing_address_id` — an address belongs to whoever it was created for, so it is never referenced by id here.","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"company":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"phone":{"type":"string"},"country_code":{"type":"string"},"state_code":{"type":"string"},"state_name":{"type":"string"},"label":{"type":"string"}}},"returns_address":{"type":"object","description":"The seller's own address, written inline. There is no `billing_address_id` — an address belongs to whoever it was created for, so it is never referenced by id here.","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"company":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"phone":{"type":"string"},"country_code":{"type":"string"},"state_code":{"type":"string"},"state_name":{"type":"string"},"label":{"type":"string"}}}}}}}}},"delete":{"summary":"Delete a seller","tags":["Sellers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Soft-deletes the seller. Their products are kept and left without a\nseller rather than deleted — what happens to a departed seller's\ncatalog is the operator's decision.\n\n\n**Required scope:** `write_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"seller deleted"}}}},"/api/v3/admin/sellers/{id}/invite":{"parameters":[{"name":"id","in":"path","required":true,"description":"Seller prefixed ID","schema":{"type":"string"}}],"post":{"summary":"Invite someone to run a seller","tags":["Sellers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Sends an invitation to the seller's own team and moves the seller to\n`invited`. The person becomes a member when they accept, and can then\nsign in to the seller panel.\n\n`role_id` must name a role this seller owns; omit it for the seller's\nown admin role. Re-inviting is allowed — an invitation expires, or the\nfirst one goes to the wrong address.\n\n\n**Required scope:** `write_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"invitation sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Seller"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string"},"role_id":{"type":"string","nullable":true}}}}}}}},"/api/v3/admin/sellers/{id}/approve":{"parameters":[{"name":"id","in":"path","required":true,"description":"Seller prefixed ID","schema":{"type":"string"}}],"patch":{"summary":"Approve a seller","tags":["Sellers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Lets the seller sell. This is also the way back for one that was\nsuspended or turned down, and it clears any holiday along with the\nsuspension.\n\n\n**Required scope:** `write_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"seller approved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Seller"}}}},"422":{"description":"seller cannot be approved from its current status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/sellers/{id}/suspend":{"parameters":[{"name":"id","in":"path","required":true,"description":"Seller prefixed ID","schema":{"type":"string"}}],"patch":{"summary":"Suspend a seller","tags":["Sellers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Stops a trading seller from selling. Their catalog and history stay,\nand approving reinstates them. Use this rather than `reject` for a\nseller already on the marketplace — it says something different, and\nit can be undone.\n\n\n**Required scope:** `write_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"seller suspended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Seller"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string"}}}}}}}},"/api/v3/admin/sellers/{id}/reject":{"parameters":[{"name":"id","in":"path","required":true,"description":"Seller prefixed ID","schema":{"type":"string"}}],"patch":{"summary":"Reject a seller","tags":["Sellers"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Turns down an applicant who never traded. A seller already selling is\nsuspended instead; rejecting one is refused.\n\n\n**Required scope:** `write_sellers` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"seller rejected","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Seller"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string"}}}}}}}},"/api/v3/admin/stock_movements":{"get":{"summary":"List stock movements","tags":["Stock Movements"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns the stock ledger, newest first. Every row says what happened to\nstock (`kind`) and carries a direct reference to what caused it, so a\nmerchant can answer \"why is this number what it is?\" from the data.\n\nKinds are `received` (goods arrived), `allocated` (stock promised to a\nplaced order), `shipped` (promised stock left), `released` (a promise\nwithdrawn) and `adjusted` (a manual correction, which always carries a\n`reason`).\n\nMovements are immutable — reversing one means writing its counterpart\nthrough the resource that caused it, which is why there is no create,\nupdate or delete here.\n\nFilter with Ransack predicates such as `q[kind_eq]`,\n`q[stock_level_id_eq]`, `q[order_id_eq]`, `q[fulfillment_id_eq]` or\n`q[created_at_gteq]`.\n\n`kind` is null on rows written before Spree 6.0 until\n`spree:migrate_stock_movements_to_typed_rows` has run.\n\n\n**Required scope:** `read_stock` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page","schema":{"type":"integer"}},{"name":"q[kind_eq]","in":"query","required":false,"description":"Filter by kind ('received', 'allocated', 'shipped', 'released', 'adjusted')","schema":{"type":"string"}},{"name":"q[stock_level_id_eq]","in":"query","required":false,"description":"Filter by stock level, e.g. sl_1234567890","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"stock movements found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/StockMovement"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]}}}},"401":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/stock_movements/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Stock movement ID","schema":{"type":"string"}}],"get":{"summary":"Get a stock movement","tags":["Stock Movements"],"security":[{"api_key":[],"bearer_auth":[]}],"description":"Returns a single stock movement by prefixed ID.\n\n**Required scope:** `read_stock` (for API-key authentication).","parameters":[{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for admin authentication","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated list of fields to include. id is always included.","schema":{"type":"string"}}],"responses":{"200":{"description":"stock movement found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockMovement"}}}},"404":{"description":"stock movement not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"PaginationMeta":{"type":"object","properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"count":{"type":"integer","description":"Total number of records"},"pages":{"type":"integer","description":"Total number of pages"},"from":{"type":"integer","description":"Index of first record on this page"},"to":{"type":"integer","description":"Index of last record on this page"},"in":{"type":"integer","description":"Number of records on this page"},"previous":{"type":"integer","nullable":true,"description":"Previous page number"},"next":{"type":"integer","nullable":true,"description":"Next page number"}},"required":["page","limit","count","pages","from","to","in"]},"ErrorResponse":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","description":"Field-specific validation errors","nullable":true}},"required":["code","message"]}},"required":["error"]},"AuthResponse":{"type":"object","properties":{"token":{"type":"string","description":"JWT access token"},"user":{"$ref":"#/components/schemas/AdminUser"}},"required":["token","user"]},"PermissionRule":{"type":"object","description":"A single permission rule (CanCanCan rule). Rules are applied in order, last-matching-wins.","properties":{"allow":{"type":"boolean","description":"true for `can`, false for `cannot`"},"actions":{"type":"array","items":{"type":"string"},"description":"Action names, e.g. [\"read\", \"update\"] or [\"manage\"]"},"subjects":{"type":"array","items":{"type":"string"},"description":"Subject class names, e.g. [\"Spree::Product\"] or [\"all\"]"},"has_conditions":{"type":"boolean","description":"True if the server-side rule has per-record conditions. The SPA shows the action optimistically and handles 403 from the API."}},"required":["allow","actions","subjects","has_conditions"]},"MeResponse":{"type":"object","description":"Current admin user profile and serialized permissions","properties":{"user":{"$ref":"#/components/schemas/AdminUser"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/PermissionRule"}}},"required":["user","permissions"]},"ImportSchemaField":{"type":"object","description":"A canonical column of an import type, including per-store custom field columns","properties":{"name":{"type":"string","description":"Canonical field name used in mappings"},"label":{"type":"string","description":"Human-readable label"},"required":{"type":"boolean","description":"Whether the field must be mapped before processing"}},"required":["name","label","required"]},"CheckoutRequirement":{"type":"object","properties":{"step":{"type":"string","description":"Checkout step this requirement belongs to"},"field":{"type":"string","description":"Field that needs to be satisfied"},"message":{"type":"string","description":"Human-readable requirement message"}},"required":["step","field","message"]},"CartWarning":{"type":"object","description":"A warning about a cart issue (e.g., item removed due to stock change)","properties":{"code":{"type":"string","description":"Machine-readable warning code"},"message":{"type":"string","description":"Human-readable warning message"},"line_item_id":{"type":"string","nullable":true,"description":"Prefixed line item ID (when applicable)"},"variant_id":{"type":"string","nullable":true,"description":"Prefixed variant ID (when applicable)"},"item_index":{"type":"integer","nullable":true,"description":"Position in the submitted items array, for warnings raised while applying a batch of item changes"}},"required":["code","message"]},"FulfillmentManifestItem":{"type":"object","description":"An item within a fulfillment — which line item and how many units are in this fulfillment","properties":{"item_id":{"type":"string","description":"Line item ID"},"variant_id":{"type":"string","description":"Variant ID"},"quantity":{"type":"integer","description":"Quantity in this fulfillment"}},"required":["item_id","variant_id","quantity"]},"AdminUserRoleAssignment":{"type":"object","description":"A role assignment for the current store on a staff member","properties":{"id":{"type":"string","description":"Prefixed role ID"},"name":{"type":"string","description":"Role name"}},"required":["id","name"]},"AdminUserStore":{"type":"object","description":"A store the staff member can access through a role assignment","properties":{"id":{"type":"string","description":"Prefixed store ID"},"name":{"type":"string","description":"Store name"},"code":{"type":"string","description":"Store code"}},"required":["id","name","code"]},"PreferenceField":{"type":"object","description":"A single configurable preference on a payment method, promotion rule/action, or calculator. The frontend uses `type` + `default` to render a sensible input.","properties":{"key":{"type":"string"},"type":{"type":"string","description":"string | text | password | integer | decimal | boolean | array | hash"},"default":{"description":"Default value (any JSON type), null when there is no default","nullable":true}},"required":["key","type"]},"PromotionActionCalculator":{"type":"object","description":"The action's nested calculator (when the action carries one — null for actions like `free_shipping`)","properties":{"type":{"type":"string","description":"Wire shorthand for the calculator subclass"},"label":{"type":"string"},"preferences":{"type":"object","additionalProperties":true},"preference_schema":{"type":"array","items":{"$ref":"#/components/schemas/PreferenceField"}}},"required":["type","label","preferences","preference_schema"]},"PromotionActionLineItem":{"type":"object","description":"One row in a `create_line_items` action — the variant added to the order and how many","properties":{"variant_id":{"type":"string"},"quantity":{"type":"integer"}},"required":["variant_id","quantity"]},"Address":{"type":"object","properties":{"id":{"type":"string"},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"full_name":{"type":"string"},"address1":{"type":"string","nullable":true},"address2":{"type":"string","nullable":true},"postal_code":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"country_name":{"type":"string"},"country_code":{"type":"string"},"state_text":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true},"quick_checkout":{"type":"boolean"},"is_default_billing":{"type":"boolean"},"is_default_shipping":{"type":"boolean"},"state_abbr":{"type":"string","nullable":true},"country_iso":{"type":"string"},"state_name":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"latitude":{"type":"number","nullable":true},"longitude":{"type":"number","nullable":true},"customer_id":{"type":"string","nullable":true}},"required":["id","first_name","last_name","full_name","address1","address2","postal_code","city","phone","company","country_name","country_code","state_text","state_code","quick_checkout","is_default_billing","is_default_shipping","state_abbr","country_iso","state_name","label","metadata","created_at","updated_at","latitude","longitude","customer_id"],"x-typelizer":true},"AdminUser":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"full_name":{"type":"string","nullable":true},"selected_locale":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"avatar_url":{"type":"string","nullable":true},"roles":{"type":"array","items":{"$ref":"#/components/schemas/AdminUserRoleAssignment"}},"stores":{"type":"array","items":{"$ref":"#/components/schemas/AdminUserStore"}}},"required":["id","email","first_name","last_name","full_name","selected_locale","created_at","updated_at","avatar_url","roles","stores"],"x-typelizer":true},"AllowedOrigin":{"type":"object","properties":{"id":{"type":"string"},"origin":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","origin","created_at","updated_at"],"x-typelizer":true},"ApiKey":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"key_type":{"type":"string"},"token_prefix":{"type":"string","nullable":true},"scopes":{"type":"array","items":{"type":"string"}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"revoked_at":{"type":"string","nullable":true},"last_used_at":{"type":"string","nullable":true},"channel_id":{"type":"string","nullable":true},"plaintext_token":{"type":"string","nullable":true},"created_by_email":{"type":"string","nullable":true}},"required":["id","name","key_type","token_prefix","scopes","created_at","updated_at","revoked_at","last_used_at","channel_id","plaintext_token","created_by_email"],"x-typelizer":true},"AppliedPromotion":{"type":"object","properties":{"id":{"type":"string"},"promotion_id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"amount":{"type":"string"},"display_amount":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","promotion_id","name","description","code","amount","display_amount","created_at","updated_at"],"x-typelizer":true},"Cart":{"type":"object","properties":{"id":{"type":"string"},"market_id":{"type":"string","nullable":true},"channel_id":{"type":"string","nullable":true},"preferred_stock_location_id":{"type":"string","nullable":true},"number":{"type":"string"},"token":{"type":"string"},"email":{"type":"string","nullable":true},"customer_note":{"type":"string","nullable":true},"currency":{"type":"string"},"locale":{"type":"string","nullable":true},"total_quantity":{"type":"number"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/CartWarning"}},"coupon_code":{"type":"string","nullable":true},"item_total":{"type":"string","nullable":true},"display_item_total":{"type":"string","nullable":true},"adjustment_total":{"type":"string","nullable":true},"display_adjustment_total":{"type":"string","nullable":true},"discount_total":{"type":"string","nullable":true},"display_discount_total":{"type":"string","nullable":true},"tax_total":{"type":"string","nullable":true},"display_tax_total":{"type":"string","nullable":true},"included_tax_total":{"type":"string","nullable":true},"display_included_tax_total":{"type":"string","nullable":true},"additional_tax_total":{"type":"string","nullable":true},"display_additional_tax_total":{"type":"string","nullable":true},"total":{"type":"string","nullable":true},"display_total":{"type":"string","nullable":true},"gift_card_total":{"type":"string","nullable":true},"display_gift_card_total":{"type":"string","nullable":true},"amount_due":{"type":"string","nullable":true},"display_amount_due":{"type":"string","nullable":true},"delivery_total":{"type":"string","nullable":true},"display_delivery_total":{"type":"string","nullable":true},"fee_total":{"type":"string","nullable":true},"display_fee_total":{"type":"string","nullable":true},"store_credit_total":{"type":"string","nullable":true},"display_store_credit_total":{"type":"string","nullable":true},"covered_by_store_credit":{"type":"boolean"},"current_step":{"type":"string"},"completed_steps":{"type":"array","items":{"type":"string"}},"requirements":{"type":"array","items":{"$ref":"#/components/schemas/CheckoutRequirement"}},"shipping_eq_billing_address":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"billing_address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"nullable":true},"shipping_address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"nullable":true},"market":{"allOf":[{"$ref":"#/components/schemas/Market"}],"nullable":true},"completed_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"applied_promotions":{"type":"array","items":{"$ref":"#/components/schemas/AppliedPromotion"}}},"required":["id","market_id","channel_id","preferred_stock_location_id","number","token","email","customer_note","currency","locale","total_quantity","warnings","coupon_code","item_total","display_item_total","adjustment_total","display_adjustment_total","discount_total","display_discount_total","tax_total","display_tax_total","included_tax_total","display_included_tax_total","additional_tax_total","display_additional_tax_total","total","display_total","gift_card_total","display_gift_card_total","amount_due","display_amount_due","delivery_total","display_delivery_total","fee_total","display_fee_total","store_credit_total","display_store_credit_total","covered_by_store_credit","current_step","completed_steps","requirements","shipping_eq_billing_address","items","billing_address","shipping_address","market","completed_at","created_at","updated_at","applied_promotions"],"x-typelizer":true},"Category":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"permalink":{"type":"string"},"position":{"type":"number"},"depth":{"type":"number"},"meta_title":{"type":"string","nullable":true},"meta_description":{"type":"string","nullable":true},"meta_keywords":{"type":"string","nullable":true},"children_count":{"type":"number"},"parent_id":{"type":"string","nullable":true},"description":{"type":"string"},"description_html":{"type":"string"},"image_url":{"type":"string","nullable":true},"square_image_url":{"type":"string","nullable":true},"is_root":{"type":"boolean"},"is_child":{"type":"boolean"},"is_leaf":{"type":"boolean"},"parent":{"$ref":"#/components/schemas/Category"},"children":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"translations":{"type":"object"},"metadata":{"type":"object"},"pretty_name":{"type":"string"},"lft":{"type":"number"},"rgt":{"type":"number"},"products_count":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","name","permalink","position","depth","meta_title","meta_description","meta_keywords","children_count","parent_id","description","description_html","image_url","square_image_url","is_root","is_child","is_leaf","metadata","pretty_name","lft","rgt","products_count","created_at","updated_at"],"x-typelizer":true},"Channel":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"code":{"type":"string"},"active":{"type":"boolean"},"default":{"type":"boolean"},"storefront_access":{"type":"string"},"guest_checkout":{"type":"boolean"},"preferred_order_routing_strategy":{"type":"string","nullable":true},"preferred_storefront_access":{"type":"string","nullable":true},"preferred_guest_checkout":{"type":"boolean","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"stock_location_ids":{"type":"array","items":{"type":"string"}}},"required":["id","name","code","active","default","storefront_access","guest_checkout","preferred_order_routing_strategy","preferred_storefront_access","preferred_guest_checkout","created_at","updated_at","stock_location_ids"],"x-typelizer":true},"ClaimLineItem":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"number"},"send_replacement":{"type":"boolean"},"description":{"type":"string","nullable":true},"refund_amount":{"type":"string"},"paid_amount":{"type":"string"},"display_refund_amount":{"type":"string"},"variant_id":{"type":"string","nullable":true},"replacement_variant_id":{"type":"string","nullable":true},"line_item_id":{"type":"string","nullable":true},"variant":{"$ref":"#/components/schemas/Variant"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"replacement_variant":{"$ref":"#/components/schemas/Variant"}},"required":["id","quantity","send_replacement","description","refund_amount","paid_amount","display_refund_amount","variant_id","replacement_variant_id","line_item_id","created_at","updated_at"],"x-typelizer":true},"ClaimReason":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"active":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"can_be_deleted":{"type":"boolean"}},"required":["id","name","active","created_at","updated_at","can_be_deleted"],"x-typelizer":true},"Claim":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"status":{"type":"string"},"resolution":{"type":"string","nullable":true},"order_id":{"type":"string","nullable":true},"reason_id":{"type":"string","nullable":true},"refund_total":{"type":"string"},"display_refund_total":{"type":"string"},"approved_at":{"type":"string","nullable":true},"resolved_at":{"type":"string","nullable":true},"denied_at":{"type":"string","nullable":true},"canceled_at":{"type":"string","nullable":true},"reason":{"$ref":"#/components/schemas/ClaimReason"},"claim_line_items":{"type":"array","items":{"$ref":"#/components/schemas/ClaimLineItem"}},"memo":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"created_by_id":{"type":"string","nullable":true},"order":{"$ref":"#/components/schemas/Order"},"refunds":{"type":"array","items":{"$ref":"#/components/schemas/Refund"}}},"required":["id","number","status","resolution","order_id","reason_id","refund_total","display_refund_total","approved_at","resolved_at","denied_at","canceled_at","memo","metadata","created_at","updated_at","created_by_id"],"x-typelizer":true},"CollectionRule":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"value":{"type":"string","nullable":true},"match_policy":{"type":"string"}},"required":["id","type","value","match_policy"],"x-typelizer":true},"Collection":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"permalink":{"type":"string"},"position":{"type":"number"},"sort_order":{"type":"string"},"meta_title":{"type":"string","nullable":true},"meta_description":{"type":"string","nullable":true},"meta_keywords":{"type":"string","nullable":true},"products_count":{"type":"number"},"description":{"type":"string"},"description_html":{"type":"string"},"image_url":{"type":"string","nullable":true},"square_image_url":{"type":"string","nullable":true},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"translations":{"type":"object"},"automatic":{"type":"boolean"},"rules_match_policy":{"type":"string"},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/CollectionRule"}}},"required":["id","name","permalink","position","sort_order","meta_title","meta_description","meta_keywords","products_count","description","description_html","image_url","square_image_url","automatic","rules_match_policy","metadata","created_at","updated_at"],"x-typelizer":true},"CommissionLine":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"currency":{"type":"string"},"taxability_reason":{"type":"string","nullable":true},"country_code":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"rate":{"type":"string"},"tax_rate":{"type":"string"},"amount":{"type":"string"},"tax_amount":{"type":"string"},"total":{"type":"string"},"display_amount":{"type":"string"},"display_tax_amount":{"type":"string"},"display_total":{"type":"string"},"order_id":{"type":"string"},"seller_id":{"type":"string"},"line_item_id":{"type":"string","nullable":true},"fulfillment_id":{"type":"string","nullable":true},"commission_rate_id":{"type":"string","nullable":true},"seller_name":{"type":"string","nullable":true}},"required":["id","kind","currency","taxability_reason","country_code","state_code","created_at","updated_at","rate","tax_rate","amount","tax_amount","total","display_amount","display_tax_amount","display_total","order_id","seller_id","line_item_id","fulfillment_id","commission_rate_id","seller_name"],"x-typelizer":true},"CommissionRate":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"code":{"type":"string","nullable":true},"enabled":{"type":"boolean"},"position":{"type":"number"},"kind":{"type":"string"},"tax_inclusive":{"type":"boolean"},"include_shipping":{"type":"boolean"},"metadata":{"type":"object","nullable":true},"deleted_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"value":{"type":"string"},"commission_tax_rate":{"type":"string","nullable":true},"amounts":{"type":"object"},"bounds":{"type":"object"},"global":{"type":"boolean"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/CommissionRule"}}},"required":["id","name","code","enabled","position","kind","tax_inclusive","include_shipping","metadata","deleted_at","created_at","updated_at","value","commission_tax_rate","amounts","bounds","global","rules"],"x-typelizer":true},"CommissionRule":{"type":"object","properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"type":{"type":"string"},"commission_rate_id":{"type":"string"},"preferences":{"type":"object"},"preference_schema":{"type":"object"},"label":{"type":"string"},"description":{"type":"string","nullable":true},"product_ids":{"type":"array","items":{"type":"string"}}},"required":["id","created_at","updated_at","type","commission_rate_id","preferences","preference_schema","label","description"],"x-typelizer":true},"CompanyContact":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"company_location_id":{"type":"string"},"customer_id":{"type":"string"},"email":{"type":"string","nullable":true}},"required":["id","role","created_at","updated_at","company_location_id","customer_id","email"],"x-typelizer":true},"CompanyLocation":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"external_id":{"type":"string","nullable":true},"metadata":{"type":"object","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"company_id":{"type":"string"},"contacts_count":{"type":"number"},"billing_address":{"$ref":"#/components/schemas/Address"},"shipping_address":{"$ref":"#/components/schemas/Address"},"company_contacts":{"type":"array","items":{"$ref":"#/components/schemas/CompanyContact"}}},"required":["id","name","external_id","metadata","created_at","updated_at","company_id","contacts_count","billing_address","shipping_address"],"x-typelizer":true},"Company":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"external_id":{"type":"string","nullable":true},"metadata":{"type":"object","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"locations_count":{"type":"number"},"company_locations":{"type":"array","items":{"$ref":"#/components/schemas/CompanyLocation"}}},"required":["id","name","external_id","metadata","created_at","updated_at","locations_count"],"x-typelizer":true},"Country":{"type":"object","properties":{"iso":{"type":"string"},"iso3":{"type":"string"},"name":{"type":"string"},"states_required":{"type":"boolean"},"zipcode_required":{"type":"boolean"},"states":{"type":"array","items":{"$ref":"#/components/schemas/State"}},"market":{"allOf":[{"$ref":"#/components/schemas/Market"}],"nullable":true}},"required":["iso","iso3","name","states_required","zipcode_required"],"x-typelizer":true},"CouponCode":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"state":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"promotion_id":{"type":"string"},"order_id":{"type":"string","nullable":true}},"required":["id","code","state","created_at","updated_at","promotion_id","order_id"],"x-typelizer":true},"CreditCard":{"type":"object","properties":{"id":{"type":"string"},"brand":{"type":"string"},"last4":{"type":"string"},"month":{"type":"number"},"year":{"type":"number"},"name":{"type":"string","nullable":true},"default":{"type":"boolean"},"gateway_payment_profile_id":{"type":"string","nullable":true},"customer_id":{"type":"string","nullable":true},"payment_method_id":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","brand","last4","month","year","name","default","gateway_payment_profile_id","customer_id","payment_method_id","metadata","created_at","updated_at"],"x-typelizer":true},"CustomFieldDefinition":{"type":"object","properties":{"id":{"type":"string"},"namespace":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"},"field_type":{"type":"string","enum":["short_text","long_text","rich_text","number","boolean","json"]},"resource_type":{"type":"string"},"storefront_visible":{"type":"boolean"},"searchable":{"type":"boolean"},"sortable":{"type":"boolean"},"filter_key":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","namespace","key","label","field_type","resource_type","storefront_visible","searchable","sortable","filter_key","created_at","updated_at"],"x-typelizer":true},"CustomField":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"type":{"type":"string","deprecated":true},"field_type":{"type":"string","enum":["short_text","long_text","rich_text","number","boolean","json"]},"key":{"type":"string"},"value":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"storefront_visible":{"type":"boolean"},"custom_field_definition_id":{"type":"string"}},"required":["id","label","type","field_type","key","value","created_at","updated_at","storefront_visible","custom_field_definition_id"],"x-typelizer":true},"CustomerGroup":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"customers_count":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"customers":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}}},"required":["id","name","description","customers_count","created_at","updated_at"],"x-typelizer":true},"Customer":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"accepts_email_marketing":{"type":"boolean"},"full_name":{"type":"string"},"available_store_credit_total":{"type":"string"},"display_available_store_credit_total":{"type":"string"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"default_billing_address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"nullable":true},"default_shipping_address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"nullable":true},"newsletter_subscriber":{"allOf":[{"$ref":"#/components/schemas/NewsletterSubscriber"}],"nullable":true},"customer_groups":{"type":"array","items":{"$ref":"#/components/schemas/CustomerGroup"}},"failed_attempts":{"type":"number"},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"internal_note":{"type":"string","nullable":true},"internal_note_html":{"type":"string","nullable":true},"default_billing_address_id":{"type":"string","nullable":true},"default_shipping_address_id":{"type":"string","nullable":true},"orders_count":{"type":"number"},"total_spent":{"type":"string"},"display_total_spent":{"type":"string"},"last_order_completed_at":{"type":"string","nullable":true},"orders":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"store_credits":{"type":"array","items":{"$ref":"#/components/schemas/StoreCredit"}},"customer_group_ids":{"type":"array","items":{"type":"string"}}},"required":["id","email","first_name","last_name","phone","accepts_email_marketing","full_name","available_store_credit_total","display_available_store_credit_total","failed_attempts","metadata","created_at","updated_at","tags","internal_note","internal_note_html","default_billing_address_id","default_shipping_address_id","orders_count","total_spent","display_total_spent","last_order_completed_at","customer_group_ids"],"x-typelizer":true},"DeliveryMethodRule":{"type":"object","properties":{"id":{"type":"string"},"active":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"preferences":{"type":"object"},"preference_schema":{"type":"object"},"product_ids":{"type":"array","items":{"type":"string"}}},"required":["id","active","created_at","updated_at","type","name","description","preferences","preference_schema","product_ids"],"x-typelizer":true},"DeliveryMethod":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"code":{"type":"string","nullable":true},"estimated_transit_business_days_min":{"type":"number","nullable":true},"estimated_transit_business_days_max":{"type":"number","nullable":true},"digital":{"type":"boolean"},"pickup":{"type":"boolean"},"pickup_point":{"type":"boolean"},"admin_name":{"type":"string","nullable":true},"fulfillment_provider":{"type":"string"},"pickup_point_provider":{"type":"string","nullable":true},"rate_provider":{"type":"string","nullable":true},"storefront_visible":{"type":"boolean"},"tracking_url":{"type":"string","nullable":true},"markup_flat":{"type":"string","nullable":true},"markup_percent":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"services":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryMethodService"}},"rules":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryMethodRule"}},"tax_category_id":{"type":"string","nullable":true},"delivery_profile_id":{"type":"string"},"delivery_origin_group_id":{"type":"string","nullable":true},"delivery_zone_id":{"type":"string","nullable":true},"stock_location_ids":{"type":"array","items":{"type":"string"}},"calculator_type":{"type":"string","nullable":true},"calculator_preferences":{"type":"object","nullable":true}},"required":["id","name","code","estimated_transit_business_days_min","estimated_transit_business_days_max","digital","pickup","pickup_point","admin_name","fulfillment_provider","pickup_point_provider","rate_provider","storefront_visible","tracking_url","markup_flat","markup_percent","created_at","updated_at","deleted_at","services","rules","tax_category_id","delivery_profile_id","delivery_origin_group_id","delivery_zone_id","stock_location_ids","calculator_type","calculator_preferences"],"x-typelizer":true},"DeliveryMethodService":{"type":"object","properties":{"id":{"type":"string"},"carrier":{"type":"string"},"service":{"type":"string"},"label":{"type":"string","nullable":true},"markup_flat":{"type":"string","nullable":true},"markup_percent":{"type":"string","nullable":true},"position":{"type":"number"}},"required":["id","carrier","service","label","markup_flat","markup_percent","position"],"x-typelizer":true},"DeliveryOriginGroup":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"position":{"type":"number","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"delivery_profile_id":{"type":"string"},"stock_location_ids":{"type":"array","items":{"type":"string"}},"delivery_zones_count":{"type":"number"},"delivery_methods_count":{"type":"number"}},"required":["id","name","position","created_at","updated_at","delivery_profile_id","stock_location_ids","delivery_zones_count","delivery_methods_count"],"x-typelizer":true},"DeliveryProfile":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"default":{"type":"boolean"},"position":{"type":"number","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"kind":{"type":"string"},"digital":{"type":"boolean"},"offers_pickup":{"type":"boolean"},"offers_shipping":{"type":"boolean"},"stock_location_ids":{"type":"array","items":{"type":"string"}},"origin_groups":{"type":"object"},"products_count":{"type":"number"},"delivery_methods_count":{"type":"number"},"delivery_zones_count":{"type":"number"}},"required":["id","name","default","position","created_at","updated_at","kind","digital","offers_pickup","offers_shipping","stock_location_ids","origin_groups","products_count","delivery_methods_count","delivery_zones_count"],"x-typelizer":true},"DeliveryRate":{"type":"object","properties":{"id":{"type":"string"},"delivery_method_id":{"type":"string"},"name":{"type":"string"},"selected":{"type":"boolean"},"cost":{"type":"string"},"total":{"type":"string"},"additional_tax_total":{"type":"string"},"included_tax_total":{"type":"string"},"tax_total":{"type":"string"},"carrier":{"type":"string","nullable":true},"service_level":{"type":"string","nullable":true},"estimated_delivery_date":{"type":"string","nullable":true},"display_cost":{"type":"string"},"display_total":{"type":"string"},"display_additional_tax_total":{"type":"string"},"display_included_tax_total":{"type":"string"},"display_tax_total":{"type":"string"},"delivery_method":{"$ref":"#/components/schemas/DeliveryMethod"},"metadata":{"type":"object","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","delivery_method_id","name","selected","cost","total","additional_tax_total","included_tax_total","tax_total","carrier","service_level","estimated_delivery_date","display_cost","display_total","display_additional_tax_total","display_included_tax_total","display_tax_total","metadata","created_at","updated_at"],"x-typelizer":true},"DeliveryZoneMember":{"type":"object","properties":{"id":{"type":"string"},"member_type":{"type":"string"},"country_code":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true},"postal_code_prefix":{"type":"string","nullable":true},"postal_code_from":{"type":"string","nullable":true},"postal_code_to":{"type":"string","nullable":true},"country_name":{"type":"string","nullable":true},"state_name":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","member_type","country_code","state_code","postal_code_prefix","postal_code_from","postal_code_to","country_name","state_name","created_at","updated_at"],"x-typelizer":true},"DeliveryZone":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"members":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryZoneMember"}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"delivery_profile_id":{"type":"string"},"delivery_origin_group_id":{"type":"string","nullable":true},"delivery_method_ids":{"type":"array","items":{"type":"string"}}},"required":["id","name","description","created_at","updated_at","delivery_profile_id","delivery_origin_group_id","delivery_method_ids"],"x-typelizer":true},"DigitalLink":{"type":"object","properties":{"id":{"type":"string"},"access_counter":{"type":"number"},"filename":{"type":"string"},"content_type":{"type":"string"},"download_url":{"type":"string"},"authorizable":{"type":"boolean"},"expired":{"type":"boolean"},"access_limit_exceeded":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","access_counter","filename","content_type","download_url","authorizable","expired","access_limit_exceeded","created_at","updated_at"],"x-typelizer":true},"Discount":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"kind":{"type":"string"},"code":{"type":"string","nullable":true},"value_type":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"promotion_id":{"type":"string","nullable":true},"line_item_id":{"type":"string","nullable":true},"fulfillment_id":{"type":"string","nullable":true},"amount":{"type":"string"},"display_amount":{"type":"string"},"metadata":{"type":"object","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","label","kind","code","value_type","value","promotion_id","line_item_id","fulfillment_id","amount","display_amount","metadata","created_at","updated_at"],"x-typelizer":true},"ExchangeLineItem":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"number"},"received_quantity":{"type":"number"},"resellable":{"type":"boolean"},"original_price":{"type":"string"},"new_variant_price":{"type":"string"},"price_difference":{"type":"string"},"original_variant_id":{"type":"string","nullable":true},"new_variant_id":{"type":"string","nullable":true},"line_item_id":{"type":"string","nullable":true},"fulfillment_item_id":{"type":"string","nullable":true},"original_variant":{"$ref":"#/components/schemas/Variant"},"new_variant":{"$ref":"#/components/schemas/Variant"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","quantity","received_quantity","resellable","original_price","new_variant_price","price_difference","original_variant_id","new_variant_id","line_item_id","fulfillment_item_id","created_at","updated_at"],"x-typelizer":true},"Exchange":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"status":{"type":"string"},"order_id":{"type":"string","nullable":true},"reason_id":{"type":"string","nullable":true},"price_difference":{"type":"string"},"display_price_difference":{"type":"string"},"approved_at":{"type":"string","nullable":true},"received_at":{"type":"string","nullable":true},"fulfilled_at":{"type":"string","nullable":true},"canceled_at":{"type":"string","nullable":true},"reason":{"$ref":"#/components/schemas/ReturnReason"},"exchange_line_items":{"type":"array","items":{"$ref":"#/components/schemas/ExchangeLineItem"}},"memo":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"stock_location_id":{"type":"string","nullable":true},"created_by_id":{"type":"string","nullable":true},"order":{"$ref":"#/components/schemas/Order"},"stock_location":{"$ref":"#/components/schemas/StockLocation"},"refunds":{"type":"array","items":{"$ref":"#/components/schemas/Refund"}}},"required":["id","number","status","order_id","reason_id","price_difference","display_price_difference","approved_at","received_at","fulfilled_at","canceled_at","memo","metadata","created_at","updated_at","stock_location_id","created_by_id"],"x-typelizer":true},"Export":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"format":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"type":{"type":"string","nullable":true},"user_id":{"type":"string","nullable":true},"done":{"type":"boolean"},"filename":{"type":"string","nullable":true},"byte_size":{"type":"number","nullable":true},"download_url":{"type":"string","nullable":true}},"required":["id","number","format","created_at","updated_at","type","user_id","done","filename","byte_size","download_url"],"x-typelizer":true},"Fee":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"kind":{"type":"string"},"line_item_id":{"type":"string","nullable":true},"fulfillment_id":{"type":"string","nullable":true},"amount":{"type":"string"},"display_amount":{"type":"string"},"metadata":{"type":"object","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","label","kind","line_item_id","fulfillment_id","amount","display_amount","metadata","created_at","updated_at"],"x-typelizer":true},"FulfillmentItem":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"number"},"status":{"type":"string"},"variant_id":{"type":"string","nullable":true},"line_item_id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"options_text":{"type":"string","nullable":true}},"required":["id","quantity","status","variant_id","line_item_id","name","options_text"],"x-typelizer":true},"Fulfillment":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"tracking":{"type":"string","nullable":true},"tracking_url":{"type":"string","nullable":true},"tracking_carrier":{"type":"string","nullable":true},"tracking_carrier_name":{"type":"string","nullable":true},"pickup_point_data":{"type":"object","nullable":true},"selected_delivery_rate_id":{"type":"string","nullable":true},"cost":{"type":"string"},"display_cost":{"type":"string"},"total":{"type":"string"},"display_total":{"type":"string"},"discount_total":{"type":"string"},"display_discount_total":{"type":"string"},"additional_tax_total":{"type":"string"},"display_additional_tax_total":{"type":"string"},"included_tax_total":{"type":"string"},"display_included_tax_total":{"type":"string"},"tax_total":{"type":"string"},"display_tax_total":{"type":"string"},"status":{"type":"string"},"fulfillment_type":{"type":"string"},"fulfilled_at":{"type":"string","nullable":true},"tracking_status":{"type":"string","nullable":true},"estimated_delivery_at":{"type":"string","nullable":true},"delivered_at":{"type":"string","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentManifestItem"}},"delivery_method":{"$ref":"#/components/schemas/DeliveryMethod"},"stock_location":{"$ref":"#/components/schemas/StockLocation"},"delivery_rates":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryRate"}},"tax_lines":{"type":"array","items":{"$ref":"#/components/schemas/TaxLine"}},"metadata":{"type":"object"},"tracking_details":{"type":"object","nullable":true},"adjustment_total":{"type":"string"},"pre_tax_amount":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"order_id":{"type":"string","nullable":true},"stock_location_id":{"type":"string","nullable":true},"documents":{"type":"object"},"provider_generates_labels":{"type":"boolean"},"fulfillment_items":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentItem"}},"order":{"$ref":"#/components/schemas/Order"}},"required":["id","number","tracking","tracking_url","tracking_carrier","tracking_carrier_name","pickup_point_data","selected_delivery_rate_id","cost","display_cost","total","display_total","discount_total","display_discount_total","additional_tax_total","display_additional_tax_total","included_tax_total","display_included_tax_total","tax_total","display_tax_total","status","fulfillment_type","fulfilled_at","tracking_status","estimated_delivery_at","delivered_at","items","metadata","tracking_details","adjustment_total","pre_tax_amount","created_at","updated_at","order_id","stock_location_id","documents","provider_generates_labels"],"x-typelizer":true},"GiftCardBatch":{"type":"object","properties":{"id":{"type":"string"},"codes_count":{"type":"number"},"currency":{"type":"string","nullable":true},"prefix":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"amount":{"type":"string","nullable":true},"expires_at":{"type":"string","nullable":true},"created_by_id":{"type":"string","nullable":true}},"required":["id","codes_count","currency","prefix","created_at","updated_at","amount","expires_at","created_by_id"],"x-typelizer":true},"GiftCard":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"status":{"type":"string"},"currency":{"type":"string"},"amount":{"type":"string"},"amount_used":{"type":"string"},"amount_authorized":{"type":"string"},"amount_remaining":{"type":"string"},"display_amount":{"type":"string"},"display_amount_used":{"type":"string"},"display_amount_remaining":{"type":"string"},"expires_at":{"type":"string","nullable":true},"redeemed_at":{"type":"string","nullable":true},"expired":{"type":"boolean"},"active":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"customer_id":{"type":"string","nullable":true},"created_by_id":{"type":"string","nullable":true},"customer":{"$ref":"#/components/schemas/Customer"},"created_by":{"$ref":"#/components/schemas/AdminUser"},"gift_card_batch":{"$ref":"#/components/schemas/GiftCardBatch"},"orders":{"type":"array","items":{"$ref":"#/components/schemas/Order"}}},"required":["id","code","status","currency","amount","amount_used","amount_authorized","amount_remaining","display_amount","display_amount_used","display_amount_remaining","expires_at","redeemed_at","expired","active","created_at","updated_at","customer_id","created_by_id"],"x-typelizer":true},"ImportMapping":{"type":"object","properties":{"id":{"type":"string"},"schema_field":{"type":"string"},"file_column":{"type":"string","nullable":true},"required":{"type":"boolean"}},"required":["id","schema_field","file_column","required"],"x-typelizer":true},"ImportRow":{"type":"object","properties":{"id":{"type":"string"},"row_number":{"type":"number"},"status":{"type":"string"},"validation_errors":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"import_id":{"type":"string","nullable":true},"item_type":{"type":"string","nullable":true},"item_id":{"type":"string","nullable":true},"data":{"type":"object"}},"required":["id","row_number","status","validation_errors","created_at","updated_at","import_id","item_type","item_id","data"],"x-typelizer":true},"Import":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"rows_count":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"type":{"type":"string","nullable":true},"status":{"type":"string"},"owner_type":{"type":"string","nullable":true},"owner_id":{"type":"string","nullable":true},"user_id":{"type":"string","nullable":true},"processing_errors":{"type":"string","nullable":true},"preferred_delimiter":{"type":"string"},"original_filename":{"type":"string","nullable":true},"original_byte_size":{"type":"number","nullable":true},"original_file_url":{"type":"string","nullable":true},"completed_rows_count":{"type":"number"},"failed_rows_count":{"type":"number"},"schema_fields":{"type":"array","items":{"$ref":"#/components/schemas/ImportSchemaField"}},"csv_headers":{"type":"array","items":{"type":"string"}},"sample_row":{"type":"object"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/ImportMapping"}}},"required":["id","number","rows_count","created_at","updated_at","type","status","owner_type","owner_id","user_id","processing_errors","preferred_delimiter","original_filename","original_byte_size","original_file_url","completed_rows_count","failed_rows_count","schema_fields","csv_headers","sample_row","mappings"],"x-typelizer":true},"Integration":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"active":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"type":{"type":"string"},"group":{"type":"string","nullable":true},"preferences":{"type":"object"},"preference_schema":{"type":"object"}},"required":["id","name","active","created_at","updated_at","type","group","preferences","preference_schema"],"x-typelizer":true},"Invitation":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"status":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"expires_at":{"type":"string"},"role_id":{"type":"string"},"role_name":{"type":"string"},"inviter_email":{"type":"string"},"acceptance_url":{"type":"string"},"invitee_exists":{"type":"boolean"},"store":{"type":"object"}},"required":["id","email","status","created_at","updated_at","expires_at","role_id","role_name","inviter_email","acceptance_url","invitee_exists","store"],"x-typelizer":true},"LineItem":{"type":"object","properties":{"id":{"type":"string"},"variant_id":{"type":"string"},"seller_id":{"type":"string","nullable":true},"preorder":{"type":"boolean"},"preorder_ships_at":{"type":"string","nullable":true},"quantity":{"type":"number"},"currency":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"options_text":{"type":"string"},"price":{"type":"string"},"display_price":{"type":"string"},"total":{"type":"string"},"display_total":{"type":"string"},"adjustment_total":{"type":"string"},"display_adjustment_total":{"type":"string"},"additional_tax_total":{"type":"string"},"display_additional_tax_total":{"type":"string"},"included_tax_total":{"type":"string"},"display_included_tax_total":{"type":"string"},"discount_total":{"type":"string"},"display_discount_total":{"type":"string"},"pre_tax_amount":{"type":"string"},"display_pre_tax_amount":{"type":"string"},"discounted_amount":{"type":"string"},"display_discounted_amount":{"type":"string"},"display_compare_at_amount":{"type":"string","nullable":true},"compare_at_amount":{"type":"string","nullable":true},"thumbnail_url":{"type":"string","nullable":true},"seller":{"$ref":"#/components/schemas/Seller"},"option_values":{"type":"array","items":{"$ref":"#/components/schemas/OptionValue"}},"digital_links":{"type":"array","items":{"$ref":"#/components/schemas/DigitalLink"}},"tax_lines":{"type":"array","items":{"$ref":"#/components/schemas/TaxLine"}},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"cost_price":{"type":"string","nullable":true},"tax_category_id":{"type":"string","nullable":true},"variant":{"$ref":"#/components/schemas/Variant"},"tax_category":{"$ref":"#/components/schemas/TaxCategory"}},"required":["id","variant_id","seller_id","preorder","preorder_ships_at","quantity","currency","name","slug","options_text","price","display_price","total","display_total","adjustment_total","display_adjustment_total","additional_tax_total","display_additional_tax_total","included_tax_total","display_included_tax_total","discount_total","display_discount_total","pre_tax_amount","display_pre_tax_amount","discounted_amount","display_discounted_amount","display_compare_at_amount","compare_at_amount","thumbnail_url","option_values","digital_links","metadata","created_at","updated_at","cost_price","tax_category_id"],"x-typelizer":true},"Market":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"currency":{"type":"string"},"default_locale":{"type":"string"},"tax_inclusive":{"type":"boolean"},"default":{"type":"boolean"},"country_codes":{"type":"array","items":{"type":"string"}},"supported_locales":{"type":"array","items":{"type":"string"}},"countries":{"type":"array","items":{"$ref":"#/components/schemas/Country"}},"tax_provider":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","name","currency","default_locale","tax_inclusive","default","country_codes","supported_locales","tax_provider","created_at","updated_at"],"x-typelizer":true},"Media":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string","nullable":true},"variant_ids":{"type":"array","items":{"type":"string"}},"position":{"type":"number"},"alt":{"type":"string","nullable":true},"media_type":{"type":"string"},"focal_point_x":{"type":"number","nullable":true},"focal_point_y":{"type":"number","nullable":true},"external_video_url":{"type":"string","nullable":true},"video_provider":{"type":"string","nullable":true},"video_embed_url":{"type":"string","nullable":true},"video_url":{"type":"string","nullable":true},"poster_url":{"type":"string","nullable":true},"original_url":{"type":"string","nullable":true},"mini_url":{"type":"string","nullable":true},"small_url":{"type":"string","nullable":true},"medium_url":{"type":"string","nullable":true},"large_url":{"type":"string","nullable":true},"xlarge_url":{"type":"string","nullable":true},"og_image_url":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"viewable_id":{"type":"string"},"download_url":{"type":"string","nullable":true},"metadata":{"type":"object"},"viewable_type":{"type":"string"}},"required":["id","product_id","variant_ids","position","alt","media_type","focal_point_x","focal_point_y","external_video_url","video_provider","video_embed_url","video_url","poster_url","original_url","mini_url","small_url","medium_url","large_url","xlarge_url","og_image_url","created_at","updated_at","viewable_id","download_url","metadata","viewable_type"],"x-typelizer":true},"NewsletterSubscriber":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"verified":{"type":"boolean"},"verified_at":{"type":"string","nullable":true},"customer_id":{"type":"string","nullable":true}},"required":["id","email","created_at","updated_at","verified","verified_at","customer_id"],"x-typelizer":true},"OptionType":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"label":{"type":"string"},"position":{"type":"number"},"kind":{"type":"string"},"translations":{"type":"object"},"metadata":{"type":"object"},"filterable":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"option_values":{"type":"array","items":{"$ref":"#/components/schemas/OptionValue"}}},"required":["id","name","label","position","kind","metadata","filterable","created_at","updated_at"],"x-typelizer":true},"OptionValue":{"type":"object","properties":{"id":{"type":"string"},"option_type_id":{"type":"string"},"name":{"type":"string"},"label":{"type":"string"},"position":{"type":"number"},"color_code":{"type":"string","nullable":true},"option_type_name":{"type":"string"},"option_type_label":{"type":"string"},"image_url":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"option_type":{"$ref":"#/components/schemas/OptionType"}},"required":["id","option_type_id","name","label","position","color_code","option_type_name","option_type_label","image_url","metadata","created_at","updated_at"],"x-typelizer":true},"OrderRoutingRule":{"type":"object","properties":{"id":{"type":"string"},"position":{"type":"number"},"active":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"type":{"type":"string"},"channel_id":{"type":"string"},"preferences":{"type":"object"},"preference_schema":{"type":"object"},"label":{"type":"string"},"description":{"type":"string"}},"required":["id","position","active","created_at","updated_at","type","channel_id","preferences","preference_schema","label","description"],"x-typelizer":true},"Order":{"type":"object","properties":{"id":{"type":"string"},"market_id":{"type":"string","nullable":true},"cart_id":{"type":"string","nullable":true},"channel_id":{"type":"string","nullable":true},"number":{"type":"string"},"email":{"type":"string"},"customer_note":{"type":"string","nullable":true},"currency":{"type":"string"},"locale":{"type":"string","nullable":true},"total_quantity":{"type":"number"},"coupon_code":{"type":"string","nullable":true},"fulfillment_status":{"type":"string","nullable":true},"payment_status":{"type":"string","nullable":true},"completed_at":{"type":"string","nullable":true},"item_total":{"type":"string"},"display_item_total":{"type":"string"},"adjustment_total":{"type":"string"},"display_adjustment_total":{"type":"string"},"discount_total":{"type":"string"},"display_discount_total":{"type":"string"},"tax_total":{"type":"string"},"display_tax_total":{"type":"string"},"included_tax_total":{"type":"string"},"display_included_tax_total":{"type":"string"},"additional_tax_total":{"type":"string"},"display_additional_tax_total":{"type":"string"},"total":{"type":"string"},"display_total":{"type":"string"},"gift_card_total":{"type":"string"},"display_gift_card_total":{"type":"string"},"amount_due":{"type":"string"},"display_amount_due":{"type":"string"},"delivery_total":{"type":"string"},"display_delivery_total":{"type":"string"},"fee_total":{"type":"string"},"display_fee_total":{"type":"string"},"store_credit_total":{"type":"string"},"display_store_credit_total":{"type":"string"},"covered_by_store_credit":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"fulfillments":{"type":"array","items":{"$ref":"#/components/schemas/Fulfillment"}},"payments":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}},"billing_address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"nullable":true},"shipping_address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"nullable":true},"gift_card":{"allOf":[{"$ref":"#/components/schemas/GiftCard"}],"nullable":true},"market":{"allOf":[{"$ref":"#/components/schemas/Market"}],"nullable":true},"status":{"type":"string"},"last_ip_address":{"type":"string","nullable":true},"considered_risky":{"type":"boolean"},"confirmation_delivered":{"type":"boolean"},"store_owner_notification_delivered":{"type":"boolean"},"payment_total":{"type":"string"},"display_payment_total":{"type":"string"},"metadata":{"type":"object"},"canceled_at":{"type":"string","nullable":true},"approved_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"preferred_stock_location_id":{"type":"string","nullable":true},"company_location_id":{"type":"string","nullable":true},"company_id":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"}},"internal_note":{"type":"string","nullable":true},"internal_note_html":{"type":"string","nullable":true},"approver_id":{"type":"string","nullable":true},"canceler_id":{"type":"string","nullable":true},"created_by_id":{"type":"string","nullable":true},"customer_id":{"type":"string","nullable":true},"applied_promotions":{"type":"array","items":{"$ref":"#/components/schemas/AppliedPromotion"}},"cart":{"$ref":"#/components/schemas/Cart"},"channel":{"$ref":"#/components/schemas/Channel"},"preferred_stock_location":{"$ref":"#/components/schemas/StockLocation"},"payment_methods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"customer":{"$ref":"#/components/schemas/Customer"},"approver":{"$ref":"#/components/schemas/Customer"},"canceler":{"$ref":"#/components/schemas/Customer"},"created_by":{"$ref":"#/components/schemas/Customer"},"returns":{"type":"array","items":{"$ref":"#/components/schemas/Return"}},"exchanges":{"type":"array","items":{"$ref":"#/components/schemas/Exchange"}},"claims":{"type":"array","items":{"$ref":"#/components/schemas/Claim"}}},"required":["id","market_id","cart_id","channel_id","number","email","customer_note","currency","locale","total_quantity","coupon_code","fulfillment_status","payment_status","completed_at","item_total","display_item_total","adjustment_total","display_adjustment_total","discount_total","display_discount_total","tax_total","display_tax_total","included_tax_total","display_included_tax_total","additional_tax_total","display_additional_tax_total","total","display_total","gift_card_total","display_gift_card_total","amount_due","display_amount_due","delivery_total","display_delivery_total","fee_total","display_fee_total","store_credit_total","display_store_credit_total","covered_by_store_credit","gift_card","market","status","last_ip_address","considered_risky","confirmation_delivered","store_owner_notification_delivered","payment_total","display_payment_total","metadata","canceled_at","approved_at","created_at","updated_at","preferred_stock_location_id","company_location_id","company_id","tags","internal_note","internal_note_html","approver_id","canceler_id","created_by_id","customer_id"],"x-typelizer":true},"PaymentMethod":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"type":{"type":"string"},"session_required":{"type":"boolean"},"source_required":{"type":"boolean"},"metadata":{"type":"object"},"active":{"type":"boolean"},"auto_capture":{"type":"boolean","nullable":true},"capture_method":{"type":"string","enum":["checkout","on_dispatch","manual"],"nullable":true},"resolved_capture_method":{"type":"string","enum":["checkout","on_dispatch","manual"]},"storefront_visible":{"type":"boolean"},"position":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"preferences":{"type":"object"},"preference_schema":{"type":"object"}},"required":["id","name","description","type","session_required","source_required","metadata","active","auto_capture","capture_method","resolved_capture_method","storefront_visible","position","created_at","updated_at","preferences","preference_schema"],"x-typelizer":true},"Payment":{"type":"object","properties":{"id":{"type":"string"},"payment_method_id":{"type":"string"},"response_code":{"type":"string","nullable":true},"number":{"type":"string"},"status":{"type":"string"},"amount":{"type":"string"},"display_amount":{"type":"string"},"source_type":{"type":"string","nullable":true,"enum":["credit_card","store_credit","payment_source"]},"source_id":{"type":"string","nullable":true},"source":{"anyOf":[{"$ref":"#/components/schemas/CreditCard"},{"$ref":"#/components/schemas/StoreCredit"},{"$ref":"#/components/schemas/PaymentSource"}],"nullable":true},"payment_method":{"$ref":"#/components/schemas/PaymentMethod"},"metadata":{"type":"object"},"avs_response":{"type":"string","nullable":true},"cvv_response_code":{"type":"string","nullable":true},"cvv_response_message":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"captured_amount":{"type":"string"},"order_id":{"type":"string","nullable":true},"order":{"$ref":"#/components/schemas/Order"},"refunds":{"type":"array","items":{"$ref":"#/components/schemas/Refund"}}},"required":["id","payment_method_id","response_code","number","status","amount","display_amount","source_type","source_id","source","metadata","avs_response","cvv_response_code","cvv_response_message","created_at","updated_at","captured_amount","order_id"],"x-typelizer":true},"PaymentSource":{"type":"object","properties":{"id":{"type":"string"},"gateway_payment_profile_id":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","gateway_payment_profile_id","metadata","created_at","updated_at"],"x-typelizer":true},"Permission":{"type":"object","properties":{"key":{"type":"string"},"resource":{"type":"string"},"kind":{"type":"string"},"group":{"type":"string"},"group_label":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}},"required":["key","resource","kind","group","group_label","label","description"],"x-typelizer":true},"PriceHistory":{"type":"object","properties":{"id":{"type":"string"},"amount":{"type":"string"},"amount_in_cents":{"type":"number"},"currency":{"type":"string"},"display_amount":{"type":"string"},"recorded_at":{"type":"string"},"variant_id":{"type":"string"},"price_id":{"type":"string"},"compare_at_amount":{"type":"string","nullable":true},"created_at":{"type":"string"}},"required":["id","amount","amount_in_cents","currency","display_amount","recorded_at","variant_id","price_id","compare_at_amount","created_at"],"x-typelizer":true},"PriceList":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"status":{"type":"string"},"position":{"type":"number"},"match_policy":{"type":"string"},"starts_at":{"type":"string","nullable":true},"ends_at":{"type":"string","nullable":true},"deleted_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"currently_active":{"type":"boolean"},"products_count":{"type":"number"},"prices_count":{"type":"number"},"product_ids":{"type":"array","items":{"type":"string"}},"price_rules":{"type":"array","items":{"$ref":"#/components/schemas/PriceRule"}}},"required":["id","name","description","status","position","match_policy","starts_at","ends_at","deleted_at","created_at","updated_at","currently_active","products_count","prices_count","product_ids"],"x-typelizer":true},"PriceRule":{"type":"object","properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"type":{"type":"string"},"price_list_id":{"type":"string"},"preferences":{"type":"object"},"preference_schema":{"type":"array","items":{"$ref":"#/components/schemas/PreferenceField"}},"label":{"type":"string"},"description":{"type":"string","nullable":true},"markets":{"type":"array","items":{"$ref":"#/components/schemas/Market"}},"customer_groups":{"type":"array","items":{"$ref":"#/components/schemas/CustomerGroup"}},"channels":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}},"customers":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}}},"required":["id","created_at","updated_at","type","price_list_id","preferences","preference_schema","label","description"],"x-typelizer":true},"Price":{"type":"object","properties":{"id":{"type":"string"},"amount":{"type":"string","nullable":true},"amount_in_cents":{"type":"number","nullable":true},"compare_at_amount":{"type":"string","nullable":true},"compare_at_amount_in_cents":{"type":"number","nullable":true},"currency":{"type":"string","nullable":true},"display_amount":{"type":"string","nullable":true},"display_compare_at_amount":{"type":"string","nullable":true},"price_list_id":{"type":"string","nullable":true},"variant_id":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"variant":{"$ref":"#/components/schemas/Variant"}},"required":["id","amount","amount_in_cents","compare_at_amount","compare_at_amount_in_cents","currency","display_amount","display_compare_at_amount","price_list_id","variant_id","created_at","updated_at"],"x-typelizer":true},"ProductPublication":{"type":"object","properties":{"id":{"type":"string"},"published_at":{"type":"string","nullable":true},"unpublished_at":{"type":"string","nullable":true},"product_id":{"type":"string"},"channel_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","published_at","unpublished_at","product_id","channel_id","created_at","updated_at"],"x-typelizer":true},"Product":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"meta_title":{"type":"string","nullable":true},"meta_description":{"type":"string","nullable":true},"meta_keywords":{"type":"string","nullable":true},"variant_count":{"type":"number"},"available_on":{"type":"string","nullable":true},"preorder_ships_at":{"type":"string","nullable":true},"purchasable":{"type":"boolean"},"preorder":{"type":"boolean"},"in_stock":{"type":"boolean"},"backorderable":{"type":"boolean"},"available":{"type":"boolean"},"description":{"type":"string","nullable":true},"description_html":{"type":"string","nullable":true},"default_variant_id":{"type":"string"},"buy_box_variant_id":{"type":"string","nullable":true},"thumbnail_url":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"}},"price":{"allOf":[{"$ref":"#/components/schemas/Price"}],"nullable":true},"original_price":{"allOf":[{"$ref":"#/components/schemas/Price"}],"nullable":true},"seller_id":{"type":"string","nullable":true},"seller":{"$ref":"#/components/schemas/Seller"},"primary_media":{"$ref":"#/components/schemas/Media"},"media":{"type":"array","items":{"$ref":"#/components/schemas/Media"}},"variants":{"type":"array","items":{"$ref":"#/components/schemas/Variant"}},"default_variant":{"$ref":"#/components/schemas/Variant"},"option_types":{"type":"array","items":{"$ref":"#/components/schemas/OptionType"}},"option_values":{"type":"array","items":{"$ref":"#/components/schemas/OptionValue"}},"categories":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"prior_price":{"allOf":[{"$ref":"#/components/schemas/PriceHistory"}],"nullable":true},"translations":{"type":"object"},"status":{"type":"string"},"metadata":{"type":"object"},"deleted_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"delivery_profile_id":{"type":"string","nullable":true},"seller_name":{"type":"string","nullable":true},"product_type_id":{"type":"string","nullable":true},"tax_category_id":{"type":"string","nullable":true},"collections":{"type":"array","items":{"$ref":"#/components/schemas/Collection"}},"product_publications":{"type":"array","items":{"$ref":"#/components/schemas/ProductPublication"}},"channels":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}},"product_type":{"$ref":"#/components/schemas/ProductType"}},"required":["id","name","slug","meta_title","meta_description","meta_keywords","variant_count","available_on","preorder_ships_at","purchasable","preorder","in_stock","backorderable","available","description","description_html","default_variant_id","buy_box_variant_id","thumbnail_url","tags","price","original_price","seller_id","status","metadata","deleted_at","created_at","updated_at","delivery_profile_id","seller_name","product_type_id","tax_category_id"],"x-typelizer":true},"ProductTypeCustomFieldDefinition":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"namespace":{"type":"string"},"label":{"type":"string"},"field_type":{"type":"string","enum":["short_text","long_text","rich_text","number","boolean","json"]},"required":{"type":"boolean"},"sort_order":{"type":"number"}},"required":["id","key","namespace","label","field_type","required","sort_order"],"x-typelizer":true},"ProductType":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"translations":{"type":"object"},"products_count":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"delivery_profile_id":{"type":"string","nullable":true},"option_type_ids":{"type":"array","items":{"type":"string"}},"category_ids":{"type":"array","items":{"type":"string"}},"custom_field_definitions":{"type":"array","items":{"$ref":"#/components/schemas/ProductTypeCustomFieldDefinition"}}},"required":["id","name","products_count","created_at","updated_at","delivery_profile_id","option_type_ids","category_ids","custom_field_definitions"],"x-typelizer":true},"PromotionAction":{"type":"object","properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"type":{"type":"string"},"promotion_id":{"type":"string"},"preferences":{"type":"object"},"preference_schema":{"type":"array","items":{"$ref":"#/components/schemas/PreferenceField"}},"label":{"type":"string"},"calculator":{"allOf":[{"$ref":"#/components/schemas/PromotionActionCalculator"}],"nullable":true},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/PromotionActionLineItem"},"nullable":true}},"required":["id","created_at","updated_at","type","promotion_id","preferences","preference_schema","label","calculator","line_items"],"x-typelizer":true},"PromotionRule":{"type":"object","properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"type":{"type":"string"},"promotion_id":{"type":"string"},"preferences":{"type":"object"},"preference_schema":{"type":"array","items":{"$ref":"#/components/schemas/PreferenceField"}},"label":{"type":"string"},"product_ids":{"type":"array","items":{"type":"string"},"nullable":true},"category_ids":{"type":"array","items":{"type":"string"},"nullable":true},"customer_ids":{"type":"array","items":{"type":"string"},"nullable":true},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"categories":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"customers":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}},"customer_groups":{"type":"array","items":{"$ref":"#/components/schemas/CustomerGroup"}},"countries":{"type":"array","items":{"$ref":"#/components/schemas/Country"}},"channels":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}},"markets":{"type":"array","items":{"$ref":"#/components/schemas/Market"}}},"required":["id","created_at","updated_at","type","promotion_id","preferences","preference_schema","label","product_ids","category_ids","customer_ids"],"x-typelizer":true},"Promotion":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"starts_at":{"type":"string","nullable":true},"expires_at":{"type":"string","nullable":true},"usage_limit":{"type":"number","nullable":true},"match_policy":{"type":"string","enum":["all","any"]},"path":{"type":"string","nullable":true},"kind":{"type":"string","enum":["coupon_code","automatic"]},"multi_codes":{"type":"boolean"},"number_of_codes":{"type":"number","nullable":true},"code_prefix":{"type":"string","nullable":true},"promotion_category_id":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"action_ids":{"type":"array","items":{"type":"string"}},"rule_ids":{"type":"array","items":{"type":"string"}}},"required":["id","name","description","code","starts_at","expires_at","usage_limit","match_policy","path","kind","multi_codes","number_of_codes","code_prefix","promotion_category_id","metadata","created_at","updated_at","action_ids","rule_ids"],"x-typelizer":true},"RefundReason":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"active":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"can_be_deleted":{"type":"boolean"}},"required":["id","name","active","created_at","updated_at","can_be_deleted"],"x-typelizer":true},"Refund":{"type":"object","properties":{"id":{"type":"string"},"transaction_id":{"type":"string","nullable":true},"amount":{"type":"string","nullable":true},"payment_id":{"type":"string","nullable":true},"refund_reason_id":{"type":"string","nullable":true},"originator_id":{"type":"string","nullable":true},"originator_type":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"payment":{"$ref":"#/components/schemas/Payment"}},"required":["id","transaction_id","amount","payment_id","refund_reason_id","originator_id","originator_type","metadata","created_at","updated_at"],"x-typelizer":true},"ReturnLineItem":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"number"},"received_quantity":{"type":"number"},"resellable":{"type":"boolean"},"pre_tax_amount":{"type":"string"},"display_pre_tax_amount":{"type":"string"},"variant_id":{"type":"string","nullable":true},"line_item_id":{"type":"string","nullable":true},"fulfillment_item_id":{"type":"string","nullable":true},"variant":{"$ref":"#/components/schemas/Variant"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"line_item":{"$ref":"#/components/schemas/LineItem"}},"required":["id","quantity","received_quantity","resellable","pre_tax_amount","display_pre_tax_amount","variant_id","line_item_id","fulfillment_item_id","created_at","updated_at"],"x-typelizer":true},"ReturnReason":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"active":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"can_be_deleted":{"type":"boolean"}},"required":["id","name","active","created_at","updated_at","can_be_deleted"],"x-typelizer":true},"Return":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"status":{"type":"string"},"order_id":{"type":"string","nullable":true},"reason_id":{"type":"string","nullable":true},"refund_total":{"type":"string"},"display_refund_total":{"type":"string"},"approved_at":{"type":"string","nullable":true},"received_at":{"type":"string","nullable":true},"refunded_at":{"type":"string","nullable":true},"canceled_at":{"type":"string","nullable":true},"reason":{"$ref":"#/components/schemas/ReturnReason"},"return_line_items":{"type":"array","items":{"$ref":"#/components/schemas/ReturnLineItem"}},"memo":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"stock_location_id":{"type":"string","nullable":true},"created_by_id":{"type":"string","nullable":true},"refunded_total":{"type":"string"},"refundable_total":{"type":"string"},"order":{"$ref":"#/components/schemas/Order"},"stock_location":{"$ref":"#/components/schemas/StockLocation"},"refunds":{"type":"array","items":{"$ref":"#/components/schemas/Refund"}}},"required":["id","number","status","order_id","reason_id","refund_total","display_refund_total","approved_at","received_at","refunded_at","canceled_at","memo","metadata","created_at","updated_at","stock_location_id","created_by_id","refunded_total","refundable_total"],"x-typelizer":true},"Role":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"permissions":{"type":"array","items":{"type":"string"}},"mutable":{"type":"boolean"},"users_count":{"type":"number"}},"required":["id","name","description","created_at","updated_at","permissions","mutable","users_count"],"x-typelizer":true},"SellerRequirement":{"type":"object","properties":{"id":{"type":"string"},"position":{"type":"number"},"active":{"type":"boolean"},"required":{"type":"boolean"},"metadata":{"type":"object","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"kind":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"preferences":{"type":"object"},"custom_field_definition_ids":{"type":"array","items":{"type":"string"}},"allow_multiple":{"type":"boolean"},"accepts_submissions":{"type":"boolean"},"reviewed_by_operator":{"type":"boolean"}},"required":["id","position","active","required","metadata","created_at","updated_at","kind","name","description","preferences","custom_field_definition_ids","allow_multiple","accepts_submissions","reviewed_by_operator"],"x-typelizer":true},"SellerRequirementStatus":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"required":{"type":"boolean"},"position":{"type":"number"},"status":{"type":"string"},"action_url":{"type":"string","nullable":true},"blocking":{"type":"boolean"},"submission":{"$ref":"#/components/schemas/SellerRequirementSubmission"}},"required":["id","kind","name","description","required","position","status","action_url","blocking"],"x-typelizer":true},"SellerRequirementSubmission":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"note":{"type":"string","nullable":true},"review_note":{"type":"string","nullable":true},"reference":{"type":"string","nullable":true},"metadata":{"type":"object","nullable":true},"reviewed_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"seller_id":{"type":"string"},"requirement_id":{"type":"string"},"requirement_name":{"type":"string"},"file_url":{"type":"string","nullable":true},"file_name":{"type":"string","nullable":true}},"required":["id","status","note","review_note","reference","metadata","reviewed_at","created_at","updated_at","seller_id","requirement_id","requirement_name","file_url","file_name"],"x-typelizer":true},"Seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"about":{"type":"string"},"about_html":{"type":"string"},"logo_url":{"type":"string","nullable":true},"square_logo_url":{"type":"string","nullable":true},"cover_photo_url":{"type":"string","nullable":true},"status":{"type":"string"},"contact_email":{"type":"string","nullable":true},"billing_email":{"type":"string","nullable":true},"tax_remittance":{"type":"string"},"payouts_schedule_interval":{"type":"string","nullable":true},"metadata":{"type":"object","nullable":true},"holiday_mode_until":{"type":"string","nullable":true},"terms_accepted_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string","nullable":true},"minimum_payout_amount":{"type":"string","nullable":true},"on_holiday":{"type":"boolean"},"sellable":{"type":"boolean"},"products_count":{"type":"number"},"users_count":{"type":"number"},"onboarding_progress":{"type":"object"},"onboarding_complete":{"type":"boolean"},"billing_address":{"$ref":"#/components/schemas/Address"},"returns_address":{"$ref":"#/components/schemas/Address"}},"required":["id","name","slug","about","about_html","logo_url","square_logo_url","cover_photo_url","status","contact_email","billing_email","tax_remittance","payouts_schedule_interval","metadata","holiday_mode_until","terms_accepted_at","created_at","updated_at","deleted_at","minimum_payout_amount","on_holiday","sellable","products_count","users_count","onboarding_progress","onboarding_complete"],"x-typelizer":true},"SetupTask":{"type":"object","properties":{"name":{"type":"string"},"done":{"type":"boolean"}},"required":["name","done"],"x-typelizer":true},"State":{"type":"object","properties":{"abbr":{"type":"string"},"name":{"type":"string"}},"required":["abbr","name"],"x-typelizer":true},"StockLevel":{"type":"object","properties":{"id":{"type":"string"},"count_on_hand":{"type":"number"},"backorderable":{"type":"boolean"},"stock_location_id":{"type":"string","nullable":true},"variant_id":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"allocated_count":{"type":"number"},"available_count":{"type":"number"},"stock_location":{"$ref":"#/components/schemas/StockLocation"},"variant":{"$ref":"#/components/schemas/Variant"}},"required":["id","count_on_hand","backorderable","stock_location_id","variant_id","metadata","created_at","updated_at","allocated_count","available_count"],"x-typelizer":true},"StockLocation":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address1":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"zipcode":{"type":"string","nullable":true},"country_code":{"type":"string","nullable":true},"country_name":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true},"state_text":{"type":"string","nullable":true},"pickup_ready_in_minutes":{"type":"number","nullable":true},"pickup_instructions":{"type":"string","nullable":true},"admin_name":{"type":"string","nullable":true},"address2":{"type":"string","nullable":true},"state_name":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"active":{"type":"boolean"},"default":{"type":"boolean"},"backorderable_default":{"type":"boolean"},"propagate_all_variants":{"type":"boolean"},"kind":{"type":"string"},"pickup_enabled":{"type":"boolean"},"pickup_stock_policy":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","name","address1","city","zipcode","country_code","country_name","state_code","state_text","pickup_ready_in_minutes","pickup_instructions","admin_name","address2","state_name","phone","company","active","default","backorderable_default","propagate_all_variants","kind","pickup_enabled","pickup_stock_policy","created_at","updated_at"],"x-typelizer":true},"StockMovement":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"number"},"kind":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"stock_level_id":{"type":"string","nullable":true},"order_id":{"type":"string","nullable":true},"fulfillment_id":{"type":"string","nullable":true},"return_id":{"type":"string","nullable":true},"exchange_id":{"type":"string","nullable":true},"stock_transfer_id":{"type":"string","nullable":true}},"required":["id","quantity","kind","reason","created_at","updated_at","stock_level_id","order_id","fulfillment_id","return_id","exchange_id","stock_transfer_id"],"x-typelizer":true},"StockReservation":{"type":"object","properties":{"id":{"type":"string"},"stock_level_id":{"type":"string"},"line_item_id":{"type":"string"},"order_id":{"type":"string"},"variant_id":{"type":"string","nullable":true},"stock_location_id":{"type":"string","nullable":true},"quantity":{"type":"number"},"expires_at":{"type":"string"},"active":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","stock_level_id","line_item_id","order_id","variant_id","stock_location_id","quantity","expires_at","active","created_at","updated_at"],"x-typelizer":true},"StockTransfer":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"reference":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"source_location_id":{"type":"string","nullable":true},"destination_location_id":{"type":"string","nullable":true},"source_location":{"$ref":"#/components/schemas/StockLocation"},"destination_location":{"$ref":"#/components/schemas/StockLocation"}},"required":["id","number","reference","metadata","created_at","updated_at","source_location_id","destination_location_id"],"x-typelizer":true},"StoreCredit":{"type":"object","properties":{"id":{"type":"string"},"amount":{"type":"string"},"amount_used":{"type":"string"},"amount_remaining":{"type":"string"},"display_amount":{"type":"string"},"display_amount_used":{"type":"string"},"display_amount_remaining":{"type":"string"},"currency":{"type":"string"},"memo":{"type":"string","nullable":true},"metadata":{"type":"object"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"customer_id":{"type":"string","nullable":true},"created_by_id":{"type":"string","nullable":true}},"required":["id","amount","amount_used","amount_remaining","display_amount","display_amount_used","display_amount_remaining","currency","memo","metadata","created_at","updated_at","customer_id","created_by_id"],"x-typelizer":true},"Store":{"type":"object","properties":{"id":{"type":"string"},"metadata":{"type":"object"},"name":{"type":"string"},"code":{"type":"string"},"preferred_storefront_url":{"type":"string","nullable":true},"default_currency":{"type":"string"},"default_locale":{"type":"string"},"mail_from_address":{"type":"string","nullable":true},"customer_support_email":{"type":"string","nullable":true},"new_order_notifications_email":{"type":"string","nullable":true},"preferred_send_consumer_transactional_emails":{"type":"boolean"},"preferred_admin_locale":{"type":"string","nullable":true},"preferred_timezone":{"type":"string"},"preferred_weight_unit":{"type":"string"},"preferred_default_package_weight":{"type":"number"},"preferred_default_package_length":{"type":"number"},"preferred_default_package_width":{"type":"number"},"preferred_default_package_height":{"type":"number"},"preferred_unit_system":{"type":"string"},"preferred_storefront_access":{"type":"string"},"preferred_guest_checkout":{"type":"boolean"},"preferred_company_field_enabled":{"type":"boolean"},"preferred_address_requires_company":{"type":"boolean"},"preferred_address_requires_phone":{"type":"boolean"},"preferred_capture_method":{"type":"string"},"preferred_track_inventory_levels":{"type":"boolean"},"preferred_stock_reservations_enabled":{"type":"boolean"},"preferred_tax_using_ship_address":{"type":"boolean"},"preferred_track_price_history":{"type":"boolean"},"preferred_show_products_without_price":{"type":"boolean"},"preferred_disable_sku_validation":{"type":"boolean"},"preferred_order_routing_strategy":{"type":"string"},"preferred_document_number_format":{"type":"string"},"preferred_order_number_prefix":{"type":"string"},"preferred_order_number_suffix":{"type":"string"},"preferred_order_number_sequence_start":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"order_number_sequence_started":{"type":"boolean"},"url":{"type":"string"},"api_url":{"type":"string"},"setup_tasks":{"type":"array","items":{"$ref":"#/components/schemas/SetupTask"}},"supported_currencies":{"type":"array","items":{"type":"string"}},"supported_locales":{"type":"array","items":{"type":"string"}},"available_locales":{"type":"array","items":{"type":"string"}},"logo_url":{"type":"string","nullable":true},"mailer_logo_url":{"type":"string","nullable":true}},"required":["id","metadata","name","code","preferred_storefront_url","default_currency","default_locale","mail_from_address","customer_support_email","new_order_notifications_email","preferred_send_consumer_transactional_emails","preferred_admin_locale","preferred_timezone","preferred_weight_unit","preferred_default_package_weight","preferred_default_package_length","preferred_default_package_width","preferred_default_package_height","preferred_unit_system","preferred_storefront_access","preferred_guest_checkout","preferred_company_field_enabled","preferred_address_requires_company","preferred_address_requires_phone","preferred_capture_method","preferred_track_inventory_levels","preferred_stock_reservations_enabled","preferred_tax_using_ship_address","preferred_track_price_history","preferred_show_products_without_price","preferred_disable_sku_validation","preferred_order_routing_strategy","preferred_document_number_format","preferred_order_number_prefix","preferred_order_number_suffix","preferred_order_number_sequence_start","created_at","updated_at","order_number_sequence_started","url","api_url","setup_tasks","supported_currencies","supported_locales","available_locales","logo_url","mailer_logo_url"],"x-typelizer":true},"TaxCategory":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"tax_code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"is_default":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","name","tax_code","description","is_default","created_at","updated_at"],"x-typelizer":true},"TaxExemptionCertificate":{"type":"object","properties":{"id":{"type":"string"},"certificate_number":{"type":"string"},"reason_code":{"type":"string"},"status":{"type":"string"},"issuing_authority":{"type":"string","nullable":true},"metadata":{"type":"object","nullable":true},"issued_at":{"type":"string"},"expires_at":{"type":"string"},"verified_at":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"company_id":{"type":"string"},"country_code":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true},"active":{"type":"boolean"},"lapsed":{"type":"boolean"},"can_be_deleted":{"type":"boolean"},"document_filename":{"type":"string","nullable":true},"document_byte_size":{"type":"number","nullable":true},"document_url":{"type":"string","nullable":true}},"required":["id","certificate_number","reason_code","status","issuing_authority","metadata","issued_at","expires_at","verified_at","created_at","updated_at","company_id","country_code","state_code","active","lapsed","can_be_deleted","document_filename","document_byte_size","document_url"],"x-typelizer":true},"TaxIdentifier":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"value":{"type":"string"},"validation_status":{"type":"string","nullable":true},"validation_evidence":{"type":"object","nullable":true},"source":{"type":"string","nullable":true},"validated_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"validatable":{"type":"boolean"},"customer_id":{"type":"string","nullable":true},"cart_id":{"type":"string","nullable":true},"order_id":{"type":"string","nullable":true}},"required":["id","kind","value","validation_status","validation_evidence","source","validated_at","created_at","updated_at","validatable","customer_id","cart_id","order_id"],"x-typelizer":true},"TaxLine":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"included":{"type":"boolean"},"rate":{"type":"string"},"tax_rate_id":{"type":"string","nullable":true},"line_item_id":{"type":"string","nullable":true},"fulfillment_id":{"type":"string","nullable":true},"fee_id":{"type":"string","nullable":true},"amount":{"type":"string"},"display_amount":{"type":"string"},"provider_id":{"type":"string","nullable":true},"metadata":{"type":"object","nullable":true},"taxability_reason":{"type":"string","nullable":true},"country_code":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true},"data":{"type":"object","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","label","included","rate","tax_rate_id","line_item_id","fulfillment_id","fee_id","amount","display_amount","provider_id","metadata","taxability_reason","country_code","state_code","data","created_at","updated_at"],"x-typelizer":true},"TaxRate":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"included_in_price":{"type":"boolean"},"show_rate_in_label":{"type":"boolean"},"metadata":{"type":"object","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string","nullable":true},"amount":{"type":"string"},"amount_percentage":{"type":"number","nullable":true},"tax_category_id":{"type":"string","nullable":true},"store_id":{"type":"string","nullable":true},"country_code":{"type":"string","nullable":true},"state_code":{"type":"string","nullable":true}},"required":["id","name","included_in_price","show_rate_in_label","metadata","created_at","updated_at","deleted_at","amount","amount_percentage","tax_category_id","store_id","country_code","state_code"],"x-typelizer":true},"Variant":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"sku":{"type":"string","nullable":true},"options_text":{"type":"string"},"track_inventory":{"type":"boolean"},"media_count":{"type":"number"},"preorder_ships_at":{"type":"string","nullable":true},"thumbnail_url":{"type":"string","nullable":true},"purchasable":{"type":"boolean"},"in_stock":{"type":"boolean"},"backorderable":{"type":"boolean"},"preorder":{"type":"boolean"},"weight":{"type":"number","nullable":true},"height":{"type":"number","nullable":true},"width":{"type":"number","nullable":true},"depth":{"type":"number","nullable":true},"price":{"$ref":"#/components/schemas/Price"},"original_price":{"allOf":[{"$ref":"#/components/schemas/Price"}],"nullable":true},"seller_id":{"type":"string","nullable":true},"seller":{"$ref":"#/components/schemas/Seller"},"primary_media":{"$ref":"#/components/schemas/Media"},"media":{"type":"array","items":{"$ref":"#/components/schemas/Media"}},"option_values":{"type":"array","items":{"$ref":"#/components/schemas/OptionValue"}},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"prior_price":{"allOf":[{"$ref":"#/components/schemas/PriceHistory"}],"nullable":true},"metadata":{"type":"object"},"position":{"type":"number"},"cost_price":{"type":"string","nullable":true},"cost_currency":{"type":"string","nullable":true},"barcode":{"type":"string","nullable":true},"weight_unit":{"type":"string","nullable":true},"dimensions_unit":{"type":"string","nullable":true},"backorder_limit":{"type":"number","nullable":true},"hs_code":{"type":"string","nullable":true},"country_of_origin":{"type":"string","nullable":true},"customs_description":{"type":"string","nullable":true},"deleted_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"preorderable":{"type":"boolean"},"tax_category_id":{"type":"string","nullable":true},"available_stock":{"type":"number","nullable":true},"reserved_quantity":{"type":"number"},"total_on_hand":{"type":"number","nullable":true},"product_name":{"type":"string"},"delivery_profile_id":{"type":"string","nullable":true},"prices":{"type":"array","items":{"$ref":"#/components/schemas/Price"}},"stock_levels":{"type":"array","items":{"$ref":"#/components/schemas/StockLevel"}}},"required":["id","product_id","sku","options_text","track_inventory","media_count","preorder_ships_at","thumbnail_url","purchasable","in_stock","backorderable","preorder","weight","height","width","depth","price","original_price","seller_id","option_values","metadata","position","cost_price","cost_currency","barcode","weight_unit","dimensions_unit","backorder_limit","hs_code","country_of_origin","customs_description","deleted_at","created_at","updated_at","preorderable","tax_category_id","available_stock","reserved_quantity","total_on_hand","product_name","delivery_profile_id"],"x-typelizer":true},"WebhookDelivery":{"type":"object","properties":{"id":{"type":"string"},"event_name":{"type":"string"},"event_id":{"type":"string","nullable":true},"response_code":{"type":"number","nullable":true},"execution_time":{"type":"number","nullable":true},"error_type":{"type":"string","nullable":true},"request_errors":{"type":"string","nullable":true},"response_body":{"type":"string","nullable":true},"success":{"type":"boolean","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"delivered_at":{"type":"string","nullable":true},"payload":{"type":"object"},"webhook_endpoint_id":{"type":"string"},"webhook_endpoint_url":{"type":"string"}},"required":["id","event_name","event_id","response_code","execution_time","error_type","request_errors","response_body","success","created_at","updated_at","delivered_at","payload","webhook_endpoint_id","webhook_endpoint_url"],"x-typelizer":true},"WebhookEndpoint":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"url":{"type":"string"},"active":{"type":"boolean"},"subscriptions":{"type":"array","items":{"type":"string"}},"disabled_reason":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"disabled_at":{"type":"string","nullable":true},"secret_key":{"type":"string","nullable":true},"last_delivery_at":{"type":"string","nullable":true},"recent_delivery_count":{"type":"number"},"recent_failure_count":{"type":"number"},"total_delivery_count":{"type":"number"},"successful_delivery_count":{"type":"number"},"failed_delivery_count":{"type":"number"}},"required":["id","name","url","active","subscriptions","disabled_reason","created_at","updated_at","disabled_at","secret_key","last_delivery_at","recent_delivery_count","recent_failure_count","total_delivery_count","successful_delivery_count","failed_delivery_count"],"x-typelizer":true}}}}\ No newline at end of filediff --git a/packages/cli/src/generated/resource-paths.json b/packages/cli/src/generated/resource-paths.jsonindex 5769e941b3..5db5626bbb 100644--- a/packages/cli/src/generated/resource-paths.json+++ b/packages/cli/src/generated/resource-paths.json@@ -1 +1 @@-["/admin_users","/allowed_origins","/api_keys","/auth","/categories","/channels","/collection_rules","/collections","/commission_lines","/commission_rates","/companies","/company_contacts","/company_locations","/custom_field_definitions","/customer_groups","/customers","/delivery_methods","/delivery_profiles","/delivery_zones","/exports","/gift_card_batches","/gift_cards","/imports","/integrations","/invitations","/locales","/markets","/me","/option_types","/order_routing_rules","/orders","/payment_methods","/permissions","/price_lists","/prices","/product_types","/products","/promotion_actions","/promotion_rules","/promotions","/roles","/sellers","/stock_locations","/store","/tags","/tax_rates","/translatable_resources","/translations","/webhook_endpoints"]\ No newline at end of file+["/admin_users","/allowed_origins","/api_keys","/auth","/categories","/channels","/collection_rules","/collections","/commission_lines","/commission_rates","/companies","/company_contacts","/company_locations","/custom_field_definitions","/customer_groups","/customers","/delivery_methods","/delivery_profiles","/delivery_zones","/exports","/gift_card_batches","/gift_cards","/imports","/integrations","/invitations","/locales","/markets","/me","/option_types","/order_routing_rules","/orders","/payment_methods","/permissions","/price_lists","/prices","/product_types","/products","/promotion_actions","/promotion_rules","/promotions","/roles","/seller_requirements","/sellers","/stock_locations","/stock_movements","/store","/tags","/tax_rates","/translatable_resources","/translations","/webhook_endpoints"]\ No newline at end of filediff --git a/packages/dashboard-ui/src/spree/address-block.tsx b/packages/dashboard-ui/src/spree/address-block.tsxindex 164a940b24..4c75e16ed5 100644--- a/packages/dashboard-ui/src/spree/address-block.tsx+++ b/packages/dashboard-ui/src/spree/address-block.tsx@@ -43,13 +43,14 @@ export function AddressBlock({title,address,}: {- title: string+ /** Omitted where the surrounding card already names the address. */+ title?: stringaddress: AddressBlockValue | null | undefined}) {const { t, i18n } = useTranslation()return (<div>- <h6 className="font-semibold text-sm mb-1.5">{title}</h6>+ {title && <h6 className="font-semibold text-sm mb-1.5">{title}</h6>}{address ? (<div className="text-sm text-muted-foreground flex flex-col gap-0.5"><div>{address.full_name}</div>diff --git a/packages/dashboard-ui/src/ui/card.tsx b/packages/dashboard-ui/src/ui/card.tsxindex 922d68a6c9..73851fb9d3 100644--- a/packages/dashboard-ui/src/ui/card.tsx+++ b/packages/dashboard-ui/src/ui/card.tsx@@ -32,7 +32,9 @@ function CardTitle({ className, ...props }: React.ComponentProps<'div'>) {return (<divdata-slot="card-title"- className={cn('text-lg font-medium flex items-center gap-2', className)}+ // Same size and weight as SheetTitle and DialogTitle: a card, a sheet+ // and a dialog heading are the same rank of thing.+ className={cn('text-base font-medium flex items-center gap-2', className)}{...props}/>)diff --git a/packages/dashboard-ui/src/ui/dialog.tsx b/packages/dashboard-ui/src/ui/dialog.tsxindex c8cd62ef90..57ff18f796 100644--- a/packages/dashboard-ui/src/ui/dialog.tsx+++ b/packages/dashboard-ui/src/ui/dialog.tsx@@ -177,7 +177,7 @@ function DialogTitle({ className, ...props }: React.ComponentProps<typeof Dialogreturn (<DialogPrimitive.Titledata-slot="dialog-title"- className={cn('text-base leading-none font-medium', className)}+ className={cn('text-base font-medium', className)}{...props}/>)diff --git a/packages/dashboard-ui/src/ui/sheet.tsx b/packages/dashboard-ui/src/ui/sheet.tsxindex 63b7f5d188..738e99e359 100644--- a/packages/dashboard-ui/src/ui/sheet.tsx+++ b/packages/dashboard-ui/src/ui/sheet.tsx@@ -186,7 +186,7 @@ function SheetTitle({ className, ...props }: React.ComponentProps<typeof SheetPrreturn (<SheetPrimitive.Titledata-slot="sheet-title"- className={cn('text-base leading-none font-medium', className)}+ className={cn('text-base font-medium', className)}{...props}/>)diff --git a/packages/dashboard/components.json b/packages/dashboard/components.jsonindex 5c23ec4912..907aae1d3a 100644--- a/packages/dashboard/components.json+++ b/packages/dashboard/components.json@@ -21,5 +21,7 @@},"menuColor": "default","menuAccent": "subtle",- "registries": {}+ "registries": {+ "@mapcn": "https://mapcn.dev/r/{name}.json"+ }}diff --git a/packages/dashboard/package.json b/packages/dashboard/package.jsonindex ee66786ab8..0d6d9fd2b1 100644--- a/packages/dashboard/package.json+++ b/packages/dashboard/package.json@@ -81,6 +81,7 @@"flag-icons": "^7.5.0","i18next": "^26.2.0","lucide-react": "^1.14.0",+ "maplibre-gl": "^6.4.0","next-themes": "^0.4.6","react": "^19.2.6","react-colorful": "^5.7.0",@@ -99,6 +100,7 @@"devDependencies": {"@playwright/test": "^1.59.1","@spree/dashboard-plugin-example": "workspace:^",+ "@types/geojson": "^7946.0.16","@types/node": "^25.6.0","@types/react": "^19.2.14","@types/react-dom": "^19.2.3",diff --git a/packages/dashboard/src/components/spree/address-fieldset.tsx b/packages/dashboard/src/components/spree/address-fieldset.tsxnew file mode 100644index 0000000000..b86fa1e49c--- /dev/null+++ b/packages/dashboard/src/components/spree/address-fieldset.tsx@@ -0,0 +1,161 @@+import { CountryCombobox, StateCombobox, useCountryStates } from '@spree/dashboard-core'+import { Field, FieldError, FieldLabel, Input } from '@spree/dashboard-ui'+import {+ Controller,+ type FieldValues,+ type Path,+ type FieldError as RhfFieldError,+ type UseFormReturn,+} from 'react-hook-form'+import { useTranslation } from 'react-i18next'++/**+ * The address block every form that captures one shares — name, street, city,+ * postal code, country/state pickers and phone.+ *+ * Generic over the form values so a page carrying an address under any key can+ * use it; `prefix` names that key.+ *+ * **Reach for `AddressFormDialog` (dashboard-core) first** — it owns one+ * address end to end, with its own sheet, Zod validation and 422 mapping, and+ * is what orders, customers and sellers use. This fieldset is for the case it+ * cannot serve: a form editing *several* addresses at once, where the fields+ * have to live inside a form the page already owns (a company location edits+ * billing and shipping together behind one "same as billing" toggle).+ *+ * Stock locations deliberately use neither: they are not addresses but a model+ * with its own flat columns and vocabulary (`zipcode`, `state_text`), so+ * sharing would mean a field-name mapping layer between form and API.+ */+export function AddressFieldset<TValues extends FieldValues>({+ form,+ prefix,+ legend,+}: {+ form: UseFormReturn<TValues>+ /** The form key holding the address block, e.g. `billing_address`. */+ prefix: Path<TValues>+ legend?: string+}) {+ const { t } = useTranslation()+ // Paths are composed as strings and cast once here: RHF cannot infer that+ // `${prefix}.city` is a key of TValues, and spelling every field out as a+ // generic parameter would make every caller declare its address shape twice.+ const path = (field: string) => `${prefix}.${field}` as Path<TValues>+ const countryCode = form.watch(path('country_code')) as string | undefined+ const { states } = useCountryStates(countryCode)++ // Server-side validation errors land under the same nested path the fields+ // are registered at, so each one renders beside the input it belongs to+ // rather than as one banner the merchant has to map back themselves.+ const errorFor = (field: string): RhfFieldError | undefined => {+ const block = form.formState.errors[prefix] as Record<string, RhfFieldError> | undefined++ return block?.[field]+ }++ return (+ <fieldset className="flex flex-col gap-4 rounded-md border p-4">+ {legend && <legend className="px-1 font-medium text-sm">{legend}</legend>}++ <div className="grid gap-4 sm:grid-cols-2">+ <Field>+ <FieldLabel htmlFor={`${prefix}-first-name`}>+ {t('admin.fields.first_name.label')}+ </FieldLabel>+ <Input id={`${prefix}-first-name`} {...form.register(path('first_name'))} />+ <FieldError errors={[errorFor('first_name')]} />+ </Field>+ <Field>+ <FieldLabel htmlFor={`${prefix}-last-name`}>+ {t('admin.fields.last_name.label')}+ </FieldLabel>+ <Input id={`${prefix}-last-name`} {...form.register(path('last_name'))} />+ <FieldError errors={[errorFor('last_name')]} />+ </Field>+ </div>++ <Field>+ <FieldLabel htmlFor={`${prefix}-address1`}>{t('admin.fields.address1.label')}</FieldLabel>+ <Input id={`${prefix}-address1`} {...form.register(path('address1'))} />+ <FieldError errors={[errorFor('address1')]} />+ </Field>++ <Field>+ <FieldLabel htmlFor={`${prefix}-address2`}>{t('admin.fields.address2.label')}</FieldLabel>+ <Input id={`${prefix}-address2`} {...form.register(path('address2'))} />+ <FieldError errors={[errorFor('address2')]} />+ </Field>++ <div className="grid gap-4 sm:grid-cols-2">+ <Field>+ <FieldLabel htmlFor={`${prefix}-city`}>{t('admin.fields.city.label')}</FieldLabel>+ <Input id={`${prefix}-city`} {...form.register(path('city'))} />+ <FieldError errors={[errorFor('city')]} />+ </Field>+ <Field>+ <FieldLabel htmlFor={`${prefix}-postal-code`}>+ {t('admin.fields.postal_code.label')}+ </FieldLabel>+ <Input id={`${prefix}-postal-code`} {...form.register(path('postal_code'))} />+ <FieldError errors={[errorFor('postal_code')]} />+ </Field>+ </div>++ <div className="grid gap-4 sm:grid-cols-2">+ <Field>+ <FieldLabel htmlFor={`${prefix}-country`}>{t('admin.fields.country.label')}</FieldLabel>+ <Controller+ name={path('country_code')}+ control={form.control}+ render={({ field }) => (+ <CountryCombobox+ value={field.value}+ onValueChange={(iso) => {+ field.onChange(iso)+ form.setValue(path('state_code'), '' as never, { shouldDirty: true })+ }}+ />+ )}+ />+ <FieldError errors={[errorFor('country_code')]} />+ </Field>+ {/* A country Spree has no subdivision list for still needs somewhere+ to put a region, so the picker falls back to a plain field rather+ than vanishing — otherwise the address simply cannot be completed. */}+ {countryCode && states.length > 0 ? (+ <Field>+ <FieldLabel htmlFor={`${prefix}-state`}>{t('admin.fields.state.label')}</FieldLabel>+ <Controller+ name={path('state_code')}+ control={form.control}+ render={({ field }) => (+ <StateCombobox+ countryCode={countryCode}+ states={states}+ value={field.value}+ onValueChange={field.onChange}+ />+ )}+ />+ <FieldError errors={[errorFor('state_code')]} />+ </Field>+ ) : (+ <Field>+ <FieldLabel htmlFor={`${prefix}-state-name`}>+ {t('admin.fields.state_name.label')}+ </FieldLabel>+ <Input id={`${prefix}-state-name`} {...form.register(path('state_name'))} />+ <FieldError errors={[errorFor('state_name')]} />+ </Field>+ )}+ </div>++ <Field>+ <FieldLabel htmlFor={`${prefix}-phone`}>{t('admin.fields.phone.label')}</FieldLabel>+ <Input id={`${prefix}-phone`} {...form.register(path('phone'))} />+ <FieldError errors={[errorFor('phone')]} />+ </Field>+ </fieldset>+ )+}diff --git a/packages/dashboard/src/components/spree/company-location-sheet.tsx b/packages/dashboard/src/components/spree/company-location-sheet.tsxindex 392d776a3b..1a6ca872a6 100644--- a/packages/dashboard/src/components/spree/company-location-sheet.tsx+++ b/packages/dashboard/src/components/spree/company-location-sheet.tsx@@ -1,11 +1,6 @@import { zodResolver } from '@hookform/resolvers/zod'import type { CompanyLocation } from '@spree/admin-sdk'-import {- CountryCombobox,- mapSpreeErrorsToForm,- StateCombobox,- useCountryStates,-} from '@spree/dashboard-core'+import { mapSpreeErrorsToForm } from '@spree/dashboard-core'import {Button,Checkbox,@@ -23,7 +18,7 @@ import {SheetTitle,} from '@spree/dashboard-ui'import { useEffect } from 'react'-import { Controller, type UseFormReturn, useForm } from 'react-hook-form'+import { Controller, useForm } from 'react-hook-form'import { useTranslation } from 'react-i18next'import { useCreateCompanyLocation, useUpdateCompanyLocation } from '../../hooks/use-companies'import {@@ -33,6 +28,7 @@ import {companyLocationFormSchema,companyLocationValuesToParams,} from '../../schemas/company'+import { AddressFieldset } from './address-fieldset'/*** Creates a branch under a company, or edits one addressed by its own id. A@@ -213,102 +209,3 @@ function addressToForm(address: CompanyLocation['billing_address'] | undefined)state_code: address?.state_code ?? '',}}--function AddressFieldset({- form,- prefix,- legend,-}: {- form: UseFormReturn<CompanyLocationFormValues>- prefix: 'billing_address' | 'shipping_address'- legend: string-}) {- const { t } = useTranslation()- const countryCode = form.watch(`${prefix}.country_code`)- const { states } = useCountryStates(countryCode)-- return (- <fieldset className="flex flex-col gap-4 rounded-md border p-4">- <legend className="px-1 font-medium text-sm">{legend}</legend>-- <div className="grid gap-4 sm:grid-cols-2">- <Field>- <FieldLabel htmlFor={`${prefix}-first-name`}>- {t('admin.fields.first_name.label')}- </FieldLabel>- <Input id={`${prefix}-first-name`} {...form.register(`${prefix}.first_name`)} />- </Field>- <Field>- <FieldLabel htmlFor={`${prefix}-last-name`}>- {t('admin.fields.last_name.label')}- </FieldLabel>- <Input id={`${prefix}-last-name`} {...form.register(`${prefix}.last_name`)} />- </Field>- </div>-- <Field>- <FieldLabel htmlFor={`${prefix}-address1`}>{t('admin.fields.address1.label')}</FieldLabel>- <Input id={`${prefix}-address1`} {...form.register(`${prefix}.address1`)} />- </Field>-- <Field>- <FieldLabel htmlFor={`${prefix}-address2`}>{t('admin.fields.address2.label')}</FieldLabel>- <Input id={`${prefix}-address2`} {...form.register(`${prefix}.address2`)} />- </Field>-- <div className="grid gap-4 sm:grid-cols-2">- <Field>- <FieldLabel htmlFor={`${prefix}-city`}>{t('admin.fields.city.label')}</FieldLabel>- <Input id={`${prefix}-city`} {...form.register(`${prefix}.city`)} />- </Field>- <Field>- <FieldLabel htmlFor={`${prefix}-postal-code`}>- {t('admin.fields.postal_code.label')}- </FieldLabel>- <Input id={`${prefix}-postal-code`} {...form.register(`${prefix}.postal_code`)} />- </Field>- </div>-- <div className="grid gap-4 sm:grid-cols-2">- <Field>- <FieldLabel htmlFor={`${prefix}-country`}>{t('admin.fields.country.label')}</FieldLabel>- <Controller- name={`${prefix}.country_code`}- control={form.control}- render={({ field }) => (- <CountryCombobox- value={field.value}- onValueChange={(iso) => {- field.onChange(iso)- form.setValue(`${prefix}.state_code`, '', { shouldDirty: true })- }}- />- )}- />- </Field>- {countryCode && states.length > 0 && (- <Field>- <FieldLabel htmlFor={`${prefix}-state`}>{t('admin.fields.state.label')}</FieldLabel>- <Controller- name={`${prefix}.state_code`}- control={form.control}- render={({ field }) => (- <StateCombobox- countryCode={countryCode}- states={states}- value={field.value}- onValueChange={field.onChange}- />- )}- />- </Field>- )}- </div>-- <Field>- <FieldLabel htmlFor={`${prefix}-phone`}>{t('admin.fields.phone.label')}</FieldLabel>- <Input id={`${prefix}-phone`} {...form.register(`${prefix}.phone`)} />- </Field>- </fieldset>- )-}diff --git a/packages/dashboard/src/components/spree/sellers/seller-address-card.tsx b/packages/dashboard/src/components/spree/sellers/seller-address-card.tsxnew file mode 100644index 0000000000..7052653538--- /dev/null+++ b/packages/dashboard/src/components/spree/sellers/seller-address-card.tsx@@ -0,0 +1,97 @@+import type { Seller } from '@spree/admin-sdk'+import { AddressFormDialog } from '@spree/dashboard-core'+import {+ AddressBlock,+ Badge,+ Button,+ Card,+ CardAction,+ CardContent,+ CardHeader,+ CardTitle,+} from '@spree/dashboard-ui'+import { PencilIcon } from 'lucide-react'+import { useState } from 'react'+import { useTranslation } from 'react-i18next'+import { useUpdateSeller } from '../../../hooks/use-sellers'+import { SellerAddressMap } from './seller-address-map'++type AddressKey = 'billing_address' | 'returns_address'++/**+ * One of a seller's two addresses — where they are invoiced, and where+ * customer returns go — with the map the legacy admin showed beside it.+ *+ * A returns address is what a shopper is told to post to, and a billing+ * address is what a commission invoice is addressed to, so both are worth+ * seeing on a map rather than trusting as typed.+ */+export function SellerAddressCard({+ seller,+ addressKey,+ canEdit,+}: {+ seller: Seller+ addressKey: AddressKey+ canEdit: boolean+}) {+ const { t } = useTranslation()+ const [editing, setEditing] = useState(false)+ const updateMutation = useUpdateSeller(seller.id)+ const address = seller[addressKey]+ const title = t(`admin.sellers.detail.${addressKey}`)++ return (+ <>+ <Card>+ <CardHeader>+ <CardTitle>+ {title}+ {address ? (+ <Badge variant="success">{t('admin.sellers.address.filled')}</Badge>+ ) : (+ <Badge variant="outline">{t('admin.sellers.address.not_filled')}</Badge>+ )}+ </CardTitle>+ {canEdit && (+ <CardAction>+ <Button variant="outline" size="sm" onClick={() => setEditing(true)}>+ <PencilIcon className="size-4" />+ {t('admin.actions.edit')}+ </Button>+ </CardAction>+ )}+ </CardHeader>+ <CardContent className="flex flex-col gap-3">+ {address ? (+ <>+ {/* No title: the card header already names it. */}+ <AddressBlock address={address} />+ <SellerAddressMap address={address} label={seller.name} />+ </>+ ) : (+ <p className="py-4 text-center text-muted-foreground text-sm">+ {t('admin.sellers.address.not_provided_by_seller')}+ </p>+ )}+ </CardContent>+ </Card>++ {editing && (+ <AddressFormDialog+ title={title}+ address={address}+ open+ onOpenChange={setEditing}+ // Only the address being edited is sent: the other one is untouched,+ // and posting both would rewrite a record the operator never opened.+ onSave={async (values) => {+ await updateMutation.mutateAsync({ [addressKey]: values })+ setEditing(false)+ }}+ isPending={updateMutation.isPending}+ />+ )}+ </>+ )+}diff --git a/packages/dashboard/src/components/spree/sellers/seller-address-map.tsx b/packages/dashboard/src/components/spree/sellers/seller-address-map.tsxnew file mode 100644index 0000000000..c5579b2c2a--- /dev/null+++ b/packages/dashboard/src/components/spree/sellers/seller-address-map.tsx@@ -0,0 +1,66 @@+import type { Address } from '@spree/admin-sdk'+import { lazy, Suspense } from 'react'+import { useTranslation } from 'react-i18next'++// MapLibre and its styles are a few megabytes, and a map appears on one card+// of one page — loaded on demand so every other screen does not carry it.+const LazyMap = lazy(async () => {+ const map = await import('../../ui/map')++ return { default: map.Map }+})+const LazyMapControls = lazy(async () => {+ const map = await import('../../ui/map')++ return { default: map.MapControls }+})+const LazyMapMarker = lazy(async () => {+ const map = await import('../../ui/map')++ return { default: map.MapMarker }+})+const LazyMarkerContent = lazy(async () => {+ const map = await import('../../ui/map')++ return { default: map.MarkerContent }+})+const LazyMarkerTooltip = lazy(async () => {+ const map = await import('../../ui/map')++ return { default: map.MarkerTooltip }+})++/**+ * Where an address actually is, beside the lines that describe it — a returns+ * address is what shoppers are told to post to, so it is worth seeing on a map+ * rather than trusting as typed.+ *+ * Coordinates are geocoded in the background after the address is saved, so a+ * freshly entered one has none yet; the map is simply absent until then rather+ * than showing the middle of the ocean.+ */+export function SellerAddressMap({ address, label }: { address: Address; label?: string }) {+ const { t } = useTranslation()+ const { latitude, longitude } = address++ if (latitude == null || longitude == null) {+ return (+ <p className="text-muted-foreground text-xs">{t('admin.sellers.address.not_located_yet')}</p>+ )+ }++ return (+ <div className="h-40 overflow-hidden rounded-md border">+ <Suspense fallback={<div className="size-full animate-pulse bg-muted" />}>+ <LazyMap center={[longitude, latitude]} zoom={13}>+ <LazyMapControls />+ <LazyMapMarker longitude={longitude} latitude={latitude}>+ {/* The default pin; the tooltip names whose address it is. */}+ <LazyMarkerContent />+ {label && <LazyMarkerTooltip>{label}</LazyMarkerTooltip>}+ </LazyMapMarker>+ </LazyMap>+ </Suspense>+ </div>+ )+}diff --git a/packages/dashboard/src/components/spree/sellers/seller-onboarding-card.tsx b/packages/dashboard/src/components/spree/sellers/seller-onboarding-card.tsxnew file mode 100644index 0000000000..2c2564d670--- /dev/null+++ b/packages/dashboard/src/components/spree/sellers/seller-onboarding-card.tsx@@ -0,0 +1,259 @@+import type { Seller, SellerRequirementStatus } from '@spree/admin-sdk'+import {+ Badge,+ Button,+ Card,+ CardTitle,+ Collapsible,+ CollapsibleContent,+ CollapsibleTrigger,+ DropdownMenu,+ DropdownMenuContent,+ DropdownMenuItem,+ DropdownMenuTrigger,+ Progress,+ useConfirm,+} from '@spree/dashboard-ui'+import {+ CheckCircle2Icon,+ ChevronDownIcon,+ CircleIcon,+ ClockIcon,+ DownloadIcon,+ MoreHorizontalIcon,+ XCircleIcon,+} from 'lucide-react'+import { useTranslation } from 'react-i18next'+import {+ useAcceptSellerRequirementSubmission,+ useRejectSellerRequirementSubmission,+ useSellerOnboarding,+ useWaiveSellerRequirement,+} from '../../../hooks/use-seller-requirements'++/**+ * Where one seller stands against the marketplace's checklist, and the+ * operator's decisions on anything they submitted.+ *+ * The header reads the progress off the seller itself, so it renders with+ * the page and matches the list's column; the requirement rows come from+ * the heavier onboarding endpoint once the card is on screen. Everything is+ * evaluated server-side — the card never re-derives whether something is+ * done, so what the operator reads is exactly what the approval gate uses.+ */+export function SellerOnboardingCard({ seller, canEdit }: { seller: Seller; canEdit: boolean }) {+ const { t } = useTranslation()+ const { data } = useSellerOnboarding(seller.id)+ const progress = seller.onboarding_progress++ // A marketplace that asks for nothing has no checklist worth a card.+ if (progress.total === 0) return null++ return (+ <Card className="overflow-hidden py-0">+ {/* Open while there is something left to do; a finished checklist+ folds away so the page leads with what still needs the operator. */}+ <Collapsible defaultOpen={!seller.onboarding_complete}>+ <CollapsibleTrigger className="group flex w-full cursor-pointer items-center gap-3 p-4 text-left hover:bg-muted/50 border-border-subtle">+ <CardTitle>{t('admin.sellers.onboarding.title')}</CardTitle>+ {seller.onboarding_complete ? (+ <Badge variant="success">{t('admin.sellers.onboarding.all_done')}</Badge>+ ) : (+ <Badge variant="secondary">+ {t('admin.sellers.onboarding.progress', {+ done: progress.done,+ total: progress.total,+ })}+ </Badge>+ )}+ <ChevronDownIcon className="ml-auto size-4 shrink-0 text-muted-foreground transition-transform group-data-[panel-open]:rotate-180" />+ </CollapsibleTrigger>++ <CollapsibleContent>+ <div className="flex flex-col gap-4 border-t p-4">+ <Progress value={progress.percentage} />++ {data ? (+ <ul className="flex flex-col divide-y">+ {data.requirements.map((requirement) => (+ <RequirementRow+ key={requirement.id}+ sellerId={seller.id}+ requirement={requirement}+ canEdit={canEdit}+ />+ ))}+ </ul>+ ) : (+ <p className="text-muted-foreground text-sm">{t('admin.common.loading')}</p>+ )}+ </div>+ </CollapsibleContent>+ </Collapsible>+ </Card>+ )+}++function RequirementRow({+ sellerId,+ requirement,+ canEdit,+}: {+ sellerId: string+ requirement: SellerRequirementStatus+ canEdit: boolean+}) {+ const { t } = useTranslation()+ const confirm = useConfirm()+ const acceptMutation = useAcceptSellerRequirementSubmission(sellerId)+ const rejectMutation = useRejectSellerRequirementSubmission(sellerId)+ const waiveMutation = useWaiveSellerRequirement(sellerId)++ const submission = requirement.submission+ const busy = acceptMutation.isPending || rejectMutation.isPending || waiveMutation.isPending++ async function handleReject() {+ if (!submission) return++ const ok = await confirm({+ title: t('admin.sellers.onboarding.reject_confirm.title'),+ message: t('admin.sellers.onboarding.reject_confirm.message', { name: requirement.name }),+ variant: 'destructive',+ confirmLabel: t('admin.sellers.onboarding.actions.reject'),+ })+ if (!ok) return++ await rejectMutation.mutateAsync({ id: submission.id }).catch(() => undefined)+ }++ async function handleWaive() {+ const ok = await confirm({+ title: t('admin.sellers.onboarding.waive_confirm.title'),+ message: t('admin.sellers.onboarding.waive_confirm.message', { name: requirement.name }),+ confirmLabel: t('admin.sellers.onboarding.actions.waive'),+ })+ if (!ok) return++ await waiveMutation.mutateAsync({ requirement_id: requirement.id }).catch(() => undefined)+ }++ return (+ <li className="flex items-start justify-between gap-3 py-3 first:pt-0 last:pb-0">+ <div className="flex min-w-0 items-start gap-2">+ <StatusIcon status={requirement.status} />+ <div className="flex min-w-0 flex-col gap-0.5">+ <div className="flex flex-wrap items-center gap-2">+ <span className="font-medium text-sm">{requirement.name}</span>+ {!requirement.required && (+ <Badge variant="outline">{t('admin.seller_requirements.required.no')}</Badge>+ )}+ </div>+ {requirement.description && (+ <span className="text-muted-foreground text-xs">{requirement.description}</span>+ )}+ {submission?.note && (+ <span className="text-muted-foreground text-xs">+ {t('admin.sellers.onboarding.seller_note', { note: submission.note })}+ </span>+ )}+ {submission?.review_note && (+ <span className="text-muted-foreground text-xs">+ {t('admin.sellers.onboarding.review_note', { note: submission.review_note })}+ </span>+ )}+ {submission?.file_url && (+ <a+ href={submission.file_url}+ className="flex items-center gap-1 text-primary text-xs hover:underline"+ >+ <DownloadIcon className="size-3" />+ {submission.file_name ?? t('admin.sellers.onboarding.download')}+ </a>+ )}+ </div>+ </div>++ <div className="flex shrink-0 items-center gap-2">+ <StatusBadge status={requirement.status} waived={submission?.status === 'waived'} />++ {canEdit && submission?.status === 'pending' && (+ <>+ <Button+ size="sm"+ variant="outline"+ disabled={busy}+ onClick={() =>+ acceptMutation.mutateAsync({ id: submission.id }).catch(() => undefined)+ }+ >+ {t('admin.sellers.onboarding.actions.accept')}+ </Button>+ <Button size="sm" variant="ghost" disabled={busy} onClick={handleReject}>+ {t('admin.sellers.onboarding.actions.reject')}+ </Button>+ </>+ )}++ {canEdit && requirement.status !== 'complete' && (+ <DropdownMenu>+ <DropdownMenuTrigger asChild>+ <Button size="icon-sm" variant="ghost" disabled={busy}>+ <MoreHorizontalIcon className="size-4" />+ </Button>+ </DropdownMenuTrigger>+ <DropdownMenuContent align="end">+ <DropdownMenuItem onClick={handleWaive}>+ {t('admin.sellers.onboarding.actions.waive')}+ </DropdownMenuItem>+ </DropdownMenuContent>+ </DropdownMenu>+ )}+ </div>+ </li>+ )+}++/**+ * The legacy checklist showed Done / Pending; the four statuses here add+ * the two cases an operator has to act on differently — something waiting+ * on them, and something they sent back.+ *+ * A waiver is read from the status like everything else, and only changes+ * the wording — it is done, by the operator's decision rather than the+ * seller's doing. Deciding "waived" ahead of the status is what previously+ * let this badge disagree with the tick beside it.+ */+function StatusBadge({ status, waived }: { status: string; waived: boolean }) {+ const { t } = useTranslation()++ if (status === 'complete') {+ return (+ <Badge variant="success">+ {waived+ ? t('admin.sellers.onboarding.waived')+ : t('admin.sellers.onboarding.status.complete')}+ </Badge>+ )+ }+ if (status === 'pending') {+ return <Badge variant="secondary">{t('admin.sellers.onboarding.status.pending')}</Badge>+ }+ if (status === 'rejected') {+ return <Badge variant="destructive">{t('admin.sellers.onboarding.status.rejected')}</Badge>+ }+ return <Badge variant="outline">{t('admin.sellers.onboarding.status.incomplete')}</Badge>+}++function StatusIcon({ status }: { status: string }) {+ if (status === 'complete') {+ return <CheckCircle2Icon className="mt-0.5 size-4 shrink-0 text-green-600" />+ }++ if (status === 'pending') {+ return <ClockIcon className="mt-0.5 size-4 shrink-0 text-amber-600" />+ }+ if (status === 'rejected') {+ return <XCircleIcon className="mt-0.5 size-4 shrink-0 text-destructive" />+ }+ return <CircleIcon className="mt-0.5 size-4 shrink-0 text-muted-foreground" />+}diff --git a/packages/dashboard/src/components/ui/map.tsx b/packages/dashboard/src/components/ui/map.tsxnew file mode 100644index 0000000000..19d25bba8a--- /dev/null+++ b/packages/dashboard/src/components/ui/map.tsx@@ -0,0 +1,2112 @@+'use client'++import type { MarkerOptions, PopupOptions } from 'maplibre-gl'+import * as MapLibreGL from 'maplibre-gl'+import 'maplibre-gl/dist/maplibre-gl.css'++// `cn` lives in the design system here rather than a local lib/utils, which+// is the one edit made to this vendored registry component.+import { cn } from '@spree/dashboard-ui'+import type * as GeoJSON from 'geojson'+import { Loader2, Locate, Maximize, Minus, Plus, X } from 'lucide-react'+// `?worker&url` hands the file to the bundler, which emits it as its own chunk+// with the shared code it needs and gives back a same-origin URL.+import workerUrl from 'maplibre-gl/dist/maplibre-gl-worker.mjs?worker&url'+import {+ createContext,+ forwardRef,+ type ReactNode,+ useCallback,+ useContext,+ useEffect,+ useId,+ useImperativeHandle,+ useMemo,+ useRef,+ useState,+} from 'react'+import { createPortal } from 'react-dom'++// The worker ships in the package, so it is bundled and served from this+// origin. The registry's default fetches it from unpkg at runtime, which means+// executing third-party code the deploy never reviewed, a map that breaks when+// that CDN is unreachable, and a CSP that has to allow it.+if (typeof window !== 'undefined' && !MapLibreGL.getWorkerUrl()) {+ MapLibreGL.setWorkerUrl(workerUrl)+}++const defaultStyles = {+ dark: 'https://basemaps.cartocdn.com/gl/dark-matter-gl-style/style.json',+ light: 'https://basemaps.cartocdn.com/gl/positron-gl-style/style.json',+}++// A tile-less, dependency-free style with a transparent background. Use it for+// data visualizations (choropleths, world arcs, dot maps) where you draw your+// own layers and don't need a street basemap. The easiest way to opt in is the+// `blank` prop:+// <Map blank>...</Map>+// The transparent background lets the themed container show through.+const blankMapStyle: MapLibreGL.StyleSpecification = {+ version: 8,+ sources: {},+ layers: [+ {+ id: 'background',+ type: 'background',+ paint: { 'background-color': 'rgba(0, 0, 0, 0)' },+ },+ ],+}++// Prevent equivalent inline style objects from triggering a full map style reload.+function useStableValue<T>(value: T): T {+ const key = useMemo(() => JSON.stringify(value) ?? '', [value])+ // eslint-disable-next-line react-hooks/exhaustive-deps+ return useMemo(() => value, [key])+}++function mergeHoverPaint<T extends Record<string, unknown>>(+ paint: T,+ hoverPaint: T | undefined,+): T {+ if (!hoverPaint) return paint+ const merged: Record<string, unknown> = { ...paint }+ for (const [key, hoverValue] of Object.entries(hoverPaint)) {+ if (hoverValue === undefined) continue+ const baseValue = merged[key]+ merged[key] =+ baseValue === undefined+ ? hoverValue+ : ['case', ['boolean', ['feature-state', 'hover'], false], hoverValue, baseValue]+ }+ return merged as T+}++type Theme = 'light' | 'dark'++// Check the document for an explicit theme (works with next-themes, etc.).+// Covers both `attribute="class"` (the default) and `attribute="data-theme"`.+function getDocumentTheme(): Theme | null {+ if (typeof document === 'undefined') return null+ const root = document.documentElement+ if (root.classList.contains('dark')) return 'dark'+ if (root.classList.contains('light')) return 'light'+ const dataTheme = root.dataset.theme+ if (dataTheme === 'dark' || dataTheme === 'light') return dataTheme+ return null+}++// Get system preference+function getSystemTheme(): Theme {+ if (typeof window === 'undefined') return 'light'+ return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light'+}++function useResolvedTheme(themeProp?: 'light' | 'dark'): Theme {+ const [detectedTheme, setDetectedTheme] = useState<Theme>(+ () => getDocumentTheme() ?? getSystemTheme(),+ )++ useEffect(() => {+ if (themeProp) return // Skip detection if theme is provided via prop++ // Watch for document theme changes (e.g., next-themes toggling the class+ // or the data-theme attribute).+ const observer = new MutationObserver(() => {+ const docTheme = getDocumentTheme()+ if (docTheme) {+ setDetectedTheme(docTheme)+ }+ })+ observer.observe(document.documentElement, {+ attributes: true,+ attributeFilter: ['class', 'data-theme'],+ })++ // Also watch for system preference changes+ const mediaQuery = window.matchMedia('(prefers-color-scheme: dark)')+ const handleSystemChange = (e: MediaQueryListEvent) => {+ // Only use system preference if no document class is set+ if (!getDocumentTheme()) {+ setDetectedTheme(e.matches ? 'dark' : 'light')+ }+ }+ mediaQuery.addEventListener('change', handleSystemChange)++ return () => {+ observer.disconnect()+ mediaQuery.removeEventListener('change', handleSystemChange)+ }+ }, [themeProp])++ return themeProp ?? detectedTheme+}++type MapContextValue = {+ map: MapLibreGL.Map | null+ isLoaded: boolean+ resolvedTheme: Theme+}++const MapContext = createContext<MapContextValue | null>(null)++function useMap() {+ const context = useContext(MapContext)+ if (!context) {+ throw new Error('useMap must be used within a Map component')+ }+ return context+}++/** Map viewport state */+type MapViewport = {+ /** Center coordinates [longitude, latitude] */+ center: [number, number]+ /** Zoom level */+ zoom: number+ /** Bearing (rotation) in degrees */+ bearing: number+ /** Pitch (tilt) in degrees */+ pitch: number+}++type MapStyleOption = string | MapLibreGL.StyleSpecification++type MapRef = MapLibreGL.Map++type MapProps = {+ children?: ReactNode+ /** Additional CSS classes for the map container */+ className?: string+ /**+ * Theme for the map. If not provided, automatically detects system preference.+ * Pass your theme value here.+ */+ theme?: Theme+ /** Custom map styles for light and dark themes. Overrides the default Carto styles. */+ styles?: {+ light?: MapStyleOption+ dark?: MapStyleOption+ }+ /**+ * Use a transparent, tile-less basemap instead of the default Carto street+ * basemap — a blank canvas. Used alone it renders nothing; add your own+ * layers on top (`<MapGeoJSON>`, `<MapArc>`, markers, etc.). Ideal for data+ * visualizations (choropleths, arcs, dot maps).+ * Ignored when an explicit `styles` prop is provided.+ */+ blank?: boolean+ /** Map projection type. Use `{ type: "globe" }` for 3D globe view. */+ projection?: MapLibreGL.ProjectionSpecification+ /**+ * Controlled viewport. When provided with onViewportChange,+ * the map becomes controlled and viewport is driven by this prop.+ */+ viewport?: Partial<MapViewport>+ /**+ * Callback fired continuously as the viewport changes (pan, zoom, rotate, pitch).+ * Can be used standalone to observe changes, or with `viewport` prop+ * to enable controlled mode where the map viewport is driven by your state.+ */+ onViewportChange?: (viewport: MapViewport) => void+ /** Show a loading indicator on the map */+ loading?: boolean+} & Omit<MapLibreGL.MapOptions, 'container' | 'style'>++function DefaultLoader() {+ return (+ <div className="bg-background/50 absolute inset-0 z-10 flex items-center justify-center backdrop-blur-xs">+ <div className="flex gap-1">+ <span className="bg-muted-foreground/60 size-1.5 animate-pulse rounded-full" />+ <span className="bg-muted-foreground/60 size-1.5 animate-pulse rounded-full [animation-delay:150ms]" />+ <span className="bg-muted-foreground/60 size-1.5 animate-pulse rounded-full [animation-delay:300ms]" />+ </div>+ </div>+ )+}++function getViewport(map: MapLibreGL.Map): MapViewport {+ const center = map.getCenter()+ return {+ center: [center.lng, center.lat],+ zoom: map.getZoom(),+ bearing: map.getBearing(),+ pitch: map.getPitch(),+ }+}++const Map = forwardRef<MapRef, MapProps>(function Map(+ {+ children,+ className,+ theme: themeProp,+ styles,+ blank = false,+ projection,+ viewport,+ onViewportChange,+ loading = false,+ ...props+ },+ ref,+) {+ const containerRef = useRef<HTMLDivElement>(null)+ const [mapInstance, setMapInstance] = useState<MapLibreGL.Map | null>(null)+ const [isLoaded, setIsLoaded] = useState(false)+ const [isStyleLoaded, setIsStyleLoaded] = useState(false)+ const [pendingStyle, setPendingStyle] = useState<MapStyleOption | null>(null)+ const currentStyleRef = useRef<MapStyleOption | null>(null)+ const styleSwapInFlightRef = useRef(false)+ const internalUpdateRef = useRef(false)+ const resolvedTheme = useResolvedTheme(themeProp)++ const isControlled = viewport !== undefined && onViewportChange !== undefined++ const onViewportChangeRef = useRef(onViewportChange)+ onViewportChangeRef.current = onViewportChange++ const stableStyles = useStableValue(styles)++ const mapStyles = useMemo(() => {+ // Explicit styles win. Otherwise `blank` opts into the transparent+ // tile-less basemap; with neither, fall back to the Carto defaults.+ if (stableStyles) {+ return {+ dark: stableStyles.dark ?? defaultStyles.dark,+ light: stableStyles.light ?? defaultStyles.light,+ }+ }+ if (blank) {+ return { dark: blankMapStyle, light: blankMapStyle }+ }+ return defaultStyles+ }, [stableStyles, blank])++ // Expose the map instance to the parent component+ useImperativeHandle(ref, () => mapInstance as MapLibreGL.Map, [mapInstance])++ // Initialize the map+ useEffect(() => {+ if (!containerRef.current) return++ const initialStyle = resolvedTheme === 'dark' ? mapStyles.dark : mapStyles.light+ currentStyleRef.current = initialStyle++ const map = new MapLibreGL.Map({+ container: containerRef.current,+ style: initialStyle,+ renderWorldCopies: false,+ attributionControl: {+ compact: true,+ },+ ...props,+ ...viewport,+ })++ const styleLoadHandler = () => {+ styleSwapInFlightRef.current = false+ setIsStyleLoaded(true)+ }+ const loadHandler = () => setIsLoaded(true)++ // Viewport change handler - skip if triggered by internal update+ const handleMove = () => {+ if (internalUpdateRef.current) return+ onViewportChangeRef.current?.(getViewport(map))+ }++ map.on('load', loadHandler)+ map.on('style.load', styleLoadHandler)+ map.on('move', handleMove)+ setMapInstance(map)++ return () => {+ map.off('load', loadHandler)+ map.off('style.load', styleLoadHandler)+ map.off('move', handleMove)+ map.remove()+ setIsLoaded(false)+ setIsStyleLoaded(false)+ setMapInstance(null)+ }+ // eslint-disable-next-line react-hooks/exhaustive-deps+ }, [])++ // Sync controlled viewport to map+ useEffect(() => {+ if (!mapInstance || !isControlled || !viewport) return+ if (mapInstance.isMoving()) return++ const current = getViewport(mapInstance)+ const next = {+ center: viewport.center ?? current.center,+ zoom: viewport.zoom ?? current.zoom,+ bearing: viewport.bearing ?? current.bearing,+ pitch: viewport.pitch ?? current.pitch,+ }++ if (+ next.center[0] === current.center[0] &&+ next.center[1] === current.center[1] &&+ next.zoom === current.zoom &&+ next.bearing === current.bearing &&+ next.pitch === current.pitch+ ) {+ return+ }++ internalUpdateRef.current = true+ mapInstance.jumpTo(next)+ internalUpdateRef.current = false+ }, [mapInstance, isControlled, viewport])++ // Handle style change: close the gate (so layer children tear down and+ // re-add on the incoming style) - the swap itself is staged to the effect below.+ useEffect(() => {+ if (!mapInstance || !resolvedTheme) return++ const newStyle = resolvedTheme === 'dark' ? mapStyles.dark : mapStyles.light++ if (currentStyleRef.current === newStyle) return++ currentStyleRef.current = newStyle+ setIsStyleLoaded(false)+ setPendingStyle(newStyle)+ }, [mapInstance, resolvedTheme, mapStyles])++ useEffect(() => {+ if (!mapInstance || !pendingStyle) return++ setPendingStyle(null)+ styleSwapInFlightRef.current = true+ // Full reload (no diff) so `style.load` fires deterministically. A+ // successful diff would never fire it, leaving isStyleLoaded stuck false.+ mapInstance.setStyle(pendingStyle, { diff: false })+ }, [mapInstance, pendingStyle])++ // Sync projection when the prop changes after mount.+ useEffect(() => {+ if (!mapInstance || !isStyleLoaded || !projection) return+ if (styleSwapInFlightRef.current) return+ mapInstance.setProjection(projection)+ }, [mapInstance, isStyleLoaded, projection])++ const contextValue = useMemo(+ () => ({+ map: mapInstance,+ isLoaded: isLoaded && isStyleLoaded,+ resolvedTheme,+ }),+ [mapInstance, isLoaded, isStyleLoaded, resolvedTheme],+ )++ return (+ <MapContext.Provider value={contextValue}>+ <div ref={containerRef} className={cn('relative h-full w-full', className)}>+ {(!isLoaded || loading) && <DefaultLoader />}+ {/* SSR-safe: children render only when map is loaded on client */}+ {mapInstance && children}+ </div>+ </MapContext.Provider>+ )+})++type MarkerContextValue = {+ marker: MapLibreGL.Marker+ map: MapLibreGL.Map | null+}++const MarkerContext = createContext<MarkerContextValue | null>(null)++function useMarkerContext() {+ const context = useContext(MarkerContext)+ if (!context) {+ throw new Error('Marker components must be used within MapMarker')+ }+ return context+}++type MapMarkerProps = {+ /** Longitude coordinate for marker position */+ longitude: number+ /** Latitude coordinate for marker position */+ latitude: number+ /** Marker subcomponents (MarkerContent, MarkerPopup, MarkerTooltip, MarkerLabel) */+ children: ReactNode+ /** Callback when marker is clicked */+ onClick?: (e: MouseEvent) => void+ /** Callback when mouse enters marker */+ onMouseEnter?: (e: MouseEvent) => void+ /** Callback when mouse leaves marker */+ onMouseLeave?: (e: MouseEvent) => void+ /** Callback when marker drag starts (requires draggable: true) */+ onDragStart?: (lngLat: { lng: number; lat: number }) => void+ /** Callback during marker drag (requires draggable: true) */+ onDrag?: (lngLat: { lng: number; lat: number }) => void+ /** Callback when marker drag ends (requires draggable: true) */+ onDragEnd?: (lngLat: { lng: number; lat: number }) => void+} & Omit<MarkerOptions, 'element'>++function MapMarker({+ longitude,+ latitude,+ children,+ onClick,+ onMouseEnter,+ onMouseLeave,+ onDragStart,+ onDrag,+ onDragEnd,+ draggable = false,+ ...markerOptions+}: MapMarkerProps) {+ const { map } = useMap()++ const callbacksRef = useRef({+ onClick,+ onMouseEnter,+ onMouseLeave,+ onDragStart,+ onDrag,+ onDragEnd,+ })+ callbacksRef.current = {+ onClick,+ onMouseEnter,+ onMouseLeave,+ onDragStart,+ onDrag,+ onDragEnd,+ }++ const marker = useMemo(() => {+ const markerInstance = new MapLibreGL.Marker({+ ...markerOptions,+ element: document.createElement('div'),+ draggable,+ }).setLngLat([longitude, latitude])++ const handleClick = (e: MouseEvent) => callbacksRef.current.onClick?.(e)+ const handleMouseEnter = (e: MouseEvent) => callbacksRef.current.onMouseEnter?.(e)+ const handleMouseLeave = (e: MouseEvent) => callbacksRef.current.onMouseLeave?.(e)++ markerInstance.getElement()?.addEventListener('click', handleClick)+ markerInstance.getElement()?.addEventListener('mouseenter', handleMouseEnter)+ markerInstance.getElement()?.addEventListener('mouseleave', handleMouseLeave)++ const handleDragStart = () => {+ const lngLat = markerInstance.getLngLat()+ callbacksRef.current.onDragStart?.({ lng: lngLat.lng, lat: lngLat.lat })+ }+ const handleDrag = () => {+ const lngLat = markerInstance.getLngLat()+ callbacksRef.current.onDrag?.({ lng: lngLat.lng, lat: lngLat.lat })+ }+ const handleDragEnd = () => {+ const lngLat = markerInstance.getLngLat()+ callbacksRef.current.onDragEnd?.({ lng: lngLat.lng, lat: lngLat.lat })+ }++ markerInstance.on('dragstart', handleDragStart)+ markerInstance.on('drag', handleDrag)+ markerInstance.on('dragend', handleDragEnd)++ return markerInstance++ // eslint-disable-next-line react-hooks/exhaustive-deps+ }, [])++ useEffect(() => {+ if (!map) return++ marker.addTo(map)++ return () => {+ marker.remove()+ }++ // eslint-disable-next-line react-hooks/exhaustive-deps+ }, [map])++ const { offset, rotation, rotationAlignment, pitchAlignment } = markerOptions++ useEffect(() => {+ const current = marker.getLngLat()+ if (current.lng !== longitude || current.lat !== latitude) {+ marker.setLngLat([longitude, latitude])+ }++ if (marker.isDraggable() !== draggable) {+ marker.setDraggable(draggable)+ }++ const currentOffset = marker.getOffset()+ const newOffset = offset ?? [0, 0]+ const [newOffsetX, newOffsetY] = Array.isArray(newOffset)+ ? newOffset+ : [newOffset.x, newOffset.y]+ if (currentOffset.x !== newOffsetX || currentOffset.y !== newOffsetY) {+ marker.setOffset(newOffset)+ }++ if (marker.getRotation() !== (rotation ?? 0)) {+ marker.setRotation(rotation ?? 0)+ }+ if (marker.getRotationAlignment() !== (rotationAlignment ?? 'auto')) {+ marker.setRotationAlignment(rotationAlignment ?? 'auto')+ }+ if (marker.getPitchAlignment() !== (pitchAlignment ?? 'auto')) {+ marker.setPitchAlignment(pitchAlignment ?? 'auto')+ }+ }, [marker, longitude, latitude, draggable, offset, rotation, rotationAlignment, pitchAlignment])++ return <MarkerContext.Provider value={{ marker, map }}>{children}</MarkerContext.Provider>+}++type MarkerContentProps = {+ /** Custom marker content. Defaults to a blue dot if not provided */+ children?: ReactNode+ /** Additional CSS classes for the marker container */+ className?: string+}++function MarkerContent({ children, className }: MarkerContentProps) {+ const { marker } = useMarkerContext()++ return createPortal(+ <div className={cn('relative cursor-pointer', className)}>+ {children || <DefaultMarkerIcon />}+ </div>,+ marker.getElement(),+ )+}++function DefaultMarkerIcon() {+ return (+ <div className="relative h-4 w-4 rounded-full border-2 border-white bg-blue-500 shadow-lg" />+ )+}++function PopupCloseButton({ onClick }: { onClick: () => void }) {+ return (+ <button+ type="button"+ onClick={onClick}+ aria-label="Close popup"+ className="focus-visible:ring-ring hover:bg-muted text-foreground absolute top-1 right-1 z-10 inline-flex size-5 cursor-pointer items-center justify-center rounded-sm transition-colors focus:outline-none focus-visible:ring-2 focus-visible:ring-inset"+ >+ <X className="size-3.5" />+ </button>+ )+}++type MarkerPopupProps = {+ /** Popup content */+ children: ReactNode+ /** Additional CSS classes for the popup container */+ className?: string+ /** Show a close button in the popup (default: false) */+ closeButton?: boolean+} & Omit<PopupOptions, 'className' | 'closeButton'>++function MarkerPopup({+ children,+ className,+ closeButton = false,+ ...popupOptions+}: MarkerPopupProps) {+ const { marker, map } = useMarkerContext()+ const container = useMemo(() => document.createElement('div'), [])+ const { offset, maxWidth } = popupOptions++ const popup = useMemo(() => {+ const popupInstance = new MapLibreGL.Popup({+ offset: 16,+ ...popupOptions,+ closeButton: false,+ })+ .setMaxWidth('none')+ .setDOMContent(container)++ return popupInstance+ // eslint-disable-next-line react-hooks/exhaustive-deps+ }, [])++ useEffect(() => {+ if (!map) return++ popup.setDOMContent(container)+ marker.setPopup(popup)++ return () => {+ marker.setPopup(null)+ }+ // eslint-disable-next-line react-hooks/exhaustive-deps+ }, [map])++ // Sync popup options when they change.+ useEffect(() => {+ popup.setOffset(offset ?? 16)+ if (maxWidth) {+ popup.setMaxWidth(maxWidth)+ }+ }, [popup, offset, maxWidth])++ const handleClose = () => popup.remove()++ return createPortal(+ <div+ className={cn(+ 'bg-popover text-popover-foreground relative max-w-62 rounded-md border p-3 shadow-md',+ 'animate-in fade-in-0 zoom-in-95 duration-200 ease-out',+ className,+ )}+ >+ {closeButton && <PopupCloseButton onClick={handleClose} />}+ {children}+ </div>,+ container,+ )+}++type MarkerTooltipProps = {+ /** Tooltip content */+ children: ReactNode+ /** Additional CSS classes for the tooltip container */+ className?: string+} & Omit<PopupOptions, 'className' | 'closeButton' | 'closeOnClick'>++function MarkerTooltip({ children, className, ...popupOptions }: MarkerTooltipProps) {+ const { marker, map } = useMarkerContext()+ const container = useMemo(() => document.createElement('div'), [])+ const { offset, maxWidth } = popupOptions++ const tooltip = useMemo(() => {+ const tooltipInstance = new MapLibreGL.Popup({+ offset: 16,+ ...popupOptions,+ closeOnClick: true,+ closeButton: false,+ }).setMaxWidth('none')++ return tooltipInstance+ // eslint-disable-next-line react-hooks/exhaustive-deps+ }, [])++ useEffect(() => {+ if (!map) return++ tooltip.setDOMContent(container)++ const handleMouseEnter = () => {+ tooltip.setLngLat(marker.getLngLat()).addTo(map)+ }+ const handleMouseLeave = () => tooltip.remove()++ marker.getElement()?.addEventListener('mouseenter', handleMouseEnter)+ marker.getElement()?.addEventListener('mouseleave', handleMouseLeave)++ return () => {+ marker.getElement()?.removeEventListener('mouseenter', handleMouseEnter)+ marker.getElement()?.removeEventListener('mouseleave', handleMouseLeave)+ tooltip.remove()+ }+ // eslint-disable-next-line react-hooks/exhaustive-deps+ }, [map])++ // Sync tooltip options when they change.+ useEffect(() => {+ tooltip.setOffset(offset ?? 16)+ if (maxWidth) {+ tooltip.setMaxWidth(maxWidth)+ }+ }, [tooltip, offset, maxWidth])++ return createPortal(+ <div+ className={cn(+ 'bg-foreground text-background pointer-events-none rounded-md px-2 py-1 text-xs text-balance shadow-md',+ 'animate-in fade-in-0 zoom-in-95 duration-200 ease-out',+ className,+ )}+ >+ {children}+ </div>,+ container,+ )+}++type MarkerLabelProps = {+ /** Label text content */+ children: ReactNode+ /** Additional CSS classes for the label */+ className?: string+ /** Position of the label relative to the marker (default: "top") */+ position?: 'top' | 'bottom'+}++function MarkerLabel({ children, className, position = 'top' }: MarkerLabelProps) {+ const positionClasses = {+ top: 'bottom-full mb-1',+ bottom: 'top-full mt-1',+ }++ return (+ <div+ className={cn(+ 'absolute left-1/2 -translate-x-1/2 whitespace-nowrap',+ 'text-foreground text-[10px] font-medium',+ positionClasses[position],+ className,+ )}+ >+ {children}+ </div>+ )+}++type MapControlsProps = {+ /** Position of the controls on the map (default: "bottom-right") */+ position?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'+ /** Show zoom in/out buttons (default: true) */+ showZoom?: boolean+ /** Show compass button to reset bearing (default: false) */+ showCompass?: boolean+ /** Show locate button to find user's location (default: false) */+ showLocate?: boolean+ /** Show fullscreen toggle button (default: false) */+ showFullscreen?: boolean+ /** Additional CSS classes for the controls container */+ className?: string+ /** Callback with user coordinates when located */+ onLocate?: (coords: { longitude: number; latitude: number }) => void+}++const positionClasses = {+ 'top-left': 'top-2 left-2',+ 'top-right': 'top-2 right-2',+ 'bottom-left': 'bottom-2 left-2',+ 'bottom-right': 'bottom-10 right-2',+}++function ControlGroup({ children }: { children: React.ReactNode }) {+ return (+ <div className="border-border bg-background [&>button:not(:last-child)]:border-border flex flex-col overflow-hidden rounded-md border shadow-sm [&>button:not(:last-child)]:border-b">+ {children}+ </div>+ )+}++function ControlButton({+ onClick,+ label,+ children,+ disabled = false,+}: {+ onClick: () => void+ label: string+ children: React.ReactNode+ disabled?: boolean+}) {+ return (+ <button+ onClick={onClick}+ aria-label={label}+ type="button"+ className={cn(+ 'flex size-8 items-center justify-center transition-colors',+ 'first:rounded-t-md last:rounded-b-md',+ 'hover:bg-accent dark:hover:bg-accent/40',+ 'focus-visible:ring-ring focus-visible:ring-2 focus-visible:outline-none focus-visible:ring-inset',+ 'disabled:pointer-events-none disabled:opacity-50',+ )}+ disabled={disabled}+ >+ {children}+ </button>+ )+}++function MapControls({+ position = 'bottom-right',+ showZoom = true,+ showCompass = false,+ showLocate = false,+ showFullscreen = false,+ className,+ onLocate,+}: MapControlsProps) {+ const { map } = useMap()+ const [waitingForLocation, setWaitingForLocation] = useState(false)++ const handleZoomIn = useCallback(() => {+ map?.zoomTo(map.getZoom() + 1, { duration: 300 })+ }, [map])++ const handleZoomOut = useCallback(() => {+ map?.zoomTo(map.getZoom() - 1, { duration: 300 })+ }, [map])++ const handleResetBearing = useCallback(() => {+ map?.resetNorthPitch({ duration: 300 })+ }, [map])++ const handleLocate = useCallback(() => {+ if (!('geolocation' in navigator)) return+ setWaitingForLocation(true)+ navigator.geolocation.getCurrentPosition(+ (pos) => {+ const coords = {+ longitude: pos.coords.longitude,+ latitude: pos.coords.latitude,+ }+ map?.flyTo({+ center: [coords.longitude, coords.latitude],+ zoom: 14,+ duration: 1500,+ })+ onLocate?.(coords)+ setWaitingForLocation(false)+ },+ (error) => {+ console.error('Error getting location:', error)+ setWaitingForLocation(false)+ },+ // Without a timeout the spec default is Infinity: a dismissed permission+ // prompt would leave the button disabled forever.+ { timeout: 10000 },+ )+ }, [map, onLocate])++ const handleFullscreen = useCallback(() => {+ const container = map?.getContainer()+ if (!container) return+ if (document.fullscreenElement) {+ document.exitFullscreen()+ } else {+ container.requestFullscreen()+ }+ }, [map])++ return (+ <div+ className={cn('absolute z-10 flex flex-col gap-1.5', positionClasses[position], className)}+ >+ {showZoom && (+ <ControlGroup>+ <ControlButton onClick={handleZoomIn} label="Zoom in">+ <Plus className="size-4" />+ </ControlButton>+ <ControlButton onClick={handleZoomOut} label="Zoom out">+ <Minus className="size-4" />+ </ControlButton>+ </ControlGroup>+ )}+ {showCompass && (+ <ControlGroup>+ <CompassButton onClick={handleResetBearing} />+ </ControlGroup>+ )}+ {showLocate && (+ <ControlGroup>+ <ControlButton+ onClick={handleLocate}+ label="Find my location"+ disabled={waitingForLocation}+ >+ {waitingForLocation ? (+ <Loader2 className="size-4 animate-spin" />+ ) : (+ <Locate className="size-4" />+ )}+ </ControlButton>+ </ControlGroup>+ )}+ {showFullscreen && (+ <ControlGroup>+ <ControlButton onClick={handleFullscreen} label="Toggle fullscreen">+ <Maximize className="size-4" />+ </ControlButton>+ </ControlGroup>+ )}+ </div>+ )+}++function CompassButton({ onClick }: { onClick: () => void }) {+ const { map } = useMap()+ const compassRef = useRef<SVGSVGElement>(null)++ useEffect(() => {+ if (!map || !compassRef.current) return++ const compass = compassRef.current++ const updateRotation = () => {+ const bearing = map.getBearing()+ const pitch = map.getPitch()+ compass.style.transform = `rotateX(${pitch}deg) rotateZ(${-bearing}deg)`+ }++ map.on('rotate', updateRotation)+ map.on('pitch', updateRotation)+ updateRotation()++ return () => {+ map.off('rotate', updateRotation)+ map.off('pitch', updateRotation)+ }+ }, [map])++ return (+ <ControlButton onClick={onClick} label="Reset bearing to north">+ <svg+ ref={compassRef}+ viewBox="0 0 24 24"+ className="size-5"+ style={{ transformStyle: 'preserve-3d' }}+ >+ <path d="M12 2L16 12H12V2Z" className="fill-red-500" />+ <path d="M12 2L8 12H12V2Z" className="fill-red-300" />+ <path d="M12 22L16 12H12V22Z" className="fill-muted-foreground/60" />+ <path d="M12 22L8 12H12V22Z" className="fill-muted-foreground/30" />+ </svg>+ </ControlButton>+ )+}++type MapPopupProps = {+ /** Longitude coordinate for popup position */+ longitude: number+ /** Latitude coordinate for popup position */+ latitude: number+ /** Callback when popup is closed */+ onClose?: () => void+ /** Popup content */+ children: ReactNode+ /** Additional CSS classes for the popup container */+ className?: string+ /** Show a close button in the popup (default: false) */+ closeButton?: boolean+} & Omit<PopupOptions, 'className' | 'closeButton'>++function MapPopup({+ longitude,+ latitude,+ onClose,+ children,+ className,+ closeButton = false,+ ...popupOptions+}: MapPopupProps) {+ const { map } = useMap()+ const onCloseRef = useRef(onClose)+ onCloseRef.current = onClose+ const container = useMemo(() => document.createElement('div'), [])+ const { offset, maxWidth } = popupOptions++ const popup = useMemo(() => {+ const popupInstance = new MapLibreGL.Popup({+ offset: 16,+ ...popupOptions,+ closeButton: false,+ })+ .setMaxWidth('none')+ .setLngLat([longitude, latitude])++ return popupInstance+ // eslint-disable-next-line react-hooks/exhaustive-deps+ }, [])++ useEffect(() => {+ if (!map) return++ const onCloseProp = () => onCloseRef.current?.()++ popup.on('close', onCloseProp)++ popup.setDOMContent(container)+ popup.addTo(map)++ return () => {+ popup.off('close', onCloseProp)+ if (popup.isOpen()) {+ popup.remove()+ }+ }+ // eslint-disable-next-line react-hooks/exhaustive-deps+ }, [map])++ // Sync popup position and options when they change.+ useEffect(() => {+ const current = popup.getLngLat()+ if (!current || current.lng !== longitude || current.lat !== latitude) {+ popup.setLngLat([longitude, latitude])+ }+ popup.setOffset(offset ?? 16)+ if (maxWidth) {+ popup.setMaxWidth(maxWidth)+ }+ }, [popup, longitude, latitude, offset, maxWidth])++ const handleClose = () => {+ popup.remove()+ }++ return createPortal(+ <div+ className={cn(+ 'bg-popover text-popover-foreground relative max-w-62 rounded-md border p-3 shadow-md',+ 'animate-in fade-in-0 zoom-in-95 duration-200 ease-out',+ className,+ )}+ >+ {closeButton && <PopupCloseButton onClick={handleClose} />}+ {children}+ </div>,+ container,+ )+}++type MapRouteProps = {+ /** Optional unique identifier for the route layer */+ id?: string+ /** Array of [longitude, latitude] coordinate pairs defining the route */+ coordinates: [number, number][]+ /** Line color as CSS color value (default: "#4285F4") */+ color?: string+ /** Line width in pixels (default: 3) */+ width?: number+ /** Line opacity from 0 to 1 (default: 0.8) */+ opacity?: number+ /** Dash pattern [dash length, gap length] for dashed lines */+ dashArray?: [number, number]+ /** Callback when the route line is clicked */+ onClick?: () => void+ /** Callback when mouse enters the route line */+ onMouseEnter?: () => void+ /** Callback when mouse leaves the route line */+ onMouseLeave?: () => void+ /** Whether the route is interactive - shows pointer cursor on hover (default: true) */+ interactive?: boolean+}++function MapRoute({+ id: propId,+ coordinates,+ color = '#4285F4',+ width = 3,+ opacity = 0.8,+ dashArray,+ onClick,+ onMouseEnter,+ onMouseLeave,+ interactive = true,+}: MapRouteProps) {+ const { map, isLoaded } = useMap()+ const autoId = useId()+ const id = propId ?? autoId+ const sourceId = `route-source-${id}`+ const layerId = `route-layer-${id}`++ // Add source and layer on mount+ useEffect(() => {+ if (!isLoaded || !map) return++ map.addSource(sourceId, {+ type: 'geojson',+ data: {+ type: 'Feature',+ properties: {},+ geometry: { type: 'LineString', coordinates: [] },+ },+ })++ map.addLayer({+ id: layerId,+ type: 'line',+ source: sourceId,+ layout: { 'line-join': 'round', 'line-cap': 'round' },+ paint: {+ 'line-color': color,+ 'line-width': width,+ 'line-opacity': opacity,+ ...(dashArray && { 'line-dasharray': dashArray }),+ },+ })++ return () => {+ try {+ if (map.getLayer(layerId)) map.removeLayer(layerId)+ if (map.getSource(sourceId)) map.removeSource(sourceId)+ } catch {+ // ignore+ }+ }+ // eslint-disable-next-line react-hooks/exhaustive-deps+ }, [isLoaded, map])++ // When coordinates change, update the source data+ useEffect(() => {+ if (!isLoaded || !map || coordinates.length < 2) return++ const source = map.getSource(sourceId) as MapLibreGL.GeoJSONSource+ if (source) {+ source.setData({+ type: 'Feature',+ properties: {},+ geometry: { type: 'LineString', coordinates },+ })+ }+ }, [isLoaded, map, coordinates, sourceId])++ useEffect(() => {+ if (!isLoaded || !map || !map.getLayer(layerId)) return++ map.setPaintProperty(layerId, 'line-color', color)+ map.setPaintProperty(layerId, 'line-width', width)+ map.setPaintProperty(layerId, 'line-opacity', opacity)+ map.setPaintProperty(layerId, 'line-dasharray', dashArray)+ }, [isLoaded, map, layerId, color, width, opacity, dashArray])++ // Handle click and hover events+ useEffect(() => {+ if (!isLoaded || !map || !interactive) return++ const handleClick = () => {+ onClick?.()+ }+ const handleMouseEnter = () => {+ map.getCanvas().style.cursor = 'pointer'+ onMouseEnter?.()+ }+ const handleMouseLeave = () => {+ map.getCanvas().style.cursor = ''+ onMouseLeave?.()+ }++ map.on('click', layerId, handleClick)+ map.on('mouseenter', layerId, handleMouseEnter)+ map.on('mouseleave', layerId, handleMouseLeave)++ return () => {+ map.off('click', layerId, handleClick)+ map.off('mouseenter', layerId, handleMouseEnter)+ map.off('mouseleave', layerId, handleMouseLeave)+ }+ }, [isLoaded, map, layerId, onClick, onMouseEnter, onMouseLeave, interactive])++ return null+}++type MapGeoJSONData<P extends GeoJSON.GeoJsonProperties = GeoJSON.GeoJsonProperties> =+ | GeoJSON.FeatureCollection<GeoJSON.Geometry, P>+ | GeoJSON.Feature<GeoJSON.Geometry, P>+ | GeoJSON.Geometry+ | string++type MapFillPaint = NonNullable<MapLibreGL.FillLayerSpecification['paint']>+type MapLinePaint = NonNullable<MapLibreGL.LineLayerSpecification['paint']>++/** A rendered feature with strongly-typed `properties`. */+type MapGeoJSONFeature<P extends GeoJSON.GeoJsonProperties = GeoJSON.GeoJsonProperties> = Omit<+ MapLibreGL.MapGeoJSONFeature,+ 'properties'+> & { properties: P }++/** Event payload passed to MapGeoJSON interaction callbacks. */+type MapGeoJSONEvent<P extends GeoJSON.GeoJsonProperties = GeoJSON.GeoJsonProperties> = {+ /** The feature under the cursor, with its typed GeoJSON properties. */+ feature: MapGeoJSONFeature<P>+ /** Longitude of the cursor at the time of the event. */+ longitude: number+ /** Latitude of the cursor at the time of the event. */+ latitude: number+ /** The underlying MapLibre mouse event for advanced use cases. */+ originalEvent: MapLibreGL.MapLayerMouseEvent+}++type MapGeoJSONProps<P extends GeoJSON.GeoJsonProperties = GeoJSON.GeoJsonProperties> = {+ /** GeoJSON data (FeatureCollection, Feature, Geometry) or a URL to fetch it from. */+ data: MapGeoJSONData<P>+ /** Optional unique identifier prefix for the source/layers. Auto-generated if not provided. */+ id?: string+ /**+ * Feature property to promote to the feature `id`. Required for hover+ * feature-state (`fillHoverPaint`) and stable `onHover`/`onClick` payloads.+ */+ promoteId?: string+ /**+ * Paint for the polygon fill layer. Merged on top of a theme-aware monochrome+ * surface tone (`fill-color`). Pass `false` to omit the fill layer entirely+ * (e.g. outlines only).+ */+ fillPaint?: MapFillPaint | false+ /**+ * Paint for the outline layer. Merged on top of a hairline default+ * (`line-color` = a near-surface neutral, `line-width` = 0.5) for thin+ * separators. Override `line-color` if your container differs, or pass+ * `false` to omit the layer.+ */+ linePaint?: MapLinePaint | false+ /**+ * Paint merged onto the fill layer for the feature under the cursor, applied+ * as a `case` expression keyed on hover feature-state. Requires `promoteId`.+ */+ fillHoverPaint?: MapFillPaint+ /** Callback when a feature is clicked. */+ onClick?: (e: MapGeoJSONEvent<P>) => void+ /** Callback fired when the hovered feature changes; `null` when the cursor leaves. */+ onHover?: (e: MapGeoJSONEvent<P> | null) => void+ /** Whether features respond to mouse events (default: false). */+ interactive?: boolean+ /** Optional MapLibre layer id to insert the layers before (z-order control). */+ beforeId?: string+}++// Monochrome defaults: a neutral-gray fill (hex of the grayscale chart tokens)+// with a fixed near-surface line for thin separators. Colors are hardcoded (not+// theme tokens), tuned for a typical light/dark surface. Override via+// `fillPaint` / `linePaint`.+const GEOJSON_DEFAULT_COLORS = {+ light: { fill: '#d4d4d4', line: '#ffffff' },+ dark: { fill: '#404040', line: '#171717' },+} satisfies Record<Theme, { fill: string; line: string }>++/**+ * Renders arbitrary GeoJSON as fill + outline layers on the map. Composes like+ * `MapRoute` / `MapArc` — drop it inside `<Map>` (typically with `blank`) for+ * choropleths and region/data maps. For full control over expressions and+ * multiple layers, manage layers directly via `useMap()` instead.+ */+function MapGeoJSON<P extends GeoJSON.GeoJsonProperties = GeoJSON.GeoJsonProperties>({+ data,+ id: propId,+ promoteId,+ fillPaint,+ linePaint,+ fillHoverPaint,+ onClick,+ onHover,+ interactive = false,+ beforeId,+}: MapGeoJSONProps<P>) {+ const { map, isLoaded, resolvedTheme } = useMap()+ const autoId = useId()+ const id = propId ?? autoId+ const sourceId = `geojson-source-${id}`+ const fillLayerId = `geojson-fill-${id}`+ const lineLayerId = `geojson-line-${id}`++ const defaults = GEOJSON_DEFAULT_COLORS[resolvedTheme]++ const showFill = fillPaint !== false+ const showLine = linePaint !== false++ const mergedFillPaint = useMemo(+ () => mergeHoverPaint({ 'fill-color': defaults.fill, ...(fillPaint || {}) }, fillHoverPaint),+ [defaults.fill, fillPaint, fillHoverPaint],+ )+ const mergedLinePaint = useMemo(+ () => ({+ 'line-color': defaults.line,+ 'line-width': 0.5,+ ...(linePaint || {}),+ }),+ [defaults.line, linePaint],+ )+ const latestRef = useRef({ onClick, onHover })+ latestRef.current = { onClick, onHover }++ // Add source on mount.+ useEffect(() => {+ if (!isLoaded || !map) return++ map.addSource(sourceId, {+ type: 'geojson',+ data,+ ...(promoteId ? { promoteId } : {}),+ })++ return () => {+ try {+ if (map.getLayer(lineLayerId)) map.removeLayer(lineLayerId)+ if (map.getLayer(fillLayerId)) map.removeLayer(fillLayerId)+ if (map.getSource(sourceId)) map.removeSource(sourceId)+ } catch {+ // style may be mid-reload+ }+ }+ // eslint-disable-next-line react-hooks/exhaustive-deps+ }, [isLoaded, map])++ // Sync data when it changes.+ useEffect(() => {+ if (!isLoaded || !map) return+ const source = map.getSource(sourceId) as MapLibreGL.GeoJSONSource | undefined+ source?.setData(data as never)+ }, [isLoaded, map, data, sourceId])++ // Sync layers and paint when visibility or styling changes.+ useEffect(() => {+ if (!isLoaded || !map) return++ const source = map.getSource(sourceId)+ if (!source) return++ if (showFill && !map.getLayer(fillLayerId)) {+ map.addLayer(+ {+ id: fillLayerId,+ type: 'fill',+ source: sourceId,+ paint: mergedFillPaint,+ },+ beforeId,+ )+ } else if (!showFill && map.getLayer(fillLayerId)) {+ map.removeLayer(fillLayerId)+ }++ if (showLine && !map.getLayer(lineLayerId)) {+ map.addLayer(+ {+ id: lineLayerId,+ type: 'line',+ source: sourceId,+ paint: mergedLinePaint,+ },+ beforeId,+ )+ } else if (!showLine && map.getLayer(lineLayerId)) {+ map.removeLayer(lineLayerId)+ }++ if (showFill && map.getLayer(fillLayerId)) {+ for (const [key, value] of Object.entries(mergedFillPaint)) {+ map.setPaintProperty(fillLayerId, key as keyof MapFillPaint, value as never)+ }+ }+ if (showLine && map.getLayer(lineLayerId)) {+ for (const [key, value] of Object.entries(mergedLinePaint)) {+ map.setPaintProperty(lineLayerId, key as keyof MapLinePaint, value as never)+ }+ }+ }, [+ isLoaded,+ map,+ sourceId,+ fillLayerId,+ lineLayerId,+ showFill,+ showLine,+ mergedFillPaint,+ mergedLinePaint,+ beforeId,+ ])++ // Interaction handlers (bound to the fill layer).+ useEffect(() => {+ if (!isLoaded || !map || !interactive || !showFill) return++ let hoveredId: string | number | null = null++ const setHover = (next: string | number | null) => {+ if (next === hoveredId) return+ const sourceExists = !!map.getSource(sourceId)+ if (hoveredId != null && sourceExists) {+ map.setFeatureState({ source: sourceId, id: hoveredId }, { hover: false })+ }+ hoveredId = next+ if (next != null && sourceExists) {+ map.setFeatureState({ source: sourceId, id: next }, { hover: true })+ }+ }++ const handleMouseMove = (e: MapLibreGL.MapLayerMouseEvent) => {+ const feature = e.features?.[0]+ if (!feature) return+ map.getCanvas().style.cursor = 'pointer'++ const featureId = feature.id+ if (featureId === hoveredId) return+ setHover(featureId ?? null)+ latestRef.current.onHover?.({+ feature: feature as unknown as MapGeoJSONFeature<P>,+ longitude: e.lngLat.lng,+ latitude: e.lngLat.lat,+ originalEvent: e,+ })+ }++ const handleMouseLeave = () => {+ setHover(null)+ map.getCanvas().style.cursor = ''+ latestRef.current.onHover?.(null)+ }++ const handleClick = (e: MapLibreGL.MapLayerMouseEvent) => {+ const feature = e.features?.[0]+ if (!feature) return+ latestRef.current.onClick?.({+ feature: feature as unknown as MapGeoJSONFeature<P>,+ longitude: e.lngLat.lng,+ latitude: e.lngLat.lat,+ originalEvent: e,+ })+ }++ map.on('mousemove', fillLayerId, handleMouseMove)+ map.on('mouseleave', fillLayerId, handleMouseLeave)+ map.on('click', fillLayerId, handleClick)++ return () => {+ map.off('mousemove', fillLayerId, handleMouseMove)+ map.off('mouseleave', fillLayerId, handleMouseLeave)+ map.off('click', fillLayerId, handleClick)+ setHover(null)+ map.getCanvas().style.cursor = ''+ }+ }, [isLoaded, map, fillLayerId, sourceId, interactive, showFill])++ return null+}++/** A single arc to render inside <MapArc data={...}>. */+type MapArcDatum = {+ /** Unique identifier for this arc. Required for hover state tracking and event payloads. */+ id: string | number+ /** Start coordinate as [longitude, latitude]. */+ from: [number, number]+ /** End coordinate as [longitude, latitude]. */+ to: [number, number]+}++/** Event payload passed to MapArc interaction callbacks. */+type MapArcEvent<T extends MapArcDatum = MapArcDatum> = {+ /** The arc datum that was hovered or clicked. */+ arc: T+ /** Longitude of the cursor at the time of the event. */+ longitude: number+ /** Latitude of the cursor at the time of the event. */+ latitude: number+ /** The underlying MapLibre mouse event for advanced use cases. */+ originalEvent: MapLibreGL.MapMouseEvent+}++type MapArcLinePaint = NonNullable<MapLibreGL.LineLayerSpecification['paint']>+type MapArcLineLayout = NonNullable<MapLibreGL.LineLayerSpecification['layout']>++type MapArcProps<T extends MapArcDatum = MapArcDatum> = {+ /** Array of arcs to render. Each arc must have a unique `id`. */+ data: T[]+ /** Optional unique identifier prefix for the arc source/layers. Auto-generated if not provided. */+ id?: string+ /**+ * How far each arc bows away from a straight line. `0` renders straight+ * lines; higher values bend further. Negative values bend to the opposite+ * side. Arcs are computed as a quadratic Bézier in lng/lat space; the+ * destination longitude is unwrapped relative to the origin so that arcs+ * cross the antimeridian via the shorter great-circle direction. (default: 0.2)+ */+ curvature?: number+ /** Number of samples used to render each curve. Higher = smoother. (default: 64) */+ samples?: number+ /**+ * MapLibre paint properties for the arc layer. Merged on top of sensible+ * defaults (`line-color: #4285F4`, `line-width: 2`, `line-opacity: 0.85`).+ * Any value can be a MapLibre expression for per-feature styling, every+ * field on each arc datum (besides `from`/`to`) is exposed via `["get", ...]`.+ */+ paint?: MapArcLinePaint+ /** MapLibre layout properties for the arc layer. Defaults to rounded joins/caps. */+ layout?: MapArcLineLayout+ /**+ * Paint properties applied to the arc currently under the cursor. Each key+ * is merged into `paint` as a `case` expression keyed on per-feature hover+ * state, so only the hovered arc changes appearance.+ */+ hoverPaint?: MapArcLinePaint+ /** Callback when an arc is clicked. */+ onClick?: (e: MapArcEvent<T>) => void+ /**+ * Callback fired when the hovered arc changes. Receives the cursor's+ * lng/lat at the moment of entry, and `null` when the cursor leaves the+ * last hovered arc.+ */+ onHover?: (e: MapArcEvent<T> | null) => void+ /** Whether arcs respond to mouse events (default: true). */+ interactive?: boolean+ /** Optional MapLibre layer id to insert the arc layers before (z-order control). */+ beforeId?: string+}++const DEFAULT_ARC_CURVATURE = 0.2+const DEFAULT_ARC_SAMPLES = 64+const ARC_HIT_MIN_WIDTH = 12+const ARC_HIT_PADDING = 6++const DEFAULT_ARC_PAINT: MapArcLinePaint = {+ 'line-color': '#4285F4',+ 'line-width': 2,+ 'line-opacity': 0.85,+}++const DEFAULT_ARC_LAYOUT: MapArcLineLayout = {+ 'line-join': 'round',+ 'line-cap': 'round',+}++function buildArcCoordinates(+ from: [number, number],+ to: [number, number],+ curvature: number,+ samples: number,+): [number, number][] {+ const [x0, y0] = from+ const [xTo, y2] = to+ // Unwrap the destination longitude so |dx| <= 180. This makes arcs that+ // straddle the antimeridian (e.g. Tokyo -> San Francisco) bow the short way+ // across the Pacific instead of the long way around the globe. Resulting+ // longitudes may fall outside [-180, 180]; MapLibre renders them correctly+ // on the globe projection, and on mercator when world copies are enabled.+ const rawDx = xTo - x0+ const x2 = rawDx > 180 ? xTo - 360 : rawDx < -180 ? xTo + 360 : xTo+ const dx = x2 - x0+ const dy = y2 - y0+ const distance = Math.hypot(dx, dy)++ if (distance === 0 || curvature === 0) return [from, [x2, y2]]++ const mx = (x0 + x2) / 2+ const my = (y0 + y2) / 2+ const nx = -dy / distance+ const ny = dx / distance+ const offset = distance * curvature+ const cx = mx + nx * offset+ const cy = my + ny * offset++ const points: [number, number][] = []+ const segments = Math.max(2, Math.floor(samples))+ for (let i = 0; i <= segments; i += 1) {+ const t = i / segments+ const inv = 1 - t+ const x = inv * inv * x0 + 2 * inv * t * cx + t * t * x2+ const y = inv * inv * y0 + 2 * inv * t * cy + t * t * y2+ points.push([x, y])+ }+ return points+}++function MapArc<T extends MapArcDatum = MapArcDatum>({+ data,+ id: propId,+ curvature = DEFAULT_ARC_CURVATURE,+ samples = DEFAULT_ARC_SAMPLES,+ paint,+ layout,+ hoverPaint,+ onClick,+ onHover,+ interactive = true,+ beforeId,+}: MapArcProps<T>) {+ const { map, isLoaded } = useMap()+ const autoId = useId()+ const id = propId ?? autoId+ const sourceId = `arc-source-${id}`+ const layerId = `arc-layer-${id}`+ const hitLayerId = `arc-hit-layer-${id}`++ const mergedPaint = useMemo(+ () => mergeHoverPaint({ ...DEFAULT_ARC_PAINT, ...paint }, hoverPaint),+ [paint, hoverPaint],+ )+ const mergedLayout = useMemo(() => ({ ...DEFAULT_ARC_LAYOUT, ...layout }), [layout])++ const hitWidth = useMemo(() => {+ const w = paint?.['line-width'] ?? DEFAULT_ARC_PAINT['line-width']+ const base = typeof w === 'number' ? w : ARC_HIT_MIN_WIDTH+ return Math.max(base + ARC_HIT_PADDING, ARC_HIT_MIN_WIDTH)+ }, [paint])++ const geoJSON = useMemo<GeoJSON.FeatureCollection<GeoJSON.LineString>>(+ () => ({+ type: 'FeatureCollection',+ features: data.map((arc) => {+ const { from, to, ...properties } = arc+ return {+ type: 'Feature',+ properties,+ geometry: {+ type: 'LineString',+ coordinates: buildArcCoordinates(from, to, curvature, samples),+ },+ }+ }),+ }),+ [data, curvature, samples],+ )++ const latestRef = useRef({ data, onClick, onHover })+ latestRef.current = { data, onClick, onHover }++ // Add source and layers on mount.+ useEffect(() => {+ if (!isLoaded || !map) return++ map.addSource(sourceId, {+ type: 'geojson',+ data: geoJSON,+ promoteId: 'id',+ })++ map.addLayer(+ {+ id: hitLayerId,+ type: 'line',+ source: sourceId,+ layout: DEFAULT_ARC_LAYOUT,+ paint: {+ 'line-color': 'rgba(0, 0, 0, 0)',+ 'line-width': hitWidth,+ 'line-opacity': 1,+ },+ },+ beforeId,+ )++ map.addLayer(+ {+ id: layerId,+ type: 'line',+ source: sourceId,+ layout: mergedLayout,+ paint: mergedPaint,+ },+ beforeId,+ )++ return () => {+ try {+ if (map.getLayer(layerId)) map.removeLayer(layerId)+ if (map.getLayer(hitLayerId)) map.removeLayer(hitLayerId)+ if (map.getSource(sourceId)) map.removeSource(sourceId)+ } catch {+ // ignore+ }+ }+ // eslint-disable-next-line react-hooks/exhaustive-deps+ }, [isLoaded, map])++ // Sync features when data / curvature / samples change.+ useEffect(() => {+ if (!isLoaded || !map) return+ const source = map.getSource(sourceId) as MapLibreGL.GeoJSONSource | undefined+ source?.setData(geoJSON)+ }, [isLoaded, map, geoJSON, sourceId])++ // Sync paint/layout when they change.+ useEffect(() => {+ if (!isLoaded || !map || !map.getLayer(layerId)) return+ for (const [key, value] of Object.entries(mergedPaint)) {+ map.setPaintProperty(layerId, key as keyof MapArcLinePaint, value as never)+ }+ for (const [key, value] of Object.entries(mergedLayout)) {+ map.setLayoutProperty(layerId, key as keyof MapArcLineLayout, value as never)+ }+ if (map.getLayer(hitLayerId)) {+ map.setPaintProperty(hitLayerId, 'line-width', hitWidth)+ }+ }, [isLoaded, map, layerId, hitLayerId, mergedPaint, mergedLayout, hitWidth])++ // Interaction handlers+ useEffect(() => {+ if (!isLoaded || !map || !interactive) return++ let hoveredId: string | number | null = null++ const setHover = (next: string | number | null) => {+ if (next === hoveredId) return+ const sourceExists = !!map.getSource(sourceId)+ if (hoveredId != null && sourceExists) {+ map.setFeatureState({ source: sourceId, id: hoveredId }, { hover: false })+ }+ hoveredId = next+ if (next != null && sourceExists) {+ map.setFeatureState({ source: sourceId, id: next }, { hover: true })+ }+ }++ const findArc = (featureId: string | number | undefined) =>+ featureId == null+ ? undefined+ : latestRef.current.data.find((arc) => String(arc.id) === String(featureId))++ const handleMouseMove = (e: MapLibreGL.MapLayerMouseEvent) => {+ const featureId = e.features?.[0]?.id as string | number | undefined+ if (featureId == null || featureId === hoveredId) return++ setHover(featureId)+ map.getCanvas().style.cursor = 'pointer'++ const arc = findArc(featureId)+ if (arc) {+ latestRef.current.onHover?.({+ arc: arc as T,+ longitude: e.lngLat.lng,+ latitude: e.lngLat.lat,+ originalEvent: e,+ })+ }+ }++ const handleMouseLeave = () => {+ setHover(null)+ map.getCanvas().style.cursor = ''+ latestRef.current.onHover?.(null)+ }++ const handleClick = (e: MapLibreGL.MapLayerMouseEvent) => {+ const arc = findArc(e.features?.[0]?.id as string | number | undefined)+ if (!arc) return+ latestRef.current.onClick?.({+ arc: arc as T,+ longitude: e.lngLat.lng,+ latitude: e.lngLat.lat,+ originalEvent: e,+ })+ }++ map.on('mousemove', hitLayerId, handleMouseMove)+ map.on('mouseleave', hitLayerId, handleMouseLeave)+ map.on('click', hitLayerId, handleClick)++ return () => {+ map.off('mousemove', hitLayerId, handleMouseMove)+ map.off('mouseleave', hitLayerId, handleMouseLeave)+ map.off('click', hitLayerId, handleClick)+ setHover(null)+ map.getCanvas().style.cursor = ''+ }+ }, [isLoaded, map, hitLayerId, sourceId, interactive])++ return null+}++type MapClusterLayerProps<P extends GeoJSON.GeoJsonProperties = GeoJSON.GeoJsonProperties> = {+ /** GeoJSON FeatureCollection data or URL to fetch GeoJSON from */+ data: string | GeoJSON.FeatureCollection<GeoJSON.Point, P>+ /** Maximum zoom level to cluster points on (default: 14) */+ clusterMaxZoom?: number+ /** Radius of each cluster when clustering points in pixels (default: 50) */+ clusterRadius?: number+ /** Colors for cluster circles: [small, medium, large] based on point count (default: ["#3b82f6", "#1d4ed8", "#1e3a8a"]) */+ clusterColors?: [string, string, string]+ /** Point count thresholds for color/size steps: [medium, large] (default: [100, 750]) */+ clusterThresholds?: [number, number]+ /** Color for unclustered individual points (default: "#3b82f6") */+ pointColor?: string+ /** Callback when an unclustered point is clicked */+ onPointClick?: (feature: GeoJSON.Feature<GeoJSON.Point, P>, coordinates: [number, number]) => void+ /** Callback when a cluster is clicked. If not provided, zooms into the cluster */+ onClusterClick?: (clusterId: number, coordinates: [number, number], pointCount: number) => void+}++const DEFAULT_CLUSTER_COLORS: [string, string, string] = ['#3b82f6', '#1d4ed8', '#1e3a8a']+const DEFAULT_CLUSTER_THRESHOLDS: [number, number] = [100, 750]++function MapClusterLayer<P extends GeoJSON.GeoJsonProperties = GeoJSON.GeoJsonProperties>({+ data,+ clusterMaxZoom = 14,+ clusterRadius = 50,+ clusterColors = DEFAULT_CLUSTER_COLORS,+ clusterThresholds = DEFAULT_CLUSTER_THRESHOLDS,+ pointColor = '#3b82f6',+ onPointClick,+ onClusterClick,+}: MapClusterLayerProps<P>) {+ const { map, isLoaded } = useMap()+ const id = useId()+ const sourceId = `cluster-source-${id}`+ const clusterLayerId = `clusters-${id}`+ const clusterCountLayerId = `cluster-count-${id}`+ const unclusteredLayerId = `unclustered-point-${id}`++ const stylePropsRef = useRef({+ clusterColors,+ clusterThresholds,+ pointColor,+ })++ // Add source and layers on mount+ useEffect(() => {+ if (!isLoaded || !map) return++ // Add clustered GeoJSON source+ map.addSource(sourceId, {+ type: 'geojson',+ data,+ cluster: true,+ clusterMaxZoom,+ clusterRadius,+ })++ // Add cluster circles layer+ map.addLayer({+ id: clusterLayerId,+ type: 'circle',+ source: sourceId,+ filter: ['has', 'point_count'],+ paint: {+ 'circle-color': [+ 'step',+ ['get', 'point_count'],+ clusterColors[0],+ clusterThresholds[0],+ clusterColors[1],+ clusterThresholds[1],+ clusterColors[2],+ ],+ 'circle-radius': [+ 'step',+ ['get', 'point_count'],+ 20,+ clusterThresholds[0],+ 30,+ clusterThresholds[1],+ 40,+ ],+ 'circle-stroke-width': 0.75,+ 'circle-stroke-color': '#fff',+ 'circle-opacity': 0.85,+ },+ })++ // Add cluster count text layer+ map.addLayer({+ id: clusterCountLayerId,+ type: 'symbol',+ source: sourceId,+ filter: ['has', 'point_count'],+ layout: {+ 'text-field': '{point_count_abbreviated}',+ 'text-font': ['Open Sans Semibold'],+ 'text-size': 12,+ },+ paint: {+ 'text-color': '#fff',+ },+ })++ // Add unclustered point layer+ map.addLayer({+ id: unclusteredLayerId,+ type: 'circle',+ source: sourceId,+ filter: ['!', ['has', 'point_count']],+ paint: {+ 'circle-color': pointColor,+ 'circle-radius': 5,+ 'circle-stroke-width': 2,+ 'circle-stroke-color': '#fff',+ },+ })++ return () => {+ try {+ if (map.getLayer(clusterCountLayerId)) map.removeLayer(clusterCountLayerId)+ if (map.getLayer(unclusteredLayerId)) map.removeLayer(unclusteredLayerId)+ if (map.getLayer(clusterLayerId)) map.removeLayer(clusterLayerId)+ if (map.getSource(sourceId)) map.removeSource(sourceId)+ } catch {+ // ignore+ }+ }+ // eslint-disable-next-line react-hooks/exhaustive-deps+ }, [isLoaded, map, sourceId])++ // Update source data when data prop changes (only for non-URL data)+ useEffect(() => {+ if (!isLoaded || !map || typeof data === 'string') return++ const source = map.getSource(sourceId) as MapLibreGL.GeoJSONSource+ if (source) {+ source.setData(data)+ }+ }, [isLoaded, map, data, sourceId])++ // Update layer styles when props change+ useEffect(() => {+ if (!isLoaded || !map) return++ const prev = stylePropsRef.current+ const colorsChanged =+ prev.clusterColors !== clusterColors || prev.clusterThresholds !== clusterThresholds++ // Update cluster layer colors and sizes+ if (map.getLayer(clusterLayerId) && colorsChanged) {+ map.setPaintProperty(clusterLayerId, 'circle-color', [+ 'step',+ ['get', 'point_count'],+ clusterColors[0],+ clusterThresholds[0],+ clusterColors[1],+ clusterThresholds[1],+ clusterColors[2],+ ])+ map.setPaintProperty(clusterLayerId, 'circle-radius', [+ 'step',+ ['get', 'point_count'],+ 20,+ clusterThresholds[0],+ 30,+ clusterThresholds[1],+ 40,+ ])+ }++ // Update unclustered point layer color+ if (map.getLayer(unclusteredLayerId) && prev.pointColor !== pointColor) {+ map.setPaintProperty(unclusteredLayerId, 'circle-color', pointColor)+ }++ stylePropsRef.current = { clusterColors, clusterThresholds, pointColor }+ }, [+ isLoaded,+ map,+ clusterLayerId,+ unclusteredLayerId,+ clusterColors,+ clusterThresholds,+ pointColor,+ ])++ // Handle click events+ useEffect(() => {+ if (!isLoaded || !map) return++ // Cluster click handler - zoom into cluster+ const handleClusterClick = async (+ e: MapLibreGL.MapMouseEvent & {+ features?: MapLibreGL.MapGeoJSONFeature[]+ },+ ) => {+ const features = map.queryRenderedFeatures(e.point, {+ layers: [clusterLayerId],+ })+ if (!features.length) return++ const feature = features[0]+ const clusterId = feature.properties?.cluster_id as number+ const pointCount = feature.properties?.point_count as number+ const coordinates = (feature.geometry as GeoJSON.Point).coordinates as [number, number]++ if (onClusterClick) {+ onClusterClick(clusterId, coordinates, pointCount)+ } else {+ // Default behavior: zoom to cluster expansion zoom+ const source = map.getSource(sourceId) as MapLibreGL.GeoJSONSource+ const zoom = await source.getClusterExpansionZoom(clusterId)+ map.easeTo({+ center: coordinates,+ zoom,+ })+ }+ }++ // Unclustered point click handler+ const handlePointClick = (+ e: MapLibreGL.MapMouseEvent & {+ features?: MapLibreGL.MapGeoJSONFeature[]+ },+ ) => {+ if (!onPointClick || !e.features?.length) return++ const feature = e.features[0]+ const coordinates = (feature.geometry as GeoJSON.Point).coordinates.slice() as [+ number,+ number,+ ]++ // Handle world copies+ while (Math.abs(e.lngLat.lng - coordinates[0]) > 180) {+ coordinates[0] += e.lngLat.lng > coordinates[0] ? 360 : -360+ }++ onPointClick(feature as unknown as GeoJSON.Feature<GeoJSON.Point, P>, coordinates)+ }++ // Cursor style handlers+ const handleMouseEnterCluster = () => {+ map.getCanvas().style.cursor = 'pointer'+ }+ const handleMouseLeaveCluster = () => {+ map.getCanvas().style.cursor = ''+ }+ const handleMouseEnterPoint = () => {+ if (onPointClick) {+ map.getCanvas().style.cursor = 'pointer'+ }+ }+ const handleMouseLeavePoint = () => {+ map.getCanvas().style.cursor = ''+ }++ map.on('click', clusterLayerId, handleClusterClick)+ map.on('click', unclusteredLayerId, handlePointClick)+ map.on('mouseenter', clusterLayerId, handleMouseEnterCluster)+ map.on('mouseleave', clusterLayerId, handleMouseLeaveCluster)+ map.on('mouseenter', unclusteredLayerId, handleMouseEnterPoint)+ map.on('mouseleave', unclusteredLayerId, handleMouseLeavePoint)++ return () => {+ map.off('click', clusterLayerId, handleClusterClick)+ map.off('click', unclusteredLayerId, handlePointClick)+ map.off('mouseenter', clusterLayerId, handleMouseEnterCluster)+ map.off('mouseleave', clusterLayerId, handleMouseLeaveCluster)+ map.off('mouseenter', unclusteredLayerId, handleMouseEnterPoint)+ map.off('mouseleave', unclusteredLayerId, handleMouseLeavePoint)+ }+ }, [isLoaded, map, clusterLayerId, unclusteredLayerId, sourceId, onClusterClick, onPointClick])++ return null+}++export type {+ MapArcDatum,+ MapArcEvent,+ MapArcProps,+ MapClusterLayerProps,+ MapControlsProps,+ MapGeoJSONData,+ MapGeoJSONEvent,+ MapGeoJSONFeature,+ MapGeoJSONProps,+ MapMarkerProps,+ MapPopupProps,+ MapProps,+ MapRef,+ MapRouteProps,+ MapStyleOption,+ MapViewport,+ MarkerContentProps,+ MarkerLabelProps,+ MarkerPopupProps,+ MarkerTooltipProps,+}+export {+ Map,+ MapArc,+ MapClusterLayer,+ MapControls,+ MapGeoJSON,+ MapMarker,+ MapPopup,+ MapRoute,+ MarkerContent,+ MarkerLabel,+ MarkerPopup,+ MarkerTooltip,+ useMap,+}diff --git a/packages/dashboard/src/hooks/use-sellers.ts b/packages/dashboard/src/hooks/use-sellers.tsindex 95ca895b7a..e1ea36818e 100644--- a/packages/dashboard/src/hooks/use-sellers.ts+++ b/packages/dashboard/src/hooks/use-sellers.ts@@ -1,9 +1,11 @@import type {ListParams,Seller,+ SellerApproveParams,SellerCreateParams,SellerInviteParams,SellerRejectParams,+ SellerReopenOnboardingParams,SellerSuspendParams,SellerUpdateParams,} from '@spree/admin-sdk'@@ -90,15 +92,40 @@ export function useInviteSeller(id: string) {})}+/**+ * Admits a seller. The server refuses while a required onboarding requirement+ * is unmet, so pass `override_requirements` to admit one anyway — the page+ * turns that into a confirm dialog naming what is outstanding, and the+ * `seller.approved` event records the override.+ *+ * Invalidates the seller's onboarding query as well as the seller itself,+ * since approving can change what the checklist reports.+ */export function useApproveSeller(id: string) {- return useResourceMutation<Seller, Error, void>({- mutationFn: () => adminClient.sellers.approve(id),- invalidate: [['sellers'], ['sellers', id]],+ return useResourceMutation<Seller, Error, SellerApproveParams | undefined>({+ mutationFn: (params) => adminClient.sellers.approve(id, params ?? undefined),+ invalidate: [['sellers'], ['sellers', id], ['sellers', id, 'onboarding']],successMessage: i18n.t('admin.sellers.messages.approved'),errorMessage: i18n.t('admin.sellers.messages.approve_failed'),})}+/**+ * Sends a seller awaiting review back to onboarding, optionally with a note+ * saying what to fix. Distinct from rejecting them, which turns them away.+ *+ * Invalidates the onboarding query too, because the seller's standing against+ * the checklist changes with their status.+ */+export function useReopenSellerOnboarding(id: string) {+ return useResourceMutation<Seller, Error, SellerReopenOnboardingParams | undefined>({+ mutationFn: (params) => adminClient.sellers.reopenOnboarding(id, params ?? undefined),+ invalidate: [['sellers'], ['sellers', id], ['sellers', id, 'onboarding']],+ successMessage: i18n.t('admin.sellers.messages.onboarding_reopened'),+ errorMessage: i18n.t('admin.errors.failed_to_update'),+ })+}+export function useSuspendSeller(id: string) {return useResourceMutation<Seller, Error, SellerSuspendParams | undefined>({mutationFn: (params) => adminClient.sellers.suspend(id, params ?? undefined),diff --git a/packages/dashboard/src/locales/ar.json b/packages/dashboard/src/locales/ar.jsonindex 5c76122393..574be901f4 100644--- a/packages/dashboard/src/locales/ar.json+++ b/packages/dashboard/src/locales/ar.json@@ -289,6 +289,97 @@},"title": "المجموعات"},+ "commission_rates": {+ "add_cta": "إضافة نسبة عمولة",+ "applies_to_everything": "كل عملية بيع",+ "create_description": "حدّد ما يتقاضاه السوق من البائعين، وعلى أي مبيعات ينطبق.",+ "create_label": "إنشاء نسبة العمولة",+ "delete_confirm": {+ "message": "سيتم حذف {{name}}. العمولات المحتسبة سابقًا لن تتأثر.",+ "title": "حذف نسبة العمولة؟"+ },+ "edit_description": "حدّث الرسوم وحدودها والمبيعات التي تنطبق عليها.",+ "empty": "لا توجد نسب عمولة بعد",+ "messages": {+ "created": "تم إنشاء نسبة العمولة",+ "deleted": "تم حذف نسبة العمولة",+ "updated": "تم تحديث نسبة العمولة"+ },+ "search_placeholder": "البحث بالاسم…",+ "order_hint": "تُضاف النسب الجديدة إلى أعلى القائمة، وتفوز أول نسبة مطابقة — اسحب لإعادة الترتيب.",+ "conditions": {+ "add": "إضافة شرط",+ "title": "الشروط"+ }+ },+ "companies": {+ "add_cta": "إضافة شركة",+ "add_sheet_title": "شركة جديدة",+ "create_description": "يشتري العملاء من الشركات عبر الفروع. يمكنك إضافة الفروع والرقم الضريبي وشهادات الإعفاء بعد إنشاء الشركة.",+ "create_label": "إنشاء الشركة",+ "delete_confirm": {+ "message": "سيؤدي هذا إلى حذف {{name}} مع فروعها ومشترييها وشهاداتها. لا يمكن التراجع عن هذا الإجراء.",+ "title": "حذف الشركة؟"+ },+ "detail": {+ "delete_label": "حذف الشركة",+ "load_error": "تعذر تحميل هذه الشركة",+ "profile": "الشركة"+ },+ "empty": "لا توجد شركات بعد",+ "locations_column": "الفروع",+ "messages": {+ "created": "تم إنشاء الشركة",+ "deleted": "تم حذف الشركة",+ "updated": "تم تحديث الشركة"+ },+ "search_placeholder": "البحث في الشركات"+ },+ "company_contacts": {+ "add_cta": "إضافة مشترٍ",+ "add_title": "تخويل مشترٍ",+ "dialog_description": "عميل يشتري لهذا الفرع. من يشتري لفرع واحد فقط تُنسب طلباته إليه تلقائياً.",+ "empty": "لم يتم تخويل أي مشترٍ بعد",+ "messages": {+ "created": "تمت إضافة المشتري",+ "deleted": "تمت إزالة المشتري"+ },+ "remove_action": "إزالة المشتري",+ "remove_confirm": {+ "message": "لن يعود {{email}} يشتري لهذا الفرع. لن يتأثر حساب العميل.",+ "title": "إزالة هذا المشتري؟"+ },+ "roles_enterprise_help": "يمكن للمشترين المضافين هنا تقديم الطلبات لهذا الفرع. الأدوار ومسارات الموافقة وحدود الإنفاق تأتي مع Spree Enterprise.",+ "roles_enterprise_title": "الأدوار والموافقات من مزايا Enterprise",+ "title": "المشترون"+ },+ "company_locations": {+ "add_cta": "إضافة فرع",+ "add_title": "فرع جديد",+ "addresses": "العناوين",+ "billing_address": "عنوان الفوترة",+ "contacts_count_few": "{{count}} مشترين",+ "contacts_count_many": "{{count}} مشترياً",+ "contacts_count_one": "مشترٍ واحد",+ "contacts_count_other": "{{count}} مشترٍ",+ "contacts_count_two": "مشتريان",+ "contacts_count_zero": "لا مشترين",+ "detail": {+ "delete_label": "حذف الفرع",+ "load_error": "تعذر تحميل هذا الفرع"+ },+ "dialog_description": "الفرع هو الجهة التي تُصدر لها الفاتورة وتُشحن إليها الطلبات. العناوين اختيارية، لكن أي عنوان تبدأ بتعبئته يتطلب الاسم والدولة.",+ "edit_title": "تعديل الفرع",+ "empty": "لا توجد فروع بعد",+ "messages": {+ "created": "تم إنشاء الفرع",+ "deleted": "تم حذف الفرع",+ "updated": "تم تحديث الفرع"+ },+ "shipping_address": "عنوان الشحن",+ "shipping_same_as_billing": "عنوان الشحن هو نفسه عنوان الفوترة",+ "title": "الفروع"+ },"components": {"adjustment_action_editor": {"calculator_label": "آلة حاسبة",@@ -547,6 +638,67 @@"split_description": "اشحن المنتجات نفسها من مستودع ثانٍ له مناطقه وأسعاره الخاصة.","split_title": "تقسيم مصادر الشحن"},+ "delivery_profiles": {+ "add_cta": "إضافة ملف",+ "add_dialog_title": "ملف توصيل جديد",+ "all_locations": "جميع المواقع",+ "capabilities": {+ "digital": "رقمي",+ "pickup": "استلام",+ "ships": "شحن"+ },+ "create_description": "اجمع المنتجات التي تُشحن بالطريقة نفسها، مع مواقع ومناطق وطرق توصيل خاصة بها.",+ "create_label": "إنشاء الملف",+ "default_badge": "افتراضي",+ "default_confirm": {+ "message": "ستُشحن المنتجات التي لا ملف خاص لها عبر «{{name}}».",+ "title": "تعيينه ملفًا افتراضيًا"+ },+ "delete_confirm": {+ "message": "هل تريد حذف «{{name}}»؟ ستُحذف معه مناطقه وطرق التوصيل الخاصة به.",+ "title": "حذف ملف الشحن"+ },+ "detail": {+ "add_digital_method": "إضافة طريقة رقمية",+ "add_method": "إضافة طريقة",+ "collect_from": "الاستلام من",+ "collect_from_hint": "المواقع التي يمكن للعملاء الاستلام منها. تسري التغييرات فورًا.",+ "delete_label": "حذف الملف",+ "digital_empty": "لا توجد طريقة تسليم رقمي بعد.",+ "digital_hint": "يُسلَّم دون شحن أو استلام.",+ "digital_title": "التسليم الرقمي",+ "general_title": "عام",+ "hidden_badge": "مخفية",+ "load_failed_title": "تعذّر تحميل ملف الشحن هذا",+ "no_methods": "لا توجد طرق توصيل هنا بعد.",+ "no_stock_locations": "لا توجد مواقع بعد — أضف موقعًا من الإعدادات ← المواقع.",+ "no_zone_hint": "تُعرض هذه الطرق في كل مكان يغطيه هذا الملف.",+ "no_zone_title": "بدون تقييد بمنطقة",+ "no_zones": "لا توجد مناطق بعد — أضف واحدة لتبدأ بعرض طرق التوصيل.",+ "offer_pickup": "إتاحة الاستلام",+ "origins_title": "الشحن من",+ "pickup_empty": "لا توجد طريقة استلام بعد — لا يمكن للعملاء استلام الطلبات في هذا الملف.",+ "pickup_hint": "يستلم العملاء هذه الطلبات بأنفسهم. الاستلام ليس له وجهة، لذا لا تنطبق المناطق.",+ "pickup_title": "الاستلام من المتجر",+ "zones_title": "المناطق وطرق التوصيل"+ },+ "empty": "لا توجد ملفات توصيل بعد.",+ "is_default_hint": "المنتجات التي لا ملف خاص لها تُشحن عبر هذا الملف.",+ "kind_immutable_hint": "يُحدَّد النوع عند إنشاء الملف ولا يمكن تغييره.",+ "kinds": {+ "digital": "رقمي",+ "shipping": "شحن"+ },+ "locations_count": "{{count}} مواقع",+ "make_default": "تعيين كافتراضي",+ "messages": {+ "created": "تم إنشاء ملف الشحن",+ "deleted": "تم حذف ملف الشحن",+ "updated": "تم تحديث ملف الشحن"+ },+ "search_placeholder": "ابحث في ملفات التوصيل…",+ "selected_locations": "المواقع المحددة"+ },"delivery_zones": {"add_countries_in_markets": "أضف المزيد من البلدان في الأسواق","add_cta": "إضافة منطقة توصيل",@@ -601,6 +753,9 @@"to_placeholder": "إلى","toggle_states": "عرض مناطق {{country}}"},+ "enterprise": {+ "learn_more": "تعرّف على Spree Enterprise"+ },"errors": {"forbidden_description": "ليس لديك إذن لعرض هذه الصفحة.","forbidden_title": "غير مصرح",@@ -1729,67 +1884,6 @@}}},- "delivery_profiles": {- "add_cta": "إضافة ملف",- "add_dialog_title": "ملف توصيل جديد",- "all_locations": "جميع المواقع",- "capabilities": {- "digital": "رقمي",- "pickup": "استلام",- "ships": "شحن"- },- "create_description": "اجمع المنتجات التي تُشحن بالطريقة نفسها، مع مواقع ومناطق وطرق توصيل خاصة بها.",- "create_label": "إنشاء الملف",- "default_badge": "افتراضي",- "default_confirm": {- "message": "ستُشحن المنتجات التي لا ملف خاص لها عبر «{{name}}».",- "title": "تعيينه ملفًا افتراضيًا"- },- "delete_confirm": {- "message": "هل تريد حذف «{{name}}»؟ ستُحذف معه مناطقه وطرق التوصيل الخاصة به.",- "title": "حذف ملف الشحن"- },- "detail": {- "add_digital_method": "إضافة طريقة رقمية",- "add_method": "إضافة طريقة",- "collect_from": "الاستلام من",- "collect_from_hint": "المواقع التي يمكن للعملاء الاستلام منها. تسري التغييرات فورًا.",- "delete_label": "حذف الملف",- "digital_empty": "لا توجد طريقة تسليم رقمي بعد.",- "digital_hint": "يُسلَّم دون شحن أو استلام.",- "digital_title": "التسليم الرقمي",- "general_title": "عام",- "hidden_badge": "مخفية",- "load_failed_title": "تعذّر تحميل ملف الشحن هذا",- "no_methods": "لا توجد طرق توصيل هنا بعد.",- "no_stock_locations": "لا توجد مواقع بعد — أضف موقعًا من الإعدادات ← المواقع.",- "no_zone_hint": "تُعرض هذه الطرق في كل مكان يغطيه هذا الملف.",- "no_zone_title": "بدون تقييد بمنطقة",- "no_zones": "لا توجد مناطق بعد — أضف واحدة لتبدأ بعرض طرق التوصيل.",- "offer_pickup": "إتاحة الاستلام",- "origins_title": "الشحن من",- "pickup_empty": "لا توجد طريقة استلام بعد — لا يمكن للعملاء استلام الطلبات في هذا الملف.",- "pickup_hint": "يستلم العملاء هذه الطلبات بأنفسهم. الاستلام ليس له وجهة، لذا لا تنطبق المناطق.",- "pickup_title": "الاستلام من المتجر",- "zones_title": "المناطق وطرق التوصيل"- },- "empty": "لا توجد ملفات توصيل بعد.",- "is_default_hint": "المنتجات التي لا ملف خاص لها تُشحن عبر هذا الملف.",- "kind_immutable_hint": "يُحدَّد النوع عند إنشاء الملف ولا يمكن تغييره.",- "kinds": {- "digital": "رقمي",- "shipping": "شحن"- },- "locations_count": "{{count}} مواقع",- "make_default": "تعيين كافتراضي",- "messages": {- "created": "تم إنشاء ملف الشحن",- "deleted": "تم حذف ملف الشحن",- "updated": "تم تحديث ملف الشحن"- },- "search_placeholder": "ابحث في ملفات التوصيل…",- "selected_locations": "المواقع المحددة"- },"gift_cards": {"batch_autocomplete": {"empty": "لا توجد دفعات مطابقة",@@ -1950,6 +2044,9 @@"sign_in_and_accept": "Sign in & accept","sign_in_to_accept": ". قم بتسجيل الدخول للقبول."},+ "jurisdiction": {+ "everywhere": "كل المناطق"+ },"markets": {"add_cta": "إضافة سوق","columns": {@@ -3790,23 +3887,257 @@"name_required": "الاسم مطلوب"}},- "settings": {- "webhooks": {- "errors": {- "redeliver_failed": "تعذّرت إعادة التسليم",- "send_test_failed": "فشل إرسال الرد التلقائي على الويب للاختبار"+ "seller_requirements": {+ "title": "متطلبات البائعين",+ "search_placeholder": "ابحث في المتطلبات",+ "empty": "لا توجد متطلبات بعد. يمكن للبائعين طلب المراجعة فورًا.",+ "add_cta": "إضافة متطلب",+ "add_title": "إضافة متطلب",+ "edit_title": "تعديل المتطلب",+ "columns": {+ "kind": "النوع",+ "required": "مطلوب"+ },+ "required": {+ "yes": "مطلوب",+ "no": "موصى به"+ },+ "status": {+ "disabled": "متوقف"+ },+ "fields": {+ "accepted_files": {+ "label": "الملفات المقبولة",+ "help": "يمكن للبائعين رفع: {{types}}"},- "messages": {- "removed": "تمت إزالة نقطة نهاية Webhook",- "updated": "تم تحديث نقطة نهاية Webhook"+ "active": {+ "label": "مفعّل",+ "help": "أوقفه للتوقف عن طلبه دون حذفه."+ },+ "custom_fields": {+ "label": "الحقول المخصصة",+ "help": "على البائع تعبئة كل حقل تختاره.",+ "placeholder": "ابحث عن الحقول",+ "empty": "لا توجد حقول للبائعين. أنشئها من الإعدادات ← الحقول المخصصة."+ },+ "description": {+ "label": "التعليمات",+ "placeholder": "اشرح للبائع ما تحتاجه ولماذا"+ },+ "kind": {+ "label": "النوع",+ "placeholder": "اختر ما تطلبه"+ },+ "name": {+ "label": "الاسم",+ "label_required": "الاسم (مطلوب)",+ "help": "ما يراه البائع في قائمته."+ },+ "required": {+ "label": "مطلوب",+ "help": "يجب إنجاز العناصر المطلوبة قبل الموافقة. أما الباقي فيُعرض كموصى به."}+ },+ "delete_confirm": {+ "title": "حذف المتطلب؟",+ "message": "لن يُطلب من البائعين «{{name}}» بعد الآن. كما سيُحذف ما قدّموه بشأنه."+ },+ "messages": {+ "created": "تمت إضافة المتطلب",+ "updated": "تم حفظ المتطلب",+ "deleted": "تم حذف المتطلب",+ "submission_accepted": "تم القبول",+ "submission_rejected": "أُعيد إلى البائع",+ "waived": "تم إعفاء هذا البائع من المتطلب"+ },+ "kinds": {+ "accept_terms": "قبول الشروط",+ "complete_profile": "استكمال الملف",+ "billing_address": "عنوان الفوترة",+ "returns_address": "عنوان المرتجعات",+ "minimum_products": "الحد الأدنى للمنتجات",+ "required_custom_fields": "الحقول المخصصة المطلوبة",+ "attestation": "إقرار البائع",+ "operator_review": "مراجعة يدوية",+ "document": "مستند"}},- "settings_nav": {- "groups": {- "audit": "التدقيق",- "fulfillment": "التنفيذ",- "payments": "المدفوعات والضرائب",+ "sellers": {+ "actions": {+ "invite": "دعوة",+ "reinvite": "إعادة الإرسال",+ "send_invitation": "إرسال الدعوة",+ "approve": "الموافقة",+ "reinstate": "إعادة التفعيل",+ "suspend": "تعليق",+ "reject": "رفض",+ "reopen_onboarding": "إعادة إلى الإعداد"+ },+ "add_cta": "إضافة بائع",+ "add_sheet_title": "بائع جديد",+ "address": {+ "filled": "مكتمل",+ "not_filled": "غير مكتمل",+ "not_provided_by_seller": "لم يقدّمه البائع بعد",+ "not_located_yet": "تظهر الخريطة بعد تحديد موقع هذا العنوان."+ },+ "approve_override_confirm": {+ "title": "الموافقة رغم ذلك؟",+ "message": "لم يُكمل هذا البائع: {{names}}. الموافقة الآن تتيح له البيع رغم ذلك، وسيُسجَّل القرار.",+ "action": "وافق رغم ذلك"+ },+ "autocomplete": {+ "placeholder": "ابحث عن بائعين",+ "empty": "لم يُعثر على بائعين"+ },+ "create_description": "أنشئ سجل البائع أولاً، ثم ادعُه ووافق عليه واضبط الدفعات من صفحته.",+ "create_label": "إنشاء البائع",+ "delete_confirm": {+ "title": "حذف البائع؟",+ "message": "سيؤدي هذا إلى إزالة {{name}} من السوق. تبقى منتجاته في الكتالوج بلا بائع. لا يمكن التراجع عن ذلك."+ },+ "detail": {+ "load_error": "تعذّر تحميل هذا البائع",+ "delete_label": "حذف البائع",+ "status": "الحالة",+ "settlement": "الدفعات والضرائب",+ "at_a_glance": "لمحة سريعة",+ "contact": "التواصل",+ "edit_profile": "تعديل الملف",+ "edit_profile_description": "يحرّر البائع هذه البيانات من لوحته الخاصة، وما تعدّله هنا يجري نيابةً عنه.",+ "edit_settlement": "تعديل الدفعات والضرائب",+ "edit_settlement_description": "أنت وحدك من يرى هذه الإعدادات ويغيّرها، ولا يحرّرها البائع.",+ "no_about": "لم يكتب هذا البائع نبذة بعد.",+ "billing_address": "عنوان الفوترة",+ "returns_address": "عنوان المرتجعات"+ },+ "empty": "لا يوجد بائعون بعد",+ "images": {+ "logo_label": "الشعار",+ "logo_help": "يُفضَّل الشكل المربّع. يظهر بجوار البائع في كل مكان يرد فيه.",+ "square_logo_label": "شعار مربّع",+ "square_logo_help": "للمواضع التي تتطلب مربّعاً دقيقاً، مثل الصورة الرمزية.",+ "cover_photo_label": "صورة الغلاف",+ "cover_photo_help": "لافتة عريضة أعلى ملف البائع."+ },+ "invite_sheet": {+ "title": "دعوة بائع",+ "description": "ينضم الشخص إلى فريق البائع عند قبول الدعوة، ويمكنه بعدها الدخول إلى لوحته الخاصة.",+ "email_help": "سترسل الدعوة إلى هذا العنوان."+ },+ "messages": {+ "created": "تم إنشاء البائع",+ "create_failed": "تعذّر إنشاء البائع",+ "updated": "تم تحديث البائع",+ "update_failed": "تعذّر تحديث البائع",+ "deleted": "تم حذف البائع",+ "delete_failed": "تعذّر حذف البائع",+ "invited": "تم إرسال الدعوة",+ "invite_failed": "تعذّر إرسال الدعوة",+ "approved": "تمت الموافقة على البائع",+ "approve_failed": "تعذّرت الموافقة على البائع",+ "suspended": "تم تعليق البائع",+ "suspend_failed": "تعذّر تعليق البائع",+ "rejected": "تم رفض البائع",+ "reject_failed": "تعذّر رفض البائع",+ "onboarding_reopened": "أُعيد إلى الإعداد"+ },+ "not_provided": "غير محدد",+ "on_holiday_notice": "هذا البائع في إجازة. تبقى منتجاته ظاهرة لكن لا يمكن شراء أي منها.",+ "onboarding": {+ "title": "الإعداد",+ "progress": "اكتمل {{done}} من {{total}}",+ "waived": "مُعفى",+ "download": "تنزيل الملف",+ "seller_note": "البائع: {{note}}",+ "review_note": "ملاحظتك: {{note}}",+ "actions": {+ "accept": "قبول",+ "reject": "إعادة",+ "waive": "إعفاء هذا البائع"+ },+ "reject_confirm": {+ "title": "إعادته؟",+ "message": "سيُطلب من البائع «{{name}}» مرة أخرى."+ },+ "waive_confirm": {+ "title": "إعفاء من هذا المتطلب؟",+ "message": "سيُعدّ «{{name}}» مستوفىً لهذا البائع فقط."+ },+ "all_done": "اكتمل كل شيء 🎉",+ "status": {+ "complete": "تم",+ "pending": "قيد المراجعة",+ "rejected": "أُعيد",+ "incomplete": "معلّق"+ }+ },+ "onboarding_column": "الإعداد",+ "payout_interval": {+ "inherit": "الإعداد الافتراضي للمتجر",+ "daily": "يومياً",+ "weekly": "أسبوعياً",+ "biweekly": "كل أسبوعين",+ "monthly": "شهرياً",+ "manual": "يدوي"+ },+ "products_column": "المنتجات",+ "reject_confirm": {+ "title": "رفض البائع؟",+ "message": "لن يُقبل {{name}} في السوق. يمكنك الموافقة عليه لاحقاً إذا لزم الأمر."+ },+ "reopen_onboarding_confirm": {+ "title": "إعادته إلى الإعداد؟",+ "message": "سيتمكن {{name}} من تعديل بياناته وطلب المراجعة مجددًا."+ },+ "search_placeholder": "ابحث عن بائعين",+ "status": {+ "pending": "قيد الانتظار",+ "invited": "مدعو",+ "onboarding": "قيد الإعداد",+ "ready_for_review": "جاهز للمراجعة",+ "approved": "معتمد",+ "suspended": "معلّق",+ "rejected": "مرفوض",+ "canceled": "ملغى"+ },+ "status_help": {+ "pending": "تم الإنشاء، ولم تُرسل أي دعوة بعد.",+ "invited": "في انتظار قبول الدعوة.",+ "onboarding": "يستكمل بياناته.",+ "ready_for_review": "في انتظار موافقتك.",+ "approved": "يبيع في السوق.",+ "suspended": "موقوف عن البيع. أعد تفعيله ليتاجر من جديد.",+ "rejected": "غير مقبول في السوق.",+ "canceled": "انسحب قبل الانضمام."+ },+ "suspend_confirm": {+ "title": "تعليق البائع؟",+ "message": "سيتوقف {{name}} عن البيع فوراً. يبقى الكتالوج والسجل، ويمكنك إعادته لاحقاً."+ },+ "tax_remittance": {+ "seller": "البائع يورّد الضريبة",+ "platform": "السوق يورّد الضريبة"+ },+ "team_column": "الفريق"+ },+ "settings": {+ "webhooks": {+ "errors": {+ "redeliver_failed": "تعذّرت إعادة التسليم",+ "send_test_failed": "فشل إرسال الرد التلقائي على الويب للاختبار"+ },+ "messages": {+ "removed": "تمت إزالة نقطة نهاية Webhook",+ "updated": "تم تحديث نقطة نهاية Webhook"+ }+ }+ },+ "settings_nav": {+ "groups": {+ "audit": "التدقيق",+ "fulfillment": "التنفيذ",+ "payments": "المدفوعات والضرائب","store": "المتجر","team": "الفريق والوصول"},@@ -3814,6 +4145,7 @@"allowed_origins": "المصادر المسموح بها","api_keys": "مفاتيح API","channels": "قنوات البيع",+ "commission_rates": "نسب العمولة","custom_field_definitions": "الحقول المخصصة","delivery_profiles": "ملفات التوصيل","emails": "البريد الإلكتروني",@@ -3825,13 +4157,13 @@"profile": "الملف الشخصي","reasons": "المرتجعات والأسباب","roles": "الأدوار",+ "seller_requirements": "متطلبات البائعين","staff": "الموظفون","stock_locations": "مواقع المخزون","store": "المتجر","tax_categories": "فئات الضريبة","tax_rates": "نسب الضريبة",- "webhooks": "Webhooks",- "commission_rates": "نسب العمولة"+ "webhooks": "Webhooks"}},"setup": {@@ -3996,95 +4328,50 @@},"search_placeholder": "البحث بالاسم…"},- "translations": {- "coverage_summary": "تمت ترجمة {{translated}} من {{total}} لغة",- "dirty_summary": "{{count}} تغيير(ات) غير محفوظة",- "discard_confirm": {- "message": "لديك {{count}} تغيير(ات) ترجمة غير محفوظة. هل تريد تجاهلها؟",- "title": "تجاهل التغييرات؟"- },- "field": "الحقل",- "load_error": "تعذر تحميل الترجمات",- "locale": "اللغة",- "manage": "إدارة الترجمات",- "no_locales": "أضف المزيد من اللغات إلى متجرك لترجمة هذا المنتج.",- "original": "الأصل",- "save": "حفظ الترجمات",- "save_error": "تعذر حفظ الترجمات",- "saved": "تم حفظ الترجمات",- "source": "المصدر",- "title": "الترجمات"- },- "jurisdiction": {- "everywhere": "كل المناطق"- },- "companies": {- "add_cta": "إضافة شركة",- "add_sheet_title": "شركة جديدة",- "create_description": "يشتري العملاء من الشركات عبر الفروع. يمكنك إضافة الفروع والرقم الضريبي وشهادات الإعفاء بعد إنشاء الشركة.",- "create_label": "إنشاء الشركة",+ "tax_exemption_certificates": {+ "add_cta": "إضافة شهادة",+ "add_title": "إضافة شهادة إعفاء","delete_confirm": {- "message": "سيؤدي هذا إلى حذف {{name}} مع فروعها ومشترييها وشهاداتها. لا يمكن التراجع عن هذا الإجراء.",- "title": "حذف الشركة؟"- },- "detail": {- "delete_label": "حذف الشركة",- "load_error": "تعذر تحميل هذه الشركة",- "profile": "الشركة"+ "message": "ستتم إزالة الشهادة {{number}}. لا يمكن التراجع عن هذا الإجراء.",+ "title": "حذف هذه الشهادة؟"},- "empty": "لا توجد شركات بعد",- "locations_column": "الفروع",+ "dialog_description": "إثبات أن مشتريات هذه الشركة غير خاضعة للضريبة. لا تسري الشهادة الجديدة إلا بعد قبولها.",+ "download_action": "تنزيل المستند",+ "empty": "لا توجد شهادات مسجلة",+ "expires_prefix": "تنتهي",+ "lapsed": "منتهية","messages": {- "created": "تم إنشاء الشركة",- "deleted": "تم حذف الشركة",- "updated": "تم تحديث الشركة"- },- "search_placeholder": "البحث في الشركات"- },- "company_locations": {- "add_cta": "إضافة فرع",- "add_title": "فرع جديد",- "addresses": "العناوين",- "billing_address": "عنوان الفوترة",- "contacts_count_few": "{{count}} مشترين",- "contacts_count_many": "{{count}} مشترياً",- "contacts_count_one": "مشترٍ واحد",- "contacts_count_other": "{{count}} مشترٍ",- "contacts_count_two": "مشتريان",- "contacts_count_zero": "لا مشترين",- "detail": {- "delete_label": "حذف الفرع",- "load_error": "تعذر تحميل هذا الفرع"+ "created": "تمت إضافة الشهادة",+ "deleted": "تم حذف الشهادة",+ "revoked": "تم إلغاء الشهادة",+ "updated": "تم تحديث الشهادة",+ "verified": "تم قبول الشهادة"},- "dialog_description": "الفرع هو الجهة التي تُصدر لها الفاتورة وتُشحن إليها الطلبات. العناوين اختيارية، لكن أي عنوان تبدأ بتعبئته يتطلب الاسم والدولة.",- "edit_title": "تعديل الفرع",- "empty": "لا توجد فروع بعد",- "messages": {- "created": "تم إنشاء الفرع",- "deleted": "تم حذف الفرع",- "updated": "تم تحديث الفرع"+ "never_expires": "بلا تاريخ انتهاء",+ "no_document": "لا يوجد مستند مرفق",+ "reason_codes": {+ "agricultural": "الزراعة",+ "charitable": "جهة خيرية",+ "educational": "جهة تعليمية",+ "government": "جهة حكومية",+ "manufacturing": "التصنيع",+ "resale": "إعادة البيع"},- "shipping_address": "عنوان الشحن",- "shipping_same_as_billing": "عنوان الشحن هو نفسه عنوان الفوترة",- "title": "الفروع"- },- "company_contacts": {- "add_cta": "إضافة مشترٍ",- "add_title": "تخويل مشترٍ",- "dialog_description": "عميل يشتري لهذا الفرع. من يشتري لفرع واحد فقط تُنسب طلباته إليه تلقائياً.",- "empty": "لم يتم تخويل أي مشترٍ بعد",- "messages": {- "created": "تمت إضافة المشتري",- "deleted": "تمت إزالة المشتري"+ "revoke_action": "إلغاء",+ "revoke_confirm": {+ "message": "لن تعود الشهادة {{number}} تسري على الطلبات الجديدة، لكنها تبقى محفوظة كسجل.",+ "title": "إلغاء هذه الشهادة؟"},- "remove_action": "إزالة المشتري",- "remove_confirm": {- "message": "لن يعود {{email}} يشتري لهذا الفرع. لن يتأثر حساب العميل.",- "title": "إزالة هذا المشتري؟"+ "select_reason": "اختر السبب",+ "status": {+ "expired": "منتهية الصلاحية",+ "pending": "بانتظار المراجعة",+ "revoked": "ملغاة",+ "verified": "مقبولة"},- "roles_enterprise_help": "يمكن للمشترين المضافين هنا تقديم الطلبات لهذا الفرع. الأدوار ومسارات الموافقة وحدود الإنفاق تأتي مع Spree Enterprise.",- "roles_enterprise_title": "الأدوار والموافقات من مزايا Enterprise",- "title": "المشترون"+ "title": "شهادات الإعفاء",+ "verified_at": "تاريخ القبول",+ "verify_action": "قبول"},"tax_identifiers": {"add_cta": "إضافة رقم",@@ -4124,50 +4411,11 @@"verified": "تم التحقق"}},- "tax_exemption_certificates": {- "add_cta": "إضافة شهادة",- "add_title": "إضافة شهادة إعفاء",- "delete_confirm": {- "message": "ستتم إزالة الشهادة {{number}}. لا يمكن التراجع عن هذا الإجراء.",- "title": "حذف هذه الشهادة؟"- },- "dialog_description": "إثبات أن مشتريات هذه الشركة غير خاضعة للضريبة. لا تسري الشهادة الجديدة إلا بعد قبولها.",- "download_action": "تنزيل المستند",- "empty": "لا توجد شهادات مسجلة",- "expires_prefix": "تنتهي",- "lapsed": "منتهية",- "messages": {- "created": "تمت إضافة الشهادة",- "deleted": "تم حذف الشهادة",- "revoked": "تم إلغاء الشهادة",- "updated": "تم تحديث الشهادة",- "verified": "تم قبول الشهادة"- },- "never_expires": "بلا تاريخ انتهاء",- "no_document": "لا يوجد مستند مرفق",- "reason_codes": {- "agricultural": "الزراعة",- "charitable": "جهة خيرية",- "educational": "جهة تعليمية",- "government": "جهة حكومية",- "manufacturing": "التصنيع",- "resale": "إعادة البيع"- },- "revoke_action": "إلغاء",- "revoke_confirm": {- "message": "لن تعود الشهادة {{number}} تسري على الطلبات الجديدة، لكنها تبقى محفوظة كسجل.",- "title": "إلغاء هذه الشهادة؟"- },- "select_reason": "اختر السبب",- "status": {- "expired": "منتهية الصلاحية",- "pending": "بانتظار المراجعة",- "revoked": "ملغاة",- "verified": "مقبولة"- },- "title": "شهادات الإعفاء",- "verified_at": "تاريخ القبول",- "verify_action": "قبول"+ "tax_providers": {+ "limitations_title": "{{name}} لا يغطي",+ "unavailable_option": "{{name}} (غير مُعد)",+ "use_default": "استخدام المحرك الافتراضي",+ "use_default_named": "الافتراضي ({{name}})"},"tax_rates": {"add_cta": "إضافة نسبة ضريبة",@@ -4190,148 +4438,24 @@"search_placeholder": "البحث في نسب الضريبة","select_category": "اختر فئة"},- "tax_providers": {- "limitations_title": "{{name}} لا يغطي",- "unavailable_option": "{{name}} (غير مُعد)",- "use_default": "استخدام المحرك الافتراضي",- "use_default_named": "الافتراضي ({{name}})"- },- "enterprise": {- "learn_more": "تعرّف على Spree Enterprise"- },- "sellers": {- "add_cta": "إضافة بائع",- "add_sheet_title": "بائع جديد",- "create_description": "أنشئ سجل البائع أولاً، ثم ادعُه ووافق عليه واضبط الدفعات من صفحته.",- "create_label": "إنشاء البائع",- "search_placeholder": "ابحث عن بائعين",- "empty": "لا يوجد بائعون بعد",- "products_column": "المنتجات",- "team_column": "الفريق",- "on_holiday_notice": "هذا البائع في إجازة. تبقى منتجاته ظاهرة لكن لا يمكن شراء أي منها.",- "delete_confirm": {- "title": "حذف البائع؟",- "message": "سيؤدي هذا إلى إزالة {{name}} من السوق. تبقى منتجاته في الكتالوج بلا بائع. لا يمكن التراجع عن ذلك."- },- "suspend_confirm": {- "title": "تعليق البائع؟",- "message": "سيتوقف {{name}} عن البيع فوراً. يبقى الكتالوج والسجل، ويمكنك إعادته لاحقاً."- },- "reject_confirm": {- "title": "رفض البائع؟",- "message": "لن يُقبل {{name}} في السوق. يمكنك الموافقة عليه لاحقاً إذا لزم الأمر."- },- "invite_sheet": {- "title": "دعوة بائع",- "description": "ينضم الشخص إلى فريق البائع عند قبول الدعوة، ويمكنه بعدها الدخول إلى لوحته الخاصة.",- "email_help": "سترسل الدعوة إلى هذا العنوان."- },- "actions": {- "invite": "دعوة",- "reinvite": "إعادة الإرسال",- "send_invitation": "إرسال الدعوة",- "approve": "الموافقة",- "reinstate": "إعادة التفعيل",- "suspend": "تعليق",- "reject": "رفض"- },- "detail": {- "load_error": "تعذّر تحميل هذا البائع",- "delete_label": "حذف البائع",- "status": "الحالة",- "settlement": "الدفعات والضرائب",- "at_a_glance": "لمحة سريعة",- "contact": "التواصل",- "edit_profile": "تعديل الملف",- "edit_profile_description": "يحرّر البائع هذه البيانات من لوحته الخاصة، وما تعدّله هنا يجري نيابةً عنه.",- "edit_settlement": "تعديل الدفعات والضرائب",- "edit_settlement_description": "أنت وحدك من يرى هذه الإعدادات ويغيّرها، ولا يحرّرها البائع.",- "no_about": "لم يكتب هذا البائع نبذة بعد."- },- "status": {- "pending": "قيد الانتظار",- "invited": "مدعو",- "onboarding": "قيد الإعداد",- "ready_for_review": "جاهز للمراجعة",- "approved": "معتمد",- "suspended": "معلّق",- "rejected": "مرفوض",- "canceled": "ملغى"- },- "status_help": {- "pending": "تم الإنشاء، ولم تُرسل أي دعوة بعد.",- "invited": "في انتظار قبول الدعوة.",- "onboarding": "يستكمل بياناته.",- "ready_for_review": "في انتظار موافقتك.",- "approved": "يبيع في السوق.",- "suspended": "موقوف عن البيع. أعد تفعيله ليتاجر من جديد.",- "rejected": "غير مقبول في السوق.",- "canceled": "انسحب قبل الانضمام."- },- "tax_remittance": {- "seller": "البائع يورّد الضريبة",- "platform": "السوق يورّد الضريبة"- },- "payout_interval": {- "inherit": "الإعداد الافتراضي للمتجر",- "daily": "يومياً",- "weekly": "أسبوعياً",- "biweekly": "كل أسبوعين",- "monthly": "شهرياً",- "manual": "يدوي"- },- "messages": {- "created": "تم إنشاء البائع",- "create_failed": "تعذّر إنشاء البائع",- "updated": "تم تحديث البائع",- "update_failed": "تعذّر تحديث البائع",- "deleted": "تم حذف البائع",- "delete_failed": "تعذّر حذف البائع",- "invited": "تم إرسال الدعوة",- "invite_failed": "تعذّر إرسال الدعوة",- "approved": "تمت الموافقة على البائع",- "approve_failed": "تعذّرت الموافقة على البائع",- "suspended": "تم تعليق البائع",- "suspend_failed": "تعذّر تعليق البائع",- "rejected": "تم رفض البائع",- "reject_failed": "تعذّر رفض البائع"- },- "not_provided": "غير محدد",- "images": {- "logo_label": "الشعار",- "logo_help": "يُفضَّل الشكل المربّع. يظهر بجوار البائع في كل مكان يرد فيه.",- "square_logo_label": "شعار مربّع",- "square_logo_help": "للمواضع التي تتطلب مربّعاً دقيقاً، مثل الصورة الرمزية.",- "cover_photo_label": "صورة الغلاف",- "cover_photo_help": "لافتة عريضة أعلى ملف البائع."- },- "autocomplete": {- "placeholder": "ابحث عن بائعين",- "empty": "لم يُعثر على بائعين"- }- },- "commission_rates": {- "add_cta": "إضافة نسبة عمولة",- "applies_to_everything": "كل عملية بيع",- "create_description": "حدّد ما يتقاضاه السوق من البائعين، وعلى أي مبيعات ينطبق.",- "create_label": "إنشاء نسبة العمولة",- "delete_confirm": {- "message": "سيتم حذف {{name}}. العمولات المحتسبة سابقًا لن تتأثر.",- "title": "حذف نسبة العمولة؟"- },- "edit_description": "حدّث الرسوم وحدودها والمبيعات التي تنطبق عليها.",- "empty": "لا توجد نسب عمولة بعد",- "messages": {- "created": "تم إنشاء نسبة العمولة",- "deleted": "تم حذف نسبة العمولة",- "updated": "تم تحديث نسبة العمولة"+ "translations": {+ "coverage_summary": "تمت ترجمة {{translated}} من {{total}} لغة",+ "dirty_summary": "{{count}} تغيير(ات) غير محفوظة",+ "discard_confirm": {+ "message": "لديك {{count}} تغيير(ات) ترجمة غير محفوظة. هل تريد تجاهلها؟",+ "title": "تجاهل التغييرات؟"},- "search_placeholder": "البحث بالاسم…",- "order_hint": "تُضاف النسب الجديدة إلى أعلى القائمة، وتفوز أول نسبة مطابقة — اسحب لإعادة الترتيب.",- "conditions": {- "add": "إضافة شرط",- "title": "الشروط"- }+ "field": "الحقل",+ "load_error": "تعذر تحميل الترجمات",+ "locale": "اللغة",+ "manage": "إدارة الترجمات",+ "no_locales": "أضف المزيد من اللغات إلى متجرك لترجمة هذا المنتج.",+ "original": "الأصل",+ "save": "حفظ الترجمات",+ "save_error": "تعذر حفظ الترجمات",+ "saved": "تم حفظ الترجمات",+ "source": "المصدر",+ "title": "الترجمات"}}}diff --git a/packages/dashboard/src/locales/de.json b/packages/dashboard/src/locales/de.jsonindex 96f6a99be4..9cd8f67c1c 100644--- a/packages/dashboard/src/locales/de.json+++ b/packages/dashboard/src/locales/de.json@@ -289,6 +289,93 @@},"title": "Kollektionen"},+ "commission_rates": {+ "add_cta": "Provisionssatz hinzufügen",+ "applies_to_everything": "Jeder Verkauf",+ "create_description": "Legen Sie fest, was der Marktplatz Verkäufern berechnet und für welche Verkäufe das gilt.",+ "create_label": "Provisionssatz erstellen",+ "delete_confirm": {+ "message": "{{name}} wird entfernt. Bereits berechnete Provisionen bleiben unverändert.",+ "title": "Provisionssatz löschen?"+ },+ "edit_description": "Gebühr, Grenzen und betroffene Verkäufe aktualisieren.",+ "empty": "Noch keine Provisionssätze",+ "messages": {+ "created": "Provisionssatz erstellt",+ "deleted": "Provisionssatz gelöscht",+ "updated": "Provisionssatz aktualisiert"+ },+ "search_placeholder": "Nach Namen suchen…",+ "order_hint": "Neue Sätze stehen oben in der Liste, und der erste passende gilt — zum Umsortieren ziehen.",+ "conditions": {+ "add": "Bedingung hinzufügen",+ "title": "Bedingungen"+ }+ },+ "companies": {+ "add_cta": "Firma hinzufügen",+ "add_sheet_title": "Neue Firma",+ "create_description": "Geschäftskunden kaufen über Niederlassungen ein. Niederlassungen, Steuernummer und Freistellungsbescheinigungen können Sie hinzufügen, sobald die Firma angelegt ist.",+ "create_label": "Firma anlegen",+ "delete_confirm": {+ "message": "Damit werden {{name}} sowie alle Niederlassungen, Einkäufer und Bescheinigungen gelöscht. Das lässt sich nicht rückgängig machen.",+ "title": "Firma löschen?"+ },+ "detail": {+ "delete_label": "Firma löschen",+ "load_error": "Diese Firma konnte nicht geladen werden",+ "profile": "Firma"+ },+ "empty": "Noch keine Firmen",+ "locations_column": "Niederlassungen",+ "messages": {+ "created": "Firma angelegt",+ "deleted": "Firma gelöscht",+ "updated": "Firma aktualisiert"+ },+ "search_placeholder": "Firmen suchen"+ },+ "company_contacts": {+ "add_cta": "Einkäufer hinzufügen",+ "add_title": "Einkäufer berechtigen",+ "dialog_description": "Ein Kunde, der für diese Niederlassung einkauft. Wer für genau eine Niederlassung einkauft, dessen Bestellungen werden ihr automatisch zugeordnet.",+ "empty": "Noch keine Einkäufer berechtigt",+ "messages": {+ "created": "Einkäufer hinzugefügt",+ "deleted": "Einkäufer entfernt"+ },+ "remove_action": "Einkäufer entfernen",+ "remove_confirm": {+ "message": "{{email}} kauft dann nicht mehr für diese Niederlassung ein. Das Kundenkonto bleibt bestehen.",+ "title": "Diesen Einkäufer entfernen?"+ },+ "roles_enterprise_help": "Hier hinzugefügte Einkäufer können für diese Niederlassung bestellen. Rollen, Freigabeprozesse und Ausgabenlimits gehören zu Spree Enterprise.",+ "roles_enterprise_title": "Rollen und Freigaben sind eine Enterprise-Funktion",+ "title": "Einkäufer"+ },+ "company_locations": {+ "add_cta": "Niederlassung hinzufügen",+ "add_title": "Neue Niederlassung",+ "addresses": "Adressen",+ "billing_address": "Rechnungsadresse",+ "contacts_count_one": "{{count}} Einkäufer",+ "contacts_count_other": "{{count}} Einkäufer",+ "detail": {+ "delete_label": "Niederlassung löschen",+ "load_error": "Diese Niederlassung konnte nicht geladen werden"+ },+ "dialog_description": "Eine Niederlassung ist der Ort, an den die Rechnung geht und an den geliefert wird. Adressen sind optional, benötigen aber Name und Land, sobald sie ausgefüllt werden.",+ "edit_title": "Niederlassung bearbeiten",+ "empty": "Noch keine Niederlassungen",+ "messages": {+ "created": "Niederlassung angelegt",+ "deleted": "Niederlassung gelöscht",+ "updated": "Niederlassung aktualisiert"+ },+ "shipping_address": "Lieferadresse",+ "shipping_same_as_billing": "Lieferadresse entspricht der Rechnungsadresse",+ "title": "Niederlassungen"+ },"components": {"adjustment_action_editor": {"calculator_label": "Kalkulator",@@ -547,6 +634,67 @@"split_description": "Versenden Sie dieselben Produkte aus einem zweiten Lager mit eigenen Zonen und Tarifen.","split_title": "Versandstandorte aufteilen"},+ "delivery_profiles": {+ "add_cta": "Profil hinzufügen",+ "add_dialog_title": "Neues Lieferprofil",+ "all_locations": "Alle Lagerorte",+ "capabilities": {+ "digital": "Digital",+ "pickup": "Abholung",+ "ships": "Versand"+ },+ "create_description": "Fassen Sie Produkte mit gleichem Versand zusammen — mit eigenen Lagerorten, Zonen und Versandarten.",+ "create_label": "Profil erstellen",+ "default_badge": "Standard",+ "default_confirm": {+ "message": "Produkte ohne eigenes Profil werden künftig über „{{name}}“ versendet.",+ "title": "Als Standardprofil festlegen"+ },+ "delete_confirm": {+ "message": "„{{name}}“ löschen? Die zugehörigen Zonen und Versandarten werden mitgelöscht.",+ "title": "Versandprofil löschen"+ },+ "detail": {+ "add_digital_method": "Digitale Methode hinzufügen",+ "add_method": "Versandart hinzufügen",+ "collect_from": "Abholen bei",+ "collect_from_hint": "Standorte, an denen abgeholt werden kann. Änderungen gelten sofort.",+ "delete_label": "Profil löschen",+ "digital_empty": "Noch keine digitale Liefermethode.",+ "digital_hint": "Wird ohne Versand oder Abholung geliefert.",+ "digital_title": "Digitale Lieferung",+ "general_title": "Allgemein",+ "hidden_badge": "Ausgeblendet",+ "load_failed_title": "Dieses Versandprofil konnte nicht geladen werden",+ "no_methods": "Hier gibt es noch keine Versandarten.",+ "no_stock_locations": "Noch keine Standorte — legen Sie einen unter Einstellungen → Standorte an.",+ "no_zone_hint": "Diese Versandarten gelten überall, wohin dieses Profil reicht.",+ "no_zone_title": "Keine Zonenbeschränkung",+ "no_zones": "Noch keine Zonen — legen Sie eine an, um Versandarten anzubieten.",+ "offer_pickup": "Abholung anbieten",+ "origins_title": "Versand ab",+ "pickup_empty": "Noch keine Abholmethode — auf diesem Profil ist keine Abholung möglich.",+ "pickup_hint": "Kundinnen und Kunden holen diese Bestellungen persönlich ab. Abholung hat kein Ziel, daher gelten keine Zonen.",+ "pickup_title": "Abholung",+ "zones_title": "Zonen und Versandarten"+ },+ "empty": "Noch keine Lieferprofile.",+ "is_default_hint": "Produkte ohne eigenes Profil werden über dieses Profil versendet.",+ "kind_immutable_hint": "Die Art wird beim Erstellen des Profils festgelegt.",+ "kinds": {+ "digital": "Digital",+ "shipping": "Versand"+ },+ "locations_count": "{{count}} Lagerorte",+ "make_default": "Als Standard festlegen",+ "messages": {+ "created": "Versandprofil erstellt",+ "deleted": "Versandprofil gelöscht",+ "updated": "Versandprofil aktualisiert"+ },+ "search_placeholder": "Lieferprofile suchen…",+ "selected_locations": "Ausgewählte Lagerorte"+ },"delivery_zones": {"add_countries_in_markets": "Weitere Länder unter Märkte hinzufügen","add_cta": "Lieferzone hinzufügen",@@ -590,6 +738,9 @@"to_placeholder": "Bis","toggle_states": "Bundesländer von {{country}} anzeigen"},+ "enterprise": {+ "learn_more": "Mehr über Spree Enterprise erfahren"+ },"errors": {"forbidden_description": "Sie haben keine Berechtigung, diese Seite anzuzeigen.","forbidden_title": "Nicht berechtigt",@@ -1718,67 +1869,6 @@}}},- "delivery_profiles": {- "add_cta": "Profil hinzufügen",- "add_dialog_title": "Neues Lieferprofil",- "all_locations": "Alle Lagerorte",- "capabilities": {- "digital": "Digital",- "pickup": "Abholung",- "ships": "Versand"- },- "create_description": "Fassen Sie Produkte mit gleichem Versand zusammen — mit eigenen Lagerorten, Zonen und Versandarten.",- "create_label": "Profil erstellen",- "default_badge": "Standard",- "default_confirm": {- "message": "Produkte ohne eigenes Profil werden künftig über „{{name}}“ versendet.",- "title": "Als Standardprofil festlegen"- },- "delete_confirm": {- "message": "„{{name}}“ löschen? Die zugehörigen Zonen und Versandarten werden mitgelöscht.",- "title": "Versandprofil löschen"- },- "detail": {- "add_digital_method": "Digitale Methode hinzufügen",- "add_method": "Versandart hinzufügen",- "collect_from": "Abholen bei",- "collect_from_hint": "Standorte, an denen abgeholt werden kann. Änderungen gelten sofort.",- "delete_label": "Profil löschen",- "digital_empty": "Noch keine digitale Liefermethode.",- "digital_hint": "Wird ohne Versand oder Abholung geliefert.",- "digital_title": "Digitale Lieferung",- "general_title": "Allgemein",- "hidden_badge": "Ausgeblendet",- "load_failed_title": "Dieses Versandprofil konnte nicht geladen werden",- "no_methods": "Hier gibt es noch keine Versandarten.",- "no_stock_locations": "Noch keine Standorte — legen Sie einen unter Einstellungen → Standorte an.",- "no_zone_hint": "Diese Versandarten gelten überall, wohin dieses Profil reicht.",- "no_zone_title": "Keine Zonenbeschränkung",- "no_zones": "Noch keine Zonen — legen Sie eine an, um Versandarten anzubieten.",- "offer_pickup": "Abholung anbieten",- "origins_title": "Versand ab",- "pickup_empty": "Noch keine Abholmethode — auf diesem Profil ist keine Abholung möglich.",- "pickup_hint": "Kundinnen und Kunden holen diese Bestellungen persönlich ab. Abholung hat kein Ziel, daher gelten keine Zonen.",- "pickup_title": "Abholung",- "zones_title": "Zonen und Versandarten"- },- "empty": "Noch keine Lieferprofile.",- "is_default_hint": "Produkte ohne eigenes Profil werden über dieses Profil versendet.",- "kind_immutable_hint": "Die Art wird beim Erstellen des Profils festgelegt.",- "kinds": {- "digital": "Digital",- "shipping": "Versand"- },- "locations_count": "{{count}} Lagerorte",- "make_default": "Als Standard festlegen",- "messages": {- "created": "Versandprofil erstellt",- "deleted": "Versandprofil gelöscht",- "updated": "Versandprofil aktualisiert"- },- "search_placeholder": "Lieferprofile suchen…",- "selected_locations": "Ausgewählte Lagerorte"- },"gift_cards": {"batch_autocomplete": {"empty": "Keine passenden Chargen",@@ -1939,6 +2029,9 @@"sign_in_and_accept": "Anmelden & annehmen","sign_in_to_accept": ". Melden Sie sich an, um anzunehmen."},+ "jurisdiction": {+ "everywhere": "Überall"+ },"markets": {"add_cta": "Markt hinzufügen","columns": {@@ -3775,30 +3868,265 @@"name_required": "Name ist erforderlich"}},- "settings": {- "webhooks": {- "errors": {- "redeliver_failed": "Erneute Zustellung fehlgeschlagen",- "send_test_failed": "Test-Webhook konnte nicht gesendet werden"+ "seller_requirements": {+ "title": "Verkäuferanforderungen",+ "search_placeholder": "Anforderungen suchen",+ "empty": "Noch keine Anforderungen. Verkäufer können sofort um Prüfung bitten.",+ "add_cta": "Anforderung hinzufügen",+ "add_title": "Anforderung hinzufügen",+ "edit_title": "Anforderung bearbeiten",+ "columns": {+ "kind": "Typ",+ "required": "Erforderlich"+ },+ "required": {+ "yes": "Erforderlich",+ "no": "Empfohlen"+ },+ "status": {+ "disabled": "Aus"+ },+ "fields": {+ "accepted_files": {+ "label": "Zulässige Dateien",+ "help": "Verkäufer können hochladen: {{types}}"},- "messages": {- "removed": "Webhook-Endpunkt entfernt",- "updated": "Webhook-Endpunkt aktualisiert"+ "active": {+ "label": "Aktiv",+ "help": "Ausschalten, um dies nicht mehr zu verlangen, ohne es zu löschen."+ },+ "custom_fields": {+ "label": "Benutzerdefinierte Felder",+ "help": "Der Verkäufer muss jedes gewählte Feld ausfüllen.",+ "placeholder": "Felder suchen",+ "empty": "Keine Verkäuferfelder gefunden. Legen Sie sie unter Einstellungen → Benutzerdefinierte Felder an."+ },+ "description": {+ "label": "Hinweise",+ "placeholder": "Erklären Sie dem Verkäufer, was Sie brauchen und warum"+ },+ "kind": {+ "label": "Typ",+ "placeholder": "Wählen Sie, was Sie verlangen"+ },+ "name": {+ "label": "Name",+ "label_required": "Name (erforderlich)",+ "help": "Was der Verkäufer auf seiner Liste sieht."+ },+ "required": {+ "label": "Erforderlich",+ "help": "Erforderliche Punkte müssen vor der Freigabe erledigt sein. Andere gelten als empfohlen."}+ },+ "delete_confirm": {+ "title": "Anforderung löschen?",+ "message": "Verkäufer werden nicht mehr nach „{{name}}\" gefragt. Bereits Eingereichtes wird ebenfalls gelöscht."+ },+ "messages": {+ "created": "Anforderung hinzugefügt",+ "updated": "Anforderung gespeichert",+ "deleted": "Anforderung gelöscht",+ "submission_accepted": "Angenommen",+ "submission_rejected": "An den Verkäufer zurückgeschickt",+ "waived": "Anforderung für diesen Verkäufer erlassen"+ },+ "kinds": {+ "accept_terms": "Bedingungen akzeptieren",+ "complete_profile": "Profil vervollständigen",+ "billing_address": "Rechnungsadresse",+ "returns_address": "Retourenadresse",+ "minimum_products": "Mindestanzahl Produkte",+ "required_custom_fields": "Erforderliche benutzerdefinierte Felder",+ "attestation": "Bestätigung des Verkäufers",+ "operator_review": "Manuelle Prüfung",+ "document": "Dokument"}},- "settings_nav": {- "groups": {- "audit": "Audit",- "fulfillment": "Fulfillment",- "payments": "Zahlungen & Steuern",- "store": "Shop",- "team": "Team & Zugriff"- },- "items": {+ "sellers": {+ "actions": {+ "invite": "Einladen",+ "reinvite": "Erneut senden",+ "send_invitation": "Einladung senden",+ "approve": "Freigeben",+ "reinstate": "Sperre aufheben",+ "suspend": "Sperren",+ "reject": "Ablehnen",+ "reopen_onboarding": "Zurück zur Einrichtung"+ },+ "add_cta": "Verkäufer hinzufügen",+ "add_sheet_title": "Neuer Verkäufer",+ "address": {+ "filled": "Ausgefüllt",+ "not_filled": "Nicht ausgefüllt",+ "not_provided_by_seller": "Vom Verkäufer noch nicht angegeben",+ "not_located_yet": "Die Karte erscheint, sobald diese Adresse gefunden wurde."+ },+ "approve_override_confirm": {+ "title": "Trotzdem freigeben?",+ "message": "Dieser Verkäufer hat Folgendes nicht erledigt: {{names}}. Eine Freigabe jetzt erlaubt den Verkauf trotzdem, und die Entscheidung wird festgehalten.",+ "action": "Trotzdem freigeben"+ },+ "autocomplete": {+ "placeholder": "Verkäufer suchen",+ "empty": "Keine Verkäufer gefunden"+ },+ "create_description": "Legen Sie zuerst den Verkäufer an. Einladung, Freigabe und Auszahlungen richten Sie danach auf seiner Seite ein.",+ "create_label": "Verkäufer anlegen",+ "delete_confirm": {+ "title": "Verkäufer löschen?",+ "message": "Damit wird {{name}} vom Marktplatz entfernt. Die Produkte bleiben ohne Verkäufer im Katalog. Das lässt sich nicht rückgängig machen."+ },+ "detail": {+ "load_error": "Dieser Verkäufer konnte nicht geladen werden",+ "delete_label": "Verkäufer löschen",+ "status": "Status",+ "settlement": "Auszahlungen und Steuern",+ "at_a_glance": "Auf einen Blick",+ "contact": "Kontakt",+ "edit_profile": "Profil bearbeiten",+ "edit_profile_description": "Der Verkäufer pflegt das in seinem eigenen Bereich. Änderungen hier erfolgen in seinem Namen.",+ "edit_settlement": "Auszahlungen und Steuern bearbeiten",+ "edit_settlement_description": "Nur Sie sehen und ändern diese Angaben. Der Verkäufer bearbeitet sie nie.",+ "no_about": "Dieser Verkäufer hat noch keine Beschreibung verfasst.",+ "billing_address": "Rechnungsadresse",+ "returns_address": "Retourenadresse"+ },+ "empty": "Noch keine Verkäufer",+ "images": {+ "logo_label": "Logo",+ "logo_help": "Quadratisch passt am besten. Wird überall neben dem Verkäufer angezeigt.",+ "square_logo_label": "Quadratisches Logo",+ "square_logo_help": "Für Stellen, die ein enges Quadrat brauchen, etwa ein Profilbild.",+ "cover_photo_label": "Titelbild",+ "cover_photo_help": "Ein breites Banner oben auf dem Verkäuferprofil."+ },+ "invite_sheet": {+ "title": "Verkäufer einladen",+ "description": "Mit der Annahme tritt die Person dem Verkäuferteam bei und kann sich in ihrem eigenen Bereich anmelden.",+ "email_help": "Die Einladung geht an diese Adresse."+ },+ "messages": {+ "created": "Verkäufer angelegt",+ "create_failed": "Verkäufer konnte nicht angelegt werden",+ "updated": "Verkäufer aktualisiert",+ "update_failed": "Verkäufer konnte nicht aktualisiert werden",+ "deleted": "Verkäufer gelöscht",+ "delete_failed": "Verkäufer konnte nicht gelöscht werden",+ "invited": "Einladung gesendet",+ "invite_failed": "Einladung konnte nicht gesendet werden",+ "approved": "Verkäufer freigegeben",+ "approve_failed": "Verkäufer konnte nicht freigegeben werden",+ "suspended": "Verkäufer gesperrt",+ "suspend_failed": "Verkäufer konnte nicht gesperrt werden",+ "rejected": "Verkäufer abgelehnt",+ "reject_failed": "Verkäufer konnte nicht abgelehnt werden",+ "onboarding_reopened": "Zurück zur Einrichtung geschickt"+ },+ "not_provided": "Nicht angegeben",+ "on_holiday_notice": "Dieser Verkäufer ist abwesend. Sein Katalog bleibt sichtbar, es kann aber nichts gekauft werden.",+ "onboarding": {+ "title": "Einrichtung",+ "progress": "{{done}} von {{total}} erledigt",+ "waived": "Erlassen",+ "download": "Datei herunterladen",+ "seller_note": "Verkäufer: {{note}}",+ "review_note": "Ihre Notiz: {{note}}",+ "actions": {+ "accept": "Annehmen",+ "reject": "Zurückschicken",+ "waive": "Für diesen Verkäufer erlassen"+ },+ "reject_confirm": {+ "title": "Zurückschicken?",+ "message": "Der Verkäufer wird erneut nach „{{name}}\" gefragt."+ },+ "waive_confirm": {+ "title": "Anforderung erlassen?",+ "message": "„{{name}}\" gilt nur für diesen Verkäufer als erfüllt."+ },+ "all_done": "Alles erledigt 🎉",+ "status": {+ "complete": "Erledigt",+ "pending": "In Prüfung",+ "rejected": "Zurückgeschickt",+ "incomplete": "Ausstehend"+ }+ },+ "onboarding_column": "Einrichtung",+ "payout_interval": {+ "inherit": "Standard des Shops",+ "daily": "Täglich",+ "weekly": "Wöchentlich",+ "biweekly": "Alle zwei Wochen",+ "monthly": "Monatlich",+ "manual": "Manuell"+ },+ "products_column": "Produkte",+ "reject_confirm": {+ "title": "Verkäufer ablehnen?",+ "message": "{{name}} wird nicht zum Marktplatz zugelassen. Sie können ihn später trotzdem freigeben."+ },+ "reopen_onboarding_confirm": {+ "title": "Zurück zur Einrichtung schicken?",+ "message": "{{name}} kann die Angaben ändern und erneut um Prüfung bitten."+ },+ "search_placeholder": "Verkäufer suchen",+ "status": {+ "pending": "Offen",+ "invited": "Eingeladen",+ "onboarding": "In Einrichtung",+ "ready_for_review": "Zur Prüfung bereit",+ "approved": "Freigegeben",+ "suspended": "Gesperrt",+ "rejected": "Abgelehnt",+ "canceled": "Abgebrochen"+ },+ "status_help": {+ "pending": "Angelegt, aber noch niemand eingeladen.",+ "invited": "Wartet darauf, dass jemand die Einladung annimmt.",+ "onboarding": "Trägt gerade seine Daten ein.",+ "ready_for_review": "Wartet auf Ihre Freigabe.",+ "approved": "Verkauft auf dem Marktplatz.",+ "suspended": "Vom Verkauf ausgeschlossen. Heben Sie die Sperre auf, um wieder zu handeln.",+ "rejected": "Nicht zum Marktplatz zugelassen.",+ "canceled": "Hat vor dem Beitritt zurückgezogen."+ },+ "suspend_confirm": {+ "title": "Verkäufer sperren?",+ "message": "{{name}} kann sofort nicht mehr verkaufen. Katalog und Historie bleiben erhalten, und Sie können die Sperre später aufheben."+ },+ "tax_remittance": {+ "seller": "Verkäufer führt ab",+ "platform": "Marktplatz führt ab"+ },+ "team_column": "Team"+ },+ "settings": {+ "webhooks": {+ "errors": {+ "redeliver_failed": "Erneute Zustellung fehlgeschlagen",+ "send_test_failed": "Test-Webhook konnte nicht gesendet werden"+ },+ "messages": {+ "removed": "Webhook-Endpunkt entfernt",+ "updated": "Webhook-Endpunkt aktualisiert"+ }+ }+ },+ "settings_nav": {+ "groups": {+ "audit": "Audit",+ "fulfillment": "Fulfillment",+ "payments": "Zahlungen & Steuern",+ "store": "Shop",+ "team": "Team & Zugriff"+ },+ "items": {"allowed_origins": "Zugelassene Ursprünge","api_keys": "API-Schlüssel","channels": "Verkaufskanäle",+ "commission_rates": "Provisionssätze","custom_field_definitions": "Benutzerdefinierte Felder","delivery_profiles": "Lieferprofile","emails": "E-Mails",@@ -3810,13 +4138,13 @@"profile": "Profil","reasons": "Rücksendungen & Gründe","roles": "Rollen",+ "seller_requirements": "Verkäuferanforderungen","staff": "Mitarbeiter","stock_locations": "Lagerstandorte","store": "Shop","tax_categories": "Steuerkategorien","tax_rates": "Steuersätze",- "webhooks": "Webhooks",- "commission_rates": "Provisionssätze"+ "webhooks": "Webhooks"}},"setup": {@@ -3981,91 +4309,50 @@},"search_placeholder": "Nach Name suchen…"},- "translations": {- "coverage_summary": "{{translated}} von {{total}} Sprachen übersetzt",- "dirty_summary": "{{count}} nicht gespeicherte Änderung(en)",- "discard_confirm": {- "message": "Sie haben {{count}} nicht gespeicherte Übersetzungsänderung(en). Verwerfen?",- "title": "Änderungen verwerfen?"- },- "field": "Feld",- "load_error": "Übersetzungen konnten nicht geladen werden",- "locale": "Sprache",- "manage": "Übersetzungen verwalten",- "no_locales": "Fügen Sie Ihrem Shop weitere Sprachen hinzu, um dieses Produkt zu übersetzen.",- "original": "Original",- "save": "Übersetzungen speichern",- "save_error": "Übersetzungen konnten nicht gespeichert werden",- "saved": "Übersetzungen gespeichert",- "source": "Quelle",- "title": "Übersetzungen"- },- "jurisdiction": {- "everywhere": "Überall"- },- "companies": {- "add_cta": "Firma hinzufügen",- "add_sheet_title": "Neue Firma",- "create_description": "Geschäftskunden kaufen über Niederlassungen ein. Niederlassungen, Steuernummer und Freistellungsbescheinigungen können Sie hinzufügen, sobald die Firma angelegt ist.",- "create_label": "Firma anlegen",+ "tax_exemption_certificates": {+ "add_cta": "Bescheinigung hinzufügen",+ "add_title": "Freistellungsbescheinigung hinzufügen","delete_confirm": {- "message": "Damit werden {{name}} sowie alle Niederlassungen, Einkäufer und Bescheinigungen gelöscht. Das lässt sich nicht rückgängig machen.",- "title": "Firma löschen?"- },- "detail": {- "delete_label": "Firma löschen",- "load_error": "Diese Firma konnte nicht geladen werden",- "profile": "Firma"+ "message": "Bescheinigung {{number}} wird entfernt. Das lässt sich nicht rückgängig machen.",+ "title": "Diese Bescheinigung löschen?"},- "empty": "Noch keine Firmen",- "locations_column": "Niederlassungen",+ "dialog_description": "Der Nachweis, dass die Einkäufe dieser Firma steuerfrei sind. Eine neue Bescheinigung gilt erst, wenn Sie sie angenommen haben.",+ "download_action": "Dokument herunterladen",+ "empty": "Keine Bescheinigungen hinterlegt",+ "expires_prefix": "Gültig bis",+ "lapsed": "Abgelaufen","messages": {- "created": "Firma angelegt",- "deleted": "Firma gelöscht",- "updated": "Firma aktualisiert"- },- "search_placeholder": "Firmen suchen"- },- "company_locations": {- "add_cta": "Niederlassung hinzufügen",- "add_title": "Neue Niederlassung",- "addresses": "Adressen",- "billing_address": "Rechnungsadresse",- "contacts_count_one": "{{count}} Einkäufer",- "contacts_count_other": "{{count}} Einkäufer",- "detail": {- "delete_label": "Niederlassung löschen",- "load_error": "Diese Niederlassung konnte nicht geladen werden"+ "created": "Bescheinigung hinzugefügt",+ "deleted": "Bescheinigung gelöscht",+ "revoked": "Bescheinigung widerrufen",+ "updated": "Bescheinigung aktualisiert",+ "verified": "Bescheinigung angenommen"},- "dialog_description": "Eine Niederlassung ist der Ort, an den die Rechnung geht und an den geliefert wird. Adressen sind optional, benötigen aber Name und Land, sobald sie ausgefüllt werden.",- "edit_title": "Niederlassung bearbeiten",- "empty": "Noch keine Niederlassungen",- "messages": {- "created": "Niederlassung angelegt",- "deleted": "Niederlassung gelöscht",- "updated": "Niederlassung aktualisiert"+ "never_expires": "Läuft nicht ab",+ "no_document": "Kein Dokument hinterlegt",+ "reason_codes": {+ "agricultural": "Landwirtschaft",+ "charitable": "Gemeinnützig",+ "educational": "Bildung",+ "government": "Behörde",+ "manufacturing": "Produktion",+ "resale": "Wiederverkauf"},- "shipping_address": "Lieferadresse",- "shipping_same_as_billing": "Lieferadresse entspricht der Rechnungsadresse",- "title": "Niederlassungen"- },- "company_contacts": {- "add_cta": "Einkäufer hinzufügen",- "add_title": "Einkäufer berechtigen",- "dialog_description": "Ein Kunde, der für diese Niederlassung einkauft. Wer für genau eine Niederlassung einkauft, dessen Bestellungen werden ihr automatisch zugeordnet.",- "empty": "Noch keine Einkäufer berechtigt",- "messages": {- "created": "Einkäufer hinzugefügt",- "deleted": "Einkäufer entfernt"+ "revoke_action": "Widerrufen",+ "revoke_confirm": {+ "message": "Bescheinigung {{number}} gilt dann nicht mehr für neue Bestellungen. Sie bleibt als Nachweis erhalten.",+ "title": "Diese Bescheinigung widerrufen?"},- "remove_action": "Einkäufer entfernen",- "remove_confirm": {- "message": "{{email}} kauft dann nicht mehr für diese Niederlassung ein. Das Kundenkonto bleibt bestehen.",- "title": "Diesen Einkäufer entfernen?"+ "select_reason": "Grund wählen",+ "status": {+ "expired": "Abgelaufen",+ "pending": "Wartet auf Prüfung",+ "revoked": "Widerrufen",+ "verified": "Angenommen"},- "roles_enterprise_help": "Hier hinzugefügte Einkäufer können für diese Niederlassung bestellen. Rollen, Freigabeprozesse und Ausgabenlimits gehören zu Spree Enterprise.",- "roles_enterprise_title": "Rollen und Freigaben sind eine Enterprise-Funktion",- "title": "Einkäufer"+ "title": "Freistellungsbescheinigungen",+ "verified_at": "Angenommen am",+ "verify_action": "Annehmen"},"tax_identifiers": {"add_cta": "Nummer hinzufügen",@@ -4105,50 +4392,11 @@"verified": "Bestätigt"}},- "tax_exemption_certificates": {- "add_cta": "Bescheinigung hinzufügen",- "add_title": "Freistellungsbescheinigung hinzufügen",- "delete_confirm": {- "message": "Bescheinigung {{number}} wird entfernt. Das lässt sich nicht rückgängig machen.",- "title": "Diese Bescheinigung löschen?"- },- "dialog_description": "Der Nachweis, dass die Einkäufe dieser Firma steuerfrei sind. Eine neue Bescheinigung gilt erst, wenn Sie sie angenommen haben.",- "download_action": "Dokument herunterladen",- "empty": "Keine Bescheinigungen hinterlegt",- "expires_prefix": "Gültig bis",- "lapsed": "Abgelaufen",- "messages": {- "created": "Bescheinigung hinzugefügt",- "deleted": "Bescheinigung gelöscht",- "revoked": "Bescheinigung widerrufen",- "updated": "Bescheinigung aktualisiert",- "verified": "Bescheinigung angenommen"- },- "never_expires": "Läuft nicht ab",- "no_document": "Kein Dokument hinterlegt",- "reason_codes": {- "agricultural": "Landwirtschaft",- "charitable": "Gemeinnützig",- "educational": "Bildung",- "government": "Behörde",- "manufacturing": "Produktion",- "resale": "Wiederverkauf"- },- "revoke_action": "Widerrufen",- "revoke_confirm": {- "message": "Bescheinigung {{number}} gilt dann nicht mehr für neue Bestellungen. Sie bleibt als Nachweis erhalten.",- "title": "Diese Bescheinigung widerrufen?"- },- "select_reason": "Grund wählen",- "status": {- "expired": "Abgelaufen",- "pending": "Wartet auf Prüfung",- "revoked": "Widerrufen",- "verified": "Angenommen"- },- "title": "Freistellungsbescheinigungen",- "verified_at": "Angenommen am",- "verify_action": "Annehmen"+ "tax_providers": {+ "limitations_title": "{{name}} deckt Folgendes nicht ab",+ "unavailable_option": "{{name}} (nicht eingerichtet)",+ "use_default": "Standardberechnung verwenden",+ "use_default_named": "Standard ({{name}})"},"tax_rates": {"add_cta": "Steuersatz hinzufügen",@@ -4171,148 +4419,24 @@"search_placeholder": "Steuersätze suchen","select_category": "Kategorie wählen"},- "tax_providers": {- "limitations_title": "{{name}} deckt Folgendes nicht ab",- "unavailable_option": "{{name}} (nicht eingerichtet)",- "use_default": "Standardberechnung verwenden",- "use_default_named": "Standard ({{name}})"- },- "enterprise": {- "learn_more": "Mehr über Spree Enterprise erfahren"- },- "sellers": {- "add_cta": "Verkäufer hinzufügen",- "add_sheet_title": "Neuer Verkäufer",- "create_description": "Legen Sie zuerst den Verkäufer an. Einladung, Freigabe und Auszahlungen richten Sie danach auf seiner Seite ein.",- "create_label": "Verkäufer anlegen",- "search_placeholder": "Verkäufer suchen",- "empty": "Noch keine Verkäufer",- "products_column": "Produkte",- "team_column": "Team",- "on_holiday_notice": "Dieser Verkäufer ist abwesend. Sein Katalog bleibt sichtbar, es kann aber nichts gekauft werden.",- "delete_confirm": {- "title": "Verkäufer löschen?",- "message": "Damit wird {{name}} vom Marktplatz entfernt. Die Produkte bleiben ohne Verkäufer im Katalog. Das lässt sich nicht rückgängig machen."- },- "suspend_confirm": {- "title": "Verkäufer sperren?",- "message": "{{name}} kann sofort nicht mehr verkaufen. Katalog und Historie bleiben erhalten, und Sie können die Sperre später aufheben."- },- "reject_confirm": {- "title": "Verkäufer ablehnen?",- "message": "{{name}} wird nicht zum Marktplatz zugelassen. Sie können ihn später trotzdem freigeben."- },- "invite_sheet": {- "title": "Verkäufer einladen",- "description": "Mit der Annahme tritt die Person dem Verkäuferteam bei und kann sich in ihrem eigenen Bereich anmelden.",- "email_help": "Die Einladung geht an diese Adresse."- },- "actions": {- "invite": "Einladen",- "reinvite": "Erneut senden",- "send_invitation": "Einladung senden",- "approve": "Freigeben",- "reinstate": "Sperre aufheben",- "suspend": "Sperren",- "reject": "Ablehnen"- },- "detail": {- "load_error": "Dieser Verkäufer konnte nicht geladen werden",- "delete_label": "Verkäufer löschen",- "status": "Status",- "settlement": "Auszahlungen und Steuern",- "at_a_glance": "Auf einen Blick",- "contact": "Kontakt",- "edit_profile": "Profil bearbeiten",- "edit_profile_description": "Der Verkäufer pflegt das in seinem eigenen Bereich. Änderungen hier erfolgen in seinem Namen.",- "edit_settlement": "Auszahlungen und Steuern bearbeiten",- "edit_settlement_description": "Nur Sie sehen und ändern diese Angaben. Der Verkäufer bearbeitet sie nie.",- "no_about": "Dieser Verkäufer hat noch keine Beschreibung verfasst."- },- "status": {- "pending": "Offen",- "invited": "Eingeladen",- "onboarding": "In Einrichtung",- "ready_for_review": "Zur Prüfung bereit",- "approved": "Freigegeben",- "suspended": "Gesperrt",- "rejected": "Abgelehnt",- "canceled": "Abgebrochen"- },- "status_help": {- "pending": "Angelegt, aber noch niemand eingeladen.",- "invited": "Wartet darauf, dass jemand die Einladung annimmt.",- "onboarding": "Trägt gerade seine Daten ein.",- "ready_for_review": "Wartet auf Ihre Freigabe.",- "approved": "Verkauft auf dem Marktplatz.",- "suspended": "Vom Verkauf ausgeschlossen. Heben Sie die Sperre auf, um wieder zu handeln.",- "rejected": "Nicht zum Marktplatz zugelassen.",- "canceled": "Hat vor dem Beitritt zurückgezogen."- },- "tax_remittance": {- "seller": "Verkäufer führt ab",- "platform": "Marktplatz führt ab"- },- "payout_interval": {- "inherit": "Standard des Shops",- "daily": "Täglich",- "weekly": "Wöchentlich",- "biweekly": "Alle zwei Wochen",- "monthly": "Monatlich",- "manual": "Manuell"- },- "messages": {- "created": "Verkäufer angelegt",- "create_failed": "Verkäufer konnte nicht angelegt werden",- "updated": "Verkäufer aktualisiert",- "update_failed": "Verkäufer konnte nicht aktualisiert werden",- "deleted": "Verkäufer gelöscht",- "delete_failed": "Verkäufer konnte nicht gelöscht werden",- "invited": "Einladung gesendet",- "invite_failed": "Einladung konnte nicht gesendet werden",- "approved": "Verkäufer freigegeben",- "approve_failed": "Verkäufer konnte nicht freigegeben werden",- "suspended": "Verkäufer gesperrt",- "suspend_failed": "Verkäufer konnte nicht gesperrt werden",- "rejected": "Verkäufer abgelehnt",- "reject_failed": "Verkäufer konnte nicht abgelehnt werden"- },- "not_provided": "Nicht angegeben",- "images": {- "logo_label": "Logo",- "logo_help": "Quadratisch passt am besten. Wird überall neben dem Verkäufer angezeigt.",- "square_logo_label": "Quadratisches Logo",- "square_logo_help": "Für Stellen, die ein enges Quadrat brauchen, etwa ein Profilbild.",- "cover_photo_label": "Titelbild",- "cover_photo_help": "Ein breites Banner oben auf dem Verkäuferprofil."- },- "autocomplete": {- "placeholder": "Verkäufer suchen",- "empty": "Keine Verkäufer gefunden"- }- },- "commission_rates": {- "add_cta": "Provisionssatz hinzufügen",- "applies_to_everything": "Jeder Verkauf",- "create_description": "Legen Sie fest, was der Marktplatz Verkäufern berechnet und für welche Verkäufe das gilt.",- "create_label": "Provisionssatz erstellen",- "delete_confirm": {- "message": "{{name}} wird entfernt. Bereits berechnete Provisionen bleiben unverändert.",- "title": "Provisionssatz löschen?"- },- "edit_description": "Gebühr, Grenzen und betroffene Verkäufe aktualisieren.",- "empty": "Noch keine Provisionssätze",- "messages": {- "created": "Provisionssatz erstellt",- "deleted": "Provisionssatz gelöscht",- "updated": "Provisionssatz aktualisiert"+ "translations": {+ "coverage_summary": "{{translated}} von {{total}} Sprachen übersetzt",+ "dirty_summary": "{{count}} nicht gespeicherte Änderung(en)",+ "discard_confirm": {+ "message": "Sie haben {{count}} nicht gespeicherte Übersetzungsänderung(en). Verwerfen?",+ "title": "Änderungen verwerfen?"},- "search_placeholder": "Nach Namen suchen…",- "order_hint": "Neue Sätze stehen oben in der Liste, und der erste passende gilt — zum Umsortieren ziehen.",- "conditions": {- "add": "Bedingung hinzufügen",- "title": "Bedingungen"- }+ "field": "Feld",+ "load_error": "Übersetzungen konnten nicht geladen werden",+ "locale": "Sprache",+ "manage": "Übersetzungen verwalten",+ "no_locales": "Fügen Sie Ihrem Shop weitere Sprachen hinzu, um dieses Produkt zu übersetzen.",+ "original": "Original",+ "save": "Übersetzungen speichern",+ "save_error": "Übersetzungen konnten nicht gespeichert werden",+ "saved": "Übersetzungen gespeichert",+ "source": "Quelle",+ "title": "Übersetzungen"}}}diff --git a/packages/dashboard/src/locales/en.json b/packages/dashboard/src/locales/en.jsonindex f36b695bed..3c7be23e86 100644--- a/packages/dashboard/src/locales/en.json+++ b/packages/dashboard/src/locales/en.json@@ -289,6 +289,93 @@},"title": "Collections"},+ "commission_rates": {+ "add_cta": "Add commission rate",+ "applies_to_everything": "Every sale",+ "create_description": "Set what the marketplace charges sellers, and which sales it applies to.",+ "create_label": "Create commission rate",+ "delete_confirm": {+ "message": "{{name}} will be removed. Commission already charged is unaffected.",+ "title": "Delete commission rate?"+ },+ "edit_description": "Update the charge, its limits, and which sales it applies to.",+ "empty": "No commission rates yet",+ "messages": {+ "created": "Commission rate created",+ "deleted": "Commission rate deleted",+ "updated": "Commission rate updated"+ },+ "search_placeholder": "Search by name…",+ "order_hint": "New rates go to the top of the list, and the first one that matches a sale wins — drag to reorder.",+ "conditions": {+ "add": "Add condition",+ "title": "Conditions"+ }+ },+ "companies": {+ "add_cta": "Add company",+ "add_sheet_title": "New company",+ "create_description": "Business customers buy through branches. You can add branches, tax registration and exemption certificates once the company exists.",+ "create_label": "Create company",+ "delete_confirm": {+ "message": "This deletes {{name}} along with its branches, buyers and certificates. This cannot be undone.",+ "title": "Delete company?"+ },+ "detail": {+ "delete_label": "Delete company",+ "load_error": "Could not load this company",+ "profile": "Company"+ },+ "empty": "No companies yet",+ "locations_column": "Branches",+ "messages": {+ "created": "Company created",+ "deleted": "Company deleted",+ "updated": "Company updated"+ },+ "search_placeholder": "Search companies"+ },+ "company_contacts": {+ "add_cta": "Add buyer",+ "add_title": "Authorise a buyer",+ "dialog_description": "A customer who buys for this branch. Someone who buys for exactly one branch has their orders attributed to it automatically.",+ "empty": "No buyers authorised yet",+ "messages": {+ "created": "Buyer added",+ "deleted": "Buyer removed"+ },+ "remove_action": "Remove buyer",+ "remove_confirm": {+ "message": "{{email}} will no longer buy for this branch. Their customer account is not affected.",+ "title": "Remove this buyer?"+ },+ "roles_enterprise_help": "Buyers you add here can place orders for this branch. Roles, approval workflows and spending limits come with Spree Enterprise.",+ "roles_enterprise_title": "Roles and approvals are an Enterprise feature",+ "title": "Buyers"+ },+ "company_locations": {+ "add_cta": "Add branch",+ "add_title": "New branch",+ "addresses": "Addresses",+ "billing_address": "Billing address",+ "contacts_count_one": "{{count}} buyer",+ "contacts_count_other": "{{count}} buyers",+ "detail": {+ "delete_label": "Delete branch",+ "load_error": "Could not load this branch"+ },+ "dialog_description": "A branch is where the business is invoiced and where its orders ship. Addresses are optional, but a partial address needs a name and country.",+ "edit_title": "Edit branch",+ "empty": "No branches yet",+ "messages": {+ "created": "Branch created",+ "deleted": "Branch deleted",+ "updated": "Branch updated"+ },+ "shipping_address": "Shipping address",+ "shipping_same_as_billing": "Shipping address is the same as billing",+ "title": "Branches"+ },"components": {"adjustment_action_editor": {"calculator_label": "Calculator",@@ -547,6 +634,67 @@"split_description": "Ship the same products from a second warehouse with its own zones and rates.","split_title": "Split shipping origins"},+ "delivery_profiles": {+ "add_cta": "Add profile",+ "add_dialog_title": "New delivery profile",+ "all_locations": "All locations",+ "capabilities": {+ "digital": "Digital",+ "pickup": "Pickup",+ "ships": "Ships"+ },+ "create_description": "Group products that ship the same way, with their own locations, zones and delivery methods.",+ "create_label": "Create profile",+ "default_badge": "Default",+ "default_confirm": {+ "message": "Products without a profile of their own will start shipping on “{{name}}”.",+ "title": "Make this the default profile"+ },+ "delete_confirm": {+ "message": "Delete “{{name}}”? Its zones and delivery methods go with it.",+ "title": "Delete shipping profile"+ },+ "detail": {+ "add_digital_method": "Add digital method",+ "add_method": "Add method",+ "collect_from": "Collect from",+ "collect_from_hint": "Locations customers can collect from. Changes take effect immediately.",+ "delete_label": "Delete profile",+ "digital_empty": "No digital delivery method yet.",+ "digital_hint": "Delivered without shipping or collection.",+ "digital_title": "Digital delivery",+ "general_title": "General",+ "hidden_badge": "Hidden",+ "load_failed_title": "Could not load this shipping profile",+ "no_methods": "No delivery methods here yet.",+ "no_stock_locations": "No locations yet — add one under Settings → Locations.",+ "no_zone_hint": "These methods are offered wherever this profile reaches.",+ "no_zone_title": "No zone restriction",+ "no_zones": "No zones yet — add one to start offering delivery methods.",+ "offer_pickup": "Offer pickup",+ "origins_title": "Ships from",+ "pickup_empty": "No pickup method yet — customers cannot collect orders on this profile.",+ "pickup_hint": "Customers collect these orders in person. Pickup has no destination, so zones do not apply.",+ "pickup_title": "Pickup",+ "zones_title": "Zones and delivery methods"+ },+ "empty": "No delivery profiles yet.",+ "is_default_hint": "Products without a profile of their own ship on this one.",+ "kind_immutable_hint": "The kind is fixed when the profile is created.",+ "kinds": {+ "digital": "Digital",+ "shipping": "Shipping"+ },+ "locations_count": "{{count}} locations",+ "make_default": "Make default",+ "messages": {+ "created": "Shipping profile created",+ "deleted": "Shipping profile deleted",+ "updated": "Shipping profile updated"+ },+ "search_placeholder": "Search delivery profiles…",+ "selected_locations": "Selected locations"+ },"delivery_zones": {"add_countries_in_markets": "Add more countries in Markets","add_cta": "Add delivery zone",@@ -590,6 +738,9 @@"to_placeholder": "To","toggle_states": "Show states of {{country}}"},+ "enterprise": {+ "learn_more": "Learn about Spree Enterprise"+ },"errors": {"forbidden_description": "You don’t have permission to view this page.","forbidden_title": "Not authorized",@@ -1718,67 +1869,6 @@}}},- "delivery_profiles": {- "add_cta": "Add profile",- "add_dialog_title": "New delivery profile",- "all_locations": "All locations",- "capabilities": {- "digital": "Digital",- "pickup": "Pickup",- "ships": "Ships"- },- "create_description": "Group products that ship the same way, with their own locations, zones and delivery methods.",- "create_label": "Create profile",- "default_badge": "Default",- "default_confirm": {- "message": "Products without a profile of their own will start shipping on “{{name}}”.",- "title": "Make this the default profile"- },- "delete_confirm": {- "message": "Delete “{{name}}”? Its zones and delivery methods go with it.",- "title": "Delete shipping profile"- },- "detail": {- "add_digital_method": "Add digital method",- "add_method": "Add method",- "collect_from": "Collect from",- "collect_from_hint": "Locations customers can collect from. Changes take effect immediately.",- "delete_label": "Delete profile",- "digital_empty": "No digital delivery method yet.",- "digital_hint": "Delivered without shipping or collection.",- "digital_title": "Digital delivery",- "general_title": "General",- "hidden_badge": "Hidden",- "load_failed_title": "Could not load this shipping profile",- "no_methods": "No delivery methods here yet.",- "no_stock_locations": "No locations yet — add one under Settings → Locations.",- "no_zone_hint": "These methods are offered wherever this profile reaches.",- "no_zone_title": "No zone restriction",- "no_zones": "No zones yet — add one to start offering delivery methods.",- "offer_pickup": "Offer pickup",- "origins_title": "Ships from",- "pickup_empty": "No pickup method yet — customers cannot collect orders on this profile.",- "pickup_hint": "Customers collect these orders in person. Pickup has no destination, so zones do not apply.",- "pickup_title": "Pickup",- "zones_title": "Zones and delivery methods"- },- "empty": "No delivery profiles yet.",- "is_default_hint": "Products without a profile of their own ship on this one.",- "kind_immutable_hint": "The kind is fixed when the profile is created.",- "kinds": {- "digital": "Digital",- "shipping": "Shipping"- },- "locations_count": "{{count}} locations",- "make_default": "Make default",- "messages": {- "created": "Shipping profile created",- "deleted": "Shipping profile deleted",- "updated": "Shipping profile updated"- },- "search_placeholder": "Search delivery profiles…",- "selected_locations": "Selected locations"- },"gift_cards": {"batch_autocomplete": {"empty": "No batches match",@@ -1939,6 +2029,9 @@"sign_in_and_accept": "Sign in & accept","sign_in_to_accept": ". Sign in to accept."},+ "jurisdiction": {+ "everywhere": "Everywhere"+ },"markets": {"add_cta": "Add market","columns": {@@ -3775,30 +3868,265 @@"name_required": "Name is required"}},- "settings": {- "webhooks": {- "errors": {- "redeliver_failed": "Failed to redeliver",- "send_test_failed": "Failed to send test webhook"+ "seller_requirements": {+ "title": "Seller requirements",+ "search_placeholder": "Search requirements",+ "empty": "No requirements yet. Sellers can ask to be reviewed straight away.",+ "add_cta": "Add requirement",+ "add_title": "Add a requirement",+ "edit_title": "Edit requirement",+ "columns": {+ "kind": "Type",+ "required": "Required"+ },+ "required": {+ "yes": "Required",+ "no": "Recommended"+ },+ "status": {+ "disabled": "Off"+ },+ "fields": {+ "accepted_files": {+ "label": "Accepted files",+ "help": "Sellers can upload: {{types}}"},- "messages": {- "removed": "Webhook endpoint removed",- "updated": "Webhook endpoint updated"+ "active": {+ "label": "Active",+ "help": "Switch off to stop asking for this without deleting it."+ },+ "custom_fields": {+ "label": "Custom fields",+ "help": "The seller must fill in every field you choose.",+ "placeholder": "Search custom fields",+ "empty": "No seller custom fields found. Create them in Settings → Custom fields."+ },+ "description": {+ "label": "Instructions",+ "placeholder": "Tell the seller what you need and why"+ },+ "kind": {+ "label": "Type",+ "placeholder": "Choose what to ask for"+ },+ "name": {+ "label": "Name",+ "label_required": "Name (required)",+ "help": "What the seller sees on their checklist."+ },+ "required": {+ "label": "Required",+ "help": "Required items must be done before a seller can be approved. Others are shown as recommended."}+ },+ "delete_confirm": {+ "title": "Delete requirement?",+ "message": "Sellers will no longer be asked for \"{{name}}\". Anything they already submitted for it is deleted too."+ },+ "messages": {+ "created": "Requirement added",+ "updated": "Requirement saved",+ "deleted": "Requirement deleted",+ "submission_accepted": "Accepted",+ "submission_rejected": "Sent back to the seller",+ "waived": "Requirement waived for this seller"+ },+ "kinds": {+ "accept_terms": "Accept terms",+ "complete_profile": "Complete profile",+ "billing_address": "Billing address",+ "returns_address": "Returns address",+ "minimum_products": "Minimum products",+ "required_custom_fields": "Required custom fields",+ "attestation": "Seller confirmation",+ "operator_review": "Manual check",+ "document": "Document"}},- "settings_nav": {- "groups": {- "audit": "Audit",- "fulfillment": "Fulfillment",- "payments": "Payments & taxes",- "store": "Store",- "team": "Team & access"- },- "items": {+ "sellers": {+ "actions": {+ "invite": "Invite",+ "reinvite": "Send again",+ "send_invitation": "Send invitation",+ "approve": "Approve",+ "reinstate": "Reinstate",+ "suspend": "Suspend",+ "reject": "Reject",+ "reopen_onboarding": "Send back to onboarding"+ },+ "add_cta": "Add seller",+ "add_sheet_title": "New seller",+ "address": {+ "filled": "Filled",+ "not_filled": "Not filled",+ "not_provided_by_seller": "Not yet provided by the seller",+ "not_located_yet": "The map appears once this address has been located."+ },+ "approve_override_confirm": {+ "title": "Approve anyway?",+ "message": "This seller has not finished: {{names}}. Approving now lets them trade regardless, and the decision is recorded.",+ "action": "Approve anyway"+ },+ "autocomplete": {+ "placeholder": "Search sellers",+ "empty": "No sellers found"+ },+ "create_description": "Create the seller record first. You can invite them, approve them and set up payouts from their page.",+ "create_label": "Create seller",+ "delete_confirm": {+ "title": "Delete seller?",+ "message": "This removes {{name}} from the marketplace. Their products stay in your catalog without a seller. This cannot be undone."+ },+ "detail": {+ "load_error": "Could not load this seller",+ "delete_label": "Delete seller",+ "status": "Status",+ "settlement": "Payouts and tax",+ "at_a_glance": "At a glance",+ "contact": "Contact",+ "edit_profile": "Edit profile",+ "edit_profile_description": "The seller maintains this from their own panel. Edits here apply on their behalf.",+ "edit_settlement": "Edit payouts and tax",+ "edit_settlement_description": "Only you can see or change these. The seller never edits them.",+ "no_about": "This seller has not written a description yet.",+ "billing_address": "Billing address",+ "returns_address": "Returns address"+ },+ "empty": "No sellers yet",+ "images": {+ "logo_label": "Logo",+ "logo_help": "Square works best. Shown beside the seller everywhere they appear.",+ "square_logo_label": "Square logo",+ "square_logo_help": "Used where a tight square is needed, such as an avatar.",+ "cover_photo_label": "Cover photo",+ "cover_photo_help": "A wide banner across the top of the seller profile."+ },+ "invite_sheet": {+ "title": "Invite seller",+ "description": "They join the seller team when they accept and can then sign in to their own panel.",+ "email_help": "The invitation goes to this address."+ },+ "messages": {+ "created": "Seller created",+ "create_failed": "Could not create the seller",+ "updated": "Seller updated",+ "update_failed": "Could not update the seller",+ "deleted": "Seller deleted",+ "delete_failed": "Could not delete the seller",+ "invited": "Invitation sent",+ "invite_failed": "Could not send the invitation",+ "approved": "Seller approved",+ "approve_failed": "Could not approve the seller",+ "suspended": "Seller suspended",+ "suspend_failed": "Could not suspend the seller",+ "rejected": "Seller rejected",+ "reject_failed": "Could not reject the seller",+ "onboarding_reopened": "Sent back to onboarding"+ },+ "not_provided": "Not provided",+ "on_holiday_notice": "This seller is away. Their catalog stays visible but nothing can be bought from them.",+ "onboarding": {+ "title": "Onboarding",+ "progress": "{{done}} of {{total}} done",+ "waived": "Waived",+ "download": "Download file",+ "seller_note": "Seller: {{note}}",+ "review_note": "Your note: {{note}}",+ "actions": {+ "accept": "Accept",+ "reject": "Send back",+ "waive": "Waive for this seller"+ },+ "reject_confirm": {+ "title": "Send back?",+ "message": "The seller will be asked for \"{{name}}\" again."+ },+ "waive_confirm": {+ "title": "Waive this requirement?",+ "message": "\"{{name}}\" will count as met for this seller only."+ },+ "all_done": "All done 🎉",+ "status": {+ "complete": "Done",+ "pending": "Under review",+ "rejected": "Sent back",+ "incomplete": "Pending"+ }+ },+ "onboarding_column": "Onboarding",+ "payout_interval": {+ "inherit": "Use store default",+ "daily": "Daily",+ "weekly": "Weekly",+ "biweekly": "Every two weeks",+ "monthly": "Monthly",+ "manual": "Manual"+ },+ "products_column": "Products",+ "reject_confirm": {+ "title": "Reject seller?",+ "message": "{{name}} will not be admitted to the marketplace. You can still approve them later if this was a mistake."+ },+ "reopen_onboarding_confirm": {+ "title": "Send back to onboarding?",+ "message": "{{name}} will be able to change their details and ask for review again."+ },+ "search_placeholder": "Search sellers",+ "status": {+ "pending": "Pending",+ "invited": "Invited",+ "onboarding": "Onboarding",+ "ready_for_review": "Ready for review",+ "approved": "Approved",+ "suspended": "Suspended",+ "rejected": "Rejected",+ "canceled": "Canceled"+ },+ "status_help": {+ "pending": "Created, but nobody has been invited yet.",+ "invited": "Waiting for someone to accept the invitation.",+ "onboarding": "Filling in their details.",+ "ready_for_review": "Waiting for you to approve them.",+ "approved": "Selling on the marketplace.",+ "suspended": "Stopped from selling. Reinstate to let them trade again.",+ "rejected": "Not admitted to the marketplace.",+ "canceled": "They withdrew before joining."+ },+ "suspend_confirm": {+ "title": "Suspend seller?",+ "message": "{{name}} stops selling immediately. Their catalog and history stay, and you can reinstate them later."+ },+ "tax_remittance": {+ "seller": "Seller remits",+ "platform": "Marketplace remits"+ },+ "team_column": "Team"+ },+ "settings": {+ "webhooks": {+ "errors": {+ "redeliver_failed": "Failed to redeliver",+ "send_test_failed": "Failed to send test webhook"+ },+ "messages": {+ "removed": "Webhook endpoint removed",+ "updated": "Webhook endpoint updated"+ }+ }+ },+ "settings_nav": {+ "groups": {+ "audit": "Audit",+ "fulfillment": "Fulfillment",+ "payments": "Payments & taxes",+ "store": "Store",+ "team": "Team & access"+ },+ "items": {"allowed_origins": "Allowed origins","api_keys": "API keys","channels": "Sales channels",+ "commission_rates": "Commission rates","custom_field_definitions": "Custom fields","delivery_profiles": "Delivery profiles","emails": "Emails",@@ -3810,13 +4138,13 @@"profile": "Profile","reasons": "Returns & reasons","roles": "Roles",+ "seller_requirements": "Seller requirements","staff": "Staff","stock_locations": "Stock locations","store": "Store","tax_categories": "Tax categories","tax_rates": "Tax rates",- "webhooks": "Webhooks",- "commission_rates": "Commission rates"+ "webhooks": "Webhooks"}},"setup": {@@ -3981,91 +4309,50 @@},"search_placeholder": "Search by name…"},- "translations": {- "coverage_summary": "{{translated}} of {{total}} locales translated",- "dirty_summary": "{{count}} unsaved change(s)",- "discard_confirm": {- "message": "You have {{count}} unsaved translation change(s). Discard them?",- "title": "Discard changes?"- },- "field": "Field",- "load_error": "Could not load translations",- "locale": "Locale",- "manage": "Manage translations",- "no_locales": "Add more locales to your store to translate this product.",- "original": "Original",- "save": "Save translations",- "save_error": "Could not save translations",- "saved": "Translations saved",- "source": "Source",- "title": "Translations"- },- "jurisdiction": {- "everywhere": "Everywhere"- },- "companies": {- "add_cta": "Add company",- "add_sheet_title": "New company",- "create_description": "Business customers buy through branches. You can add branches, tax registration and exemption certificates once the company exists.",- "create_label": "Create company",+ "tax_exemption_certificates": {+ "add_cta": "Add certificate",+ "add_title": "Add exemption certificate","delete_confirm": {- "message": "This deletes {{name}} along with its branches, buyers and certificates. This cannot be undone.",- "title": "Delete company?"- },- "detail": {- "delete_label": "Delete company",- "load_error": "Could not load this company",- "profile": "Company"+ "message": "Certificate {{number}} will be removed. This cannot be undone.",+ "title": "Delete this certificate?"},- "empty": "No companies yet",- "locations_column": "Branches",+ "dialog_description": "Evidence that this business's purchases are not taxed. A new certificate waits for your decision before it applies.",+ "download_action": "Download document",+ "empty": "No certificates on file",+ "expires_prefix": "Expires",+ "lapsed": "Lapsed","messages": {- "created": "Company created",- "deleted": "Company deleted",- "updated": "Company updated"- },- "search_placeholder": "Search companies"- },- "company_locations": {- "add_cta": "Add branch",- "add_title": "New branch",- "addresses": "Addresses",- "billing_address": "Billing address",- "contacts_count_one": "{{count}} buyer",- "contacts_count_other": "{{count}} buyers",- "detail": {- "delete_label": "Delete branch",- "load_error": "Could not load this branch"+ "created": "Certificate added",+ "deleted": "Certificate deleted",+ "revoked": "Certificate revoked",+ "updated": "Certificate updated",+ "verified": "Certificate accepted"},- "dialog_description": "A branch is where the business is invoiced and where its orders ship. Addresses are optional, but a partial address needs a name and country.",- "edit_title": "Edit branch",- "empty": "No branches yet",- "messages": {- "created": "Branch created",- "deleted": "Branch deleted",- "updated": "Branch updated"+ "never_expires": "Does not expire",+ "no_document": "No document attached",+ "reason_codes": {+ "agricultural": "Agricultural",+ "charitable": "Charitable",+ "educational": "Educational",+ "government": "Government",+ "manufacturing": "Manufacturing",+ "resale": "Resale"},- "shipping_address": "Shipping address",- "shipping_same_as_billing": "Shipping address is the same as billing",- "title": "Branches"- },- "company_contacts": {- "add_cta": "Add buyer",- "add_title": "Authorise a buyer",- "dialog_description": "A customer who buys for this branch. Someone who buys for exactly one branch has their orders attributed to it automatically.",- "empty": "No buyers authorised yet",- "messages": {- "created": "Buyer added",- "deleted": "Buyer removed"+ "revoke_action": "Revoke",+ "revoke_confirm": {+ "message": "Certificate {{number}} stops applying to new orders. It stays on file as a record.",+ "title": "Revoke this certificate?"},- "remove_action": "Remove buyer",- "remove_confirm": {- "message": "{{email}} will no longer buy for this branch. Their customer account is not affected.",- "title": "Remove this buyer?"+ "select_reason": "Select a reason",+ "status": {+ "expired": "Expired",+ "pending": "Awaiting review",+ "revoked": "Revoked",+ "verified": "Accepted"},- "roles_enterprise_help": "Buyers you add here can place orders for this branch. Roles, approval workflows and spending limits come with Spree Enterprise.",- "roles_enterprise_title": "Roles and approvals are an Enterprise feature",- "title": "Buyers"+ "title": "Exemption certificates",+ "verified_at": "Accepted on",+ "verify_action": "Accept"},"tax_identifiers": {"add_cta": "Add registration",@@ -4105,50 +4392,11 @@"verified": "Verified"}},- "tax_exemption_certificates": {- "add_cta": "Add certificate",- "add_title": "Add exemption certificate",- "delete_confirm": {- "message": "Certificate {{number}} will be removed. This cannot be undone.",- "title": "Delete this certificate?"- },- "dialog_description": "Evidence that this business's purchases are not taxed. A new certificate waits for your decision before it applies.",- "download_action": "Download document",- "empty": "No certificates on file",- "expires_prefix": "Expires",- "lapsed": "Lapsed",- "messages": {- "created": "Certificate added",- "deleted": "Certificate deleted",- "revoked": "Certificate revoked",- "updated": "Certificate updated",- "verified": "Certificate accepted"- },- "never_expires": "Does not expire",- "no_document": "No document attached",- "reason_codes": {- "agricultural": "Agricultural",- "charitable": "Charitable",- "educational": "Educational",- "government": "Government",- "manufacturing": "Manufacturing",- "resale": "Resale"- },- "revoke_action": "Revoke",- "revoke_confirm": {- "message": "Certificate {{number}} stops applying to new orders. It stays on file as a record.",- "title": "Revoke this certificate?"- },- "select_reason": "Select a reason",- "status": {- "expired": "Expired",- "pending": "Awaiting review",- "revoked": "Revoked",- "verified": "Accepted"- },- "title": "Exemption certificates",- "verified_at": "Accepted on",- "verify_action": "Accept"+ "tax_providers": {+ "limitations_title": "{{name}} does not handle",+ "unavailable_option": "{{name}} (not configured)",+ "use_default": "Use the default engine",+ "use_default_named": "Default ({{name}})"},"tax_rates": {"add_cta": "Add tax rate",@@ -4171,148 +4419,24 @@"search_placeholder": "Search tax rates","select_category": "Select a category"},- "tax_providers": {- "limitations_title": "{{name}} does not handle",- "unavailable_option": "{{name}} (not configured)",- "use_default": "Use the default engine",- "use_default_named": "Default ({{name}})"- },- "enterprise": {- "learn_more": "Learn about Spree Enterprise"- },- "sellers": {- "add_cta": "Add seller",- "add_sheet_title": "New seller",- "create_description": "Create the seller record first. You can invite them, approve them and set up payouts from their page.",- "create_label": "Create seller",- "search_placeholder": "Search sellers",- "empty": "No sellers yet",- "products_column": "Products",- "team_column": "Team",- "on_holiday_notice": "This seller is away. Their catalog stays visible but nothing can be bought from them.",- "delete_confirm": {- "title": "Delete seller?",- "message": "This removes {{name}} from the marketplace. Their products stay in your catalog without a seller. This cannot be undone."- },- "suspend_confirm": {- "title": "Suspend seller?",- "message": "{{name}} stops selling immediately. Their catalog and history stay, and you can reinstate them later."- },- "reject_confirm": {- "title": "Reject seller?",- "message": "{{name}} will not be admitted to the marketplace. You can still approve them later if this was a mistake."- },- "invite_sheet": {- "title": "Invite seller",- "description": "They join the seller team when they accept and can then sign in to their own panel.",- "email_help": "The invitation goes to this address."- },- "actions": {- "invite": "Invite",- "reinvite": "Send again",- "send_invitation": "Send invitation",- "approve": "Approve",- "reinstate": "Reinstate",- "suspend": "Suspend",- "reject": "Reject"- },- "detail": {- "load_error": "Could not load this seller",- "delete_label": "Delete seller",- "status": "Status",- "settlement": "Payouts and tax",- "at_a_glance": "At a glance",- "contact": "Contact",- "edit_profile": "Edit profile",- "edit_profile_description": "The seller maintains this from their own panel. Edits here apply on their behalf.",- "edit_settlement": "Edit payouts and tax",- "edit_settlement_description": "Only you can see or change these. The seller never edits them.",- "no_about": "This seller has not written a description yet."- },- "status": {- "pending": "Pending",- "invited": "Invited",- "onboarding": "Onboarding",- "ready_for_review": "Ready for review",- "approved": "Approved",- "suspended": "Suspended",- "rejected": "Rejected",- "canceled": "Canceled"- },- "status_help": {- "pending": "Created, but nobody has been invited yet.",- "invited": "Waiting for someone to accept the invitation.",- "onboarding": "Filling in their details.",- "ready_for_review": "Waiting for you to approve them.",- "approved": "Selling on the marketplace.",- "suspended": "Stopped from selling. Reinstate to let them trade again.",- "rejected": "Not admitted to the marketplace.",- "canceled": "They withdrew before joining."- },- "tax_remittance": {- "seller": "Seller remits",- "platform": "Marketplace remits"- },- "payout_interval": {- "inherit": "Use store default",- "daily": "Daily",- "weekly": "Weekly",- "biweekly": "Every two weeks",- "monthly": "Monthly",- "manual": "Manual"- },- "messages": {- "created": "Seller created",- "create_failed": "Could not create the seller",- "updated": "Seller updated",- "update_failed": "Could not update the seller",- "deleted": "Seller deleted",- "delete_failed": "Could not delete the seller",- "invited": "Invitation sent",- "invite_failed": "Could not send the invitation",- "approved": "Seller approved",- "approve_failed": "Could not approve the seller",- "suspended": "Seller suspended",- "suspend_failed": "Could not suspend the seller",- "rejected": "Seller rejected",- "reject_failed": "Could not reject the seller"- },- "not_provided": "Not provided",- "images": {- "logo_label": "Logo",- "logo_help": "Square works best. Shown beside the seller everywhere they appear.",- "square_logo_label": "Square logo",- "square_logo_help": "Used where a tight square is needed, such as an avatar.",- "cover_photo_label": "Cover photo",- "cover_photo_help": "A wide banner across the top of the seller profile."- },- "autocomplete": {- "placeholder": "Search sellers",- "empty": "No sellers found"- }- },- "commission_rates": {- "add_cta": "Add commission rate",- "applies_to_everything": "Every sale",- "create_description": "Set what the marketplace charges sellers, and which sales it applies to.",- "create_label": "Create commission rate",- "delete_confirm": {- "message": "{{name}} will be removed. Commission already charged is unaffected.",- "title": "Delete commission rate?"- },- "edit_description": "Update the charge, its limits, and which sales it applies to.",- "empty": "No commission rates yet",- "messages": {- "created": "Commission rate created",- "deleted": "Commission rate deleted",- "updated": "Commission rate updated"+ "translations": {+ "coverage_summary": "{{translated}} of {{total}} locales translated",+ "dirty_summary": "{{count}} unsaved change(s)",+ "discard_confirm": {+ "message": "You have {{count}} unsaved translation change(s). Discard them?",+ "title": "Discard changes?"},- "search_placeholder": "Search by name…",- "order_hint": "New rates go to the top of the list, and the first one that matches a sale wins — drag to reorder.",- "conditions": {- "add": "Add condition",- "title": "Conditions"- }+ "field": "Field",+ "load_error": "Could not load translations",+ "locale": "Locale",+ "manage": "Manage translations",+ "no_locales": "Add more locales to your store to translate this product.",+ "original": "Original",+ "save": "Save translations",+ "save_error": "Could not save translations",+ "saved": "Translations saved",+ "source": "Source",+ "title": "Translations"}}}diff --git a/packages/dashboard/src/locales/fr.json b/packages/dashboard/src/locales/fr.jsonindex fcaa7236d4..c764bab3f5 100644--- a/packages/dashboard/src/locales/fr.json+++ b/packages/dashboard/src/locales/fr.json@@ -289,6 +289,93 @@},"title": "Collections"},+ "commission_rates": {+ "add_cta": "Ajouter un taux de commission",+ "applies_to_everything": "Toutes les ventes",+ "create_description": "Définissez ce que la place de marché facture aux vendeurs, et les ventes concernées.",+ "create_label": "Créer le taux de commission",+ "delete_confirm": {+ "message": "{{name}} sera supprimé. Les commissions déjà facturées ne changent pas.",+ "title": "Supprimer le taux de commission ?"+ },+ "edit_description": "Modifiez les frais, leurs limites et les ventes concernées.",+ "empty": "Aucun taux de commission",+ "messages": {+ "created": "Taux de commission créé",+ "deleted": "Taux de commission supprimé",+ "updated": "Taux de commission mis à jour"+ },+ "search_placeholder": "Rechercher par nom…",+ "order_hint": "Les nouveaux taux se placent en haut de la liste, et le premier qui correspond l'emporte — glissez pour réordonner.",+ "conditions": {+ "add": "Ajouter une condition",+ "title": "Conditions"+ }+ },+ "companies": {+ "add_cta": "Ajouter une entreprise",+ "add_sheet_title": "Nouvelle entreprise",+ "create_description": "Les clients professionnels achètent via des établissements. Vous pourrez ajouter des établissements, un numéro de TVA et des attestations d'exonération une fois l'entreprise créée.",+ "create_label": "Créer l'entreprise",+ "delete_confirm": {+ "message": "Cela supprime {{name}} ainsi que ses établissements, ses acheteurs et ses attestations. Cette action est irréversible.",+ "title": "Supprimer l'entreprise ?"+ },+ "detail": {+ "delete_label": "Supprimer l'entreprise",+ "load_error": "Impossible de charger cette entreprise",+ "profile": "Entreprise"+ },+ "empty": "Aucune entreprise pour le moment",+ "locations_column": "Établissements",+ "messages": {+ "created": "Entreprise créée",+ "deleted": "Entreprise supprimée",+ "updated": "Entreprise mise à jour"+ },+ "search_placeholder": "Rechercher des entreprises"+ },+ "company_contacts": {+ "add_cta": "Ajouter un acheteur",+ "add_title": "Autoriser un acheteur",+ "dialog_description": "Un client qui achète pour cet établissement. Celui qui achète pour un seul établissement voit ses commandes rattachées automatiquement.",+ "empty": "Aucun acheteur autorisé pour le moment",+ "messages": {+ "created": "Acheteur ajouté",+ "deleted": "Acheteur retiré"+ },+ "remove_action": "Retirer l'acheteur",+ "remove_confirm": {+ "message": "{{email}} n'achètera plus pour cet établissement. Son compte client n'est pas modifié.",+ "title": "Retirer cet acheteur ?"+ },+ "roles_enterprise_help": "Les acheteurs ajoutés ici peuvent commander pour cet établissement. Les rôles, circuits de validation et plafonds de dépenses font partie de Spree Enterprise.",+ "roles_enterprise_title": "Les rôles et validations sont une fonctionnalité Enterprise",+ "title": "Acheteurs"+ },+ "company_locations": {+ "add_cta": "Ajouter un établissement",+ "add_title": "Nouvel établissement",+ "addresses": "Adresses",+ "billing_address": "Adresse de facturation",+ "contacts_count_one": "{{count}} acheteur",+ "contacts_count_other": "{{count}} acheteurs",+ "detail": {+ "delete_label": "Supprimer l'établissement",+ "load_error": "Impossible de charger cet établissement"+ },+ "dialog_description": "Un établissement est l'adresse de facturation et de livraison de l'entreprise. Les adresses sont facultatives, mais une adresse renseignée exige un nom et un pays.",+ "edit_title": "Modifier l'établissement",+ "empty": "Aucun établissement pour le moment",+ "messages": {+ "created": "Établissement créé",+ "deleted": "Établissement supprimé",+ "updated": "Établissement mis à jour"+ },+ "shipping_address": "Adresse de livraison",+ "shipping_same_as_billing": "L'adresse de livraison est identique à celle de facturation",+ "title": "Établissements"+ },"components": {"adjustment_action_editor": {"calculator_label": "Calculateur",@@ -547,6 +634,67 @@"split_description": "Expédiez les mêmes produits depuis un second entrepôt avec ses propres zones et tarifs.","split_title": "Séparer les origines d'expédition"},+ "delivery_profiles": {+ "add_cta": "Ajouter un profil",+ "add_dialog_title": "Nouveau profil de livraison",+ "all_locations": "Tous les emplacements",+ "capabilities": {+ "digital": "Numérique",+ "pickup": "Retrait",+ "ships": "Expédition"+ },+ "create_description": "Regroupez les produits expédiés de la même façon, avec leurs propres emplacements, zones et méthodes de livraison.",+ "create_label": "Créer le profil",+ "default_badge": "Par défaut",+ "default_confirm": {+ "message": "Les produits sans profil propre seront désormais expédiés avec « {{name}} ».",+ "title": "Définir comme profil par défaut"+ },+ "delete_confirm": {+ "message": "Supprimer « {{name}} » ? Ses zones et méthodes de livraison seront supprimées avec lui.",+ "title": "Supprimer le profil d’expédition"+ },+ "detail": {+ "add_digital_method": "Ajouter une méthode numérique",+ "add_method": "Ajouter une méthode",+ "collect_from": "Retrait depuis",+ "collect_from_hint": "Emplacements où les clients peuvent retirer leur commande. Les modifications prennent effet immédiatement.",+ "delete_label": "Supprimer le profil",+ "digital_empty": "Aucune méthode de livraison numérique.",+ "digital_hint": "Livré sans expédition ni retrait.",+ "digital_title": "Livraison numérique",+ "general_title": "Général",+ "hidden_badge": "Masquée",+ "load_failed_title": "Impossible de charger ce profil d’expédition",+ "no_methods": "Aucune méthode de livraison ici pour le moment.",+ "no_stock_locations": "Aucun emplacement — ajoutez-en un dans Paramètres → Emplacements.",+ "no_zone_hint": "Ces méthodes sont proposées partout où ce profil s’applique.",+ "no_zone_title": "Aucune restriction de zone",+ "no_zones": "Aucune zone pour le moment — ajoutez-en une pour proposer des méthodes de livraison.",+ "offer_pickup": "Proposer le retrait",+ "origins_title": "Expédié depuis",+ "pickup_empty": "Aucune méthode de retrait — les clients ne peuvent pas retirer de commandes sur ce profil.",+ "pickup_hint": "Les clients retirent ces commandes en personne. Le retrait n’a pas de destination, les zones ne s’appliquent donc pas.",+ "pickup_title": "Retrait",+ "zones_title": "Zones et méthodes de livraison"+ },+ "empty": "Aucun profil de livraison pour le moment.",+ "is_default_hint": "Les produits sans profil propre sont expédiés avec celui-ci.",+ "kind_immutable_hint": "Le type est fixé à la création du profil.",+ "kinds": {+ "digital": "Numérique",+ "shipping": "Expédition"+ },+ "locations_count": "{{count}} emplacements",+ "make_default": "Définir par défaut",+ "messages": {+ "created": "Profil d’expédition créé",+ "deleted": "Profil d’expédition supprimé",+ "updated": "Profil d’expédition mis à jour"+ },+ "search_placeholder": "Rechercher des profils de livraison…",+ "selected_locations": "Emplacements sélectionnés"+ },"delivery_zones": {"add_countries_in_markets": "Ajouter d’autres pays dans Marchés","add_cta": "Ajouter une zone",@@ -590,6 +738,9 @@"to_placeholder": "À","toggle_states": "Afficher les régions de {{country}}"},+ "enterprise": {+ "learn_more": "En savoir plus sur Spree Enterprise"+ },"errors": {"forbidden_description": "Vous n’avez pas la permission de voir cette page.","forbidden_title": "Non autorisé",@@ -1718,67 +1869,6 @@}}},- "delivery_profiles": {- "add_cta": "Ajouter un profil",- "add_dialog_title": "Nouveau profil de livraison",- "all_locations": "Tous les emplacements",- "capabilities": {- "digital": "Numérique",- "pickup": "Retrait",- "ships": "Expédition"- },- "create_description": "Regroupez les produits expédiés de la même façon, avec leurs propres emplacements, zones et méthodes de livraison.",- "create_label": "Créer le profil",- "default_badge": "Par défaut",- "default_confirm": {- "message": "Les produits sans profil propre seront désormais expédiés avec « {{name}} ».",- "title": "Définir comme profil par défaut"- },- "delete_confirm": {- "message": "Supprimer « {{name}} » ? Ses zones et méthodes de livraison seront supprimées avec lui.",- "title": "Supprimer le profil d’expédition"- },- "detail": {- "add_digital_method": "Ajouter une méthode numérique",- "add_method": "Ajouter une méthode",- "collect_from": "Retrait depuis",- "collect_from_hint": "Emplacements où les clients peuvent retirer leur commande. Les modifications prennent effet immédiatement.",- "delete_label": "Supprimer le profil",- "digital_empty": "Aucune méthode de livraison numérique.",- "digital_hint": "Livré sans expédition ni retrait.",- "digital_title": "Livraison numérique",- "general_title": "Général",- "hidden_badge": "Masquée",- "load_failed_title": "Impossible de charger ce profil d’expédition",- "no_methods": "Aucune méthode de livraison ici pour le moment.",- "no_stock_locations": "Aucun emplacement — ajoutez-en un dans Paramètres → Emplacements.",- "no_zone_hint": "Ces méthodes sont proposées partout où ce profil s’applique.",- "no_zone_title": "Aucune restriction de zone",- "no_zones": "Aucune zone pour le moment — ajoutez-en une pour proposer des méthodes de livraison.",- "offer_pickup": "Proposer le retrait",- "origins_title": "Expédié depuis",- "pickup_empty": "Aucune méthode de retrait — les clients ne peuvent pas retirer de commandes sur ce profil.",- "pickup_hint": "Les clients retirent ces commandes en personne. Le retrait n’a pas de destination, les zones ne s’appliquent donc pas.",- "pickup_title": "Retrait",- "zones_title": "Zones et méthodes de livraison"- },- "empty": "Aucun profil de livraison pour le moment.",- "is_default_hint": "Les produits sans profil propre sont expédiés avec celui-ci.",- "kind_immutable_hint": "Le type est fixé à la création du profil.",- "kinds": {- "digital": "Numérique",- "shipping": "Expédition"- },- "locations_count": "{{count}} emplacements",- "make_default": "Définir par défaut",- "messages": {- "created": "Profil d’expédition créé",- "deleted": "Profil d’expédition supprimé",- "updated": "Profil d’expédition mis à jour"- },- "search_placeholder": "Rechercher des profils de livraison…",- "selected_locations": "Emplacements sélectionnés"- },"gift_cards": {"batch_autocomplete": {"empty": "Aucun lot correspondant",@@ -1939,6 +2029,9 @@"sign_in_and_accept": "Se connecter et accepter","sign_in_to_accept": ". Connectez-vous pour accepter."},+ "jurisdiction": {+ "everywhere": "Partout"+ },"markets": {"add_cta": "Ajouter un marché","columns": {@@ -3775,30 +3868,265 @@"name_required": "Le nom est requis"}},- "settings": {- "webhooks": {- "errors": {- "redeliver_failed": "Échec de la nouvelle livraison",- "send_test_failed": "Échec de l'envoi du webhook de test"+ "seller_requirements": {+ "title": "Exigences vendeurs",+ "search_placeholder": "Rechercher des exigences",+ "empty": "Aucune exigence pour l'instant. Les vendeurs peuvent demander un examen immédiatement.",+ "add_cta": "Ajouter une exigence",+ "add_title": "Ajouter une exigence",+ "edit_title": "Modifier l'exigence",+ "columns": {+ "kind": "Type",+ "required": "Obligatoire"+ },+ "required": {+ "yes": "Obligatoire",+ "no": "Recommandé"+ },+ "status": {+ "disabled": "Désactivé"+ },+ "fields": {+ "accepted_files": {+ "label": "Fichiers acceptés",+ "help": "Les vendeurs peuvent envoyer : {{types}}"},- "messages": {- "removed": "Point de terminaison webhook supprimé",- "updated": "Point de terminaison webhook mis à jour"+ "active": {+ "label": "Actif",+ "help": "Désactivez pour ne plus le demander sans le supprimer."+ },+ "custom_fields": {+ "label": "Champs personnalisés",+ "help": "Le vendeur doit remplir chaque champ que vous choisissez.",+ "placeholder": "Rechercher des champs",+ "empty": "Aucun champ vendeur trouvé. Créez-les dans Paramètres → Champs personnalisés."+ },+ "description": {+ "label": "Instructions",+ "placeholder": "Expliquez au vendeur ce dont vous avez besoin et pourquoi"+ },+ "kind": {+ "label": "Type",+ "placeholder": "Choisissez ce que vous demandez"+ },+ "name": {+ "label": "Nom",+ "label_required": "Nom (obligatoire)",+ "help": "Ce que le vendeur voit sur sa liste."+ },+ "required": {+ "label": "Obligatoire",+ "help": "Les éléments obligatoires doivent être faits avant l'approbation. Les autres sont recommandés."}+ },+ "delete_confirm": {+ "title": "Supprimer l'exigence ?",+ "message": "Les vendeurs ne seront plus invités à fournir « {{name}} ». Ce qu'ils ont déjà envoyé est également supprimé."+ },+ "messages": {+ "created": "Exigence ajoutée",+ "updated": "Exigence enregistrée",+ "deleted": "Exigence supprimée",+ "submission_accepted": "Accepté",+ "submission_rejected": "Renvoyé au vendeur",+ "waived": "Exigence levée pour ce vendeur"+ },+ "kinds": {+ "accept_terms": "Accepter les conditions",+ "complete_profile": "Compléter le profil",+ "billing_address": "Adresse de facturation",+ "returns_address": "Adresse de retour",+ "minimum_products": "Nombre minimum de produits",+ "required_custom_fields": "Champs personnalisés obligatoires",+ "attestation": "Confirmation du vendeur",+ "operator_review": "Vérification manuelle",+ "document": "Document"}},- "settings_nav": {- "groups": {- "audit": "Audit",- "fulfillment": "Traitement des commandes",- "payments": "Paiements et taxes",- "store": "Boutique",- "team": "Équipe et accès"- },+ "sellers": {+ "actions": {+ "invite": "Inviter",+ "reinvite": "Renvoyer",+ "send_invitation": "Envoyer l'invitation",+ "approve": "Approuver",+ "reinstate": "Réactiver",+ "suspend": "Suspendre",+ "reject": "Refuser",+ "reopen_onboarding": "Renvoyer à la configuration"+ },+ "add_cta": "Ajouter un vendeur",+ "add_sheet_title": "Nouveau vendeur",+ "address": {+ "filled": "Renseignée",+ "not_filled": "Non renseignée",+ "not_provided_by_seller": "Pas encore fournie par le vendeur",+ "not_located_yet": "La carte apparaît une fois cette adresse localisée."+ },+ "approve_override_confirm": {+ "title": "Approuver quand même ?",+ "message": "Ce vendeur n'a pas terminé : {{names}}. L'approuver maintenant l'autorise à vendre malgré tout, et la décision est enregistrée.",+ "action": "Approuver quand même"+ },+ "autocomplete": {+ "placeholder": "Rechercher des vendeurs",+ "empty": "Aucun vendeur trouvé"+ },+ "create_description": "Créez d'abord la fiche du vendeur. Vous pourrez l'inviter, l'approuver et configurer ses versements depuis sa page.",+ "create_label": "Créer le vendeur",+ "delete_confirm": {+ "title": "Supprimer le vendeur ?",+ "message": "Cela retire {{name}} de la place de marché. Ses produits restent dans votre catalogue sans vendeur. Action irréversible."+ },+ "detail": {+ "load_error": "Impossible de charger ce vendeur",+ "delete_label": "Supprimer le vendeur",+ "status": "Statut",+ "settlement": "Versements et taxes",+ "at_a_glance": "En un coup d'œil",+ "contact": "Contact",+ "edit_profile": "Modifier le profil",+ "edit_profile_description": "Le vendeur gère ces informations depuis son propre espace. Les modifications faites ici le sont en son nom.",+ "edit_settlement": "Modifier les versements et les taxes",+ "edit_settlement_description": "Vous seul pouvez voir et modifier ces réglages. Le vendeur ne les modifie jamais.",+ "no_about": "Ce vendeur n'a pas encore rédigé de description.",+ "billing_address": "Adresse de facturation",+ "returns_address": "Adresse de retour"+ },+ "empty": "Aucun vendeur pour le moment",+ "images": {+ "logo_label": "Logo",+ "logo_help": "Un format carré convient le mieux. Affiché à côté du vendeur partout où il apparaît.",+ "square_logo_label": "Logo carré",+ "square_logo_help": "Pour les emplacements qui exigent un carré strict, comme un avatar.",+ "cover_photo_label": "Photo de couverture",+ "cover_photo_help": "Une bannière large en haut du profil du vendeur."+ },+ "invite_sheet": {+ "title": "Inviter un vendeur",+ "description": "La personne rejoint l'équipe du vendeur en acceptant et peut alors se connecter à son propre espace.",+ "email_help": "L'invitation part à cette adresse."+ },+ "messages": {+ "created": "Vendeur créé",+ "create_failed": "Impossible de créer le vendeur",+ "updated": "Vendeur mis à jour",+ "update_failed": "Impossible de mettre à jour le vendeur",+ "deleted": "Vendeur supprimé",+ "delete_failed": "Impossible de supprimer le vendeur",+ "invited": "Invitation envoyée",+ "invite_failed": "Impossible d'envoyer l'invitation",+ "approved": "Vendeur approuvé",+ "approve_failed": "Impossible d'approuver le vendeur",+ "suspended": "Vendeur suspendu",+ "suspend_failed": "Impossible de suspendre le vendeur",+ "rejected": "Vendeur refusé",+ "reject_failed": "Impossible de refuser le vendeur",+ "onboarding_reopened": "Renvoyé à la configuration"+ },+ "not_provided": "Non renseigné",+ "on_holiday_notice": "Ce vendeur est absent. Son catalogue reste visible mais rien ne peut être acheté.",+ "onboarding": {+ "title": "Configuration",+ "progress": "{{done}} sur {{total}} terminé",+ "waived": "Levée",+ "download": "Télécharger le fichier",+ "seller_note": "Vendeur : {{note}}",+ "review_note": "Votre note : {{note}}",+ "actions": {+ "accept": "Accepter",+ "reject": "Renvoyer",+ "waive": "Lever pour ce vendeur"+ },+ "reject_confirm": {+ "title": "Renvoyer ?",+ "message": "Le vendeur devra fournir « {{name}} » à nouveau."+ },+ "waive_confirm": {+ "title": "Lever cette exigence ?",+ "message": "« {{name}} » comptera comme remplie pour ce vendeur uniquement."+ },+ "all_done": "Tout est fait 🎉",+ "status": {+ "complete": "Fait",+ "pending": "En cours d’examen",+ "rejected": "Renvoyé",+ "incomplete": "En attente"+ }+ },+ "onboarding_column": "Configuration",+ "payout_interval": {+ "inherit": "Valeur par défaut de la boutique",+ "daily": "Chaque jour",+ "weekly": "Chaque semaine",+ "biweekly": "Toutes les deux semaines",+ "monthly": "Chaque mois",+ "manual": "Manuel"+ },+ "products_column": "Produits",+ "reject_confirm": {+ "title": "Refuser le vendeur ?",+ "message": "{{name}} ne sera pas admis sur la place de marché. Vous pourrez toujours l'approuver plus tard."+ },+ "reopen_onboarding_confirm": {+ "title": "Renvoyer à la configuration ?",+ "message": "{{name}} pourra modifier ses informations et redemander un examen."+ },+ "search_placeholder": "Rechercher des vendeurs",+ "status": {+ "pending": "En attente",+ "invited": "Invité",+ "onboarding": "Configuration",+ "ready_for_review": "À examiner",+ "approved": "Approuvé",+ "suspended": "Suspendu",+ "rejected": "Refusé",+ "canceled": "Annulé"+ },+ "status_help": {+ "pending": "Créé, mais personne n'a encore été invité.",+ "invited": "En attente de l'acceptation de l'invitation.",+ "onboarding": "Renseigne ses informations.",+ "ready_for_review": "Attend votre approbation.",+ "approved": "Vend sur la place de marché.",+ "suspended": "Ne peut plus vendre. Réactivez-le pour reprendre.",+ "rejected": "Non admis sur la place de marché.",+ "canceled": "S'est retiré avant de rejoindre."+ },+ "suspend_confirm": {+ "title": "Suspendre le vendeur ?",+ "message": "{{name}} cesse de vendre immédiatement. Son catalogue et son historique sont conservés, et vous pourrez le réactiver plus tard."+ },+ "tax_remittance": {+ "seller": "Le vendeur reverse",+ "platform": "La place de marché reverse"+ },+ "team_column": "Équipe"+ },+ "settings": {+ "webhooks": {+ "errors": {+ "redeliver_failed": "Échec de la nouvelle livraison",+ "send_test_failed": "Échec de l'envoi du webhook de test"+ },+ "messages": {+ "removed": "Point de terminaison webhook supprimé",+ "updated": "Point de terminaison webhook mis à jour"+ }+ }+ },+ "settings_nav": {+ "groups": {+ "audit": "Audit",+ "fulfillment": "Traitement des commandes",+ "payments": "Paiements et taxes",+ "store": "Boutique",+ "team": "Équipe et accès"+ },"items": {"allowed_origins": "Origines autorisées","api_keys": "Clés API","channels": "Canaux de vente",+ "commission_rates": "Taux de commission","custom_field_definitions": "Champs personnalisés","delivery_profiles": "Profils de livraison","emails": "E-mails",@@ -3810,13 +4138,13 @@"profile": "Profil","reasons": "Retours et motifs","roles": "Rôles",+ "seller_requirements": "Exigences vendeurs","staff": "Personnel","stock_locations": "Emplacements de stock","store": "Boutique","tax_categories": "Catégories de taxe","tax_rates": "Taux de taxe",- "webhooks": "Webhooks",- "commission_rates": "Taux de commission"+ "webhooks": "Webhooks"}},"setup": {@@ -3981,91 +4309,50 @@},"search_placeholder": "Rechercher par nom…"},- "translations": {- "coverage_summary": "{{translated}} sur {{total}} langues traduites",- "dirty_summary": "{{count}} modification(s) non enregistrée(s)",- "discard_confirm": {- "message": "Vous avez {{count}} modification(s) de traduction non enregistrée(s). Les annuler ?",- "title": "Annuler les modifications ?"- },- "field": "Champ",- "load_error": "Impossible de charger les traductions",- "locale": "Langue",- "manage": "Gérer les traductions",- "no_locales": "Ajoutez d autres langues à votre boutique pour traduire ce produit.",- "original": "Original",- "save": "Enregistrer les traductions",- "save_error": "Impossible d enregistrer les traductions",- "saved": "Traductions enregistrées",- "source": "Source",- "title": "Traductions"- },- "jurisdiction": {- "everywhere": "Partout"- },- "companies": {- "add_cta": "Ajouter une entreprise",- "add_sheet_title": "Nouvelle entreprise",- "create_description": "Les clients professionnels achètent via des établissements. Vous pourrez ajouter des établissements, un numéro de TVA et des attestations d'exonération une fois l'entreprise créée.",- "create_label": "Créer l'entreprise",+ "tax_exemption_certificates": {+ "add_cta": "Ajouter une attestation",+ "add_title": "Ajouter une attestation d'exonération","delete_confirm": {- "message": "Cela supprime {{name}} ainsi que ses établissements, ses acheteurs et ses attestations. Cette action est irréversible.",- "title": "Supprimer l'entreprise ?"- },- "detail": {- "delete_label": "Supprimer l'entreprise",- "load_error": "Impossible de charger cette entreprise",- "profile": "Entreprise"+ "message": "L'attestation {{number}} sera retirée. Cette action est irréversible.",+ "title": "Supprimer cette attestation ?"},- "empty": "Aucune entreprise pour le moment",- "locations_column": "Établissements",+ "dialog_description": "La preuve que les achats de cette entreprise ne sont pas taxés. Une nouvelle attestation ne s'applique qu'une fois acceptée.",+ "download_action": "Télécharger le document",+ "empty": "Aucune attestation enregistrée",+ "expires_prefix": "Expire",+ "lapsed": "Périmée","messages": {- "created": "Entreprise créée",- "deleted": "Entreprise supprimée",- "updated": "Entreprise mise à jour"- },- "search_placeholder": "Rechercher des entreprises"- },- "company_locations": {- "add_cta": "Ajouter un établissement",- "add_title": "Nouvel établissement",- "addresses": "Adresses",- "billing_address": "Adresse de facturation",- "contacts_count_one": "{{count}} acheteur",- "contacts_count_other": "{{count}} acheteurs",- "detail": {- "delete_label": "Supprimer l'établissement",- "load_error": "Impossible de charger cet établissement"+ "created": "Attestation ajoutée",+ "deleted": "Attestation supprimée",+ "revoked": "Attestation révoquée",+ "updated": "Attestation mise à jour",+ "verified": "Attestation acceptée"},- "dialog_description": "Un établissement est l'adresse de facturation et de livraison de l'entreprise. Les adresses sont facultatives, mais une adresse renseignée exige un nom et un pays.",- "edit_title": "Modifier l'établissement",- "empty": "Aucun établissement pour le moment",- "messages": {- "created": "Établissement créé",- "deleted": "Établissement supprimé",- "updated": "Établissement mis à jour"+ "never_expires": "Sans expiration",+ "no_document": "Aucun document joint",+ "reason_codes": {+ "agricultural": "Agriculture",+ "charitable": "Organisme caritatif",+ "educational": "Enseignement",+ "government": "Administration",+ "manufacturing": "Production",+ "resale": "Revente"},- "shipping_address": "Adresse de livraison",- "shipping_same_as_billing": "L'adresse de livraison est identique à celle de facturation",- "title": "Établissements"- },- "company_contacts": {- "add_cta": "Ajouter un acheteur",- "add_title": "Autoriser un acheteur",- "dialog_description": "Un client qui achète pour cet établissement. Celui qui achète pour un seul établissement voit ses commandes rattachées automatiquement.",- "empty": "Aucun acheteur autorisé pour le moment",- "messages": {- "created": "Acheteur ajouté",- "deleted": "Acheteur retiré"+ "revoke_action": "Révoquer",+ "revoke_confirm": {+ "message": "L'attestation {{number}} ne s'appliquera plus aux nouvelles commandes. Elle reste conservée comme justificatif.",+ "title": "Révoquer cette attestation ?"},- "remove_action": "Retirer l'acheteur",- "remove_confirm": {- "message": "{{email}} n'achètera plus pour cet établissement. Son compte client n'est pas modifié.",- "title": "Retirer cet acheteur ?"+ "select_reason": "Choisir un motif",+ "status": {+ "expired": "Expirée",+ "pending": "En attente d'examen",+ "revoked": "Révoquée",+ "verified": "Acceptée"},- "roles_enterprise_help": "Les acheteurs ajoutés ici peuvent commander pour cet établissement. Les rôles, circuits de validation et plafonds de dépenses font partie de Spree Enterprise.",- "roles_enterprise_title": "Les rôles et validations sont une fonctionnalité Enterprise",- "title": "Acheteurs"+ "title": "Attestations d'exonération",+ "verified_at": "Acceptée le",+ "verify_action": "Accepter"},"tax_identifiers": {"add_cta": "Ajouter un numéro",@@ -4105,50 +4392,11 @@"verified": "Vérifié"}},- "tax_exemption_certificates": {- "add_cta": "Ajouter une attestation",- "add_title": "Ajouter une attestation d'exonération",- "delete_confirm": {- "message": "L'attestation {{number}} sera retirée. Cette action est irréversible.",- "title": "Supprimer cette attestation ?"- },- "dialog_description": "La preuve que les achats de cette entreprise ne sont pas taxés. Une nouvelle attestation ne s'applique qu'une fois acceptée.",- "download_action": "Télécharger le document",- "empty": "Aucune attestation enregistrée",- "expires_prefix": "Expire",- "lapsed": "Périmée",- "messages": {- "created": "Attestation ajoutée",- "deleted": "Attestation supprimée",- "revoked": "Attestation révoquée",- "updated": "Attestation mise à jour",- "verified": "Attestation acceptée"- },- "never_expires": "Sans expiration",- "no_document": "Aucun document joint",- "reason_codes": {- "agricultural": "Agriculture",- "charitable": "Organisme caritatif",- "educational": "Enseignement",- "government": "Administration",- "manufacturing": "Production",- "resale": "Revente"- },- "revoke_action": "Révoquer",- "revoke_confirm": {- "message": "L'attestation {{number}} ne s'appliquera plus aux nouvelles commandes. Elle reste conservée comme justificatif.",- "title": "Révoquer cette attestation ?"- },- "select_reason": "Choisir un motif",- "status": {- "expired": "Expirée",- "pending": "En attente d'examen",- "revoked": "Révoquée",- "verified": "Acceptée"- },- "title": "Attestations d'exonération",- "verified_at": "Acceptée le",- "verify_action": "Accepter"+ "tax_providers": {+ "limitations_title": "{{name}} ne prend pas en charge",+ "unavailable_option": "{{name}} (non configuré)",+ "use_default": "Utiliser le moteur par défaut",+ "use_default_named": "Par défaut ({{name}})"},"tax_rates": {"add_cta": "Ajouter un taux",@@ -4171,148 +4419,24 @@"search_placeholder": "Rechercher des taux","select_category": "Choisir une catégorie"},- "tax_providers": {- "limitations_title": "{{name}} ne prend pas en charge",- "unavailable_option": "{{name}} (non configuré)",- "use_default": "Utiliser le moteur par défaut",- "use_default_named": "Par défaut ({{name}})"- },- "enterprise": {- "learn_more": "En savoir plus sur Spree Enterprise"- },- "sellers": {- "add_cta": "Ajouter un vendeur",- "add_sheet_title": "Nouveau vendeur",- "create_description": "Créez d'abord la fiche du vendeur. Vous pourrez l'inviter, l'approuver et configurer ses versements depuis sa page.",- "create_label": "Créer le vendeur",- "search_placeholder": "Rechercher des vendeurs",- "empty": "Aucun vendeur pour le moment",- "products_column": "Produits",- "team_column": "Équipe",- "on_holiday_notice": "Ce vendeur est absent. Son catalogue reste visible mais rien ne peut être acheté.",- "delete_confirm": {- "title": "Supprimer le vendeur ?",- "message": "Cela retire {{name}} de la place de marché. Ses produits restent dans votre catalogue sans vendeur. Action irréversible."- },- "suspend_confirm": {- "title": "Suspendre le vendeur ?",- "message": "{{name}} cesse de vendre immédiatement. Son catalogue et son historique sont conservés, et vous pourrez le réactiver plus tard."- },- "reject_confirm": {- "title": "Refuser le vendeur ?",- "message": "{{name}} ne sera pas admis sur la place de marché. Vous pourrez toujours l'approuver plus tard."- },- "invite_sheet": {- "title": "Inviter un vendeur",- "description": "La personne rejoint l'équipe du vendeur en acceptant et peut alors se connecter à son propre espace.",- "email_help": "L'invitation part à cette adresse."- },- "actions": {- "invite": "Inviter",- "reinvite": "Renvoyer",- "send_invitation": "Envoyer l'invitation",- "approve": "Approuver",- "reinstate": "Réactiver",- "suspend": "Suspendre",- "reject": "Refuser"- },- "detail": {- "load_error": "Impossible de charger ce vendeur",- "delete_label": "Supprimer le vendeur",- "status": "Statut",- "settlement": "Versements et taxes",- "at_a_glance": "En un coup d'œil",- "contact": "Contact",- "edit_profile": "Modifier le profil",- "edit_profile_description": "Le vendeur gère ces informations depuis son propre espace. Les modifications faites ici le sont en son nom.",- "edit_settlement": "Modifier les versements et les taxes",- "edit_settlement_description": "Vous seul pouvez voir et modifier ces réglages. Le vendeur ne les modifie jamais.",- "no_about": "Ce vendeur n'a pas encore rédigé de description."- },- "status": {- "pending": "En attente",- "invited": "Invité",- "onboarding": "Configuration",- "ready_for_review": "À examiner",- "approved": "Approuvé",- "suspended": "Suspendu",- "rejected": "Refusé",- "canceled": "Annulé"- },- "status_help": {- "pending": "Créé, mais personne n'a encore été invité.",- "invited": "En attente de l'acceptation de l'invitation.",- "onboarding": "Renseigne ses informations.",- "ready_for_review": "Attend votre approbation.",- "approved": "Vend sur la place de marché.",- "suspended": "Ne peut plus vendre. Réactivez-le pour reprendre.",- "rejected": "Non admis sur la place de marché.",- "canceled": "S'est retiré avant de rejoindre."- },- "tax_remittance": {- "seller": "Le vendeur reverse",- "platform": "La place de marché reverse"- },- "payout_interval": {- "inherit": "Valeur par défaut de la boutique",- "daily": "Chaque jour",- "weekly": "Chaque semaine",- "biweekly": "Toutes les deux semaines",- "monthly": "Chaque mois",- "manual": "Manuel"- },- "messages": {- "created": "Vendeur créé",- "create_failed": "Impossible de créer le vendeur",- "updated": "Vendeur mis à jour",- "update_failed": "Impossible de mettre à jour le vendeur",- "deleted": "Vendeur supprimé",- "delete_failed": "Impossible de supprimer le vendeur",- "invited": "Invitation envoyée",- "invite_failed": "Impossible d'envoyer l'invitation",- "approved": "Vendeur approuvé",- "approve_failed": "Impossible d'approuver le vendeur",- "suspended": "Vendeur suspendu",- "suspend_failed": "Impossible de suspendre le vendeur",- "rejected": "Vendeur refusé",- "reject_failed": "Impossible de refuser le vendeur"- },- "not_provided": "Non renseigné",- "images": {- "logo_label": "Logo",- "logo_help": "Un format carré convient le mieux. Affiché à côté du vendeur partout où il apparaît.",- "square_logo_label": "Logo carré",- "square_logo_help": "Pour les emplacements qui exigent un carré strict, comme un avatar.",- "cover_photo_label": "Photo de couverture",- "cover_photo_help": "Une bannière large en haut du profil du vendeur."- },- "autocomplete": {- "placeholder": "Rechercher des vendeurs",- "empty": "Aucun vendeur trouvé"- }- },- "commission_rates": {- "add_cta": "Ajouter un taux de commission",- "applies_to_everything": "Toutes les ventes",- "create_description": "Définissez ce que la place de marché facture aux vendeurs, et les ventes concernées.",- "create_label": "Créer le taux de commission",- "delete_confirm": {- "message": "{{name}} sera supprimé. Les commissions déjà facturées ne changent pas.",- "title": "Supprimer le taux de commission ?"- },- "edit_description": "Modifiez les frais, leurs limites et les ventes concernées.",- "empty": "Aucun taux de commission",- "messages": {- "created": "Taux de commission créé",- "deleted": "Taux de commission supprimé",- "updated": "Taux de commission mis à jour"+ "translations": {+ "coverage_summary": "{{translated}} sur {{total}} langues traduites",+ "dirty_summary": "{{count}} modification(s) non enregistrée(s)",+ "discard_confirm": {+ "message": "Vous avez {{count}} modification(s) de traduction non enregistrée(s). Les annuler ?",+ "title": "Annuler les modifications ?"},- "search_placeholder": "Rechercher par nom…",- "order_hint": "Les nouveaux taux se placent en haut de la liste, et le premier qui correspond l'emporte — glissez pour réordonner.",- "conditions": {- "add": "Ajouter une condition",- "title": "Conditions"- }+ "field": "Champ",+ "load_error": "Impossible de charger les traductions",+ "locale": "Langue",+ "manage": "Gérer les traductions",+ "no_locales": "Ajoutez d autres langues à votre boutique pour traduire ce produit.",+ "original": "Original",+ "save": "Enregistrer les traductions",+ "save_error": "Impossible d enregistrer les traductions",+ "saved": "Traductions enregistrées",+ "source": "Source",+ "title": "Traductions"}}}diff --git a/packages/dashboard/src/locales/pl.json b/packages/dashboard/src/locales/pl.jsonindex d836fd911e..d0db24f9d0 100644--- a/packages/dashboard/src/locales/pl.json+++ b/packages/dashboard/src/locales/pl.json@@ -295,6 +295,95 @@},"title": "Kolekcje"},+ "commission_rates": {+ "add_cta": "Dodaj stawkę prowizji",+ "applies_to_everything": "Każda sprzedaż",+ "create_description": "Określ, ile marketplace pobiera od sprzedawców i których sprzedaży to dotyczy.",+ "create_label": "Utwórz stawkę prowizji",+ "delete_confirm": {+ "message": "{{name}} zostanie usunięta. Naliczone już prowizje pozostaną bez zmian.",+ "title": "Usunąć stawkę prowizji?"+ },+ "edit_description": "Zaktualizuj opłatę, jej limity i objęte nią sprzedaże.",+ "empty": "Brak stawek prowizji",+ "messages": {+ "created": "Utworzono stawkę prowizji",+ "deleted": "Usunięto stawkę prowizji",+ "updated": "Zaktualizowano stawkę prowizji"+ },+ "search_placeholder": "Szukaj po nazwie…",+ "order_hint": "Nowe stawki trafiają na górę listy, a wygrywa pierwsza pasująca — przeciągnij, aby zmienić kolejność.",+ "conditions": {+ "add": "Dodaj warunek",+ "title": "Warunki"+ }+ },+ "companies": {+ "add_cta": "Dodaj firmę",+ "add_sheet_title": "Nowa firma",+ "create_description": "Klienci biznesowi kupują przez oddziały. Oddziały, numer podatkowy i certyfikaty zwolnienia dodasz po utworzeniu firmy.",+ "create_label": "Utwórz firmę",+ "delete_confirm": {+ "message": "Spowoduje to usunięcie {{name}} wraz z oddziałami, kupującymi i certyfikatami. Tej operacji nie można cofnąć.",+ "title": "Usunąć firmę?"+ },+ "detail": {+ "delete_label": "Usuń firmę",+ "load_error": "Nie udało się wczytać tej firmy",+ "profile": "Firma"+ },+ "empty": "Nie ma jeszcze żadnych firm",+ "locations_column": "Oddziały",+ "messages": {+ "created": "Firma utworzona",+ "deleted": "Firma usunięta",+ "updated": "Firma zaktualizowana"+ },+ "search_placeholder": "Szukaj firm"+ },+ "company_contacts": {+ "add_cta": "Dodaj kupującego",+ "add_title": "Uprawnij kupującego",+ "dialog_description": "Klient, który kupuje dla tego oddziału. Jeśli kupuje tylko dla jednego oddziału, jego zamówienia trafiają do niego automatycznie.",+ "empty": "Nie uprawniono jeszcze żadnych kupujących",+ "messages": {+ "created": "Kupujący dodany",+ "deleted": "Kupujący usunięty"+ },+ "remove_action": "Usuń kupującego",+ "remove_confirm": {+ "message": "{{email}} nie będzie już kupować dla tego oddziału. Konto klienta pozostaje bez zmian.",+ "title": "Usunąć tego kupującego?"+ },+ "roles_enterprise_help": "Dodani tutaj kupujący mogą składać zamówienia dla tego oddziału. Role, procesy akceptacji i limity wydatków są częścią Spree Enterprise.",+ "roles_enterprise_title": "Role i akceptacje to funkcja Enterprise",+ "title": "Kupujący"+ },+ "company_locations": {+ "add_cta": "Dodaj oddział",+ "add_title": "Nowy oddział",+ "addresses": "Adresy",+ "billing_address": "Adres rozliczeniowy",+ "contacts_count_few": "{{count}} kupujących",+ "contacts_count_many": "{{count}} kupujących",+ "contacts_count_one": "{{count}} kupujący",+ "contacts_count_other": "{{count}} kupujących",+ "detail": {+ "delete_label": "Usuń oddział",+ "load_error": "Nie udało się wczytać tego oddziału"+ },+ "dialog_description": "Oddział to miejsce, na które wystawiana jest faktura i pod które trafia dostawa. Adresy są opcjonalne, ale wypełniony adres wymaga imienia, nazwiska i kraju.",+ "edit_title": "Edytuj oddział",+ "empty": "Nie ma jeszcze żadnych oddziałów",+ "messages": {+ "created": "Oddział utworzony",+ "deleted": "Oddział usunięty",+ "updated": "Oddział zaktualizowany"+ },+ "shipping_address": "Adres dostawy",+ "shipping_same_as_billing": "Adres dostawy taki sam jak rozliczeniowy",+ "title": "Oddziały"+ },"components": {"adjustment_action_editor": {"calculator_label": "Kalkulator",@@ -555,6 +644,67 @@"split_description": "Wysyłaj te same produkty z drugiego magazynu z własnymi strefami i stawkami.","split_title": "Podziel miejsca wysyłki"},+ "delivery_profiles": {+ "add_cta": "Dodaj profil",+ "add_dialog_title": "Nowy profil dostawy",+ "all_locations": "Wszystkie lokalizacje",+ "capabilities": {+ "digital": "Cyfrowa",+ "pickup": "Odbiór",+ "ships": "Wysyłka"+ },+ "create_description": "Zgrupuj produkty wysyłane w ten sam sposób, z własnymi lokalizacjami, strefami i metodami dostawy.",+ "create_label": "Utwórz profil",+ "default_badge": "Domyślny",+ "default_confirm": {+ "message": "Produkty bez własnego profilu będą wysyłane według profilu „{{name}}”.",+ "title": "Ustaw jako profil domyślny"+ },+ "delete_confirm": {+ "message": "Usunąć „{{name}}”? Jego strefy i metody dostawy zostaną usunięte razem z nim.",+ "title": "Usuń profil wysyłki"+ },+ "detail": {+ "add_digital_method": "Dodaj metodę cyfrową",+ "add_method": "Dodaj metodę",+ "collect_from": "Odbiór z",+ "collect_from_hint": "Lokalizacje, z których klienci mogą odbierać zamówienia. Zmiany działają natychmiast.",+ "delete_label": "Usuń profil",+ "digital_empty": "Brak metody dostawy cyfrowej.",+ "digital_hint": "Dostarczane bez wysyłki i odbioru.",+ "digital_title": "Dostawa cyfrowa",+ "general_title": "Ogólne",+ "hidden_badge": "Ukryta",+ "load_failed_title": "Nie udało się wczytać tego profilu wysyłki",+ "no_methods": "Brak metod dostawy w tym miejscu.",+ "no_stock_locations": "Brak lokalizacji — dodaj jedną w Ustawienia → Lokalizacje.",+ "no_zone_hint": "Te metody są oferowane wszędzie, gdzie sięga ten profil.",+ "no_zone_title": "Bez ograniczenia strefy",+ "no_zones": "Brak stref — dodaj jedną, aby oferować metody dostawy.",+ "offer_pickup": "Zaoferuj odbiór",+ "origins_title": "Wysyłka z",+ "pickup_empty": "Brak metody odbioru — klienci nie mogą odbierać zamówień w tym profilu.",+ "pickup_hint": "Klienci odbierają te zamówienia osobiście. Odbiór nie ma miejsca docelowego, więc strefy nie mają zastosowania.",+ "pickup_title": "Odbiór osobisty",+ "zones_title": "Strefy i metody dostawy"+ },+ "empty": "Brak profili dostawy.",+ "is_default_hint": "Produkty bez własnego profilu są wysyłane według tego profilu.",+ "kind_immutable_hint": "Rodzaj jest ustalany przy tworzeniu profilu.",+ "kinds": {+ "digital": "Cyfrowa",+ "shipping": "Wysyłka"+ },+ "locations_count": "Lokalizacje: {{count}}",+ "make_default": "Ustaw jako domyślny",+ "messages": {+ "created": "Utworzono profil wysyłki",+ "deleted": "Usunięto profil wysyłki",+ "updated": "Zaktualizowano profil wysyłki"+ },+ "search_placeholder": "Szukaj profili dostawy…",+ "selected_locations": "Wybrane lokalizacje"+ },"delivery_zones": {"add_countries_in_markets": "Dodaj więcej krajów w sekcji Rynki","add_cta": "Dodaj strefę dostawy",@@ -604,6 +754,9 @@"to_placeholder": "Do","toggle_states": "Pokaż regiony kraju {{country}}"},+ "enterprise": {+ "learn_more": "Dowiedz się więcej o Spree Enterprise"+ },"errors": {"forbidden_description": "Nie masz uprawnień do wyświetlenia tej strony.","forbidden_title": "Brak uprawnień",@@ -1732,67 +1885,6 @@}}},- "delivery_profiles": {- "add_cta": "Dodaj profil",- "add_dialog_title": "Nowy profil dostawy",- "all_locations": "Wszystkie lokalizacje",- "capabilities": {- "digital": "Cyfrowa",- "pickup": "Odbiór",- "ships": "Wysyłka"- },- "create_description": "Zgrupuj produkty wysyłane w ten sam sposób, z własnymi lokalizacjami, strefami i metodami dostawy.",- "create_label": "Utwórz profil",- "default_badge": "Domyślny",- "default_confirm": {- "message": "Produkty bez własnego profilu będą wysyłane według profilu „{{name}}”.",- "title": "Ustaw jako profil domyślny"- },- "delete_confirm": {- "message": "Usunąć „{{name}}”? Jego strefy i metody dostawy zostaną usunięte razem z nim.",- "title": "Usuń profil wysyłki"- },- "detail": {- "add_digital_method": "Dodaj metodę cyfrową",- "add_method": "Dodaj metodę",- "collect_from": "Odbiór z",- "collect_from_hint": "Lokalizacje, z których klienci mogą odbierać zamówienia. Zmiany działają natychmiast.",- "delete_label": "Usuń profil",- "digital_empty": "Brak metody dostawy cyfrowej.",- "digital_hint": "Dostarczane bez wysyłki i odbioru.",- "digital_title": "Dostawa cyfrowa",- "general_title": "Ogólne",- "hidden_badge": "Ukryta",- "load_failed_title": "Nie udało się wczytać tego profilu wysyłki",- "no_methods": "Brak metod dostawy w tym miejscu.",- "no_stock_locations": "Brak lokalizacji — dodaj jedną w Ustawienia → Lokalizacje.",- "no_zone_hint": "Te metody są oferowane wszędzie, gdzie sięga ten profil.",- "no_zone_title": "Bez ograniczenia strefy",- "no_zones": "Brak stref — dodaj jedną, aby oferować metody dostawy.",- "offer_pickup": "Zaoferuj odbiór",- "origins_title": "Wysyłka z",- "pickup_empty": "Brak metody odbioru — klienci nie mogą odbierać zamówień w tym profilu.",- "pickup_hint": "Klienci odbierają te zamówienia osobiście. Odbiór nie ma miejsca docelowego, więc strefy nie mają zastosowania.",- "pickup_title": "Odbiór osobisty",- "zones_title": "Strefy i metody dostawy"- },- "empty": "Brak profili dostawy.",- "is_default_hint": "Produkty bez własnego profilu są wysyłane według tego profilu.",- "kind_immutable_hint": "Rodzaj jest ustalany przy tworzeniu profilu.",- "kinds": {- "digital": "Cyfrowa",- "shipping": "Wysyłka"- },- "locations_count": "Lokalizacje: {{count}}",- "make_default": "Ustaw jako domyślny",- "messages": {- "created": "Utworzono profil wysyłki",- "deleted": "Usunięto profil wysyłki",- "updated": "Zaktualizowano profil wysyłki"- },- "search_placeholder": "Szukaj profili dostawy…",- "selected_locations": "Wybrane lokalizacje"- },"gift_cards": {"batch_autocomplete": {"empty": "Brak pasujących partii",@@ -1953,6 +2045,9 @@"sign_in_and_accept": "Zaloguj się i zaakceptuj","sign_in_to_accept": ". Zaloguj się, aby zaakceptować."},+ "jurisdiction": {+ "everywhere": "Wszędzie"+ },"markets": {"add_cta": "Dodaj rynek","columns": {@@ -3829,30 +3924,265 @@"name_required": "Nazwa jest wymagana"}},- "settings": {- "webhooks": {- "errors": {- "redeliver_failed": "Ponowne dostarczenie nie powiodło się",- "send_test_failed": "Nie udało się wysłać testowego webhooka"+ "seller_requirements": {+ "title": "Wymagania dla sprzedawców",+ "search_placeholder": "Szukaj wymagań",+ "empty": "Brak wymagań. Sprzedawcy mogą od razu poprosić o weryfikację.",+ "add_cta": "Dodaj wymaganie",+ "add_title": "Dodaj wymaganie",+ "edit_title": "Edytuj wymaganie",+ "columns": {+ "kind": "Typ",+ "required": "Wymagane"+ },+ "required": {+ "yes": "Wymagane",+ "no": "Zalecane"+ },+ "status": {+ "disabled": "Wyłączone"+ },+ "fields": {+ "accepted_files": {+ "label": "Dozwolone pliki",+ "help": "Sprzedawcy mogą przesłać: {{types}}"},- "messages": {- "removed": "Usunięto punkt końcowy webhooka",- "updated": "Zaktualizowano punkt końcowy webhooka"+ "active": {+ "label": "Aktywne",+ "help": "Wyłącz, aby przestać tego wymagać, bez usuwania."+ },+ "custom_fields": {+ "label": "Pola niestandardowe",+ "help": "Sprzedawca musi wypełnić każde wybrane pole.",+ "placeholder": "Szukaj pól",+ "empty": "Brak pól sprzedawcy. Utwórz je w Ustawienia → Pola niestandardowe."+ },+ "description": {+ "label": "Instrukcje",+ "placeholder": "Wyjaśnij sprzedawcy, czego potrzebujesz i dlaczego"+ },+ "kind": {+ "label": "Typ",+ "placeholder": "Wybierz, czego wymagasz"+ },+ "name": {+ "label": "Nazwa",+ "label_required": "Nazwa (wymagana)",+ "help": "To, co sprzedawca widzi na swojej liście."+ },+ "required": {+ "label": "Wymagane",+ "help": "Wymagane pozycje trzeba wykonać przed zatwierdzeniem. Pozostałe są zalecane."}+ },+ "delete_confirm": {+ "title": "Usunąć wymaganie?",+ "message": "Sprzedawcy nie będą już proszeni o „{{name}}\". To, co już przesłali, także zostanie usunięte."+ },+ "messages": {+ "created": "Dodano wymaganie",+ "updated": "Zapisano wymaganie",+ "deleted": "Usunięto wymaganie",+ "submission_accepted": "Zaakceptowano",+ "submission_rejected": "Odesłano do sprzedawcy",+ "waived": "Odstąpiono od wymagania dla tego sprzedawcy"+ },+ "kinds": {+ "accept_terms": "Akceptacja regulaminu",+ "complete_profile": "Uzupełnienie profilu",+ "billing_address": "Adres rozliczeniowy",+ "returns_address": "Adres zwrotów",+ "minimum_products": "Minimalna liczba produktów",+ "required_custom_fields": "Wymagane pola niestandardowe",+ "attestation": "Potwierdzenie sprzedawcy",+ "operator_review": "Weryfikacja ręczna",+ "document": "Dokument"}},- "settings_nav": {- "groups": {- "audit": "Audyt",- "fulfillment": "Realizacja zamówień",- "payments": "Płatności i podatki",- "store": "Sklep",- "team": "Zespół i dostęp"+ "sellers": {+ "actions": {+ "invite": "Zaproś",+ "reinvite": "Wyślij ponownie",+ "send_invitation": "Wyślij zaproszenie",+ "approve": "Zaakceptuj",+ "reinstate": "Przywróć",+ "suspend": "Zawieś",+ "reject": "Odrzuć",+ "reopen_onboarding": "Odeślij do uzupełnienia"+ },+ "add_cta": "Dodaj sprzedawcę",+ "add_sheet_title": "Nowy sprzedawca",+ "address": {+ "filled": "Uzupełniony",+ "not_filled": "Nieuzupełniony",+ "not_provided_by_seller": "Sprzedawca jeszcze go nie podał",+ "not_located_yet": "Mapa pojawi się, gdy adres zostanie zlokalizowany."+ },+ "approve_override_confirm": {+ "title": "Zatwierdzić mimo to?",+ "message": "Ten sprzedawca nie ukończył: {{names}}. Zatwierdzenie teraz i tak pozwoli mu sprzedawać, a decyzja zostanie odnotowana.",+ "action": "Zatwierdź mimo to"+ },+ "autocomplete": {+ "placeholder": "Szukaj sprzedawców",+ "empty": "Nie znaleziono sprzedawców"+ },+ "create_description": "Najpierw utwórz sprzedawcę. Zaproszenie, akceptację i wypłaty ustawisz na jego stronie.",+ "create_label": "Utwórz sprzedawcę",+ "delete_confirm": {+ "title": "Usunąć sprzedawcę?",+ "message": "To usunie {{name}} z marketplace. Jego produkty zostaną w katalogu bez sprzedawcy. Tej operacji nie można cofnąć."+ },+ "detail": {+ "load_error": "Nie udało się wczytać tego sprzedawcy",+ "delete_label": "Usuń sprzedawcę",+ "status": "Status",+ "settlement": "Wypłaty i podatki",+ "at_a_glance": "W skrócie",+ "contact": "Kontakt",+ "edit_profile": "Edytuj profil",+ "edit_profile_description": "Sprzedawca prowadzi to w swoim panelu. Zmiany tutaj wprowadzasz w jego imieniu.",+ "edit_settlement": "Edytuj wypłaty i podatki",+ "edit_settlement_description": "Tylko Ty widzisz i zmieniasz te ustawienia. Sprzedawca ich nie edytuje.",+ "no_about": "Ten sprzedawca nie napisał jeszcze opisu.",+ "billing_address": "Adres rozliczeniowy",+ "returns_address": "Adres zwrotów"+ },+ "empty": "Nie ma jeszcze sprzedawców",+ "images": {+ "logo_label": "Logo",+ "logo_help": "Najlepiej sprawdza się kwadrat. Widoczne przy sprzedawcy wszędzie tam, gdzie się pojawia.",+ "square_logo_label": "Logo kwadratowe",+ "square_logo_help": "Do miejsc wymagających ścisłego kwadratu, na przykład awatara.",+ "cover_photo_label": "Zdjęcie w tle",+ "cover_photo_help": "Szeroki baner u góry profilu sprzedawcy."+ },+ "invite_sheet": {+ "title": "Zaproś sprzedawcę",+ "description": "Po przyjęciu zaproszenia osoba dołącza do zespołu sprzedawcy i może zalogować się do własnego panelu.",+ "email_help": "Zaproszenie trafi na ten adres."+ },+ "messages": {+ "created": "Sprzedawca utworzony",+ "create_failed": "Nie udało się utworzyć sprzedawcy",+ "updated": "Sprzedawca zaktualizowany",+ "update_failed": "Nie udało się zaktualizować sprzedawcy",+ "deleted": "Sprzedawca usunięty",+ "delete_failed": "Nie udało się usunąć sprzedawcy",+ "invited": "Zaproszenie wysłane",+ "invite_failed": "Nie udało się wysłać zaproszenia",+ "approved": "Sprzedawca zaakceptowany",+ "approve_failed": "Nie udało się zaakceptować sprzedawcy",+ "suspended": "Sprzedawca zawieszony",+ "suspend_failed": "Nie udało się zawiesić sprzedawcy",+ "rejected": "Sprzedawca odrzucony",+ "reject_failed": "Nie udało się odrzucić sprzedawcy",+ "onboarding_reopened": "Odesłano do uzupełnienia"+ },+ "not_provided": "Nie podano",+ "on_holiday_notice": "Ten sprzedawca jest nieobecny. Jego katalog pozostaje widoczny, ale nic nie da się kupić.",+ "onboarding": {+ "title": "Wdrożenie",+ "progress": "Ukończono {{done}} z {{total}}",+ "waived": "Odstąpiono",+ "download": "Pobierz plik",+ "seller_note": "Sprzedawca: {{note}}",+ "review_note": "Twoja notatka: {{note}}",+ "actions": {+ "accept": "Akceptuj",+ "reject": "Odeślij",+ "waive": "Odstąp dla tego sprzedawcy"+ },+ "reject_confirm": {+ "title": "Odesłać?",+ "message": "Sprzedawca zostanie ponownie poproszony o „{{name}}\"."+ },+ "waive_confirm": {+ "title": "Odstąpić od wymagania?",+ "message": "„{{name}}\" będzie uznane za spełnione tylko dla tego sprzedawcy."+ },+ "all_done": "Wszystko gotowe 🎉",+ "status": {+ "complete": "Gotowe",+ "pending": "W weryfikacji",+ "rejected": "Odesłane",+ "incomplete": "Oczekuje"+ }+ },+ "onboarding_column": "Wdrożenie",+ "payout_interval": {+ "inherit": "Domyślne ustawienie sklepu",+ "daily": "Codziennie",+ "weekly": "Co tydzień",+ "biweekly": "Co dwa tygodnie",+ "monthly": "Co miesiąc",+ "manual": "Ręcznie"+ },+ "products_column": "Produkty",+ "reject_confirm": {+ "title": "Odrzucić sprzedawcę?",+ "message": "{{name}} nie zostanie przyjęty do marketplace. Nadal możesz go później zaakceptować."+ },+ "reopen_onboarding_confirm": {+ "title": "Odesłać do uzupełnienia?",+ "message": "{{name}} będzie mógł zmienić dane i ponownie poprosić o weryfikację."+ },+ "search_placeholder": "Szukaj sprzedawców",+ "status": {+ "pending": "Oczekuje",+ "invited": "Zaproszony",+ "onboarding": "Konfiguracja",+ "ready_for_review": "Do sprawdzenia",+ "approved": "Zaakceptowany",+ "suspended": "Zawieszony",+ "rejected": "Odrzucony",+ "canceled": "Anulowany"+ },+ "status_help": {+ "pending": "Utworzony, ale nikt nie został jeszcze zaproszony.",+ "invited": "Czeka na przyjęcie zaproszenia.",+ "onboarding": "Uzupełnia swoje dane.",+ "ready_for_review": "Czeka na Twoją akceptację.",+ "approved": "Sprzedaje w marketplace.",+ "suspended": "Nie może sprzedawać. Przywróć, aby wrócił do handlu.",+ "rejected": "Nieprzyjęty do marketplace.",+ "canceled": "Wycofał się przed dołączeniem."+ },+ "suspend_confirm": {+ "title": "Zawiesić sprzedawcę?",+ "message": "{{name}} natychmiast przestanie sprzedawać. Katalog i historia zostaną zachowane, a zawieszenie możesz później cofnąć."+ },+ "tax_remittance": {+ "seller": "Rozlicza sprzedawca",+ "platform": "Rozlicza marketplace"+ },+ "team_column": "Zespół"+ },+ "settings": {+ "webhooks": {+ "errors": {+ "redeliver_failed": "Ponowne dostarczenie nie powiodło się",+ "send_test_failed": "Nie udało się wysłać testowego webhooka"+ },+ "messages": {+ "removed": "Usunięto punkt końcowy webhooka",+ "updated": "Zaktualizowano punkt końcowy webhooka"+ }+ }+ },+ "settings_nav": {+ "groups": {+ "audit": "Audyt",+ "fulfillment": "Realizacja zamówień",+ "payments": "Płatności i podatki",+ "store": "Sklep",+ "team": "Zespół i dostęp"},"items": {"allowed_origins": "Dozwolone źródła","api_keys": "Klucze API","channels": "Kanały sprzedaży",+ "commission_rates": "Stawki prowizji","custom_field_definitions": "Pola niestandardowe","delivery_profiles": "Profile dostawy","emails": "Wiadomości e-mail",@@ -3864,13 +4194,13 @@"profile": "Profil","reasons": "Zwroty i powody","roles": "Role",+ "seller_requirements": "Wymagania dla sprzedawców","staff": "Zespół","stock_locations": "Lokalizacje magazynowe","store": "Sklep","tax_categories": "Kategorie podatkowe","tax_rates": "Stawki podatku",- "webhooks": "Webhooki",- "commission_rates": "Stawki prowizji"+ "webhooks": "Webhooki"}},"setup": {@@ -4035,93 +4365,50 @@},"search_placeholder": "Szukaj według nazwy…"},- "translations": {- "coverage_summary": "Przetłumaczono {{translated}} z {{total}} języków",- "dirty_summary": "{{count}} niezapisanych zmian",- "discard_confirm": {- "message": "Masz {{count}} niezapisanych zmian tłumaczeń. Odrzucić je?",- "title": "Odrzucić zmiany?"- },- "field": "Pole",- "load_error": "Nie można załadować tłumaczeń",- "locale": "Język",- "manage": "Zarządzaj tłumaczeniami",- "no_locales": "Dodaj więcej języków do swojego sklepu, aby przetłumaczyć ten produkt.",- "original": "Oryginał",- "save": "Zapisz tłumaczenia",- "save_error": "Nie można zapisać tłumaczeń",- "saved": "Tłumaczenia zapisane",- "source": "Źródło",- "title": "Tłumaczenia"- },- "jurisdiction": {- "everywhere": "Wszędzie"- },- "companies": {- "add_cta": "Dodaj firmę",- "add_sheet_title": "Nowa firma",- "create_description": "Klienci biznesowi kupują przez oddziały. Oddziały, numer podatkowy i certyfikaty zwolnienia dodasz po utworzeniu firmy.",- "create_label": "Utwórz firmę",+ "tax_exemption_certificates": {+ "add_cta": "Dodaj certyfikat",+ "add_title": "Dodaj certyfikat zwolnienia","delete_confirm": {- "message": "Spowoduje to usunięcie {{name}} wraz z oddziałami, kupującymi i certyfikatami. Tej operacji nie można cofnąć.",- "title": "Usunąć firmę?"- },- "detail": {- "delete_label": "Usuń firmę",- "load_error": "Nie udało się wczytać tej firmy",- "profile": "Firma"+ "message": "Certyfikat {{number}} zostanie usunięty. Tej operacji nie można cofnąć.",+ "title": "Usunąć ten certyfikat?"},- "empty": "Nie ma jeszcze żadnych firm",- "locations_column": "Oddziały",+ "dialog_description": "Dowód, że zakupy tej firmy nie są opodatkowane. Nowy certyfikat zaczyna obowiązywać dopiero po zaakceptowaniu.",+ "download_action": "Pobierz dokument",+ "empty": "Brak zapisanych certyfikatów",+ "expires_prefix": "Wygasa",+ "lapsed": "Nieważny","messages": {- "created": "Firma utworzona",- "deleted": "Firma usunięta",- "updated": "Firma zaktualizowana"- },- "search_placeholder": "Szukaj firm"- },- "company_locations": {- "add_cta": "Dodaj oddział",- "add_title": "Nowy oddział",- "addresses": "Adresy",- "billing_address": "Adres rozliczeniowy",- "contacts_count_few": "{{count}} kupujących",- "contacts_count_many": "{{count}} kupujących",- "contacts_count_one": "{{count}} kupujący",- "contacts_count_other": "{{count}} kupujących",- "detail": {- "delete_label": "Usuń oddział",- "load_error": "Nie udało się wczytać tego oddziału"+ "created": "Certyfikat dodany",+ "deleted": "Certyfikat usunięty",+ "revoked": "Certyfikat unieważniony",+ "updated": "Certyfikat zaktualizowany",+ "verified": "Certyfikat zaakceptowany"},- "dialog_description": "Oddział to miejsce, na które wystawiana jest faktura i pod które trafia dostawa. Adresy są opcjonalne, ale wypełniony adres wymaga imienia, nazwiska i kraju.",- "edit_title": "Edytuj oddział",- "empty": "Nie ma jeszcze żadnych oddziałów",- "messages": {- "created": "Oddział utworzony",- "deleted": "Oddział usunięty",- "updated": "Oddział zaktualizowany"+ "never_expires": "Bez daty wygaśnięcia",+ "no_document": "Brak załączonego dokumentu",+ "reason_codes": {+ "agricultural": "Rolnictwo",+ "charitable": "Organizacja charytatywna",+ "educational": "Edukacja",+ "government": "Instytucja publiczna",+ "manufacturing": "Produkcja",+ "resale": "Odsprzedaż"},- "shipping_address": "Adres dostawy",- "shipping_same_as_billing": "Adres dostawy taki sam jak rozliczeniowy",- "title": "Oddziały"- },- "company_contacts": {- "add_cta": "Dodaj kupującego",- "add_title": "Uprawnij kupującego",- "dialog_description": "Klient, który kupuje dla tego oddziału. Jeśli kupuje tylko dla jednego oddziału, jego zamówienia trafiają do niego automatycznie.",- "empty": "Nie uprawniono jeszcze żadnych kupujących",- "messages": {- "created": "Kupujący dodany",- "deleted": "Kupujący usunięty"+ "revoke_action": "Unieważnij",+ "revoke_confirm": {+ "message": "Certyfikat {{number}} przestanie obowiązywać dla nowych zamówień. Pozostanie zapisany jako dokumentacja.",+ "title": "Unieważnić ten certyfikat?"},- "remove_action": "Usuń kupującego",- "remove_confirm": {- "message": "{{email}} nie będzie już kupować dla tego oddziału. Konto klienta pozostaje bez zmian.",- "title": "Usunąć tego kupującego?"+ "select_reason": "Wybierz powód",+ "status": {+ "expired": "Wygasł",+ "pending": "Oczekuje na weryfikację",+ "revoked": "Unieważniony",+ "verified": "Zaakceptowany"},- "roles_enterprise_help": "Dodani tutaj kupujący mogą składać zamówienia dla tego oddziału. Role, procesy akceptacji i limity wydatków są częścią Spree Enterprise.",- "roles_enterprise_title": "Role i akceptacje to funkcja Enterprise",- "title": "Kupujący"+ "title": "Certyfikaty zwolnienia",+ "verified_at": "Zaakceptowano",+ "verify_action": "Zaakceptuj"},"tax_identifiers": {"add_cta": "Dodaj numer",@@ -4161,50 +4448,11 @@"verified": "Potwierdzony"}},- "tax_exemption_certificates": {- "add_cta": "Dodaj certyfikat",- "add_title": "Dodaj certyfikat zwolnienia",- "delete_confirm": {- "message": "Certyfikat {{number}} zostanie usunięty. Tej operacji nie można cofnąć.",- "title": "Usunąć ten certyfikat?"- },- "dialog_description": "Dowód, że zakupy tej firmy nie są opodatkowane. Nowy certyfikat zaczyna obowiązywać dopiero po zaakceptowaniu.",- "download_action": "Pobierz dokument",- "empty": "Brak zapisanych certyfikatów",- "expires_prefix": "Wygasa",- "lapsed": "Nieważny",- "messages": {- "created": "Certyfikat dodany",- "deleted": "Certyfikat usunięty",- "revoked": "Certyfikat unieważniony",- "updated": "Certyfikat zaktualizowany",- "verified": "Certyfikat zaakceptowany"- },- "never_expires": "Bez daty wygaśnięcia",- "no_document": "Brak załączonego dokumentu",- "reason_codes": {- "agricultural": "Rolnictwo",- "charitable": "Organizacja charytatywna",- "educational": "Edukacja",- "government": "Instytucja publiczna",- "manufacturing": "Produkcja",- "resale": "Odsprzedaż"- },- "revoke_action": "Unieważnij",- "revoke_confirm": {- "message": "Certyfikat {{number}} przestanie obowiązywać dla nowych zamówień. Pozostanie zapisany jako dokumentacja.",- "title": "Unieważnić ten certyfikat?"- },- "select_reason": "Wybierz powód",- "status": {- "expired": "Wygasł",- "pending": "Oczekuje na weryfikację",- "revoked": "Unieważniony",- "verified": "Zaakceptowany"- },- "title": "Certyfikaty zwolnienia",- "verified_at": "Zaakceptowano",- "verify_action": "Zaakceptuj"+ "tax_providers": {+ "limitations_title": "{{name}} nie obsługuje",+ "unavailable_option": "{{name}} (nieskonfigurowany)",+ "use_default": "Użyj domyślnego mechanizmu",+ "use_default_named": "Domyślny ({{name}})"},"tax_rates": {"add_cta": "Dodaj stawkę",@@ -4227,148 +4475,24 @@"search_placeholder": "Szukaj stawek","select_category": "Wybierz kategorię"},- "tax_providers": {- "limitations_title": "{{name}} nie obsługuje",- "unavailable_option": "{{name}} (nieskonfigurowany)",- "use_default": "Użyj domyślnego mechanizmu",- "use_default_named": "Domyślny ({{name}})"- },- "enterprise": {- "learn_more": "Dowiedz się więcej o Spree Enterprise"- },- "sellers": {- "add_cta": "Dodaj sprzedawcę",- "add_sheet_title": "Nowy sprzedawca",- "create_description": "Najpierw utwórz sprzedawcę. Zaproszenie, akceptację i wypłaty ustawisz na jego stronie.",- "create_label": "Utwórz sprzedawcę",- "search_placeholder": "Szukaj sprzedawców",- "empty": "Nie ma jeszcze sprzedawców",- "products_column": "Produkty",- "team_column": "Zespół",- "on_holiday_notice": "Ten sprzedawca jest nieobecny. Jego katalog pozostaje widoczny, ale nic nie da się kupić.",- "delete_confirm": {- "title": "Usunąć sprzedawcę?",- "message": "To usunie {{name}} z marketplace. Jego produkty zostaną w katalogu bez sprzedawcy. Tej operacji nie można cofnąć."- },- "suspend_confirm": {- "title": "Zawiesić sprzedawcę?",- "message": "{{name}} natychmiast przestanie sprzedawać. Katalog i historia zostaną zachowane, a zawieszenie możesz później cofnąć."- },- "reject_confirm": {- "title": "Odrzucić sprzedawcę?",- "message": "{{name}} nie zostanie przyjęty do marketplace. Nadal możesz go później zaakceptować."- },- "invite_sheet": {- "title": "Zaproś sprzedawcę",- "description": "Po przyjęciu zaproszenia osoba dołącza do zespołu sprzedawcy i może zalogować się do własnego panelu.",- "email_help": "Zaproszenie trafi na ten adres."- },- "actions": {- "invite": "Zaproś",- "reinvite": "Wyślij ponownie",- "send_invitation": "Wyślij zaproszenie",- "approve": "Zaakceptuj",- "reinstate": "Przywróć",- "suspend": "Zawieś",- "reject": "Odrzuć"- },- "detail": {- "load_error": "Nie udało się wczytać tego sprzedawcy",- "delete_label": "Usuń sprzedawcę",- "status": "Status",- "settlement": "Wypłaty i podatki",- "at_a_glance": "W skrócie",- "contact": "Kontakt",- "edit_profile": "Edytuj profil",- "edit_profile_description": "Sprzedawca prowadzi to w swoim panelu. Zmiany tutaj wprowadzasz w jego imieniu.",- "edit_settlement": "Edytuj wypłaty i podatki",- "edit_settlement_description": "Tylko Ty widzisz i zmieniasz te ustawienia. Sprzedawca ich nie edytuje.",- "no_about": "Ten sprzedawca nie napisał jeszcze opisu."- },- "status": {- "pending": "Oczekuje",- "invited": "Zaproszony",- "onboarding": "Konfiguracja",- "ready_for_review": "Do sprawdzenia",- "approved": "Zaakceptowany",- "suspended": "Zawieszony",- "rejected": "Odrzucony",- "canceled": "Anulowany"- },- "status_help": {- "pending": "Utworzony, ale nikt nie został jeszcze zaproszony.",- "invited": "Czeka na przyjęcie zaproszenia.",- "onboarding": "Uzupełnia swoje dane.",- "ready_for_review": "Czeka na Twoją akceptację.",- "approved": "Sprzedaje w marketplace.",- "suspended": "Nie może sprzedawać. Przywróć, aby wrócił do handlu.",- "rejected": "Nieprzyjęty do marketplace.",- "canceled": "Wycofał się przed dołączeniem."- },- "tax_remittance": {- "seller": "Rozlicza sprzedawca",- "platform": "Rozlicza marketplace"- },- "payout_interval": {- "inherit": "Domyślne ustawienie sklepu",- "daily": "Codziennie",- "weekly": "Co tydzień",- "biweekly": "Co dwa tygodnie",- "monthly": "Co miesiąc",- "manual": "Ręcznie"- },- "messages": {- "created": "Sprzedawca utworzony",- "create_failed": "Nie udało się utworzyć sprzedawcy",- "updated": "Sprzedawca zaktualizowany",- "update_failed": "Nie udało się zaktualizować sprzedawcy",- "deleted": "Sprzedawca usunięty",- "delete_failed": "Nie udało się usunąć sprzedawcy",- "invited": "Zaproszenie wysłane",- "invite_failed": "Nie udało się wysłać zaproszenia",- "approved": "Sprzedawca zaakceptowany",- "approve_failed": "Nie udało się zaakceptować sprzedawcy",- "suspended": "Sprzedawca zawieszony",- "suspend_failed": "Nie udało się zawiesić sprzedawcy",- "rejected": "Sprzedawca odrzucony",- "reject_failed": "Nie udało się odrzucić sprzedawcy"- },- "not_provided": "Nie podano",- "images": {- "logo_label": "Logo",- "logo_help": "Najlepiej sprawdza się kwadrat. Widoczne przy sprzedawcy wszędzie tam, gdzie się pojawia.",- "square_logo_label": "Logo kwadratowe",- "square_logo_help": "Do miejsc wymagających ścisłego kwadratu, na przykład awatara.",- "cover_photo_label": "Zdjęcie w tle",- "cover_photo_help": "Szeroki baner u góry profilu sprzedawcy."- },- "autocomplete": {- "placeholder": "Szukaj sprzedawców",- "empty": "Nie znaleziono sprzedawców"- }- },- "commission_rates": {- "add_cta": "Dodaj stawkę prowizji",- "applies_to_everything": "Każda sprzedaż",- "create_description": "Określ, ile marketplace pobiera od sprzedawców i których sprzedaży to dotyczy.",- "create_label": "Utwórz stawkę prowizji",- "delete_confirm": {- "message": "{{name}} zostanie usunięta. Naliczone już prowizje pozostaną bez zmian.",- "title": "Usunąć stawkę prowizji?"- },- "edit_description": "Zaktualizuj opłatę, jej limity i objęte nią sprzedaże.",- "empty": "Brak stawek prowizji",- "messages": {- "created": "Utworzono stawkę prowizji",- "deleted": "Usunięto stawkę prowizji",- "updated": "Zaktualizowano stawkę prowizji"+ "translations": {+ "coverage_summary": "Przetłumaczono {{translated}} z {{total}} języków",+ "dirty_summary": "{{count}} niezapisanych zmian",+ "discard_confirm": {+ "message": "Masz {{count}} niezapisanych zmian tłumaczeń. Odrzucić je?",+ "title": "Odrzucić zmiany?"},- "search_placeholder": "Szukaj po nazwie…",- "order_hint": "Nowe stawki trafiają na górę listy, a wygrywa pierwsza pasująca — przeciągnij, aby zmienić kolejność.",- "conditions": {- "add": "Dodaj warunek",- "title": "Warunki"- }+ "field": "Pole",+ "load_error": "Nie można załadować tłumaczeń",+ "locale": "Język",+ "manage": "Zarządzaj tłumaczeniami",+ "no_locales": "Dodaj więcej języków do swojego sklepu, aby przetłumaczyć ten produkt.",+ "original": "Oryginał",+ "save": "Zapisz tłumaczenia",+ "save_error": "Nie można zapisać tłumaczeń",+ "saved": "Tłumaczenia zapisane",+ "source": "Źródło",+ "title": "Tłumaczenia"}}}diff --git a/packages/dashboard/src/locales/zh-CN.json b/packages/dashboard/src/locales/zh-CN.jsonindex ddf6c2c724..4806fdcc07 100644--- a/packages/dashboard/src/locales/zh-CN.json+++ b/packages/dashboard/src/locales/zh-CN.json@@ -289,6 +289,93 @@},"title": "系列"},+ "commission_rates": {+ "add_cta": "添加佣金费率",+ "applies_to_everything": "所有销售",+ "create_description": "设置平台向卖家收取的费用,以及适用于哪些销售。",+ "create_label": "创建佣金费率",+ "delete_confirm": {+ "message": "将删除 {{name}}。已收取的佣金不受影响。",+ "title": "删除佣金费率?"+ },+ "edit_description": "更新费用、上下限以及适用的销售范围。",+ "empty": "暂无佣金费率",+ "messages": {+ "created": "佣金费率已创建",+ "deleted": "佣金费率已删除",+ "updated": "佣金费率已更新"+ },+ "search_placeholder": "按名称搜索…",+ "order_hint": "新费率会添加到列表顶部,首个匹配的费率生效——拖动可调整顺序。",+ "conditions": {+ "add": "添加条件",+ "title": "条件"+ }+ },+ "companies": {+ "add_cta": "添加企业",+ "add_sheet_title": "新建企业",+ "create_description": "企业客户通过分支机构下单。创建企业后即可添加分支机构、税务登记号和免税证明。",+ "create_label": "创建企业",+ "delete_confirm": {+ "message": "将删除 {{name}} 及其所有分支机构、采购人和证明。此操作无法撤销。",+ "title": "删除企业?"+ },+ "detail": {+ "delete_label": "删除企业",+ "load_error": "无法加载该企业",+ "profile": "企业"+ },+ "empty": "暂无企业",+ "locations_column": "分支机构",+ "messages": {+ "created": "企业已创建",+ "deleted": "企业已删除",+ "updated": "企业已更新"+ },+ "search_placeholder": "搜索企业"+ },+ "company_contacts": {+ "add_cta": "添加采购人",+ "add_title": "授权采购人",+ "dialog_description": "为该分支机构下单的客户。若客户只为一个分支机构采购,其订单会自动归属该机构。",+ "empty": "尚未授权任何采购人",+ "messages": {+ "created": "采购人已添加",+ "deleted": "采购人已移除"+ },+ "remove_action": "移除采购人",+ "remove_confirm": {+ "message": "{{email}} 将不再为该分支机构采购。其客户账户不受影响。",+ "title": "移除该采购人?"+ },+ "roles_enterprise_help": "在此添加的采购人可为该分支机构下单。角色、审批流程和支出限额由 Spree Enterprise 提供。",+ "roles_enterprise_title": "角色与审批为 Enterprise 功能",+ "title": "采购人"+ },+ "company_locations": {+ "add_cta": "添加分支机构",+ "add_title": "新建分支机构",+ "addresses": "地址",+ "billing_address": "账单地址",+ "contacts_count_one": "{{count}} 位采购人",+ "contacts_count_other": "{{count}} 位采购人",+ "detail": {+ "delete_label": "删除分支机构",+ "load_error": "无法加载该分支机构"+ },+ "dialog_description": "分支机构是开具发票和收货的地点。地址为选填,但一旦填写则需要姓名和国家/地区。",+ "edit_title": "编辑分支机构",+ "empty": "暂无分支机构",+ "messages": {+ "created": "分支机构已创建",+ "deleted": "分支机构已删除",+ "updated": "分支机构已更新"+ },+ "shipping_address": "收货地址",+ "shipping_same_as_billing": "收货地址与账单地址相同",+ "title": "分支机构"+ },"components": {"adjustment_action_editor": {"calculator_label": "计算器",@@ -547,6 +634,67 @@"split_description": "从第二个仓库发运相同的商品,并为其设置独立的区域和费率。","split_title": "拆分发货地"},+ "delivery_profiles": {+ "add_cta": "添加配置方案",+ "add_dialog_title": "新建配送方案",+ "all_locations": "所有地点",+ "capabilities": {+ "digital": "数字交付",+ "pickup": "自提",+ "ships": "配送"+ },+ "create_description": "将配送方式相同的商品归为一组,并为其设置独立的发货地点、区域和配送方式。",+ "create_label": "创建配置方案",+ "default_badge": "默认",+ "default_confirm": {+ "message": "未单独指定配置方案的商品今后将使用“{{name}}”配送。",+ "title": "设为默认配置方案"+ },+ "delete_confirm": {+ "message": "确定删除“{{name}}”吗?其区域和配送方式将一并删除。",+ "title": "删除配送配置方案"+ },+ "detail": {+ "add_digital_method": "添加数字交付方式",+ "add_method": "添加配送方式",+ "collect_from": "自提地点",+ "collect_from_hint": "顾客可以前往自提的地点。更改立即生效。",+ "delete_label": "删除配置方案",+ "digital_empty": "尚无数字交付方式。",+ "digital_hint": "无需配送或自提即可交付。",+ "digital_title": "数字交付",+ "general_title": "基本信息",+ "hidden_badge": "已隐藏",+ "load_failed_title": "无法加载此配送配置方案",+ "no_methods": "此处暂无配送方式。",+ "no_stock_locations": "尚无地点,请在“设置 → 地点”中添加。",+ "no_zone_hint": "这些配送方式在此配置方案覆盖的所有地区均可用。",+ "no_zone_title": "不限区域",+ "no_zones": "暂无区域 — 添加一个即可开始提供配送方式。",+ "offer_pickup": "提供自提",+ "origins_title": "发货地点",+ "pickup_empty": "尚无自提方式,顾客无法在此方案中自提订单。",+ "pickup_hint": "顾客亲自领取这些订单。自提没有配送目的地,因此不适用区域。",+ "pickup_title": "到店自提",+ "zones_title": "区域与配送方式"+ },+ "empty": "尚无配送方案。",+ "is_default_hint": "未单独指定配置方案的商品将使用此方案配送。",+ "kind_immutable_hint": "类型在创建配置方案时确定,之后不可更改。",+ "kinds": {+ "digital": "数字交付",+ "shipping": "实物配送"+ },+ "locations_count": "{{count}} 个地点",+ "make_default": "设为默认",+ "messages": {+ "created": "配送配置方案已创建",+ "deleted": "配送配置方案已删除",+ "updated": "配送配置方案已更新"+ },+ "search_placeholder": "搜索配送方案…",+ "selected_locations": "选定地点"+ },"delivery_zones": {"add_countries_in_markets": "在“市场”中添加更多国家","add_cta": "添加配送区域",@@ -587,6 +735,9 @@"to_placeholder": "止","toggle_states": "显示 {{country}} 的省/州"},+ "enterprise": {+ "learn_more": "了解 Spree Enterprise"+ },"errors": {"forbidden_description": "您没有权限查看此页面。","forbidden_title": "未授权",@@ -1715,67 +1866,6 @@}}},- "delivery_profiles": {- "add_cta": "添加配置方案",- "add_dialog_title": "新建配送方案",- "all_locations": "所有地点",- "capabilities": {- "digital": "数字交付",- "pickup": "自提",- "ships": "配送"- },- "create_description": "将配送方式相同的商品归为一组,并为其设置独立的发货地点、区域和配送方式。",- "create_label": "创建配置方案",- "default_badge": "默认",- "default_confirm": {- "message": "未单独指定配置方案的商品今后将使用“{{name}}”配送。",- "title": "设为默认配置方案"- },- "delete_confirm": {- "message": "确定删除“{{name}}”吗?其区域和配送方式将一并删除。",- "title": "删除配送配置方案"- },- "detail": {- "add_digital_method": "添加数字交付方式",- "add_method": "添加配送方式",- "collect_from": "自提地点",- "collect_from_hint": "顾客可以前往自提的地点。更改立即生效。",- "delete_label": "删除配置方案",- "digital_empty": "尚无数字交付方式。",- "digital_hint": "无需配送或自提即可交付。",- "digital_title": "数字交付",- "general_title": "基本信息",- "hidden_badge": "已隐藏",- "load_failed_title": "无法加载此配送配置方案",- "no_methods": "此处暂无配送方式。",- "no_stock_locations": "尚无地点,请在“设置 → 地点”中添加。",- "no_zone_hint": "这些配送方式在此配置方案覆盖的所有地区均可用。",- "no_zone_title": "不限区域",- "no_zones": "暂无区域 — 添加一个即可开始提供配送方式。",- "offer_pickup": "提供自提",- "origins_title": "发货地点",- "pickup_empty": "尚无自提方式,顾客无法在此方案中自提订单。",- "pickup_hint": "顾客亲自领取这些订单。自提没有配送目的地,因此不适用区域。",- "pickup_title": "到店自提",- "zones_title": "区域与配送方式"- },- "empty": "尚无配送方案。",- "is_default_hint": "未单独指定配置方案的商品将使用此方案配送。",- "kind_immutable_hint": "类型在创建配置方案时确定,之后不可更改。",- "kinds": {- "digital": "数字交付",- "shipping": "实物配送"- },- "locations_count": "{{count}} 个地点",- "make_default": "设为默认",- "messages": {- "created": "配送配置方案已创建",- "deleted": "配送配置方案已删除",- "updated": "配送配置方案已更新"- },- "search_placeholder": "搜索配送方案…",- "selected_locations": "选定地点"- },"gift_cards": {"batch_autocomplete": {"empty": "无匹配的批次",@@ -1936,6 +2026,9 @@"sign_in_and_accept": "登录并接受","sign_in_to_accept": "。登录以接受。"},+ "jurisdiction": {+ "everywhere": "所有地区"+ },"markets": {"add_cta": "添加市场","columns": {@@ -3770,30 +3863,265 @@"name_required": "名称为必填项"}},- "settings": {- "webhooks": {- "errors": {- "redeliver_failed": "重新投递失败",- "send_test_failed": "发送测试 Webhook 失败"+ "seller_requirements": {+ "title": "卖家要求",+ "search_placeholder": "搜索要求",+ "empty": "尚无要求。卖家可以立即申请审核。",+ "add_cta": "添加要求",+ "add_title": "添加要求",+ "edit_title": "编辑要求",+ "columns": {+ "kind": "类型",+ "required": "必需"+ },+ "required": {+ "yes": "必需",+ "no": "建议"+ },+ "status": {+ "disabled": "已关闭"+ },+ "fields": {+ "accepted_files": {+ "label": "可上传文件",+ "help": "卖家可上传:{{types}}"},- "messages": {- "removed": "Webhook 端点已移除",- "updated": "Webhook 端点已更新"+ "active": {+ "label": "启用",+ "help": "关闭即可停止要求,而不删除它。"+ },+ "custom_fields": {+ "label": "自定义字段",+ "help": "卖家必须填写你选择的每个字段。",+ "placeholder": "搜索字段",+ "empty": "未找到卖家自定义字段。请在设置 → 自定义字段中创建。"+ },+ "description": {+ "label": "说明",+ "placeholder": "告诉卖家你需要什么以及原因"+ },+ "kind": {+ "label": "类型",+ "placeholder": "选择你要求的内容"+ },+ "name": {+ "label": "名称",+ "label_required": "名称(必填)",+ "help": "卖家在清单上看到的内容。"+ },+ "required": {+ "label": "必需",+ "help": "必需项在批准前必须完成,其余项显示为建议。"}+ },+ "delete_confirm": {+ "title": "删除要求?",+ "message": "将不再向卖家索取“{{name}}”。他们已提交的内容也会一并删除。"+ },+ "messages": {+ "created": "已添加要求",+ "updated": "已保存要求",+ "deleted": "已删除要求",+ "submission_accepted": "已接受",+ "submission_rejected": "已退回给卖家",+ "waived": "已豁免该卖家的此项要求"+ },+ "kinds": {+ "accept_terms": "接受条款",+ "complete_profile": "完善资料",+ "billing_address": "账单地址",+ "returns_address": "退货地址",+ "minimum_products": "最少商品数",+ "required_custom_fields": "必填自定义字段",+ "attestation": "卖家确认",+ "operator_review": "人工核查",+ "document": "文件"}},- "settings_nav": {- "groups": {- "audit": "审计",- "fulfillment": "履约",- "payments": "支付与税务",- "store": "店铺",- "team": "团队与权限"- },- "items": {+ "sellers": {+ "actions": {+ "invite": "邀请",+ "reinvite": "重新发送",+ "send_invitation": "发送邀请",+ "approve": "批准",+ "reinstate": "恢复",+ "suspend": "暂停",+ "reject": "拒绝",+ "reopen_onboarding": "退回入驻流程"+ },+ "add_cta": "添加卖家",+ "add_sheet_title": "新建卖家",+ "address": {+ "filled": "已填写",+ "not_filled": "未填写",+ "not_provided_by_seller": "卖家尚未提供",+ "not_located_yet": "定位完成后将显示地图。"+ },+ "approve_override_confirm": {+ "title": "仍要批准吗?",+ "message": "该卖家尚未完成:{{names}}。现在批准将允许其照常经营,此决定会被记录。",+ "action": "仍然批准"+ },+ "autocomplete": {+ "placeholder": "搜索卖家",+ "empty": "未找到卖家"+ },+ "create_description": "先创建卖家记录,然后在卖家页面邀请、批准并设置结算。",+ "create_label": "创建卖家",+ "delete_confirm": {+ "title": "删除卖家?",+ "message": "这会将 {{name}} 从市场中移除。其商品会保留在目录中但不再归属任何卖家。此操作无法撤销。"+ },+ "detail": {+ "load_error": "无法加载该卖家",+ "delete_label": "删除卖家",+ "status": "状态",+ "settlement": "结算与税务",+ "at_a_glance": "概览",+ "contact": "联系方式",+ "edit_profile": "编辑资料",+ "edit_profile_description": "卖家在自己的面板中维护这些信息。在这里的修改代表卖家进行。",+ "edit_settlement": "编辑结算与税务",+ "edit_settlement_description": "只有你能查看和修改这些设置,卖家无法编辑。",+ "no_about": "该卖家尚未填写简介。",+ "billing_address": "账单地址",+ "returns_address": "退货地址"+ },+ "empty": "暂无卖家",+ "images": {+ "logo_label": "标志",+ "logo_help": "建议使用正方形。会在卖家出现的各处显示在其旁边。",+ "square_logo_label": "方形标志",+ "square_logo_help": "用于需要严格正方形的位置,例如头像。",+ "cover_photo_label": "封面图",+ "cover_photo_help": "卖家资料页顶部的宽幅横幅。"+ },+ "invite_sheet": {+ "title": "邀请卖家",+ "description": "对方接受后即加入卖家团队,并可登录自己的面板。",+ "email_help": "邀请将发送到该邮箱。"+ },+ "messages": {+ "created": "卖家已创建",+ "create_failed": "无法创建卖家",+ "updated": "卖家已更新",+ "update_failed": "无法更新卖家",+ "deleted": "卖家已删除",+ "delete_failed": "无法删除卖家",+ "invited": "邀请已发送",+ "invite_failed": "无法发送邀请",+ "approved": "卖家已批准",+ "approve_failed": "无法批准卖家",+ "suspended": "卖家已暂停",+ "suspend_failed": "无法暂停卖家",+ "rejected": "卖家已拒绝",+ "reject_failed": "无法拒绝卖家",+ "onboarding_reopened": "已退回入驻流程"+ },+ "not_provided": "未填写",+ "on_holiday_notice": "该卖家处于休假状态。商品仍然可见,但无法购买。",+ "onboarding": {+ "title": "入驻",+ "progress": "已完成 {{done}} / {{total}}",+ "waived": "已豁免",+ "download": "下载文件",+ "seller_note": "卖家:{{note}}",+ "review_note": "你的备注:{{note}}",+ "actions": {+ "accept": "接受",+ "reject": "退回",+ "waive": "为该卖家豁免"+ },+ "reject_confirm": {+ "title": "退回?",+ "message": "将再次向卖家索取“{{name}}”。"+ },+ "waive_confirm": {+ "title": "豁免此要求?",+ "message": "“{{name}}”将仅对该卖家视为已满足。"+ },+ "all_done": "全部完成 🎉",+ "status": {+ "complete": "已完成",+ "pending": "审核中",+ "rejected": "已退回",+ "incomplete": "待办"+ }+ },+ "onboarding_column": "入驻",+ "payout_interval": {+ "inherit": "使用商店默认值",+ "daily": "每天",+ "weekly": "每周",+ "biweekly": "每两周",+ "monthly": "每月",+ "manual": "手动"+ },+ "products_column": "商品",+ "reject_confirm": {+ "title": "拒绝卖家?",+ "message": "{{name}} 将不会进入市场。如有需要,之后仍可批准。"+ },+ "reopen_onboarding_confirm": {+ "title": "退回入驻流程?",+ "message": "{{name}} 将可以修改资料并再次申请审核。"+ },+ "search_placeholder": "搜索卖家",+ "status": {+ "pending": "待处理",+ "invited": "已邀请",+ "onboarding": "入驻中",+ "ready_for_review": "待审核",+ "approved": "已批准",+ "suspended": "已暂停",+ "rejected": "已拒绝",+ "canceled": "已取消"+ },+ "status_help": {+ "pending": "已创建,但尚未邀请任何人。",+ "invited": "等待对方接受邀请。",+ "onboarding": "正在填写资料。",+ "ready_for_review": "等待你的批准。",+ "approved": "正在市场中销售。",+ "suspended": "已停止销售。恢复后可继续经营。",+ "rejected": "未获准进入市场。",+ "canceled": "在加入前已退出。"+ },+ "suspend_confirm": {+ "title": "暂停卖家?",+ "message": "{{name}} 将立即停止销售。商品和历史记录会保留,之后可以恢复。"+ },+ "tax_remittance": {+ "seller": "卖家申报",+ "platform": "市场申报"+ },+ "team_column": "团队"+ },+ "settings": {+ "webhooks": {+ "errors": {+ "redeliver_failed": "重新投递失败",+ "send_test_failed": "发送测试 Webhook 失败"+ },+ "messages": {+ "removed": "Webhook 端点已移除",+ "updated": "Webhook 端点已更新"+ }+ }+ },+ "settings_nav": {+ "groups": {+ "audit": "审计",+ "fulfillment": "履约",+ "payments": "支付与税务",+ "store": "店铺",+ "team": "团队与权限"+ },+ "items": {"allowed_origins": "允许的来源","api_keys": "API 密钥","channels": "销售渠道",+ "commission_rates": "佣金费率","custom_field_definitions": "自定义字段","delivery_profiles": "配送方案","emails": "邮件",@@ -3805,13 +4133,13 @@"profile": "个人资料","reasons": "退货与原因","roles": "角色",+ "seller_requirements": "卖家要求","staff": "员工","stock_locations": "库存地点","store": "店铺","tax_categories": "税收类别","tax_rates": "税率",- "webhooks": "Webhooks",- "commission_rates": "佣金费率"+ "webhooks": "Webhooks"}},"setup": {@@ -3976,91 +4304,50 @@},"search_placeholder": "按名称搜索…"},- "translations": {- "coverage_summary": "已翻译 {{total}} 种语言中的 {{translated}} 种",- "dirty_summary": "{{count}} 项未保存的更改",- "discard_confirm": {- "message": "您有 {{count}} 项未保存的翻译更改。要放弃吗?",- "title": "放弃更改?"- },- "field": "字段",- "load_error": "无法加载翻译",- "locale": "语言",- "manage": "管理翻译",- "no_locales": "向您的商店添加更多语言以翻译此产品。",- "original": "原文",- "save": "保存翻译",- "save_error": "无法保存翻译",- "saved": "翻译已保存",- "source": "源",- "title": "翻译"- },- "jurisdiction": {- "everywhere": "所有地区"- },- "companies": {- "add_cta": "添加企业",- "add_sheet_title": "新建企业",- "create_description": "企业客户通过分支机构下单。创建企业后即可添加分支机构、税务登记号和免税证明。",- "create_label": "创建企业",+ "tax_exemption_certificates": {+ "add_cta": "添加证明",+ "add_title": "添加免税证明","delete_confirm": {- "message": "将删除 {{name}} 及其所有分支机构、采购人和证明。此操作无法撤销。",- "title": "删除企业?"- },- "detail": {- "delete_label": "删除企业",- "load_error": "无法加载该企业",- "profile": "企业"+ "message": "将移除证明 {{number}}。此操作无法撤销。",+ "title": "删除该证明?"},- "empty": "暂无企业",- "locations_column": "分支机构",+ "dialog_description": "证明该企业的采购无需征税。新证明需经您接受后才会生效。",+ "download_action": "下载文件",+ "empty": "暂无证明",+ "expires_prefix": "有效期至",+ "lapsed": "已失效","messages": {- "created": "企业已创建",- "deleted": "企业已删除",- "updated": "企业已更新"- },- "search_placeholder": "搜索企业"- },- "company_locations": {- "add_cta": "添加分支机构",- "add_title": "新建分支机构",- "addresses": "地址",- "billing_address": "账单地址",- "contacts_count_one": "{{count}} 位采购人",- "contacts_count_other": "{{count}} 位采购人",- "detail": {- "delete_label": "删除分支机构",- "load_error": "无法加载该分支机构"+ "created": "证明已添加",+ "deleted": "证明已删除",+ "revoked": "证明已撤销",+ "updated": "证明已更新",+ "verified": "证明已接受"},- "dialog_description": "分支机构是开具发票和收货的地点。地址为选填,但一旦填写则需要姓名和国家/地区。",- "edit_title": "编辑分支机构",- "empty": "暂无分支机构",- "messages": {- "created": "分支机构已创建",- "deleted": "分支机构已删除",- "updated": "分支机构已更新"+ "never_expires": "长期有效",+ "no_document": "未附文件",+ "reason_codes": {+ "agricultural": "农业",+ "charitable": "慈善机构",+ "educational": "教育机构",+ "government": "政府机构",+ "manufacturing": "生产制造",+ "resale": "转售"},- "shipping_address": "收货地址",- "shipping_same_as_billing": "收货地址与账单地址相同",- "title": "分支机构"- },- "company_contacts": {- "add_cta": "添加采购人",- "add_title": "授权采购人",- "dialog_description": "为该分支机构下单的客户。若客户只为一个分支机构采购,其订单会自动归属该机构。",- "empty": "尚未授权任何采购人",- "messages": {- "created": "采购人已添加",- "deleted": "采购人已移除"+ "revoke_action": "撤销",+ "revoke_confirm": {+ "message": "证明 {{number}} 将不再适用于新订单,但会作为记录保留。",+ "title": "撤销该证明?"},- "remove_action": "移除采购人",- "remove_confirm": {- "message": "{{email}} 将不再为该分支机构采购。其客户账户不受影响。",- "title": "移除该采购人?"+ "select_reason": "选择事由",+ "status": {+ "expired": "已过期",+ "pending": "待审核",+ "revoked": "已撤销",+ "verified": "已接受"},- "roles_enterprise_help": "在此添加的采购人可为该分支机构下单。角色、审批流程和支出限额由 Spree Enterprise 提供。",- "roles_enterprise_title": "角色与审批为 Enterprise 功能",- "title": "采购人"+ "title": "免税证明",+ "verified_at": "接受日期",+ "verify_action": "接受"},"tax_identifiers": {"add_cta": "添加登记号",@@ -4100,50 +4387,11 @@"verified": "已核验"}},- "tax_exemption_certificates": {- "add_cta": "添加证明",- "add_title": "添加免税证明",- "delete_confirm": {- "message": "将移除证明 {{number}}。此操作无法撤销。",- "title": "删除该证明?"- },- "dialog_description": "证明该企业的采购无需征税。新证明需经您接受后才会生效。",- "download_action": "下载文件",- "empty": "暂无证明",- "expires_prefix": "有效期至",- "lapsed": "已失效",- "messages": {- "created": "证明已添加",- "deleted": "证明已删除",- "revoked": "证明已撤销",- "updated": "证明已更新",- "verified": "证明已接受"- },- "never_expires": "长期有效",- "no_document": "未附文件",- "reason_codes": {- "agricultural": "农业",- "charitable": "慈善机构",- "educational": "教育机构",- "government": "政府机构",- "manufacturing": "生产制造",- "resale": "转售"- },- "revoke_action": "撤销",- "revoke_confirm": {- "message": "证明 {{number}} 将不再适用于新订单,但会作为记录保留。",- "title": "撤销该证明?"- },- "select_reason": "选择事由",- "status": {- "expired": "已过期",- "pending": "待审核",- "revoked": "已撤销",- "verified": "已接受"- },- "title": "免税证明",- "verified_at": "接受日期",- "verify_action": "接受"+ "tax_providers": {+ "limitations_title": "{{name}} 不支持",+ "unavailable_option": "{{name}}(未配置)",+ "use_default": "使用默认计算引擎",+ "use_default_named": "默认({{name}})"},"tax_rates": {"add_cta": "添加税率",@@ -4166,148 +4414,24 @@"search_placeholder": "搜索税率","select_category": "选择类别"},- "tax_providers": {- "limitations_title": "{{name}} 不支持",- "unavailable_option": "{{name}}(未配置)",- "use_default": "使用默认计算引擎",- "use_default_named": "默认({{name}})"- },- "enterprise": {- "learn_more": "了解 Spree Enterprise"- },- "sellers": {- "add_cta": "添加卖家",- "add_sheet_title": "新建卖家",- "create_description": "先创建卖家记录,然后在卖家页面邀请、批准并设置结算。",- "create_label": "创建卖家",- "search_placeholder": "搜索卖家",- "empty": "暂无卖家",- "products_column": "商品",- "team_column": "团队",- "on_holiday_notice": "该卖家处于休假状态。商品仍然可见,但无法购买。",- "delete_confirm": {- "title": "删除卖家?",- "message": "这会将 {{name}} 从市场中移除。其商品会保留在目录中但不再归属任何卖家。此操作无法撤销。"- },- "suspend_confirm": {- "title": "暂停卖家?",- "message": "{{name}} 将立即停止销售。商品和历史记录会保留,之后可以恢复。"- },- "reject_confirm": {- "title": "拒绝卖家?",- "message": "{{name}} 将不会进入市场。如有需要,之后仍可批准。"- },- "invite_sheet": {- "title": "邀请卖家",- "description": "对方接受后即加入卖家团队,并可登录自己的面板。",- "email_help": "邀请将发送到该邮箱。"- },- "actions": {- "invite": "邀请",- "reinvite": "重新发送",- "send_invitation": "发送邀请",- "approve": "批准",- "reinstate": "恢复",- "suspend": "暂停",- "reject": "拒绝"- },- "detail": {- "load_error": "无法加载该卖家",- "delete_label": "删除卖家",- "status": "状态",- "settlement": "结算与税务",- "at_a_glance": "概览",- "contact": "联系方式",- "edit_profile": "编辑资料",- "edit_profile_description": "卖家在自己的面板中维护这些信息。在这里的修改代表卖家进行。",- "edit_settlement": "编辑结算与税务",- "edit_settlement_description": "只有你能查看和修改这些设置,卖家无法编辑。",- "no_about": "该卖家尚未填写简介。"- },- "status": {- "pending": "待处理",- "invited": "已邀请",- "onboarding": "入驻中",- "ready_for_review": "待审核",- "approved": "已批准",- "suspended": "已暂停",- "rejected": "已拒绝",- "canceled": "已取消"- },- "status_help": {- "pending": "已创建,但尚未邀请任何人。",- "invited": "等待对方接受邀请。",- "onboarding": "正在填写资料。",- "ready_for_review": "等待你的批准。",- "approved": "正在市场中销售。",- "suspended": "已停止销售。恢复后可继续经营。",- "rejected": "未获准进入市场。",- "canceled": "在加入前已退出。"- },- "tax_remittance": {- "seller": "卖家申报",- "platform": "市场申报"- },- "payout_interval": {- "inherit": "使用商店默认值",- "daily": "每天",- "weekly": "每周",- "biweekly": "每两周",- "monthly": "每月",- "manual": "手动"- },- "messages": {- "created": "卖家已创建",- "create_failed": "无法创建卖家",- "updated": "卖家已更新",- "update_failed": "无法更新卖家",- "deleted": "卖家已删除",- "delete_failed": "无法删除卖家",- "invited": "邀请已发送",- "invite_failed": "无法发送邀请",- "approved": "卖家已批准",- "approve_failed": "无法批准卖家",- "suspended": "卖家已暂停",- "suspend_failed": "无法暂停卖家",- "rejected": "卖家已拒绝",- "reject_failed": "无法拒绝卖家"- },- "not_provided": "未填写",- "images": {- "logo_label": "标志",- "logo_help": "建议使用正方形。会在卖家出现的各处显示在其旁边。",- "square_logo_label": "方形标志",- "square_logo_help": "用于需要严格正方形的位置,例如头像。",- "cover_photo_label": "封面图",- "cover_photo_help": "卖家资料页顶部的宽幅横幅。"- },- "autocomplete": {- "placeholder": "搜索卖家",- "empty": "未找到卖家"- }- },- "commission_rates": {- "add_cta": "添加佣金费率",- "applies_to_everything": "所有销售",- "create_description": "设置平台向卖家收取的费用,以及适用于哪些销售。",- "create_label": "创建佣金费率",- "delete_confirm": {- "message": "将删除 {{name}}。已收取的佣金不受影响。",- "title": "删除佣金费率?"- },- "edit_description": "更新费用、上下限以及适用的销售范围。",- "empty": "暂无佣金费率",- "messages": {- "created": "佣金费率已创建",- "deleted": "佣金费率已删除",- "updated": "佣金费率已更新"+ "translations": {+ "coverage_summary": "已翻译 {{total}} 种语言中的 {{translated}} 种",+ "dirty_summary": "{{count}} 项未保存的更改",+ "discard_confirm": {+ "message": "您有 {{count}} 项未保存的翻译更改。要放弃吗?",+ "title": "放弃更改?"},- "search_placeholder": "按名称搜索…",- "order_hint": "新费率会添加到列表顶部,首个匹配的费率生效——拖动可调整顺序。",- "conditions": {- "add": "添加条件",- "title": "条件"- }+ "field": "字段",+ "load_error": "无法加载翻译",+ "locale": "语言",+ "manage": "管理翻译",+ "no_locales": "向您的商店添加更多语言以翻译此产品。",+ "original": "原文",+ "save": "保存翻译",+ "save_error": "无法保存翻译",+ "saved": "翻译已保存",+ "source": "源",+ "title": "翻译"}}}diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/getting-started.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/getting-started.tsxindex 97b76d44ba..b2ab6e7053 100644--- a/packages/dashboard/src/routes/_authenticated/$storeId/getting-started.tsx+++ b/packages/dashboard/src/routes/_authenticated/$storeId/getting-started.tsx@@ -3,6 +3,7 @@ import { PageHeader, Slot, useStore } from '@spree/dashboard-core'import {Button,Card,+ CardTitle,Collapsible,CollapsibleContent,CollapsibleTrigger,@@ -96,7 +97,7 @@ function GettingStartedPage() {) : (<CircleIcon className="size-5 shrink-0 text-muted-foreground" />)}- <span className="grow font-medium">{taskCopy(task, 'title')}</span>+ <CardTitle className="grow">{taskCopy(task, 'title')}</CardTitle><ChevronDownIcon className="size-4 shrink-0 text-muted-foreground transition-transform group-data-[panel-open]:rotate-180" /></CollapsibleTrigger>{/* keepMounted so slot components mount even while their card isdiff --git a/packages/dashboard/src/routes/_authenticated/$storeId/sellers/$sellerId.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/sellers/$sellerId.tsxindex 4e7a0c8f58..f45db6c8aa 100644--- a/packages/dashboard/src/routes/_authenticated/$storeId/sellers/$sellerId.tsx+++ b/packages/dashboard/src/routes/_authenticated/$storeId/sellers/$sellerId.tsx@@ -9,6 +9,7 @@ import {usePermissions,} from '@spree/dashboard-core'import {+ Badge,Button,Card,CardAction,@@ -48,6 +49,7 @@ import {PauseIcon,PencilIcon,StoreIcon,+ UndoIcon,UsersIcon,} from 'lucide-react'import { type ReactNode, useEffect, useState } from 'react'@@ -55,11 +57,15 @@ import { Controller, useForm } from 'react-hook-form'import { useTranslation } from 'react-i18next'import { ResourceImageField } from '../../../../components/spree/resource-image-field'import { ResourceDetailSkeleton } from '../../../../components/spree/route-pending'+import { SellerAddressCard } from '../../../../components/spree/sellers/seller-address-card'+import { SellerOnboardingCard } from '../../../../components/spree/sellers/seller-onboarding-card'+import { useSellerOnboarding } from '../../../../hooks/use-seller-requirements'import {useApproveSeller,useDeleteSeller,useInviteSeller,useRejectSeller,+ useReopenSellerOnboarding,useSeller,useSuspendSeller,useUpdateSeller,@@ -118,6 +124,10 @@ function SellerBody({ seller }: { seller: Seller }) {const [inviting, setInviting] = useState(false)const approveMutation = useApproveSeller(seller.id)+ const reopenMutation = useReopenSellerOnboarding(seller.id)+ // Read here as well as in the card: approving has to know what is still+ // outstanding so it can say so before the operator overrides it.+ const { data: onboarding } = useSellerOnboarding(seller.id)const suspendMutation = useSuspendSeller(seller.id)const rejectMutation = useRejectSeller(seller.id)@@ -161,19 +171,57 @@ function SellerBody({ seller }: { seller: Seller }) {await rejectMutation.mutateAsync(undefined).catch(() => undefined)}+ // Admitting a seller whose checklist is unfinished is allowed, but never by+ // accident: the operator is shown exactly what is outstanding and has to+ // say they mean it. The server refuses without the override, so this dialog+ // is the only way past it.+ async function handleApprove() {+ if (!onboarding) return++ // `blocking` comes from the server, which is also what the approval gate+ // reads — deriving it here again would let the warning and the refusal+ // disagree.+ const blocking = onboarding.requirements.filter((requirement) => requirement.blocking)++ if (blocking.length > 0) {+ const ok = await confirm({+ title: t('admin.sellers.approve_override_confirm.title'),+ message: t('admin.sellers.approve_override_confirm.message', {+ names: blocking.map((requirement) => requirement.name).join(', '),+ }),+ variant: 'destructive',+ confirmLabel: t('admin.sellers.approve_override_confirm.action'),+ })+ if (!ok) return++ await approveMutation.mutateAsync({ override_requirements: true }).catch(() => undefined)+ return+ }++ await approveMutation.mutateAsync(undefined).catch(() => undefined)+ }++ async function handleReopenOnboarding() {+ const ok = await confirm({+ title: t('admin.sellers.reopen_onboarding_confirm.title'),+ message: t('admin.sellers.reopen_onboarding_confirm.message', { name: seller.name }),+ confirmLabel: t('admin.sellers.actions.reopen_onboarding'),+ })+ if (!ok) return++ await reopenMutation.mutateAsync(undefined).catch(() => undefined)+ }+// Approving is the move an operator comes here to make, so it is the button;// the rest live in the dropdown beside it.const primaryAction = canEdit ? (<>+ {/* Without the checklist, approving cannot tell "nothing is blocking"+ from "we were never told", so the button waits for it — a failed+ query leaves `isPending` false with no data, which is why this gates+ on the data rather than the loading flag. */}{canApprove && (- <Button- size="sm"- disabled={busy}- // The hook already surfaces the failure; catching keeps a rejected- // request from also becoming an unhandled promise rejection, as the- // suspend and reject handlers do.- onClick={() => approveMutation.mutateAsync().catch(() => undefined)}- >+ <Button size="sm" disabled={busy || !onboarding} onClick={handleApprove}>{status === 'suspended'? t('admin.sellers.actions.reinstate'): t('admin.sellers.actions.approve')}@@ -203,6 +251,12 @@ function SellerBody({ seller }: { seller: Seller }) {{t('admin.sellers.actions.suspend')}</DropdownMenuItem>)}+ {status === 'ready_for_review' && (+ <DropdownMenuItem onClick={handleReopenOnboarding}>+ <UndoIcon className="size-4" />+ {t('admin.sellers.actions.reopen_onboarding')}+ </DropdownMenuItem>+ )}{canReject && (<DropdownMenuItem onClick={handleReject}><BanIcon className="size-4" />@@ -220,7 +274,19 @@ function SellerBody({ seller }: { seller: Seller }) {title={seller.name}subtitle={seller.contact_email ?? undefined}backTo="sellers"- badges={<StatusBadge status={status} label={t(`admin.sellers.status.${status}`)} />}+ badges={+ <>+ <StatusBadge status={status} label={t(`admin.sellers.status.${status}`)} />+ {seller.onboarding_progress.total > 0 && !seller.onboarding_complete && (+ <Badge variant="secondary">+ {t('admin.sellers.onboarding.progress', {+ done: seller.onboarding_progress.done,+ total: seller.onboarding_progress.total,+ })}+ </Badge>+ )}+ </>+ }actions={primaryAction}dropdownItems={dropdownItems}resource={{ id: seller.id }}@@ -235,6 +301,7 @@ function SellerBody({ seller }: { seller: Seller }) {canEdit={canEdit}onEdit={() => setEditingProfile(true)}/>+ <SellerOnboardingCard seller={seller} canEdit={canEdit} /><Slot name="seller.form_main" context={{ seller, canEdit }} /></>}@@ -242,7 +309,13 @@ function SellerBody({ seller }: { seller: Seller }) {<><SellerStatusCard seller={seller} /><SellerAtAGlanceCard seller={seller} />- <SellerContactCard seller={seller} />+ <SellerContactCard+ seller={seller}+ canEdit={canEdit}+ onEdit={() => setEditingProfile(true)}+ />+ <SellerAddressCard seller={seller} addressKey="billing_address" canEdit={canEdit} />+ <SellerAddressCard seller={seller} addressKey="returns_address" canEdit={canEdit} /><SellerSettlementCardseller={seller}canEdit={canEdit}@@ -301,7 +374,7 @@ function SellerBrandCard({{seller.cover_photo_url ? (<img src={seller.cover_photo_url} alt="" className="h-40 w-full bg-accent object-cover" />) : (- <div className="h-20 w-full border-border border-b bg-accent" />+ <div className="h-20 w-full border-border border-b bg-muted" />)}{canEdit && (<Button size="sm" variant="outline" className="absolute top-3 right-3" onClick={onEdit}>@@ -411,13 +484,29 @@ function SellerAtAGlanceCard({ seller }: { seller: Seller }) {)}-function SellerContactCard({ seller }: { seller: Seller }) {+function SellerContactCard({+ seller,+ canEdit,+ onEdit,+}: {+ seller: Seller+ canEdit: boolean+ onEdit: () => void+}) {const { t } = useTranslation()return (<Card><CardHeader><CardTitle>{t('admin.sellers.detail.contact')}</CardTitle>+ {canEdit && (+ <CardAction>+ <Button variant="outline" size="sm" onClick={onEdit}>+ <PencilIcon className="size-4" />+ {t('admin.actions.edit')}+ </Button>+ </CardAction>+ )}</CardHeader><CardContent className="flex flex-col gap-3"><ReadRow label={t('admin.fields.contact_email.label')}>diff --git a/packages/dashboard/src/tables/sellers.tsx b/packages/dashboard/src/tables/sellers.tsxindex bf3f024dd4..ba2ba6793a 100644--- a/packages/dashboard/src/tables/sellers.tsx+++ b/packages/dashboard/src/tables/sellers.tsx@@ -1,6 +1,6 @@import type { Seller } from '@spree/admin-sdk'import { defineTable } from '@spree/dashboard-core'-import { RelativeTime, StatusBadge } from '@spree/dashboard-ui'+import { Progress, RelativeTime, StatusBadge } from '@spree/dashboard-ui'import { Link } from '@tanstack/react-router'import i18n from 'i18next'import { StoreIcon } from 'lucide-react'@@ -56,6 +56,29 @@ defineTable<Seller>('sellers', {default: true,render: (seller) => seller.contact_email ?? <span className="text-muted-foreground">—</span>,},+ {+ key: 'onboarding',+ label: i18n.t('admin.sellers.onboarding_column'),+ default: true,+ // "n of m done" over a bar, as the operator's list has always shown+ // it. Nothing to show for a marketplace that asks for nothing.+ render: (seller) => {+ const progress = seller.onboarding_progress+ if (progress.total === 0) return <span className="text-muted-foreground">—</span>++ return (+ <div className="flex min-w-32 flex-col gap-1">+ <span className="text-muted-foreground text-xs">+ {i18n.t('admin.sellers.onboarding.progress', {+ done: progress.done,+ total: progress.total,+ })}+ </span>+ <Progress value={progress.percentage} />+ </div>+ )+ },+ },{key: 'products_count',label: i18n.t('admin.sellers.products_column'),diff --git a/pnpm-lock.yaml b/pnpm-lock.yamlindex bb50034feb..acdca1fdeb 100644--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -231,6 +231,9 @@ importers:lucide-react:specifier: ^1.14.0version: 1.14.0([email protected])+ maplibre-gl:+ specifier: ^6.4.0+ version: 6.4.0next-themes:specifier: ^0.4.6@@ -280,6 +283,9 @@ importers:'@spree/dashboard-plugin-example':specifier: workspace:^version: link:../dashboard-plugin-example+ '@types/geojson':+ specifier: ^7946.0.16+ version: 7946.0.16'@types/node':specifier: ^25.6.0version: 25.6.0@@ -1235,6 +1241,35 @@ packages:'@manypkg/[email protected]':resolution: {integrity: sha512-fo+QhuU3qE/2TQMQmbVMqaQ6EWbMhi4ABWP+O4AM1NqPBuy0OrApV5LO6BrrgnhtAHS2NH6RrVk9OL181tTi8A==}+ '@mapbox/[email protected]':+ resolution: {integrity: sha512-0SElaV0uMxEnxzBhhX9WTuPyUeMsAN/SS0i16tjuba4/mio63MG9khjC1a0JAiPGXAwvwm4UfHJURCN7nyudQg==}+ engines: {node: '>= 22'}++ '@mapbox/[email protected]':+ resolution: {integrity: sha512-YGcBz1cg4ATXDCM/71L9xveh4dynfGmcLDqufR+nQQy3fKwsAZsWd/x4621/6uJaeB9mwOHE6hPeDgXz9uViUQ==}++ '@mapbox/[email protected]':+ resolution: {integrity: sha512-LVL4wgI9YAum5V+LNVQO6QgFBPw7/MIIY4XJPNsPDMrjEwcE+JfKk1LuIl8GnF197ejVdC9QdPaxrx5gfgdGXg==}++ '@mapbox/[email protected]':+ resolution: {integrity: sha512-fqd515fjBmANKGGsQ286E2Wvj/XvDFpGzwJxq4CI6jMQue6Oy04uCKp+JWKF00xRTmk6cEu1jPJ9p3xqH8YWqQ==}++ '@mapbox/[email protected]':+ resolution: {integrity: sha512-Qf10S1uIHMk20ri/IVBnpS+esUEkVaR5Hftmz88jTInrpmWgPGJfPe3LVjjlE77trLx8tH6qjTG7uWH9hIq/0Q==}++ '@maplibre/[email protected]':+ resolution: {integrity: sha512-FVMOcmSP/yqol45t7StApEyTL5/vmqBCuFhH9n+fFuINenhaX+YgHHIt1yJ86S8kln3uJLcMvmEU2cfn6E2eCQ==}++ '@maplibre/[email protected]':+ resolution: {integrity: sha512-QFKCXkOeSzOr8jF75jm6kySOg+dUvOehPhRi68gcOYPHb7U5JloUq0dJW0Y5/fZV8ygfT0Vp2RWodvq+fyxFWA==}+ hasBin: true++ '@maplibre/[email protected]':+ resolution: {integrity: sha512-ZeK5w2TTeHOajcLaEQs1KZXw2V9wIKo1PmThlxlsHoXsQsYlBqLJzPOd6tJHRtGTChUY3DPPmjXRArYVvAbmZw==}++ '@maplibre/[email protected]':+ resolution: {integrity: sha512-j6p0AdjvAR19Z3XaCysle7A4ZSo08tYOzxD0Y9NQylwPAkwJJeYub5b2eVucdeDh7erhv69DahoLOevDRERRUw==}+'@modelcontextprotocol/[email protected]':resolution: {integrity: sha512-zo37mZA9hJWpULgkRpowewez1y6ML5GsXJPY8FI0tBBCd77HEvza4jDqRKOXgHNn867PVGCyTdzqpz0izu5ZjQ==}engines: {node: '>=18'}@@ -2183,6 +2218,9 @@ packages:'@types/[email protected]':resolution: {integrity: sha512-GhdPgy1el4/ImP05X05Uw4cw2/M93BCUmnEvWZNStlCzEKME4Fkk+YpoA5OiHNQmoS7Cafb8Xa3Pya8m1Qrzeg==}+ '@types/[email protected]':+ resolution: {integrity: sha512-6C8nqWur3j98U6+lXDfTUWIfgvZU+EumvpHKcYjujKH7woYyLj2sUmff0tRhrqM7BohUw7Pz3ZB1jj2gW9Fvmg==}+'@types/[email protected]':resolution: {integrity: sha512-J8xLz7q2OFulZ2cyGTLE1TbbZcjpno7FaN6zdJNrgAdrJ+DZzh/uFR6YrTb4C+nXakvud8Q4+rbhoIWlYQbUFQ==}@@ -2677,6 +2715,9 @@ packages:resolution: {integrity: sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==}engines: {node: '>= 0.4'}+ resolution: {integrity: sha512-vnS4AVwp1KHAF13i1vp1/2D5evWy3k5u/iW/B81QVsUZtV8cv2tU0b2VNFlqvh4kYwrFMDdjPCfAmfyJW9y14Q==}+resolution: {integrity: sha512-wG99Zcfcys9fZux7Cft8BAX/YrOJLJSZ3jyYPfhZHqN2E+Ffx+QXBDsv3gubEgPtV6dTzJMSQUwk1H98/t/0wQ==}engines: {bun: '>=1', deno: '>=2', node: '>=16'}@@ -2934,6 +2975,9 @@ packages:resolution: {integrity: sha512-7tN6rFgBlMgpBML5j8typ92BKFi2sFQvIdpAqLA2beia5avZDrMs0FLZiM5etShWq5irVyGcGMEA1jcDaK7A/Q==}+ resolution: {integrity: sha512-latSnyDNt/8zYUB6VIJ6PCh2jBjJX6gnDsoCZ7LyW7GkqrD51EWwa9qCoGixj8YqBtETQK/xY7OmpTF8xz1DdQ==}+resolution: {integrity: sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==}engines: {node: '>= 6'}@@ -3184,6 +3228,9 @@ packages:resolution: {integrity: sha512-fQhoXdcvc3V28x7C7BMs4P5+kNlgUURe2jmUT1T//oBRMDrqy1QPelJimwZGo7Hg9VPV3EQV5Bnq4hbFy2vetA==}+ resolution: {integrity: sha512-3CNZ2DnrpByG9Nqj6Xo8vqbjT4F6N+tb4Gb28ESAZjYZ5yqvmc56J+/kuIwkaAMOyblTQhUW7PxMkUb8Q36N3Q==}+resolution: {integrity: sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==}engines: {node: '>=6'}@@ -3195,6 +3242,9 @@ packages:resolution: {integrity: sha512-zwOTdL3rFQ/lRdBnntKVOX6k5cKJwEc1HdilT71BWEu7J41gXIB2MRp+vxduPSwZJPWBxEzv4yH1wYLJGUHX4Q==}+ resolution: {integrity: sha512-e9vurzrXJQrFX6ckpHP3bvj5l+9CnYzkxDNnNQ1h2QTqdWsUAJgXiKdGNcOa1EY85dU8KbQ+z/FdQdB7P+9yfQ==}+resolution: {integrity: sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==}engines: {node: '>=6'}@@ -3320,6 +3370,10 @@ packages:resolution: {integrity: sha512-hXdUTZYIVOt1Ex//jAQi+wTZZpUpwBj/0QsOzqegb3rGMMeJiSEu5xLHnYfBrRV4RH2+OCSOO95Is/7x1WJ4bw==}engines: {node: '>=10'}+ resolution: {integrity: sha512-pCgDUsaYFuZwIH37aV2qF4m03nZPlW79DlqC+cQ+48tpqiqW2SJyA7fEOcFrS5ilDK493f0X3LxiH17T5BqV7g==}+ engines: {node: '>=16.14.0', npm: '>=8.1.0'}+resolution: {integrity: sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==}engines: {node: '>= 0.4'}@@ -3386,6 +3440,9 @@ packages:typescript:optional: true+ resolution: {integrity: sha512-TvmkNhkv8yct0SVBSy+o8wYzXjE4Zz3PCesbfs8HiCXXdcTuocApFv11UWlNFWKYsP2okqrhb7JNlSm9InBhIw==}+resolution: {integrity: sha512-dkEJPVvun4FryqBmZ5KhDo0K9iDXAwn08tMLDinNdRBNPcYEDiWYysLcc6k3mjTMlbP9KyylvRpd4wFtwrT9rw==}engines: {node: ^20.17.0 || >=22.9.0}@@ -3555,6 +3612,10 @@ packages:resolution: {integrity: sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==}+ resolution: {integrity: sha512-mnvGdvOrIvJOBGUEdGkrVXjN8E/VkIJCkf2eS1DH2yv82ORUlLttmDt0rWY38yYZmVwciZwBUvHM20qxBZf40w==}+ hasBin: true+resolution: {integrity: sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==}@@ -3617,6 +3678,9 @@ packages:resolution: {integrity: sha512-FfR8sjd4em2T6fb3I2MwAJU7HWVMr9zba+enmQeeWFfCbm+UOC/0X4DS8XtpUTMwWMGbjKYP7xjfNekzyGmB3A==}engines: {node: ^10 || ^12 || >=14}+ resolution: {integrity: sha512-pcaShQc1Shq0y+E7GqJqvZj8DTthWV1KeHGdi0Z6IAin2Oi3JnLCOfwnCo84qc+HAp52wT9nK9H7FAJp5a44GQ==}+resolution: {integrity: sha512-dM0jVuXJPsDN6DvRpea484tCUaMiXWjuCn++HGTqUWzGDjv5tZkEZldAJ/UMlqRYGFrD/etByo4/xOuC/snX2A==}engines: {node: '>=20'}@@ -3675,6 +3739,9 @@ packages:resolution: {integrity: sha512-TnKDdohEatgyZNGCDWIdccOHXhYloJwbwU+phw/a23KBvJIR9lWQWW7WHHK3vBdOLDNuF7TaX98GObUZOWkOnA==}+ resolution: {integrity: sha512-VG2K63Igkiv9p76tk1lilczEK1cT+kCjKtkdhw1dQZV3k3IXJbd3o6Ho8b9zJZaHSnT2hKe4I+ObmX9w6m5SmQ==}+resolution: {integrity: sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg==}engines: {node: '>= 0.10'}@@ -3689,6 +3756,9 @@ packages:resolution: {integrity: sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==}+ resolution: {integrity: sha512-XdjUArbK4Bm5fLLvlm5KpTFOiOThgfWWI4axAZDWg4E/0mKdZyI9tNEfds27qCi1ze/vwTR16kvmmGhRra3c2g==}+resolution: {integrity: sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==}engines: {node: '>= 0.6'}@@ -3839,6 +3909,9 @@ packages:resolution: {integrity: sha512-seS2Tj26TBVOC2NIc2rOe2y2ZO7efxITtLZcGSOnHHNOQ7CkiUBfw0Iw2ck6xkIhPwLhKNLS8BO+hEpngQlqzw==}+ resolution: {integrity: sha512-kI5ffTiZWmJaS/huM8wZfEMer1eRd7oJQhDuxeCLe3t7N7mX3z94CN0xPxBQxFYQTSNz9T0i+v6inKqSdK8xrQ==}+resolution: {integrity: sha512-oMA2dcrw6u0YfxJQXm342bFKX/E4sG9rbTzO9ptUcR/e8A33cHuvStiYOwH7fszkZlZ1z/ta9AAoPk2F4qIOHA==}engines: {node: '>=18'}@@ -4093,6 +4166,9 @@ packages:resolution: {integrity: sha512-wXR/dYpcqKmfWpEdZjiKJOwCNFndD0DMnrW/cYjVGttEkBfVgcLFHoNrlj47mjOVic9yyNu65alsgF4NQyTa2g==}engines: {node: '>=12.0.0'}+ resolution: {integrity: sha512-gRa9gwYU3ECmQYv3lslts5hxuIa90veaEcxDYuu3QGOIAEM2mOZkVHp48ANJuu1CURtRdHKUBY5Lm1tHV+sD4g==}+resolution: {integrity: sha512-Bf+ILmBgretUrdJxzXM0SgXLZ3XfiaUuOj/IKQHuTXip+05Xn+uyEYdVg0kYDipTBcLrCVyUzAPz7QmArb0mmw==}engines: {node: '>=14.0.0'}@@ -5082,6 +5158,43 @@ snapshots:globby: 11.1.0read-yaml-file: 2.1.0+ '@mapbox/[email protected]': {}++ '@mapbox/[email protected]': {}++ '@mapbox/[email protected]': {}++ '@mapbox/[email protected]': {}++ '@mapbox/[email protected]':+ dependencies:+ '@mapbox/point-geometry': 1.1.0+ '@types/geojson': 7946.0.16+ pbf: 5.1.2++ '@maplibre/[email protected]':+ dependencies:+ kdbush: 4.1.0++ '@maplibre/[email protected]':+ dependencies:+ '@mapbox/jsonlint-lines-primitives': 2.0.3+ '@mapbox/unitbezier': 1.0.0+ json-stringify-pretty-compact: 4.0.0+ minimist: 1.2.8+ quickselect: 3.0.0+ tinyqueue: 3.0.0++ '@maplibre/[email protected]':+ dependencies:+ '@mapbox/point-geometry': 1.1.0++ '@maplibre/[email protected]':+ dependencies:+ '@mapbox/point-geometry': 1.1.0+ '@types/geojson': 7946.0.16+ pbf: 5.1.2+'@modelcontextprotocol/[email protected]([email protected])':dependencies:'@hono/node-server': 1.19.14([email protected])@@ -5887,6 +6000,8 @@ snapshots:'@types/[email protected]': {}+ '@types/[email protected]': {}+'@types/[email protected]': {}'@types/[email protected]':@@ -6322,6 +6437,8 @@ snapshots:es-errors: 1.3.0gopd: 1.2.0+ [email protected]: {}+dependencies:'@ecies/ciphers': 0.2.6(@noble/[email protected])@@ -6631,6 +6748,8 @@ snapshots:dependencies:resolve-pkg-maps: 1.0.0+ [email protected]: {}+dependencies:is-glob: 4.0.3@@ -6814,6 +6933,8 @@ snapshots:+ [email protected]: {}+@@ -6826,6 +6947,8 @@ snapshots:optionalDependencies:graceful-fs: 4.2.11+ [email protected]: {}+@@ -6920,6 +7043,26 @@ snapshots:dependencies:semver: 7.7.4+ dependencies:+ '@mapbox/point-geometry': 1.1.0+ '@mapbox/tiny-sdf': 2.2.0+ '@mapbox/unitbezier': 1.0.0+ '@mapbox/vector-tile': 3.0.0+ '@maplibre/geojson-vt': 6.1.1+ '@maplibre/maplibre-gl-style-spec': 26.2.1+ '@maplibre/mlt': 1.1.12+ '@maplibre/vt-pbf': 4.3.2+ '@types/geojson': 7946.0.16+ earcut: 3.2.3+ gl-matrix: 3.4.4+ kdbush: 4.1.0+ murmurhash-js: 1.0.0+ pbf: 5.1.2+ potpack: 2.1.0+ quickselect: 3.0.0+ tinyqueue: 3.0.0+@@ -6987,6 +7130,8 @@ snapshots:transitivePeerDependencies:- '@types/node'+ [email protected]: {}+@@ -7131,6 +7276,10 @@ snapshots:+ dependencies:+ resolve-protobuf-schema: 2.1.0+@@ -7181,6 +7330,8 @@ snapshots:picocolors: 1.1.1source-map-js: 1.2.1+ [email protected]: {}+@@ -7265,6 +7416,8 @@ snapshots:prosemirror-state: 1.4.4prosemirror-transform: 1.12.0+ [email protected]: {}+dependencies:forwarded: 0.2.0@@ -7278,6 +7431,8 @@ snapshots:+ [email protected]: {}+@@ -7417,6 +7572,10 @@ snapshots:+ dependencies:+ protocol-buffers-schema: 3.6.1+dependencies:onetime: 7.0.0@@ -7740,6 +7899,8 @@ snapshots:fdir: 6.5.0([email protected])picomatch: 4.0.4+ [email protected]: {}+