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
Fix: SDK examples are typechecked in CI (#14878)
Damian Legawiec013d30402f7d
diff --git a/docs/api-reference/seller.yaml b/docs/api-reference/seller.yamlindex 981711485c..d2300389a2 100644--- a/docs/api-reference/seller.yaml+++ b/docs/api-reference/seller.yaml@@ -75,6 +75,20 @@ paths:defaults to `email`. Sellers and store staff read different providerregistries, so a marketplace can require SSO for its own back officewhile still letting sellers sign in with a password.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ })++ const auth = await client.auth.login({+ email: '[email protected]',+ password: 'password123',+ })parameters: []responses:'200':@@ -128,6 +142,17 @@ paths:storefront or the back office cannot be exchanged for a seller session.Membership is rechecked here too: a user whose last seller role wasrevoked mid-session is refused rather than renewed.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ })++ const auth = await client.auth.refresh()responses:'200':description: refresh successful@@ -166,6 +191,17 @@ paths:tags:- Authenticationdescription: Revokes the refresh-token cookie, ending the seller session.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ })++ await client.auth.logout()responses:'204':description: logout successful@@ -178,6 +214,17 @@ paths:The sign-in methods this marketplace offers sellers, for the login pageto render. Unauthenticated — a login page must be able to ask beforeanyone has signed in.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ })++ const { providers } = await client.auth.providers()responses:'200':description: providers listed@@ -212,6 +259,17 @@ paths:invitation: both answer `404`, so the endpoint cannot be used toenumerate. An invitation onto the store's own staff rather than a selleranswers `404` here too.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ })++ const invitation = await client.auth.lookupInvitation('inv_xxx', 'token-from-email')parameters:- name: tokenin: query@@ -266,6 +324,22 @@ paths:`password` is required when no account exists for the invited address, inwhich case it sets one. When an account already exists, the same field ishow the person proves the account is theirs.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ })++ const auth = await client.auth.acceptInvitation('inv_xxx', 'token-from-email', {+ password: 'password123',+ password_confirmation: 'password123',+ first_name: 'Jane',+ last_name: 'Doe',+ })parameters:- name: tokenin: query@@ -331,6 +405,20 @@ paths:email is delivered by Spree via the`seller_user.password_reset_requested` event, which is never forwardedto webhook endpoints.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ })++ await client.auth.requestPasswordReset({+ email: '[email protected]',+ redirect_url: 'https://sellers.your-store.com/reset-password',+ })parameters: []responses:'202':@@ -360,6 +448,20 @@ paths:The token is single-use, and resetting revokes every other session theaccount holds. A token whose seller membership has since been revoked isrefused exactly as an expired one.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ })++ const auth = await client.auth.resetPassword('reset-token-from-email', {+ password: 'new-password-123',+ password_confirmation: 'new-password-123',+ })parameters:- name: idin: path@@ -421,6 +523,18 @@ paths:Sending the header narrows `permission_keys` and `permissions` to thatseller; without it both are empty, because capability is per seller andthere is no answer spanning all of them.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ })++ const me = await client.me.get()parameters:- name: X-Spree-Seller-Idin: header@@ -683,6 +797,22 @@ paths:`avatar_signed_id` takes the `signed_id` from `POST /files` to set thephoto, or `null` to remove it; omit it to leave the current one alone.`email` is identity-bound and cannot be changed here.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ })++ const me = await client.me.update({+ first_name: 'Jane',+ last_name: 'Doe',+ selected_locale: 'en',+ })parameters: []responses:'200':@@ -754,6 +884,19 @@ paths:in a billing address needs every country.Unpaginated. An address dropdown needs all ~250 at once.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: countries } = await client.countries.list()parameters:- name: X-Spree-Seller-Idin: header@@ -12338,6 +12481,19 @@ paths:A shared marketplace method comes back with `editable: false` — it islisted so the seller can see what already ships their goods, and everywrite against it is a 404.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: deliveryMethods } = await client.deliveryMethods.list()parameters:- name: X-Spree-Seller-Idin: header@@ -12487,6 +12643,23 @@ paths:Neither the rate provider nor the fulfillment provider is settable: aseller prices their own rates and enters tracking numbers by hand,because carrier accounts belong to the marketplace.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const deliveryMethod = await client.deliveryMethods.create({+ name: 'Next day',+ delivery_profile_id: 'fp_UkLWZg9DAJ',+ calculator: { type: 'flat_rate', preferences: { amount: '9.99', currency: 'USD' } },+ })parameters:- name: X-Spree-Seller-Idin: header@@ -12562,6 +12735,19 @@ paths:- Delivery Methodssecurity:- bearer_auth: []+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const deliveryMethod = await client.deliveryMethods.get('dm_UkLWZg9DAJ')responses:'200':description: delivery method found@@ -12601,6 +12787,23 @@ paths:- bearer_auth: []description: Only the seller's own methods can be changed — a marketplace methodshared with sellers is read-only.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const deliveryMethod = await client.deliveryMethods.update('dm_UkLWZg9DAJ', {+ name: 'Next day (tracked)',+ estimated_transit_business_days_min: 1,+ estimated_transit_business_days_max: 2,+ })parameters: []responses:'200':@@ -12645,6 +12848,19 @@ paths:- Delivery Methodssecurity:- bearer_auth: []+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ await client.deliveryMethods.delete('dm_UkLWZg9DAJ')responses:'204':description: delivery method retired@@ -12657,6 +12873,19 @@ paths:- bearer_auth: []description: The eligibility rules a seller may put on their own method, withthe preference schema each form is rendered from.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: ruleTypes } = await client.deliveryMethods.ruleTypes()parameters:- name: X-Spree-Seller-Idin: header@@ -12763,6 +12992,19 @@ paths:- Delivery Methodssecurity:- bearer_auth: []+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: calculators } = await client.deliveryMethods.calculators()parameters:- name: X-Spree-Seller-Idin: header@@ -12944,6 +13186,19 @@ paths:the profiles themselves, and the zones and methods behind them, are themarketplace's. A product created without one lands on the profilemarked `default`.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: deliveryProfiles } = await client.deliveryProfiles.list()parameters:- name: X-Spree-Seller-Idin: header@@ -13052,6 +13307,21 @@ paths:draws one. Pass `delivery_profile_id` to list only the zones under theprofile a method belongs to, which is what the method form's pickerasks for.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: deliveryZones } = await client.deliveryZones.list({+ delivery_profile_id: 'fp_UkLWZg9DAJ',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -13164,6 +13434,19 @@ paths:Each requirement's `id` is what a submission is posted against. Amarketplace that asks for nothing returns an empty list, which is acomplete answer rather than a missing one.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const onboarding = await client.onboarding.get()parameters:- name: X-Spree-Seller-Idin: header@@ -13208,6 +13491,19 @@ paths:message names the blocking requirements, and the seller's status isunchanged. Returns the same payload as the checklist so the panel canre-render from one response.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const onboarding = await client.onboarding.submitForReview()parameters:- name: X-Spree-Seller-Idin: header@@ -13249,6 +13545,22 @@ paths:what it needs before it will pay this seller. Ask for it when theseller acts: these links are short-lived and single-use. Answers`{ "url": null }` when the provider hosts no onboarding.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const link = await client.onboarding.payoutAccount({+ refresh_url: 'https://sellers.your-store.com/onboarding',+ return_url: 'https://sellers.your-store.com/onboarding',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -13296,6 +13608,21 @@ paths:An attestation is accepted on the spot; a requirement the operatorreviews comes back `pending`.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const submission = await client.requirementSubmissions.create('selreq_xxx', {+ note: 'Confirmed.',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -13356,6 +13683,36 @@ paths:Served through the API rather than from a storage URL on purpose: theseare identity and registration documents, so every read is authorizedagainst the acting seller. Another seller's submission answers `404`.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ // The onboarding checklist carries each requirement's latest submission.+ const { requirements } = await client.onboarding.get()+ const submission = requirements.find((requirement) => requirement.submission?.file_url)?.submission++ if (submission?.file_url) {+ // Documents are served through the API, so fetch with the session's token+ // and seller, then drive the browser download:+ const response = await fetch(`https://your-store.com${submission.file_url}`, {+ headers: { Authorization: 'Bearer eyJhbGciOi...', 'X-Spree-Seller-Id': 'sel_UkLWZg9DAJ' },+ })+ const url = URL.createObjectURL(await response.blob())+ const link = Object.assign(document.createElement('a'), {+ href: url,+ download: submission.file_name ?? 'document',+ })+ link.click()+ URL.revokeObjectURL(url)+ }parameters:- name: X-Spree-Seller-Idin: header@@ -13388,6 +13745,19 @@ paths:policies and every other seller's are invisible here. A seller startswith none: what they are expected to publish is decided by themarketplace's onboarding checklist.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: policies } = await client.policies.list()parameters:- name: X-Spree-Seller-Idin: header@@ -13495,6 +13865,22 @@ paths:When the marketplace requires a named policy, use that exact name —the onboarding check matches on it.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const policy = await client.policies.create({+ name: 'Returns Policy',+ body: '<p>Return anything unopened within 30 days.</p>',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -13537,6 +13923,19 @@ paths:security:- bearer_auth: []description: Returns one of this seller's policies, by prefixed ID or slug.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const policy = await client.policies.get('returns-policy')parameters:- name: X-Spree-Seller-Idin: header@@ -13575,6 +13974,21 @@ paths:security:- bearer_auth: []description: Rewrites one of this seller's policies.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const policy = await client.policies.update('returns-policy', {+ body: '<p>Return anything unopened within 60 days.</p>',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -13609,6 +14023,19 @@ paths:security:- bearer_auth: []description: Withdraws one of this seller's policies.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ await client.policies.delete('returns-policy')parameters:- name: X-Spree-Seller-Idin: header@@ -13632,6 +14059,22 @@ paths:and its delivery profile, so a seller picks one when listing; definingtypes is the marketplace's. Send the chosen `id` as `product_type_id`on the product.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: productTypes } = await client.productTypes.list({+ name_cont: 'apparel',+ sort: 'name',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -13726,6 +14169,19 @@ paths:- Product Typessecurity:- bearer_auth: []+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const productType = await client.productTypes.get('pt_UkLWZg9DAJ')parameters:- name: X-Spree-Seller-Idin: header@@ -13762,6 +14218,23 @@ paths:Every call is rooted in the acting seller server-side, so this can neverreturn another seller's product or one the marketplace operator sellsfirst-party.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: products, meta } = await client.products.list({+ status_eq: 'draft',+ sort: '-created_at',+ limit: 25,+ })parameters:- name: X-Spree-Seller-Idin: header@@ -14023,6 +14496,23 @@ paths:The operator's own settings — tax category, delivery profile and whetherthe product is promotionable — are not writable here; they belong to themarketplace, not the seller.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const product = await client.products.create({+ name: 'Hand-thrown mug',+ description: '<p>Stoneware, glazed by hand.</p>',+ prices: [{ currency: 'USD', amount: '24.00' }],+ })parameters:- name: X-Spree-Seller-Idin: header@@ -14109,6 +14599,19 @@ paths:An id belonging to another seller answers `404`, not `403` — the selleris not told the record exists.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const product = await client.products.get('prod_UkLWZg9DAJ', 'variants,media')parameters:- name: X-Spree-Seller-Idin: header@@ -14184,6 +14687,21 @@ paths:security:- bearer_auth: []description: Edits a product the acting seller owns.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const product = await client.products.update('prod_UkLWZg9DAJ', {+ name: 'Hand-thrown mug, large',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -14251,6 +14769,19 @@ paths:security:- bearer_auth: []description: Deletes a product the acting seller owns.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ await client.products.delete('prod_UkLWZg9DAJ')parameters:- name: X-Spree-Seller-Idin: header@@ -14272,6 +14803,21 @@ paths:rejected listings can be submitted, so a mixed selection moves what itcan: `product_count` is what was submitted, and `skipped_count`, presentonly when something was skipped, is the rest.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const result = await client.products.bulkSubmit({+ ids: ['prod_UkLWZg9DAJ', 'prod_9XbR2kQwLm'],+ })parameters:- name: X-Spree-Seller-Idin: header@@ -14301,6 +14847,22 @@ paths:description: |Moves a selection to `draft` or `archived`. There is no bulk route onto`active`: a listing goes on sale when the marketplace approves it.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const result = await client.products.bulkStatusUpdate({+ ids: ['prod_UkLWZg9DAJ', 'prod_9XbR2kQwLm'],+ status: 'archived',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -14333,6 +14895,19 @@ paths:Singular by nature: the seller in play is always the one named by`X-Spree-Seller-Id`, never an id in the path — so a seller cannot addressanother seller here even by guessing one.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const profile = await client.profile.get()parameters:- name: X-Spree-Seller-Idin: header@@ -14406,6 +14981,23 @@ paths:`custom_fields` is narrowed server-side to the definitions thismarketplace's onboarding actually asks this seller for; a field nothingasked for is ignored rather than written.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const profile = await client.profile.update({+ name: 'Acme Outfitters',+ contact_email: '[email protected]',+ legal_name: 'Acme Outfitters Ltd',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -14479,6 +15071,19 @@ paths:Rooted in the acting seller, so the marketplace operator's own warehousesnever appear here.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: stockLocations } = await client.stockLocations.list()parameters:- name: X-Spree-Seller-Idin: header@@ -14617,6 +15222,26 @@ paths:The seller and the store come from the request context whatever thepayload says.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const stockLocation = await client.stockLocations.create({+ name: 'Brooklyn warehouse',+ kind: 'warehouse',+ country_code: 'US',+ state_code: 'NY',+ city: 'Brooklyn',+ zipcode: '11201',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -14688,6 +15313,19 @@ paths:description: |A stock location the acting seller owns. An id belonging to anotherseller — or to the marketplace operator — answers `404`.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const stockLocation = await client.stockLocations.get('sloc_UkLWZg9DAJ')parameters:- name: X-Spree-Seller-Idin: header@@ -14745,6 +15383,22 @@ paths:There is no delete: a location holds stock levels and is named onhistorical fulfillments, so a seller retires one by setting `active` to`false`.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const stockLocation = await client.stockLocations.update('sloc_UkLWZg9DAJ', {+ returns_enabled: true,+ phone: '+1 718 555 0100',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -14801,6 +15455,19 @@ paths:Sending an invitation lives on `team`, because that is hiring. Chasing orwithdrawing one is bookkeeping on the offer itself, so it lives here.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: invitations } = await client.invitations.list()parameters:- name: X-Spree-Seller-Idin: header@@ -14847,6 +15514,19 @@ paths:The link a colleague opens to join the team. It carries the invitation'stoken, so the listing never includes it; fetch it when someone asks tocopy the link.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const link = await client.invitations.acceptanceLink('inv_xxx')parameters:- name: X-Spree-Seller-Idin: header@@ -14881,6 +15561,19 @@ paths:Sends the invitation email again, for a colleague who never got the firstone. An invitation whose window has closed is refused rather thanre-sent.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const invitation = await client.invitations.resend('inv_xxx')parameters:- name: X-Spree-Seller-Idin: header@@ -14926,6 +15619,19 @@ paths:security:- bearer_auth: []description: Withdraws an offer that has not been accepted.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ await client.invitations.revoke('inv_xxx')parameters:- name: X-Spree-Seller-Idin: header@@ -14957,6 +15663,19 @@ paths:Rooted at the acting seller throughout, so a seller only ever sees theirown team. Unpaginated — a seller's team is small by nature.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: members } = await client.team.list()parameters:- name: X-Spree-Seller-Idin: header@@ -15002,6 +15721,21 @@ paths:The role is not a parameter. Every member holds the seller's own seededrole, which already carries the whole seller vocabulary.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const invitation = await client.team.invite({+ email: '[email protected]',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -15062,6 +15796,19 @@ paths:The team can never reach zero: emptying it would leave a seller nobodycan sign in to, and only the marketplace operator could put someone back.The last remaining member is refused with `422`.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ await client.team.remove('adm_xxx')parameters:- name: X-Spree-Seller-Idin: header@@ -15114,6 +15861,24 @@ paths:upload. `visibility` is `public` (the default, web images, videos andCSV only) or `private` (any type). `checksum` is the file's MD5digest, base64-encoded.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const file = await client.files.create({+ filename: 'registration.pdf',+ content_type: 'application/pdf',+ byte_size: 51234,+ visibility: 'private',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -15164,6 +15929,19 @@ paths:Computed from the ledger rather than stored, so the rows carry no idand there is nothing to page.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: balances } = await client.balances.list()parameters:- name: X-Spree-Seller-Idin: header@@ -15209,6 +15987,19 @@ paths:security:- bearer_auth: []description: Problems reported on one of this seller's orders.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: claims } = await client.orders.claims.list('or_UkLWZg9DAJ')parameters:- name: X-Spree-Seller-Idin: header@@ -15304,6 +16095,22 @@ paths:A replacement variant, if one is offered, comes from this seller's owncatalogue — a rival's is not theirs to promise.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const claim = await client.orders.claims.create('or_UkLWZg9DAJ', {+ items: [{ line_item_id: 'li_UkLWZg9DAJ', quantity: 1, description: 'Arrived damaged' }],+ reason_id: 'clr_UkLWZg9DAJ',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -15355,6 +16162,19 @@ paths:security:- bearer_auth: []description: Accepts that the claim is good.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const claim = await client.orders.claims.approve('or_UkLWZg9DAJ', 'claim_UkLWZg9DAJ')parameters:- name: X-Spree-Seller-Idin: header@@ -15404,6 +16224,23 @@ paths:A refund is bounded by this order's share of the payment, so oneseller can never settle out of a sibling's money.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const claim = await client.orders.claims.resolve('or_UkLWZg9DAJ', 'claim_UkLWZg9DAJ', {+ resolution: 'refund',+ refund_method: 'original_payment',+ amount: '19.99',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -15455,6 +16292,21 @@ paths:security:- bearer_auth: []description: Turns the claim down.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const claim = await client.orders.claims.deny('or_UkLWZg9DAJ', 'claim_UkLWZg9DAJ', {+ reason: 'Reported after the claim window closed',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -15505,6 +16357,21 @@ paths:security:- bearer_auth: []description: Withdraws a claim that is no longer needed.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const claim = await client.orders.claims.cancel('or_UkLWZg9DAJ', 'claim_UkLWZg9DAJ', {+ reason: 'Customer found the missing item',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -15547,6 +16414,19 @@ paths:What can go wrong with a delivery, as the marketplace defines it.Read-only: a seller picks from the operator's vocabulary.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: reasons } = await client.claimReasons.list()parameters:- name: X-Spree-Seller-Idin: header@@ -15630,6 +16510,19 @@ paths:security:- bearer_auth: []description: Goods swapped for different ones on one of this seller's orders.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: exchanges } = await client.orders.exchanges.list('or_UkLWZg9DAJ')parameters:- name: X-Spree-Seller-Idin: header@@ -15725,6 +16618,24 @@ paths:The replacement comes from this seller's own catalogue: it is stockthey will send, so a variant belonging to another seller is not theirsto promise and reads as missing.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const exchange = await client.orders.exchanges.create('or_UkLWZg9DAJ', {+ items: [+ { fulfillment_item_id: 'fi_UkLWZg9DAJ', new_variant_id: 'variant_86Rf07xd4z', quantity: 1 },+ ],+ reason_id: 'rar_UkLWZg9DAJ',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -15778,6 +16689,21 @@ paths:description: |Records the goods coming back. Send the rows that actually arrived fora partial or damaged receipt; omit them to receive everything.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const exchange = await client.orders.exchanges.receive('or_UkLWZg9DAJ', 'exch_UkLWZg9DAJ', {+ items: [{ exchange_line_item_id: 'eli_UkLWZg9DAJ', quantity: 1, resellable: true }],+ })parameters:- name: X-Spree-Seller-Idin: header@@ -15830,6 +16756,19 @@ paths:description: |Sends the replacement goods, settling any price difference at the sametime — which is why it takes a refund method.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const exchange = await client.orders.exchanges.fulfill('or_UkLWZg9DAJ', 'exch_UkLWZg9DAJ')parameters:- name: X-Spree-Seller-Idin: header@@ -15880,6 +16819,21 @@ paths:security:- bearer_auth: []description: Withdraws an exchange before the goods come back.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const exchange = await client.orders.exchanges.cancel('or_UkLWZg9DAJ', 'exch_UkLWZg9DAJ', {+ reason: 'Customer kept the original',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -15928,6 +16882,22 @@ paths:Generation runs in the background: poll `GET /api/v3/seller/exports/{id}`until `done` is true, then fetch `download_url`.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const exp = await client.exports.create({+ type: 'orders',+ search_params: { completed_at_gt: '2026-01-01' },+ })parameters:- name: X-Spree-Seller-Idin: header@@ -15986,6 +16956,19 @@ paths:description: |Reads one of this seller's exports. Poll this until `done` is true,then fetch `download_url`.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const exp = await client.exports.get('exp_UkLWZg9DAJ')parameters:- name: X-Spree-Seller-Idin: header@@ -16040,6 +17023,39 @@ paths:The bytes are served by this endpoint rather than through a redirect,so the seller's own session authorizes every download.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ // An export is built in the background; poll until it is done.+ let exp = await client.exports.get('exp_UkLWZg9DAJ')+ while (!exp.done) {+ await new Promise((resolve) => setTimeout(resolve, 2000))+ exp = await client.exports.get(exp.id)+ }++ if (exp.download_url) {+ // Exports are served through the API, so fetch with the session's token+ // and seller, then drive the browser download:+ const response = await fetch(`https://your-store.com${exp.download_url}`, {+ headers: { Authorization: 'Bearer eyJhbGciOi...', 'X-Spree-Seller-Id': 'sel_UkLWZg9DAJ' },+ })+ const url = URL.createObjectURL(await response.blob())+ const link = Object.assign(document.createElement('a'), {+ href: url,+ download: exp.filename ?? 'export.csv',+ })+ link.click()+ URL.revokeObjectURL(url)+ }parameters:- name: X-Spree-Seller-Idin: header@@ -16089,6 +17105,19 @@ paths:Reached through the order, which is itself fetched through the actingseller — so a fulfillment on somebody else's order is unreachablewhatever ids are sent.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: fulfillments } = await client.orders.fulfillments.list('or_UkLWZg9DAJ')parameters:- name: X-Spree-Seller-Idin: header@@ -16227,6 +17256,23 @@ paths:`items` narrows the dispatch to part of what the fulfillment holds; theremainder splits onto a new one. Omit it to ship the lot.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const fulfillment = await client.orders.fulfillments.fulfill('or_UkLWZg9DAJ', 'ful_UkLWZg9DAJ', {+ tracking: '1Z879E930346834440',+ tracking_carrier: 'ups',+ notify_customer: true,+ })parameters:- name: X-Spree-Seller-Idin: header@@ -16314,6 +17360,22 @@ paths:Adds or corrects the tracking number and its carrier. Can also move theparcel to another of the seller's own stock locations, which quotes itsrates again from there, or pick a different one of its quoted rates.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const fulfillment = await client.orders.fulfillments.update('or_UkLWZg9DAJ', 'ful_UkLWZg9DAJ', {+ tracking: '1Z879E930346834440',+ tracking_carrier: 'ups',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -16401,6 +17463,19 @@ paths:description: |A parcel this seller is not going to send after all. The goods go backon the shelf and the carrier is stood down.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const fulfillment = await client.orders.fulfillments.cancel('or_UkLWZg9DAJ', 'ful_UkLWZg9DAJ')parameters:- name: X-Spree-Seller-Idin: header@@ -16483,6 +17558,26 @@ paths:Moves part of what this parcel holds onto a new one, for goods leavingseparately. Answers with every fulfillment on the order, sincesplitting rewrites more than one.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: fulfillments } = await client.orders.fulfillments.split(+ 'or_UkLWZg9DAJ',+ 'ful_UkLWZg9DAJ',+ {+ variant_id: 'variant_86Rf07xd4z',+ quantity: 1,+ },+ )parameters:- name: X-Spree-Seller-Idin: header@@ -16604,6 +17699,22 @@ paths:- bearer_auth: []description: The consignments of one of this seller's parcels, one per trackingnumber, with each carrier status.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: deliveries } = await client.orders.fulfillments.deliveries.list(+ 'or_UkLWZg9DAJ',+ 'ful_UkLWZg9DAJ',+ )parameters:- name: X-Spree-Seller-Idin: header@@ -16706,6 +17817,26 @@ paths:- bearer_auth: []description: 'Adds a tracked consignment to the parcel: a second box, or a freightnumber covering several pallets.'+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const delivery = await client.orders.fulfillments.deliveries.create(+ 'or_UkLWZg9DAJ',+ 'ful_UkLWZg9DAJ',+ {+ tracking_number: '1Z879E930346834440',+ carrier: 'ups',+ },+ )parameters:- name: X-Spree-Seller-Idin: header@@ -16766,6 +17897,24 @@ paths:- bearer_auth: []description: Corrects the tracking number, carrier or link. A corrected numberstarts the carrier journey over.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const delivery = await client.orders.fulfillments.deliveries.update(+ 'or_UkLWZg9DAJ',+ 'ful_UkLWZg9DAJ',+ 'dlv_UkLWZg9DAJ',+ { tracking_number: '1Z879E930346834441' },+ )parameters:- name: X-Spree-Seller-Idin: header@@ -16820,6 +17969,22 @@ paths:- bearer_auth: []description: Every label bought or uploaded for one of this seller's parcels,refunded ones included.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: labels } = await client.orders.fulfillments.labels.list(+ 'or_UkLWZg9DAJ',+ 'ful_UkLWZg9DAJ',+ )parameters:- name: X-Spree-Seller-Idin: header@@ -16935,6 +18100,24 @@ paths:`POST /files` first and send its `signed_id` as `file_signed_id`.Buying a label needs the marketplace's carrier account, so a requestwithout a file is refused.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const label = await client.orders.fulfillments.labels.create('or_UkLWZg9DAJ', 'ful_UkLWZg9DAJ', {+ file_signed_id: 'signed_id_from_files_upload',+ tracking_number: '1Z879E930346834440',+ cost: '6.50',+ currency: 'USD',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -16985,6 +18168,19 @@ paths:description: |The carriers a tracking number can be pinned to, from the registry —so a carrier an extension adds appears without a client change.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: carriers } = await client.trackingCarriers.list()parameters:- name: X-Spree-Seller-Idin: header@@ -17056,6 +18252,22 @@ paths:- bearer_auth: []description: This seller's product CSV imports, queued or finished. Anotherseller's imports are never listed.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: imports } = await client.imports.list({+ status_eq: 'completed',+ sort: '-created_at',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -17314,6 +18526,22 @@ paths:`attachment_signed_id`. On success the import is in the `mapping` state, carryingthe auto-assigned column `mappings`; confirm them with`PATCH /imports/{id}/complete_mapping`. Imported products are created as drafts.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const productImport = await client.imports.create({+ type: 'products',+ attachment_signed_id: 'eyJfcmFpbHMiOnsiZGF0YSI6MTIzLCJwdXIiOiJibG9iX2lkIn19--4b9d',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -17694,6 +18922,21 @@ paths:- bearer_auth: []description: The rows of one of this seller's imports, each with its statusand any validation errors.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: rows } = await client.imports.rows.list('imp_UkLWZg9DAJ', {+ status_eq: 'failed',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -17805,6 +19048,21 @@ paths:Applies the submitted column mappings, then starts row processing. Omit `mappings`to accept the auto-assigned ones from the create response. Returns 422 when arequired field is left unmapped (`details.missing_required_fields`).+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const productImport = await client.imports.completeMapping('imp_UkLWZg9DAJ', {+ mappings: [{ schema_field: 'name', file_column: 'Product name' }],+ })parameters:- name: X-Spree-Seller-Idin: header@@ -18177,6 +19435,23 @@ paths:Checkouts still in flight are left out: until one completes it isnobody's order.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: orders, meta } = await client.orders.list({+ fulfillment_status_eq: 'unfulfilled',+ sort: '-completed_at',+ limit: 25,+ })parameters:- name: X-Spree-Seller-Idin: header@@ -18464,6 +19739,19 @@ paths:How the customer paid the marketplace is deliberately absent — that isbetween the buyer and the operator.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const order = await client.orders.get('or_UkLWZg9DAJ', { expand: ['payment_splits'] })parameters:- name: X-Spree-Seller-Idin: header@@ -18643,6 +19931,23 @@ paths:There is no `refund_amount`: withdrawing from the whole order returnswhat that order was paid, and a partial figure is a return.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const order = await client.orders.cancel('or_UkLWZg9DAJ', {+ cancel_reason_id: 'ocr_UkLWZg9DAJ',+ cancel_note: 'Out of stock with the supplier',+ refund_payments: true,+ })parameters:- name: X-Spree-Seller-Idin: header@@ -18814,6 +20119,21 @@ paths:This is the only write against the order itself besides cancelling:nothing else about it, its totals included, is the seller's to change.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const order = await client.orders.address('or_UkLWZg9DAJ', {+ shipping_address: { address1: '9 Corrected Way', city: 'Portland', postal_code: '97201' },+ })parameters:- name: X-Spree-Seller-Idin: header@@ -18994,6 +20314,19 @@ paths:A marketplace basket splits into one order per seller, so the internalnote here is this seller's alone rather than the operator's note aboutthe whole sale.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const order = await client.orders.notes.get('or_UkLWZg9DAJ')parameters:- name: X-Spree-Seller-Idin: header@@ -19149,6 +20482,21 @@ paths:`internal_note` accepts HTML and is sanitized on save;`internal_note_html` reads it back.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const order = await client.orders.notes.update('or_UkLWZg9DAJ', {+ internal_note: '<p>Packed with the fragile insert.</p>',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -19321,6 +20669,19 @@ paths:Read-only: a seller picks one when cancelling, and the operator decideswhat the list holds. Retired reasons are left out.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: reasons } = await client.orderCancellationReasons.list()parameters:- name: X-Spree-Seller-Idin: header@@ -19408,6 +20769,19 @@ paths:The row marked `default` is the box this seller's parcels are quotedwith — its size and weight are added to every rate.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: packageTypes } = await client.packageTypes.list({ owner: 'mine' })parameters:- name: X-Spree-Seller-Idin: header@@ -19550,6 +20924,28 @@ paths:makes it the box their parcels are quoted with, and demotes whicheverof their rows held the flag before — the marketplace's default is adifferent owner's row and is left alone.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const packageType = await client.packageTypes.create({+ name: 'Medium box',+ kind: 'box',+ length: 40,+ width: 30,+ height: 20,+ dimensions_unit: 'cm',+ max_weight: 10,+ weight_unit: 'kg',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -19616,6 +21012,19 @@ paths:description: |Returns one package type by prefixed ID — the seller's own, or amarketplace row they may pack into.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const packageType = await client.packageTypes.get('pkgtype_UkLWZg9DAJ')parameters:- name: X-Spree-Seller-Idin: header@@ -19665,6 +21074,21 @@ paths:description: |Changes the seller's own packaging. A marketplace row is not theirs toedit and answers 404.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const packageType = await client.packageTypes.update('pkgtype_UkLWZg9DAJ', {+ max_weight: 15,+ })parameters:- name: X-Spree-Seller-Idin: header@@ -19711,6 +21135,19 @@ paths:Retires one of the seller's own package types. The default box isrefused — name another default first, or every parcel silently fallsback to the marketplace's box.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ await client.packageTypes.delete('pkgtype_UkLWZg9DAJ')parameters:- name: X-Spree-Seller-Idin: header@@ -19736,6 +21173,22 @@ paths:Read-only: a payout is created by the marketplace's sweep andconfirmed by the payout provider or the operator.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: payouts } = await client.payouts.list({+ status_eq: 'completed',+ sort: '-period_end',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -19861,6 +21314,19 @@ paths:- bearer_auth: []description: One of this seller's settlements. Another seller's is not found,whatever id is sent.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const payout = await client.payouts.get('vpo_UkLWZg9DAJ')parameters:- name: X-Spree-Seller-Idin: header@@ -19916,6 +21382,19 @@ paths:Reached through the order, which is itself fetched through the actingseller — so a return on somebody else's order is unreachable whateverids are sent.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: returns } = await client.orders.returns.list('or_UkLWZg9DAJ')parameters:- name: X-Spree-Seller-Idin: header@@ -20015,6 +21494,22 @@ paths:order, so only what this seller actually shipped can come back. Anoptional stock location says which of the seller's own shelves itreturns to.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const orderReturn = await client.orders.returns.create('or_UkLWZg9DAJ', {+ items: [{ fulfillment_item_id: 'fi_UkLWZg9DAJ', quantity: 1 }],+ reason_id: 'rar_UkLWZg9DAJ',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -20077,6 +21572,19 @@ paths:security:- bearer_auth: []description: Agrees the goods may come back.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const orderReturn = await client.orders.returns.approve('or_UkLWZg9DAJ', 'ret_UkLWZg9DAJ')parameters:- name: X-Spree-Seller-Idin: header@@ -20128,6 +21636,21 @@ paths:Records what actually arrived, and whether it can be sold again.Omitting `items` receives everything as requested and resellable.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const orderReturn = await client.orders.returns.receive('or_UkLWZg9DAJ', 'ret_UkLWZg9DAJ', {+ items: [{ return_line_item_id: 'rli_UkLWZg9DAJ', quantity: 1, resellable: true }],+ })parameters:- name: X-Spree-Seller-Idin: header@@ -20187,6 +21710,21 @@ paths:theirs to do. The amount is bounded by what the return is owed and, ona basket split between sellers, by this order's share of the payment —never a sibling's.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const orderReturn = await client.orders.returns.refund('or_UkLWZg9DAJ', 'ret_UkLWZg9DAJ', {+ refund_method: 'original_payment',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -20248,6 +21786,21 @@ paths:security:- bearer_auth: []description: Calls the return off.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const orderReturn = await client.orders.returns.cancel('or_UkLWZg9DAJ', 'ret_UkLWZg9DAJ', {+ reason: 'Customer decided to keep the goods',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -20294,6 +21847,19 @@ paths:Read-only: the vocabulary is the operator's, and a seller picks fromit. Retired reasons are left out.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: reasons } = await client.returnReasons.list()parameters:- name: X-Spree-Seller-Idin: header@@ -20377,6 +21943,19 @@ paths:A collection rather than a single field: a business trading in morethan one regime holds a registration in each, and they are notalternatives. One per kind.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: taxIdentifiers } = await client.taxIdentifiers.list()parameters:- name: X-Spree-Seller-Idin: header@@ -20448,6 +22027,22 @@ paths:A number a registered validator refuses is rejected outright ratherthan stored, so a typo cannot reach an invoice.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const taxIdentifier = await client.taxIdentifiers.create({+ kind: 'eu_vat',+ value: 'DE123456789',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -20498,6 +22093,21 @@ paths:description: |A changed number drops its validation verdict, because that answer wasabout the old one.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const taxIdentifier = await client.taxIdentifiers.update('txi_xxx', {+ value: 'DE987654321',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -20527,6 +22137,19 @@ paths:- Tax Identifierssecurity:- bearer_auth: []+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ await client.taxIdentifiers.remove('txi_xxx')parameters:- name: X-Spree-Seller-Idin: header@@ -20555,6 +22178,19 @@ paths:installed for the kind — core format-checks EU VAT numbers but asks noregistry, so a stock install answers 422 here rather than queueing acheck nobody can answer.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const taxIdentifier = await client.taxIdentifiers.validate('txi_xxx')parameters:- name: X-Spree-Seller-Idin: header@@ -20586,6 +22222,22 @@ paths:Read-only. Filter with `q[order_id_eq]` for one order's rows, or`q[payout_id_eq]` for the earnings one settlement covers.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const { data: transfers } = await client.transfers.list({+ payout_id_eq: 'vpo_UkLWZg9DAJ',+ sort: '-created_at',+ })parameters:- name: X-Spree-Seller-Idin: header@@ -20718,6 +22370,19 @@ paths:- bearer_auth: []description: One of this seller's transfers. Another seller's is not found,whatever id is sent.+ x-codeSamples:+ - lang: javascript+ label: Spree Seller SDK+ source: |-+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })++ const transfer = await client.transfers.get('vtr_UkLWZg9DAJ')parameters:- name: X-Spree-Seller-Idin: headerdiff --git a/docs/api-reference/store.yaml b/docs/api-reference/store.yamlindex fc71388e54..c1a1e034cc 100644--- a/docs/api-reference/store.yaml+++ b/docs/api-reference/store.yaml@@ -1173,8 +1173,8 @@ paths:limit: 25,sort: 'price',search: 'shirt',- price_gte: 20,- price_lte: 100,+ price_gte: '20',+ price_lte: '100',with_option_value_ids: ['optval_abc', 'optval_def'],expand: ['variants', 'media'],})diff --git a/docs/developer/core-concepts/search-filtering.mdx b/docs/developer/core-concepts/search-filtering.mdxindex 3770db7ddf..2f96c1134b 100644--- a/docs/developer/core-concepts/search-filtering.mdx+++ b/docs/developer/core-concepts/search-filtering.mdx@@ -48,15 +48,15 @@ curl 'https://api.mystore.com/api/v3/store/products?q[search]=tote+bag&limit=12'```typescript Store SDKconst { data: products } = await client.products.list({- price_gte: 20,- price_lte: 100,+ price_gte: '20',+ price_lte: '100',})``````typescript Admin SDKconst { data: products } = await adminClient.products.list({- price_gte: 20,- price_lte: 100,+ price_gte: '20',+ price_lte: '100',})```diff --git a/docs/developer/sdk/store/products.mdx b/docs/developer/sdk/store/products.mdxindex 12ec24f3aa..aacf333283 100644--- a/docs/developer/sdk/store/products.mdx+++ b/docs/developer/sdk/store/products.mdx@@ -22,8 +22,8 @@ Use flat param keys — the SDK wraps them in `q[...]` automatically:```typescriptconst products = await client.products.list({name_cont: 'shirt', // Name contains- price_gte: 20, // Min price- price_lte: 100, // Max price+ price_gte: '20', // Min price+ price_lte: '100', // Max pricewith_option_value_ids: ['optval_abc', 'optval_def'], // By option valuesin_stock: true, // In stock onlysearch: 'blue shirt', // Full-text searchdiff --git a/packages/sdk/examples/products/list.ts b/packages/sdk/examples/products/list.tsindex c726003004..b3cf560d88 100644--- a/packages/sdk/examples/products/list.ts+++ b/packages/sdk/examples/products/list.ts@@ -11,8 +11,8 @@ const products = await client.products.list({limit: 25,sort: 'price',search: 'shirt',- price_gte: 20,- price_lte: 100,+ price_gte: '20',+ price_lte: '100',with_option_value_ids: ['optval_abc', 'optval_def'],expand: ['variants', 'media'],})diff --git a/packages/sdk/package.json b/packages/sdk/package.jsonindex 2a3cfb4260..572899db0e 100644--- a/packages/sdk/package.json+++ b/packages/sdk/package.json@@ -60,7 +60,7 @@"build": "tsup","dev": "tsup --watch","console": "tsx console.ts",- "typecheck": "tsc --noEmit",+ "typecheck": "tsc --noEmit && tsc --noEmit -p tsconfig.examples.json","examples:typecheck": "tsc --noEmit -p tsconfig.examples.json","test": "vitest run","test:integration": "vitest run --config vitest.integration.config.ts",diff --git a/packages/seller-sdk/examples/auth/accept-invitation.ts b/packages/seller-sdk/examples/auth/accept-invitation.tsnew file mode 100644index 0000000000..a9bdf35570--- /dev/null+++ b/packages/seller-sdk/examples/auth/accept-invitation.ts@@ -0,0 +1,17 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+})++// region:example+const auth = await client.auth.acceptInvitation('inv_xxx', 'token-from-email', {+ password: 'password123',+ password_confirmation: 'password123',+ first_name: 'Jane',+ last_name: 'Doe',+})++// endregion:example++export { auth }diff --git a/packages/seller-sdk/examples/auth/login.ts b/packages/seller-sdk/examples/auth/login.tsnew file mode 100644index 0000000000..9aba95fc6b--- /dev/null+++ b/packages/seller-sdk/examples/auth/login.ts@@ -0,0 +1,15 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+})++// region:example+const auth = await client.auth.login({+ email: '[email protected]',+ password: 'password123',+})++// endregion:example++export { auth }diff --git a/packages/seller-sdk/examples/auth/logout.ts b/packages/seller-sdk/examples/auth/logout.tsnew file mode 100644index 0000000000..f2870bb399--- /dev/null+++ b/packages/seller-sdk/examples/auth/logout.ts@@ -0,0 +1,9 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+})++// region:example+await client.auth.logout()+// endregion:examplediff --git a/packages/seller-sdk/examples/auth/lookup-invitation.ts b/packages/seller-sdk/examples/auth/lookup-invitation.tsnew file mode 100644index 0000000000..aa76ef46e9--- /dev/null+++ b/packages/seller-sdk/examples/auth/lookup-invitation.ts@@ -0,0 +1,12 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+})++// region:example+const invitation = await client.auth.lookupInvitation('inv_xxx', 'token-from-email')++// endregion:example++export { invitation }diff --git a/packages/seller-sdk/examples/auth/providers.ts b/packages/seller-sdk/examples/auth/providers.tsnew file mode 100644index 0000000000..5ea77d72e5--- /dev/null+++ b/packages/seller-sdk/examples/auth/providers.ts@@ -0,0 +1,12 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+})++// region:example+const { providers } = await client.auth.providers()++// endregion:example++export { providers }diff --git a/packages/seller-sdk/examples/auth/refresh.ts b/packages/seller-sdk/examples/auth/refresh.tsnew file mode 100644index 0000000000..4c3e06d2cb--- /dev/null+++ b/packages/seller-sdk/examples/auth/refresh.ts@@ -0,0 +1,12 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+})++// region:example+const auth = await client.auth.refresh()++// endregion:example++export { auth }diff --git a/packages/seller-sdk/examples/auth/request-password-reset.ts b/packages/seller-sdk/examples/auth/request-password-reset.tsnew file mode 100644index 0000000000..d6a1ea36b0--- /dev/null+++ b/packages/seller-sdk/examples/auth/request-password-reset.ts@@ -0,0 +1,12 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+})++// region:example+await client.auth.requestPasswordReset({+ email: '[email protected]',+ redirect_url: 'https://sellers.your-store.com/reset-password',+})+// endregion:examplediff --git a/packages/seller-sdk/examples/auth/reset-password.ts b/packages/seller-sdk/examples/auth/reset-password.tsnew file mode 100644index 0000000000..3235bf45ce--- /dev/null+++ b/packages/seller-sdk/examples/auth/reset-password.ts@@ -0,0 +1,15 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+})++// region:example+const auth = await client.auth.resetPassword('reset-token-from-email', {+ password: 'new-password-123',+ password_confirmation: 'new-password-123',+})++// endregion:example++export { auth }diff --git a/packages/seller-sdk/examples/balances/list.ts b/packages/seller-sdk/examples/balances/list.tsnew file mode 100644index 0000000000..9aae40ae78--- /dev/null+++ b/packages/seller-sdk/examples/balances/list.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: balances } = await client.balances.list()++// endregion:example++export { balances }diff --git a/packages/seller-sdk/examples/claim-reasons/list.ts b/packages/seller-sdk/examples/claim-reasons/list.tsnew file mode 100644index 0000000000..4ae0286a13--- /dev/null+++ b/packages/seller-sdk/examples/claim-reasons/list.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: reasons } = await client.claimReasons.list()++// endregion:example++export { reasons }diff --git a/packages/seller-sdk/examples/countries/list.ts b/packages/seller-sdk/examples/countries/list.tsnew file mode 100644index 0000000000..b7df35a12a--- /dev/null+++ b/packages/seller-sdk/examples/countries/list.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: countries } = await client.countries.list()++// endregion:example++export { countries }diff --git a/packages/seller-sdk/examples/delivery-methods/calculators.ts b/packages/seller-sdk/examples/delivery-methods/calculators.tsnew file mode 100644index 0000000000..3f8cb3e618--- /dev/null+++ b/packages/seller-sdk/examples/delivery-methods/calculators.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: calculators } = await client.deliveryMethods.calculators()++// endregion:example++export { calculators }diff --git a/packages/seller-sdk/examples/delivery-methods/create.ts b/packages/seller-sdk/examples/delivery-methods/create.tsnew file mode 100644index 0000000000..9b61716650--- /dev/null+++ b/packages/seller-sdk/examples/delivery-methods/create.ts@@ -0,0 +1,18 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const deliveryMethod = await client.deliveryMethods.create({+ name: 'Next day',+ delivery_profile_id: 'fp_UkLWZg9DAJ',+ calculator: { type: 'flat_rate', preferences: { amount: '9.99', currency: 'USD' } },+})++// endregion:example++export { deliveryMethod }diff --git a/packages/seller-sdk/examples/delivery-methods/delete.ts b/packages/seller-sdk/examples/delivery-methods/delete.tsnew file mode 100644index 0000000000..fdc44cbe1d--- /dev/null+++ b/packages/seller-sdk/examples/delivery-methods/delete.ts@@ -0,0 +1,11 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+await client.deliveryMethods.delete('dm_UkLWZg9DAJ')+// endregion:examplediff --git a/packages/seller-sdk/examples/delivery-methods/get.ts b/packages/seller-sdk/examples/delivery-methods/get.tsnew file mode 100644index 0000000000..442e6f3909--- /dev/null+++ b/packages/seller-sdk/examples/delivery-methods/get.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const deliveryMethod = await client.deliveryMethods.get('dm_UkLWZg9DAJ')++// endregion:example++export { deliveryMethod }diff --git a/packages/seller-sdk/examples/delivery-methods/list.ts b/packages/seller-sdk/examples/delivery-methods/list.tsnew file mode 100644index 0000000000..7b67c5d4e7--- /dev/null+++ b/packages/seller-sdk/examples/delivery-methods/list.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: deliveryMethods } = await client.deliveryMethods.list()++// endregion:example++export { deliveryMethods }diff --git a/packages/seller-sdk/examples/delivery-methods/rule-types.ts b/packages/seller-sdk/examples/delivery-methods/rule-types.tsnew file mode 100644index 0000000000..da4ccda1ab--- /dev/null+++ b/packages/seller-sdk/examples/delivery-methods/rule-types.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: ruleTypes } = await client.deliveryMethods.ruleTypes()++// endregion:example++export { ruleTypes }diff --git a/packages/seller-sdk/examples/delivery-methods/update.ts b/packages/seller-sdk/examples/delivery-methods/update.tsnew file mode 100644index 0000000000..40baf55dbd--- /dev/null+++ b/packages/seller-sdk/examples/delivery-methods/update.ts@@ -0,0 +1,18 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const deliveryMethod = await client.deliveryMethods.update('dm_UkLWZg9DAJ', {+ name: 'Next day (tracked)',+ estimated_transit_business_days_min: 1,+ estimated_transit_business_days_max: 2,+})++// endregion:example++export { deliveryMethod }diff --git a/packages/seller-sdk/examples/delivery-profiles/list.ts b/packages/seller-sdk/examples/delivery-profiles/list.tsnew file mode 100644index 0000000000..1bf1c1f26b--- /dev/null+++ b/packages/seller-sdk/examples/delivery-profiles/list.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: deliveryProfiles } = await client.deliveryProfiles.list()++// endregion:example++export { deliveryProfiles }diff --git a/packages/seller-sdk/examples/delivery-zones/list.ts b/packages/seller-sdk/examples/delivery-zones/list.tsnew file mode 100644index 0000000000..5dcedfdd24--- /dev/null+++ b/packages/seller-sdk/examples/delivery-zones/list.ts@@ -0,0 +1,16 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: deliveryZones } = await client.deliveryZones.list({+ delivery_profile_id: 'fp_UkLWZg9DAJ',+})++// endregion:example++export { deliveryZones }diff --git a/packages/seller-sdk/examples/exports/create.ts b/packages/seller-sdk/examples/exports/create.tsnew file mode 100644index 0000000000..74aedbe419--- /dev/null+++ b/packages/seller-sdk/examples/exports/create.ts@@ -0,0 +1,17 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const exp = await client.exports.create({+ type: 'orders',+ search_params: { completed_at_gt: '2026-01-01' },+})++// endregion:example++export { exp }diff --git a/packages/seller-sdk/examples/exports/download.ts b/packages/seller-sdk/examples/exports/download.tsnew file mode 100644index 0000000000..7941e1dc7a--- /dev/null+++ b/packages/seller-sdk/examples/exports/download.ts@@ -0,0 +1,31 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+// An export is built in the background; poll until it is done.+let exp = await client.exports.get('exp_UkLWZg9DAJ')+while (!exp.done) {+ await new Promise((resolve) => setTimeout(resolve, 2000))+ exp = await client.exports.get(exp.id)+}++if (exp.download_url) {+ // Exports are served through the API, so fetch with the session's token+ // and seller, then drive the browser download:+ const response = await fetch(`https://your-store.com${exp.download_url}`, {+ headers: { Authorization: 'Bearer eyJhbGciOi...', 'X-Spree-Seller-Id': 'sel_UkLWZg9DAJ' },+ })+ const url = URL.createObjectURL(await response.blob())+ const link = Object.assign(document.createElement('a'), {+ href: url,+ download: exp.filename ?? 'export.csv',+ })+ link.click()+ URL.revokeObjectURL(url)+}+// endregion:examplediff --git a/packages/seller-sdk/examples/exports/get.ts b/packages/seller-sdk/examples/exports/get.tsnew file mode 100644index 0000000000..311a10f11d--- /dev/null+++ b/packages/seller-sdk/examples/exports/get.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const exp = await client.exports.get('exp_UkLWZg9DAJ')++// endregion:example++export { exp }diff --git a/packages/seller-sdk/examples/files/create.ts b/packages/seller-sdk/examples/files/create.tsnew file mode 100644index 0000000000..c1b1e51b01--- /dev/null+++ b/packages/seller-sdk/examples/files/create.ts@@ -0,0 +1,19 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const file = await client.files.create({+ filename: 'registration.pdf',+ content_type: 'application/pdf',+ byte_size: 51234,+ visibility: 'private',+})++// endregion:example++export { file }diff --git a/packages/seller-sdk/examples/imports/complete-mapping.ts b/packages/seller-sdk/examples/imports/complete-mapping.tsnew file mode 100644index 0000000000..a8d1939e7e--- /dev/null+++ b/packages/seller-sdk/examples/imports/complete-mapping.ts@@ -0,0 +1,16 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const productImport = await client.imports.completeMapping('imp_UkLWZg9DAJ', {+ mappings: [{ schema_field: 'name', file_column: 'Product name' }],+})++// endregion:example++export { productImport }diff --git a/packages/seller-sdk/examples/imports/create.ts b/packages/seller-sdk/examples/imports/create.tsnew file mode 100644index 0000000000..d0014da067--- /dev/null+++ b/packages/seller-sdk/examples/imports/create.ts@@ -0,0 +1,17 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const productImport = await client.imports.create({+ type: 'products',+ attachment_signed_id: 'eyJfcmFpbHMiOnsiZGF0YSI6MTIzLCJwdXIiOiJibG9iX2lkIn19--4b9d',+})++// endregion:example++export { productImport }diff --git a/packages/seller-sdk/examples/imports/list.ts b/packages/seller-sdk/examples/imports/list.tsnew file mode 100644index 0000000000..e4003f66f1--- /dev/null+++ b/packages/seller-sdk/examples/imports/list.ts@@ -0,0 +1,17 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: imports } = await client.imports.list({+ status_eq: 'completed',+ sort: '-created_at',+})++// endregion:example++export { imports }diff --git a/packages/seller-sdk/examples/imports/rows-list.ts b/packages/seller-sdk/examples/imports/rows-list.tsnew file mode 100644index 0000000000..ae87490354--- /dev/null+++ b/packages/seller-sdk/examples/imports/rows-list.ts@@ -0,0 +1,16 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: rows } = await client.imports.rows.list('imp_UkLWZg9DAJ', {+ status_eq: 'failed',+})++// endregion:example++export { rows }diff --git a/packages/seller-sdk/examples/invitations/acceptance-link.ts b/packages/seller-sdk/examples/invitations/acceptance-link.tsnew file mode 100644index 0000000000..43ddc85914--- /dev/null+++ b/packages/seller-sdk/examples/invitations/acceptance-link.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const link = await client.invitations.acceptanceLink('inv_xxx')++// endregion:example++export { link }diff --git a/packages/seller-sdk/examples/invitations/delete.ts b/packages/seller-sdk/examples/invitations/delete.tsnew file mode 100644index 0000000000..b58002abf3--- /dev/null+++ b/packages/seller-sdk/examples/invitations/delete.ts@@ -0,0 +1,11 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+await client.invitations.revoke('inv_xxx')+// endregion:examplediff --git a/packages/seller-sdk/examples/invitations/list.ts b/packages/seller-sdk/examples/invitations/list.tsnew file mode 100644index 0000000000..8845c31f36--- /dev/null+++ b/packages/seller-sdk/examples/invitations/list.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: invitations } = await client.invitations.list()++// endregion:example++export { invitations }diff --git a/packages/seller-sdk/examples/invitations/resend.ts b/packages/seller-sdk/examples/invitations/resend.tsnew file mode 100644index 0000000000..9fbfd4ba98--- /dev/null+++ b/packages/seller-sdk/examples/invitations/resend.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const invitation = await client.invitations.resend('inv_xxx')++// endregion:example++export { invitation }diff --git a/packages/seller-sdk/examples/me/get.ts b/packages/seller-sdk/examples/me/get.tsnew file mode 100644index 0000000000..b4f3b18487--- /dev/null+++ b/packages/seller-sdk/examples/me/get.ts@@ -0,0 +1,13 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+})++// region:example+const me = await client.me.get()++// endregion:example++export { me }diff --git a/packages/seller-sdk/examples/me/update.ts b/packages/seller-sdk/examples/me/update.tsnew file mode 100644index 0000000000..43efd8e85e--- /dev/null+++ b/packages/seller-sdk/examples/me/update.ts@@ -0,0 +1,17 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+})++// region:example+const me = await client.me.update({+ first_name: 'Jane',+ last_name: 'Doe',+ selected_locale: 'en',+})++// endregion:example++export { me }diff --git a/packages/seller-sdk/examples/onboarding/get.ts b/packages/seller-sdk/examples/onboarding/get.tsnew file mode 100644index 0000000000..502678f3e0--- /dev/null+++ b/packages/seller-sdk/examples/onboarding/get.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const onboarding = await client.onboarding.get()++// endregion:example++export { onboarding }diff --git a/packages/seller-sdk/examples/onboarding/payout-account.ts b/packages/seller-sdk/examples/onboarding/payout-account.tsnew file mode 100644index 0000000000..53263f2d02--- /dev/null+++ b/packages/seller-sdk/examples/onboarding/payout-account.ts@@ -0,0 +1,17 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const link = await client.onboarding.payoutAccount({+ refresh_url: 'https://sellers.your-store.com/onboarding',+ return_url: 'https://sellers.your-store.com/onboarding',+})++// endregion:example++export { link }diff --git a/packages/seller-sdk/examples/onboarding/submit-for-review.ts b/packages/seller-sdk/examples/onboarding/submit-for-review.tsnew file mode 100644index 0000000000..9f979396d4--- /dev/null+++ b/packages/seller-sdk/examples/onboarding/submit-for-review.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const onboarding = await client.onboarding.submitForReview()++// endregion:example++export { onboarding }diff --git a/packages/seller-sdk/examples/order-cancellation-reasons/list.ts b/packages/seller-sdk/examples/order-cancellation-reasons/list.tsnew file mode 100644index 0000000000..f62ccdbf10--- /dev/null+++ b/packages/seller-sdk/examples/order-cancellation-reasons/list.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: reasons } = await client.orderCancellationReasons.list()++// endregion:example++export { reasons }diff --git a/packages/seller-sdk/examples/order-claims/approve.ts b/packages/seller-sdk/examples/order-claims/approve.tsnew file mode 100644index 0000000000..d7d74d32ef--- /dev/null+++ b/packages/seller-sdk/examples/order-claims/approve.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const claim = await client.orders.claims.approve('or_UkLWZg9DAJ', 'claim_UkLWZg9DAJ')++// endregion:example++export { claim }diff --git a/packages/seller-sdk/examples/order-claims/cancel.ts b/packages/seller-sdk/examples/order-claims/cancel.tsnew file mode 100644index 0000000000..099a9852b5--- /dev/null+++ b/packages/seller-sdk/examples/order-claims/cancel.ts@@ -0,0 +1,16 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const claim = await client.orders.claims.cancel('or_UkLWZg9DAJ', 'claim_UkLWZg9DAJ', {+ reason: 'Customer found the missing item',+})++// endregion:example++export { claim }diff --git a/packages/seller-sdk/examples/order-claims/create.ts b/packages/seller-sdk/examples/order-claims/create.tsnew file mode 100644index 0000000000..201eb15f89--- /dev/null+++ b/packages/seller-sdk/examples/order-claims/create.ts@@ -0,0 +1,17 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const claim = await client.orders.claims.create('or_UkLWZg9DAJ', {+ items: [{ line_item_id: 'li_UkLWZg9DAJ', quantity: 1, description: 'Arrived damaged' }],+ reason_id: 'clr_UkLWZg9DAJ',+})++// endregion:example++export { claim }diff --git a/packages/seller-sdk/examples/order-claims/deny.ts b/packages/seller-sdk/examples/order-claims/deny.tsnew file mode 100644index 0000000000..2d861d46db--- /dev/null+++ b/packages/seller-sdk/examples/order-claims/deny.ts@@ -0,0 +1,16 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const claim = await client.orders.claims.deny('or_UkLWZg9DAJ', 'claim_UkLWZg9DAJ', {+ reason: 'Reported after the claim window closed',+})++// endregion:example++export { claim }diff --git a/packages/seller-sdk/examples/order-claims/list.ts b/packages/seller-sdk/examples/order-claims/list.tsnew file mode 100644index 0000000000..ab514a6254--- /dev/null+++ b/packages/seller-sdk/examples/order-claims/list.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: claims } = await client.orders.claims.list('or_UkLWZg9DAJ')++// endregion:example++export { claims }diff --git a/packages/seller-sdk/examples/order-claims/resolve.ts b/packages/seller-sdk/examples/order-claims/resolve.tsnew file mode 100644index 0000000000..66c2aedf4e--- /dev/null+++ b/packages/seller-sdk/examples/order-claims/resolve.ts@@ -0,0 +1,18 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const claim = await client.orders.claims.resolve('or_UkLWZg9DAJ', 'claim_UkLWZg9DAJ', {+ resolution: 'refund',+ refund_method: 'original_payment',+ amount: '19.99',+})++// endregion:example++export { claim }diff --git a/packages/seller-sdk/examples/order-deliveries/create.ts b/packages/seller-sdk/examples/order-deliveries/create.tsnew file mode 100644index 0000000000..99bc2872ab--- /dev/null+++ b/packages/seller-sdk/examples/order-deliveries/create.ts@@ -0,0 +1,21 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const delivery = await client.orders.fulfillments.deliveries.create(+ 'or_UkLWZg9DAJ',+ 'ful_UkLWZg9DAJ',+ {+ tracking_number: '1Z879E930346834440',+ carrier: 'ups',+ },+)++// endregion:example++export { delivery }diff --git a/packages/seller-sdk/examples/order-deliveries/list.ts b/packages/seller-sdk/examples/order-deliveries/list.tsnew file mode 100644index 0000000000..cfe1dca8a3--- /dev/null+++ b/packages/seller-sdk/examples/order-deliveries/list.ts@@ -0,0 +1,17 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: deliveries } = await client.orders.fulfillments.deliveries.list(+ 'or_UkLWZg9DAJ',+ 'ful_UkLWZg9DAJ',+)++// endregion:example++export { deliveries }diff --git a/packages/seller-sdk/examples/order-deliveries/update.ts b/packages/seller-sdk/examples/order-deliveries/update.tsnew file mode 100644index 0000000000..4998e984d4--- /dev/null+++ b/packages/seller-sdk/examples/order-deliveries/update.ts@@ -0,0 +1,19 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const delivery = await client.orders.fulfillments.deliveries.update(+ 'or_UkLWZg9DAJ',+ 'ful_UkLWZg9DAJ',+ 'dlv_UkLWZg9DAJ',+ { tracking_number: '1Z879E930346834441' },+)++// endregion:example++export { delivery }diff --git a/packages/seller-sdk/examples/order-exchanges/cancel.ts b/packages/seller-sdk/examples/order-exchanges/cancel.tsnew file mode 100644index 0000000000..d2194d108a--- /dev/null+++ b/packages/seller-sdk/examples/order-exchanges/cancel.ts@@ -0,0 +1,16 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const exchange = await client.orders.exchanges.cancel('or_UkLWZg9DAJ', 'exch_UkLWZg9DAJ', {+ reason: 'Customer kept the original',+})++// endregion:example++export { exchange }diff --git a/packages/seller-sdk/examples/order-exchanges/create.ts b/packages/seller-sdk/examples/order-exchanges/create.tsnew file mode 100644index 0000000000..65837517e4--- /dev/null+++ b/packages/seller-sdk/examples/order-exchanges/create.ts@@ -0,0 +1,19 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const exchange = await client.orders.exchanges.create('or_UkLWZg9DAJ', {+ items: [+ { fulfillment_item_id: 'fi_UkLWZg9DAJ', new_variant_id: 'variant_86Rf07xd4z', quantity: 1 },+ ],+ reason_id: 'rar_UkLWZg9DAJ',+})++// endregion:example++export { exchange }diff --git a/packages/seller-sdk/examples/order-exchanges/fulfill.ts b/packages/seller-sdk/examples/order-exchanges/fulfill.tsnew file mode 100644index 0000000000..f3a8263e82--- /dev/null+++ b/packages/seller-sdk/examples/order-exchanges/fulfill.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const exchange = await client.orders.exchanges.fulfill('or_UkLWZg9DAJ', 'exch_UkLWZg9DAJ')++// endregion:example++export { exchange }diff --git a/packages/seller-sdk/examples/order-exchanges/list.ts b/packages/seller-sdk/examples/order-exchanges/list.tsnew file mode 100644index 0000000000..6bc2bbcd5a--- /dev/null+++ b/packages/seller-sdk/examples/order-exchanges/list.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: exchanges } = await client.orders.exchanges.list('or_UkLWZg9DAJ')++// endregion:example++export { exchanges }diff --git a/packages/seller-sdk/examples/order-exchanges/receive.ts b/packages/seller-sdk/examples/order-exchanges/receive.tsnew file mode 100644index 0000000000..813577e360--- /dev/null+++ b/packages/seller-sdk/examples/order-exchanges/receive.ts@@ -0,0 +1,16 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const exchange = await client.orders.exchanges.receive('or_UkLWZg9DAJ', 'exch_UkLWZg9DAJ', {+ items: [{ exchange_line_item_id: 'eli_UkLWZg9DAJ', quantity: 1, resellable: true }],+})++// endregion:example++export { exchange }diff --git a/packages/seller-sdk/examples/order-fulfillments/cancel.ts b/packages/seller-sdk/examples/order-fulfillments/cancel.tsnew file mode 100644index 0000000000..2d87cc540c--- /dev/null+++ b/packages/seller-sdk/examples/order-fulfillments/cancel.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const fulfillment = await client.orders.fulfillments.cancel('or_UkLWZg9DAJ', 'ful_UkLWZg9DAJ')++// endregion:example++export { fulfillment }diff --git a/packages/seller-sdk/examples/order-fulfillments/fulfill.ts b/packages/seller-sdk/examples/order-fulfillments/fulfill.tsnew file mode 100644index 0000000000..ae7d2fb487--- /dev/null+++ b/packages/seller-sdk/examples/order-fulfillments/fulfill.ts@@ -0,0 +1,18 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const fulfillment = await client.orders.fulfillments.fulfill('or_UkLWZg9DAJ', 'ful_UkLWZg9DAJ', {+ tracking: '1Z879E930346834440',+ tracking_carrier: 'ups',+ notify_customer: true,+})++// endregion:example++export { fulfillment }diff --git a/packages/seller-sdk/examples/order-fulfillments/list.ts b/packages/seller-sdk/examples/order-fulfillments/list.tsnew file mode 100644index 0000000000..6e4ff85ab6--- /dev/null+++ b/packages/seller-sdk/examples/order-fulfillments/list.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: fulfillments } = await client.orders.fulfillments.list('or_UkLWZg9DAJ')++// endregion:example++export { fulfillments }diff --git a/packages/seller-sdk/examples/order-fulfillments/split.ts b/packages/seller-sdk/examples/order-fulfillments/split.tsnew file mode 100644index 0000000000..5d97238962--- /dev/null+++ b/packages/seller-sdk/examples/order-fulfillments/split.ts@@ -0,0 +1,21 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: fulfillments } = await client.orders.fulfillments.split(+ 'or_UkLWZg9DAJ',+ 'ful_UkLWZg9DAJ',+ {+ variant_id: 'variant_86Rf07xd4z',+ quantity: 1,+ },+)++// endregion:example++export { fulfillments }diff --git a/packages/seller-sdk/examples/order-fulfillments/update.ts b/packages/seller-sdk/examples/order-fulfillments/update.tsnew file mode 100644index 0000000000..00b0a7685a--- /dev/null+++ b/packages/seller-sdk/examples/order-fulfillments/update.ts@@ -0,0 +1,17 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const fulfillment = await client.orders.fulfillments.update('or_UkLWZg9DAJ', 'ful_UkLWZg9DAJ', {+ tracking: '1Z879E930346834440',+ tracking_carrier: 'ups',+})++// endregion:example++export { fulfillment }diff --git a/packages/seller-sdk/examples/order-labels/list.ts b/packages/seller-sdk/examples/order-labels/list.tsnew file mode 100644index 0000000000..4df4320114--- /dev/null+++ b/packages/seller-sdk/examples/order-labels/list.ts@@ -0,0 +1,17 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: labels } = await client.orders.fulfillments.labels.list(+ 'or_UkLWZg9DAJ',+ 'ful_UkLWZg9DAJ',+)++// endregion:example++export { labels }diff --git a/packages/seller-sdk/examples/order-labels/upload.ts b/packages/seller-sdk/examples/order-labels/upload.tsnew file mode 100644index 0000000000..2c2db69f7f--- /dev/null+++ b/packages/seller-sdk/examples/order-labels/upload.ts@@ -0,0 +1,19 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const label = await client.orders.fulfillments.labels.create('or_UkLWZg9DAJ', 'ful_UkLWZg9DAJ', {+ file_signed_id: 'signed_id_from_files_upload',+ tracking_number: '1Z879E930346834440',+ cost: '6.50',+ currency: 'USD',+})++// endregion:example++export { label }diff --git a/packages/seller-sdk/examples/order-returns/approve.ts b/packages/seller-sdk/examples/order-returns/approve.tsnew file mode 100644index 0000000000..b598151fc5--- /dev/null+++ b/packages/seller-sdk/examples/order-returns/approve.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const orderReturn = await client.orders.returns.approve('or_UkLWZg9DAJ', 'ret_UkLWZg9DAJ')++// endregion:example++export { orderReturn }diff --git a/packages/seller-sdk/examples/order-returns/cancel.ts b/packages/seller-sdk/examples/order-returns/cancel.tsnew file mode 100644index 0000000000..40d714d924--- /dev/null+++ b/packages/seller-sdk/examples/order-returns/cancel.ts@@ -0,0 +1,16 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const orderReturn = await client.orders.returns.cancel('or_UkLWZg9DAJ', 'ret_UkLWZg9DAJ', {+ reason: 'Customer decided to keep the goods',+})++// endregion:example++export { orderReturn }diff --git a/packages/seller-sdk/examples/order-returns/create.ts b/packages/seller-sdk/examples/order-returns/create.tsnew file mode 100644index 0000000000..18a8dd68c3--- /dev/null+++ b/packages/seller-sdk/examples/order-returns/create.ts@@ -0,0 +1,17 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const orderReturn = await client.orders.returns.create('or_UkLWZg9DAJ', {+ items: [{ fulfillment_item_id: 'fi_UkLWZg9DAJ', quantity: 1 }],+ reason_id: 'rar_UkLWZg9DAJ',+})++// endregion:example++export { orderReturn }diff --git a/packages/seller-sdk/examples/order-returns/list.ts b/packages/seller-sdk/examples/order-returns/list.tsnew file mode 100644index 0000000000..d64f1451bf--- /dev/null+++ b/packages/seller-sdk/examples/order-returns/list.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: returns } = await client.orders.returns.list('or_UkLWZg9DAJ')++// endregion:example++export { returns }diff --git a/packages/seller-sdk/examples/order-returns/receive.ts b/packages/seller-sdk/examples/order-returns/receive.tsnew file mode 100644index 0000000000..d29b6cce18--- /dev/null+++ b/packages/seller-sdk/examples/order-returns/receive.ts@@ -0,0 +1,16 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const orderReturn = await client.orders.returns.receive('or_UkLWZg9DAJ', 'ret_UkLWZg9DAJ', {+ items: [{ return_line_item_id: 'rli_UkLWZg9DAJ', quantity: 1, resellable: true }],+})++// endregion:example++export { orderReturn }diff --git a/packages/seller-sdk/examples/order-returns/refund.ts b/packages/seller-sdk/examples/order-returns/refund.tsnew file mode 100644index 0000000000..16b30a9752--- /dev/null+++ b/packages/seller-sdk/examples/order-returns/refund.ts@@ -0,0 +1,16 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const orderReturn = await client.orders.returns.refund('or_UkLWZg9DAJ', 'ret_UkLWZg9DAJ', {+ refund_method: 'original_payment',+})++// endregion:example++export { orderReturn }diff --git a/packages/seller-sdk/examples/orders/address-update.ts b/packages/seller-sdk/examples/orders/address-update.tsnew file mode 100644index 0000000000..3adb564767--- /dev/null+++ b/packages/seller-sdk/examples/orders/address-update.ts@@ -0,0 +1,16 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const order = await client.orders.address('or_UkLWZg9DAJ', {+ shipping_address: { address1: '9 Corrected Way', city: 'Portland', postal_code: '97201' },+})++// endregion:example++export { order }diff --git a/packages/seller-sdk/examples/orders/cancel.ts b/packages/seller-sdk/examples/orders/cancel.tsnew file mode 100644index 0000000000..12bd974348--- /dev/null+++ b/packages/seller-sdk/examples/orders/cancel.ts@@ -0,0 +1,18 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const order = await client.orders.cancel('or_UkLWZg9DAJ', {+ cancel_reason_id: 'ocr_UkLWZg9DAJ',+ cancel_note: 'Out of stock with the supplier',+ refund_payments: true,+})++// endregion:example++export { order }diff --git a/packages/seller-sdk/examples/orders/get.ts b/packages/seller-sdk/examples/orders/get.tsnew file mode 100644index 0000000000..a449d052c5--- /dev/null+++ b/packages/seller-sdk/examples/orders/get.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const order = await client.orders.get('or_UkLWZg9DAJ', { expand: ['payment_splits'] })++// endregion:example++export { order }diff --git a/packages/seller-sdk/examples/orders/list.ts b/packages/seller-sdk/examples/orders/list.tsnew file mode 100644index 0000000000..15827f734d--- /dev/null+++ b/packages/seller-sdk/examples/orders/list.ts@@ -0,0 +1,18 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: orders, meta } = await client.orders.list({+ fulfillment_status_eq: 'unfulfilled',+ sort: '-completed_at',+ limit: 25,+})++// endregion:example++export { meta, orders }diff --git a/packages/seller-sdk/examples/orders/notes-get.ts b/packages/seller-sdk/examples/orders/notes-get.tsnew file mode 100644index 0000000000..c043586fd0--- /dev/null+++ b/packages/seller-sdk/examples/orders/notes-get.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const order = await client.orders.notes.get('or_UkLWZg9DAJ')++// endregion:example++export { order }diff --git a/packages/seller-sdk/examples/orders/notes-update.ts b/packages/seller-sdk/examples/orders/notes-update.tsnew file mode 100644index 0000000000..c2738ff0f2--- /dev/null+++ b/packages/seller-sdk/examples/orders/notes-update.ts@@ -0,0 +1,16 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const order = await client.orders.notes.update('or_UkLWZg9DAJ', {+ internal_note: '<p>Packed with the fragile insert.</p>',+})++// endregion:example++export { order }diff --git a/packages/seller-sdk/examples/package-types/create.ts b/packages/seller-sdk/examples/package-types/create.tsnew file mode 100644index 0000000000..46ff2d1ba9--- /dev/null+++ b/packages/seller-sdk/examples/package-types/create.ts@@ -0,0 +1,23 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const packageType = await client.packageTypes.create({+ name: 'Medium box',+ kind: 'box',+ length: 40,+ width: 30,+ height: 20,+ dimensions_unit: 'cm',+ max_weight: 10,+ weight_unit: 'kg',+})++// endregion:example++export { packageType }diff --git a/packages/seller-sdk/examples/package-types/delete.ts b/packages/seller-sdk/examples/package-types/delete.tsnew file mode 100644index 0000000000..47a7c1db1a--- /dev/null+++ b/packages/seller-sdk/examples/package-types/delete.ts@@ -0,0 +1,11 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+await client.packageTypes.delete('pkgtype_UkLWZg9DAJ')+// endregion:examplediff --git a/packages/seller-sdk/examples/package-types/get.ts b/packages/seller-sdk/examples/package-types/get.tsnew file mode 100644index 0000000000..5264628b8a--- /dev/null+++ b/packages/seller-sdk/examples/package-types/get.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const packageType = await client.packageTypes.get('pkgtype_UkLWZg9DAJ')++// endregion:example++export { packageType }diff --git a/packages/seller-sdk/examples/package-types/list.ts b/packages/seller-sdk/examples/package-types/list.tsnew file mode 100644index 0000000000..0f7ce4f8a7--- /dev/null+++ b/packages/seller-sdk/examples/package-types/list.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: packageTypes } = await client.packageTypes.list({ owner: 'mine' })++// endregion:example++export { packageTypes }diff --git a/packages/seller-sdk/examples/package-types/update.ts b/packages/seller-sdk/examples/package-types/update.tsnew file mode 100644index 0000000000..781749ac4d--- /dev/null+++ b/packages/seller-sdk/examples/package-types/update.ts@@ -0,0 +1,16 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const packageType = await client.packageTypes.update('pkgtype_UkLWZg9DAJ', {+ max_weight: 15,+})++// endregion:example++export { packageType }diff --git a/packages/seller-sdk/examples/payouts/get.ts b/packages/seller-sdk/examples/payouts/get.tsnew file mode 100644index 0000000000..5aa007a099--- /dev/null+++ b/packages/seller-sdk/examples/payouts/get.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const payout = await client.payouts.get('vpo_UkLWZg9DAJ')++// endregion:example++export { payout }diff --git a/packages/seller-sdk/examples/payouts/list.ts b/packages/seller-sdk/examples/payouts/list.tsnew file mode 100644index 0000000000..14a3b666b9--- /dev/null+++ b/packages/seller-sdk/examples/payouts/list.ts@@ -0,0 +1,17 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: payouts } = await client.payouts.list({+ status_eq: 'completed',+ sort: '-period_end',+})++// endregion:example++export { payouts }diff --git a/packages/seller-sdk/examples/policies/create.ts b/packages/seller-sdk/examples/policies/create.tsnew file mode 100644index 0000000000..b29af059ac--- /dev/null+++ b/packages/seller-sdk/examples/policies/create.ts@@ -0,0 +1,17 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const policy = await client.policies.create({+ name: 'Returns Policy',+ body: '<p>Return anything unopened within 30 days.</p>',+})++// endregion:example++export { policy }diff --git a/packages/seller-sdk/examples/policies/delete.ts b/packages/seller-sdk/examples/policies/delete.tsnew file mode 100644index 0000000000..800ad841f3--- /dev/null+++ b/packages/seller-sdk/examples/policies/delete.ts@@ -0,0 +1,11 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+await client.policies.delete('returns-policy')+// endregion:examplediff --git a/packages/seller-sdk/examples/policies/get.ts b/packages/seller-sdk/examples/policies/get.tsnew file mode 100644index 0000000000..4a14f73f25--- /dev/null+++ b/packages/seller-sdk/examples/policies/get.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const policy = await client.policies.get('returns-policy')++// endregion:example++export { policy }diff --git a/packages/seller-sdk/examples/policies/list.ts b/packages/seller-sdk/examples/policies/list.tsnew file mode 100644index 0000000000..5183b096de--- /dev/null+++ b/packages/seller-sdk/examples/policies/list.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: policies } = await client.policies.list()++// endregion:example++export { policies }diff --git a/packages/seller-sdk/examples/policies/update.ts b/packages/seller-sdk/examples/policies/update.tsnew file mode 100644index 0000000000..2a6f5892a1--- /dev/null+++ b/packages/seller-sdk/examples/policies/update.ts@@ -0,0 +1,16 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const policy = await client.policies.update('returns-policy', {+ body: '<p>Return anything unopened within 60 days.</p>',+})++// endregion:example++export { policy }diff --git a/packages/seller-sdk/examples/product-types/get.ts b/packages/seller-sdk/examples/product-types/get.tsnew file mode 100644index 0000000000..47714aee82--- /dev/null+++ b/packages/seller-sdk/examples/product-types/get.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const productType = await client.productTypes.get('pt_UkLWZg9DAJ')++// endregion:example++export { productType }diff --git a/packages/seller-sdk/examples/product-types/list.ts b/packages/seller-sdk/examples/product-types/list.tsnew file mode 100644index 0000000000..a096bf7ad0--- /dev/null+++ b/packages/seller-sdk/examples/product-types/list.ts@@ -0,0 +1,17 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: productTypes } = await client.productTypes.list({+ name_cont: 'apparel',+ sort: 'name',+})++// endregion:example++export { productTypes }diff --git a/packages/seller-sdk/examples/products/bulk-status-update.ts b/packages/seller-sdk/examples/products/bulk-status-update.tsnew file mode 100644index 0000000000..f27a63a922--- /dev/null+++ b/packages/seller-sdk/examples/products/bulk-status-update.ts@@ -0,0 +1,17 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const result = await client.products.bulkStatusUpdate({+ ids: ['prod_UkLWZg9DAJ', 'prod_9XbR2kQwLm'],+ status: 'archived',+})++// endregion:example++export { result }diff --git a/packages/seller-sdk/examples/products/bulk-submit.ts b/packages/seller-sdk/examples/products/bulk-submit.tsnew file mode 100644index 0000000000..7bd4b588c4--- /dev/null+++ b/packages/seller-sdk/examples/products/bulk-submit.ts@@ -0,0 +1,16 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const result = await client.products.bulkSubmit({+ ids: ['prod_UkLWZg9DAJ', 'prod_9XbR2kQwLm'],+})++// endregion:example++export { result }diff --git a/packages/seller-sdk/examples/products/create.ts b/packages/seller-sdk/examples/products/create.tsnew file mode 100644index 0000000000..2da6fd2a0a--- /dev/null+++ b/packages/seller-sdk/examples/products/create.ts@@ -0,0 +1,18 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const product = await client.products.create({+ name: 'Hand-thrown mug',+ description: '<p>Stoneware, glazed by hand.</p>',+ prices: [{ currency: 'USD', amount: '24.00' }],+})++// endregion:example++export { product }diff --git a/packages/seller-sdk/examples/products/delete.ts b/packages/seller-sdk/examples/products/delete.tsnew file mode 100644index 0000000000..d5084114b0--- /dev/null+++ b/packages/seller-sdk/examples/products/delete.ts@@ -0,0 +1,11 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+await client.products.delete('prod_UkLWZg9DAJ')+// endregion:examplediff --git a/packages/seller-sdk/examples/products/get.ts b/packages/seller-sdk/examples/products/get.tsnew file mode 100644index 0000000000..150682321d--- /dev/null+++ b/packages/seller-sdk/examples/products/get.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const product = await client.products.get('prod_UkLWZg9DAJ', 'variants,media')++// endregion:example++export { product }diff --git a/packages/seller-sdk/examples/products/list.ts b/packages/seller-sdk/examples/products/list.tsnew file mode 100644index 0000000000..6499fcee7b--- /dev/null+++ b/packages/seller-sdk/examples/products/list.ts@@ -0,0 +1,18 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: products, meta } = await client.products.list({+ status_eq: 'draft',+ sort: '-created_at',+ limit: 25,+})++// endregion:example++export { meta, products }diff --git a/packages/seller-sdk/examples/products/update.ts b/packages/seller-sdk/examples/products/update.tsnew file mode 100644index 0000000000..d1d533a2d0--- /dev/null+++ b/packages/seller-sdk/examples/products/update.ts@@ -0,0 +1,16 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const product = await client.products.update('prod_UkLWZg9DAJ', {+ name: 'Hand-thrown mug, large',+})++// endregion:example++export { product }diff --git a/packages/seller-sdk/examples/profile/get.ts b/packages/seller-sdk/examples/profile/get.tsnew file mode 100644index 0000000000..f705609d0f--- /dev/null+++ b/packages/seller-sdk/examples/profile/get.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const profile = await client.profile.get()++// endregion:example++export { profile }diff --git a/packages/seller-sdk/examples/profile/update.ts b/packages/seller-sdk/examples/profile/update.tsnew file mode 100644index 0000000000..aafac00fb2--- /dev/null+++ b/packages/seller-sdk/examples/profile/update.ts@@ -0,0 +1,18 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const profile = await client.profile.update({+ name: 'Acme Outfitters',+ contact_email: '[email protected]',+ legal_name: 'Acme Outfitters Ltd',+})++// endregion:example++export { profile }diff --git a/packages/seller-sdk/examples/requirement-submissions/create.ts b/packages/seller-sdk/examples/requirement-submissions/create.tsnew file mode 100644index 0000000000..9b655b1bce--- /dev/null+++ b/packages/seller-sdk/examples/requirement-submissions/create.ts@@ -0,0 +1,16 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const submission = await client.requirementSubmissions.create('selreq_xxx', {+ note: 'Confirmed.',+})++// endregion:example++export { submission }diff --git a/packages/seller-sdk/examples/requirement-submissions/download.ts b/packages/seller-sdk/examples/requirement-submissions/download.tsnew file mode 100644index 0000000000..dc83d95272--- /dev/null+++ b/packages/seller-sdk/examples/requirement-submissions/download.ts@@ -0,0 +1,28 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+// The onboarding checklist carries each requirement's latest submission.+const { requirements } = await client.onboarding.get()+const submission = requirements.find((requirement) => requirement.submission?.file_url)?.submission++if (submission?.file_url) {+ // Documents are served through the API, so fetch with the session's token+ // and seller, then drive the browser download:+ const response = await fetch(`https://your-store.com${submission.file_url}`, {+ headers: { Authorization: 'Bearer eyJhbGciOi...', 'X-Spree-Seller-Id': 'sel_UkLWZg9DAJ' },+ })+ const url = URL.createObjectURL(await response.blob())+ const link = Object.assign(document.createElement('a'), {+ href: url,+ download: submission.file_name ?? 'document',+ })+ link.click()+ URL.revokeObjectURL(url)+}+// endregion:examplediff --git a/packages/seller-sdk/examples/return-reasons/list.ts b/packages/seller-sdk/examples/return-reasons/list.tsnew file mode 100644index 0000000000..c7cbd68c4e--- /dev/null+++ b/packages/seller-sdk/examples/return-reasons/list.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: reasons } = await client.returnReasons.list()++// endregion:example++export { reasons }diff --git a/packages/seller-sdk/examples/stock-locations/create.ts b/packages/seller-sdk/examples/stock-locations/create.tsnew file mode 100644index 0000000000..c6830e9dd1--- /dev/null+++ b/packages/seller-sdk/examples/stock-locations/create.ts@@ -0,0 +1,21 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const stockLocation = await client.stockLocations.create({+ name: 'Brooklyn warehouse',+ kind: 'warehouse',+ country_code: 'US',+ state_code: 'NY',+ city: 'Brooklyn',+ zipcode: '11201',+})++// endregion:example++export { stockLocation }diff --git a/packages/seller-sdk/examples/stock-locations/get.ts b/packages/seller-sdk/examples/stock-locations/get.tsnew file mode 100644index 0000000000..50c00f8f49--- /dev/null+++ b/packages/seller-sdk/examples/stock-locations/get.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const stockLocation = await client.stockLocations.get('sloc_UkLWZg9DAJ')++// endregion:example++export { stockLocation }diff --git a/packages/seller-sdk/examples/stock-locations/list.ts b/packages/seller-sdk/examples/stock-locations/list.tsnew file mode 100644index 0000000000..d2f233e514--- /dev/null+++ b/packages/seller-sdk/examples/stock-locations/list.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: stockLocations } = await client.stockLocations.list()++// endregion:example++export { stockLocations }diff --git a/packages/seller-sdk/examples/stock-locations/update.ts b/packages/seller-sdk/examples/stock-locations/update.tsnew file mode 100644index 0000000000..8073f3656d--- /dev/null+++ b/packages/seller-sdk/examples/stock-locations/update.ts@@ -0,0 +1,17 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const stockLocation = await client.stockLocations.update('sloc_UkLWZg9DAJ', {+ returns_enabled: true,+ phone: '+1 718 555 0100',+})++// endregion:example++export { stockLocation }diff --git a/packages/seller-sdk/examples/tax-identifiers/create.ts b/packages/seller-sdk/examples/tax-identifiers/create.tsnew file mode 100644index 0000000000..a17fd1b4fa--- /dev/null+++ b/packages/seller-sdk/examples/tax-identifiers/create.ts@@ -0,0 +1,17 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const taxIdentifier = await client.taxIdentifiers.create({+ kind: 'eu_vat',+ value: 'DE123456789',+})++// endregion:example++export { taxIdentifier }diff --git a/packages/seller-sdk/examples/tax-identifiers/delete.ts b/packages/seller-sdk/examples/tax-identifiers/delete.tsnew file mode 100644index 0000000000..2ddc880335--- /dev/null+++ b/packages/seller-sdk/examples/tax-identifiers/delete.ts@@ -0,0 +1,11 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+await client.taxIdentifiers.remove('txi_xxx')+// endregion:examplediff --git a/packages/seller-sdk/examples/tax-identifiers/list.ts b/packages/seller-sdk/examples/tax-identifiers/list.tsnew file mode 100644index 0000000000..5c2e576230--- /dev/null+++ b/packages/seller-sdk/examples/tax-identifiers/list.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: taxIdentifiers } = await client.taxIdentifiers.list()++// endregion:example++export { taxIdentifiers }diff --git a/packages/seller-sdk/examples/tax-identifiers/update.ts b/packages/seller-sdk/examples/tax-identifiers/update.tsnew file mode 100644index 0000000000..bb10d8e823--- /dev/null+++ b/packages/seller-sdk/examples/tax-identifiers/update.ts@@ -0,0 +1,16 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const taxIdentifier = await client.taxIdentifiers.update('txi_xxx', {+ value: 'DE987654321',+})++// endregion:example++export { taxIdentifier }diff --git a/packages/seller-sdk/examples/tax-identifiers/validate.ts b/packages/seller-sdk/examples/tax-identifiers/validate.tsnew file mode 100644index 0000000000..5e977bd605--- /dev/null+++ b/packages/seller-sdk/examples/tax-identifiers/validate.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const taxIdentifier = await client.taxIdentifiers.validate('txi_xxx')++// endregion:example++export { taxIdentifier }diff --git a/packages/seller-sdk/examples/team/delete.ts b/packages/seller-sdk/examples/team/delete.tsnew file mode 100644index 0000000000..b1f8a68c2f--- /dev/null+++ b/packages/seller-sdk/examples/team/delete.ts@@ -0,0 +1,11 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+await client.team.remove('adm_xxx')+// endregion:examplediff --git a/packages/seller-sdk/examples/team/invite.ts b/packages/seller-sdk/examples/team/invite.tsnew file mode 100644index 0000000000..117589be09--- /dev/null+++ b/packages/seller-sdk/examples/team/invite.ts@@ -0,0 +1,16 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const invitation = await client.team.invite({+ email: '[email protected]',+})++// endregion:example++export { invitation }diff --git a/packages/seller-sdk/examples/team/list.ts b/packages/seller-sdk/examples/team/list.tsnew file mode 100644index 0000000000..50d3b9b624--- /dev/null+++ b/packages/seller-sdk/examples/team/list.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: members } = await client.team.list()++// endregion:example++export { members }diff --git a/packages/seller-sdk/examples/tracking-carriers/list.ts b/packages/seller-sdk/examples/tracking-carriers/list.tsnew file mode 100644index 0000000000..44e1f464dc--- /dev/null+++ b/packages/seller-sdk/examples/tracking-carriers/list.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: carriers } = await client.trackingCarriers.list()++// endregion:example++export { carriers }diff --git a/packages/seller-sdk/examples/transfers/get.ts b/packages/seller-sdk/examples/transfers/get.tsnew file mode 100644index 0000000000..b455518e55--- /dev/null+++ b/packages/seller-sdk/examples/transfers/get.ts@@ -0,0 +1,14 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const transfer = await client.transfers.get('vtr_UkLWZg9DAJ')++// endregion:example++export { transfer }diff --git a/packages/seller-sdk/examples/transfers/list.ts b/packages/seller-sdk/examples/transfers/list.tsnew file mode 100644index 0000000000..a91b8839a7--- /dev/null+++ b/packages/seller-sdk/examples/transfers/list.ts@@ -0,0 +1,17 @@+import { createSellerClient } from '@spree/seller-sdk'++const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+})++// region:example+const { data: transfers } = await client.transfers.list({+ payout_id_eq: 'vpo_UkLWZg9DAJ',+ sort: '-created_at',+})++// endregion:example++export { transfers }diff --git a/packages/seller-sdk/package.json b/packages/seller-sdk/package.jsonindex 3bde068263..6ea5ee429b 100644--- a/packages/seller-sdk/package.json+++ b/packages/seller-sdk/package.json@@ -49,7 +49,8 @@"generate:params": "tsx ../sdk-core/scripts/generate-params.ts seller","build": "tsup","dev": "tsup --watch",- "typecheck": "tsc --noEmit",+ "typecheck": "tsc --noEmit && tsc --noEmit -p tsconfig.examples.json",+ "examples:typecheck": "tsc --noEmit -p tsconfig.examples.json","test": "vitest run --passWithNoTests","test:watch": "vitest","lint": "biome check src",diff --git a/packages/seller-sdk/tests/code-samples.test.ts b/packages/seller-sdk/tests/code-samples.test.tsnew file mode 100644index 0000000000..722c21e710--- /dev/null+++ b/packages/seller-sdk/tests/code-samples.test.ts@@ -0,0 +1,48 @@+import { readdirSync, readFileSync } from 'node:fs'+import path from 'node:path'+import { fileURLToPath } from 'node:url'+import { describe, expect, it } from 'vitest'+import { parse } from 'yaml'++const HTTP_METHODS = ['get', 'post', 'put', 'patch', 'delete']+const PACKAGE_ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..')++type CodeSample = { label?: string; source?: string }++describe('Seller SDK examples', () => {+ it('appear on every endpoint in the Seller API reference', () => {+ const spec = parse(+ readFileSync(path.resolve(PACKAGE_ROOT, '../../docs/api-reference/seller.yaml'), 'utf8'),+ )+ const missing: string[] = []++ for (const [route, operations] of Object.entries<+ Record<string, { 'x-codeSamples'?: CodeSample[] }>+ >(spec.paths)) {+ for (const [method, operation] of Object.entries(operations)) {+ if (!HTTP_METHODS.includes(method)) continue++ const hasSample = operation['x-codeSamples']?.some(+ (sample) => sample.label === 'Spree Seller SDK' && sample.source?.trim(),+ )+ if (!hasSample) missing.push(`${method.toUpperCase()} ${route}`)+ }+ }++ expect(missing).toEqual([])+ })++ // The API reference shows only the code between these markers, and a+ // formatter can drop a trailing marker along with the code around it.+ it('mark the code the API reference shows', () => {+ const examplesRoot = path.join(PACKAGE_ROOT, 'examples')+ const unmarked = readdirSync(examplesRoot, { recursive: true, encoding: 'utf8' })+ .filter((file) => file.endsWith('.ts'))+ .filter((file) => {+ const source = readFileSync(path.join(examplesRoot, file), 'utf8')+ return !/\/\/ region:example\n[\s\S]+?\/\/ endregion:example/.test(source)+ })++ expect(unmarked).toEqual([])+ })+})diff --git a/packages/seller-sdk/tsconfig.examples.json b/packages/seller-sdk/tsconfig.examples.jsonnew file mode 100644index 0000000000..d3070cc6ec--- /dev/null+++ b/packages/seller-sdk/tsconfig.examples.json@@ -0,0 +1,16 @@+{+ "extends": "./tsconfig.json",+ "compilerOptions": {+ "noEmit": true,+ "rootDir": "./",+ "noUnusedLocals": false,+ "noUnusedParameters": false,+ "paths": {+ "@/types": ["./src/types/generated/index.ts"],+ "@spree/seller-sdk": ["./src/index.ts"],+ "@spree/seller-sdk/types": ["./src/types/generated/index.ts"]+ }+ },+ "include": ["examples/**/*.ts", "src/**/*.ts"],+ "exclude": ["node_modules", "dist", "tests"]+}diff --git a/spree/api/spec/integration/spree/api/v3/seller/auth_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/auth_spec.rbindex 6d9d77b34f..9de0971823 100644--- a/spree/api/spec/integration/spree/api/v3/seller/auth_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/auth_spec.rb@@ -35,6 +35,8 @@ RSpec.describe 'Seller Authentication API', type: :request, swagger_doc: 'api-rewhile still letting sellers sign in with a password.DESC+ seller_sdk_example 'auth/login', as: :guest+request_body_forresponse '200', 'login successful' do@@ -76,6 +78,8 @@ RSpec.describe 'Seller Authentication API', type: :request, swagger_doc: 'api-rerevoked mid-session is refused rather than renewed.DESC+ seller_sdk_example 'auth/refresh', as: :guest+response '200', 'refresh successful' dolet(:refresh_token_record) docreate(:refresh_token, :for_admin, user: existing_seller_user,@@ -113,6 +117,8 @@ RSpec.describe 'Seller Authentication API', type: :request, swagger_doc: 'api-reproduces 'application/json'description 'Revokes the refresh-token cookie, ending the seller session.'+ seller_sdk_example 'auth/logout', as: :guest+response '204', 'logout successful' dorun_test!end@@ -129,6 +135,8 @@ RSpec.describe 'Seller Authentication API', type: :request, swagger_doc: 'api-reanyone has signed in.DESC+ seller_sdk_example 'auth/providers', as: :guest+response '200', 'providers listed' doschema '$ref' => '#/components/schemas/AuthProvidersResponse'diff --git a/spree/api/spec/integration/spree/api/v3/seller/balances_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/balances_spec.rbindex 23590f3ffe..c2aef10bc8 100644--- a/spree/api/spec/integration/spree/api/v3/seller/balances_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/balances_spec.rb@@ -35,6 +35,8 @@ RSpec.describe 'Seller Balances API', type: :request, swagger_doc: 'api-referencand there is nothing to page.DESC+ seller_sdk_example 'balances/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'balances listed' dodiff --git a/spree/api/spec/integration/spree/api/v3/seller/claims_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/claims_spec.rbindex 6188b9ff89..b74457a330 100644--- a/spree/api/spec/integration/spree/api/v3/seller/claims_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/claims_spec.rb@@ -25,6 +25,8 @@ RSpec.describe 'Seller Claims API', type: :request, swagger_doc: 'api-reference/security [bearer_auth: []]description "Problems reported on one of this seller's orders."+ seller_sdk_example 'order-claims/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truefilter_parameters_for@@ -58,6 +60,8 @@ RSpec.describe 'Seller Claims API', type: :request, swagger_doc: 'api-reference/catalogue — a rival's is not theirs to promise.DESC+ seller_sdk_example 'order-claims/create'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -90,6 +94,8 @@ RSpec.describe 'Seller Claims API', type: :request, swagger_doc: 'api-reference/security [bearer_auth: []]description 'Accepts that the claim is good.'+ seller_sdk_example 'order-claims/approve'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'claim approved' do@@ -121,6 +127,8 @@ RSpec.describe 'Seller Claims API', type: :request, swagger_doc: 'api-reference/seller can never settle out of a sibling's money.DESC+ seller_sdk_example 'order-claims/resolve'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -151,6 +159,8 @@ RSpec.describe 'Seller Claims API', type: :request, swagger_doc: 'api-reference/security [bearer_auth: []]description 'Turns the claim down.'+ seller_sdk_example 'order-claims/deny'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for(required: false)@@ -179,6 +189,8 @@ RSpec.describe 'Seller Claims API', type: :request, swagger_doc: 'api-reference/security [bearer_auth: []]description 'Withdraws a claim that is no longer needed.'+ seller_sdk_example 'order-claims/cancel'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for(required: false)@@ -209,6 +221,8 @@ RSpec.describe 'Seller Claims API', type: :request, swagger_doc: 'api-reference/Read-only: a seller picks from the operator's vocabulary.DESC+ seller_sdk_example 'claim-reasons/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truefilter_parameters_fordiff --git a/spree/api/spec/integration/spree/api/v3/seller/countries_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/countries_spec.rbindex 007d9f9e7d..73162e6b59 100644--- a/spree/api/spec/integration/spree/api/v3/seller/countries_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/countries_spec.rb@@ -20,6 +20,8 @@ RSpec.describe 'Seller Countries API', type: :request, swagger_doc: 'api-referenUnpaginated. An address dropdown needs all ~250 at once.DESC+ seller_sdk_example 'countries/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'countries listed' dodiff --git a/spree/api/spec/integration/spree/api/v3/seller/delivery_methods_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/delivery_methods_spec.rbindex 44f0aebaab..e2004debe0 100644--- a/spree/api/spec/integration/spree/api/v3/seller/delivery_methods_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/delivery_methods_spec.rb@@ -27,6 +27,8 @@ RSpec.describe 'Seller Delivery Methods API', type: :request, swagger_doc: 'api-write against it is a 404.DESC+ seller_sdk_example 'delivery-methods/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueparameter name: :page, in: :query, type: :integer, required: false, description: 'Page number'parameter name: :limit, in: :query, type: :integer, required: false, description: 'Records per page (max 100)'@@ -64,6 +66,8 @@ RSpec.describe 'Seller Delivery Methods API', type: :request, swagger_doc: 'api-because carrier accounts belong to the marketplace.DESC+ seller_sdk_example 'delivery-methods/create'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -106,6 +110,8 @@ RSpec.describe 'Seller Delivery Methods API', type: :request, swagger_doc: 'api-produces 'application/json'security [bearer_auth: []]+ seller_sdk_example 'delivery-methods/get'+response '200', 'delivery method found' dolet(:Authorization) { "Bearer #{seller_jwt_token}" }let(:'X-Spree-Seller-Id') { seller.prefixed_id }@@ -124,6 +130,8 @@ RSpec.describe 'Seller Delivery Methods API', type: :request, swagger_doc: 'api-security [bearer_auth: []]description "Only the seller's own methods can be changed — a marketplace method shared with sellers is read-only."+ seller_sdk_example 'delivery-methods/update'+request_body_forresponse '200', 'delivery method updated' do@@ -144,6 +152,8 @@ RSpec.describe 'Seller Delivery Methods API', type: :request, swagger_doc: 'api-tags 'Delivery Methods'security [bearer_auth: []]+ seller_sdk_example 'delivery-methods/delete'+response '204', 'delivery method retired' dolet(:Authorization) { "Bearer #{seller_jwt_token}" }let(:'X-Spree-Seller-Id') { seller.prefixed_id }@@ -161,6 +171,8 @@ RSpec.describe 'Seller Delivery Methods API', type: :request, swagger_doc: 'api-security [bearer_auth: []]description 'The eligibility rules a seller may put on their own method, with the preference schema each form is rendered from.'+ seller_sdk_example 'delivery-methods/rule-types'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'rule types listed' do@@ -195,6 +207,8 @@ RSpec.describe 'Seller Delivery Methods API', type: :request, swagger_doc: 'api-produces 'application/json'security [bearer_auth: []]+ seller_sdk_example 'delivery-methods/calculators'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'calculators listed' dodiff --git a/spree/api/spec/integration/spree/api/v3/seller/delivery_profiles_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/delivery_profiles_spec.rbindex 9f8590d479..b6a85bb657 100644--- a/spree/api/spec/integration/spree/api/v3/seller/delivery_profiles_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/delivery_profiles_spec.rb@@ -22,6 +22,8 @@ RSpec.describe 'Seller Delivery Profiles API', type: :request, swagger_doc: 'apimarked `default`.DESC+ seller_sdk_example 'delivery-profiles/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueparameter name: :page, in: :query, type: :integer, required: false, description: 'Page number'parameter name: :limit, in: :query, type: :integer, required: false, description: 'Records per page (max 100)'diff --git a/spree/api/spec/integration/spree/api/v3/seller/delivery_zones_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/delivery_zones_spec.rbindex 2bc3b35179..3bcdcb890f 100644--- a/spree/api/spec/integration/spree/api/v3/seller/delivery_zones_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/delivery_zones_spec.rb@@ -26,6 +26,8 @@ RSpec.describe 'Seller Delivery Zones API', type: :request, swagger_doc: 'api-reasks for.DESC+ seller_sdk_example 'delivery-zones/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueparameter name: :delivery_profile_id, in: :query, type: :string, required: false,description: 'Only zones under this delivery profile'diff --git a/spree/api/spec/integration/spree/api/v3/seller/exchanges_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/exchanges_spec.rbindex 5cb88622a7..8059577fd3 100644--- a/spree/api/spec/integration/spree/api/v3/seller/exchanges_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/exchanges_spec.rb@@ -29,6 +29,8 @@ RSpec.describe 'Seller Exchanges API', type: :request, swagger_doc: 'api-referensecurity [bearer_auth: []]description "Goods swapped for different ones on one of this seller's orders."+ seller_sdk_example 'order-exchanges/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truefilter_parameters_for@@ -62,6 +64,8 @@ RSpec.describe 'Seller Exchanges API', type: :request, swagger_doc: 'api-referento promise and reads as missing.DESC+ seller_sdk_example 'order-exchanges/create'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -100,6 +104,8 @@ RSpec.describe 'Seller Exchanges API', type: :request, swagger_doc: 'api-referena partial or damaged receipt; omit them to receive everything.DESC+ seller_sdk_example 'order-exchanges/receive'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for(required: false)@@ -141,6 +147,8 @@ RSpec.describe 'Seller Exchanges API', type: :request, swagger_doc: 'api-referentime — which is why it takes a refund method.DESC+ seller_sdk_example 'order-exchanges/fulfill'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for(required: false)@@ -174,6 +182,8 @@ RSpec.describe 'Seller Exchanges API', type: :request, swagger_doc: 'api-referensecurity [bearer_auth: []]description 'Withdraws an exchange before the goods come back.'+ seller_sdk_example 'order-exchanges/cancel'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for(required: false)diff --git a/spree/api/spec/integration/spree/api/v3/seller/exports_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/exports_spec.rbindex 168ba3ea09..824b047858 100644--- a/spree/api/spec/integration/spree/api/v3/seller/exports_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/exports_spec.rb@@ -31,6 +31,8 @@ RSpec.describe 'Seller Exports API', type: :request, swagger_doc: 'api-referenceuntil `done` is true, then fetch `download_url`.DESC+ seller_sdk_example 'exports/create'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -70,6 +72,8 @@ RSpec.describe 'Seller Exports API', type: :request, swagger_doc: 'api-referencethen fetch `download_url`.DESC+ seller_sdk_example 'exports/get'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'export found' do@@ -112,6 +116,8 @@ RSpec.describe 'Seller Exports API', type: :request, swagger_doc: 'api-referenceso the seller's own session authorizes every download.DESC+ seller_sdk_example 'exports/download'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '422', 'export is still being written' dodiff --git a/spree/api/spec/integration/spree/api/v3/seller/files_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/files_spec.rbindex 6e8eb5a7e4..e557d37354 100644--- a/spree/api/spec/integration/spree/api/v3/seller/files_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/files_spec.rb@@ -34,6 +34,8 @@ RSpec.describe 'Seller Files API', type: :request, swagger_doc: 'api-reference/sdigest, base64-encoded.DESC+ seller_sdk_example 'files/create'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_fordiff --git a/spree/api/spec/integration/spree/api/v3/seller/fulfillments_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/fulfillments_spec.rbindex d51c9d197c..5abdc7cd97 100644--- a/spree/api/spec/integration/spree/api/v3/seller/fulfillments_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/fulfillments_spec.rb@@ -29,6 +29,8 @@ RSpec.describe 'Seller Fulfillments API', type: :request, swagger_doc: 'api-refewhatever ids are sent.DESC+ seller_sdk_example 'order-fulfillments/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truefilter_parameters_for@@ -71,6 +73,8 @@ RSpec.describe 'Seller Fulfillments API', type: :request, swagger_doc: 'api-referemainder splits onto a new one. Omit it to ship the lot.DESC+ seller_sdk_example 'order-fulfillments/fulfill'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for(required: false)@@ -106,6 +110,8 @@ RSpec.describe 'Seller Fulfillments API', type: :request, swagger_doc: 'api-referates again from there, or pick a different one of its quoted rates.DESC+ seller_sdk_example 'order-fulfillments/update'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -138,6 +144,8 @@ RSpec.describe 'Seller Fulfillments API', type: :request, swagger_doc: 'api-refeon the shelf and the carrier is stood down.DESC+ seller_sdk_example 'order-fulfillments/cancel'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'parcel canceled' do@@ -170,6 +178,8 @@ RSpec.describe 'Seller Fulfillments API', type: :request, swagger_doc: 'api-refesplitting rewrites more than one.DESC+ seller_sdk_example 'order-fulfillments/split'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -198,6 +208,8 @@ RSpec.describe 'Seller Fulfillments API', type: :request, swagger_doc: 'api-refesecurity [bearer_auth: []]description "The consignments of one of this seller's parcels, one per tracking number, with each carrier status."+ seller_sdk_example 'order-deliveries/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueparameter name: :page, in: :query, type: :integer, required: false, description: 'Page number'parameter name: :limit, in: :query, type: :integer, required: false, description: 'Records per page (max 100)'@@ -226,6 +238,8 @@ RSpec.describe 'Seller Fulfillments API', type: :request, swagger_doc: 'api-refesecurity [bearer_auth: []]description 'Adds a tracked consignment to the parcel: a second box, or a freight number covering several pallets.'+ seller_sdk_example 'order-deliveries/create'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -257,6 +271,8 @@ RSpec.describe 'Seller Fulfillments API', type: :request, swagger_doc: 'api-refesecurity [bearer_auth: []]description 'Corrects the tracking number, carrier or link. A corrected number starts the carrier journey over.'+ seller_sdk_example 'order-deliveries/update'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -287,6 +303,8 @@ RSpec.describe 'Seller Fulfillments API', type: :request, swagger_doc: 'api-refesecurity [bearer_auth: []]description "Every label bought or uploaded for one of this seller's parcels, refunded ones included."+ seller_sdk_example 'order-labels/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueparameter name: :page, in: :query, type: :integer, required: false, description: 'Page number'parameter name: :limit, in: :query, type: :integer, required: false, description: 'Records per page (max 100)'@@ -320,6 +338,8 @@ RSpec.describe 'Seller Fulfillments API', type: :request, swagger_doc: 'api-refewithout a file is refused.DESC+ seller_sdk_example 'order-labels/upload'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -357,6 +377,8 @@ RSpec.describe 'Seller Fulfillments API', type: :request, swagger_doc: 'api-refeso a carrier an extension adds appears without a client change.DESC+ seller_sdk_example 'tracking-carriers/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'carriers listed' dodiff --git a/spree/api/spec/integration/spree/api/v3/seller/imports_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/imports_spec.rbindex 428295b659..c38dc40dc0 100644--- a/spree/api/spec/integration/spree/api/v3/seller/imports_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/imports_spec.rb@@ -22,6 +22,8 @@ RSpec.describe 'Seller Imports API', type: :request, swagger_doc: 'api-referencesecurity [bearer_auth: []]description "This seller's product CSV imports, queued or finished. Another seller's imports are never listed."+ seller_sdk_example 'imports/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueparameter name: :page, in: :query, type: :integer, required: false, description: 'Page number'parameter name: :limit, in: :query, type: :integer, required: false, description: 'Records per page (max 100)'@@ -55,6 +57,8 @@ RSpec.describe 'Seller Imports API', type: :request, swagger_doc: 'api-reference`PATCH /imports/{id}/complete_mapping`. Imported products are created as drafts.DESC+ seller_sdk_example 'imports/create'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -88,6 +92,8 @@ RSpec.describe 'Seller Imports API', type: :request, swagger_doc: 'api-referencesecurity [bearer_auth: []]description "The rows of one of this seller's imports, each with its status and any validation errors."+ seller_sdk_example 'imports/rows-list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueparameter name: :page, in: :query, type: :integer, required: false, description: 'Page number'parameter name: :limit, in: :query, type: :integer, required: false, description: 'Records per page (max 100)'@@ -123,6 +129,8 @@ RSpec.describe 'Seller Imports API', type: :request, swagger_doc: 'api-referencerequired field is left unmapped (`details.missing_required_fields`).DESC+ seller_sdk_example 'imports/complete-mapping'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for(required: false)diff --git a/spree/api/spec/integration/spree/api/v3/seller/invitation_acceptances_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/invitation_acceptances_spec.rbindex 5aa0ec4830..20d60b5a16 100644--- a/spree/api/spec/integration/spree/api/v3/seller/invitation_acceptances_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/invitation_acceptances_spec.rb@@ -29,6 +29,8 @@ RSpec.describe 'Seller Invitation Acceptance API', type: :request, swagger_doc:answers `404` here too.DESC+ seller_sdk_example 'auth/lookup-invitation', as: :guest+parameter name: :token, in: :query, type: :string, required: true,description: 'The token from the emailed link'@@ -74,6 +76,8 @@ RSpec.describe 'Seller Invitation Acceptance API', type: :request, swagger_doc:how the person proves the account is theirs.DESC+ seller_sdk_example 'auth/accept-invitation', as: :guest+parameter name: :token, in: :query, type: :string, required: true,description: 'The token from the emailed link'request_body_fordiff --git a/spree/api/spec/integration/spree/api/v3/seller/invitations_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/invitations_spec.rbindex 6e8796bddc..5d61aff94b 100644--- a/spree/api/spec/integration/spree/api/v3/seller/invitations_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/invitations_spec.rb@@ -30,6 +30,8 @@ RSpec.describe 'Seller Invitations API', type: :request, swagger_doc: 'api-referwithdrawing one is bookkeeping on the offer itself, so it lives here.DESC+ seller_sdk_example 'invitations/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'invitations listed' do@@ -65,6 +67,8 @@ RSpec.describe 'Seller Invitations API', type: :request, swagger_doc: 'api-refercopy the link.DESC+ seller_sdk_example 'invitations/acceptance-link'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'acceptance link found' do@@ -94,6 +98,8 @@ RSpec.describe 'Seller Invitations API', type: :request, swagger_doc: 'api-referre-sent.DESC+ seller_sdk_example 'invitations/resend'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'invitation resent' do@@ -130,6 +136,8 @@ RSpec.describe 'Seller Invitations API', type: :request, swagger_doc: 'api-refersecurity [bearer_auth: []]description 'Withdraws an offer that has not been accepted.'+ seller_sdk_example 'invitations/delete'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '204', 'invitation revoked' dodiff --git a/spree/api/spec/integration/spree/api/v3/seller/me_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/me_spec.rbindex 06c5a39a76..f4ca887369 100644--- a/spree/api/spec/integration/spree/api/v3/seller/me_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/me_spec.rb@@ -21,6 +21,8 @@ RSpec.describe 'Seller Account API', type: :request, swagger_doc: 'api-referencethere is no answer spanning all of them.DESC+ seller_sdk_example 'me/get', as: :user+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: false,description: 'The seller to report capability for. Omit to list sellers without narrowing permissions.'@@ -67,6 +69,8 @@ RSpec.describe 'Seller Account API', type: :request, swagger_doc: 'api-reference`email` is identity-bound and cannot be changed here.DESC+ seller_sdk_example 'me/update', as: :user+request_body_forresponse '200', 'account updated' dodiff --git a/spree/api/spec/integration/spree/api/v3/seller/onboarding_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/onboarding_spec.rbindex 6b5b23c32e..0f3bbf56e6 100644--- a/spree/api/spec/integration/spree/api/v3/seller/onboarding_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/onboarding_spec.rb@@ -32,6 +32,8 @@ RSpec.describe 'Seller Onboarding API', type: :request, swagger_doc: 'api-referecomplete answer rather than a missing one.DESC+ seller_sdk_example 'onboarding/get'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'checklist returned' do@@ -73,6 +75,8 @@ RSpec.describe 'Seller Onboarding API', type: :request, swagger_doc: 'api-referere-render from one response.DESC+ seller_sdk_example 'onboarding/submit-for-review'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'submitted for review' do@@ -118,6 +122,8 @@ RSpec.describe 'Seller Onboarding API', type: :request, swagger_doc: 'api-refere`{ "url": null }` when the provider hosts no onboarding.DESC+ seller_sdk_example 'onboarding/payout-account'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_fordiff --git a/spree/api/spec/integration/spree/api/v3/seller/orders_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/orders_spec.rbindex ab74b91582..94ac73d25e 100644--- a/spree/api/spec/integration/spree/api/v3/seller/orders_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/orders_spec.rb@@ -30,6 +30,8 @@ RSpec.describe 'Seller Orders API', type: :request, swagger_doc: 'api-reference/nobody's order.DESC+ seller_sdk_example 'orders/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueparameter name: :page, in: :query, type: :integer, required: false, description: 'Page number'parameter name: :limit, in: :query, type: :integer, required: false, description: 'Records per page (max 100)'@@ -70,6 +72,8 @@ RSpec.describe 'Seller Orders API', type: :request, swagger_doc: 'api-reference/between the buyer and the operator.DESC+ seller_sdk_example 'orders/get'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'order found' do@@ -121,6 +125,8 @@ RSpec.describe 'Seller Orders API', type: :request, swagger_doc: 'api-reference/what that order was paid, and a partial figure is a return.DESC+ seller_sdk_example 'orders/cancel'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for(required: false)@@ -158,6 +164,8 @@ RSpec.describe 'Seller Orders API', type: :request, swagger_doc: 'api-reference/nothing else about it, its totals included, is the seller's to change.DESC+ seller_sdk_example 'orders/address-update'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -200,6 +208,8 @@ RSpec.describe 'Seller Orders API', type: :request, swagger_doc: 'api-reference/the whole sale.DESC+ seller_sdk_example 'orders/notes-get'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'notes' do@@ -226,6 +236,8 @@ RSpec.describe 'Seller Orders API', type: :request, swagger_doc: 'api-reference/`internal_note_html` reads it back.DESC+ seller_sdk_example 'orders/notes-update'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -265,6 +277,8 @@ RSpec.describe 'Seller Orders API', type: :request, swagger_doc: 'api-reference/what the list holds. Retired reasons are left out.DESC+ seller_sdk_example 'order-cancellation-reasons/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truefilter_parameters_fordiff --git a/spree/api/spec/integration/spree/api/v3/seller/package_types_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/package_types_spec.rbindex ab17a3e086..a8cca84364 100644--- a/spree/api/spec/integration/spree/api/v3/seller/package_types_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/package_types_spec.rb@@ -34,6 +34,8 @@ RSpec.describe 'Seller Package Types API', type: :request, swagger_doc: 'api-refwith — its size and weight are added to every rate.DESC+ seller_sdk_example 'package-types/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueparameter name: :owner, in: :query, required: false, schema: { type: :string, enum: ['mine'] },description: "Narrows the list to the seller's own packaging, leaving out the marketplace's shared rows"@@ -71,6 +73,8 @@ RSpec.describe 'Seller Package Types API', type: :request, swagger_doc: 'api-refdifferent owner's row and is left alone.DESC+ seller_sdk_example 'package-types/create'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -115,6 +119,8 @@ RSpec.describe 'Seller Package Types API', type: :request, swagger_doc: 'api-refmarketplace row they may pack into.DESC+ seller_sdk_example 'package-types/get'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'package type found' do@@ -150,6 +156,8 @@ RSpec.describe 'Seller Package Types API', type: :request, swagger_doc: 'api-refedit and answers 404.DESC+ seller_sdk_example 'package-types/update'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -177,6 +185,8 @@ RSpec.describe 'Seller Package Types API', type: :request, swagger_doc: 'api-refback to the marketplace's box.DESC+ seller_sdk_example 'package-types/delete'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '204', 'package type deleted' dodiff --git a/spree/api/spec/integration/spree/api/v3/seller/password_resets_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/password_resets_spec.rbindex 47391ff208..c647658a5c 100644--- a/spree/api/spec/integration/spree/api/v3/seller/password_resets_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/password_resets_spec.rb@@ -27,6 +27,8 @@ RSpec.describe 'Seller Password Resets API', type: :request, swagger_doc: 'api-rto webhook endpoints.DESC+ seller_sdk_example 'auth/request-password-reset', as: :guest+request_body_forresponse '202', 'reset requested' do@@ -55,6 +57,8 @@ RSpec.describe 'Seller Password Resets API', type: :request, swagger_doc: 'api-rrefused exactly as an expired one.DESC+ seller_sdk_example 'auth/reset-password', as: :guest+parameter name: :id, in: :path, type: :string, description: 'The reset token from the emailed link'request_body_fordiff --git a/spree/api/spec/integration/spree/api/v3/seller/payouts_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/payouts_spec.rbindex bcda50207d..64be12b037 100644--- a/spree/api/spec/integration/spree/api/v3/seller/payouts_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/payouts_spec.rb@@ -32,6 +32,8 @@ RSpec.describe 'Seller Payouts API', type: :request, swagger_doc: 'api-referenceconfirmed by the payout provider or the operator.DESC+ seller_sdk_example 'payouts/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueparameter name: :page, in: :query, type: :integer, required: false, description: 'Page number'parameter name: :limit, in: :query, type: :integer, required: false, description: 'Records per page (max 100)'@@ -65,6 +67,8 @@ RSpec.describe 'Seller Payouts API', type: :request, swagger_doc: 'api-referencesecurity [bearer_auth: []]description "One of this seller's settlements. Another seller's is not found, whatever id is sent."+ seller_sdk_example 'payouts/get'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'payout found' dodiff --git a/spree/api/spec/integration/spree/api/v3/seller/policies_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/policies_spec.rbindex d91bc76924..570e6b8775 100644--- a/spree/api/spec/integration/spree/api/v3/seller/policies_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/policies_spec.rb@@ -28,6 +28,8 @@ RSpec.describe 'Seller Policies API', type: :request, swagger_doc: 'api-referencmarketplace's onboarding checklist.DESC+ seller_sdk_example 'policies/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueparameter name: :page, in: :query, type: :integer, required: false, description: 'Page number'parameter name: :limit, in: :query, type: :integer, required: false, description: 'Records per page (max 100)'@@ -64,6 +66,8 @@ RSpec.describe 'Seller Policies API', type: :request, swagger_doc: 'api-referencthe onboarding check matches on it.DESC+ seller_sdk_example 'policies/create'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -94,6 +98,8 @@ RSpec.describe 'Seller Policies API', type: :request, swagger_doc: 'api-referencsecurity [bearer_auth: []]description 'Returns one of this seller\'s policies, by prefixed ID or slug.'+ seller_sdk_example 'policies/get'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'policy found' do@@ -126,6 +132,8 @@ RSpec.describe 'Seller Policies API', type: :request, swagger_doc: 'api-referencsecurity [bearer_auth: []]description 'Rewrites one of this seller\'s policies.'+ seller_sdk_example 'policies/update'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -148,6 +156,8 @@ RSpec.describe 'Seller Policies API', type: :request, swagger_doc: 'api-referencsecurity [bearer_auth: []]description 'Withdraws one of this seller\'s policies.'+ seller_sdk_example 'policies/delete'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '204', 'policy deleted' dodiff --git a/spree/api/spec/integration/spree/api/v3/seller/product_types_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/product_types_spec.rbindex cdfe83cde4..721bc28a36 100644--- a/spree/api/spec/integration/spree/api/v3/seller/product_types_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/product_types_spec.rb@@ -27,6 +27,8 @@ RSpec.describe 'Seller Product Types API', type: :request, swagger_doc: 'api-refon the product.DESC+ seller_sdk_example 'product-types/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueparameter name: :page, in: :query, type: :integer, required: false, description: 'Page number'parameter name: :limit, in: :query, type: :integer, required: false, description: 'Records per page (max 100)'@@ -57,6 +59,8 @@ RSpec.describe 'Seller Product Types API', type: :request, swagger_doc: 'api-refproduces 'application/json'security [bearer_auth: []]+ seller_sdk_example 'product-types/get'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueparameter name: :id, in: :path, type: :string, required: true, description: 'Product type ID'diff --git a/spree/api/spec/integration/spree/api/v3/seller/products_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/products_spec.rbindex cff06e0b6a..d0def6040c 100644--- a/spree/api/spec/integration/spree/api/v3/seller/products_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/products_spec.rb@@ -20,6 +20,8 @@ RSpec.describe 'Seller Products API', type: :request, swagger_doc: 'api-referencfirst-party.DESC+ seller_sdk_example 'products/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueparameter name: :page, in: :query, type: :integer, required: false, description: 'Page number'parameter name: :limit, in: :query, type: :integer, required: false, description: 'Records per page (max 100)'@@ -60,6 +62,8 @@ RSpec.describe 'Seller Products API', type: :request, swagger_doc: 'api-referencmarketplace, not the seller.DESC+ seller_sdk_example 'products/create'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -101,6 +105,8 @@ RSpec.describe 'Seller Products API', type: :request, swagger_doc: 'api-referencis not told the record exists.DESC+ seller_sdk_example 'products/get'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'product returned' do@@ -132,6 +138,8 @@ RSpec.describe 'Seller Products API', type: :request, swagger_doc: 'api-referencsecurity [bearer_auth: []]description 'Edits a product the acting seller owns.'+ seller_sdk_example 'products/update'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -155,6 +163,8 @@ RSpec.describe 'Seller Products API', type: :request, swagger_doc: 'api-referencsecurity [bearer_auth: []]description 'Deletes a product the acting seller owns.'+ seller_sdk_example 'products/delete'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '204', 'product deleted' do@@ -180,6 +190,8 @@ RSpec.describe 'Seller Products API', type: :request, swagger_doc: 'api-referenconly when something was skipped, is the rest.DESC+ seller_sdk_example 'products/bulk-submit'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -207,6 +219,8 @@ RSpec.describe 'Seller Products API', type: :request, swagger_doc: 'api-referenc`active`: a listing goes on sale when the marketplace approves it.DESC+ seller_sdk_example 'products/bulk-status-update'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_fordiff --git a/spree/api/spec/integration/spree/api/v3/seller/profile_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/profile_spec.rbindex c4a722e6ba..771590682b 100644--- a/spree/api/spec/integration/spree/api/v3/seller/profile_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/profile_spec.rb@@ -24,6 +24,8 @@ RSpec.describe 'Seller Profile API', type: :request, swagger_doc: 'api-referenceanother seller here even by guessing one.DESC+ seller_sdk_example 'profile/get'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'profile returned' do@@ -69,6 +71,8 @@ RSpec.describe 'Seller Profile API', type: :request, swagger_doc: 'api-referenceasked for is ignored rather than written.DESC+ seller_sdk_example 'profile/update'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_fordiff --git a/spree/api/spec/integration/spree/api/v3/seller/requirement_submissions_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/requirement_submissions_spec.rbindex 397ec9d6e1..603f0a057a 100644--- a/spree/api/spec/integration/spree/api/v3/seller/requirement_submissions_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/requirement_submissions_spec.rb@@ -38,6 +38,8 @@ RSpec.describe 'Seller Requirement Submissions API', type: :request, swagger_docreviews comes back `pending`.DESC+ seller_sdk_example 'requirement-submissions/create'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -82,6 +84,8 @@ RSpec.describe 'Seller Requirement Submissions API', type: :request, swagger_docagainst the acting seller. Another seller's submission answers `404`.DESC+ seller_sdk_example 'requirement-submissions/download'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '404', "another seller's submission" dodiff --git a/spree/api/spec/integration/spree/api/v3/seller/returns_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/returns_spec.rbindex cff9c80e9e..6f67753dc3 100644--- a/spree/api/spec/integration/spree/api/v3/seller/returns_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/returns_spec.rb@@ -36,6 +36,8 @@ RSpec.describe 'Seller Returns API', type: :request, swagger_doc: 'api-referenceids are sent.DESC+ seller_sdk_example 'order-returns/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truefilter_parameters_for@@ -70,6 +72,8 @@ RSpec.describe 'Seller Returns API', type: :request, swagger_doc: 'api-referencereturns to.DESC+ seller_sdk_example 'order-returns/create'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -109,6 +113,8 @@ RSpec.describe 'Seller Returns API', type: :request, swagger_doc: 'api-referencesecurity [bearer_auth: []]description 'Agrees the goods may come back.'+ seller_sdk_example 'order-returns/approve'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'return approved' do@@ -139,6 +145,8 @@ RSpec.describe 'Seller Returns API', type: :request, swagger_doc: 'api-referenceOmitting `items` receives everything as requested and resellable.DESC+ seller_sdk_example 'order-returns/receive'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for(required: false)@@ -176,6 +184,8 @@ RSpec.describe 'Seller Returns API', type: :request, swagger_doc: 'api-referencenever a sibling's.DESC+ seller_sdk_example 'order-returns/refund'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for(required: false)@@ -224,6 +234,8 @@ RSpec.describe 'Seller Returns API', type: :request, swagger_doc: 'api-referencesecurity [bearer_auth: []]description 'Calls the return off.'+ seller_sdk_example 'order-returns/cancel'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for(required: false)@@ -253,6 +265,8 @@ RSpec.describe 'Seller Returns API', type: :request, swagger_doc: 'api-referenceit. Retired reasons are left out.DESC+ seller_sdk_example 'return-reasons/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truefilter_parameters_fordiff --git a/spree/api/spec/integration/spree/api/v3/seller/stock_locations_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/stock_locations_spec.rbindex 5f1064e608..cc55aeb127 100644--- a/spree/api/spec/integration/spree/api/v3/seller/stock_locations_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/stock_locations_spec.rb@@ -25,6 +25,8 @@ RSpec.describe 'Seller Stock Locations API', type: :request, swagger_doc: 'api-rnever appear here.DESC+ seller_sdk_example 'stock-locations/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueparameter name: :page, in: :query, type: :integer, required: false, description: 'Page number'parameter name: :limit, in: :query, type: :integer, required: false, description: 'Records per page (max 100)'@@ -61,6 +63,8 @@ RSpec.describe 'Seller Stock Locations API', type: :request, swagger_doc: 'api-rpayload says.DESC+ seller_sdk_example 'stock-locations/create'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -100,6 +104,8 @@ RSpec.describe 'Seller Stock Locations API', type: :request, swagger_doc: 'api-rseller — or to the marketplace operator — answers `404`.DESC+ seller_sdk_example 'stock-locations/get'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'stock location returned' do@@ -137,6 +143,8 @@ RSpec.describe 'Seller Stock Locations API', type: :request, swagger_doc: 'api-r`false`.DESC+ seller_sdk_example 'stock-locations/update'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_fordiff --git a/spree/api/spec/integration/spree/api/v3/seller/tax_identifiers_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/tax_identifiers_spec.rbindex 4ee9b3f64d..e5b7648974 100644--- a/spree/api/spec/integration/spree/api/v3/seller/tax_identifiers_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/tax_identifiers_spec.rb@@ -25,6 +25,8 @@ RSpec.describe 'Seller Tax Identifiers API', type: :request, swagger_doc: 'api-ralternatives. One per kind.DESC+ seller_sdk_example 'tax-identifiers/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truefilter_parameters_for@@ -55,6 +57,8 @@ RSpec.describe 'Seller Tax Identifiers API', type: :request, swagger_doc: 'api-rthan stored, so a typo cannot reach an invoice.DESC+ seller_sdk_example 'tax-identifiers/create'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -89,6 +93,8 @@ RSpec.describe 'Seller Tax Identifiers API', type: :request, swagger_doc: 'api-rabout the old one.DESC+ seller_sdk_example 'tax-identifiers/update'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -106,6 +112,8 @@ RSpec.describe 'Seller Tax Identifiers API', type: :request, swagger_doc: 'api-rtags 'Tax Identifiers'security [bearer_auth: []]+ seller_sdk_example 'tax-identifiers/delete'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '204', 'registration removed' do@@ -133,6 +141,8 @@ RSpec.describe 'Seller Tax Identifiers API', type: :request, swagger_doc: 'api-rcheck nobody can answer.DESC+ seller_sdk_example 'tax-identifiers/validate'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '422', 'no registry validator is installed for this kind' dodiff --git a/spree/api/spec/integration/spree/api/v3/seller/team_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/team_spec.rbindex bfdead1d37..500d45295f 100644--- a/spree/api/spec/integration/spree/api/v3/seller/team_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/team_spec.rb@@ -23,6 +23,8 @@ RSpec.describe 'Seller Team API', type: :request, swagger_doc: 'api-reference/seown team. Unpaginated — a seller's team is small by nature.DESC+ seller_sdk_example 'team/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'team members listed' do@@ -59,6 +61,8 @@ RSpec.describe 'Seller Team API', type: :request, swagger_doc: 'api-reference/serole, which already carries the whole seller vocabulary.DESC+ seller_sdk_example 'team/invite'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: truerequest_body_for@@ -101,6 +105,8 @@ RSpec.describe 'Seller Team API', type: :request, swagger_doc: 'api-reference/seThe last remaining member is refused with `422`.DESC+ seller_sdk_example 'team/delete'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '204', 'member removed' dodiff --git a/spree/api/spec/integration/spree/api/v3/seller/transfers_spec.rb b/spree/api/spec/integration/spree/api/v3/seller/transfers_spec.rbindex 5177142173..f0a17fdd46 100644--- a/spree/api/spec/integration/spree/api/v3/seller/transfers_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/seller/transfers_spec.rb@@ -27,6 +27,8 @@ RSpec.describe 'Seller Transfers API', type: :request, swagger_doc: 'api-referen`q[payout_id_eq]` for the earnings one settlement covers.DESC+ seller_sdk_example 'transfers/list'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueparameter name: :page, in: :query, type: :integer, required: false, description: 'Page number'parameter name: :limit, in: :query, type: :integer, required: false, description: 'Records per page (max 100)'@@ -60,6 +62,8 @@ RSpec.describe 'Seller Transfers API', type: :request, swagger_doc: 'api-referensecurity [bearer_auth: []]description "One of this seller's transfers. Another seller's is not found, whatever id is sent."+ seller_sdk_example 'transfers/get'+parameter name: 'X-Spree-Seller-Id', in: :header, type: :string, required: trueresponse '200', 'transfer found' dodiff --git a/spree/api/spec/support/code_samples_helper.rb b/spree/api/spec/support/code_samples_helper.rbindex dabd27b177..5c1fe9d309 100644--- a/spree/api/spec/support/code_samples_helper.rb+++ b/spree/api/spec/support/code_samples_helper.rb@@ -31,8 +31,39 @@ module CodeSamplesHelper})JS+ # Seller API callers: a guest (sign-in, password reset, invitations), a+ # signed-in person who has not picked a seller yet (`/me`), and a session+ # acting for one seller (everything else).+ SELLER_SDK_CLIENT_INITS = {+ guest: <<~JS.strip,+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ })+ JS+ user: <<~JS.strip,+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ })+ JS+ seller: <<~JS.strip+ import { createSellerClient } from '@spree/seller-sdk'++ const client = createSellerClient({+ baseUrl: 'https://your-store.com',+ jwtToken: 'eyJhbGciOi...',+ sellerId: 'sel_UkLWZg9DAJ',+ })+ JS+ }.freeze+SDK_EXAMPLES_ROOT = File.expand_path('../../../../packages/sdk/examples', __dir__)ADMIN_SDK_EXAMPLES_ROOT = File.expand_path('../../../../packages/admin-sdk/examples', __dir__)+ SELLER_SDK_EXAMPLES_ROOT = File.expand_path('../../../../packages/seller-sdk/examples', __dir__)# Match `// region:example` / `// endregion:example` markers and extract# the body between them. The markers can have arbitrary indentation.@@ -88,6 +119,24 @@ module CodeSamplesHelperadmin_cli_example(sdk_body_json(source), sdk_call_has_args(source))end+ # Mirrors `sdk_example` for the Seller SDK — examples live under+ # `packages/seller-sdk/examples/`.+ #+ # @param name [String] the example's path under `examples/`, without `.ts`+ # @param as [Symbol] the client the sample starts from: `:seller`, `:user`+ # or `:guest` (see SELLER_SDK_CLIENT_INITS)+ # @return [Array<Hash>] the operation's code samples+ def seller_sdk_example(name, as: :seller)+ source = EXAMPLE_CACHE[[:seller, name]] ||= load_example_body(SELLER_SDK_EXAMPLES_ROOT, name, 'Seller SDK')+ code_samples(+ {+ lang: 'javascript',+ label: 'Spree Seller SDK',+ source: "#{SELLER_SDK_CLIENT_INITS.fetch(as)}\n\n#{source}\n"+ }+ )+ end+# Emits a `spree api` CLI code sample for the current operation, derived from# its HTTP verb + path template (no per-endpoint authoring — the CLI is a# generic verb client, so the shape is mechanical). With the SDK example,