Skip to content

armgit / spree

Public Imported from GitHub
0

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

1012 KB
Raw Blame
---
openapi: 3.0.3
info:
  title: Seller API
  contact:
    name: Spree Commerce
    url: https://spreecommerce.org
    email: [email protected]
  description: |
    Spree Seller API v3 - the marketplace seller panel, where a seller runs
    their own shop inside someone else's marketplace.

    This is a branch of its own, not a narrowing of the Admin API. Every
    endpoint is scoped server-side to the seller the request acts as, which
    is what makes cross-seller access impossible by construction rather
    than by rule. Sellers never call the Admin API.

    ## Authentication

    Sign in at `POST /api/v3/seller/auth/login` and send the returned JWT as
    `Authorization: Bearer <token>`. The token carries a `seller_api`
    audience — a token minted for the storefront or the back office is not
    accepted here, and vice versa.

    There is deliberately **no secret API key** for this branch: a
    credential that could act as a seller without a seller signing in is
    exactly what the separate audience exists to prevent.

    ### Choosing a seller

    A user may run more than one seller. Login returns the list; send the
    chosen seller's ID in the `X-Spree-Seller-Id` header on every
    authenticated request. The store is derived from the seller — never
    sent — so no header can widen what a seller reaches. A request that
    names no seller the caller belongs to is rejected with `403`.

    ## Response Format

    All responses are JSON. List endpoints return paginated responses with
    `data` and `meta` keys.

    ## Error Handling

    Errors return a consistent format:
    ```json
    {
      "error": {
        "code": "validation_error",
        "message": "Validation failed",
        "details": { "name": ["can't be blank"] }
      }
    }
    ```
  version: v3
paths:
  "/api/v3/seller/auth/login":
    post:
      summary: Login
      tags:
      - Authentication
      description: |
        Signs a seller in and returns a short-lived JWT access token carrying the
        `seller_api` audience. The rotatable refresh token is set in an HttpOnly
        cookie — it is not included in the response body.

        The response lists every seller this user may act for. Pick one and send
        its `id` as `X-Spree-Seller-Id` on every subsequent request; nothing else
        on this API answers until a seller is named.

        Authenticating is not on its own enough. A store's own staff share the
        same user class, so a user who runs no seller is refused — issuing a
        token would hand out an audience its holder can do nothing with.

        The `provider` field selects the authentication method. When omitted it
        defaults to `email`. Sellers and store staff read different provider
        registries, so a marketplace can require SSO for its own back office
        while 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':
          description: login successful
          content:
            application/json:
              example:
                token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJhZG1pbiIsImp0aSI6IjE5NWY4OTE2LWI3NGQtNDg2MS1hMTQ3LTJmMDhiMzhiMWIzNSIsImlzcyI6InNwcmVlIiwiYXVkIjoic2VsbGVyX2FwaSIsImV4cCI6MTc2ODQ3ODcwMH0.e2XwsDONtD0x4j9jfjnHhDhAJpzhXBQ2LuIjWS1kY1k
                user:
                  id: adm_UkLWZg9DAJ
                  email: [email protected]
                  first_name: Jan
                  last_name: Cummerata
                  full_name: Jan Cummerata
                  created_at: '2026-01-15T12:00:00.000Z'
                  avatar_url:
                  selected_locale:
                sellers:
                - id: sel_UkLWZg9DAJ
                  name: Seller 6
                  status: approved
              schema:
                "$ref": "#/components/schemas/AuthResponse"
        '401':
          description: invalid credentials
          content:
            application/json:
              example:
                error:
                  code: authentication_failed
                  message: Invalid email or password
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LoginParams"
        required: true
  "/api/v3/seller/auth/refresh":
    post:
      summary: Refresh token
      tags:
      - Authentication
      description: |
        Exchanges the HttpOnly refresh-token cookie for a new access JWT and a
        rotated refresh cookie. No request body or Authorization header is
        required — the cookie alone authenticates the call.

        The lookup is narrowed by audience, so a refresh token minted for the
        storefront or the back office cannot be exchanged for a seller session.
        Membership is rechecked here too: a user whose last seller role was
        revoked 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
          content:
            application/json:
              example:
                token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJhZG1pbiIsImp0aSI6IjdjODEzNjdjLTBlYWEtNGUzOC1hNmRjLTJjMTYzOTIxY2Q1MiIsImlzcyI6InNwcmVlIiwiYXVkIjoic2VsbGVyX2FwaSIsImV4cCI6MTc2ODQ3ODcwMH0.N2ttey6pvsPoOdx0F9pdUNbdT1j25ejAzpghXTbB8zo
                user:
                  id: adm_UkLWZg9DAJ
                  email: [email protected]
                  first_name: Magdalen
                  last_name: Hayes
                  full_name: Magdalen Hayes
                  created_at: '2026-01-15T12:00:00.000Z'
                  avatar_url:
                  selected_locale:
                sellers:
                - id: sel_UkLWZg9DAJ
                  name: Seller 8
                  status: approved
              schema:
                "$ref": "#/components/schemas/AuthResponse"
        '401':
          description: missing or invalid refresh-token cookie
          content:
            application/json:
              example:
                error:
                  code: invalid_refresh_token
                  message: Refresh token cookie missing
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
  "/api/v3/seller/auth/logout":
    post:
      summary: Logout
      tags:
      - Authentication
      description: 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
  "/api/v3/seller/auth/providers":
    get:
      summary: List authentication providers
      tags:
      - Authentication
      description: |
        The sign-in methods this marketplace offers sellers, for the login page
        to render. Unauthenticated — a login page must be able to ask before
        anyone 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
          content:
            application/json:
              example:
                providers:
                - key: email
                  kind: password
              schema:
                "$ref": "#/components/schemas/AuthProvidersResponse"
  "/api/v3/seller/auth/invitations/{id}/lookup":
    parameters:
    - name: id
      in: path
      description: Invitation ID from the emailed link
      required: true
      schema:
        type: string
    get:
      summary: Look up an invitation
      tags:
      - Authentication
      description: |
        Reads an invitation from the emailed link, before anyone signs in.

        The acceptance page needs the invited address to decide whether it is
        asking someone to set a new password or to confirm one they already have.

        Unauthenticated — the ID and token in the emailed link are the
        credential. A wrong token is indistinguishable from an unknown
        invitation: both answer `404`, so the endpoint cannot be used to
        enumerate. An invitation onto the store's own staff rather than a seller
        answers `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: token
        in: query
        required: true
        description: The token from the emailed link
        schema:
          type: string
      responses:
        '200':
          description: invitation found
          content:
            application/json:
              example:
                id: inv_UkLWZg9DAJ
                email: [email protected]
                created_at: '2026-01-15T12:00:00.000Z'
                expires_at: '2026-01-29T12:00:00.000Z'
                accepted_at:
                status: pending
                inviter_email: [email protected]
                invitee_exists: false
                seller:
                  id: sel_UkLWZg9DAJ
                  name: Seller 72
              schema:
                "$ref": "#/components/schemas/Invitation"
        '404':
          description: wrong token, or an invitation that can no longer be accepted
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Invitation not found, expired, or already accepted.
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
  "/api/v3/seller/auth/invitations/{id}/accept":
    parameters:
    - name: id
      in: path
      description: Invitation ID from the emailed link
      required: true
      schema:
        type: string
    post:
      summary: Accept an invitation
      tags:
      - Authentication
      description: |
        Accepts the invitation and returns a signed-in seller session, so the new
        member lands in the panel rather than on a login form.

        The email is never taken from the request — it always comes from the
        invitation, which is what stops the link being redirected to another
        address.

        `password` is required when no account exists for the invited address, in
        which case it sets one. When an account already exists, the same field is
        how the person proves the account is theirs — unless the request carries
        that account's own access token, which proves it already.
      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: token
        in: query
        required: true
        description: The token from the emailed link
        schema:
          type: string
      responses:
        '200':
          description: invitation accepted, session issued
          content:
            application/json:
              example:
                token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyLCJ1c2VyX3R5cGUiOiJhZG1pbiIsImp0aSI6IjRmYzVlNzBmLWU1ODAtNDExNi1hOWU5LTBjNDliMGExYjMxNCIsImlzcyI6InNwcmVlIiwiYXVkIjoic2VsbGVyX2FwaSIsImV4cCI6MTc2ODQ3ODcwMH0.H0mJ1zDqTi6mNs_BZBRTJ77OMsWAqeUXvQM09YPLefs
                user:
                  id: adm_gbHJdmfrXB
                  email: [email protected]
                  first_name: Robin
                  last_name: Ellis
                  full_name: Robin Ellis
                  created_at: '2026-01-15T12:00:00.000Z'
                  avatar_url:
                  selected_locale:
                sellers:
                - id: sel_UkLWZg9DAJ
                  name: Seller 79
                  status: approved
              schema:
                "$ref": "#/components/schemas/AuthResponse"
        '404':
          description: wrong token, or an invitation that can no longer be accepted
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Invitation not found, expired, or already accepted.
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/InvitationAcceptParams"
        required: true
  "/api/v3/seller/auth/password_resets":
    post:
      summary: Request password reset
      tags:
      - Authentication
      description: |
        Requests a password reset email for a seller.

        Unauthenticated. Always answers `202`, whether or not the address
        belongs to a seller, so this cannot be used to discover which accounts
        exist. A store staff member who runs no seller is treated as no match:
        they have no seller panel to be sent to.

        `redirect_url` is where the emailed link should point, with the reset
        token appended as a `token` query param. It is honoured only when it
        matches one of the store's allowed origins; otherwise it is silently
        ignored and the server resolves the seller panel origin itself. The
        email is delivered by Spree via the
        `seller_user.password_reset_requested` event, which is never forwarded
        to 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':
          description: reset requested
          content:
            application/json:
              example:
                message: If an account exists for that email, password reset instructions
                  have been sent.
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/PasswordResetCreateParams"
        required: true
  "/api/v3/seller/auth/password_resets/{id}":
    patch:
      summary: Reset password
      tags:
      - Authentication
      description: |
        Spends a password reset token (the `token` query param from the emailed
        link), sets the new password and signs the seller in: the response
        carries a seller JWT and the rotatable refresh token is set in an
        HttpOnly cookie, so they land in the panel rather than on a login form.

        The token is single-use, and resetting revokes every other session the
        account holds. A token whose seller membership has since been revoked is
        refused 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: id
        in: path
        description: The reset token from the emailed link
        required: true
        schema:
          type: string
      responses:
        '200':
          description: password reset
          content:
            application/json:
              example:
                token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJhZG1pbiIsImp0aSI6ImJjMDM3NTNhLTEzN2MtNGM1Zi1hMzM2LWUzMjBlZTNiMjQ5YyIsImlzcyI6InNwcmVlIiwiYXVkIjoic2VsbGVyX2FwaSIsImV4cCI6MTc2ODQ3ODcwMH0.EASrzbGpJVyAl10SJyzs8na68Wmvedkm7G66wTBq_0k
                user:
                  id: adm_UkLWZg9DAJ
                  email: [email protected]
                  first_name: Ariana
                  last_name: Wiza
                  full_name: Ariana Wiza
                  created_at: '2026-01-15T12:00:00.000Z'
                  avatar_url:
                  selected_locale:
                sellers:
                - id: sel_UkLWZg9DAJ
                  name: Seller 117
                  status: approved
              schema:
                "$ref": "#/components/schemas/AuthResponse"
        '422':
          description: invalid or expired token
          content:
            application/json:
              example:
                error:
                  code: password_reset_token_invalid
                  message: Password reset token is invalid or has expired.
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/PasswordResetUpdateParams"
        required: true
  "/api/v3/seller/me":
    get:
      summary: Current user
      tags:
      - Account
      security:
      - bearer_auth: []
      description: |
        The signed-in user, the sellers they may act for, and what they may do on
        the selected one.

        This is the one authenticated endpoint that answers without
        `X-Spree-Seller-Id` — it is what tells the panel which seller to name.
        Sending the header narrows `permission_keys` and `permissions` to that
        seller; without it both are empty, because capability is per seller and
        there 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-Id
        in: header
        required: false
        description: The seller to report capability for. Omit to list sellers without
          narrowing permissions.
        schema:
          type: string
      responses:
        '200':
          description: current user returned
          content:
            application/json:
              example:
                user:
                  id: adm_UkLWZg9DAJ
                  email: [email protected]
                  first_name: Nadia
                  last_name: Effertz
                  full_name: Nadia Effertz
                  created_at: '2026-01-15T12:00:00.000Z'
                  avatar_url:
                  selected_locale:
                sellers:
                - id: sel_UkLWZg9DAJ
                  name: Seller 89
                  slug: seller-89
                  status: approved
                store:
                  id: store_UkLWZg9DAJ
                  name: Spree Test Store
                  seller_digital_assets_enabled: false
                  seller_digital_asset_content_types:
                  - application/pdf
                  - application/epub+zip
                  - application/zip
                  - application/x-7z-compressed
                  - application/gzip
                  - application/json
                  - text/plain
                  - text/csv
                  - audio/mpeg
                  - audio/mp4
                  - audio/aac
                  - audio/flac
                  - audio/ogg
                  - audio/wav
                  - audio/x-wav
                  - audio/midi
                  - video/mp4
                  - video/webm
                  - video/quicktime
                  - image/jpeg
                  - image/png
                  - image/gif
                  - image/webp
                  - image/tiff
                  review_seller_digital_asset_changes: true
                permissions:
                - allow: true
                  actions:
                  - read
                  subjects:
                  - country
                  has_conditions: false
                - allow: true
                  actions:
                  - read
                  subjects:
                  - state
                  has_conditions: false
                - allow: true
                  actions:
                  - read
                  subjects:
                  - store
                  has_conditions: true
                - allow: true
                  actions:
                  - read
                  - admin
                  subjects:
                  - product
                  has_conditions: false
                - allow: true
                  actions:
                  - read
                  - admin
                  subjects:
                  - variant
                  has_conditions: false
                - allow: true
                  actions:
                  - read
                  - admin
                  subjects:
                  - option_type
                  has_conditions: false
                - allow: true
                  actions:
                  - read
                  - admin
                  subjects:
                  - option_value
                  has_conditions: false
                - allow: true
                  actions:
                  - read
                  - admin
                  subjects:
                  - price
                  has_conditions: false
                - allow: true
                  actions:
                  - read
                  - admin
                  subjects:
                  - price_list
                  has_conditions: false
                - allow: true
                  actions:
                  - read
                  - admin
                  subjects:
                  - price_rule
                  has_conditions: false
                - allow: true
                  actions:
                  - read
                  - admin
                  subjects:
                  - catalog
                  has_conditions: false
                - allow: true
                  actions:
                  - read
                  - admin
                  subjects:
                  - catalog_product
                  has_conditions: false
                - allow: true
                  actions:
                  - read
                  - admin
                  subjects:
                  - catalog_assignment
                  has_conditions: false
                - allow: true
                  actions:
                  - read
                  - admin
                  subjects:
                  - custom_field
                  has_conditions: false
                - allow: true
                  actions:
                  - read
                  - admin
                  subjects:
                  - digital_asset
                  has_conditions: false
                - allow: true
                  actions:
                  - read
                  - admin
                  subjects:
                  - import
                  has_conditions: false
                - allow: true
                  actions:
                  - read
                  - admin
                  subjects:
                  - import_row
                  has_conditions: false
                - allow: true
                  actions:
                  - manage
                  subjects:
                  - product
                  has_conditions: false
                - allow: true
                  actions:
                  - manage
                  subjects:
                  - variant
                  has_conditions: false
                - allow: true
                  actions:
                  - manage
                  subjects:
                  - option_type
                  has_conditions: false
                - allow: true
                  actions:
                  - manage
                  subjects:
                  - option_value
                  has_conditions: false
                - allow: true
                  actions:
                  - manage
                  subjects:
                  - price
                  has_conditions: false
                - allow: true
                  actions:
                  - manage
                  subjects:
                  - price_list
                  has_conditions: false
                - allow: true
                  actions:
                  - manage
                  subjects:
                  - price_rule
                  has_conditions: false
                - allow: true
                  actions:
                  - manage
                  subjects:
                  - catalog
                  has_conditions: false
                - allow: true
                  actions:
                  - manage
                  subjects:
                  - catalog_product
                  has_conditions: false
                - allow: true
                  actions:
                  - manage
                  subjects:
                  - catalog_assignment
                  has_conditions: false
                - allow: true
                  actions:
                  - manage
                  subjects:
                  - custom_field
                  has_conditions: false
                - allow: true
                  actions:
                  - manage
                  subjects:
                  - digital_asset
                  has_conditions: false
                - allow: true
                  actions:
                  - manage
                  subjects:
                  - import
                  has_conditions: false
                - allow: true
                  actions:
                  - manage
                  subjects:
                  - import_row
                  has_conditions: false
                permission_keys:
                - read_products
                - write_products
              schema:
                "$ref": "#/components/schemas/SellerMeResponse"
        '401':
          description: missing or invalid token
          content:
            application/json:
              example:
                error:
                  code: authentication_required
                  message: Authentication required
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
    patch:
      summary: Update your account
      tags:
      - Account
      security:
      - bearer_auth: []
      description: |
        Edits the signed-in person's own account — the name and photo their team
        sees, and the language their panel displays.

        This is the person, not the business: the seller they act for is
        `PATCH /profile`. Like `GET /me` it answers without
        `X-Spree-Seller-Id`, because the account is the same whichever seller
        they are acting for.

        `avatar_signed_id` takes the `signed_id` from `POST /files` to set the
        photo, 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':
          description: account updated
          content:
            application/json:
              example:
                user:
                  id: adm_UkLWZg9DAJ
                  email: [email protected]
                  first_name: Ada
                  last_name: Lovelace
                  full_name: Ada Lovelace
                  created_at: '2026-01-15T12:00:00.000Z'
                  avatar_url:
                  selected_locale:
                sellers:
                - id: sel_UkLWZg9DAJ
                  name: Seller 91
                  slug: seller-91
                  status: approved
                store:
                  id: store_UkLWZg9DAJ
                  name: Spree Test Store
                  seller_digital_assets_enabled: false
                  seller_digital_asset_content_types:
                  - application/pdf
                  - application/epub+zip
                  - application/zip
                  - application/x-7z-compressed
                  - application/gzip
                  - application/json
                  - text/plain
                  - text/csv
                  - audio/mpeg
                  - audio/mp4
                  - audio/aac
                  - audio/flac
                  - audio/ogg
                  - audio/wav
                  - audio/x-wav
                  - audio/midi
                  - video/mp4
                  - video/webm
                  - video/quicktime
                  - image/jpeg
                  - image/png
                  - image/gif
                  - image/webp
                  - image/tiff
                  review_seller_digital_asset_changes: true
                permissions: []
                permission_keys: []
              schema:
                "$ref": "#/components/schemas/SellerMeResponse"
        '422':
          description: the photo is not a web image
          content:
            application/json:
              example:
                error:
                  code: validation_error
                  message: Avatar has an invalid content type (authorized content
                    types are PNG, JPG, GIF, WEBP)
                  details:
                    avatar_signed_id:
                    - has an invalid content type (authorized content types are PNG,
                      JPG, GIF, WEBP)
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
        '401':
          description: missing or invalid token
          content:
            application/json:
              example:
                error:
                  code: authentication_required
                  message: Authentication required
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/AccountUpdateParams"
        required: true
  "/api/v3/seller/countries":
    get:
      summary: List countries
      tags:
      - Countries
      security:
      - bearer_auth: []
      description: |
        Countries and their states, for the panel's address forms.

        Public reference data — the same list the storefront serves — so it is
        not narrowed to the markets this marketplace sells into: a seller filling
        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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: countries listed
          content:
            application/json:
              example:
                data:
                - iso: AD
                  iso3: AND
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '07'
                    name: Andorra la Vella
                  - abbr: '02'
                    name: Canillo
                  - abbr: '03'
                    name: Encamp
                  - abbr: '08'
                    name: Escaldes-Engordany
                  - abbr: '04'
                    name: La Massana
                  - abbr: '05'
                    name: Ordino
                  - abbr: '06'
                    name: Sant Julià de Lòria
                - iso: AE
                  iso3: ARE
                  states_required: true
                  zipcode_required: false
                  states:
                  - abbr: AJ
                    name: "'Ajmān"
                  - abbr: AZ
                    name: Abū Z̧aby [Abu Dhabi]
                  - abbr: FU
                    name: Al Fujayrah
                  - abbr: SH
                    name: Ash Shariqah [Sharjah]
                  - abbr: DU
                    name: Dubayy
                  - abbr: RK
                    name: Ra's al Khaymah
                  - abbr: UQ
                    name: Umm al Qaywayn
                - iso: AF
                  iso3: AFG
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: BDS
                    name: Badakhshan
                  - abbr: BDG
                    name: Badghis
                  - abbr: BGL
                    name: Baghlan
                  - abbr: BAL
                    name: Balkh
                  - abbr: BAM
                    name: Bamian
                  - abbr: DAY
                    name: Daykondi
                  - abbr: FRA
                    name: Farah
                  - abbr: FYB
                    name: Faryab
                  - abbr: GHA
                    name: Ghazni
                  - abbr: GHO
                    name: Ghowr
                  - abbr: HEL
                    name: Helmand
                  - abbr: HER
                    name: Herat
                  - abbr: JOW
                    name: Jowzjan
                  - abbr: KAB
                    name: Kabul [Kabol]
                  - abbr: KAN
                    name: Kandahar
                  - abbr: KAP
                    name: Kapisa
                  - abbr: KHO
                    name: Khowst
                  - abbr: KNR
                    name: Konar [Kunar]
                  - abbr: KDZ
                    name: Kondoz [Kunduz]
                  - abbr: LAG
                    name: Laghman
                  - abbr: NAN
                    name: Nangrahar [Nangarhar]
                  - abbr: NIM
                    name: Nimruz
                  - abbr: NUR
                    name: Nurestan
                  - abbr: PIA
                    name: Paktia
                  - abbr: PKA
                    name: Paktika
                  - abbr: PAN
                    name: Panjshir
                  - abbr: PAR
                    name: Parwan
                  - abbr: SAM
                    name: Samangan
                  - abbr: SAR
                    name: Sar-e Pol
                  - abbr: TAK
                    name: Takhar
                  - abbr: WAR
                    name: Wardak [Wardag]
                  - abbr: ZAB
                    name: Zabol [Zabul]
                  - abbr: URU
                    name: روزګان ولايت
                  - abbr: LOG
                    name: لوګر ولايت
                - iso: AG
                  iso3: ATG
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: '10'
                    name: Barbuda
                  - abbr: '11'
                    name: Redonda
                  - abbr: '03'
                    name: Saint George
                  - abbr: '04'
                    name: Saint John’s
                  - abbr: '05'
                    name: Saint Mary
                  - abbr: '06'
                    name: Saint Paul
                  - abbr: '07'
                    name: Saint Peter
                  - abbr: '08'
                    name: Saint Philip
                - iso: AI
                  iso3: AIA
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: AL
                  iso3: ALB
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '01'
                    name: Berat
                  - abbr: '09'
                    name: Dibër
                  - abbr: '02'
                    name: Durrës
                  - abbr: '03'
                    name: Elbasan
                  - abbr: '04'
                    name: Fier
                  - abbr: '05'
                    name: Gjirokastër
                  - abbr: '06'
                    name: Korçë
                  - abbr: '07'
                    name: Kukës
                  - abbr: '08'
                    name: Lezhë
                  - abbr: '10'
                    name: Shkodër
                  - abbr: '11'
                    name: Tiranë
                  - abbr: '12'
                    name: Vlorë
                - iso: AM
                  iso3: ARM
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AG
                    name: Aragacotn
                  - abbr: AR
                    name: Ararat
                  - abbr: AV
                    name: Armavir
                  - abbr: ER
                    name: Erevan
                  - abbr: GR
                    name: Gegark'unik'
                  - abbr: KT
                    name: Kotayk'
                  - abbr: LO
                    name: Lory
                  - abbr: SU
                    name: Syunik'
                  - abbr: TV
                    name: Tavuš
                  - abbr: VD
                    name: Vayoc Jor
                  - abbr: SH
                    name: Širak
                - iso: AO
                  iso3: AGO
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: BGO
                    name: Bengo
                  - abbr: BGU
                    name: Benguela
                  - abbr: BIE
                    name: Bié
                  - abbr: CAB
                    name: Cabinda
                  - abbr: CCU
                    name: Cuando-Cubango
                  - abbr: CNO
                    name: Cuanza Norte
                  - abbr: CUS
                    name: Cuanza Sul
                  - abbr: CNN
                    name: Cunene
                  - abbr: HUA
                    name: Huambo
                  - abbr: HUI
                    name: Huíla
                  - abbr: LUA
                    name: Luanda
                  - abbr: LNO
                    name: Lunda Norte
                  - abbr: LSU
                    name: Lunda Sul
                  - abbr: MAL
                    name: Malange
                  - abbr: MOX
                    name: Moxico
                  - abbr: NAM
                    name: Namibe
                  - abbr: UIG
                    name: Uíge
                  - abbr: ZAI
                    name: Zaire
                - iso: AR
                  iso3: ARG
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: B
                    name: Buenos Aires
                  - abbr: C
                    name: Capital federal
                  - abbr: K
                    name: Catamarca
                  - abbr: H
                    name: Chaco
                  - abbr: U
                    name: Chubut
                  - abbr: W
                    name: Corrientes
                  - abbr: X
                    name: Córdoba
                  - abbr: E
                    name: Entre Ríos
                  - abbr: P
                    name: Formosa
                  - abbr: "Y"
                    name: Jujuy
                  - abbr: L
                    name: La Pampa
                  - abbr: F
                    name: La Rioja
                  - abbr: M
                    name: Mendoza
                  - abbr: "N"
                    name: Misiones
                  - abbr: Q
                    name: Neuquén
                  - abbr: R
                    name: Río Negro
                  - abbr: A
                    name: Salta
                  - abbr: J
                    name: San Juan
                  - abbr: D
                    name: San Luis
                  - abbr: Z
                    name: Santa Cruz
                  - abbr: S
                    name: Santa Fe
                  - abbr: G
                    name: Santiago del Estero
                  - abbr: V
                    name: Tierra del Fuego
                  - abbr: T
                    name: Tucumán
                - iso: AS
                  iso3: ASM
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: AT
                  iso3: AUT
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '1'
                    name: Burgenland
                  - abbr: '2'
                    name: Kärnten
                  - abbr: '3'
                    name: Niederösterreich
                  - abbr: '4'
                    name: Oberösterreich
                  - abbr: '5'
                    name: Salzburg
                  - abbr: '6'
                    name: Steiermark
                  - abbr: '7'
                    name: Tirol
                  - abbr: '8'
                    name: Vorarlberg
                  - abbr: '9'
                    name: Wien
                - iso: AU
                  iso3: AUS
                  states_required: true
                  zipcode_required: true
                  states:
                  - abbr: ACT
                    name: Australian Capital Territory
                  - abbr: NSW
                    name: New South Wales
                  - abbr: NT
                    name: Northern Territory
                  - abbr: QLD
                    name: Queensland
                  - abbr: SA
                    name: South Australia
                  - abbr: TAS
                    name: Tasmania
                  - abbr: VIC
                    name: Victoria
                  - abbr: WA
                    name: Western Australia
                - iso: AW
                  iso3: ABW
                  states_required: false
                  zipcode_required: false
                  states: []
                - iso: AZ
                  iso3: AZE
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: ABS
                    name: Abseron
                  - abbr: AGC
                    name: Agcabädi
                  - abbr: AGM
                    name: Agdam
                  - abbr: AGS
                    name: Agdas
                  - abbr: AGA
                    name: Agstafa
                  - abbr: AGU
                    name: Agsu
                  - abbr: AST
                    name: Astara
                  - abbr: BAB
                    name: Babäk
                  - abbr: BA
                    name: Baki
                  - abbr: BAL
                    name: Balakän
                  - abbr: BEY
                    name: Beyläqan
                  - abbr: BIL
                    name: Biläsuvar
                  - abbr: BAR
                    name: Bärdä
                  - abbr: CUL
                    name: Culfa
                  - abbr: CAB
                    name: Cäbrayil
                  - abbr: CAL
                    name: Cälilabab
                  - abbr: DAS
                    name: Daskäsän
                  - abbr: FUZ
                    name: Füzuli
                  - abbr: GOR
                    name: Goranboy
                  - abbr: GAD
                    name: Gädäbäy
                  - abbr: GA
                    name: Gäncä
                  - abbr: GYG
                    name: Göygöl
                  - abbr: GOY
                    name: Göyçay
                  - abbr: HAC
                    name: Haciqabul
                  - abbr: IMI
                    name: Imisli
                  - abbr: ISM
                    name: Ismayilli
                  - abbr: KAL
                    name: Kälbäcär
                  - abbr: KUR
                    name: Kürdämir
                  - abbr: KAN
                    name: Kəngərli
                  - abbr: LAC
                    name: Laçin
                  - abbr: LER
                    name: Lerik
                  - abbr: LAN
                    name: Länkäran
                  - abbr: LA
                    name: Länkäran City
                  - abbr: MAS
                    name: Masalli
                  - abbr: MI
                    name: Mingäçevir
                  - abbr: NA
                    name: Naftalan
                  - abbr: NX
                    name: Naxçivan
                  - abbr: NV
                    name: Naxçıvan
                  - abbr: NEF
                    name: Neftçala
                  - abbr: OGU
                    name: Oguz
                  - abbr: ORD
                    name: Ordubad
                  - abbr: QAX
                    name: Qax
                  - abbr: QAZ
                    name: Qazax
                  - abbr: QOB
                    name: Qobustan
                  - abbr: QBA
                    name: Quba
                  - abbr: QBI
                    name: Qubadli
                  - abbr: QUS
                    name: Qusar
                  - abbr: QAB
                    name: Qäbälä
                  - abbr: SAT
                    name: Saatli
                  - abbr: SAB
                    name: Sabirabad
                  - abbr: SAH
                    name: Sahbuz
                  - abbr: SAL
                    name: Salyan
                  - abbr: SMI
                    name: Samaxi
                  - abbr: SMX
                    name: Samux
                  - abbr: SIY
                    name: Siyäzän
                  - abbr: SM
                    name: Sumqayit
                  - abbr: SUS
                    name: Susa
                  - abbr: SAD
                    name: Sädäräk
                  - abbr: SAK
                    name: Säki
                  - abbr: SA
                    name: Säki City
                  - abbr: SKR
                    name: Sämkir
                  - abbr: SAR
                    name: Särur
                  - abbr: TOV
                    name: Tovuz
                  - abbr: TAR
                    name: Tärtär
                  - abbr: UCA
                    name: Ucar
                  - abbr: XA
                    name: Xankändi
                  - abbr: XAC
                    name: Xaçmaz
                  - abbr: XIZ
                    name: Xizi
                  - abbr: XCI
                    name: Xocali
                  - abbr: XVD
                    name: Xocavänd
                  - abbr: YAR
                    name: Yardimli
                  - abbr: YEV
                    name: Yevlax
                  - abbr: YE
                    name: Yevlax City
                  - abbr: ZAQ
                    name: Zaqatala
                  - abbr: ZAN
                    name: Zängilan
                  - abbr: ZAR
                    name: Zärdab
                  - abbr: SBN
                    name: Şabran (rayon)
                  - abbr: SR
                    name: Şirvan
                - iso: BA
                  iso3: BIH
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: BRC
                    name: Brčko Distrikt
                  - abbr: BIH
                    name: Federacija Bosna i Hercegovina
                  - abbr: SRP
                    name: Republika Srpska
                - iso: BB
                  iso3: BRB
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '01'
                    name: Christ Church
                  - abbr: '02'
                    name: Saint Andrew
                  - abbr: '03'
                    name: Saint George
                  - abbr: '04'
                    name: Saint James
                  - abbr: '05'
                    name: Saint John
                  - abbr: '06'
                    name: Saint Joseph
                  - abbr: '07'
                    name: Saint Lucy
                  - abbr: '08'
                    name: Saint Michael
                  - abbr: '09'
                    name: Saint Peter
                  - abbr: '10'
                    name: Saint Philip
                  - abbr: '11'
                    name: Saint Thomas
                - iso: BD
                  iso3: BGD
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '05'
                    name: Bagerhat zila
                  - abbr: '01'
                    name: Bandarban zila
                  - abbr: '02'
                    name: Barguna zila
                  - abbr: '06'
                    name: Barisal zila
                  - abbr: '07'
                    name: Bhola zila
                  - abbr: '03'
                    name: Bogra zila
                  - abbr: '04'
                    name: Brahmanbaria zila
                  - abbr: '09'
                    name: Chandpur zila
                  - abbr: '10'
                    name: Chittagong zila
                  - abbr: '12'
                    name: Chuadanga zila
                  - abbr: '08'
                    name: Comilla zila
                  - abbr: '11'
                    name: Cox's Bazar zila
                  - abbr: '13'
                    name: Dhaka zila
                  - abbr: '14'
                    name: Dinajpur zila
                  - abbr: '15'
                    name: Faridpur zila
                  - abbr: '16'
                    name: Feni zila
                  - abbr: '19'
                    name: Gaibandha zila
                  - abbr: '18'
                    name: Gazipur zila
                  - abbr: '17'
                    name: Gopalganj zila
                  - abbr: '20'
                    name: Habiganj zila
                  - abbr: '24'
                    name: Jaipurhat zila
                  - abbr: '21'
                    name: Jamalpur zila
                  - abbr: '22'
                    name: Jessore zila
                  - abbr: '25'
                    name: Jhalakati zila
                  - abbr: '23'
                    name: Jhenaidah zila
                  - abbr: '29'
                    name: Khagrachari zila
                  - abbr: '27'
                    name: Khulna zila
                  - abbr: '26'
                    name: Kishoreganj zila
                  - abbr: '28'
                    name: Kurigram zila
                  - abbr: '30'
                    name: Kushtia zila
                  - abbr: '31'
                    name: Lakshmipur zila
                  - abbr: '32'
                    name: Lalmonirhat zila
                  - abbr: '36'
                    name: Madaripur zila
                  - abbr: '37'
                    name: Magura zila
                  - abbr: '33'
                    name: Manikganj zila
                  - abbr: '39'
                    name: Meherpur zila
                  - abbr: '38'
                    name: Moulvibazar zila
                  - abbr: '35'
                    name: Munshiganj zila
                  - abbr: '34'
                    name: Mymensingh zila
                  - abbr: '48'
                    name: Naogaon zila
                  - abbr: '43'
                    name: Narail zila
                  - abbr: '40'
                    name: Narayanganj zila
                  - abbr: '42'
                    name: Narsingdi zila
                  - abbr: '44'
                    name: Natore zila
                  - abbr: '45'
                    name: Nawabganj zila
                  - abbr: '41'
                    name: Netrakona zila
                  - abbr: '46'
                    name: Nilphamari zila
                  - abbr: '47'
                    name: Noakhali zila
                  - abbr: '49'
                    name: Pabna zila
                  - abbr: '52'
                    name: Panchagarh zila
                  - abbr: '51'
                    name: Patuakhali zila
                  - abbr: '50'
                    name: Pirojpur zila
                  - abbr: '53'
                    name: Rajbari zila
                  - abbr: '54'
                    name: Rajshahi zila
                  - abbr: '56'
                    name: Rangamati zila
                  - abbr: '55'
                    name: Rangpur zila
                  - abbr: '58'
                    name: Satkhira zila
                  - abbr: '62'
                    name: Shariatpur zila
                  - abbr: '57'
                    name: Sherpur zila
                  - abbr: '59'
                    name: Sirajganj zila
                  - abbr: '61'
                    name: Sunamganj zila
                  - abbr: '60'
                    name: Sylhet zila
                  - abbr: '63'
                    name: Tangail zila
                  - abbr: '64'
                    name: Thakurgaon zila
                  - abbr: D
                    name: খুলনা বিভাগ
                  - abbr: B
                    name: চট্টগ্রাম বিভাগ
                  - abbr: C
                    name: ঢাকা বিভাগ
                  - abbr: A
                    name: বরিশাল বিভাগ
                  - abbr: H
                    name: ময়মনসিংহ বিভাগ
                  - abbr: F
                    name: রংপুর বিভাগ
                  - abbr: E
                    name: রাজশাহী বিভাগ
                  - abbr: G
                    name: সিলেট বিভাগ
                - iso: BE
                  iso3: BEL
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: VAN
                    name: Antwerp
                  - abbr: BRU
                    name: Brussels
                  - abbr: VOV
                    name: East Flanders
                  - abbr: VBR
                    name: Flemish Brabant
                  - abbr: WHT
                    name: Hainaut
                  - abbr: VLI
                    name: Limburg
                  - abbr: WLG
                    name: Liège
                  - abbr: WLX
                    name: Luxembourg
                  - abbr: WNA
                    name: Namur
                  - abbr: VLG
                    name: Vlaams Gewest
                  - abbr: WAL
                    name: Wallonië
                  - abbr: WBR
                    name: Walloon Brabant
                  - abbr: VWV
                    name: West Flanders
                - iso: BF
                  iso3: BFA
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: BAL
                    name: Balé
                  - abbr: BAM
                    name: Bam
                  - abbr: BAN
                    name: Banwa
                  - abbr: BAZ
                    name: Bazèga
                  - abbr: '01'
                    name: Boucle du Mouhoun
                  - abbr: BGR
                    name: Bougouriba
                  - abbr: BLG
                    name: Boulgou
                  - abbr: BLK
                    name: Boulkiemdé
                  - abbr: '02'
                    name: Cascades
                  - abbr: '03'
                    name: Centre
                  - abbr: '04'
                    name: Centre-Est
                  - abbr: '05'
                    name: Centre-Nord
                  - abbr: '06'
                    name: Centre-Ouest
                  - abbr: '07'
                    name: Centre-Sud
                  - abbr: COM
                    name: Comoé
                  - abbr: '08'
                    name: Est
                  - abbr: GAN
                    name: Ganzourgou
                  - abbr: GNA
                    name: Gnagna
                  - abbr: GOU
                    name: Gourma
                  - abbr: '09'
                    name: Hauts-Bassins
                  - abbr: HOU
                    name: Houet
                  - abbr: IOB
                    name: Ioba
                  - abbr: KAD
                    name: Kadiogo
                  - abbr: KMD
                    name: Komondjari
                  - abbr: KMP
                    name: Kompienga
                  - abbr: KOS
                    name: Kossi
                  - abbr: KOP
                    name: Koulpélogo
                  - abbr: KOT
                    name: Kouritenga
                  - abbr: KOW
                    name: Kourwéogo
                  - abbr: KEN
                    name: Kénédougou
                  - abbr: LOR
                    name: Loroum
                  - abbr: LER
                    name: Léraba
                  - abbr: MOU
                    name: Mouhoun
                  - abbr: NAO
                    name: Nahouri
                  - abbr: NAM
                    name: Namentenga
                  - abbr: NAY
                    name: Nayala
                  - abbr: '10'
                    name: Nord
                  - abbr: NOU
                    name: Noumbiel
                  - abbr: OUB
                    name: Oubritenga
                  - abbr: OUD
                    name: Oudalan
                  - abbr: PAS
                    name: Passoré
                  - abbr: '11'
                    name: Plateau-Central
                  - abbr: PON
                    name: Poni
                  - abbr: '12'
                    name: Sahel
                  - abbr: SNG
                    name: Sanguié
                  - abbr: SMT
                    name: Sanmatenga
                  - abbr: SIS
                    name: Sissili
                  - abbr: SOM
                    name: Soum
                  - abbr: SOR
                    name: Sourou
                  - abbr: '13'
                    name: Sud-Ouest
                  - abbr: SEN
                    name: Séno
                  - abbr: TAP
                    name: Tapoa
                  - abbr: TUI
                    name: Tui
                  - abbr: YAG
                    name: Yagha
                  - abbr: YAT
                    name: Yatenga
                  - abbr: ZIR
                    name: Ziro
                  - abbr: ZON
                    name: Zondoma
                  - abbr: ZOU
                    name: Zoundwéogo
                - iso: BG
                  iso3: BGR
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '01'
                    name: Blagoevgrad
                  - abbr: '02'
                    name: Burgas
                  - abbr: '08'
                    name: Dobrich
                  - abbr: '07'
                    name: Gabrovo
                  - abbr: '26'
                    name: Haskovo
                  - abbr: '09'
                    name: Kardzhali
                  - abbr: '10'
                    name: Kjustendil
                  - abbr: '11'
                    name: Lovech
                  - abbr: '12'
                    name: Montana
                  - abbr: '13'
                    name: Pazardzhik
                  - abbr: '14'
                    name: Pernik
                  - abbr: '15'
                    name: Pleven
                  - abbr: '16'
                    name: Plovdiv
                  - abbr: '17'
                    name: Razgrad
                  - abbr: '18'
                    name: Ruse
                  - abbr: '19'
                    name: Silistra
                  - abbr: '20'
                    name: Sliven
                  - abbr: '21'
                    name: Smolyan
                  - abbr: '23'
                    name: Sofia
                  - abbr: '22'
                    name: Sofia-Grad
                  - abbr: '24'
                    name: Stara Zagora
                  - abbr: '25'
                    name: Targovishte
                  - abbr: '03'
                    name: Varna
                  - abbr: '04'
                    name: Veliko Tarnovo
                  - abbr: '05'
                    name: Vidin
                  - abbr: '06'
                    name: Vratsa
                  - abbr: '28'
                    name: Yambol
                  - abbr: '27'
                    name: Šumen
                - iso: BH
                  iso3: BHR
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '14'
                    name: Al Janubiyah
                  - abbr: '13'
                    name: Al Manamah (Al ‘Asimah)
                  - abbr: '15'
                    name: Al Muharraq
                  - abbr: '17'
                    name: Ash Shamaliyah
                - iso: BI
                  iso3: BDI
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: BB
                    name: Bubanza
                  - abbr: BJ
                    name: Bujumbura
                  - abbr: BR
                    name: Bururi
                  - abbr: CA
                    name: Cankuzo
                  - abbr: CI
                    name: Cibitoke
                  - abbr: GI
                    name: Gitega
                  - abbr: KR
                    name: Karuzi
                  - abbr: KY
                    name: Kayanza
                  - abbr: KI
                    name: Kirundo
                  - abbr: MA
                    name: Makamba
                  - abbr: MU
                    name: Muramvya
                  - abbr: MY
                    name: Muyinga
                  - abbr: MW
                    name: Mwaro
                  - abbr: NG
                    name: Ngozi
                  - abbr: RM
                    name: Province de Rumonge
                  - abbr: RT
                    name: Rutana
                  - abbr: RY
                    name: Ruyigi
                  - abbr: BM
                    name: province de Bujumbura Mairie
                  - abbr: BL
                    name: province de Bujumbura rural
                - iso: BJ
                  iso3: BEN
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: AL
                    name: Alibori
                  - abbr: AK
                    name: Atakora
                  - abbr: AQ
                    name: Atlantique
                  - abbr: BO
                    name: Borgou
                  - abbr: CO
                    name: Collines
                  - abbr: DO
                    name: Donga
                  - abbr: KO
                    name: Kouffo
                  - abbr: LI
                    name: Littoral
                  - abbr: MO
                    name: Mono
                  - abbr: OU
                    name: Ouémé
                  - abbr: PL
                    name: Plateau
                  - abbr: ZO
                    name: Zou
                - iso: BL
                  iso3: BLM
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: BM
                  iso3: BMU
                  states_required: false
                  zipcode_required: false
                  states: []
                - iso: BN
                  iso3: BRN
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: BE
                    name: Belait
                  - abbr: BM
                    name: Brunei-Muara
                  - abbr: TE
                    name: Temburong
                  - abbr: TU
                    name: Tutong
                - iso: BO
                  iso3: BOL
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: H
                    name: Chuquisaca
                  - abbr: C
                    name: Cochabamba
                  - abbr: B
                    name: El Beni
                  - abbr: L
                    name: La Paz
                  - abbr: O
                    name: Oruro
                  - abbr: "N"
                    name: Pando
                  - abbr: P
                    name: Potosí
                  - abbr: S
                    name: Santa Cruz
                  - abbr: T
                    name: Tarija
                - iso: BQ
                  iso3: BES
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: BO
                    name: Bonaire
                  - abbr: SA
                    name: Saba
                  - abbr: SE
                    name: Sint Eustatius
                - iso: BR
                  iso3: BRA
                  states_required: true
                  zipcode_required: true
                  states:
                  - abbr: AC
                    name: Acre
                  - abbr: AL
                    name: Alagoas
                  - abbr: AP
                    name: Amapá
                  - abbr: AM
                    name: Amazonas
                  - abbr: BA
                    name: Bahia
                  - abbr: CE
                    name: Ceará
                  - abbr: DF
                    name: Distrito Federal
                  - abbr: ES
                    name: Espírito Santo
                  - abbr: GO
                    name: Goiás
                  - abbr: MA
                    name: Maranhão
                  - abbr: MT
                    name: Mato Grosso
                  - abbr: MS
                    name: Mato Grosso do Sul
                  - abbr: MG
                    name: Minas Gerais
                  - abbr: PR
                    name: Paraná
                  - abbr: PB
                    name: Paraíba
                  - abbr: PA
                    name: Pará
                  - abbr: PE
                    name: Pernambuco
                  - abbr: PI
                    name: Piauí
                  - abbr: RN
                    name: Rio Grande do Norte
                  - abbr: RS
                    name: Rio Grande do Sul
                  - abbr: RJ
                    name: Rio de Janeiro
                  - abbr: RO
                    name: Rondônia
                  - abbr: RR
                    name: Roraima
                  - abbr: SC
                    name: Santa Catarina
                  - abbr: SE
                    name: Sergipe
                  - abbr: SP
                    name: São Paulo
                  - abbr: TO
                    name: Tocantins
                - iso: BS
                  iso3: BHS
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: AK
                    name: Acklins
                  - abbr: BY
                    name: Berry Islands
                  - abbr: BI
                    name: Bimini
                  - abbr: BP
                    name: Black Point
                  - abbr: CI
                    name: Cat Island
                  - abbr: CO
                    name: Central Abaco
                  - abbr: CS
                    name: Central Andros
                  - abbr: CE
                    name: Central Eleuthera
                  - abbr: CK
                    name: Crooked Island
                  - abbr: EG
                    name: East Grand Bahama
                  - abbr: EX
                    name: Exuma
                  - abbr: FP
                    name: Freeport
                  - abbr: GC
                    name: Grand Cay
                  - abbr: HI
                    name: Harbour Island
                  - abbr: HT
                    name: Hope Town
                  - abbr: IN
                    name: Inagua
                  - abbr: LI
                    name: Long Island
                  - abbr: MC
                    name: Mangrove Cay
                  - abbr: MG
                    name: Mayaguana
                  - abbr: MI
                    name: Moore’s Island
                  - abbr: NP
                    name: New Providence
                  - abbr: 'NO'
                    name: North Abaco
                  - abbr: NS
                    name: North Andros
                  - abbr: NE
                    name: North Eleuthera
                  - abbr: RI
                    name: Ragged Island
                  - abbr: RC
                    name: Rum Cay
                  - abbr: SS
                    name: San Salvador
                  - abbr: SO
                    name: South Abaco
                  - abbr: SA
                    name: South Andros
                  - abbr: SE
                    name: South Eleuthera
                  - abbr: SW
                    name: Spanish Wells
                  - abbr: WG
                    name: West Grand Bahama
                - iso: BT
                  iso3: BTN
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '33'
                    name: Bumthang
                  - abbr: '12'
                    name: Chhukha
                  - abbr: '22'
                    name: Dagana
                  - abbr: GA
                    name: Gasa
                  - abbr: '13'
                    name: Ha
                  - abbr: '44'
                    name: Lhuentse
                  - abbr: '42'
                    name: Monggar
                  - abbr: '11'
                    name: Paro
                  - abbr: '43'
                    name: Pemagatshel
                  - abbr: '23'
                    name: Punakha
                  - abbr: '45'
                    name: Samdrup Jongkha
                  - abbr: '14'
                    name: Samtse
                  - abbr: '31'
                    name: Sarpang
                  - abbr: '15'
                    name: Thimphu
                  - abbr: TY
                    name: Trashi Yangtse
                  - abbr: '41'
                    name: Trashigang
                  - abbr: '32'
                    name: Trongsa
                  - abbr: '21'
                    name: Tsirang
                  - abbr: '24'
                    name: Wangdue Phodrang
                  - abbr: '34'
                    name: Zhemgang
                - iso: BW
                  iso3: BWA
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: CE
                    name: Central
                  - abbr: CH
                    name: Chobe
                  - abbr: FR
                    name: Francistown
                  - abbr: GA
                    name: Gaborone
                  - abbr: GH
                    name: Ghanzi
                  - abbr: JW
                    name: Jwaneng
                  - abbr: KG
                    name: Kgalagadi
                  - abbr: KL
                    name: Kgatleng
                  - abbr: KW
                    name: Kweneng
                  - abbr: LO
                    name: Lobatse
                  - abbr: NE
                    name: North-East
                  - abbr: NW
                    name: North-West
                  - abbr: SP
                    name: Selibe Phikwe
                  - abbr: SE
                    name: South-East
                  - abbr: SO
                    name: Southern
                  - abbr: ST
                    name: Sowa Town
                - iso: BY
                  iso3: BLR
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: BR
                    name: Brest
                  - abbr: HO
                    name: Homel
                  - abbr: HR
                    name: Hrodna
                  - abbr: MA
                    name: Magileu
                  - abbr: MI
                    name: Minsk Region
                  - abbr: VI
                    name: Vitebsk
                  - abbr: HM
                    name: Мінск
                - iso: BZ
                  iso3: BLZ
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: BZ
                    name: Belize
                  - abbr: CY
                    name: Cayo
                  - abbr: CZL
                    name: Corozal
                  - abbr: OW
                    name: Orange Walk
                  - abbr: SC
                    name: Stann Creek
                  - abbr: TOL
                    name: Toledo
                - iso: CA
                  iso3: CAN
                  states_required: true
                  zipcode_required: true
                  states:
                  - abbr: AB
                    name: Alberta
                  - abbr: BC
                    name: British Columbia
                  - abbr: MB
                    name: Manitoba
                  - abbr: NB
                    name: New Brunswick
                  - abbr: NL
                    name: Newfoundland and Labrador
                  - abbr: NT
                    name: Northwest Territories
                  - abbr: NS
                    name: Nova Scotia
                  - abbr: NU
                    name: Nunavut
                  - abbr: 'ON'
                    name: Ontario
                  - abbr: PE
                    name: Prince Edward Island
                  - abbr: QC
                    name: Quebec
                  - abbr: SK
                    name: Saskatchewan
                  - abbr: YT
                    name: Yukon
                - iso: CC
                  iso3: CCK
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: CD
                  iso3: COD
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: BC
                    name: Bas-Congo
                  - abbr: BU
                    name: Bas-Uele
                  - abbr: HK
                    name: Haut-Katanga
                  - abbr: HL
                    name: Haut-Lomami
                  - abbr: HU
                    name: Haut-Uele
                  - abbr: IT
                    name: Ituri
                  - abbr: LO
                    name: Kabinda
                  - abbr: KE
                    name: Kasai-Oriental
                  - abbr: KS
                    name: Kasaï
                  - abbr: KN
                    name: Kinshasa
                  - abbr: KG
                    name: Kwango
                  - abbr: KL
                    name: Kwilu
                  - abbr: LU
                    name: Lualaba
                  - abbr: KC
                    name: Lulua
                  - abbr: MN
                    name: Mai-Ndombe
                  - abbr: MA
                    name: Maniema
                  - abbr: MO
                    name: Mongala
                  - abbr: NK
                    name: Nord-Kivu
                  - abbr: NU
                    name: Nord-Ubangi
                  - abbr: SA
                    name: Sankuru
                  - abbr: SK
                    name: Sud-Kivu
                  - abbr: SU
                    name: Sud-Ubangi
                  - abbr: TA
                    name: Tanganyika
                  - abbr: TO
                    name: Tshopo
                  - abbr: TU
                    name: Tshuapa
                  - abbr: EQ
                    name: Équateur
                - iso: CF
                  iso3: CAF
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: BB
                    name: Bamingui-Bangoran
                  - abbr: BGF
                    name: Bangui
                  - abbr: BK
                    name: Basse-Kotto
                  - abbr: HM
                    name: Haut-Mbomou
                  - abbr: HK
                    name: Haute-Kotto
                  - abbr: KG
                    name: Kémo
                  - abbr: LB
                    name: Lobaye
                  - abbr: HS
                    name: Mambéré-Kadéï
                  - abbr: MB
                    name: Mbomou
                  - abbr: KB
                    name: Nana-Grébizi
                  - abbr: NM
                    name: Nana-Mambéré
                  - abbr: MP
                    name: Ombella-Mpoko
                  - abbr: UK
                    name: Ouaka
                  - abbr: AC
                    name: Ouham
                  - abbr: OP
                    name: Ouham-Pendé
                  - abbr: SE
                    name: Sangha-Mbaéré
                  - abbr: VK
                    name: Vakaga
                - iso: CG
                  iso3: COG
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: '11'
                    name: Bouenza
                  - abbr: BZV
                    name: Brazzaville
                  - abbr: '8'
                    name: Cuvette
                  - abbr: '15'
                    name: Cuvette-Ouest
                  - abbr: '5'
                    name: Kouilou
                  - abbr: '7'
                    name: Likouala
                  - abbr: '2'
                    name: Lékoumou
                  - abbr: '9'
                    name: Niari
                  - abbr: '14'
                    name: Plateaux
                  - abbr: '16'
                    name: Pointe-Noire
                  - abbr: '12'
                    name: Pool
                  - abbr: '13'
                    name: Sangha
                - iso: CH
                  iso3: CHE
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AG
                    name: Aargau
                  - abbr: AR
                    name: Appenzell Ausserrhoden
                  - abbr: AI
                    name: Appenzell Innerrhoden
                  - abbr: BL
                    name: Basel-Landschaft
                  - abbr: BS
                    name: Basel-Stadt
                  - abbr: BE
                    name: Bern
                  - abbr: FR
                    name: Fribourg
                  - abbr: GE
                    name: Geneva
                  - abbr: GL
                    name: Glarus
                  - abbr: GR
                    name: Graubünden
                  - abbr: JU
                    name: Jura
                  - abbr: LU
                    name: Lucerne
                  - abbr: NE
                    name: Neuchâtel
                  - abbr: NW
                    name: Nidwalden
                  - abbr: OW
                    name: Obwalden
                  - abbr: SH
                    name: Schaffhausen
                  - abbr: SZ
                    name: Schwyz
                  - abbr: SO
                    name: Solothurn
                  - abbr: SG
                    name: St. Gallen
                  - abbr: TG
                    name: Thurgau
                  - abbr: TI
                    name: Ticino
                  - abbr: UR
                    name: Uri
                  - abbr: VS
                    name: Valais
                  - abbr: VD
                    name: Vaud
                  - abbr: ZG
                    name: Zug
                  - abbr: ZH
                    name: Zürich
                - iso: CI
                  iso3: CIV
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: AB
                    name: Abidjan
                  - abbr: DN
                    name: Denguélé
                  - abbr: CM
                    name: District de la Comoé
                  - abbr: LC
                    name: District des Lacs
                  - abbr: LG
                    name: District des Lagunes
                  - abbr: MG
                    name: District des Montagnes
                  - abbr: BS
                    name: District du Bas-Sassandra
                  - abbr: SM
                    name: District du Sassandra-Marahoué
                  - abbr: WR
                    name: District du Woroba
                  - abbr: GD
                    name: Gôh-Djiboua
                  - abbr: SV
                    name: Savanes
                  - abbr: VB
                    name: Vallée du Bandama
                  - abbr: YM
                    name: Yamoussoukro
                  - abbr: ZZ
                    name: Zanzan
                - iso: CK
                  iso3: COK
                  states_required: false
                  zipcode_required: false
                  states: []
                - iso: CL
                  iso3: CHL
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AI
                    name: Aisén del General Carlos Ibáñez del Campo
                  - abbr: AN
                    name: Antofagasta
                  - abbr: AR
                    name: Araucanía
                  - abbr: AP
                    name: Arica y Parinacota
                  - abbr: AT
                    name: Atacama
                  - abbr: BI
                    name: Bío-Bío
                  - abbr: CO
                    name: Coquimbo
                  - abbr: LI
                    name: Libertador General Bernardo O'Higgins
                  - abbr: LL
                    name: Los Lagos
                  - abbr: LR
                    name: Los Ríos
                  - abbr: MA
                    name: Magallanes
                  - abbr: ML
                    name: Maule
                  - abbr: RM
                    name: Región Metropolitana de Santiago
                  - abbr: NB
                    name: Región de Ñuble
                  - abbr: TA
                    name: Tarapacá
                  - abbr: VS
                    name: Valparaíso
                - iso: CM
                  iso3: CMR
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: AD
                    name: Adamaoua
                  - abbr: CE
                    name: Centre
                  - abbr: ES
                    name: East
                  - abbr: EN
                    name: Far North
                  - abbr: LT
                    name: Littoral
                  - abbr: 'NO'
                    name: North
                  - abbr: NW
                    name: North-West
                  - abbr: SU
                    name: South
                  - abbr: SW
                    name: South-West
                  - abbr: OU
                    name: West
                - iso: CN
                  iso3: CHN
                  states_required: true
                  zipcode_required: true
                  states:
                  - abbr: AH
                    name: Anhui
                  - abbr: BJ
                    name: Beijing
                  - abbr: CQ
                    name: Chongqing
                  - abbr: FJ
                    name: Fujian
                  - abbr: GS
                    name: Gansu
                  - abbr: GD
                    name: Guangdong
                  - abbr: GX
                    name: Guangxi
                  - abbr: GZ
                    name: Guizhou
                  - abbr: HI
                    name: Hainan
                  - abbr: HE
                    name: Hebei
                  - abbr: HL
                    name: Heilongjiang
                  - abbr: HA
                    name: Henan
                  - abbr: HB
                    name: Hubei
                  - abbr: HN
                    name: Hunan
                  - abbr: NM
                    name: Inner Mongolia
                  - abbr: JS
                    name: Jiangsu
                  - abbr: JX
                    name: Jiangxi
                  - abbr: JL
                    name: Jilin
                  - abbr: LN
                    name: Liaoning
                  - abbr: NX
                    name: Ningxia
                  - abbr: QH
                    name: Qinghai
                  - abbr: SN
                    name: Shaanxi
                  - abbr: SD
                    name: Shandong
                  - abbr: SH
                    name: Shanghai
                  - abbr: SX
                    name: Shanxi
                  - abbr: SC
                    name: Sichuan
                  - abbr: TJ
                    name: Tianjin
                  - abbr: XJ
                    name: Xinjiang
                  - abbr: XZ
                    name: Xizang
                  - abbr: YN
                    name: Yunnan
                  - abbr: ZJ
                    name: Zhejiang
                - iso: CO
                  iso3: COL
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AMA
                    name: Amazonas
                  - abbr: ANT
                    name: Antioquia
                  - abbr: ARA
                    name: Arauca
                  - abbr: ATL
                    name: Atlántico
                  - abbr: BOL
                    name: Bolívar
                  - abbr: BOY
                    name: Boyacá
                  - abbr: CAL
                    name: Caldas
                  - abbr: CAQ
                    name: Caquetá
                  - abbr: CAS
                    name: Casanare
                  - abbr: CAU
                    name: Cauca
                  - abbr: CES
                    name: Cesar
                  - abbr: CHO
                    name: Chocó
                  - abbr: CUN
                    name: Cundinamarca
                  - abbr: COR
                    name: Córdoba
                  - abbr: DC
                    name: Distrito Capital de Bogotá
                  - abbr: GUA
                    name: Guainía
                  - abbr: GUV
                    name: Guaviare
                  - abbr: HUI
                    name: Huila
                  - abbr: LAG
                    name: La Guajira
                  - abbr: MAG
                    name: Magdalena
                  - abbr: MET
                    name: Meta
                  - abbr: NAR
                    name: Nariño
                  - abbr: NSA
                    name: Norte de Santander
                  - abbr: PUT
                    name: Putumayo
                  - abbr: QUI
                    name: Quindío
                  - abbr: RIS
                    name: Risaralda
                  - abbr: SAP
                    name: San Andrés, Providencia y Santa Catalina
                  - abbr: SAN
                    name: Santander
                  - abbr: SUC
                    name: Sucre
                  - abbr: TOL
                    name: Tolima
                  - abbr: VAC
                    name: Valle del Cauca
                  - abbr: VAU
                    name: Vaupés
                  - abbr: VID
                    name: Vichada
                - iso: CR
                  iso3: CRI
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: A
                    name: Alajuela
                  - abbr: C
                    name: Cartago
                  - abbr: G
                    name: Guanacaste
                  - abbr: H
                    name: Heredia
                  - abbr: L
                    name: Limón
                  - abbr: P
                    name: Puntarenas
                  - abbr: SJ
                    name: San José
                - iso: CU
                  iso3: CUB
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '15'
                    name: Artemisa
                  - abbr: '09'
                    name: Camagüey
                  - abbr: '08'
                    name: Ciego de Ávila
                  - abbr: '06'
                    name: Cienfuegos
                  - abbr: '12'
                    name: Granma
                  - abbr: '14'
                    name: Guantánamo
                  - abbr: '11'
                    name: Holguín
                  - abbr: '99'
                    name: Isla de la Juventud
                  - abbr: '03'
                    name: La Habana
                  - abbr: '10'
                    name: Las Tunas
                  - abbr: '04'
                    name: Matanzas
                  - abbr: '16'
                    name: Mayabeque
                  - abbr: '01'
                    name: Pinar del Río
                  - abbr: '07'
                    name: Sancti Spíritus
                  - abbr: '13'
                    name: Santiago de Cuba
                  - abbr: '05'
                    name: Villa Clara
                - iso: CV
                  iso3: CPV
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: BV
                    name: Boa Vista
                  - abbr: BR
                    name: Brava
                  - abbr: CS
                    name: Calheta de São Miguel
                  - abbr: B
                    name: Ilhas de Barlavento
                  - abbr: S
                    name: Ilhas de Sotavento
                  - abbr: MA
                    name: Maio
                  - abbr: MO
                    name: Mosteiros
                  - abbr: PA
                    name: Paúl
                  - abbr: PN
                    name: Porto Novo
                  - abbr: PR
                    name: Praia
                  - abbr: RB
                    name: Ribeira Brava
                  - abbr: RG
                    name: Ribeira Grande
                  - abbr: RS
                    name: Ribeira Grande de Santiago
                  - abbr: SL
                    name: Sal
                  - abbr: CA
                    name: Santa Catarina
                  - abbr: CF
                    name: Santa Catarina do Fogo
                  - abbr: CR
                    name: Santa Cruz
                  - abbr: SD
                    name: São Domingos
                  - abbr: SF
                    name: São Filipe
                  - abbr: SO
                    name: São Lourenço dos Órgãos
                  - abbr: SM
                    name: São Miguel
                  - abbr: SN
                    name: São Nicolau
                  - abbr: SS
                    name: São Salvador do Mundo
                  - abbr: SV
                    name: São Vicente
                  - abbr: TA
                    name: Tarrafal
                  - abbr: TS
                    name: Tarrafal de São Nicolau
                - iso: CW
                  iso3: CUW
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: CX
                  iso3: CXR
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: CY
                  iso3: CYP
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '04'
                    name: Ammochostos
                  - abbr: '06'
                    name: Keryneia
                  - abbr: '03'
                    name: Larnaka
                  - abbr: '01'
                    name: Lefkosia
                  - abbr: '02'
                    name: Lemesos
                  - abbr: '05'
                    name: Pafos
                - iso: CZ
                  iso3: CZE
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '201'
                    name: Benešov
                  - abbr: '202'
                    name: Beroun
                  - abbr: '641'
                    name: Blansko
                  - abbr: '642'
                    name: Brno-město
                  - abbr: '643'
                    name: Brno-venkov
                  - abbr: '801'
                    name: Bruntál
                  - abbr: '644'
                    name: Břeclav
                  - abbr: '411'
                    name: Cheb
                  - abbr: '422'
                    name: Chomutov
                  - abbr: '531'
                    name: Chrudim
                  - abbr: '321'
                    name: Domažlice
                  - abbr: '421'
                    name: Děčín
                  - abbr: '802'
                    name: Frýdek-Místek
                  - abbr: '631'
                    name: Havlíčkův Brod
                  - abbr: '645'
                    name: Hodonín
                  - abbr: '521'
                    name: Hradec Králové
                  - abbr: '512'
                    name: Jablonec nad Nisou
                  - abbr: '711'
                    name: Jeseník
                  - abbr: '632'
                    name: Jihlava
                  - abbr: '64'
                    name: Jihomoravský kraj
                  - abbr: '31'
                    name: Jihočeský kraj
                  - abbr: '313'
                    name: Jindřichův Hradec
                  - abbr: '522'
                    name: Jičín
                  - abbr: '41'
                    name: Karlovarský kraj
                  - abbr: '412'
                    name: Karlovy Vary
                  - abbr: '803'
                    name: Karviná
                  - abbr: '203'
                    name: Kladno
                  - abbr: '322'
                    name: Klatovy
                  - abbr: '204'
                    name: Kolín
                  - abbr: '63'
                    name: Kraj Vysočina
                  - abbr: '721'
                    name: Kroměříž
                  - abbr: '52'
                    name: Královéhradecký kraj
                  - abbr: '205'
                    name: Kutná Hora
                  - abbr: '513'
                    name: Liberec
                  - abbr: '51'
                    name: Liberecký kraj
                  - abbr: '423'
                    name: Litoměřice
                  - abbr: '424'
                    name: Louny
                  - abbr: '207'
                    name: Mladá Boleslav
                  - abbr: '80'
                    name: Moravskoslezský kraj
                  - abbr: '425'
                    name: Most
                  - abbr: '206'
                    name: Mělník
                  - abbr: '804'
                    name: Nový Jičín
                  - abbr: '208'
                    name: Nymburk
                  - abbr: '523'
                    name: Náchod
                  - abbr: '712'
                    name: Olomouc
                  - abbr: '71'
                    name: Olomoucký kraj
                  - abbr: '805'
                    name: Opava
                  - abbr: '806'
                    name: Ostrava-město
                  - abbr: '532'
                    name: Pardubice
                  - abbr: '53'
                    name: Pardubický kraj
                  - abbr: '633'
                    name: Pelhřimov
                  - abbr: '324'
                    name: Plzeň-jih
                  - abbr: '323'
                    name: Plzeň-město
                  - abbr: '325'
                    name: Plzeň-sever
                  - abbr: '32'
                    name: Plzeňský kraj
                  - abbr: '315'
                    name: Prachatice
                  - abbr: '10'
                    name: Praha, Hlavní město
                  - abbr: '209'
                    name: Praha-východ
                  - abbr: 20A
                    name: Praha-západ
                  - abbr: '713'
                    name: Prostějov
                  - abbr: '314'
                    name: Písek
                  - abbr: '714'
                    name: Přerov
                  - abbr: 20B
                    name: Příbram
                  - abbr: 20C
                    name: Rakovník
                  - abbr: '326'
                    name: Rokycany
                  - abbr: '524'
                    name: Rychnov nad Kněžnou
                  - abbr: '514'
                    name: Semily
                  - abbr: '413'
                    name: Sokolov
                  - abbr: '316'
                    name: Strakonice
                  - abbr: '20'
                    name: Středočeský kraj
                  - abbr: '533'
                    name: Svitavy
                  - abbr: '327'
                    name: Tachov
                  - abbr: '426'
                    name: Teplice
                  - abbr: '525'
                    name: Trutnov
                  - abbr: '317'
                    name: Tábor
                  - abbr: '634'
                    name: Třebíč
                  - abbr: '722'
                    name: Uherské Hradiště
                  - abbr: '723'
                    name: Vsetín
                  - abbr: '646'
                    name: Vyškov
                  - abbr: '724'
                    name: Zlín
                  - abbr: '72'
                    name: Zlínský kraj
                  - abbr: '647'
                    name: Znojmo
                  - abbr: '42'
                    name: Ústecký kraj
                  - abbr: '427'
                    name: Ústí nad Labem
                  - abbr: '534'
                    name: Ústí nad Orlicí
                  - abbr: '511'
                    name: Česká Lípa
                  - abbr: '311'
                    name: České Budějovice
                  - abbr: '312'
                    name: Český Krumlov
                  - abbr: '715'
                    name: Šumperk
                  - abbr: '635'
                    name: Žďár nad Sázavou
                - iso: DE
                  iso3: DEU
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: BW
                    name: Baden-Württemberg
                  - abbr: BY
                    name: Bayern
                  - abbr: BE
                    name: Berlin
                  - abbr: BB
                    name: Brandenburg
                  - abbr: HB
                    name: Bremen
                  - abbr: HH
                    name: Hamburg
                  - abbr: HE
                    name: Hessen
                  - abbr: MV
                    name: Mecklenburg-Vorpommern
                  - abbr: NI
                    name: Niedersachsen
                  - abbr: NW
                    name: Nordrhein-Westfalen
                  - abbr: RP
                    name: Rheinland-Pfalz
                  - abbr: SL
                    name: Saarland
                  - abbr: SN
                    name: Sachsen
                  - abbr: ST
                    name: Sachsen-Anhalt
                  - abbr: SH
                    name: Schleswig-Holstein
                  - abbr: TH
                    name: Thüringen
                - iso: DJ
                  iso3: DJI
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: AS
                    name: Ali Sabieh
                  - abbr: AR
                    name: Arta
                  - abbr: DI
                    name: Dikhil
                  - abbr: DJ
                    name: Djibouti
                  - abbr: OB
                    name: Obock
                  - abbr: TA
                    name: Tadjourah
                - iso: DK
                  iso3: DNK
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '84'
                    name: Hovedstaden
                  - abbr: '82'
                    name: Midtjylland
                  - abbr: '81'
                    name: Nordjylland
                  - abbr: '85'
                    name: Sjælland
                  - abbr: '83'
                    name: Syddanmark
                - iso: DM
                  iso3: DMA
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: '02'
                    name: Saint Andrew
                  - abbr: '03'
                    name: Saint David
                  - abbr: '04'
                    name: Saint George
                  - abbr: '05'
                    name: Saint John
                  - abbr: '06'
                    name: Saint Joseph
                  - abbr: '07'
                    name: Saint Luke
                  - abbr: '08'
                    name: Saint Mark
                  - abbr: '09'
                    name: Saint Patrick
                  - abbr: '10'
                    name: Saint Paul
                  - abbr: '11'
                    name: Saint Peter
                - iso: DO
                  iso3: DOM
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '02'
                    name: Azua
                  - abbr: '03'
                    name: Bahoruco
                  - abbr: '04'
                    name: Barahona
                  - abbr: '33'
                    name: Cibao Nordeste
                  - abbr: '34'
                    name: Cibao Noroeste
                  - abbr: '35'
                    name: Cibao Norte
                  - abbr: '36'
                    name: Cibao Sur
                  - abbr: '05'
                    name: Dajabón
                  - abbr: '01'
                    name: Distrito Nacional (Santo Domingo)
                  - abbr: '06'
                    name: Duarte
                  - abbr: '08'
                    name: El Seybo [El Seibo]
                  - abbr: '37'
                    name: El Valle
                  - abbr: '38'
                    name: Enriquillo
                  - abbr: '09'
                    name: Espaillat
                  - abbr: '30'
                    name: Hato Mayor
                  - abbr: '39'
                    name: Higüamo
                  - abbr: '10'
                    name: Independencia
                  - abbr: '11'
                    name: La Altagracia
                  - abbr: '07'
                    name: La Estrelleta [Elías Piña]
                  - abbr: '12'
                    name: La Romana
                  - abbr: '13'
                    name: La Vega
                  - abbr: '14'
                    name: María Trinidad Sánchez
                  - abbr: '28'
                    name: Monseñor Nouel
                  - abbr: '15'
                    name: Monte Cristi
                  - abbr: '29'
                    name: Monte Plata
                  - abbr: '40'
                    name: Ozama
                  - abbr: '16'
                    name: Pedernales
                  - abbr: '17'
                    name: Peravia
                  - abbr: '18'
                    name: Puerto Plata
                  - abbr: '19'
                    name: Salcedo
                  - abbr: '20'
                    name: Samaná
                  - abbr: '21'
                    name: San Cristóbal
                  - abbr: '31'
                    name: San Jose de Ocoa
                  - abbr: '22'
                    name: San Juan
                  - abbr: '23'
                    name: San Pedro de Macorís
                  - abbr: '25'
                    name: Santiago
                  - abbr: '26'
                    name: Santiago Rodríguez
                  - abbr: '32'
                    name: Santo Domingo
                  - abbr: '24'
                    name: Sánchez Ramírez
                  - abbr: '41'
                    name: Valdesia
                  - abbr: '27'
                    name: Valverde
                  - abbr: '42'
                    name: Yuma
                - iso: DZ
                  iso3: DZA
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '01'
                    name: Adrar
                  - abbr: '16'
                    name: Alger
                  - abbr: '23'
                    name: Annaba
                  - abbr: '44'
                    name: Aïn Defla
                  - abbr: '46'
                    name: Aïn Témouchent
                  - abbr: '05'
                    name: Batna
                  - abbr: '07'
                    name: Biskra
                  - abbr: '09'
                    name: Blida
                  - abbr: '34'
                    name: Bordj Bou Arréridj
                  - abbr: '10'
                    name: Bouira
                  - abbr: '35'
                    name: Boumerdès
                  - abbr: '08'
                    name: Béchar
                  - abbr: '06'
                    name: Béjaïa
                  - abbr: '02'
                    name: Chlef
                  - abbr: '25'
                    name: Constantine
                  - abbr: '17'
                    name: Djelfa
                  - abbr: '32'
                    name: El Bayadh
                  - abbr: '39'
                    name: El Oued
                  - abbr: '36'
                    name: El Tarf
                  - abbr: '47'
                    name: Ghardaïa
                  - abbr: '24'
                    name: Guelma
                  - abbr: '33'
                    name: Illizi
                  - abbr: '18'
                    name: Jijel
                  - abbr: '40'
                    name: Khenchela
                  - abbr: '03'
                    name: Laghouat
                  - abbr: '29'
                    name: Mascara
                  - abbr: '43'
                    name: Mila
                  - abbr: '27'
                    name: Mostaganem
                  - abbr: '28'
                    name: Msila
                  - abbr: '26'
                    name: Médéa
                  - abbr: '45'
                    name: Naama
                  - abbr: '31'
                    name: Oran
                  - abbr: '30'
                    name: Ouargla
                  - abbr: '04'
                    name: Oum el Bouaghi
                  - abbr: '48'
                    name: Relizane
                  - abbr: '20'
                    name: Saïda
                  - abbr: '22'
                    name: Sidi Bel Abbès
                  - abbr: '21'
                    name: Skikda
                  - abbr: '41'
                    name: Souk Ahras
                  - abbr: '19'
                    name: Sétif
                  - abbr: '11'
                    name: Tamanghasset
                  - abbr: '14'
                    name: Tiaret
                  - abbr: '37'
                    name: Tindouf
                  - abbr: '42'
                    name: Tipaza
                  - abbr: '38'
                    name: Tissemsilt
                  - abbr: '15'
                    name: Tizi Ouzou
                  - abbr: '13'
                    name: Tlemcen
                  - abbr: '12'
                    name: Tébessa
                - iso: EC
                  iso3: ECU
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: A
                    name: Azuay
                  - abbr: B
                    name: Bolívar
                  - abbr: C
                    name: Carchi
                  - abbr: F
                    name: Cañar
                  - abbr: H
                    name: Chimborazo
                  - abbr: X
                    name: Cotopaxi
                  - abbr: O
                    name: El Oro
                  - abbr: E
                    name: Esmeraldas
                  - abbr: W
                    name: Galápagos
                  - abbr: G
                    name: Guayas
                  - abbr: I
                    name: Imbabura
                  - abbr: L
                    name: Loja
                  - abbr: R
                    name: Los Ríos
                  - abbr: M
                    name: Manabí
                  - abbr: S
                    name: Morona-Santiago
                  - abbr: "N"
                    name: Napo
                  - abbr: D
                    name: Orellana
                  - abbr: "Y"
                    name: Pastaza
                  - abbr: P
                    name: Pichincha
                  - abbr: SE
                    name: Santa Elena
                  - abbr: SD
                    name: Santo Domingo de los Tsachilas
                  - abbr: U
                    name: Sucumbíos
                  - abbr: T
                    name: Tungurahua
                  - abbr: Z
                    name: Zamora-Chinchipe
                - iso: EE
                  iso3: EST
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '130'
                    name: Alutaguse
                  - abbr: '141'
                    name: Anija
                  - abbr: '142'
                    name: Antsla
                  - abbr: '171'
                    name: Elva
                  - abbr: '184'
                    name: Haapsalu
                  - abbr: '191'
                    name: Haljala
                  - abbr: '37'
                    name: Harjumaa
                  - abbr: '198'
                    name: Harku
                  - abbr: '205'
                    name: Hiiumaa
                  - abbr: '39'
                    name: Hiiumaa
                  - abbr: '214'
                    name: Häädemeeste
                  - abbr: '45'
                    name: Ida-Virumaa
                  - abbr: '255'
                    name: Järva
                  - abbr: '52'
                    name: Järvamaa
                  - abbr: '245'
                    name: Jõelähtme
                  - abbr: '247'
                    name: Jõgeva
                  - abbr: '50'
                    name: Jõgevamaa
                  - abbr: '251'
                    name: Jõhvi
                  - abbr: '272'
                    name: Kadrina
                  - abbr: '283'
                    name: Kambja
                  - abbr: '284'
                    name: Kanepi
                  - abbr: '291'
                    name: Kastre
                  - abbr: '293'
                    name: Kehtna
                  - abbr: '296'
                    name: Keila
                  - abbr: '303'
                    name: Kihnu
                  - abbr: '305'
                    name: Kiili
                  - abbr: '317'
                    name: Kohila
                  - abbr: '321'
                    name: Kohtla-Järve
                  - abbr: '338'
                    name: Kose
                  - abbr: '353'
                    name: Kuusalu
                  - abbr: '424'
                    name: Loksa
                  - abbr: '432'
                    name: Luunja
                  - abbr: '431'
                    name: Lääne-Harju
                  - abbr: '441'
                    name: Lääne-Nigula
                  - abbr: '60'
                    name: Lääne-Virumaa
                  - abbr: '56'
                    name: Läänemaa
                  - abbr: '430'
                    name: Lääneranna
                  - abbr: '442'
                    name: Lüganuse
                  - abbr: '446'
                    name: Maardu
                  - abbr: '478'
                    name: Muhu
                  - abbr: '480'
                    name: Mulgi
                  - abbr: '486'
                    name: Mustvee
                  - abbr: '503'
                    name: Märjamaa
                  - abbr: '511'
                    name: Narva
                  - abbr: '514'
                    name: Narva-Jõesuu
                  - abbr: '528'
                    name: Nõo
                  - abbr: '557'
                    name: Otepää
                  - abbr: '567'
                    name: Paide
                  - abbr: '586'
                    name: Peipsiääre
                  - abbr: '624'
                    name: Pärnu
                  - abbr: '68'
                    name: Pärnumaa
                  - abbr: '638'
                    name: Põhja-Pärnumaa
                  - abbr: '615'
                    name: Põhja-Sakala
                  - abbr: '618'
                    name: Põltsamaa
                  - abbr: '622'
                    name: Põlva
                  - abbr: '64'
                    name: Põlvamaa
                  - abbr: '651'
                    name: Raasiku
                  - abbr: '653'
                    name: Rae
                  - abbr: '661'
                    name: Rakvere
                  - abbr: '663'
                    name: Rakvere
                  - abbr: '668'
                    name: Rapla
                  - abbr: '71'
                    name: Raplamaa
                  - abbr: '689'
                    name: Ruhnu
                  - abbr: '708'
                    name: Räpina
                  - abbr: '698'
                    name: Rõuge
                  - abbr: '712'
                    name: Saarde
                  - abbr: '714'
                    name: Saaremaa
                  - abbr: '74'
                    name: Saaremaa
                  - abbr: '719'
                    name: Saku
                  - abbr: '726'
                    name: Saue
                  - abbr: '732'
                    name: Setomaa
                  - abbr: '735'
                    name: Sillamäe
                  - abbr: '784'
                    name: Tallinn
                  - abbr: '792'
                    name: Tapa
                  - abbr: '793'
                    name: Tartu
                  - abbr: '796'
                    name: Tartu
                  - abbr: '79'
                    name: Tartumaa
                  - abbr: '803'
                    name: Toila
                  - abbr: '809'
                    name: Tori
                  - abbr: '824'
                    name: Tõrva
                  - abbr: '834'
                    name: Türi
                  - abbr: '855'
                    name: Valga
                  - abbr: '81'
                    name: Valgamaa
                  - abbr: '890'
                    name: Viimsi
                  - abbr: '899'
                    name: Viljandi
                  - abbr: '897'
                    name: Viljandi
                  - abbr: '84'
                    name: Viljandimaa
                  - abbr: '901'
                    name: Vinni
                  - abbr: '903'
                    name: Viru-Nigula
                  - abbr: '907'
                    name: Vormsi
                  - abbr: '928'
                    name: Väike-Maarja
                  - abbr: '917'
                    name: Võru
                  - abbr: '919'
                    name: Võru
                  - abbr: '87'
                    name: Võrumaa
                - iso: EG
                  iso3: EGY
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: DK
                    name: Ad Daqahliyah
                  - abbr: BA
                    name: Al Bahr al Ahmar
                  - abbr: BH
                    name: Al Buhayrah
                  - abbr: FYM
                    name: Al Fayyum
                  - abbr: GH
                    name: Al Gharbiyah
                  - abbr: ALX
                    name: Al Iskandariyah
                  - abbr: IS
                    name: Al Ismā`īlīyah
                  - abbr: GZ
                    name: Al Jizah
                  - abbr: MNF
                    name: Al Minufiyah
                  - abbr: MN
                    name: Al Minya
                  - abbr: C
                    name: Al Qahirah
                  - abbr: KB
                    name: Al Qalyubiyah
                  - abbr: WAD
                    name: Al Wadi al Jadid
                  - abbr: SUZ
                    name: As Suways
                  - abbr: SHR
                    name: Ash Sharqiyah
                  - abbr: ASN
                    name: Aswan
                  - abbr: AST
                    name: Asyut
                  - abbr: BNS
                    name: Bani Suwayf
                  - abbr: PTS
                    name: Būr Sa`īd
                  - abbr: DT
                    name: Dumyat
                  - abbr: JS
                    name: Janub Sina'
                  - abbr: KFS
                    name: Kafr ash Shaykh
                  - abbr: MT
                    name: Matrūh
                  - abbr: KN
                    name: Qina
                  - abbr: SIN
                    name: Shamal Sina'
                  - abbr: SHG
                    name: Suhaj
                  - abbr: LX
                    name: al-Uqsur
                - iso: ER
                  iso3: ERI
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: AN
                    name: Anseba
                  - abbr: DU
                    name: Debub
                  - abbr: DK
                    name: Debubawi Keyih Bahri [Debub-Keih-Bahri]
                  - abbr: GB
                    name: Gash-Barka
                  - abbr: MA
                    name: Maakel [Maekel]
                  - abbr: SK
                    name: Semenawi Keyih Bahri [Semien-Keih-Bahri]
                - iso: ES
                  iso3: ESP
                  states_required: true
                  zipcode_required: true
                  states:
                  - abbr: AB
                    name: Albacete
                  - abbr: A
                    name: Alicante/Alacant
                  - abbr: AL
                    name: Almería
                  - abbr: AN
                    name: Andalucía
                  - abbr: VI
                    name: Araba/Álava
                  - abbr: AR
                    name: Aragón
                  - abbr: O
                    name: Asturias
                  - abbr: BA
                    name: Badajoz
                  - abbr: PM
                    name: Balears, Illes
                  - abbr: B
                    name: Barcelona
                  - abbr: BI
                    name: Bizkaia
                  - abbr: BU
                    name: Burgos
                  - abbr: CN
                    name: Canary Islands
                  - abbr: CB
                    name: Cantabria
                  - abbr: S
                    name: Cantabria
                  - abbr: CS
                    name: Castellón/Castelló
                  - abbr: CL
                    name: Castilla y León
                  - abbr: CM
                    name: Castilla-La Mancha
                  - abbr: CT
                    name: Cataluña
                  - abbr: CE
                    name: Ceuta
                  - abbr: CR
                    name: Ciudad Real
                  - abbr: VC
                    name: Comunidad Valenciana
                  - abbr: MD
                    name: Comunidad de Madrid
                  - abbr: C
                    name: Coruña, A
                  - abbr: CU
                    name: Cuenca
                  - abbr: CC
                    name: Cáceres
                  - abbr: CA
                    name: Cádiz
                  - abbr: CO
                    name: Córdoba
                  - abbr: EX
                    name: Extremadura
                  - abbr: GA
                    name: Galicia
                  - abbr: SS
                    name: Gipuzkoa
                  - abbr: GI
                    name: Girona
                  - abbr: GR
                    name: Granada
                  - abbr: GU
                    name: Guadalajara
                  - abbr: H
                    name: Huelva
                  - abbr: HU
                    name: Huesca
                  - abbr: IB
                    name: Islas Baleares
                  - abbr: J
                    name: Jaén
                  - abbr: RI
                    name: La Rioja
                  - abbr: LE
                    name: León
                  - abbr: L
                    name: Lleida
                  - abbr: LU
                    name: Lugo
                  - abbr: M
                    name: Madrid
                  - abbr: ML
                    name: Melilla
                  - abbr: MU
                    name: Murcia
                  - abbr: MA
                    name: Málaga
                  - abbr: NC
                    name: Navarra
                  - abbr: NA
                    name: Navarra
                  - abbr: OR
                    name: Ourense
                  - abbr: P
                    name: Palencia
                  - abbr: GC
                    name: Palmas, Las
                  - abbr: PV
                    name: País Vasco
                  - abbr: PO
                    name: Pontevedra
                  - abbr: AS
                    name: Principado de Asturias
                  - abbr: MC
                    name: Región de Murcia
                  - abbr: LO
                    name: Rioja, La
                  - abbr: SA
                    name: Salamanca
                  - abbr: TF
                    name: Santa Cruz de Tenerife
                  - abbr: SG
                    name: Segovia
                  - abbr: SE
                    name: Sevilla
                  - abbr: SO
                    name: Soria
                  - abbr: T
                    name: Tarragona
                  - abbr: TE
                    name: Teruel
                  - abbr: TO
                    name: Toledo
                  - abbr: V
                    name: Valencia/València
                  - abbr: VA
                    name: Valladolid
                  - abbr: ZA
                    name: Zamora
                  - abbr: Z
                    name: Zaragoza
                  - abbr: AV
                    name: Ávila
                - iso: ET
                  iso3: ETH
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AA
                    name: Adis Abeba
                  - abbr: AF
                    name: Afar
                  - abbr: AM
                    name: Amara
                  - abbr: BE
                    name: Binshangul Gumuz
                  - abbr: DD
                    name: Dire Dawa
                  - abbr: GA
                    name: Gambela Hizboch
                  - abbr: HA
                    name: Hareri Hizb
                  - abbr: OR
                    name: Oromiya
                  - abbr: SO
                    name: Sumale
                  - abbr: TI
                    name: Tigray
                  - abbr: SN
                    name: YeDebub Biheroch Bihereseboch na Hizboch
                - iso: FI
                  iso3: FIN
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '01'
                    name: Ahvenanmaan maakunta
                  - abbr: '02'
                    name: Etelä-Karjala
                  - abbr: '03'
                    name: Etelä-Pohjanmaa
                  - abbr: '04'
                    name: Etelä-Savo
                  - abbr: '05'
                    name: Kainuu
                  - abbr: '06'
                    name: Kanta-Häme
                  - abbr: '07'
                    name: Keski-Pohjanmaa
                  - abbr: '08'
                    name: Keski-Suomi
                  - abbr: '09'
                    name: Kymenlaakso
                  - abbr: '10'
                    name: Lappi
                  - abbr: '11'
                    name: Pirkanmaa
                  - abbr: '12'
                    name: Pohjanmaa
                  - abbr: '13'
                    name: Pohjois-Karjala
                  - abbr: '14'
                    name: Pohjois-Pohjanmaa
                  - abbr: '15'
                    name: Pohjois-Savo
                  - abbr: '16'
                    name: Päijät-Häme
                  - abbr: '17'
                    name: Satakunta
                  - abbr: '18'
                    name: Uusimaa
                  - abbr: '19'
                    name: Varsinais-Suomi
                - iso: FJ
                  iso3: FJI
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: '01'
                    name: Ba
                  - abbr: '02'
                    name: Bua
                  - abbr: '03'
                    name: Cakaudrove
                  - abbr: C
                    name: Central
                  - abbr: E
                    name: Eastern
                  - abbr: '04'
                    name: Kadavu
                  - abbr: '05'
                    name: Lau
                  - abbr: '06'
                    name: Lomaiviti
                  - abbr: '07'
                    name: Macuata
                  - abbr: '08'
                    name: Nadroga-Navosa
                  - abbr: '09'
                    name: Naitasiri
                  - abbr: '10'
                    name: Namosi
                  - abbr: "N"
                    name: Northern
                  - abbr: '11'
                    name: Ra
                  - abbr: '12'
                    name: Rewa
                  - abbr: R
                    name: Rotuma
                  - abbr: '13'
                    name: Serua
                  - abbr: '14'
                    name: Tailevu
                  - abbr: W
                    name: Western
                - iso: FK
                  iso3: FLK
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: FM
                  iso3: FSM
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: TRK
                    name: Chuuk
                  - abbr: KSA
                    name: Kosrae
                  - abbr: PNI
                    name: Pohnpei
                  - abbr: YAP
                    name: Yap
                - iso: FO
                  iso3: FRO
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: FR
                  iso3: FRA
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '01'
                    name: Ain
                  - abbr: '02'
                    name: Aisne
                  - abbr: '03'
                    name: Allier
                  - abbr: '06'
                    name: Alpes-Maritimes
                  - abbr: '04'
                    name: Alpes-de-Haute-Provence
                  - abbr: 6AE
                    name: Alsace
                  - abbr: '08'
                    name: Ardennes
                  - abbr: '07'
                    name: Ardèche
                  - abbr: '09'
                    name: Ariège
                  - abbr: '10'
                    name: Aube
                  - abbr: '11'
                    name: Aude
                  - abbr: ARA
                    name: Auvergne-Rhône-Alpes
                  - abbr: '12'
                    name: Aveyron
                  - abbr: '67'
                    name: Bas-Rhin
                  - abbr: '13'
                    name: Bouches-du-Rhône
                  - abbr: BFC
                    name: Bourgogne-Franche-Comté
                  - abbr: BRE
                    name: Bretagne
                  - abbr: '14'
                    name: Calvados
                  - abbr: '15'
                    name: Cantal
                  - abbr: CVL
                    name: Centre-Val de Loire
                  - abbr: '16'
                    name: Charente
                  - abbr: '17'
                    name: Charente-Maritime
                  - abbr: '18'
                    name: Cher
                  - abbr: CP
                    name: Clipperton
                  - abbr: '19'
                    name: Corrèze
                  - abbr: 20R
                    name: Corse
                  - abbr: 2A
                    name: Corse-du-Sud
                  - abbr: '23'
                    name: Creuse
                  - abbr: '21'
                    name: Côte-d'Or
                  - abbr: '22'
                    name: Côtes-d'Armor
                  - abbr: '79'
                    name: Deux-Sèvres
                  - abbr: '24'
                    name: Dordogne
                  - abbr: '25'
                    name: Doubs
                  - abbr: '26'
                    name: Drôme
                  - abbr: '91'
                    name: Essonne
                  - abbr: '27'
                    name: Eure
                  - abbr: '28'
                    name: Eure-et-Loir
                  - abbr: '29'
                    name: Finistère
                  - abbr: '30'
                    name: Gard
                  - abbr: '32'
                    name: Gers
                  - abbr: '33'
                    name: Gironde
                  - abbr: GES
                    name: Grand Est
                  - abbr: '971'
                    name: Guadeloupe
                  - abbr: '973'
                    name: Guyane (française)
                  - abbr: '68'
                    name: Haut-Rhin
                  - abbr: 2B
                    name: Haute-Corse
                  - abbr: '31'
                    name: Haute-Garonne
                  - abbr: '43'
                    name: Haute-Loire
                  - abbr: '52'
                    name: Haute-Marne
                  - abbr: '74'
                    name: Haute-Savoie
                  - abbr: '70'
                    name: Haute-Saône
                  - abbr: '87'
                    name: Haute-Vienne
                  - abbr: '05'
                    name: Hautes-Alpes
                  - abbr: '65'
                    name: Hautes-Pyrénées
                  - abbr: HDF
                    name: Hauts-de-France
                  - abbr: '92'
                    name: Hauts-de-Seine
                  - abbr: '34'
                    name: Hérault
                  - abbr: '35'
                    name: Ille-et-Vilaine
                  - abbr: '36'
                    name: Indre
                  - abbr: '37'
                    name: Indre-et-Loire
                  - abbr: '38'
                    name: Isère
                  - abbr: '39'
                    name: Jura
                  - abbr: '974'
                    name: La Réunion
                  - abbr: '40'
                    name: Landes
                  - abbr: '41'
                    name: Loir-et-Cher
                  - abbr: '42'
                    name: Loire
                  - abbr: '44'
                    name: Loire-Atlantique
                  - abbr: '45'
                    name: Loiret
                  - abbr: '46'
                    name: Lot
                  - abbr: '47'
                    name: Lot-et-Garonne
                  - abbr: '48'
                    name: Lozère
                  - abbr: '49'
                    name: Maine-et-Loire
                  - abbr: '50'
                    name: Manche
                  - abbr: '51'
                    name: Marne
                  - abbr: '972'
                    name: Martinique
                  - abbr: '53'
                    name: Mayenne
                  - abbr: '976'
                    name: Mayotte
                  - abbr: '54'
                    name: Meurthe-et-Moselle
                  - abbr: '55'
                    name: Meuse
                  - abbr: '56'
                    name: Morbihan
                  - abbr: '57'
                    name: Moselle
                  - abbr: 69M
                    name: Métropole de Lyon
                  - abbr: '58'
                    name: Nièvre
                  - abbr: '59'
                    name: Nord
                  - abbr: NOR
                    name: Normandie
                  - abbr: NAQ
                    name: Nouvelle-Aquitaine
                  - abbr: NC
                    name: Nouvelle-Calédonie
                  - abbr: OCC
                    name: Occitanie
                  - abbr: '60'
                    name: Oise
                  - abbr: '61'
                    name: Orne
                  - abbr: 75C
                    name: Paris
                  - abbr: '62'
                    name: Pas-de-Calais
                  - abbr: PDL
                    name: Pays de la Loire
                  - abbr: PF
                    name: Polynésie française
                  - abbr: PAC
                    name: Provence-Alpes-Côte d'Azur
                  - abbr: '63'
                    name: Puy-de-Dôme
                  - abbr: '64'
                    name: Pyrénées-Atlantiques
                  - abbr: '66'
                    name: Pyrénées-Orientales
                  - abbr: '69'
                    name: Rhône
                  - abbr: BL
                    name: Saint-Barthélemy
                  - abbr: MF
                    name: Saint-Martin
                  - abbr: PM
                    name: Saint-Pierre-et-Miquelon
                  - abbr: '72'
                    name: Sarthe
                  - abbr: '73'
                    name: Savoie
                  - abbr: '71'
                    name: Saône-et-Loire
                  - abbr: '76'
                    name: Seine-Maritime
                  - abbr: '93'
                    name: Seine-Saint-Denis
                  - abbr: '77'
                    name: Seine-et-Marne
                  - abbr: '80'
                    name: Somme
                  - abbr: '81'
                    name: Tarn
                  - abbr: '82'
                    name: Tarn-et-Garonne
                  - abbr: TF
                    name: Terres Australes Françaises
                  - abbr: '90'
                    name: Territoire de Belfort
                  - abbr: '95'
                    name: Val-d'Oise
                  - abbr: '94'
                    name: Val-de-Marne
                  - abbr: '83'
                    name: Var
                  - abbr: '84'
                    name: Vaucluse
                  - abbr: '85'
                    name: Vendée
                  - abbr: '86'
                    name: Vienne
                  - abbr: '88'
                    name: Vosges
                  - abbr: WF
                    name: Wallis-et-Futuna
                  - abbr: '89'
                    name: Yonne
                  - abbr: '78'
                    name: Yvelines
                  - abbr: IDF
                    name: Île-de-France
                - iso: GA
                  iso3: GAB
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '1'
                    name: Estuaire
                  - abbr: '2'
                    name: Haut-Ogooué
                  - abbr: '3'
                    name: Moyen-Ogooué
                  - abbr: '4'
                    name: Ngounié
                  - abbr: '5'
                    name: Nyanga
                  - abbr: '6'
                    name: Ogooué-Ivindo
                  - abbr: '7'
                    name: Ogooué-Lolo
                  - abbr: '8'
                    name: Ogooué-Maritime
                  - abbr: '9'
                    name: Woleu-Ntem
                - iso: GB
                  iso3: GBR
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: ABE
                    name: Aberdeen City
                  - abbr: ABD
                    name: Aberdeenshire
                  - abbr: ANS
                    name: Angus
                  - abbr: ANN
                    name: Antrim and Newtownabbey
                  - abbr: AND
                    name: Ards and North Down
                  - abbr: AGB
                    name: Argyll and Bute
                  - abbr: ABC
                    name: Armagh City, Banbridge and Craigavon
                  - abbr: BDG
                    name: Barking and Dagenham
                  - abbr: BNE
                    name: Barnet
                  - abbr: BNS
                    name: Barnsley
                  - abbr: BAS
                    name: Bath and North East Somerset
                  - abbr: BDF
                    name: Bedfordshire
                  - abbr: BFS
                    name: Belfast
                  - abbr: BEX
                    name: Bexley
                  - abbr: BIR
                    name: Birmingham
                  - abbr: BBD
                    name: Blackburn with Darwen
                  - abbr: BPL
                    name: Blackpool
                  - abbr: BGW
                    name: Blaenau Gwent
                  - abbr: BOL
                    name: Bolton
                  - abbr: BCP
                    name: Bournemouth, Christchurch and Poole
                  - abbr: BRC
                    name: Bracknell Forest
                  - abbr: BRD
                    name: Bradford
                  - abbr: BEN
                    name: Brent
                  - abbr: BGE
                    name: Bridgend [Pen-y-bont ar Ogwr GB-POG]
                  - abbr: BNH
                    name: Brighton and Hove
                  - abbr: BST
                    name: Bristol, City of
                  - abbr: BRY
                    name: Bromley
                  - abbr: BKM
                    name: Buckinghamshire
                  - abbr: BUR
                    name: Bury
                  - abbr: CAY
                    name: Caerphilly [Caerffili GB-CAF]
                  - abbr: CLD
                    name: Calderdale
                  - abbr: CAM
                    name: Cambridgeshire
                  - abbr: CMD
                    name: Camden
                  - abbr: CRF
                    name: Cardiff [Caerdydd GB-CRD]
                  - abbr: CMN
                    name: Carmarthenshire [Sir Gaerfyrddin GB-GFY]
                  - abbr: CCG
                    name: Causeway Coast and Glens
                  - abbr: CBF
                    name: Central Bedfordshire
                  - abbr: CGN
                    name: Ceredigion [Sir Ceredigion]
                  - abbr: CHE
                    name: Cheshire East
                  - abbr: CHW
                    name: Cheshire West and Chester
                  - abbr: CLK
                    name: Clackmannanshire
                  - abbr: CWY
                    name: Conwy
                  - abbr: CON
                    name: Cornwall
                  - abbr: COV
                    name: Coventry
                  - abbr: CRY
                    name: Croydon
                  - abbr: CMA
                    name: Cumbria
                  - abbr: DAL
                    name: Darlington
                  - abbr: DEN
                    name: Denbighshire [Sir Ddinbych GB-DDB]
                  - abbr: DER
                    name: Derby
                  - abbr: DBY
                    name: Derbyshire
                  - abbr: DRS
                    name: Derry and Strabane
                  - abbr: DEV
                    name: Devon
                  - abbr: DNC
                    name: Doncaster
                  - abbr: DOR
                    name: Dorset
                  - abbr: DUD
                    name: Dudley
                  - abbr: DGY
                    name: Dumfries and Galloway
                  - abbr: DND
                    name: Dundee City
                  - abbr: DUR
                    name: Durham
                  - abbr: EAL
                    name: Ealing
                  - abbr: EAY
                    name: East Ayrshire
                  - abbr: EDU
                    name: East Dunbartonshire
                  - abbr: ELN
                    name: East Lothian
                  - abbr: ERW
                    name: East Renfrewshire
                  - abbr: ERY
                    name: East Riding of Yorkshire
                  - abbr: ESX
                    name: East Sussex
                  - abbr: EDH
                    name: Edinburgh, City of
                  - abbr: ELS
                    name: Eilean Siar
                  - abbr: ENF
                    name: Enfield
                  - abbr: ENG
                    name: England
                  - abbr: ESS
                    name: Essex
                  - abbr: FAL
                    name: Falkirk
                  - abbr: FMO
                    name: Fermanagh and Omagh
                  - abbr: FIF
                    name: Fife
                  - abbr: FLN
                    name: Flintshire [Sir y Fflint GB-FFL]
                  - abbr: GAT
                    name: Gateshead
                  - abbr: GLG
                    name: Glasgow City
                  - abbr: GLS
                    name: Gloucestershire
                  - abbr: GRE
                    name: Greenwich
                  - abbr: GWN
                    name: Gwynedd
                  - abbr: HCK
                    name: Hackney
                  - abbr: HAL
                    name: Halton
                  - abbr: HMF
                    name: Hammersmith and Fulham
                  - abbr: HAM
                    name: Hampshire
                  - abbr: HRY
                    name: Haringey
                  - abbr: HRW
                    name: Harrow
                  - abbr: HPL
                    name: Hartlepool
                  - abbr: HAV
                    name: Havering
                  - abbr: HEF
                    name: Herefordshire, County of
                  - abbr: HRT
                    name: Hertfordshire
                  - abbr: HLD
                    name: Highland
                  - abbr: HIL
                    name: Hillingdon
                  - abbr: HNS
                    name: Hounslow
                  - abbr: IVC
                    name: Inverclyde
                  - abbr: AGY
                    name: Isle of Anglesey [Sir Ynys Môn GB-YNM]
                  - abbr: IOW
                    name: Isle of Wight
                  - abbr: IOS
                    name: Isles of Scilly
                  - abbr: ISL
                    name: Islington
                  - abbr: KEC
                    name: Kensington and Chelsea
                  - abbr: KEN
                    name: Kent
                  - abbr: KHL
                    name: Kingston upon Hull, City of
                  - abbr: KTT
                    name: Kingston upon Thames
                  - abbr: KIR
                    name: Kirklees
                  - abbr: KWL
                    name: Knowsley
                  - abbr: LBH
                    name: Lambeth
                  - abbr: LAN
                    name: Lancashire
                  - abbr: LDS
                    name: Leeds
                  - abbr: LCE
                    name: Leicester
                  - abbr: LEC
                    name: Leicestershire
                  - abbr: LEW
                    name: Lewisham
                  - abbr: LIN
                    name: Lincolnshire
                  - abbr: LBC
                    name: Lisburn and Castlereagh
                  - abbr: LIV
                    name: Liverpool
                  - abbr: LND
                    name: London, City of
                  - abbr: LUT
                    name: Luton
                  - abbr: MAN
                    name: Manchester
                  - abbr: MDW
                    name: Medway
                  - abbr: MTY
                    name: Merthyr Tydfil [Merthyr Tudful GB-MTU]
                  - abbr: MRT
                    name: Merton
                  - abbr: MUL
                    name: Mid Ulster
                  - abbr: MEA
                    name: Mid and East Antrim
                  - abbr: MDB
                    name: Middlesbrough
                  - abbr: MLN
                    name: Midlothian
                  - abbr: MIK
                    name: Milton Keynes
                  - abbr: MON
                    name: Monmouthshire [Sir Fynwy GB-FYN]
                  - abbr: MRY
                    name: Moray
                  - abbr: NTL
                    name: Neath Port Talbot [Castell-nedd Port Talbot GB-CTL]
                  - abbr: NET
                    name: Newcastle upon Tyne
                  - abbr: NWM
                    name: Newham
                  - abbr: NWP
                    name: Newport [Casnewydd GB-CNW]
                  - abbr: NMD
                    name: Newry, Mourne and Down
                  - abbr: NFK
                    name: Norfolk
                  - abbr: NAY
                    name: North Ayrshire
                  - abbr: NEL
                    name: North East Lincolnshire
                  - abbr: NLK
                    name: North Lanarkshire
                  - abbr: NLN
                    name: North Lincolnshire
                  - abbr: NSM
                    name: North Somerset
                  - abbr: NTY
                    name: North Tyneside
                  - abbr: NYK
                    name: North Yorkshire
                  - abbr: NTH
                    name: Northamptonshire
                  - abbr: NIR
                    name: Northern Ireland
                  - abbr: NBL
                    name: Northumberland
                  - abbr: NGM
                    name: Nottingham
                  - abbr: NTT
                    name: Nottinghamshire
                  - abbr: OLD
                    name: Oldham
                  - abbr: ORK
                    name: Orkney Islands
                  - abbr: OXF
                    name: Oxfordshire
                  - abbr: PEM
                    name: Pembrokeshire [Sir Benfro GB-BNF]
                  - abbr: PKN
                    name: Perth and Kinross
                  - abbr: PTE
                    name: Peterborough
                  - abbr: PLY
                    name: Plymouth
                  - abbr: POR
                    name: Portsmouth
                  - abbr: POW
                    name: Powys
                  - abbr: RDG
                    name: Reading
                  - abbr: RDB
                    name: Redbridge
                  - abbr: RCC
                    name: Redcar and Cleveland
                  - abbr: RFW
                    name: Renfrewshire
                  - abbr: RCT
                    name: Rhondda, Cynon, Taff [Rhondda, Cynon,Taf]
                  - abbr: RIC
                    name: Richmond upon Thames
                  - abbr: RCH
                    name: Rochdale
                  - abbr: ROT
                    name: Rotherham
                  - abbr: RUT
                    name: Rutland
                  - abbr: SLF
                    name: Salford
                  - abbr: SAW
                    name: Sandwell
                  - abbr: SCT
                    name: Scotland
                  - abbr: SCB
                    name: Scottish Borders, The
                  - abbr: SFT
                    name: Sefton
                  - abbr: SHF
                    name: Sheffield
                  - abbr: ZET
                    name: Shetland Islands
                  - abbr: SHR
                    name: Shropshire
                  - abbr: SLG
                    name: Slough
                  - abbr: SOL
                    name: Solihull
                  - abbr: SOM
                    name: Somerset
                  - abbr: SAY
                    name: South Ayrshire
                  - abbr: SGC
                    name: South Gloucestershire
                  - abbr: SLK
                    name: South Lanarkshire
                  - abbr: STY
                    name: South Tyneside
                  - abbr: STH
                    name: Southampton
                  - abbr: SOS
                    name: Southend-on-Sea
                  - abbr: SWK
                    name: Southwark
                  - abbr: SHN
                    name: St. Helens
                  - abbr: STS
                    name: Staffordshire
                  - abbr: STG
                    name: Stirling
                  - abbr: SKP
                    name: Stockport
                  - abbr: STT
                    name: Stockton-on-Tees
                  - abbr: STE
                    name: Stoke-on-Trent
                  - abbr: SFK
                    name: Suffolk
                  - abbr: SND
                    name: Sunderland
                  - abbr: SRY
                    name: Surrey
                  - abbr: STN
                    name: Sutton
                  - abbr: SWA
                    name: Swansea [Abertawe GB-ATA]
                  - abbr: SWD
                    name: Swindon
                  - abbr: TAM
                    name: Tameside
                  - abbr: TFW
                    name: Telford and Wrekin
                  - abbr: THR
                    name: Thurrock
                  - abbr: TOB
                    name: Torbay
                  - abbr: TOF
                    name: Torfaen [Tor-faen]
                  - abbr: TWH
                    name: Tower Hamlets
                  - abbr: TRF
                    name: Trafford
                  - abbr: VGL
                    name: Vale of Glamorgan, The [Bro Morgannwg GB-BMG]
                  - abbr: WKF
                    name: Wakefield
                  - abbr: WLS
                    name: Wales
                  - abbr: WLL
                    name: Walsall
                  - abbr: WFT
                    name: Waltham Forest
                  - abbr: WND
                    name: Wandsworth
                  - abbr: WRT
                    name: Warrington
                  - abbr: WAR
                    name: Warwickshire
                  - abbr: WBK
                    name: West Berkshire
                  - abbr: WDU
                    name: West Dunbartonshire
                  - abbr: WLN
                    name: West Lothian
                  - abbr: WSX
                    name: West Sussex
                  - abbr: WSM
                    name: Westminster
                  - abbr: WGN
                    name: Wigan
                  - abbr: WIL
                    name: Wiltshire
                  - abbr: WNM
                    name: Windsor and Maidenhead
                  - abbr: WRL
                    name: Wirral
                  - abbr: WOK
                    name: Wokingham
                  - abbr: WLV
                    name: Wolverhampton
                  - abbr: WOR
                    name: Worcestershire
                  - abbr: WRX
                    name: Wrexham [Wrecsam GB-WRC]
                  - abbr: YOR
                    name: York
                - iso: GD
                  iso3: GRD
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: '01'
                    name: Saint Andrew
                  - abbr: '02'
                    name: Saint David
                  - abbr: '03'
                    name: Saint George
                  - abbr: '04'
                    name: Saint John
                  - abbr: '05'
                    name: Saint Mark
                  - abbr: '06'
                    name: Saint Patrick
                  - abbr: '10'
                    name: Southern Grenadine Islands
                - iso: GE
                  iso3: GEO
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AB
                    name: Abkhazia
                  - abbr: AJ
                    name: Ajaria
                  - abbr: GU
                    name: Guria
                  - abbr: IM
                    name: Imereti
                  - abbr: KA
                    name: Kakheti
                  - abbr: KK
                    name: Kvemo Kartli
                  - abbr: MM
                    name: Mtskheta-Mtianeti
                  - abbr: RL
                    name: Racha-Lechkhumi [and] Kvemo Svaneti
                  - abbr: SZ
                    name: Samegrelo-Zemo Svaneti
                  - abbr: SJ
                    name: Samtskhe-Javakheti
                  - abbr: SK
                    name: Shida Kartli
                  - abbr: TB
                    name: Tbilisi
                - iso: GF
                  iso3: GUF
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: GG
                  iso3: GGY
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: GH
                  iso3: GHA
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: AF
                    name: Ahafo
                  - abbr: AH
                    name: Ashanti
                  - abbr: BO
                    name: Bono
                  - abbr: BE
                    name: Bono East
                  - abbr: CP
                    name: Central
                  - abbr: EP
                    name: Eastern
                  - abbr: AA
                    name: Greater Accra
                  - abbr: NE
                    name: North East
                  - abbr: NP
                    name: Northern
                  - abbr: OT
                    name: Oti
                  - abbr: SV
                    name: Savannah
                  - abbr: UE
                    name: Upper East
                  - abbr: UW
                    name: Upper West
                  - abbr: TV
                    name: Volta
                  - abbr: WP
                    name: Western
                  - abbr: WN
                    name: Western North
                - iso: GI
                  iso3: GIB
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: GL
                  iso3: GRL
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AV
                    name: Avannaata Kommunia
                  - abbr: QT
                    name: Kommune Qeqertalik
                  - abbr: KU
                    name: Kujalleq
                  - abbr: QE
                    name: Qeqqata
                  - abbr: SM
                    name: Sermersooq
                - iso: GM
                  iso3: GMB
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: B
                    name: Banjul
                  - abbr: L
                    name: Lower River
                  - abbr: M
                    name: MacCarthy Island
                  - abbr: "N"
                    name: North Bank
                  - abbr: U
                    name: Upper River
                  - abbr: W
                    name: Western
                - iso: GN
                  iso3: GIN
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: BE
                    name: Beyla
                  - abbr: BF
                    name: Boffa
                  - abbr: BK
                    name: Boké
                  - abbr: C
                    name: Conakry
                  - abbr: CO
                    name: Coyah
                  - abbr: DB
                    name: Dabola
                  - abbr: DL
                    name: Dalaba
                  - abbr: DI
                    name: Dinguiraye
                  - abbr: DU
                    name: Dubréka
                  - abbr: FA
                    name: Faranah
                  - abbr: FO
                    name: Forécariah
                  - abbr: FR
                    name: Fria
                  - abbr: GA
                    name: Gaoual
                  - abbr: GU
                    name: Guékédou
                  - abbr: KA
                    name: Kankan
                  - abbr: KD
                    name: Kindia
                  - abbr: KS
                    name: Kissidougou
                  - abbr: KB
                    name: Koubia
                  - abbr: KN
                    name: Koundara
                  - abbr: KO
                    name: Kouroussa
                  - abbr: KE
                    name: Kérouané
                  - abbr: LA
                    name: Labé
                  - abbr: LO
                    name: Lola
                  - abbr: LE
                    name: Lélouma
                  - abbr: MC
                    name: Macenta
                  - abbr: ML
                    name: Mali
                  - abbr: MM
                    name: Mamou
                  - abbr: MD
                    name: Mandiana
                  - abbr: NZ
                    name: Nzérékoré
                  - abbr: PI
                    name: Pita
                  - abbr: B
                    name: Région de Boké
                  - abbr: F
                    name: Région de Faranah
                  - abbr: K
                    name: Région de Kankan
                  - abbr: D
                    name: Région de Kindia
                  - abbr: L
                    name: Région de Labé
                  - abbr: M
                    name: Région de Mamou
                  - abbr: "N"
                    name: Région de Nzérékoré
                  - abbr: SI
                    name: Siguiri
                  - abbr: TO
                    name: Tougué
                  - abbr: TE
                    name: Télimélé
                  - abbr: YO
                    name: Yomou
                - iso: GP
                  iso3: GLP
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: GQ
                  iso3: GNQ
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: AN
                    name: Annobón
                  - abbr: BN
                    name: Bioko Norte
                  - abbr: BS
                    name: Bioko Sur
                  - abbr: CS
                    name: Centro Sur
                  - abbr: DJ
                    name: Djibloho
                  - abbr: KN
                    name: Kie-Ntem
                  - abbr: LI
                    name: Litoral
                  - abbr: C
                    name: Región Continental
                  - abbr: I
                    name: Región Insular
                  - abbr: WN
                    name: Wele-Nzás
                - iso: GR
                  iso3: GRC
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: A
                    name: Anatolikí Makedonía kai Thráki
                  - abbr: I
                    name: Attikí
                  - abbr: G
                    name: Dytikí Elláda
                  - abbr: C
                    name: Dytikí Makedonía
                  - abbr: F
                    name: Ionía Nísia
                  - abbr: B
                    name: Kentrikí Makedonía
                  - abbr: M
                    name: Kríti
                  - abbr: L
                    name: Nótio Aigaío
                  - abbr: J
                    name: Pelopónnisos
                  - abbr: H
                    name: Stereá Elláda
                  - abbr: E
                    name: Thessalía
                  - abbr: K
                    name: Vóreio Aigaío
                  - abbr: '69'
                    name: Ágion Óros
                  - abbr: D
                    name: Ípeiros
                - iso: GT
                  iso3: GTM
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '16'
                    name: Alta Verapaz
                  - abbr: '15'
                    name: Baja Verapaz
                  - abbr: '04'
                    name: Chimaltenango
                  - abbr: '20'
                    name: Chiquimula
                  - abbr: '02'
                    name: El Progreso
                  - abbr: '05'
                    name: Escuintla
                  - abbr: '01'
                    name: Guatemala
                  - abbr: '13'
                    name: Huehuetenango
                  - abbr: '18'
                    name: Izabal
                  - abbr: '21'
                    name: Jalapa
                  - abbr: '22'
                    name: Jutiapa
                  - abbr: '17'
                    name: Petén
                  - abbr: '09'
                    name: Quetzaltenango
                  - abbr: '14'
                    name: Quiché
                  - abbr: '11'
                    name: Retalhuleu
                  - abbr: '03'
                    name: Sacatepéquez
                  - abbr: '12'
                    name: San Marcos
                  - abbr: '06'
                    name: Santa Rosa
                  - abbr: '07'
                    name: Sololá
                  - abbr: '10'
                    name: Suchitepéquez
                  - abbr: '08'
                    name: Totonicapán
                  - abbr: '19'
                    name: Zacapa
                - iso: GU
                  iso3: GUM
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: GW
                  iso3: GNB
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: BA
                    name: Bafatá
                  - abbr: BM
                    name: Biombo
                  - abbr: BS
                    name: Bissau
                  - abbr: BL
                    name: Bolama
                  - abbr: CA
                    name: Cacheu
                  - abbr: GA
                    name: Gabú
                  - abbr: L
                    name: Leste
                  - abbr: "N"
                    name: Norte
                  - abbr: OI
                    name: Oio
                  - abbr: QU
                    name: Quinara
                  - abbr: S
                    name: Sul
                  - abbr: TO
                    name: Tombali
                - iso: GY
                  iso3: GUY
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: BA
                    name: Barima-Waini
                  - abbr: CU
                    name: Cuyuni-Mazaruni
                  - abbr: DE
                    name: Demerara-Mahaica
                  - abbr: EB
                    name: East Berbice-Corentyne
                  - abbr: ES
                    name: Essequibo Islands-West Demerara
                  - abbr: MA
                    name: Mahaica-Berbice
                  - abbr: PM
                    name: Pomeroon-Supenaam
                  - abbr: PT
                    name: Potaro-Siparuni
                  - abbr: UD
                    name: Upper Demerara-Berbice
                  - abbr: UT
                    name: Upper Takutu-Upper Essequibo
                - iso: HK
                  iso3: HKG
                  states_required: true
                  zipcode_required: false
                  states: []
                - iso: HN
                  iso3: HND
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AT
                    name: Atlántida
                  - abbr: CH
                    name: Choluteca
                  - abbr: CL
                    name: Colón
                  - abbr: CM
                    name: Comayagua
                  - abbr: CP
                    name: Copán
                  - abbr: CR
                    name: Cortés
                  - abbr: EP
                    name: El Paraíso
                  - abbr: FM
                    name: Francisco Morazán
                  - abbr: GD
                    name: Gracias a Dios
                  - abbr: IN
                    name: Intibucá
                  - abbr: IB
                    name: Islas de la Bahía
                  - abbr: LP
                    name: La Paz
                  - abbr: LE
                    name: Lempira
                  - abbr: OC
                    name: Ocotepeque
                  - abbr: OL
                    name: Olancho
                  - abbr: SB
                    name: Santa Bárbara
                  - abbr: VA
                    name: Valle
                  - abbr: YO
                    name: Yoro
                - iso: HR
                  iso3: HRV
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '07'
                    name: Bjelovarsko-bilogorska županija
                  - abbr: '12'
                    name: Brodsko-posavska županija
                  - abbr: '19'
                    name: Dubrovačko-neretvanska županija
                  - abbr: '21'
                    name: Grad Zagreb
                  - abbr: '18'
                    name: Istarska županija
                  - abbr: '04'
                    name: Karlovačka županija
                  - abbr: '06'
                    name: Koprivničko-križevačka županija
                  - abbr: '02'
                    name: Krapinsko-zagorska županija
                  - abbr: '09'
                    name: Ličko-senjska županija
                  - abbr: '20'
                    name: Međimurska županija
                  - abbr: '14'
                    name: Osječko-baranjska županija
                  - abbr: '11'
                    name: Požeško-slavonska županija
                  - abbr: '08'
                    name: Primorsko-goranska županija
                  - abbr: '03'
                    name: Sisačko-moslavačka županija
                  - abbr: '17'
                    name: Splitsko-dalmatinska županija
                  - abbr: '05'
                    name: Varaždinska županija
                  - abbr: '10'
                    name: Virovitičko-podravska županija
                  - abbr: '16'
                    name: Vukovarsko-srijemska županija
                  - abbr: '13'
                    name: Zadarska županija
                  - abbr: '01'
                    name: Zagrebačka županija
                  - abbr: '15'
                    name: Šibensko-kninska županija
                - iso: HT
                  iso3: HTI
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AR
                    name: Artibonite
                  - abbr: CE
                    name: Centre
                  - abbr: GA
                    name: Grande-Anse
                  - abbr: NI
                    name: Nippes
                  - abbr: ND
                    name: Nord
                  - abbr: NE
                    name: Nord-Est
                  - abbr: 'NO'
                    name: Nord-Ouest
                  - abbr: OU
                    name: Ouest
                  - abbr: SD
                    name: Sud
                  - abbr: SE
                    name: Sud-Est
                - iso: HU
                  iso3: HUN
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: BA
                    name: Baranya
                  - abbr: BZ
                    name: Borsod-Abaúj-Zemplén
                  - abbr: BU
                    name: Budapest
                  - abbr: BK
                    name: Bács-Kiskun
                  - abbr: BE
                    name: Békés
                  - abbr: BC
                    name: Békéscsaba
                  - abbr: CS
                    name: Csongrád
                  - abbr: DE
                    name: Debrecen
                  - abbr: DU
                    name: Dunaújváros
                  - abbr: EG
                    name: Eger
                  - abbr: FE
                    name: Fejér
                  - abbr: GY
                    name: Győr
                  - abbr: GS
                    name: Győr-Moson-Sopron
                  - abbr: HB
                    name: Hajdú-Bihar
                  - abbr: HE
                    name: Heves
                  - abbr: HV
                    name: Hódmezővásárhely
                  - abbr: JN
                    name: Jász-Nagykun-Szolnok
                  - abbr: KV
                    name: Kaposvár
                  - abbr: KM
                    name: Kecskemét
                  - abbr: KE
                    name: Komárom-Esztergom
                  - abbr: MI
                    name: Miskolc
                  - abbr: NK
                    name: Nagykanizsa
                  - abbr: NY
                    name: Nyíregyháza
                  - abbr: 'NO'
                    name: Nógrád
                  - abbr: PE
                    name: Pest
                  - abbr: PS
                    name: Pécs
                  - abbr: ST
                    name: Salgótarján
                  - abbr: SO
                    name: Somogy
                  - abbr: SN
                    name: Sopron
                  - abbr: SZ
                    name: Szabolcs-Szatmár-Bereg
                  - abbr: SD
                    name: Szeged
                  - abbr: SS
                    name: Szekszárd
                  - abbr: SK
                    name: Szolnok
                  - abbr: SH
                    name: Szombathely
                  - abbr: SF
                    name: Székesfehérvár
                  - abbr: TB
                    name: Tatabánya
                  - abbr: TO
                    name: Tolna
                  - abbr: VA
                    name: Vas
                  - abbr: VE
                    name: Veszprém
                  - abbr: VM
                    name: Veszprém
                  - abbr: ZA
                    name: Zala
                  - abbr: ZE
                    name: Zalaegerszeg
                  - abbr: ER
                    name: Érd
                - iso: ID
                  iso3: IDN
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AC
                    name: Aceh
                  - abbr: BA
                    name: Bali
                  - abbr: BT
                    name: Banten
                  - abbr: BE
                    name: Bengkulu
                  - abbr: JK
                    name: Daerah Khusus Ibukota Jakarta
                  - abbr: GO
                    name: Gorontalo
                  - abbr: JA
                    name: Jambi
                  - abbr: JW
                    name: Jawa
                  - abbr: JB
                    name: Jawa Barat
                  - abbr: JT
                    name: Jawa Tengah
                  - abbr: JI
                    name: Jawa Timur
                  - abbr: KA
                    name: Kalimantan
                  - abbr: KB
                    name: Kalimantan Barat
                  - abbr: KS
                    name: Kalimantan Selatan
                  - abbr: KT
                    name: Kalimantan Tengah
                  - abbr: KI
                    name: Kalimantan Timur
                  - abbr: KU
                    name: Kalimantan Utara
                  - abbr: BB
                    name: Kepulauan Bangka Belitung
                  - abbr: ML
                    name: Kepulauan Maluku
                  - abbr: NU
                    name: Kepulauan Nusa Tenggara
                  - abbr: KR
                    name: Kepulauan Riau
                  - abbr: LA
                    name: Lampung
                  - abbr: MA
                    name: Maluku
                  - abbr: MU
                    name: Maluku Utara
                  - abbr: NB
                    name: Nusa Tenggara Barat
                  - abbr: NT
                    name: Nusa Tenggara Timur
                  - abbr: PA
                    name: Papua
                  - abbr: PB
                    name: Papua Barat
                  - abbr: PP
                    name: Papua bagian barat
                  - abbr: RI
                    name: Riau
                  - abbr: SL
                    name: Sulawesi
                  - abbr: SR
                    name: Sulawesi Barat
                  - abbr: SN
                    name: Sulawesi Selatan
                  - abbr: ST
                    name: Sulawesi Tengah
                  - abbr: SG
                    name: Sulawesi Tenggara
                  - abbr: SA
                    name: Sulawesi Utara
                  - abbr: SM
                    name: Sumatera
                  - abbr: SB
                    name: Sumatera Barat
                  - abbr: SS
                    name: Sumatera Selatan
                  - abbr: SU
                    name: Sumatera Utara
                  - abbr: YO
                    name: Yogyakarta
                - iso: IE
                  iso3: IRL
                  states_required: true
                  zipcode_required: false
                  states:
                  - abbr: CW
                    name: Carlow
                  - abbr: CN
                    name: Cavan
                  - abbr: CE
                    name: Clare
                  - abbr: C
                    name: Connacht
                  - abbr: CO
                    name: Cork
                  - abbr: DL
                    name: Donegal
                  - abbr: D
                    name: Dublin
                  - abbr: G
                    name: Galway
                  - abbr: KY
                    name: Kerry
                  - abbr: KE
                    name: Kildare
                  - abbr: KK
                    name: Kilkenny
                  - abbr: LS
                    name: Laois
                  - abbr: L
                    name: Leinster
                  - abbr: LM
                    name: Leitrim
                  - abbr: LK
                    name: Limerick
                  - abbr: LD
                    name: Longford
                  - abbr: LH
                    name: Louth
                  - abbr: MO
                    name: Mayo
                  - abbr: MH
                    name: Meath
                  - abbr: MN
                    name: Monaghan
                  - abbr: M
                    name: Munster
                  - abbr: OY
                    name: Offaly
                  - abbr: RN
                    name: Roscommon
                  - abbr: SO
                    name: Sligo
                  - abbr: TA
                    name: Tipperary
                  - abbr: U
                    name: Ulster
                  - abbr: WD
                    name: Waterford
                  - abbr: WH
                    name: Westmeath
                  - abbr: WX
                    name: Wexford
                  - abbr: WW
                    name: Wicklow
                - iso: IL
                  iso3: ISR
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: D
                    name: HaDarom
                  - abbr: M
                    name: HaMerkaz
                  - abbr: Z
                    name: HaZafon
                  - abbr: HA
                    name: Haifa
                  - abbr: TA
                    name: Tel-Aviv
                  - abbr: JM
                    name: Yerushalayim
                - iso: IM
                  iso3: IMN
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: IN
                  iso3: IND
                  states_required: true
                  zipcode_required: true
                  states:
                  - abbr: AN
                    name: Andaman and Nicobar Islands
                  - abbr: AP
                    name: Andhra Pradesh
                  - abbr: AR
                    name: Arunachal Pradesh
                  - abbr: AS
                    name: Assam
                  - abbr: BR
                    name: Bihar
                  - abbr: CH
                    name: Chandigarh
                  - abbr: CG
                    name: Chhattisgarh
                  - abbr: DL
                    name: Delhi
                  - abbr: DH
                    name: Dādra and Nagar Haveli and Damān and Diu
                  - abbr: GA
                    name: Goa
                  - abbr: GJ
                    name: Gujarat
                  - abbr: HR
                    name: Haryana
                  - abbr: HP
                    name: Himachal Pradesh
                  - abbr: JK
                    name: Jammu and Kashmir
                  - abbr: JH
                    name: Jharkhand
                  - abbr: KA
                    name: Karnataka
                  - abbr: KL
                    name: Kerala
                  - abbr: LA
                    name: Ladakh
                  - abbr: LD
                    name: Lakshadweep
                  - abbr: MP
                    name: Madhya Pradesh
                  - abbr: MH
                    name: Maharashtra
                  - abbr: MN
                    name: Manipur
                  - abbr: ML
                    name: Meghalaya
                  - abbr: MZ
                    name: Mizoram
                  - abbr: NL
                    name: Nagaland
                  - abbr: OD
                    name: Odisha
                  - abbr: PY
                    name: Pondicherry
                  - abbr: PB
                    name: Punjab
                  - abbr: RJ
                    name: Rajasthan
                  - abbr: SK
                    name: Sikkim
                  - abbr: TN
                    name: Tamil Nadu
                  - abbr: TR
                    name: Tripura
                  - abbr: UP
                    name: Uttar Pradesh
                  - abbr: WB
                    name: West Bengal
                  - abbr: UK
                    name: उत्तराखण्ड
                  - abbr: TS
                    name: तेलंगाना
                - iso: IQ
                  iso3: IRQ
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AN
                    name: Al Anbar
                  - abbr: BA
                    name: Al Basrah
                  - abbr: MU
                    name: Al Muthanná
                  - abbr: QA
                    name: Al Qadisiyah
                  - abbr: NA
                    name: An Najaf
                  - abbr: AR
                    name: Arbil
                  - abbr: SU
                    name: As Sulaymaniyah
                  - abbr: BB
                    name: Babil
                  - abbr: BG
                    name: Baghdad
                  - abbr: DA
                    name: Dahuk
                  - abbr: DQ
                    name: Dhi Qar
                  - abbr: DI
                    name: Diyalá
                  - abbr: KA
                    name: Karbala'
                  - abbr: MA
                    name: Maysan
                  - abbr: NI
                    name: Ninawá
                  - abbr: SD
                    name: Salah ad Din
                  - abbr: WA
                    name: Wasit
                  - abbr: KR
                    name: إقليم كردستان
                  - abbr: KI
                    name: كركوك
                - iso: IR
                  iso3: IRN
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '24'
                    name: Ardabil
                  - abbr: '04'
                    name: Az¯arbayjan-e Gharbi
                  - abbr: '03'
                    name: Az¯arbayjan-e Sharqi
                  - abbr: '18'
                    name: Bushehr
                  - abbr: '14'
                    name: Chahar Mah¸all va Bakhtiari
                  - abbr: '10'
                    name: Esfahan
                  - abbr: '07'
                    name: Fars
                  - abbr: '01'
                    name: Gilan
                  - abbr: '27'
                    name: Golestan
                  - abbr: '13'
                    name: Hamadan
                  - abbr: '22'
                    name: Hormozgan
                  - abbr: '16'
                    name: Ilam
                  - abbr: '08'
                    name: Kerman
                  - abbr: '05'
                    name: Kermanshah
                  - abbr: '29'
                    name: Khorasan-e Janubi
                  - abbr: '09'
                    name: Khorasan-e Razavi
                  - abbr: '28'
                    name: Khorasan-e Shemali
                  - abbr: '06'
                    name: Khuzestan
                  - abbr: '17'
                    name: Kohkiluyeh va Buyer Ahmad
                  - abbr: '12'
                    name: Kordestan
                  - abbr: '15'
                    name: Lorestan
                  - abbr: '00'
                    name: Markazi
                  - abbr: '02'
                    name: Mazandaran
                  - abbr: '26'
                    name: Qazvin
                  - abbr: '25'
                    name: Qom
                  - abbr: '20'
                    name: Semnan
                  - abbr: '11'
                    name: Sistan va Baluchestan
                  - abbr: '23'
                    name: Tehran
                  - abbr: '21'
                    name: Yazd
                  - abbr: '19'
                    name: Zanjan
                  - abbr: '30'
                    name: استان البرز
                - iso: IS
                  iso3: ISL
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AKH
                    name: Akrahreppur
                  - abbr: AKN
                    name: Akraneskaupstaður
                  - abbr: AKU
                    name: Akureyrarbær
                  - abbr: '7'
                    name: Austurland
                  - abbr: BLA
                    name: Bláskógabyggð
                  - abbr: BLO
                    name: Blönduósbær
                  - abbr: BOL
                    name: Bolungarvíkurkaupstaður
                  - abbr: BOG
                    name: Borgarbyggð
                  - abbr: DAB
                    name: Dalabyggð
                  - abbr: DAV
                    name: Dalvíkurbyggð
                  - abbr: EOM
                    name: Eyja- og Miklaholtshreppur
                  - abbr: EYF
                    name: Eyjafjarðarsveit
                  - abbr: FJL
                    name: Fjallabyggð
                  - abbr: FJD
                    name: Fjarðabyggð
                  - abbr: FLR
                    name: Fljótsdalshreppur
                  - abbr: FLA
                    name: Flóahreppur
                  - abbr: GAR
                    name: Garðabær
                  - abbr: GRN
                    name: Grindavíkurbær
                  - abbr: GRU
                    name: Grundarfjarðarbær
                  - abbr: GOG
                    name: Grímsnes- og Grafningshreppur
                  - abbr: GRY
                    name: Grýtubakkahreppur
                  - abbr: HAF
                    name: Hafnarfjarðarkaupstaður
                  - abbr: HEL
                    name: Helgafellssveit
                  - abbr: HRU
                    name: Hrunamannahreppur
                  - abbr: HVA
                    name: Hvalfjarðarsveit
                  - abbr: HVE
                    name: Hveragerðisbær
                  - abbr: '1'
                    name: Höfuðborgarsvæði utan Reykjavíkur
                  - abbr: HRG
                    name: Hörgársveit
                  - abbr: HUT
                    name: Húnavatnshreppur
                  - abbr: HUV
                    name: Húnaþing vestra
                  - abbr: KAL
                    name: Kaldrananeshreppur
                  - abbr: KJO
                    name: Kjósarhreppur
                  - abbr: KOP
                    name: Kópavogsbær
                  - abbr: LAN
                    name: Langanesbyggð
                  - abbr: MOS
                    name: Mosfellsbær
                  - abbr: MUL
                    name: Múlaþing
                  - abbr: MYR
                    name: Mýrdalshreppur
                  - abbr: '6'
                    name: Norðurland eystra
                  - abbr: '5'
                    name: Norðurland vestra
                  - abbr: NOR
                    name: Norðurþing
                  - abbr: RGE
                    name: Rangárþing eystra
                  - abbr: RGY
                    name: Rangárþing ytra
                  - abbr: RHH
                    name: Reykhólahreppur
                  - abbr: RKN
                    name: Reykjanesbær
                  - abbr: '0'
                    name: Reykjavík
                  - abbr: RKV
                    name: Reykjavíkurborg
                  - abbr: SEL
                    name: Seltjarnarnesbær
                  - abbr: SKF
                    name: Skaftárhreppur
                  - abbr: SKG
                    name: Skagabyggð
                  - abbr: SOG
                    name: Skeiða- og Gnúpverjahreppur
                  - abbr: SKO
                    name: Skorradalshreppur
                  - abbr: SKU
                    name: Skútustaðahreppur
                  - abbr: SNF
                    name: Snæfellsbær
                  - abbr: STR
                    name: Strandabyggð
                  - abbr: STY
                    name: Stykkishólmsbær
                  - abbr: '8'
                    name: Suðurland
                  - abbr: '2'
                    name: Suðurnes
                  - abbr: SDN
                    name: Suðurnesjabær
                  - abbr: SBH
                    name: Svalbarðshreppur
                  - abbr: SBT
                    name: Svalbarðsstrandarhreppur
                  - abbr: SHF
                    name: Sveitarfélagið Hornafjörður
                  - abbr: SSF
                    name: Sveitarfélagið Skagafjörður
                  - abbr: SSS
                    name: Sveitarfélagið Skagaströnd
                  - abbr: SVG
                    name: Sveitarfélagið Vogar
                  - abbr: SFA
                    name: Sveitarfélagið Árborg
                  - abbr: SOL
                    name: Sveitarfélagið Ölfus
                  - abbr: SDV
                    name: Súðavíkurhreppur
                  - abbr: TJO
                    name: Tjörneshreppur
                  - abbr: TAL
                    name: Tálknafjarðarhreppur
                  - abbr: '4'
                    name: Vestfirðir
                  - abbr: VEM
                    name: Vestmannaeyjabær
                  - abbr: VER
                    name: Vesturbyggð
                  - abbr: '3'
                    name: Vesturland
                  - abbr: VOP
                    name: Vopnafjarðarhreppur
                  - abbr: ARN
                    name: Árneshreppur
                  - abbr: ASA
                    name: Ásahreppur
                  - abbr: ISA
                    name: Ísafjarðarbær
                  - abbr: THG
                    name: Þingeyjarsveit
                - iso: IT
                  iso3: ITA
                  states_required: true
                  zipcode_required: true
                  states:
                  - abbr: '65'
                    name: Abruzzo
                  - abbr: AG
                    name: Agrigento
                  - abbr: AL
                    name: Alessandria
                  - abbr: AN
                    name: Ancona
                  - abbr: AR
                    name: Arezzo
                  - abbr: AP
                    name: Ascoli Piceno
                  - abbr: AT
                    name: Asti
                  - abbr: AV
                    name: Avellino
                  - abbr: BA
                    name: Bari
                  - abbr: BT
                    name: Barletta-Andria-Trani
                  - abbr: '77'
                    name: Basilicata
                  - abbr: BL
                    name: Belluno
                  - abbr: BN
                    name: Benevento
                  - abbr: BG
                    name: Bergamo
                  - abbr: BI
                    name: Biella
                  - abbr: BO
                    name: Bologna
                  - abbr: BZ
                    name: Bolzano
                  - abbr: BS
                    name: Brescia
                  - abbr: BR
                    name: Brindisi
                  - abbr: CA
                    name: Cagliari
                  - abbr: '78'
                    name: Calabria
                  - abbr: CL
                    name: Caltanissetta
                  - abbr: '72'
                    name: Campania
                  - abbr: CB
                    name: Campobasso
                  - abbr: CI
                    name: Carbonia-Iglesias
                  - abbr: CE
                    name: Caserta
                  - abbr: CT
                    name: Catania
                  - abbr: CZ
                    name: Catanzaro
                  - abbr: CH
                    name: Chieti
                  - abbr: CO
                    name: Como
                  - abbr: CS
                    name: Cosenza
                  - abbr: CR
                    name: Cremona
                  - abbr: KR
                    name: Crotone
                  - abbr: CN
                    name: Cuneo
                  - abbr: '45'
                    name: Emilia-Romagna
                  - abbr: EN
                    name: Enna
                  - abbr: FM
                    name: Fermo
                  - abbr: FE
                    name: Ferrara
                  - abbr: FI
                    name: Firenze
                  - abbr: FG
                    name: Foggia
                  - abbr: FC
                    name: Forlì-Cesena
                  - abbr: '36'
                    name: Friuli Venezia Giulia
                  - abbr: FR
                    name: Frosinone
                  - abbr: GE
                    name: Genova
                  - abbr: GO
                    name: Gorizia
                  - abbr: GR
                    name: Grosseto
                  - abbr: IM
                    name: Imperia
                  - abbr: IS
                    name: Isernia
                  - abbr: AQ
                    name: L'Aquila
                  - abbr: SP
                    name: La Spezia
                  - abbr: LT
                    name: Latina
                  - abbr: '62'
                    name: Lazio
                  - abbr: LE
                    name: Lecce
                  - abbr: LC
                    name: Lecco
                  - abbr: '42'
                    name: Liguria
                  - abbr: LI
                    name: Livorno
                  - abbr: LO
                    name: Lodi
                  - abbr: '25'
                    name: Lombardia
                  - abbr: LU
                    name: Lucca
                  - abbr: MC
                    name: Macerata
                  - abbr: MN
                    name: Mantova
                  - abbr: '57'
                    name: Marche
                  - abbr: MS
                    name: Massa-Carrara
                  - abbr: MT
                    name: Matera
                  - abbr: VS
                    name: Medio Campidano
                  - abbr: ME
                    name: Messina
                  - abbr: MI
                    name: Milano
                  - abbr: MO
                    name: Modena
                  - abbr: '67'
                    name: Molise
                  - abbr: MB
                    name: Monza e Brianza
                  - abbr: NA
                    name: Napoli
                  - abbr: 'NO'
                    name: Novara
                  - abbr: NU
                    name: Nuoro
                  - abbr: OG
                    name: Ogliastra
                  - abbr: OT
                    name: Olbia-Tempio
                  - abbr: OR
                    name: Oristano
                  - abbr: PD
                    name: Padova
                  - abbr: PA
                    name: Palermo
                  - abbr: PR
                    name: Parma
                  - abbr: PV
                    name: Pavia
                  - abbr: PG
                    name: Perugia
                  - abbr: PU
                    name: Pesaro e Urbino
                  - abbr: PE
                    name: Pescara
                  - abbr: PC
                    name: Piacenza
                  - abbr: '21'
                    name: Piemonte
                  - abbr: PI
                    name: Pisa
                  - abbr: PT
                    name: Pistoia
                  - abbr: PN
                    name: Pordenone
                  - abbr: PZ
                    name: Potenza
                  - abbr: PO
                    name: Prato
                  - abbr: '75'
                    name: Puglia
                  - abbr: RG
                    name: Ragusa
                  - abbr: RA
                    name: Ravenna
                  - abbr: RC
                    name: Reggio Calabria
                  - abbr: RE
                    name: Reggio Emilia
                  - abbr: RI
                    name: Rieti
                  - abbr: RN
                    name: Rimini
                  - abbr: RM
                    name: Roma
                  - abbr: RO
                    name: Rovigo
                  - abbr: SA
                    name: Salerno
                  - abbr: '88'
                    name: Sardegna
                  - abbr: SS
                    name: Sassari
                  - abbr: SV
                    name: Savona
                  - abbr: '82'
                    name: Sicilia
                  - abbr: SI
                    name: Siena
                  - abbr: SR
                    name: Siracusa
                  - abbr: SO
                    name: Sondrio
                  - abbr: SU
                    name: Sud Sardegna
                  - abbr: TA
                    name: Taranto
                  - abbr: TE
                    name: Teramo
                  - abbr: TR
                    name: Terni
                  - abbr: TO
                    name: Torino
                  - abbr: '52'
                    name: Toscana
                  - abbr: TP
                    name: Trapani
                  - abbr: '32'
                    name: Trentino-Alto Adige
                  - abbr: TN
                    name: Trento
                  - abbr: TV
                    name: Treviso
                  - abbr: TS
                    name: Trieste
                  - abbr: UD
                    name: Udine
                  - abbr: '55'
                    name: Umbria
                  - abbr: '23'
                    name: Valle d'Aosta
                  - abbr: VA
                    name: Varese
                  - abbr: '34'
                    name: Veneto
                  - abbr: VE
                    name: Venezia
                  - abbr: VB
                    name: Verbano-Cusio-Ossola
                  - abbr: VC
                    name: Vercelli
                  - abbr: VR
                    name: Verona
                  - abbr: VV
                    name: Vibo Valentia
                  - abbr: VI
                    name: Vicenza
                  - abbr: VT
                    name: Viterbo
                - iso: JE
                  iso3: JEY
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: JM
                  iso3: JAM
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '13'
                    name: Clarendon
                  - abbr: '09'
                    name: Hanover
                  - abbr: '01'
                    name: Kingston
                  - abbr: '12'
                    name: Manchester
                  - abbr: '04'
                    name: Portland
                  - abbr: '02'
                    name: Saint Andrew
                  - abbr: '06'
                    name: Saint Ann
                  - abbr: '14'
                    name: Saint Catherine
                  - abbr: '11'
                    name: Saint Elizabeth
                  - abbr: '08'
                    name: Saint James
                  - abbr: '05'
                    name: Saint Mary
                  - abbr: '03'
                    name: Saint Thomas
                  - abbr: '07'
                    name: Trelawny
                  - abbr: '10'
                    name: Westmoreland
                - iso: JO
                  iso3: JOR
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AJ
                    name: Ajlun
                  - abbr: BA
                    name: Al Balqa'
                  - abbr: KA
                    name: Al Karak
                  - abbr: MA
                    name: Al Mafraq
                  - abbr: AM
                    name: Amman
                  - abbr: AQ
                    name: Aqaba
                  - abbr: AT
                    name: At Tafilah
                  - abbr: AZ
                    name: Az Zarqa'
                  - abbr: IR
                    name: Irbid
                  - abbr: JA
                    name: Jarash
                  - abbr: MN
                    name: Ma`an
                  - abbr: MD
                    name: Madaba
                - iso: JP
                  iso3: JPN
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '23'
                    name: Aichi
                  - abbr: '05'
                    name: Akita
                  - abbr: '02'
                    name: Aomori
                  - abbr: '12'
                    name: Chiba
                  - abbr: '38'
                    name: Ehime
                  - abbr: '18'
                    name: Fukui
                  - abbr: '40'
                    name: Fukuoka
                  - abbr: '07'
                    name: Fukushima
                  - abbr: '21'
                    name: Gifu
                  - abbr: '10'
                    name: Gunma
                  - abbr: '34'
                    name: Hiroshima
                  - abbr: '01'
                    name: Hokkaido
                  - abbr: '28'
                    name: Hyogo
                  - abbr: '08'
                    name: Ibaraki
                  - abbr: '17'
                    name: Ishikawa
                  - abbr: '03'
                    name: Iwate
                  - abbr: '37'
                    name: Kagawa
                  - abbr: '46'
                    name: Kagoshima
                  - abbr: '14'
                    name: Kanagawa
                  - abbr: '39'
                    name: Kochi
                  - abbr: '43'
                    name: Kumamoto
                  - abbr: '26'
                    name: Kyoto
                  - abbr: '24'
                    name: Mie
                  - abbr: '04'
                    name: Miyagi
                  - abbr: '45'
                    name: Miyazaki
                  - abbr: '20'
                    name: Nagano
                  - abbr: '42'
                    name: Nagasaki
                  - abbr: '29'
                    name: Nara
                  - abbr: '15'
                    name: Niigata
                  - abbr: '44'
                    name: Oita
                  - abbr: '33'
                    name: Okayama
                  - abbr: '47'
                    name: Okinawa
                  - abbr: '27'
                    name: Osaka
                  - abbr: '41'
                    name: Saga
                  - abbr: '11'
                    name: Saitama
                  - abbr: '25'
                    name: Shiga
                  - abbr: '32'
                    name: Shimane
                  - abbr: '22'
                    name: Shizuoka
                  - abbr: '09'
                    name: Tochigi
                  - abbr: '36'
                    name: Tokushima
                  - abbr: '13'
                    name: Tokyo
                  - abbr: '31'
                    name: Tottori
                  - abbr: '16'
                    name: Toyama
                  - abbr: '30'
                    name: Wakayama
                  - abbr: '06'
                    name: Yamagata
                  - abbr: '35'
                    name: Yamaguchi
                  - abbr: '19'
                    name: Yamanashi
                - iso: KE
                  iso3: KEN
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '01'
                    name: Baringo
                  - abbr: '02'
                    name: Bomet
                  - abbr: '03'
                    name: Bungoma
                  - abbr: '04'
                    name: Busia
                  - abbr: '05'
                    name: Elgeyo/Marakwet
                  - abbr: '06'
                    name: Embu
                  - abbr: '07'
                    name: Garissa
                  - abbr: '08'
                    name: Homa Bay
                  - abbr: '09'
                    name: Isiolo
                  - abbr: '10'
                    name: Kajiado
                  - abbr: '11'
                    name: Kakamega
                  - abbr: '12'
                    name: Kericho
                  - abbr: '13'
                    name: Kiambu
                  - abbr: '14'
                    name: Kilifi
                  - abbr: '15'
                    name: Kirinyaga
                  - abbr: '16'
                    name: Kisii
                  - abbr: '17'
                    name: Kisumu
                  - abbr: '18'
                    name: Kitui
                  - abbr: '19'
                    name: Kwale
                  - abbr: '20'
                    name: Laikipia
                  - abbr: '21'
                    name: Lamu
                  - abbr: '22'
                    name: Machakos
                  - abbr: '23'
                    name: Makueni
                  - abbr: '24'
                    name: Mandera
                  - abbr: '25'
                    name: Marsabit
                  - abbr: '26'
                    name: Meru
                  - abbr: '27'
                    name: Migori
                  - abbr: '28'
                    name: Mombasa
                  - abbr: '29'
                    name: Murang’a
                  - abbr: '30'
                    name: Nairobi City
                  - abbr: '31'
                    name: Nakuru
                  - abbr: '32'
                    name: Nandi
                  - abbr: '33'
                    name: Narok
                  - abbr: '34'
                    name: Nyamira
                  - abbr: '35'
                    name: Nyandarua
                  - abbr: '36'
                    name: Nyeri
                  - abbr: '37'
                    name: Samburu
                  - abbr: '38'
                    name: Siaya
                  - abbr: '39'
                    name: Taita-Taveta
                  - abbr: '40'
                    name: Tana River
                  - abbr: '41'
                    name: Tharaka-Nithi
                  - abbr: '42'
                    name: Trans-Nzoia
                  - abbr: '43'
                    name: Turkana
                  - abbr: '44'
                    name: Uasin Gishu
                  - abbr: '45'
                    name: Vihiga
                  - abbr: '46'
                    name: Wajir
                  - abbr: '47'
                    name: West Pokot
                - iso: KG
                  iso3: KGZ
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: B
                    name: Batken
                  - abbr: GB
                    name: Bishkek
                  - abbr: C
                    name: Chü
                  - abbr: J
                    name: Jalal-Abad
                  - abbr: "N"
                    name: Naryn
                  - abbr: O
                    name: Osh
                  - abbr: T
                    name: Talas
                  - abbr: "Y"
                    name: Ysyk-Köl
                  - abbr: GO
                    name: Ош
                - iso: KH
                  iso3: KHM
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '2'
                    name: Baat Dambang [Batdâmbâng]
                  - abbr: '1'
                    name: Banteay Mean Chey [Bântéay Méanchey]
                  - abbr: '3'
                    name: Kampong Chaam [Kâmpóng Cham]
                  - abbr: '4'
                    name: Kampong Chhnang [Kâmpóng Chhnang]
                  - abbr: '5'
                    name: Kampong Spueu [Kâmpóng Spœ]
                  - abbr: '6'
                    name: Kampong Thum [Kâmpóng Thum]
                  - abbr: '7'
                    name: Kampot [Kâmpôt]
                  - abbr: '8'
                    name: Kandaal [Kândal]
                  - abbr: '9'
                    name: Kaoh Kong [Kaôh Kong]
                  - abbr: '10'
                    name: Kracheh [Krâchéh]
                  - abbr: '23'
                    name: Krong Kep [Krong Kêb]
                  - abbr: '24'
                    name: Krong Pailin [Krong Pailin]
                  - abbr: '18'
                    name: Krong Preah Sihanouk [Krong Preah Sihanouk]
                  - abbr: '11'
                    name: Mondol Kiri [Môndól Kiri]
                  - abbr: '22'
                    name: 'Otdar Mean Chey [Otdâr Méanchey] '
                  - abbr: '12'
                    name: Phnom Penh [Phnum Pénh]
                  - abbr: '15'
                    name: Pousaat [Pouthisat]
                  - abbr: '13'
                    name: Preah Vihear [Preah Vihéar]
                  - abbr: '14'
                    name: Prey Veaeng [Prey Vêng]
                  - abbr: '16'
                    name: Rotanak Kiri [Rôtânôkiri]
                  - abbr: '17'
                    name: Siem Reab [Siemréab]
                  - abbr: '19'
                    name: Stueng Traeng
                  - abbr: '20'
                    name: Svaay Rieng [Svay Rieng]
                  - abbr: '21'
                    name: Taakaev [Takêv]
                  - abbr: '25'
                    name: Tbong Khmum
                - iso: KI
                  iso3: KIR
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: G
                    name: Gilbert Islands
                  - abbr: L
                    name: Line Islands
                  - abbr: P
                    name: Phoenix Islands
                - iso: KM
                  iso3: COM
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: A
                    name: Anjouan
                  - abbr: G
                    name: Grande Comore
                  - abbr: M
                    name: Mohéli
                - iso: KN
                  iso3: KNA
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: '01'
                    name: Christ Church Nichola Town
                  - abbr: "N"
                    name: Nevis
                  - abbr: '02'
                    name: Saint Anne Sandy Point
                  - abbr: '03'
                    name: Saint George Basseterre
                  - abbr: '04'
                    name: Saint George Gingerland
                  - abbr: '05'
                    name: Saint James Windward
                  - abbr: '06'
                    name: Saint John Capisterre
                  - abbr: '07'
                    name: Saint John Figtree
                  - abbr: K
                    name: Saint Kitts
                  - abbr: '08'
                    name: Saint Mary Cayon
                  - abbr: '09'
                    name: Saint Paul Capisterre
                  - abbr: '10'
                    name: Saint Paul Charlestown
                  - abbr: '11'
                    name: Saint Peter Basseterre
                  - abbr: '12'
                    name: Saint Thomas Lowland
                  - abbr: '13'
                    name: Saint Thomas Middle Island
                  - abbr: '15'
                    name: Trinity Palmetto Point
                - iso: KP
                  iso3: PRK
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: '07'
                    name: 강원도
                  - abbr: '14'
                    name: 남포특별시
                  - abbr: '13'
                    name: 라선특별시
                  - abbr: '10'
                    name: 량강도
                  - abbr: '04'
                    name: 자강도
                  - abbr: '02'
                    name: 평안남도
                  - abbr: '03'
                    name: 평안북도
                  - abbr: '01'
                    name: 평양직할시
                  - abbr: '08'
                    name: 함경남도
                  - abbr: '09'
                    name: 함경북도
                  - abbr: '05'
                    name: 황해남도
                  - abbr: '06'
                    name: 황해북도
                - iso: KR
                  iso3: KOR
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '26'
                    name: Busan Gwang'yeogsi [Pusan-Kwangyokshi]
                  - abbr: '43'
                    name: Chungcheongbugdo [Ch'ungch'ongbuk-do]
                  - abbr: '44'
                    name: Chungcheongnamdo [Ch'ungch'ongnam-do]
                  - abbr: '27'
                    name: Daegu Gwang'yeogsi [Taegu-Kwangyokshi]
                  - abbr: '30'
                    name: Daejeon Gwang'yeogsi [Taejon-Kwangyokshi]
                  - abbr: '42'
                    name: Gang'weondo [Kang-won-do]
                  - abbr: '29'
                    name: Gwangju Gwang'yeogsi [Kwangju-Kwangyokshi]
                  - abbr: '41'
                    name: Gyeonggido [Kyonggi-do]
                  - abbr: '47'
                    name: Gyeongsangbugdo [Kyongsangbuk-do]
                  - abbr: '48'
                    name: Gyeongsangnamdo [Kyongsangnam-do]
                  - abbr: '28'
                    name: Incheon Gwang'yeogsi [Inch'n-Kwangyokshi]
                  - abbr: '49'
                    name: Jejudo [Cheju-do]
                  - abbr: '45'
                    name: Jeonrabugdo[Chollabuk-do]
                  - abbr: '46'
                    name: Jeonranamdo [Chollanam-do]
                  - abbr: '11'
                    name: Seoul Teugbyeolsi [Seoul-T'ukpyolshi]
                  - abbr: '31'
                    name: Ulsan Gwang'yeogsi [Ulsan-Kwangyokshi]
                  - abbr: '50'
                    name: 세종특별자치시
                - iso: KW
                  iso3: KWT
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AH
                    name: Al Ahmadi
                  - abbr: FA
                    name: Al Farwaniyah
                  - abbr: JA
                    name: Al Jahrah
                  - abbr: KU
                    name: Al Kuwayt
                  - abbr: HA
                    name: Hawalli
                  - abbr: MU
                    name: Mubarak al-Kabir
                - iso: KY
                  iso3: CYM
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: KZ
                  iso3: KAZ
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: ALA
                    name: Almaty
                  - abbr: ALM
                    name: Almaty oblysy
                  - abbr: AKM
                    name: Aqmola oblysy
                  - abbr: AKT
                    name: Aqtöbe oblysy
                  - abbr: AST
                    name: Astana
                  - abbr: ATY
                    name: Atyrau oblysy
                  - abbr: ZAP
                    name: Batys Qazaqstan oblysy
                  - abbr: MAN
                    name: Mangghystau oblysy
                  - abbr: YUZ
                    name: Ongtüstik Qazaqstan oblysy
                  - abbr: PAV
                    name: Pavlodar oblysy
                  - abbr: KAR
                    name: Qaraghandy oblysy
                  - abbr: KUS
                    name: Qostanay oblysy
                  - abbr: KZY
                    name: Qyzylorda oblysy
                  - abbr: VOS
                    name: Shyghys Qazaqstan oblysy
                  - abbr: SHY
                    name: Shymkent
                  - abbr: SEV
                    name: Soltüstik Qazaqstan oblysy
                  - abbr: ZHA
                    name: Zhambyl oblysy
                - iso: LA
                  iso3: LAO
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AT
                    name: Attapu [Attopeu]
                  - abbr: BK
                    name: Bokèo
                  - abbr: BL
                    name: Bolikhamxai [Borikhane]
                  - abbr: CH
                    name: Champasak [Champassak]
                  - abbr: HO
                    name: Houaphan
                  - abbr: KH
                    name: Khammouan
                  - abbr: LM
                    name: Louang Namtha
                  - abbr: LP
                    name: Louangphabang [Louang Prabang]
                  - abbr: OU
                    name: Oudômxai [Oudomsai]
                  - abbr: PH
                    name: Phôngsali [Phong Saly]
                  - abbr: SL
                    name: Salavan [Saravane]
                  - abbr: SV
                    name: Savannakhét
                  - abbr: VI
                    name: Vientiane
                  - abbr: VT
                    name: Vientiane Prefecture
                  - abbr: XA
                    name: Xaignabouli [Sayaboury]
                  - abbr: XI
                    name: Xiangkhoang [Xieng Khouang]
                  - abbr: XE
                    name: Xékong [Sékong]
                  - abbr: XS
                    name: ແຂວງໄຊສົມບູນ
                - iso: LB
                  iso3: LBN
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: BA
                    name: Beirut
                  - abbr: BI
                    name: El Béqaa
                  - abbr: JL
                    name: Jabal Loubnâne
                  - abbr: AS
                    name: Loubnâne ech Chemâli
                  - abbr: JA
                    name: Loubnâne ej Jnoûbi
                  - abbr: NA
                    name: Nabatîyé
                  - abbr: BH
                    name: محافظة بعلبك الهرمل
                  - abbr: AK
                    name: محافظة عكار
                - iso: LC
                  iso3: LCA
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: '01'
                    name: Anse la Raye
                  - abbr: '12'
                    name: Canaries
                  - abbr: '02'
                    name: Castries
                  - abbr: '03'
                    name: Choiseul
                  - abbr: '05'
                    name: Dennery
                  - abbr: '06'
                    name: Gros Islet
                  - abbr: '07'
                    name: Laborie
                  - abbr: '08'
                    name: Micoud
                  - abbr: '10'
                    name: Soufrière
                  - abbr: '11'
                    name: Vieux Fort
                - iso: LI
                  iso3: LIE
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '01'
                    name: Balzers
                  - abbr: '02'
                    name: Eschen
                  - abbr: '03'
                    name: Gamprin
                  - abbr: '04'
                    name: Mauren
                  - abbr: '05'
                    name: Planken
                  - abbr: '06'
                    name: Ruggell
                  - abbr: '07'
                    name: Schaan
                  - abbr: '08'
                    name: Schellenberg
                  - abbr: '09'
                    name: Triesen
                  - abbr: '10'
                    name: Triesenberg
                  - abbr: '11'
                    name: Vaduz
                - iso: LK
                  iso3: LKA
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '52'
                    name: Ampara
                  - abbr: '71'
                    name: Anuradhapura
                  - abbr: '81'
                    name: Badulla
                  - abbr: '51'
                    name: Batticaloa
                  - abbr: '11'
                    name: Colombo
                  - abbr: '31'
                    name: Galle
                  - abbr: '12'
                    name: Gampaha
                  - abbr: '33'
                    name: Hambantota
                  - abbr: '41'
                    name: Jaffna
                  - abbr: '13'
                    name: Kalutara
                  - abbr: '21'
                    name: Kandy
                  - abbr: '92'
                    name: Kegalla
                  - abbr: '42'
                    name: Kilinochchi
                  - abbr: '61'
                    name: Kurunegala
                  - abbr: '43'
                    name: Mannar
                  - abbr: '22'
                    name: Matale
                  - abbr: '32'
                    name: Matara
                  - abbr: '82'
                    name: Monaragala
                  - abbr: '45'
                    name: Mullaittivu
                  - abbr: '23'
                    name: Nuwara Eliya
                  - abbr: '72'
                    name: Polonnaruwa
                  - abbr: '62'
                    name: Puttalam
                  - abbr: '91'
                    name: Ratnapura
                  - abbr: '53'
                    name: Trincomalee
                  - abbr: '44'
                    name: Vavuniya
                  - abbr: '4'
                    name: උතුරු පළාත
                  - abbr: '7'
                    name: උතුරු මැද පළාත
                  - abbr: '8'
                    name: ඌව පළාත
                  - abbr: '3'
                    name: දකුණු පළාත
                  - abbr: '5'
                    name: නැගෙනහිර පළාත, ශ් රී ලංකාව
                  - abbr: '1'
                    name: බස්නාහිර පළාත, ශ් රී ලංකාව
                  - abbr: '2'
                    name: මධ්‍යම පළාත, ශ්‍රී ලංකාව
                  - abbr: '6'
                    name: වයඹ පළාත, ශ්‍රී ලංකාව
                  - abbr: '9'
                    name: සබරගමුව පළාත
                - iso: LR
                  iso3: LBR
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: BM
                    name: Bomi
                  - abbr: BG
                    name: Bong
                  - abbr: X1~
                    name: Gbarpolu
                  - abbr: GP
                    name: Gbarpolu
                  - abbr: GB
                    name: Grand Bassa
                  - abbr: CM
                    name: Grand Cape Mount
                  - abbr: GG
                    name: Grand Gedeh
                  - abbr: GK
                    name: Grand Kru
                  - abbr: LO
                    name: Lofa
                  - abbr: MG
                    name: Margibi
                  - abbr: MY
                    name: Maryland
                  - abbr: MO
                    name: Montserrado
                  - abbr: NI
                    name: Nimba
                  - abbr: RG
                    name: River Gee
                  - abbr: X2~
                    name: River Gee
                  - abbr: RI
                    name: Rivercess
                  - abbr: SI
                    name: Sinoe
                - iso: LS
                  iso3: LSO
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: D
                    name: Berea
                  - abbr: B
                    name: Butha-Buthe
                  - abbr: C
                    name: Leribe
                  - abbr: E
                    name: Mafeteng
                  - abbr: A
                    name: Maseru
                  - abbr: F
                    name: Mohale's Hoek
                  - abbr: J
                    name: Mokhotlong
                  - abbr: H
                    name: Qacha's Nek
                  - abbr: G
                    name: Quthing
                  - abbr: K
                    name: Thaba-Tseka
                - iso: LT
                  iso3: LTU
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '01'
                    name: Akmenės rajono savivaldybė
                  - abbr: AL
                    name: Alytaus Apskritis
                  - abbr: '02'
                    name: Alytaus miesto savivaldybė
                  - abbr: '03'
                    name: Alytaus rajono savivaldybė
                  - abbr: '04'
                    name: Anykščių rajono savivaldybė
                  - abbr: '05'
                    name: Birštono savivaldybė
                  - abbr: '06'
                    name: Biržų rajono savivaldybė
                  - abbr: '07'
                    name: Druskininkų savivaldybė
                  - abbr: '08'
                    name: Elektrėnų savivaldybė
                  - abbr: '09'
                    name: Ignalinos rajono savivaldybė
                  - abbr: '10'
                    name: Jonavos rajono savivaldybė
                  - abbr: '11'
                    name: Joniškio rajono savivaldybė
                  - abbr: '12'
                    name: Jurbarko rajono savivaldybė
                  - abbr: '13'
                    name: Kaišiadorių rajono savivaldybė
                  - abbr: '14'
                    name: Kalvarijos savivaldybė
                  - abbr: KU
                    name: Kauno Apskritis
                  - abbr: '15'
                    name: Kauno miesto savivaldybė
                  - abbr: '16'
                    name: Kauno rajono savivaldybė
                  - abbr: '17'
                    name: Kazlų Rūdos savivaldybė
                  - abbr: '19'
                    name: Kelmės rajono savivaldybė
                  - abbr: KL
                    name: Klaipedos Apskritis
                  - abbr: '20'
                    name: Klaipėdos miesto savivaldybė
                  - abbr: '21'
                    name: Klaipėdos rajono savivaldybė
                  - abbr: '22'
                    name: Kretingos rajono savivaldybė
                  - abbr: '23'
                    name: Kupiškio rajono savivaldybė
                  - abbr: '18'
                    name: Kėdainių rajono savivaldybė
                  - abbr: '24'
                    name: Lazdijų rajono savivaldybė
                  - abbr: MR
                    name: Marijampoles Apskritis
                  - abbr: '25'
                    name: Marijampolės savivaldybė
                  - abbr: '26'
                    name: Mažeikių rajono savivaldybė
                  - abbr: '27'
                    name: Molėtų rajono savivaldybė
                  - abbr: '28'
                    name: Neringos savivaldybė
                  - abbr: '29'
                    name: Pagėgių savivaldybė
                  - abbr: '30'
                    name: Pakruojo rajono savivaldybė
                  - abbr: '31'
                    name: Palangos miesto savivaldybė
                  - abbr: PN
                    name: Panevežio Apskritis
                  - abbr: '32'
                    name: Panevėžio miesto savivaldybė
                  - abbr: '33'
                    name: Panevėžio rajono savivaldybė
                  - abbr: '34'
                    name: Pasvalio rajono savivaldybė
                  - abbr: '35'
                    name: Plungės rajono savivaldybė
                  - abbr: '36'
                    name: Prienų rajono savivaldybė
                  - abbr: '37'
                    name: Radviliškio rajono savivaldybė
                  - abbr: '38'
                    name: Raseinių rajono savivaldybė
                  - abbr: '39'
                    name: Rietavo savivaldybė
                  - abbr: '40'
                    name: Rokiškio rajono savivaldybė
                  - abbr: '48'
                    name: Skuodo rajono savivaldybė
                  - abbr: TA
                    name: Taurages Apskritis
                  - abbr: '50'
                    name: Tauragės rajono savivaldybė
                  - abbr: TE
                    name: Telšiu Apskritis
                  - abbr: '51'
                    name: Telšių rajono savivaldybė
                  - abbr: '52'
                    name: Trakų rajono savivaldybė
                  - abbr: '53'
                    name: Ukmergės rajono savivaldybė
                  - abbr: UT
                    name: Utenos Apskritis
                  - abbr: '54'
                    name: Utenos rajono savivaldybė
                  - abbr: '55'
                    name: Varėnos rajono savivaldybė
                  - abbr: '56'
                    name: Vilkaviškio rajono savivaldybė
                  - abbr: VL
                    name: Vilniaus Apskritis
                  - abbr: '57'
                    name: Vilniaus miesto savivaldybė
                  - abbr: '58'
                    name: Vilniaus rajono savivaldybė
                  - abbr: '59'
                    name: Visagino savivaldybė
                  - abbr: '60'
                    name: Zarasų rajono savivaldybė
                  - abbr: '41'
                    name: Šakių rajono savivaldybė
                  - abbr: '42'
                    name: Šalčininkų rajono savivaldybė
                  - abbr: SA
                    name: Šiauliu Apskritis
                  - abbr: '43'
                    name: Šiaulių miesto savivaldybė
                  - abbr: '44'
                    name: Šiaulių rajono savivaldybė
                  - abbr: '45'
                    name: Šilalės rajono savivaldybė
                  - abbr: '46'
                    name: Šilutės rajono savivaldybė
                  - abbr: '47'
                    name: Širvintų rajono savivaldybė
                  - abbr: '49'
                    name: Švenčionių rajono savivaldybė
                - iso: LU
                  iso3: LUX
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: DI
                    name: Diekrech
                  - abbr: ES
                    name: Esch-Uelzecht
                  - abbr: GR
                    name: Gréivemaacher
                  - abbr: EC
                    name: Iechternach
                  - abbr: CA
                    name: Kapellen
                  - abbr: CL
                    name: Klierf
                  - abbr: LU
                    name: Lëtzebuerg
                  - abbr: ME
                    name: Miersch
                  - abbr: RD
                    name: Réiden-Atert
                  - abbr: RM
                    name: Réimech
                  - abbr: VD
                    name: Veianen
                  - abbr: WI
                    name: Wolz
                - iso: LV
                  iso3: LVA
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '002'
                    name: Aizkraukles novads
                  - abbr: '007'
                    name: Alūksnes novads
                  - abbr: '111'
                    name: Augšdaugavas novads
                  - abbr: '015'
                    name: Balvu novads
                  - abbr: '016'
                    name: Bauskas novads
                  - abbr: '022'
                    name: Cēsu novads
                  - abbr: DGV
                    name: Daugavpils
                  - abbr: '112'
                    name: Dienvidkurzemes Novads
                  - abbr: '026'
                    name: Dobeles novads
                  - abbr: '033'
                    name: Gulbenes novads
                  - abbr: JEL
                    name: Jelgava
                  - abbr: '041'
                    name: Jelgavas novads
                  - abbr: JUR
                    name: Jurmala
                  - abbr: '042'
                    name: Jēkabpils novads
                  - abbr: '047'
                    name: Krāslavas novads
                  - abbr: '050'
                    name: Kuldīgas novads
                  - abbr: LPX
                    name: Liepaja
                  - abbr: '054'
                    name: Limbažu novads
                  - abbr: '058'
                    name: Ludzas novads
                  - abbr: '056'
                    name: Līvānu novads
                  - abbr: '059'
                    name: Madonas novads
                  - abbr: '062'
                    name: Mārupes novads
                  - abbr: '067'
                    name: Ogres novads
                  - abbr: '068'
                    name: Olaines novads
                  - abbr: '073'
                    name: Preiļu novads
                  - abbr: REZ
                    name: Rezekne
                  - abbr: RIX
                    name: Riga
                  - abbr: '080'
                    name: Ropažu novads
                  - abbr: '077'
                    name: Rēzeknes novads
                  - abbr: '087'
                    name: Salaspils novads
                  - abbr: '088'
                    name: Saldus novads
                  - abbr: '089'
                    name: Saulkrastu novads
                  - abbr: '091'
                    name: Siguldas novads
                  - abbr: '094'
                    name: Smiltenes novads
                  - abbr: '097'
                    name: Talsu novads
                  - abbr: '099'
                    name: Tukuma novads
                  - abbr: '101'
                    name: Valkas novads
                  - abbr: '113'
                    name: Valmieras Novads
                  - abbr: '102'
                    name: Varakļānu novads
                  - abbr: VEN
                    name: Ventspils
                  - abbr: '106'
                    name: Ventspils novads
                  - abbr: '011'
                    name: Ādažu novads
                  - abbr: '052'
                    name: Ķekavas novads
                - iso: LY
                  iso3: LBY
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: BU
                    name: Al Butnan
                  - abbr: JA
                    name: Al Jabal al Akhḑar
                  - abbr: JG
                    name: Al Jabal al Gharbī
                  - abbr: JI
                    name: Al Jifarah
                  - abbr: JU
                    name: Al Jufrah
                  - abbr: KF
                    name: Al Kufrah
                  - abbr: MJ
                    name: Al Marj
                  - abbr: MB
                    name: Al Murqub
                  - abbr: WA
                    name: Al Wahat
                  - abbr: NQ
                    name: An Nuqaţ al Khams
                  - abbr: ZA
                    name: Az Zawiyah
                  - abbr: BA
                    name: Banghazi
                  - abbr: DR
                    name: Darnah
                  - abbr: GT
                    name: Ghat
                  - abbr: MI
                    name: Mişrātah
                  - abbr: MQ
                    name: Murzuq
                  - abbr: NL
                    name: Nālūt
                  - abbr: SB
                    name: Sabhā
                  - abbr: SR
                    name: Sirte
                  - abbr: TB
                    name: Tarabulus
                  - abbr: WD
                    name: Wādī al Ḩayāt
                  - abbr: WS
                    name: Wādī ash Shāţiʾ
                - iso: MA
                  iso3: MAR
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AGD
                    name: Agadir*
                  - abbr: HAO
                    name: Al Haouz
                  - abbr: HOC
                    name: Al Hoceïma
                  - abbr: AOU
                    name: Aousserd
                  - abbr: ASZ
                    name: Assa-Zag
                  - abbr: AZI
                    name: Azilal
                  - abbr: BAH
                    name: Aït Baha
                  - abbr: MEL
                    name: Aït Melloul
                  - abbr: BES
                    name: Ben Slimane
                  - abbr: BEM
                    name: Beni Mellal
                  - abbr: BER
                    name: Berkane
                  - abbr: BRR
                    name: Berrechid
                  - abbr: BOD
                    name: Boujdour
                  - abbr: BOM
                    name: Boulemane
                  - abbr: '05'
                    name: Béni Mellal-Khénifra
                  - abbr: CAS
                    name: Casablanca [Dar el Beïda]
                  - abbr: '06'
                    name: Casablanca-Settat
                  - abbr: CHE
                    name: Chefchaouene
                  - abbr: CHI
                    name: Chichaoua
                  - abbr: CHT
                    name: Chtouka-Ait Baha
                  - abbr: DRI
                    name: Driouch
                  - abbr: '08'
                    name: Drâa-Tafilalet
                  - abbr: HAJ
                    name: El Hajeb
                  - abbr: JDI
                    name: El Jadida
                  - abbr: ERR
                    name: Errachidia
                  - abbr: ESM
                    name: Es Semara
                  - abbr: ESI
                    name: Essaouira
                  - abbr: FAH
                    name: Fahs-Beni Makada
                  - abbr: FIG
                    name: Figuig
                  - abbr: FQH
                    name: Fquih Ben Salah
                  - abbr: FES
                    name: Fès
                  - abbr: '03'
                    name: Fès-Meknès
                  - abbr: GUE
                    name: Guelmim
                  - abbr: '10'
                    name: Guelmim-Oued Noun (EH-partial)
                  - abbr: GUF
                    name: Guercif
                  - abbr: IFR
                    name: Ifrane
                  - abbr: JRA
                    name: Jerada
                  - abbr: KES
                    name: Kelaat Sraghna
                  - abbr: KHE
                    name: Khemisset
                  - abbr: KHN
                    name: Khenifra
                  - abbr: KHO
                    name: Khouribga
                  - abbr: KEN
                    name: Kénitra
                  - abbr: '02'
                    name: L'Oriental
                  - abbr: X1~
                    name: Laayoune-Boujdour-Sakia El Hamra
                  - abbr: LAR
                    name: Larache
                  - abbr: LAA
                    name: Laâyoune
                  - abbr: '11'
                    name: Laâyoune-Sakia El Hamra (EH-partial)
                  - abbr: MAR
                    name: Marrakech
                  - abbr: '07'
                    name: Marrakech-Safi
                  - abbr: MEK
                    name: Meknès*
                  - abbr: MID
                    name: Midelt
                  - abbr: MOU
                    name: Moulay Yacoub
                  - abbr: MED
                    name: Médiouna
                  - abbr: MDF
                    name: M’diq-Fnideq
                  - abbr: NAD
                    name: Nador
                  - abbr: NOU
                    name: Nouaceur
                  - abbr: OUA
                    name: Ouarzazate
                  - abbr: OUD
                    name: Oued Ed-Dahab
                  - abbr: OUZ
                    name: Ouezzane
                  - abbr: OUJ
                    name: Oujda-Angad
                  - abbr: '04'
                    name: Rabat-Salé-Kénitra
                  - abbr: REH
                    name: Rehamna
                  - abbr: SAF
                    name: Safi
                  - abbr: SAL
                    name: Salé
                  - abbr: SEF
                    name: Sefrou
                  - abbr: SET
                    name: Settat
                  - abbr: SIB
                    name: Sidi Bennour
                  - abbr: SIF
                    name: Sidi Ifni
                  - abbr: SIK
                    name: Sidi Kacem
                  - abbr: SIL
                    name: Sidi Slimane
                  - abbr: SYB
                    name: Sidi Youssef Ben Ali
                  - abbr: SKH
                    name: Skhirate-Témara
                  - abbr: '09'
                    name: Souss-Massa
                  - abbr: '12'
                    name: Tadla-Azilal
                  - abbr: TNT
                    name: Tan-Tan
                  - abbr: TNG
                    name: Tanger-Assilah
                  - abbr: '01'
                    name: Tanger-Tétouan-Al Hoceïma
                  - abbr: TAO
                    name: Taounate
                  - abbr: TAI
                    name: Taourirt
                  - abbr: TAF
                    name: Tarfaya (EH-partial)
                  - abbr: TAR
                    name: Taroudannt
                  - abbr: TAT
                    name: Tata
                  - abbr: TAZ
                    name: Taza
                  - abbr: TIN
                    name: Tinghir
                  - abbr: TIZ
                    name: Tiznit
                  - abbr: TET
                    name: Tétouan*
                  - abbr: YUS
                    name: Youssoufia
                  - abbr: ZAG
                    name: Zagora
                  - abbr: RAB
                    name: الرباط
                  - abbr: MOH
                    name: المحمدية
                  - abbr: INE
                    name: عمالة إنزكان آيت ملول
                  - abbr: MMD
                    name: مراكش
                  - abbr: MMN
                    name: مراكش²
                - iso: MC
                  iso3: MCO
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: FO
                    name: Fontvieille
                  - abbr: CL
                    name: La Colle
                  - abbr: CO
                    name: La Condamine
                  - abbr: GA
                    name: La Gare
                  - abbr: SR
                    name: La Rousse
                  - abbr: SO
                    name: La Source
                  - abbr: LA
                    name: Larvotto/Bas Moulins
                  - abbr: MA
                    name: Malbousquet
                  - abbr: MO
                    name: Monaco-Ville
                  - abbr: MG
                    name: Moneghetti
                  - abbr: MC
                    name: Monte-Carlo
                  - abbr: MU
                    name: Moulins
                  - abbr: PH
                    name: Port Hercule
                  - abbr: SP
                    name: Spélugues
                  - abbr: VR
                    name: Vallon de la Rousse
                  - abbr: JE
                    name: jardin exotique de Monaco
                  - abbr: SD
                    name: église Sainte-Dévote
                - iso: MD
                  iso3: MDA
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AN
                    name: Anenii Noi
                  - abbr: BA
                    name: Balti
                  - abbr: BS
                    name: Basarabeasca
                  - abbr: BD
                    name: Bender [Tighina]
                  - abbr: BR
                    name: Briceni
                  - abbr: CA
                    name: Cahul
                  - abbr: CT
                    name: Cantemir
                  - abbr: CU
                    name: Chisinau
                  - abbr: CM
                    name: Cimișlia
                  - abbr: CR
                    name: Criuleni
                  - abbr: CL
                    name: Călărași
                  - abbr: CS
                    name: Căușeni
                  - abbr: DO
                    name: Dondușeni
                  - abbr: DR
                    name: Drochia
                  - abbr: DU
                    name: Dubăsari
                  - abbr: ED
                    name: Edinet
                  - abbr: FL
                    name: Florești
                  - abbr: FA
                    name: Fălești
                  - abbr: GA
                    name: Gagauzia, Unitate Teritoriala Autonoma (UTAG)
                  - abbr: GL
                    name: Glodeni
                  - abbr: HI
                    name: Hîncești
                  - abbr: IA
                    name: Ialoveni
                  - abbr: LE
                    name: Leova
                  - abbr: NI
                    name: Nisporeni
                  - abbr: OC
                    name: Ocnița
                  - abbr: OR
                    name: Orhei
                  - abbr: RE
                    name: Rezina
                  - abbr: RI
                    name: Rîșcani
                  - abbr: SO
                    name: Soroca
                  - abbr: ST
                    name: Strășeni
                  - abbr: SN
                    name: Stînga Nistrului, unitatea teritoriala din
                  - abbr: SI
                    name: Sîngerei
                  - abbr: TA
                    name: Taraclia
                  - abbr: TE
                    name: Telenești
                  - abbr: UN
                    name: Ungheni
                  - abbr: SD
                    name: Șoldănești
                  - abbr: SV
                    name: Ștefan Vodă
                - iso: ME
                  iso3: MNE
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '01'
                    name: Andrijevica
                  - abbr: '02'
                    name: Bar
                  - abbr: '03'
                    name: Berane
                  - abbr: '04'
                    name: Bijelo Polje
                  - abbr: '05'
                    name: Budva
                  - abbr: '06'
                    name: Cetinje
                  - abbr: '07'
                    name: Danilovgrad
                  - abbr: '08'
                    name: Herceg-Novi
                  - abbr: '09'
                    name: Kolašin
                  - abbr: '10'
                    name: Kotor
                  - abbr: '11'
                    name: Mojkovac
                  - abbr: '12'
                    name: Nikšic´
                  - abbr: '13'
                    name: Plav
                  - abbr: '14'
                    name: Pljevlja
                  - abbr: '15'
                    name: Plužine
                  - abbr: '16'
                    name: Podgorica
                  - abbr: '17'
                    name: Rožaje
                  - abbr: '19'
                    name: Tivat
                  - abbr: '24'
                    name: Tuzi
                  - abbr: '20'
                    name: Ulcinj
                  - abbr: '18'
                    name: Šavnik
                  - abbr: '21'
                    name: Žabljak
                  - abbr: '22'
                    name: Општина Гусиње
                  - abbr: '23'
                    name: Општина Петњица
                - iso: MF
                  iso3: MAF
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: MG
                  iso3: MDG
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: T
                    name: Antananarivo
                  - abbr: D
                    name: Antsiranana
                  - abbr: F
                    name: Fianarantsoa
                  - abbr: M
                    name: Mahajanga
                  - abbr: A
                    name: Toamasina
                  - abbr: U
                    name: Toliara
                - iso: MH
                  iso3: MHL
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: ALL
                    name: Ailinglapalap
                  - abbr: ALK
                    name: Ailuk
                  - abbr: ARN
                    name: Arno
                  - abbr: AUR
                    name: Aur
                  - abbr: EBO
                    name: Ebon
                  - abbr: ENI
                    name: Eniwetok
                  - abbr: JAB
                    name: Jabat
                  - abbr: JAL
                    name: Jaluit
                  - abbr: KIL
                    name: Kili
                  - abbr: KWA
                    name: Kwajalein
                  - abbr: LAE
                    name: Lae
                  - abbr: LIB
                    name: Lib
                  - abbr: LIK
                    name: Likiep
                  - abbr: MAJ
                    name: Majuro
                  - abbr: MAL
                    name: Maloelap
                  - abbr: MEJ
                    name: Mejit
                  - abbr: MIL
                    name: Mili
                  - abbr: NMK
                    name: Namorik
                  - abbr: NMU
                    name: Namu
                  - abbr: L
                    name: Ralik Chain
                  - abbr: T
                    name: Ratak Chain
                  - abbr: RON
                    name: Rongelap
                  - abbr: UJA
                    name: Ujae
                  - abbr: UJL
                    name: Ujelang
                  - abbr: UTI
                    name: Utirik
                  - abbr: WTH
                    name: Wotho
                  - abbr: WTJ
                    name: Wotje
                - iso: MK
                  iso3: MKD
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '801'
                    name: Aerodrom †
                  - abbr: '802'
                    name: Aračinovo
                  - abbr: '201'
                    name: Berovo
                  - abbr: '501'
                    name: Bitola
                  - abbr: '401'
                    name: Bogdanci
                  - abbr: '601'
                    name: Bogovinje
                  - abbr: '402'
                    name: Bosilovo
                  - abbr: '602'
                    name: Brvenica
                  - abbr: '803'
                    name: Butel †
                  - abbr: '313'
                    name: Centar Župa
                  - abbr: '814'
                    name: Centar †
                  - abbr: '303'
                    name: Debar
                  - abbr: '304'
                    name: Debarca
                  - abbr: '203'
                    name: Delčevo
                  - abbr: '502'
                    name: Demir Hisar
                  - abbr: '103'
                    name: Demir Kapija
                  - abbr: '406'
                    name: Dojran
                  - abbr: '503'
                    name: Dolneni
                  - abbr: '804'
                    name: Gazi Baba †
                  - abbr: '405'
                    name: Gevgelija
                  - abbr: '805'
                    name: Gjorče Petrov †
                  - abbr: '604'
                    name: Gostivar
                  - abbr: '102'
                    name: Gradsko
                  - abbr: '807'
                    name: Ilinden
                  - abbr: '606'
                    name: Jegunovce
                  - abbr: '205'
                    name: Karbinci
                  - abbr: '808'
                    name: Karpoš †
                  - abbr: '104'
                    name: Kavadarci
                  - abbr: '809'
                    name: Kisela Voda †
                  - abbr: '307'
                    name: Kičevo
                  - abbr: '407'
                    name: Konče
                  - abbr: '206'
                    name: Kočani
                  - abbr: '701'
                    name: Kratovo
                  - abbr: '702'
                    name: Kriva Palanka
                  - abbr: '504'
                    name: Krivogaštani
                  - abbr: '505'
                    name: Kruševo
                  - abbr: '703'
                    name: Kumanovo
                  - abbr: '704'
                    name: Lipkovo
                  - abbr: '105'
                    name: Lozovo
                  - abbr: '207'
                    name: Makedonska Kamenica
                  - abbr: '308'
                    name: Makedonski Brod
                  - abbr: '607'
                    name: Mavrovo i Rostuša
                  - abbr: '506'
                    name: Mogila
                  - abbr: '106'
                    name: Negotino
                  - abbr: '507'
                    name: Novaci
                  - abbr: '408'
                    name: Novo Selo
                  - abbr: '310'
                    name: Ohrid
                  - abbr: '208'
                    name: Pehčevo
                  - abbr: '810'
                    name: Petrovec
                  - abbr: '311'
                    name: Plasnica
                  - abbr: '508'
                    name: Prilep
                  - abbr: '209'
                    name: Probištip
                  - abbr: '409'
                    name: Radoviš
                  - abbr: '705'
                    name: Rankovce
                  - abbr: '509'
                    name: Resen
                  - abbr: '107'
                    name: Rosoman
                  - abbr: '811'
                    name: Saraj †
                  - abbr: '812'
                    name: Sopište
                  - abbr: '706'
                    name: Staro Nagoričane
                  - abbr: '312'
                    name: Struga
                  - abbr: '410'
                    name: Strumica
                  - abbr: '813'
                    name: Studeničani
                  - abbr: '108'
                    name: Sveti Nikole
                  - abbr: '608'
                    name: Tearce
                  - abbr: '609'
                    name: Tetovo
                  - abbr: '403'
                    name: Valandovo
                  - abbr: '404'
                    name: Vasilevo
                  - abbr: '101'
                    name: Veles
                  - abbr: '301'
                    name: Vevčani
                  - abbr: '202'
                    name: Vinica
                  - abbr: '603'
                    name: Vrapčište
                  - abbr: '806'
                    name: Zelenikovo
                  - abbr: '204'
                    name: Zrnovci
                  - abbr: '815'
                    name: Čair †
                  - abbr: '109'
                    name: Čaška
                  - abbr: '210'
                    name: Češinovo-Obleševo
                  - abbr: '816'
                    name: Čučer-Sandevo
                  - abbr: '211'
                    name: Štip
                  - abbr: '817'
                    name: Šuto Orizari †
                  - abbr: '605'
                    name: Želino
                - iso: ML
                  iso3: MLI
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: BKO
                    name: Bamako
                  - abbr: '7'
                    name: Gao
                  - abbr: '1'
                    name: Kayes
                  - abbr: '8'
                    name: Kidal
                  - abbr: '2'
                    name: Koulikoro
                  - abbr: '5'
                    name: Mopti
                  - abbr: '9'
                    name: Région de Ménaka
                  - abbr: '10'
                    name: Région de Taoudénit
                  - abbr: '3'
                    name: Sikasso
                  - abbr: '4'
                    name: Ségou
                  - abbr: '6'
                    name: Tombouctou
                - iso: MM
                  iso3: MMR
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '07'
                    name: Ayeyarwady
                  - abbr: '02'
                    name: Bago
                  - abbr: '14'
                    name: Chin
                  - abbr: '11'
                    name: Kachin
                  - abbr: '12'
                    name: Kayah
                  - abbr: '13'
                    name: Kayin
                  - abbr: '03'
                    name: Magway
                  - abbr: '04'
                    name: Mandalay
                  - abbr: '15'
                    name: Mon
                  - abbr: '16'
                    name: Rakhine
                  - abbr: '01'
                    name: Sagaing
                  - abbr: '17'
                    name: Shan
                  - abbr: '05'
                    name: Tanintharyi
                  - abbr: '06'
                    name: Yangon
                  - abbr: '18'
                    name: နေပြည်တော် ပြည်ထောင်စုနယ်မြေ
                - iso: MN
                  iso3: MNG
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '073'
                    name: Arhangay
                  - abbr: '071'
                    name: Bayan-Ölgiy
                  - abbr: '069'
                    name: Bayanhongor
                  - abbr: '067'
                    name: Bulgan
                  - abbr: '037'
                    name: Darhan uul
                  - abbr: '061'
                    name: Dornod
                  - abbr: '063'
                    name: Dornogovi
                  - abbr: '059'
                    name: Dundgovi
                  - abbr: '057'
                    name: Dzavhan
                  - abbr: '065'
                    name: Govi-Altay
                  - abbr: '064'
                    name: Govi-Sümber
                  - abbr: '039'
                    name: Hentiy
                  - abbr: '043'
                    name: Hovd
                  - abbr: '041'
                    name: Hövsgöl
                  - abbr: '035'
                    name: Orhon
                  - abbr: '049'
                    name: Selenge
                  - abbr: '051'
                    name: Sühbaatar
                  - abbr: '047'
                    name: Töv
                  - abbr: '1'
                    name: Ulaanbaatar
                  - abbr: '046'
                    name: Uvs
                  - abbr: '053'
                    name: Ömnögovi
                  - abbr: '055'
                    name: Övörhangay
                - iso: MO
                  iso3: MAC
                  states_required: false
                  zipcode_required: false
                  states: []
                - iso: MP
                  iso3: MNP
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: MQ
                  iso3: MTQ
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: MR
                  iso3: MRT
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: '07'
                    name: Adrar
                  - abbr: '03'
                    name: Assaba
                  - abbr: '05'
                    name: Brakna
                  - abbr: '08'
                    name: Dakhlet Nouâdhibou
                  - abbr: '04'
                    name: Gorgol
                  - abbr: '10'
                    name: Guidimaka
                  - abbr: '01'
                    name: Hodh ech Chargui
                  - abbr: '02'
                    name: Hodh el Gharbi
                  - abbr: '12'
                    name: Inchiri
                  - abbr: '13'
                    name: Nouakchott Ouest
                  - abbr: '09'
                    name: Tagant
                  - abbr: '11'
                    name: Tiris Zemmour
                  - abbr: '06'
                    name: Trarza
                  - abbr: '15'
                    name: نواكشوط الجنوبية
                  - abbr: '14'
                    name: نواكشوط الشمالية
                - iso: MS
                  iso3: MSR
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: MT
                  iso3: MLT
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '01'
                    name: Attard
                  - abbr: '02'
                    name: Balzan
                  - abbr: '03'
                    name: Birgu
                  - abbr: '04'
                    name: Birkirkara
                  - abbr: '05'
                    name: Birżebbuġa
                  - abbr: '06'
                    name: Bormla
                  - abbr: '07'
                    name: Dingli
                  - abbr: '08'
                    name: Fgura
                  - abbr: '09'
                    name: Floriana
                  - abbr: '10'
                    name: Fontana
                  - abbr: '11'
                    name: Gudja
                  - abbr: '13'
                    name: Għajnsielem
                  - abbr: '14'
                    name: Għarb
                  - abbr: '15'
                    name: Għargħur
                  - abbr: '16'
                    name: Għasri
                  - abbr: '17'
                    name: Għaxaq
                  - abbr: '12'
                    name: Gżira
                  - abbr: '19'
                    name: Iklin
                  - abbr: '20'
                    name: Isla
                  - abbr: '21'
                    name: Kalkara
                  - abbr: '22'
                    name: Kerċem
                  - abbr: '23'
                    name: Kirkop
                  - abbr: '24'
                    name: Lija
                  - abbr: '25'
                    name: Luqa
                  - abbr: '26'
                    name: Marsa
                  - abbr: '27'
                    name: Marsaskala
                  - abbr: '28'
                    name: Marsaxlokk
                  - abbr: '29'
                    name: Mdina
                  - abbr: '30'
                    name: Mellieħa
                  - abbr: '32'
                    name: Mosta
                  - abbr: '33'
                    name: Mqabba
                  - abbr: '34'
                    name: Msida
                  - abbr: '35'
                    name: Mtarfa
                  - abbr: '36'
                    name: Munxar
                  - abbr: '31'
                    name: Mġarr
                  - abbr: '37'
                    name: Nadur
                  - abbr: '38'
                    name: Naxxar
                  - abbr: '39'
                    name: Paola
                  - abbr: '40'
                    name: Pembroke
                  - abbr: '41'
                    name: Pietà
                  - abbr: '42'
                    name: Qala
                  - abbr: '43'
                    name: Qormi
                  - abbr: '44'
                    name: Qrendi
                  - abbr: '45'
                    name: Rabat Gozo
                  - abbr: '46'
                    name: Rabat Malta
                  - abbr: '47'
                    name: Safi
                  - abbr: '49'
                    name: Saint John
                  - abbr: '48'
                    name: Saint Julian's
                  - abbr: '50'
                    name: Saint Lawrence
                  - abbr: '53'
                    name: Saint Lucia's
                  - abbr: '51'
                    name: Saint Paul's Bay
                  - abbr: '52'
                    name: Sannat
                  - abbr: '54'
                    name: Santa Venera
                  - abbr: '55'
                    name: Siġġiewi
                  - abbr: '56'
                    name: Sliema
                  - abbr: '57'
                    name: Swieqi
                  - abbr: '58'
                    name: Ta' Xbiex
                  - abbr: '59'
                    name: Tarxien
                  - abbr: '60'
                    name: Valletta
                  - abbr: '61'
                    name: Xagħra
                  - abbr: '62'
                    name: Xewkija
                  - abbr: '63'
                    name: Xgħajra
                  - abbr: '18'
                    name: Ħamrun
                  - abbr: '64'
                    name: Żabbar
                  - abbr: '65'
                    name: Żebbuġ Gozo
                  - abbr: '66'
                    name: Żebbuġ Malta
                  - abbr: '67'
                    name: Żejtun
                  - abbr: '68'
                    name: Żurrieq
                - iso: MU
                  iso3: MUS
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AG
                    name: Agalega Islands
                  - abbr: BL
                    name: Black River
                  - abbr: CC
                    name: Cargados Carajos Shoals [Saint Brandon Islands]
                  - abbr: FL
                    name: Flacq
                  - abbr: GP
                    name: Grand Port
                  - abbr: MO
                    name: Moka
                  - abbr: PA
                    name: Pamplemousses
                  - abbr: PW
                    name: Plaines Wilhems
                  - abbr: PL
                    name: Port Louis City
                  - abbr: RR
                    name: Rivière du Rempart
                  - abbr: RO
                    name: Rodrigues Island
                  - abbr: SA
                    name: Savanne
                - iso: MV
                  iso3: MDV
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '01'
                    name: Addu
                  - abbr: '00'
                    name: Ariatholhu Dhekunuburi
                  - abbr: '02'
                    name: Ariatholhu Uthuruburi
                  - abbr: '03'
                    name: Faadhippolhu
                  - abbr: '04'
                    name: Felidheatholhu
                  - abbr: '29'
                    name: Fuvammulah
                  - abbr: '05'
                    name: Hahdhunmathi
                  - abbr: '28'
                    name: Huvadhuatholhu Dhekunuburi
                  - abbr: '27'
                    name: Huvadhuatholhu Uthuruburi
                  - abbr: '08'
                    name: Kolhumadulu
                  - abbr: '26'
                    name: Maaleatholhu
                  - abbr: '20'
                    name: Maalhosmadulu Dhekunuburi
                  - abbr: '13'
                    name: Maalhosmadulu Uthuruburi
                  - abbr: MLE
                    name: Male
                  - abbr: '25'
                    name: Miladhunmadulu Dhekunuburi
                  - abbr: '24'
                    name: Miladhunmadulu Uthuruburi
                  - abbr: '12'
                    name: Mulakatholhu
                  - abbr: '17'
                    name: Nilandheatholhu Dhekunuburi
                  - abbr: '14'
                    name: Nilandheatholhu Uthuruburi
                  - abbr: '23'
                    name: Thiladhunmathee Dhekunuburi
                  - abbr: '07'
                    name: Thiladhunmathee Uthuruburi
                - iso: MW
                  iso3: MWI
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: BA
                    name: Balaka
                  - abbr: BL
                    name: Blantyre
                  - abbr: C
                    name: Central
                  - abbr: CK
                    name: Chikwawa
                  - abbr: CR
                    name: Chiradzulu
                  - abbr: CT
                    name: Chitipa
                  - abbr: DE
                    name: Dedza
                  - abbr: DO
                    name: Dowa
                  - abbr: KR
                    name: Karonga
                  - abbr: KS
                    name: Kasungu
                  - abbr: LK
                    name: Likoma Island
                  - abbr: LI
                    name: Lilongwe
                  - abbr: MH
                    name: Machinga
                  - abbr: MG
                    name: Mangochi
                  - abbr: MC
                    name: Mchinji
                  - abbr: MU
                    name: Mulanje
                  - abbr: MW
                    name: Mwanza
                  - abbr: MZ
                    name: Mzimba
                  - abbr: NE
                    name: Neno
                  - abbr: NB
                    name: Nkhata Bay
                  - abbr: NK
                    name: Nkhotakota
                  - abbr: "N"
                    name: Northern
                  - abbr: NS
                    name: Nsanje
                  - abbr: NU
                    name: Ntcheu
                  - abbr: NI
                    name: Ntchisi
                  - abbr: PH
                    name: Phalombe
                  - abbr: RU
                    name: Rumphi
                  - abbr: SA
                    name: Salima
                  - abbr: S
                    name: Southern
                  - abbr: TH
                    name: Thyolo
                  - abbr: ZO
                    name: Zomba
                - iso: MX
                  iso3: MEX
                  states_required: true
                  zipcode_required: true
                  states:
                  - abbr: AGU
                    name: Aguascalientes
                  - abbr: BCN
                    name: Baja California
                  - abbr: BCS
                    name: Baja California Sur
                  - abbr: CAM
                    name: Campeche
                  - abbr: CHP
                    name: Chiapas
                  - abbr: CHH
                    name: Chihuahua
                  - abbr: CMX
                    name: Ciudad de México
                  - abbr: COA
                    name: Coahuila
                  - abbr: COL
                    name: Colima
                  - abbr: DUR
                    name: Durango
                  - abbr: GUA
                    name: Guanajuato
                  - abbr: GRO
                    name: Guerrero
                  - abbr: HID
                    name: Hidalgo
                  - abbr: JAL
                    name: Jalisco
                  - abbr: MIC
                    name: Michoacán
                  - abbr: MOR
                    name: Morelos
                  - abbr: MEX
                    name: México
                  - abbr: NAY
                    name: Nayarit
                  - abbr: NLE
                    name: Nuevo León
                  - abbr: OAX
                    name: Oaxaca
                  - abbr: PUE
                    name: Puebla
                  - abbr: QUE
                    name: Querétaro
                  - abbr: ROO
                    name: Quintana Roo
                  - abbr: SLP
                    name: San Luis Potosí
                  - abbr: SIN
                    name: Sinaloa
                  - abbr: SON
                    name: Sonora
                  - abbr: TAB
                    name: Tabasco
                  - abbr: TAM
                    name: Tamaulipas
                  - abbr: TLA
                    name: Tlaxcala
                  - abbr: VER
                    name: Veracruz
                  - abbr: YUC
                    name: Yucatán
                  - abbr: ZAC
                    name: Zacatecas
                - iso: MY
                  iso3: MYS
                  states_required: true
                  zipcode_required: true
                  states:
                  - abbr: '01'
                    name: Johor
                  - abbr: '02'
                    name: Kedah
                  - abbr: '03'
                    name: Kelantan
                  - abbr: '04'
                    name: Melaka
                  - abbr: '05'
                    name: Negeri Sembilan
                  - abbr: '06'
                    name: Pahang
                  - abbr: '08'
                    name: Perak
                  - abbr: '09'
                    name: Perlis
                  - abbr: '07'
                    name: Pulau Pinang
                  - abbr: '12'
                    name: Sabah
                  - abbr: '13'
                    name: Sarawak
                  - abbr: '10'
                    name: Selangor
                  - abbr: '11'
                    name: Terengganu
                  - abbr: '14'
                    name: Wilayah Persekutuan Kuala Lumpur
                  - abbr: '15'
                    name: Wilayah Persekutuan Labuan
                  - abbr: '16'
                    name: Wilayah Persekutuan Putrajaya
                - iso: MZ
                  iso3: MOZ
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: P
                    name: Cabo Delgado
                  - abbr: G
                    name: Gaza
                  - abbr: I
                    name: Inhambane
                  - abbr: B
                    name: Manica
                  - abbr: L
                    name: Maputo
                  - abbr: MPM
                    name: Maputo City
                  - abbr: "N"
                    name: Nampula
                  - abbr: A
                    name: Niassa
                  - abbr: S
                    name: Sofala
                  - abbr: T
                    name: Tete
                  - abbr: Q
                    name: Zambézia
                - iso: NA
                  iso3: NAM
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: ER
                    name: Erongo
                  - abbr: HA
                    name: Hardap
                  - abbr: KA
                    name: Karas
                  - abbr: KE
                    name: Kavango East
                  - abbr: KW
                    name: Kavango West
                  - abbr: KH
                    name: Khomas
                  - abbr: KU
                    name: Kunene
                  - abbr: OW
                    name: Ohangwena
                  - abbr: OH
                    name: Omaheke
                  - abbr: OS
                    name: Omusati
                  - abbr: 'ON'
                    name: Oshana
                  - abbr: OT
                    name: Oshikoto
                  - abbr: OD
                    name: Otjozondjupa
                  - abbr: CA
                    name: Zambezi
                - iso: NC
                  iso3: NCL
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: NE
                  iso3: NER
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '1'
                    name: Agadez
                  - abbr: '2'
                    name: Diffa
                  - abbr: '3'
                    name: Dosso
                  - abbr: '4'
                    name: Maradi
                  - abbr: '8'
                    name: Niamey
                  - abbr: '5'
                    name: Tahoua
                  - abbr: '6'
                    name: Tillabéri
                  - abbr: '7'
                    name: Zinder
                - iso: NF
                  iso3: NFK
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: NG
                  iso3: NGA
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AB
                    name: Abia
                  - abbr: FC
                    name: Abuja Capital Territory
                  - abbr: AD
                    name: Adamawa
                  - abbr: AK
                    name: Akwa Ibom
                  - abbr: AN
                    name: Anambra
                  - abbr: BA
                    name: Bauchi
                  - abbr: BY
                    name: Bayelsa
                  - abbr: BE
                    name: Benue
                  - abbr: BO
                    name: Borno
                  - abbr: CR
                    name: Cross River
                  - abbr: DE
                    name: Delta
                  - abbr: EB
                    name: Ebonyi
                  - abbr: ED
                    name: Edo
                  - abbr: EK
                    name: Ekiti
                  - abbr: EN
                    name: Enugu
                  - abbr: GO
                    name: Gombe
                  - abbr: IM
                    name: Imo
                  - abbr: JI
                    name: Jigawa
                  - abbr: KD
                    name: Kaduna
                  - abbr: KN
                    name: Kano
                  - abbr: KT
                    name: Katsina
                  - abbr: KE
                    name: Kebbi
                  - abbr: KO
                    name: Kogi
                  - abbr: KW
                    name: Kwara
                  - abbr: LA
                    name: Lagos
                  - abbr: NA
                    name: Nassarawa
                  - abbr: NI
                    name: Niger
                  - abbr: OG
                    name: Ogun
                  - abbr: 'ON'
                    name: Ondo
                  - abbr: OS
                    name: Osun
                  - abbr: OY
                    name: Oyo
                  - abbr: PL
                    name: Plateau
                  - abbr: RI
                    name: Rivers
                  - abbr: SO
                    name: Sokoto
                  - abbr: TA
                    name: Taraba
                  - abbr: YO
                    name: Yobe
                  - abbr: ZA
                    name: Zamfara
                - iso: NI
                  iso3: NIC
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AN
                    name: Atlántico Norte*
                  - abbr: AS
                    name: Atlántico Sur*
                  - abbr: BO
                    name: Boaco
                  - abbr: CA
                    name: Carazo
                  - abbr: CI
                    name: Chinandega
                  - abbr: CO
                    name: Chontales
                  - abbr: ES
                    name: Estelí
                  - abbr: GR
                    name: Granada
                  - abbr: JI
                    name: Jinotega
                  - abbr: LE
                    name: León
                  - abbr: MD
                    name: Madriz
                  - abbr: MN
                    name: Managua
                  - abbr: MS
                    name: Masaya
                  - abbr: MT
                    name: Matagalpa
                  - abbr: NS
                    name: Nueva Segovia
                  - abbr: RI
                    name: Rivas
                  - abbr: SJ
                    name: Río San Juan
                - iso: NL
                  iso3: NLD
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AW
                    name: Aruba
                  - abbr: BQ1
                    name: Bonaire
                  - abbr: CW
                    name: Curaçao
                  - abbr: DR
                    name: Drenthe
                  - abbr: FL
                    name: Flevoland
                  - abbr: FR
                    name: Friesland
                  - abbr: GE
                    name: Gelderland
                  - abbr: GR
                    name: Groningen
                  - abbr: LI
                    name: Limburg
                  - abbr: NB
                    name: Noord-Brabant
                  - abbr: NH
                    name: Noord-Holland
                  - abbr: OV
                    name: Overijssel
                  - abbr: BQ2
                    name: Saba
                  - abbr: BQ3
                    name: Sint Eustatius
                  - abbr: SX
                    name: Sint Maarten
                  - abbr: UT
                    name: Utrecht
                  - abbr: ZE
                    name: Zeeland
                  - abbr: ZH
                    name: Zuid-Holland
                - iso: 'NO'
                  iso3: NOR
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '42'
                    name: Agder
                  - abbr: '34'
                    name: Innlandet
                  - abbr: '22'
                    name: Jan Mayen (Arctic Region)
                  - abbr: '15'
                    name: Møre og Romsdal
                  - abbr: '18'
                    name: Nordland
                  - abbr: '03'
                    name: Oslo
                  - abbr: '11'
                    name: Rogaland
                  - abbr: '21'
                    name: Svalbard (Arctic Region)
                  - abbr: '54'
                    name: Troms og Finnmark
                  - abbr: '50'
                    name: Trøndelag
                  - abbr: '38'
                    name: Vestfold og Telemark
                  - abbr: '46'
                    name: Vestland
                  - abbr: '30'
                    name: Viken
                - iso: NP
                  iso3: NPL
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: BA
                    name: Bagmati
                  - abbr: P3
                    name: Bagmati Province
                  - abbr: BH
                    name: Bheri
                  - abbr: DH
                    name: Dhawalagiri
                  - abbr: GA
                    name: Gandaki
                  - abbr: P4
                    name: Gandaki Province
                  - abbr: JA
                    name: Janakpur
                  - abbr: KA
                    name: Karnali
                  - abbr: P6
                    name: Karnali Province
                  - abbr: P1
                    name: Koshi Province
                  - abbr: KO
                    name: Kosi [Koshi]
                  - abbr: LU
                    name: Lumbini
                  - abbr: P5
                    name: Lumbini Province
                  - abbr: P2
                    name: Madhesh Province
                  - abbr: MA
                    name: Mahakali
                  - abbr: ME
                    name: Mechi
                  - abbr: NA
                    name: Narayani
                  - abbr: RA
                    name: Rapti
                  - abbr: SA
                    name: Sagarmatha
                  - abbr: SE
                    name: Seti
                  - abbr: P7
                    name: Sudurpashchim Province
                  - abbr: '3'
                    name: पश्चिमाञ्चल विकास क्षेत्र
                  - abbr: '4'
                    name: पूर्वाञ्चल विकास क्षेत्र
                  - abbr: '2'
                    name: मध्य-पश्चिमाञ्चल विकास क्षेत्र
                  - abbr: '1'
                    name: मध्यमाञ्चल विकास क्षेत्र
                  - abbr: '5'
                    name: सुदूर-पश्चिमाञ्चल विकास क्षेत्र
                - iso: NR
                  iso3: NRU
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: '01'
                    name: Aiwo
                  - abbr: '02'
                    name: Anabar
                  - abbr: '03'
                    name: Anetan
                  - abbr: '04'
                    name: Anibare
                  - abbr: '05'
                    name: Baiti
                  - abbr: '06'
                    name: Boe
                  - abbr: '07'
                    name: Buada
                  - abbr: '08'
                    name: Denigomodu
                  - abbr: '09'
                    name: Ewa
                  - abbr: '10'
                    name: Ijuw
                  - abbr: '11'
                    name: Meneng
                  - abbr: '12'
                    name: Nibok
                  - abbr: '13'
                    name: Uaboe
                  - abbr: '14'
                    name: Yaren
                - iso: NU
                  iso3: NIU
                  states_required: false
                  zipcode_required: false
                  states: []
                - iso: NZ
                  iso3: NZL
                  states_required: true
                  zipcode_required: true
                  states:
                  - abbr: AUK
                    name: Auckland
                  - abbr: BOP
                    name: Bay of Plenty
                  - abbr: CAN
                    name: Canterbury
                  - abbr: CIT
                    name: Chatham Islands Territory
                  - abbr: GIS
                    name: Gisborne
                  - abbr: HKB
                    name: Hawke's Bay
                  - abbr: MWT
                    name: Manawatu-Wanganui
                  - abbr: MBH
                    name: Marlborough
                  - abbr: NSN
                    name: Nelson
                  - abbr: NTL
                    name: Northland
                  - abbr: OTA
                    name: Otago
                  - abbr: STL
                    name: Southland
                  - abbr: TKI
                    name: Taranaki
                  - abbr: TAS
                    name: Tasman
                  - abbr: WKO
                    name: Waikato
                  - abbr: WGN
                    name: Wellington
                  - abbr: WTC
                    name: West Coast
                - iso: OM
                  iso3: OMN
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: DA
                    name: Ad Dakhiliyah
                  - abbr: ZA
                    name: Adh Dhahirah
                  - abbr: WU
                    name: Al Wustá
                  - abbr: MA
                    name: Masqat
                  - abbr: MU
                    name: Musandam
                  - abbr: BU
                    name: محافظة البريمي
                  - abbr: BJ
                    name: محافظة جنوب الباطنة
                  - abbr: SJ
                    name: محافظة جنوب الشرقية
                  - abbr: BS
                    name: محافظة شمال الباطنة
                  - abbr: SS
                    name: محافظة شمال الشرقية
                  - abbr: ZU
                    name: محافظة ظفار
                - iso: PA
                  iso3: PAN
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: '1'
                    name: Bocas del Toro
                  - abbr: '4'
                    name: Chiriquí
                  - abbr: '2'
                    name: Coclé
                  - abbr: '3'
                    name: Colón
                  - abbr: '5'
                    name: Darién
                  - abbr: EM
                    name: Emberá-Wounaan
                  - abbr: KY
                    name: Guna Yala
                  - abbr: '6'
                    name: Herrera
                  - abbr: '7'
                    name: Los Santos
                  - abbr: NB
                    name: Ngäbe-Buglé
                  - abbr: '8'
                    name: Panamá
                  - abbr: '10'
                    name: Panamá Oeste
                  - abbr: '9'
                    name: Veraguas
                - iso: PE
                  iso3: PER
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AMA
                    name: Amazonas
                  - abbr: ANC
                    name: Ancash
                  - abbr: APU
                    name: Apurímac
                  - abbr: ARE
                    name: Arequipa
                  - abbr: AYA
                    name: Ayacucho
                  - abbr: CAJ
                    name: Cajamarca
                  - abbr: CUS
                    name: Cuzco [Cusco]
                  - abbr: CAL
                    name: El Callao
                  - abbr: HUV
                    name: Huancavelica
                  - abbr: HUC
                    name: Huánuco
                  - abbr: ICA
                    name: Ica
                  - abbr: JUN
                    name: Junín
                  - abbr: LAL
                    name: La Libertad
                  - abbr: LAM
                    name: Lambayeque
                  - abbr: LIM
                    name: Lima
                  - abbr: LMA
                    name: Lima Metropolitana
                  - abbr: LOR
                    name: Loreto
                  - abbr: MDD
                    name: Madre de Dios
                  - abbr: MOQ
                    name: Moquegua
                  - abbr: PAS
                    name: Pasco
                  - abbr: PIU
                    name: Piura
                  - abbr: PUN
                    name: Puno
                  - abbr: SAM
                    name: San Martín
                  - abbr: TAC
                    name: Tacna
                  - abbr: TUM
                    name: Tumbes
                  - abbr: UCA
                    name: Ucayali
                - iso: PF
                  iso3: PYF
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: PG
                  iso3: PNG
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: NSB
                    name: Bougainville
                  - abbr: CPM
                    name: Central
                  - abbr: CPK
                    name: Chimbu
                  - abbr: EBR
                    name: East New Britain
                  - abbr: ESW
                    name: East Sepik
                  - abbr: EHG
                    name: Eastern Highlands
                  - abbr: EPW
                    name: Enga
                  - abbr: GPK
                    name: Gulf
                  - abbr: HLA
                    name: Hela
                  - abbr: JWK
                    name: Jiwaka
                  - abbr: MPM
                    name: Madang
                  - abbr: MRL
                    name: Manus
                  - abbr: MBA
                    name: Milne Bay
                  - abbr: MPL
                    name: Morobe
                  - abbr: NCD
                    name: National Capital District (Port Moresby)
                  - abbr: NIK
                    name: New Ireland
                  - abbr: NPP
                    name: Northern
                  - abbr: SAN
                    name: Sandaun [West Sepik]
                  - abbr: SHM
                    name: Southern Highlands
                  - abbr: WBK
                    name: West New Britain
                  - abbr: WPD
                    name: Western
                  - abbr: WHM
                    name: Western Highlands
                - iso: PH
                  iso3: PHL
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: ABR
                    name: Abra
                  - abbr: AGN
                    name: Agusan del Norte
                  - abbr: AGS
                    name: Agusan del Sur
                  - abbr: AKL
                    name: Aklan
                  - abbr: ALB
                    name: Albay
                  - abbr: ANT
                    name: Antique
                  - abbr: APA
                    name: Apayao
                  - abbr: AUR
                    name: Aurora
                  - abbr: BAS
                    name: Basilan
                  - abbr: BAN
                    name: Bataan
                  - abbr: BTN
                    name: Batanes
                  - abbr: BTG
                    name: Batangas
                  - abbr: BEN
                    name: Benguet
                  - abbr: '05'
                    name: Bicol
                  - abbr: BIL
                    name: Biliran
                  - abbr: BOH
                    name: Bohol
                  - abbr: BUK
                    name: Bukidnon
                  - abbr: BUL
                    name: Bulacan
                  - abbr: CAG
                    name: Cagayan
                  - abbr: '02'
                    name: Cagayan Valley
                  - abbr: '40'
                    name: Calabarzon
                  - abbr: CAN
                    name: Camarines Norte
                  - abbr: CAS
                    name: Camarines Sur
                  - abbr: CAM
                    name: Camiguin
                  - abbr: CAP
                    name: Capiz
                  - abbr: '13'
                    name: Caraga
                  - abbr: CAT
                    name: Catanduanes
                  - abbr: CAV
                    name: Cavite
                  - abbr: CEB
                    name: Cebu
                  - abbr: '03'
                    name: Central Luzon
                  - abbr: '07'
                    name: Central Visayas
                  - abbr: COM
                    name: Compostela Valley
                  - abbr: '15'
                    name: Cordillera Administrative
                  - abbr: '11'
                    name: Davao
                  - abbr: DVO
                    name: Davao Occidental
                  - abbr: DAO
                    name: Davao Oriental
                  - abbr: DAV
                    name: Davao del Norte
                  - abbr: DAS
                    name: Davao del Sur
                  - abbr: DIN
                    name: Dinagat Islands
                  - abbr: EAS
                    name: Eastern Samar
                  - abbr: '08'
                    name: Eastern Visayas
                  - abbr: GUI
                    name: Guimaras
                  - abbr: IFU
                    name: Ifugao
                  - abbr: '01'
                    name: Ilocos
                  - abbr: ILN
                    name: Ilocos Norte
                  - abbr: ILS
                    name: Ilocos Sur
                  - abbr: ILI
                    name: Iloilo
                  - abbr: ISA
                    name: Isabela
                  - abbr: KAL
                    name: Kalinga
                  - abbr: LUN
                    name: La Union
                  - abbr: LAG
                    name: Laguna
                  - abbr: LAN
                    name: Lanao del Norte
                  - abbr: LAS
                    name: Lanao del Sur
                  - abbr: LEY
                    name: Leyte
                  - abbr: MAG
                    name: Maguindanao
                  - abbr: MAD
                    name: Marinduque
                  - abbr: MAS
                    name: Masbate
                  - abbr: '41'
                    name: Mimaropa
                  - abbr: MDC
                    name: Mindoro Occidental
                  - abbr: MDR
                    name: Mindoro Oriental
                  - abbr: MSC
                    name: Misamis Occidental
                  - abbr: MSR
                    name: Misamis Oriental
                  - abbr: MOU
                    name: Mountain Province
                  - abbr: '14'
                    name: Muslim Mindanao
                  - abbr: '00'
                    name: National Capital Region
                  - abbr: NEC
                    name: Negros Occidental
                  - abbr: NER
                    name: Negros Oriental
                  - abbr: NCO
                    name: North Cotabato
                  - abbr: '10'
                    name: Northern Mindanao
                  - abbr: NSA
                    name: Northern Samar
                  - abbr: NUE
                    name: Nueva Ecija
                  - abbr: NUV
                    name: Nueva Vizcaya
                  - abbr: PLW
                    name: Palawan
                  - abbr: PAM
                    name: Pampanga
                  - abbr: PAN
                    name: Pangasinan
                  - abbr: QUE
                    name: Quezon
                  - abbr: QUI
                    name: Quirino
                  - abbr: RIZ
                    name: Rizal
                  - abbr: ROM
                    name: Romblon
                  - abbr: SAR
                    name: Sarangani
                  - abbr: SIG
                    name: Siquijor
                  - abbr: '12'
                    name: Soccsksargen
                  - abbr: SOR
                    name: Sorsogon
                  - abbr: SCO
                    name: South Cotabato
                  - abbr: SLE
                    name: Southern Leyte
                  - abbr: SUK
                    name: Sultan Kudarat
                  - abbr: SLU
                    name: Sulu
                  - abbr: SUN
                    name: Surigao del Norte
                  - abbr: SUR
                    name: Surigao del Sur
                  - abbr: TAR
                    name: Tarlac
                  - abbr: TAW
                    name: Tawi-Tawi
                  - abbr: WSA
                    name: Western Samar
                  - abbr: '06'
                    name: Western Visayas
                  - abbr: ZMB
                    name: Zambales
                  - abbr: '09'
                    name: Zamboanga Peninsula
                  - abbr: ZSI
                    name: Zamboanga Sibuguey [Zamboanga Sibugay]
                  - abbr: ZAN
                    name: Zamboanga del Norte
                  - abbr: ZAS
                    name: Zamboanga del Sur
                - iso: PK
                  iso3: PAK
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: JK
                    name: Azad Kashmir
                  - abbr: BA
                    name: Balochistan
                  - abbr: GB
                    name: Gilgit-Baltistan
                  - abbr: IS
                    name: Islamabad
                  - abbr: KP
                    name: Khyber Pakhtunkhwa
                  - abbr: PB
                    name: Punjab
                  - abbr: SD
                    name: Sindh
                - iso: PL
                  iso3: POL
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '02'
                    name: Dolnośląskie
                  - abbr: '04'
                    name: Kujawsko-pomorskie
                  - abbr: '06'
                    name: Lubelskie
                  - abbr: '08'
                    name: Lubuskie
                  - abbr: '14'
                    name: Mazowieckie
                  - abbr: '12'
                    name: Małopolskie
                  - abbr: '16'
                    name: Opolskie
                  - abbr: '18'
                    name: Podkarpackie
                  - abbr: '20'
                    name: Podlaskie
                  - abbr: '22'
                    name: Pomorskie
                  - abbr: '28'
                    name: Warmińsko-mazurskie
                  - abbr: '30'
                    name: Wielkopolskie
                  - abbr: '32'
                    name: Zachodniopomorskie
                  - abbr: '10'
                    name: Łódzkie
                  - abbr: '24'
                    name: Śląskie
                  - abbr: '26'
                    name: Świętokrzyskie
                - iso: PM
                  iso3: SPM
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: PN
                  iso3: PCN
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: PR
                  iso3: PRI
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: PS
                  iso3: PSE
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: JRH
                    name: أريحا
                  - abbr: JEM
                    name: القدس
                  - abbr: DEB
                    name: الوسطى
                  - abbr: JEN
                    name: جنين
                  - abbr: RBH
                    name: رام الله والبيرة
                  - abbr: NGZ
                    name: شمال غزة
                  - abbr: HBN
                    name: محافظة الخليل
                  - abbr: BTH
                    name: محافظة بيت لحم
                  - abbr: KYS
                    name: محافظة خان يونس
                  - abbr: RFH
                    name: محافظة رفح الفلسطينية
                  - abbr: SLT
                    name: محافظة سلفيت
                  - abbr: TBS
                    name: محافظة طوباس
                  - abbr: TKM
                    name: محافظة طولكرم
                  - abbr: GZA
                    name: محافظة غزة
                  - abbr: QQA
                    name: محافظة قلقيلية
                  - abbr: NBS
                    name: محافظة نابلس
                - iso: PT
                  iso3: PRT
                  states_required: true
                  zipcode_required: true
                  states:
                  - abbr: '01'
                    name: Aveiro
                  - abbr: '20'
                    name: Açores
                  - abbr: '02'
                    name: Beja
                  - abbr: '03'
                    name: Braga
                  - abbr: '04'
                    name: Bragança
                  - abbr: '05'
                    name: Castelo Branco
                  - abbr: '06'
                    name: Coimbra
                  - abbr: '08'
                    name: Faro
                  - abbr: '09'
                    name: Guarda
                  - abbr: '10'
                    name: Leiria
                  - abbr: '11'
                    name: Lisboa
                  - abbr: '30'
                    name: Madeira
                  - abbr: '12'
                    name: Portalegre
                  - abbr: '13'
                    name: Porto
                  - abbr: '14'
                    name: Santarém
                  - abbr: '15'
                    name: Setúbal
                  - abbr: '16'
                    name: Viana do Castelo
                  - abbr: '17'
                    name: Vila Real
                  - abbr: '18'
                    name: Viseu
                  - abbr: '07'
                    name: Évora
                - iso: PW
                  iso3: PLW
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '002'
                    name: Aimeliik
                  - abbr: '004'
                    name: Airai
                  - abbr: '010'
                    name: Angaur
                  - abbr: '050'
                    name: Hatobohei
                  - abbr: '100'
                    name: Kayangel
                  - abbr: '150'
                    name: Koror
                  - abbr: '212'
                    name: Melekeok
                  - abbr: '214'
                    name: Ngaraard
                  - abbr: '218'
                    name: Ngarchelong
                  - abbr: '222'
                    name: Ngardmau
                  - abbr: '224'
                    name: Ngatpang
                  - abbr: '226'
                    name: Ngchesar
                  - abbr: '227'
                    name: Ngeremlengui
                  - abbr: '228'
                    name: Ngiwal
                  - abbr: '350'
                    name: Peleliu
                  - abbr: '370'
                    name: Sonsorol
                - iso: PY
                  iso3: PRY
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '16'
                    name: Alto Paraguay
                  - abbr: '10'
                    name: Alto Paraná
                  - abbr: '13'
                    name: Amambay
                  - abbr: ASU
                    name: Asunción
                  - abbr: '19'
                    name: Boquerón
                  - abbr: '5'
                    name: Caaguazú
                  - abbr: '6'
                    name: Caazapá
                  - abbr: '14'
                    name: Canindeyú
                  - abbr: '11'
                    name: Central
                  - abbr: '1'
                    name: Concepción
                  - abbr: '3'
                    name: Cordillera
                  - abbr: '4'
                    name: Guairá
                  - abbr: '7'
                    name: Itapúa
                  - abbr: '8'
                    name: Misiones
                  - abbr: '9'
                    name: Paraguarí
                  - abbr: '15'
                    name: Presidente Hayes
                  - abbr: '2'
                    name: San Pedro
                  - abbr: '12'
                    name: Ñeembucú
                - iso: QA
                  iso3: QAT
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: DA
                    name: Ad Dawhah
                  - abbr: KH
                    name: Al Khawr
                  - abbr: WA
                    name: Al Wakrah
                  - abbr: RA
                    name: Ar Rayyan
                  - abbr: MS
                    name: Madinat ash Shamal
                  - abbr: US
                    name: Umm Salal
                  - abbr: SH
                    name: الشحانية
                  - abbr: ZA
                    name: بلدية الضعاين
                - iso: RE
                  iso3: REU
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: RO
                  iso3: ROU
                  states_required: true
                  zipcode_required: true
                  states:
                  - abbr: AB
                    name: Alba
                  - abbr: AR
                    name: Arad
                  - abbr: AG
                    name: Arges
                  - abbr: BC
                    name: Bacau
                  - abbr: BH
                    name: Bihor
                  - abbr: BN
                    name: Bistrita-Nasaud
                  - abbr: BT
                    name: Botosani
                  - abbr: BR
                    name: Braila
                  - abbr: BV
                    name: Brasov
                  - abbr: B
                    name: Bucuresti
                  - abbr: BZ
                    name: Buzau
                  - abbr: CL
                    name: Calarasi
                  - abbr: CS
                    name: Caras-Severin
                  - abbr: CJ
                    name: Cluj
                  - abbr: CT
                    name: Constanta
                  - abbr: CV
                    name: Covasna
                  - abbr: DJ
                    name: Dolj
                  - abbr: DB
                    name: Dâmbovita
                  - abbr: GL
                    name: Galati
                  - abbr: GR
                    name: Giurgiu
                  - abbr: GJ
                    name: Gorj
                  - abbr: HR
                    name: Harghita
                  - abbr: HD
                    name: Hunedoara
                  - abbr: IL
                    name: Ialomita
                  - abbr: IS
                    name: Iasi
                  - abbr: IF
                    name: Ilfov
                  - abbr: MM
                    name: Maramures
                  - abbr: MH
                    name: Mehedinti
                  - abbr: MS
                    name: Mures
                  - abbr: NT
                    name: Neamt
                  - abbr: OT
                    name: Olt
                  - abbr: PH
                    name: Prahova
                  - abbr: SJ
                    name: Salaj
                  - abbr: SM
                    name: Satu Mare
                  - abbr: SB
                    name: Sibiu
                  - abbr: SV
                    name: Suceava
                  - abbr: TR
                    name: Teleorman
                  - abbr: TM
                    name: Timis
                  - abbr: TL
                    name: Tulcea
                  - abbr: VS
                    name: Vaslui
                  - abbr: VN
                    name: Vrancea
                  - abbr: VL
                    name: Vâlcea
                - iso: RS
                  iso3: SRB
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '00'
                    name: Belgrade
                  - abbr: '14'
                    name: Bor
                  - abbr: '11'
                    name: Branicevo
                  - abbr: '23'
                    name: Jablanica
                  - abbr: '06'
                    name: Južna Backa
                  - abbr: '04'
                    name: Južni Banat
                  - abbr: '09'
                    name: Kolubara
                  - abbr: '25'
                    name: Kosovo
                  - abbr: '29'
                    name: Kosovo-Pomoravlje
                  - abbr: '28'
                    name: Kosovska Mitrovica
                  - abbr: '08'
                    name: Macva
                  - abbr: '17'
                    name: Moravica
                  - abbr: '20'
                    name: Nišava
                  - abbr: '24'
                    name: Pcinja
                  - abbr: '26'
                    name: Pec´
                  - abbr: '22'
                    name: Pirot
                  - abbr: '10'
                    name: Podunavlje
                  - abbr: '13'
                    name: Pomoravlje
                  - abbr: '27'
                    name: Prizren
                  - abbr: '19'
                    name: Rasina
                  - abbr: '18'
                    name: Raška
                  - abbr: '01'
                    name: Severna Backa
                  - abbr: '03'
                    name: Severni Banat
                  - abbr: '02'
                    name: Srednji Banat
                  - abbr: '07'
                    name: Srem
                  - abbr: '21'
                    name: Toplica
                  - abbr: '15'
                    name: Zajecar
                  - abbr: '05'
                    name: Zapadna Backa
                  - abbr: '16'
                    name: Zlatibor
                  - abbr: '12'
                    name: Šumadija
                  - abbr: VO
                    name: Војводина
                  - abbr: KM
                    name: Косово и Метохија
                - iso: RU
                  iso3: RUS
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AD
                    name: Adygeya, Respublika
                  - abbr: AL
                    name: Altay, Respublika
                  - abbr: ALT
                    name: Altayskiy kray
                  - abbr: AMU
                    name: Amurskaya oblast'
                  - abbr: ARK
                    name: Arkhangel'skaya oblast'
                  - abbr: AST
                    name: Astrakhanskaya oblast'
                  - abbr: BA
                    name: Bashkortostan, Respublika
                  - abbr: BEL
                    name: Belgorodskaya oblast'
                  - abbr: BRY
                    name: Bryanskaya oblast'
                  - abbr: BU
                    name: Buryatiya, Respublika
                  - abbr: CE
                    name: Chechenskaya Respublika
                  - abbr: CHE
                    name: Chelyabinskaya oblast'
                  - abbr: CHU
                    name: Chukotskiy avtonomnyy okrug
                  - abbr: CU
                    name: Chuvashskaya Respublika
                  - abbr: DA
                    name: Dagestan, Respublika
                  - abbr: IN
                    name: Ingushskaya Respublika [Respublika Ingushetiya]
                  - abbr: IRK
                    name: Irkutskaya oblast'
                  - abbr: IVA
                    name: Ivanovskaya oblast'
                  - abbr: KB
                    name: Kabardino-Balkarskaya Respublika
                  - abbr: KGD
                    name: Kaliningradskaya oblast'
                  - abbr: KL
                    name: Kalmykiya, Respublika
                  - abbr: KLU
                    name: Kaluzhskaya oblast'
                  - abbr: KAM
                    name: Kamchatskaya oblast'
                  - abbr: KC
                    name: Karachayevo-Cherkesskaya Respublika
                  - abbr: KR
                    name: Kareliya, Respublika
                  - abbr: KEM
                    name: Kemerovskaya oblast'
                  - abbr: KHA
                    name: Khabarovskiy kray
                  - abbr: KK
                    name: Khakasiya, Respublika
                  - abbr: KHM
                    name: Khanty-Mansiyskiy avtonomnyy okrug [Yugra]
                  - abbr: KIR
                    name: Kirovskaya oblast'
                  - abbr: KO
                    name: Komi, Respublika
                  - abbr: KOS
                    name: Kostromskaya oblast'
                  - abbr: KDA
                    name: Krasnodarskiy kray
                  - abbr: KYA
                    name: Krasnoyarskiy kray
                  - abbr: KGN
                    name: Kurganskaya oblast'
                  - abbr: KRS
                    name: Kurskaya oblast'
                  - abbr: LEN
                    name: Leningradskaya oblast'
                  - abbr: LIP
                    name: Lipetskaya oblast'
                  - abbr: MAG
                    name: Magadanskaya oblast'
                  - abbr: ME
                    name: Mariy El, Respublika
                  - abbr: MO
                    name: Mordoviya, Respublika
                  - abbr: MOS
                    name: Moskovskaya oblast'
                  - abbr: MOW
                    name: Moskva
                  - abbr: MUR
                    name: Murmanskaya oblast'
                  - abbr: NEN
                    name: Nenetskiy avtonomnyy okrug
                  - abbr: NIZ
                    name: Nizhegorodskaya oblast'
                  - abbr: NGR
                    name: Novgorodskaya oblast'
                  - abbr: NVS
                    name: Novosibirskaya oblast'
                  - abbr: OMS
                    name: Omskaya oblast'
                  - abbr: ORE
                    name: Orenburgskaya oblast'
                  - abbr: ORL
                    name: Orlovskaya oblast'
                  - abbr: PNZ
                    name: Penzenskaya oblast'
                  - abbr: PER
                    name: Perm
                  - abbr: PRI
                    name: Primorskiy kray
                  - abbr: PSK
                    name: Pskovskaya oblast'
                  - abbr: ROS
                    name: Rostovskaya oblast'
                  - abbr: RYA
                    name: Ryazanskaya oblast'
                  - abbr: SA
                    name: Sakha, Respublika [Yakutiya]
                  - abbr: SAK
                    name: Sakhalinskaya oblast'
                  - abbr: SAM
                    name: Samarskaya oblast'
                  - abbr: SPE
                    name: Sankt-Peterburg
                  - abbr: SAR
                    name: Saratovskaya oblast'
                  - abbr: SE
                    name: Severnaya Osetiya, Respublika [Alaniya] [Respublika Severnaya
                      Osetiya-Alaniya]
                  - abbr: SMO
                    name: Smolenskaya oblast'
                  - abbr: STA
                    name: Stavropol'skiy kray
                  - abbr: SVE
                    name: Sverdlovskaya oblast'
                  - abbr: TAM
                    name: Tambovskaya oblast'
                  - abbr: TA
                    name: Tatarstan, Respublika
                  - abbr: TOM
                    name: Tomskaya oblast'
                  - abbr: TUL
                    name: Tul'skaya oblast'
                  - abbr: TVE
                    name: Tverskaya oblast'
                  - abbr: TYU
                    name: Tyumenskaya oblast'
                  - abbr: TY
                    name: Tyva, Respublika [Tuva]
                  - abbr: UD
                    name: Udmurtskaya Respublika
                  - abbr: ULY
                    name: Ul'yanovskaya oblast'
                  - abbr: VLA
                    name: Vladimirskaya oblast'
                  - abbr: VGG
                    name: Volgogradskaya oblast'
                  - abbr: VLG
                    name: Vologodskaya oblast'
                  - abbr: VOR
                    name: Voronezhskaya oblast'
                  - abbr: YAN
                    name: Yamalo-Nenetskiy avtonomnyy okrug
                  - abbr: YAR
                    name: Yaroslavskaya oblast'
                  - abbr: YEV
                    name: Yevreyskaya avtonomnaya oblast'
                  - abbr: ZAB
                    name: Zabaykal'skij kray
                - iso: RW
                  iso3: RWA
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: '02'
                    name: Est
                  - abbr: '03'
                    name: Nord
                  - abbr: '04'
                    name: Ouest
                  - abbr: '05'
                    name: Sud
                  - abbr: '01'
                    name: Ville de Kigali
                - iso: SA
                  iso3: SAU
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '14'
                    name: "'Asīr"
                  - abbr: '11'
                    name: Al Bāḩah
                  - abbr: '12'
                    name: Al Jawf
                  - abbr: '03'
                    name: Al Madinah
                  - abbr: '05'
                    name: Al Qasim
                  - abbr: '08'
                    name: Al Ḩudūd ash Shamālīyah
                  - abbr: '01'
                    name: Ar Riyāḑ
                  - abbr: '04'
                    name: Ash Sharqiyah
                  - abbr: '09'
                    name: Jāzān
                  - abbr: '02'
                    name: Makkah al Mukarramah
                  - abbr: '10'
                    name: Najrān
                  - abbr: '07'
                    name: Tabūk
                  - abbr: '06'
                    name: Ḩā'il
                - iso: SB
                  iso3: SLB
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: CT
                    name: Capital Territory (Honiara)
                  - abbr: CE
                    name: Central
                  - abbr: CH
                    name: Choiseul
                  - abbr: GU
                    name: Guadalcanal
                  - abbr: IS
                    name: Isabel
                  - abbr: MK
                    name: Makira
                  - abbr: ML
                    name: Malaita
                  - abbr: RB
                    name: Rennell and Bellona
                  - abbr: TE
                    name: Temotu
                  - abbr: WE
                    name: Western
                - iso: SC
                  iso3: SYC
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: '02'
                    name: Anse Boileau
                  - abbr: '04'
                    name: Anse Louis
                  - abbr: '05'
                    name: Anse Royale
                  - abbr: '01'
                    name: Anse aux Pins
                  - abbr: '03'
                    name: Anse Étoile
                  - abbr: '06'
                    name: Baie Lazare
                  - abbr: '07'
                    name: Baie Sainte Anne
                  - abbr: '08'
                    name: Beau Vallon
                  - abbr: '09'
                    name: Bel Air
                  - abbr: '10'
                    name: Bel Ombre
                  - abbr: '11'
                    name: Cascade
                  - abbr: '12'
                    name: Glacis
                  - abbr: '13'
                    name: Grand' Anse (Mahé)
                  - abbr: '14'
                    name: Grand' Anse (Praslin)
                  - abbr: '26'
                    name: Ile Perseverance I
                  - abbr: '27'
                    name: Ile Perseverance II
                  - abbr: '15'
                    name: La Digue
                  - abbr: '16'
                    name: La Rivière Anglaise
                  - abbr: '24'
                    name: Les Mamelles
                  - abbr: '17'
                    name: Mont Buxton
                  - abbr: '18'
                    name: Mont Fleuri
                  - abbr: '19'
                    name: Plaisance
                  - abbr: '20'
                    name: Pointe La Rue
                  - abbr: '21'
                    name: Port Glaud
                  - abbr: '25'
                    name: Roche Caïman
                  - abbr: '22'
                    name: Saint Louis
                  - abbr: '23'
                    name: Takamaka
                - iso: SD
                  iso3: SDN
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: RS
                    name: Al Baḩr al Aḩmar
                  - abbr: GZ
                    name: Al Jazīrah
                  - abbr: KH
                    name: Al Kharţūm
                  - abbr: GD
                    name: Al Qaḑārif
                  - abbr: NW
                    name: An Nīl al Abyaḑ
                  - abbr: NB
                    name: An Nīl al Azraq
                  - abbr: 'NO'
                    name: Ash Shamālīyah
                  - abbr: DW
                    name: Gharb Dārfūr
                  - abbr: GK
                    name: Gharb Kurdufān
                  - abbr: DS
                    name: Janūb Dārfūr
                  - abbr: KS
                    name: Janūb Kurdufān
                  - abbr: KA
                    name: Kassalā
                  - abbr: NR
                    name: Nahr an Nīl
                  - abbr: DN
                    name: Shamāl Dārfūr
                  - abbr: DE
                    name: Sharq Dārfūr
                  - abbr: KN
                    name: Shiamāl Kurdufān
                  - abbr: SI
                    name: Sinnār
                  - abbr: DC
                    name: Wasaţ Dārfūr Zālinjay
                - iso: SE
                  iso3: SWE
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: K
                    name: Blekinge län
                  - abbr: W
                    name: Dalarnas län
                  - abbr: I
                    name: Gotlands län
                  - abbr: X
                    name: Gävleborgs län
                  - abbr: "N"
                    name: Hallands län
                  - abbr: Z
                    name: Jämtlands län
                  - abbr: F
                    name: Jönköpings län
                  - abbr: H
                    name: Kalmar län
                  - abbr: G
                    name: Kronobergs län
                  - abbr: BD
                    name: Norrbottens län
                  - abbr: M
                    name: Skåne län
                  - abbr: AB
                    name: Stockholms län
                  - abbr: D
                    name: Södermanlands län
                  - abbr: C
                    name: Uppsala län
                  - abbr: S
                    name: Värmlands län
                  - abbr: AC
                    name: Västerbottens län
                  - abbr: "Y"
                    name: Västernorrlands län
                  - abbr: U
                    name: Västmanlands län
                  - abbr: O
                    name: Västra Götalands län
                  - abbr: T
                    name: Örebro län
                  - abbr: E
                    name: Östergötlands län
                - iso: SG
                  iso3: SGP
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '01'
                    name: Central Singapore
                  - abbr: '02'
                    name: North East
                  - abbr: '03'
                    name: North West
                  - abbr: '04'
                    name: South East
                  - abbr: '05'
                    name: South West
                - iso: SH
                  iso3: SHN
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AC
                    name: Ascension
                  - abbr: HL
                    name: Saint Helena
                  - abbr: TA
                    name: Tristan da Cunha
                - iso: SI
                  iso3: SVN
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '001'
                    name: Ajdovšcina
                  - abbr: '002'
                    name: Beltinci
                  - abbr: '148'
                    name: Benedikt
                  - abbr: '149'
                    name: Bistrica ob Sotli
                  - abbr: '003'
                    name: Bled
                  - abbr: '150'
                    name: Bloke
                  - abbr: '004'
                    name: Bohinj
                  - abbr: '005'
                    name: Borovnica
                  - abbr: '006'
                    name: Bovec
                  - abbr: '151'
                    name: Braslovce
                  - abbr: '007'
                    name: Brda
                  - abbr: '008'
                    name: Brezovica
                  - abbr: '009'
                    name: Brežice
                  - abbr: '152'
                    name: Cankova
                  - abbr: '011'
                    name: Celje
                  - abbr: '012'
                    name: Cerklje na Gorenjskem
                  - abbr: '013'
                    name: Cerknica
                  - abbr: '014'
                    name: Cerkno
                  - abbr: '153'
                    name: Cerkvenjak
                  - abbr: '015'
                    name: Crenšovci
                  - abbr: '016'
                    name: Crna na Koroškem
                  - abbr: '017'
                    name: Crnomelj
                  - abbr: '018'
                    name: Destrnik
                  - abbr: '019'
                    name: Divaca
                  - abbr: '154'
                    name: Dobje
                  - abbr: '020'
                    name: Dobrepolje
                  - abbr: '155'
                    name: Dobrna
                  - abbr: '021'
                    name: Dobrova-Polhov Gradec
                  - abbr: '156'
                    name: Dobrovnik/Dobronak
                  - abbr: '022'
                    name: Dol pri Ljubljani
                  - abbr: '157'
                    name: Dolenjske Toplice
                  - abbr: '023'
                    name: Domžale
                  - abbr: '024'
                    name: Dornava
                  - abbr: '025'
                    name: Dravograd
                  - abbr: '026'
                    name: Duplek
                  - abbr: '027'
                    name: Gorenja vas-Poljane
                  - abbr: '028'
                    name: Gorišnica
                  - abbr: '029'
                    name: Gornja Radgona
                  - abbr: '030'
                    name: Gornji Grad
                  - abbr: '031'
                    name: Gornji Petrovci
                  - abbr: '158'
                    name: Grad
                  - abbr: '032'
                    name: Grosuplje
                  - abbr: '159'
                    name: Hajdina
                  - abbr: '160'
                    name: Hoce-Slivnica
                  - abbr: '161'
                    name: Hodoš/Hodos
                  - abbr: '162'
                    name: Horjul
                  - abbr: '034'
                    name: Hrastnik
                  - abbr: '035'
                    name: Hrpelje-Kozina
                  - abbr: '036'
                    name: Idrija
                  - abbr: '037'
                    name: Ig
                  - abbr: '038'
                    name: Ilirska Bistrica
                  - abbr: '039'
                    name: Ivancna Gorica
                  - abbr: '040'
                    name: Izola/Isola
                  - abbr: '041'
                    name: Jesenice
                  - abbr: '163'
                    name: Jezersko
                  - abbr: '042'
                    name: Juršinci
                  - abbr: '043'
                    name: Kamnik
                  - abbr: '044'
                    name: Kanal
                  - abbr: '045'
                    name: Kidricevo
                  - abbr: '046'
                    name: Kobarid
                  - abbr: '047'
                    name: Kobilje
                  - abbr: '048'
                    name: Kocevje
                  - abbr: '049'
                    name: Komen
                  - abbr: '164'
                    name: Komenda
                  - abbr: '050'
                    name: Koper/Capodistria
                  - abbr: '165'
                    name: Kostel
                  - abbr: '051'
                    name: Kozje
                  - abbr: '052'
                    name: Kranj
                  - abbr: '053'
                    name: Kranjska Gora
                  - abbr: '166'
                    name: Križevci
                  - abbr: '054'
                    name: Krško
                  - abbr: '055'
                    name: Kungota
                  - abbr: '056'
                    name: Kuzma
                  - abbr: '057'
                    name: Laško
                  - abbr: '058'
                    name: Lenart
                  - abbr: '059'
                    name: Lendava/Lendva
                  - abbr: '060'
                    name: Litija
                  - abbr: '061'
                    name: Ljubljana
                  - abbr: '062'
                    name: Ljubno
                  - abbr: '063'
                    name: Ljutomer
                  - abbr: '064'
                    name: Logatec
                  - abbr: '167'
                    name: Lovrenc na Pohorju
                  - abbr: '065'
                    name: Loška dolina
                  - abbr: '066'
                    name: Loški Potok
                  - abbr: '067'
                    name: Luce
                  - abbr: '068'
                    name: Lukovica
                  - abbr: '069'
                    name: Majšperk
                  - abbr: '070'
                    name: Maribor
                  - abbr: '168'
                    name: Markovci
                  - abbr: '071'
                    name: Medvode
                  - abbr: '072'
                    name: Mengeš
                  - abbr: '073'
                    name: Metlika
                  - abbr: '074'
                    name: Mežica
                  - abbr: '169'
                    name: Miklavž na Dravskem polju
                  - abbr: '075'
                    name: Miren-Kostanjevica
                  - abbr: '212'
                    name: Mirna
                  - abbr: '170'
                    name: Mirna Pec
                  - abbr: '076'
                    name: Mislinja
                  - abbr: '077'
                    name: Moravce
                  - abbr: '078'
                    name: Moravske Toplice
                  - abbr: '079'
                    name: Mozirje
                  - abbr: '080'
                    name: Murska Sobota
                  - abbr: '081'
                    name: Muta
                  - abbr: '082'
                    name: Naklo
                  - abbr: '083'
                    name: Nazarje
                  - abbr: '084'
                    name: Nova Gorica
                  - abbr: '085'
                    name: Novo mesto
                  - abbr: '213'
                    name: Občina Ankaran
                  - abbr: '195'
                    name: Občina Apače
                  - abbr: '196'
                    name: Občina Cirkulane
                  - abbr: '207'
                    name: Občina Gorje
                  - abbr: '197'
                    name: Občina Kostanjevica na Krki
                  - abbr: '208'
                    name: Občina Log - Dragomer
                  - abbr: '198'
                    name: Občina Makole
                  - abbr: '199'
                    name: Občina Mokronog - Trebelno
                  - abbr: '200'
                    name: Občina Poljčane
                  - abbr: '201'
                    name: Občina Renče - Vogrsko
                  - abbr: '209'
                    name: Občina Rečica ob Savinji
                  - abbr: '202'
                    name: Občina Središče ob Dravi
                  - abbr: '203'
                    name: Občina Straža
                  - abbr: '204'
                    name: Občina Sveta Trojica v Slovenskih goricah
                  - abbr: '210'
                    name: Občina Sveti Jurij v Slovenskih goricah
                  - abbr: '205'
                    name: Občina Sveti Tomaž
                  - abbr: '211'
                    name: Občina Šentrupert
                  - abbr: '206'
                    name: Občina Šmarješke Toplice
                  - abbr: '086'
                    name: Odranci
                  - abbr: '171'
                    name: Oplotnica
                  - abbr: '087'
                    name: Ormož
                  - abbr: '088'
                    name: Osilnica
                  - abbr: '089'
                    name: Pesnica
                  - abbr: '090'
                    name: Piran/Pirano
                  - abbr: '091'
                    name: Pivka
                  - abbr: '092'
                    name: Podcetrtek
                  - abbr: '172'
                    name: Podlehnik
                  - abbr: '093'
                    name: Podvelka
                  - abbr: '173'
                    name: Polzela
                  - abbr: '094'
                    name: Postojna
                  - abbr: '174'
                    name: Prebold
                  - abbr: '095'
                    name: Preddvor
                  - abbr: '175'
                    name: Prevalje
                  - abbr: '096'
                    name: Ptuj
                  - abbr: '097'
                    name: Puconci
                  - abbr: '098'
                    name: Race-Fram
                  - abbr: '099'
                    name: Radece
                  - abbr: '100'
                    name: Radenci
                  - abbr: '101'
                    name: Radlje ob Dravi
                  - abbr: '102'
                    name: Radovljica
                  - abbr: '103'
                    name: Ravne na Koroškem
                  - abbr: '176'
                    name: Razkrižje
                  - abbr: '104'
                    name: Ribnica
                  - abbr: '177'
                    name: Ribnica na Pohorju
                  - abbr: '107'
                    name: Rogatec
                  - abbr: '106'
                    name: Rogaška Slatina
                  - abbr: '105'
                    name: Rogašovci
                  - abbr: '108'
                    name: Ruše
                  - abbr: '178'
                    name: Selnica ob Dravi
                  - abbr: '109'
                    name: Semic
                  - abbr: '110'
                    name: Sevnica
                  - abbr: '111'
                    name: Sežana
                  - abbr: '112'
                    name: Slovenj Gradec
                  - abbr: '113'
                    name: Slovenska Bistrica
                  - abbr: '114'
                    name: Slovenske Konjice
                  - abbr: '179'
                    name: Sodražica
                  - abbr: '180'
                    name: Solcava
                  - abbr: '115'
                    name: Starše
                  - abbr: '181'
                    name: Sveta Ana
                  - abbr: '182'
                    name: Sveti Andraž v Slovenskih goricah
                  - abbr: '116'
                    name: Sveti Jurij
                  - abbr: '184'
                    name: Tabor
                  - abbr: '010'
                    name: Tišina
                  - abbr: '128'
                    name: Tolmin
                  - abbr: '129'
                    name: Trbovlje
                  - abbr: '130'
                    name: Trebnje
                  - abbr: '185'
                    name: Trnovska vas
                  - abbr: '186'
                    name: Trzin
                  - abbr: '131'
                    name: Tržic
                  - abbr: '132'
                    name: Turnišce
                  - abbr: '133'
                    name: Velenje
                  - abbr: '187'
                    name: Velika Polana
                  - abbr: '134'
                    name: Velike Lašce
                  - abbr: '188'
                    name: Veržej
                  - abbr: '135'
                    name: Videm
                  - abbr: '136'
                    name: Vipava
                  - abbr: '137'
                    name: Vitanje
                  - abbr: '138'
                    name: Vodice
                  - abbr: '139'
                    name: Vojnik
                  - abbr: '189'
                    name: Vransko
                  - abbr: '140'
                    name: Vrhnika
                  - abbr: '141'
                    name: Vuzenica
                  - abbr: '142'
                    name: Zagorje ob Savi
                  - abbr: '143'
                    name: Zavrc
                  - abbr: '144'
                    name: Zrece
                  - abbr: '033'
                    name: Šalovci
                  - abbr: '183'
                    name: Šempeter-Vrtojba
                  - abbr: '117'
                    name: Šencur
                  - abbr: '118'
                    name: Šentilj
                  - abbr: '119'
                    name: Šentjernej
                  - abbr: '120'
                    name: Šentjur pri Celju
                  - abbr: '121'
                    name: Škocjan
                  - abbr: '122'
                    name: Škofja Loka
                  - abbr: '123'
                    name: Škofljica
                  - abbr: '124'
                    name: Šmarje pri Jelšah
                  - abbr: '125'
                    name: Šmartno ob Paki
                  - abbr: '194'
                    name: Šmartno pri Litiji
                  - abbr: '126'
                    name: Šoštanj
                  - abbr: '127'
                    name: Štore
                  - abbr: '190'
                    name: Žalec
                  - abbr: '146'
                    name: Železniki
                  - abbr: '191'
                    name: Žetale
                  - abbr: '147'
                    name: Žiri
                  - abbr: '192'
                    name: Žirovnica
                  - abbr: '193'
                    name: Žužemberk
                - iso: SJ
                  iso3: SJM
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: SK
                  iso3: SVK
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: BC
                    name: Banskobystrický kraj
                  - abbr: BL
                    name: Bratislavský kraj
                  - abbr: KI
                    name: Košický kraj
                  - abbr: NI
                    name: Nitriansky kraj
                  - abbr: PV
                    name: Prešovský kraj
                  - abbr: TC
                    name: Trenciansky kraj
                  - abbr: TA
                    name: Trnavský kraj
                  - abbr: ZI
                    name: Žilinský kraj
                - iso: SL
                  iso3: SLE
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: E
                    name: Eastern
                  - abbr: NW
                    name: North Western
                  - abbr: "N"
                    name: Northern
                  - abbr: S
                    name: Southern
                  - abbr: W
                    name: Western Area (Freetown)
                - iso: SM
                  iso3: SMR
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '01'
                    name: Acquaviva
                  - abbr: '06'
                    name: Borgo Maggiore
                  - abbr: '02'
                    name: Chiesanuova
                  - abbr: '03'
                    name: Domagnano
                  - abbr: '04'
                    name: Faetano
                  - abbr: '05'
                    name: Fiorentino
                  - abbr: '08'
                    name: Montegiardino
                  - abbr: '07'
                    name: San Marino
                  - abbr: '09'
                    name: Serravalle
                - iso: SN
                  iso3: SEN
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: DK
                    name: Dakar
                  - abbr: DB
                    name: Diourbel
                  - abbr: FK
                    name: Fatick
                  - abbr: KA
                    name: Kaffrine
                  - abbr: KL
                    name: Kaolack
                  - abbr: KD
                    name: Kolda
                  - abbr: KE
                    name: Kédougou
                  - abbr: LG
                    name: Louga
                  - abbr: MT
                    name: Matam
                  - abbr: SL
                    name: Saint-Louis
                  - abbr: SE
                    name: Sédhiou
                  - abbr: TC
                    name: Tambacounda
                  - abbr: TH
                    name: Thiès
                  - abbr: ZG
                    name: Ziguinchor
                - iso: SO
                  iso3: SOM
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: AW
                    name: Awdal
                  - abbr: BK
                    name: Bakool
                  - abbr: BN
                    name: Banaadir
                  - abbr: BR
                    name: Bari
                  - abbr: BY
                    name: Bay
                  - abbr: GA
                    name: Galguduud
                  - abbr: GE
                    name: Gedo
                  - abbr: HI
                    name: Hiiraan
                  - abbr: JD
                    name: Jubbada Dhexe
                  - abbr: JH
                    name: Jubbada Hoose
                  - abbr: MU
                    name: Mudug
                  - abbr: NU
                    name: Nugaal
                  - abbr: SA
                    name: Sanaag
                  - abbr: SD
                    name: Shabeellaha Dhexe
                  - abbr: SH
                    name: Shabeellaha Hoose
                  - abbr: SO
                    name: Sool
                  - abbr: TO
                    name: Togdheer
                  - abbr: WO
                    name: Woqooyi Galbeed
                - iso: SR
                  iso3: SUR
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: BR
                    name: Brokopondo
                  - abbr: CM
                    name: Commewijne
                  - abbr: CR
                    name: Coronie
                  - abbr: MA
                    name: Marowijne
                  - abbr: NI
                    name: Nickerie
                  - abbr: PR
                    name: Para
                  - abbr: PM
                    name: Paramaribo
                  - abbr: SA
                    name: Saramacca
                  - abbr: SI
                    name: Sipaliwini
                  - abbr: WA
                    name: Wanica
                - iso: SS
                  iso3: SSD
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: NU
                    name: أعالي النيل
                  - abbr: LK
                    name: البحيرات
                  - abbr: UY
                    name: الوحدة
                  - abbr: JG
                    name: جونقلي
                  - abbr: EE
                    name: شرق الاستوائية
                  - abbr: BN
                    name: شمال بحر الغزال
                  - abbr: EW
                    name: غرب الاستوائية
                  - abbr: BW
                    name: غرب بحر الغزال
                  - abbr: WR
                    name: واراب
                  - abbr: EC
                    name: وسط الاستوائية
                - iso: ST
                  iso3: STP
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: '02'
                    name: Cantagalo
                  - abbr: '03'
                    name: Caué
                  - abbr: '04'
                    name: Lembá
                  - abbr: '05'
                    name: Lobata
                  - abbr: '06'
                    name: Mé-Zóchi
                  - abbr: P
                    name: Príncipe
                  - abbr: '01'
                    name: Água Grande
                - iso: SV
                  iso3: SLV
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AH
                    name: Ahuachapán
                  - abbr: CA
                    name: Cabañas
                  - abbr: CH
                    name: Chalatenango
                  - abbr: CU
                    name: Cuscatlán
                  - abbr: LI
                    name: La Libertad
                  - abbr: PA
                    name: La Paz
                  - abbr: UN
                    name: La Unión
                  - abbr: MO
                    name: Morazán
                  - abbr: SM
                    name: San Miguel
                  - abbr: SS
                    name: San Salvador
                  - abbr: SV
                    name: San Vicente
                  - abbr: SA
                    name: Santa Ana
                  - abbr: SO
                    name: Sonsonate
                  - abbr: US
                    name: Usulután
                - iso: SX
                  iso3: SXM
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: SY
                  iso3: SYR
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: LA
                    name: Al Ladhiqiyah
                  - abbr: QU
                    name: Al Qunaytirah
                  - abbr: HA
                    name: Al Ḩasakah
                  - abbr: RA
                    name: Ar Raqqah
                  - abbr: SU
                    name: As Suwayda'
                  - abbr: DR
                    name: Dar'ā
                  - abbr: DY
                    name: Dayr az Zawr
                  - abbr: DI
                    name: Dimashq
                  - abbr: ID
                    name: Idlib
                  - abbr: RD
                    name: Rif Dimashq
                  - abbr: TA
                    name: Tartus
                  - abbr: HL
                    name: Ḩalab
                  - abbr: HM
                    name: Ḩamāh
                  - abbr: HI
                    name: Ḩimş
                - iso: SZ
                  iso3: SWZ
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: HH
                    name: Hhohho
                  - abbr: LU
                    name: Lubombo
                  - abbr: MA
                    name: Manzini
                  - abbr: SH
                    name: Shiselweni
                - iso: TC
                  iso3: TCA
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: TD
                  iso3: TCD
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: BA
                    name: Batha
                  - abbr: CB
                    name: Chari-Baguirmi
                  - abbr: GR
                    name: Guéra
                  - abbr: HL
                    name: Hadjer Lamis
                  - abbr: KA
                    name: Kanem
                  - abbr: LC
                    name: Lac
                  - abbr: LO
                    name: Logone-Occidental
                  - abbr: LR
                    name: Logone-Oriental
                  - abbr: MA
                    name: Mandoul
                  - abbr: ME
                    name: Mayo-Kébbi-Est
                  - abbr: MO
                    name: Mayo-Kébbi-Ouest
                  - abbr: MC
                    name: Moyen-Chari
                  - abbr: ND
                    name: Ndjamena
                  - abbr: OD
                    name: Ouaddaï
                  - abbr: SA
                    name: Salamat
                  - abbr: TA
                    name: Tandjilé
                  - abbr: WF
                    name: Wadi Fira
                  - abbr: EE
                    name: إنيدي الشرقية
                  - abbr: EO
                    name: إنيدي الغربية
                  - abbr: BG
                    name: بحر الغزال
                  - abbr: BO
                    name: منطقة بوركو
                  - abbr: TI
                    name: منطقة تبستي
                  - abbr: SI
                    name: منطقة سيلا
                - iso: TG
                  iso3: TGO
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: C
                    name: Centre
                  - abbr: K
                    name: Kara
                  - abbr: M
                    name: Maritime (Région)
                  - abbr: P
                    name: Plateaux
                  - abbr: S
                    name: Savannes
                - iso: TH
                  iso3: THA
                  states_required: true
                  zipcode_required: true
                  states:
                  - abbr: '37'
                    name: Amnat Charoen
                  - abbr: '15'
                    name: Ang Thong
                  - abbr: '31'
                    name: Buri Ram
                  - abbr: '24'
                    name: Chachoengsao
                  - abbr: '18'
                    name: Chai Nat
                  - abbr: '36'
                    name: Chaiyaphum
                  - abbr: '22'
                    name: Chanthaburi
                  - abbr: '50'
                    name: Chiang Mai
                  - abbr: '57'
                    name: Chiang Rai
                  - abbr: '20'
                    name: Chon Buri
                  - abbr: '86'
                    name: Chumphon
                  - abbr: '46'
                    name: Kalasin
                  - abbr: '62'
                    name: Kamphaeng Phet
                  - abbr: '71'
                    name: Kanchanaburi
                  - abbr: '40'
                    name: Khon Kaen
                  - abbr: '81'
                    name: Krabi
                  - abbr: '10'
                    name: Krung Thep Maha Nakhon [Bangkok]
                  - abbr: '52'
                    name: Lampang
                  - abbr: '51'
                    name: Lamphun
                  - abbr: '42'
                    name: Loei
                  - abbr: '16'
                    name: Lop Buri
                  - abbr: '58'
                    name: Mae Hong Son
                  - abbr: '44'
                    name: Maha Sarakham
                  - abbr: '49'
                    name: Mukdahan
                  - abbr: '26'
                    name: Nakhon Nayok
                  - abbr: '73'
                    name: Nakhon Pathom
                  - abbr: '48'
                    name: Nakhon Phanom
                  - abbr: '30'
                    name: Nakhon Ratchasima
                  - abbr: '60'
                    name: Nakhon Sawan
                  - abbr: '80'
                    name: Nakhon Si Thammarat
                  - abbr: '55'
                    name: Nan
                  - abbr: '96'
                    name: Narathiwat
                  - abbr: '39'
                    name: Nong Bua Lam Phu
                  - abbr: '43'
                    name: Nong Khai
                  - abbr: '12'
                    name: Nonthaburi
                  - abbr: '13'
                    name: Pathum Thani
                  - abbr: '94'
                    name: Pattani
                  - abbr: '82'
                    name: Phangnga
                  - abbr: '93'
                    name: Phatthalung
                  - abbr: S
                    name: Phatthaya
                  - abbr: '56'
                    name: Phayao
                  - abbr: '67'
                    name: Phetchabun
                  - abbr: '76'
                    name: Phetchaburi
                  - abbr: '66'
                    name: Phichit
                  - abbr: '65'
                    name: Phitsanulok
                  - abbr: '14'
                    name: Phra Nakhon Si Ayutthaya
                  - abbr: '54'
                    name: Phrae
                  - abbr: '83'
                    name: Phuket
                  - abbr: '25'
                    name: Prachin Buri
                  - abbr: '77'
                    name: Prachuap Khiri Khan
                  - abbr: '85'
                    name: Ranong
                  - abbr: '70'
                    name: Ratchaburi
                  - abbr: '21'
                    name: Rayong
                  - abbr: '45'
                    name: Roi Et
                  - abbr: '27'
                    name: Sa Kaeo
                  - abbr: '47'
                    name: Sakon Nakhon
                  - abbr: '11'
                    name: Samut Prakan
                  - abbr: '74'
                    name: Samut Sakhon
                  - abbr: '75'
                    name: Samut Songkhram
                  - abbr: '19'
                    name: Saraburi
                  - abbr: '91'
                    name: Satun
                  - abbr: '33'
                    name: Si Sa Ket
                  - abbr: '17'
                    name: Sing Buri
                  - abbr: '90'
                    name: Songkhla
                  - abbr: '64'
                    name: Sukhothai
                  - abbr: '72'
                    name: Suphan Buri
                  - abbr: '84'
                    name: Surat Thani
                  - abbr: '32'
                    name: Surin
                  - abbr: '63'
                    name: Tak
                  - abbr: '92'
                    name: Trang
                  - abbr: '23'
                    name: Trat
                  - abbr: '34'
                    name: Ubon Ratchathani
                  - abbr: '41'
                    name: Udon Thani
                  - abbr: '61'
                    name: Uthai Thani
                  - abbr: '53'
                    name: Uttaradit
                  - abbr: '95'
                    name: Yala
                  - abbr: '35'
                    name: Yasothon
                  - abbr: '38'
                    name: จังหวัดบึงกาฬ
                - iso: TJ
                  iso3: TJK
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: DU
                    name: Dushanbe
                  - abbr: GB
                    name: Gorno-Badakhshan
                  - abbr: KT
                    name: Khatlon
                  - abbr: RA
                    name: Nohiyahoi Tobei Jumhurí
                  - abbr: SU
                    name: Sughd
                - iso: TK
                  iso3: TKL
                  states_required: false
                  zipcode_required: false
                  states: []
                - iso: TL
                  iso3: TLS
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: AL
                    name: Aileu
                  - abbr: AN
                    name: Ainaro
                  - abbr: BA
                    name: Baucau
                  - abbr: BO
                    name: Bobonaro
                  - abbr: CO
                    name: Cova Lima
                  - abbr: DI
                    name: Dili
                  - abbr: ER
                    name: Ermera
                  - abbr: LA
                    name: Lautem
                  - abbr: LI
                    name: Liquiça
                  - abbr: MT
                    name: Manatuto
                  - abbr: MF
                    name: Manufahi
                  - abbr: OE
                    name: Oecussi
                  - abbr: VI
                    name: Viqueque
                - iso: TM
                  iso3: TKM
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: A
                    name: Ahal
                  - abbr: S
                    name: Aşgabat
                  - abbr: B
                    name: Balkan
                  - abbr: D
                    name: Dasoguz
                  - abbr: L
                    name: Lebap
                  - abbr: M
                    name: Mary
                - iso: TN
                  iso3: TUN
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '13'
                    name: Ben Arous
                  - abbr: '23'
                    name: Bizerte
                  - abbr: '31'
                    name: Béja
                  - abbr: '81'
                    name: Gabès
                  - abbr: '71'
                    name: Gafsa
                  - abbr: '32'
                    name: Jendouba
                  - abbr: '41'
                    name: Kairouan
                  - abbr: '42'
                    name: Kasserine
                  - abbr: '73'
                    name: Kebili
                  - abbr: '12'
                    name: L'Ariana
                  - abbr: '14'
                    name: La Manouba
                  - abbr: '33'
                    name: Le Kef
                  - abbr: '53'
                    name: Mahdia
                  - abbr: '82'
                    name: Medenine
                  - abbr: '52'
                    name: Monastir
                  - abbr: '21'
                    name: Nabeul
                  - abbr: '61'
                    name: Sfax
                  - abbr: '43'
                    name: Sidi Bouzid
                  - abbr: '34'
                    name: Siliana
                  - abbr: '51'
                    name: Sousse
                  - abbr: '83'
                    name: Tataouine
                  - abbr: '72'
                    name: Tozeur
                  - abbr: '11'
                    name: Tunis
                  - abbr: '22'
                    name: Zaghouan
                - iso: TO
                  iso3: TON
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: '01'
                    name: "'Eua"
                  - abbr: '02'
                    name: Ha'apai
                  - abbr: '03'
                    name: Niuas
                  - abbr: '04'
                    name: Tongatapu
                  - abbr: '05'
                    name: Vava'u
                - iso: TR
                  iso3: TUR
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '01'
                    name: Adana
                  - abbr: '02'
                    name: Adıyaman
                  - abbr: '03'
                    name: Afyon
                  - abbr: '68'
                    name: Aksaray
                  - abbr: '05'
                    name: Amasya
                  - abbr: '06'
                    name: Ankara
                  - abbr: '07'
                    name: Antalya
                  - abbr: '75'
                    name: Ardahan
                  - abbr: '08'
                    name: Artvin
                  - abbr: '09'
                    name: Aydın
                  - abbr: '04'
                    name: Ağrı
                  - abbr: '10'
                    name: Balıkesir
                  - abbr: '74'
                    name: Bartın
                  - abbr: '72'
                    name: Batman
                  - abbr: '69'
                    name: Bayburt
                  - abbr: '11'
                    name: Bilecik
                  - abbr: '12'
                    name: Bingöl
                  - abbr: '13'
                    name: Bitlis
                  - abbr: '14'
                    name: Bolu
                  - abbr: '15'
                    name: Burdur
                  - abbr: '16'
                    name: Bursa
                  - abbr: '20'
                    name: Denizli
                  - abbr: '21'
                    name: Diyarbakır
                  - abbr: '81'
                    name: Düzce
                  - abbr: '22'
                    name: Edirne
                  - abbr: '23'
                    name: Elazığ
                  - abbr: '24'
                    name: Erzincan
                  - abbr: '25'
                    name: Erzurum
                  - abbr: '26'
                    name: Eskişehir
                  - abbr: '27'
                    name: Gaziantep
                  - abbr: '28'
                    name: Giresun
                  - abbr: '29'
                    name: Gümüşhane
                  - abbr: '30'
                    name: Hakkâri
                  - abbr: '31'
                    name: Hatay
                  - abbr: '32'
                    name: Isparta
                  - abbr: '76'
                    name: Iğdır
                  - abbr: '46'
                    name: Kahramanmaraş
                  - abbr: '78'
                    name: Karabük
                  - abbr: '70'
                    name: Karaman
                  - abbr: '36'
                    name: Kars
                  - abbr: '37'
                    name: Kastamonu
                  - abbr: '38'
                    name: Kayseri
                  - abbr: '79'
                    name: Kilis
                  - abbr: '41'
                    name: Kocaeli
                  - abbr: '42'
                    name: Konya
                  - abbr: '43'
                    name: Kütahya
                  - abbr: '39'
                    name: Kırklareli
                  - abbr: '71'
                    name: Kırıkkale
                  - abbr: '40'
                    name: Kırşehir
                  - abbr: '44'
                    name: Malatya
                  - abbr: '45'
                    name: Manisa
                  - abbr: '47'
                    name: Mardin
                  - abbr: '48'
                    name: Muğla
                  - abbr: '49'
                    name: Muş
                  - abbr: '50'
                    name: Nevşehir
                  - abbr: '51'
                    name: Niğde
                  - abbr: '52'
                    name: Ordu
                  - abbr: '80'
                    name: Osmaniye
                  - abbr: '53'
                    name: Rize
                  - abbr: '54'
                    name: Sakarya
                  - abbr: '55'
                    name: Samsun
                  - abbr: '56'
                    name: Siirt
                  - abbr: '57'
                    name: Sinop
                  - abbr: '58'
                    name: Sivas
                  - abbr: '59'
                    name: Tekirdağ
                  - abbr: '60'
                    name: Tokat
                  - abbr: '61'
                    name: Trabzon
                  - abbr: '62'
                    name: Tunceli
                  - abbr: '64'
                    name: Uşak
                  - abbr: '65'
                    name: Van
                  - abbr: '77'
                    name: Yalova
                  - abbr: '66'
                    name: Yozgat
                  - abbr: '67'
                    name: Zonguldak
                  - abbr: '17'
                    name: Çanakkale
                  - abbr: '18'
                    name: Çankırı
                  - abbr: '19'
                    name: Çorum
                  - abbr: '34'
                    name: İstanbul
                  - abbr: '35'
                    name: İzmir
                  - abbr: '33'
                    name: İçel
                  - abbr: '63'
                    name: Şanlıurfa
                  - abbr: '73'
                    name: Şırnak
                - iso: TT
                  iso3: TTO
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: ARI
                    name: Arima
                  - abbr: CHA
                    name: Chaguanas
                  - abbr: CTT
                    name: Couva-Tabaquite-Talparo
                  - abbr: DMN
                    name: Diego Martin
                  - abbr: MRC
                    name: Mayaro-Rio Claro
                  - abbr: PED
                    name: Penal-Debe
                  - abbr: PTF
                    name: Point Fortin
                  - abbr: POS
                    name: Port of Spain
                  - abbr: PRT
                    name: Princes Town
                  - abbr: SFO
                    name: San Fernando
                  - abbr: SJL
                    name: San Juan-Laventille
                  - abbr: SGE
                    name: Sangre Grande
                  - abbr: SIP
                    name: Siparia
                  - abbr: TOB
                    name: Tobago
                  - abbr: TUP
                    name: Tunapuna-Piarco
                - iso: TV
                  iso3: TUV
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: FUN
                    name: Funafuti
                  - abbr: NMG
                    name: Nanumanga
                  - abbr: NMA
                    name: Nanumea
                  - abbr: NIT
                    name: Niutao
                  - abbr: NUI
                    name: Nui
                  - abbr: NKF
                    name: Nukufetau
                  - abbr: NKL
                    name: Nukulaelae
                  - abbr: VAI
                    name: Vaitupu
                - iso: TW
                  iso3: TWN
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: CHA
                    name: Changhua
                  - abbr: CYQ
                    name: Chiayi
                  - abbr: CYI
                    name: Chiayi Municipality
                  - abbr: HSQ
                    name: Hsinchu
                  - abbr: HSZ
                    name: Hsinchu Municipality
                  - abbr: HUA
                    name: Hualien
                  - abbr: ILA
                    name: Ilan
                  - abbr: KHH
                    name: Kaohsiung Special Municipality
                  - abbr: KEE
                    name: Keelung Municipality
                  - abbr: MIA
                    name: Miaoli
                  - abbr: NAN
                    name: Nantou
                  - abbr: NWT
                    name: New Taipei
                  - abbr: PEN
                    name: Penghu
                  - abbr: PIF
                    name: Pingtung
                  - abbr: TXG
                    name: Taichung Municipality
                  - abbr: TNN
                    name: Tainan Municipality
                  - abbr: TPE
                    name: Taipei Special Municipality
                  - abbr: TTT
                    name: Taitung
                  - abbr: TAO
                    name: Taoyuan
                  - abbr: YUN
                    name: Yunlin
                  - abbr: LIE
                    name: 連江縣
                  - abbr: KIN
                    name: 金門縣
                - iso: TZ
                  iso3: TZA
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: '01'
                    name: Arusha
                  - abbr: '02'
                    name: Dar es Salaam
                  - abbr: '03'
                    name: Dodoma
                  - abbr: '04'
                    name: Iringa
                  - abbr: '05'
                    name: Kagera
                  - abbr: '06'
                    name: Kaskazini Pemba
                  - abbr: '07'
                    name: Kaskazini Unguja
                  - abbr: '08'
                    name: Kigoma
                  - abbr: '09'
                    name: Kilimanjaro
                  - abbr: '10'
                    name: Kusini Pemba
                  - abbr: '11'
                    name: Kusini Unguja
                  - abbr: '12'
                    name: Lindi
                  - abbr: '26'
                    name: Manyara
                  - abbr: '13'
                    name: Mara
                  - abbr: '14'
                    name: Mbeya
                  - abbr: '15'
                    name: Mjini Magharibi
                  - abbr: '27'
                    name: Mkoa wa Geita
                  - abbr: '28'
                    name: Mkoa wa Katavi
                  - abbr: '29'
                    name: Mkoa wa Njombe
                  - abbr: '30'
                    name: Mkoa wa Simiyu
                  - abbr: '16'
                    name: Morogoro
                  - abbr: '17'
                    name: Mtwara
                  - abbr: '18'
                    name: Mwanza
                  - abbr: '19'
                    name: Pwani
                  - abbr: '20'
                    name: Rukwa
                  - abbr: '21'
                    name: Ruvuma
                  - abbr: '22'
                    name: Shinyanga
                  - abbr: '23'
                    name: Singida
                  - abbr: '31'
                    name: Songwe
                  - abbr: '24'
                    name: Tabora
                  - abbr: '25'
                    name: Tanga
                - iso: UA
                  iso3: UKR
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '71'
                    name: Cherkas'ka Oblast'
                  - abbr: '74'
                    name: Chernihivs'ka Oblast'
                  - abbr: '77'
                    name: Chernivets'ka Oblast'
                  - abbr: '12'
                    name: Dnipropetrovs'ka Oblast'
                  - abbr: '14'
                    name: Donets'ka Oblast'
                  - abbr: '26'
                    name: Ivano-Frankivs'ka Oblast'
                  - abbr: '63'
                    name: Kharkivs'ka Oblast'
                  - abbr: '65'
                    name: Khersons'ka Oblast'
                  - abbr: '68'
                    name: Khmel'nyts'ka Oblast'
                  - abbr: '35'
                    name: Kirovohrads'ka Oblast'
                  - abbr: '30'
                    name: Kyïv
                  - abbr: '32'
                    name: Kyïvs'ka Oblast'
                  - abbr: '46'
                    name: L'vivs'ka Oblast'
                  - abbr: '09'
                    name: Luhans'ka Oblast'
                  - abbr: '48'
                    name: Mykolaïvs'ka Oblast'
                  - abbr: '51'
                    name: Odes'ka Oblast'
                  - abbr: '53'
                    name: Poltavs'ka Oblast'
                  - abbr: '43'
                    name: Respublika Krym
                  - abbr: '56'
                    name: Rivnens'ka Oblast'
                  - abbr: '40'
                    name: Sevastopol'
                  - abbr: '59'
                    name: Sums'ka Oblast'
                  - abbr: '61'
                    name: Ternopil's'ka Oblast'
                  - abbr: '05'
                    name: Vinnyts'ka Oblast'
                  - abbr: '07'
                    name: Volyns'ka Oblast'
                  - abbr: '21'
                    name: Zakarpats'ka Oblast'
                  - abbr: '23'
                    name: Zaporiz'ka Oblast'
                  - abbr: '18'
                    name: Zhytomyrs'ka Oblast'
                - iso: UG
                  iso3: UGA
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: '317'
                    name: Abim
                  - abbr: '301'
                    name: Adjumani
                  - abbr: '322'
                    name: Agago
                  - abbr: '323'
                    name: Alebtong
                  - abbr: '314'
                    name: Amolatar
                  - abbr: '324'
                    name: Amudat
                  - abbr: '216'
                    name: Amuria
                  - abbr: '319'
                    name: Amuru
                  - abbr: '302'
                    name: Apac
                  - abbr: '303'
                    name: Arua
                  - abbr: '217'
                    name: Budaka
                  - abbr: '223'
                    name: Bududa
                  - abbr: '201'
                    name: Bugiri
                  - abbr: '235'
                    name: Bugweri
                  - abbr: '420'
                    name: Buhweju
                  - abbr: '117'
                    name: Buikwe
                  - abbr: '224'
                    name: Bukedea
                  - abbr: '118'
                    name: Bukomansibi
                  - abbr: '218'
                    name: Bukwa
                  - abbr: '225'
                    name: Bulambuli
                  - abbr: '419'
                    name: Buliisa
                  - abbr: '401'
                    name: Bundibugyo
                  - abbr: '430'
                    name: Bunyangabu
                  - abbr: '402'
                    name: Bushenyi
                  - abbr: '202'
                    name: Busia
                  - abbr: '219'
                    name: Butaleja
                  - abbr: '119'
                    name: Butambala
                  - abbr: '233'
                    name: Butebo
                  - abbr: '120'
                    name: Buvuma
                  - abbr: '226'
                    name: Buyende
                  - abbr: C
                    name: Central
                  - abbr: '318'
                    name: Dokolo
                  - abbr: E
                    name: Eastern
                  - abbr: '121'
                    name: Gomba
                  - abbr: '304'
                    name: Gulu
                  - abbr: '403'
                    name: Hoima
                  - abbr: '416'
                    name: Ibanda
                  - abbr: '203'
                    name: Iganga
                  - abbr: '417'
                    name: Isingiro
                  - abbr: '204'
                    name: Jinja
                  - abbr: '315'
                    name: Kaabong
                  - abbr: '404'
                    name: Kabale
                  - abbr: '405'
                    name: Kabarole
                  - abbr: '213'
                    name: Kaberamaido
                  - abbr: '427'
                    name: Kagadi
                  - abbr: '428'
                    name: Kakumiro
                  - abbr: '237'
                    name: Kalaki
                  - abbr: '101'
                    name: Kalangala
                  - abbr: '220'
                    name: Kaliro
                  - abbr: '122'
                    name: Kalungu
                  - abbr: '102'
                    name: Kampala
                  - abbr: '205'
                    name: Kamuli
                  - abbr: '413'
                    name: Kamwenge
                  - abbr: '414'
                    name: Kanungu
                  - abbr: '206'
                    name: Kapchorwa
                  - abbr: '236'
                    name: Kapelebyong
                  - abbr: '335'
                    name: Karenga
                  - abbr: '126'
                    name: Kasanda
                  - abbr: '406'
                    name: Kasese
                  - abbr: '207'
                    name: Katakwi
                  - abbr: '112'
                    name: Kayunga
                  - abbr: '433'
                    name: Kazo
                  - abbr: '407'
                    name: Kibaale
                  - abbr: '103'
                    name: Kiboga
                  - abbr: '227'
                    name: Kibuku
                  - abbr: '432'
                    name: Kikuube
                  - abbr: '418'
                    name: Kiruhura
                  - abbr: '421'
                    name: Kiryandongo
                  - abbr: '408'
                    name: Kisoro
                  - abbr: '434'
                    name: Kitagwenda
                  - abbr: '305'
                    name: Kitgum
                  - abbr: '316'
                    name: Koboko
                  - abbr: '325'
                    name: Kole
                  - abbr: '306'
                    name: Kotido
                  - abbr: '208'
                    name: Kumi
                  - abbr: '333'
                    name: Kwania
                  - abbr: '228'
                    name: Kween
                  - abbr: '123'
                    name: Kyankwanzi
                  - abbr: '422'
                    name: Kyegegwa
                  - abbr: '415'
                    name: Kyenjojo
                  - abbr: '125'
                    name: Kyotera
                  - abbr: '326'
                    name: Lamwo
                  - abbr: '307'
                    name: Lira
                  - abbr: '229'
                    name: Luuka
                  - abbr: '104'
                    name: Luwero
                  - abbr: '124'
                    name: Lwengo
                  - abbr: '116'
                    name: Lyantonde
                  - abbr: '336'
                    name: Madi-Okollo
                  - abbr: '221'
                    name: Manafwa
                  - abbr: '320'
                    name: Maracha
                  - abbr: '105'
                    name: Masaka
                  - abbr: '409'
                    name: Masindi
                  - abbr: '214'
                    name: Mayuge
                  - abbr: '209'
                    name: Mbale
                  - abbr: '410'
                    name: Mbarara
                  - abbr: '423'
                    name: Mitooma
                  - abbr: '114'
                    name: Mityana
                  - abbr: '308'
                    name: Moroto
                  - abbr: '309'
                    name: Moyo
                  - abbr: '106'
                    name: Mpigi
                  - abbr: '107'
                    name: Mubende
                  - abbr: '108'
                    name: Mukono
                  - abbr: '334'
                    name: Nabilatuk
                  - abbr: '311'
                    name: Nakapiripirit
                  - abbr: '115'
                    name: Nakaseke
                  - abbr: '109'
                    name: Nakasongola
                  - abbr: '230'
                    name: Namayingo
                  - abbr: '234'
                    name: Namisindwa
                  - abbr: '222'
                    name: Namutumba
                  - abbr: '327'
                    name: Napak
                  - abbr: '310'
                    name: Nebbi
                  - abbr: '231'
                    name: Ngora
                  - abbr: "N"
                    name: Northern
                  - abbr: '424'
                    name: Ntoroko
                  - abbr: '411'
                    name: Ntungamo
                  - abbr: '328'
                    name: Nwoya
                  - abbr: '337'
                    name: Obongi
                  - abbr: '329'
                    name: Otuke
                  - abbr: '321'
                    name: Oyam
                  - abbr: '312'
                    name: Pader
                  - abbr: '332'
                    name: Pakwach
                  - abbr: '210'
                    name: Pallisa
                  - abbr: '110'
                    name: Rakai
                  - abbr: '429'
                    name: Rubanda
                  - abbr: '425'
                    name: Rubirizi
                  - abbr: '431'
                    name: Rukiga
                  - abbr: '412'
                    name: Rukungiri
                  - abbr: '435'
                    name: Rwampara
                  - abbr: '111'
                    name: Sembabule
                  - abbr: '232'
                    name: Serere
                  - abbr: '426'
                    name: Sheema
                  - abbr: '215'
                    name: Sironko
                  - abbr: '211'
                    name: Soroti
                  - abbr: '212'
                    name: Tororo
                  - abbr: '113'
                    name: Wakiso
                  - abbr: W
                    name: Western
                  - abbr: '313'
                    name: Yumbe
                  - abbr: '331'
                    name: Zombo
                  - abbr: '330'
                    name: Zombo²
                - iso: US
                  iso3: USA
                  states_required: true
                  zipcode_required: true
                  states:
                  - abbr: AL
                    name: Alabama
                  - abbr: AK
                    name: Alaska
                  - abbr: AZ
                    name: Arizona
                  - abbr: AR
                    name: Arkansas
                  - abbr: AA
                    name: Armed Forces Americas
                  - abbr: AE
                    name: Armed Forces Europe
                  - abbr: AP
                    name: Armed Forces Pacific
                  - abbr: CA
                    name: California
                  - abbr: CO
                    name: Colorado
                  - abbr: CT
                    name: Connecticut
                  - abbr: DE
                    name: Delaware
                  - abbr: DC
                    name: District of Columbia
                  - abbr: FL
                    name: Florida
                  - abbr: GA
                    name: Georgia
                  - abbr: HI
                    name: Hawaii
                  - abbr: ID
                    name: Idaho
                  - abbr: IL
                    name: Illinois
                  - abbr: IN
                    name: Indiana
                  - abbr: IA
                    name: Iowa
                  - abbr: KS
                    name: Kansas
                  - abbr: KY
                    name: Kentucky
                  - abbr: LA
                    name: Louisiana
                  - abbr: ME
                    name: Maine
                  - abbr: MD
                    name: Maryland
                  - abbr: MA
                    name: Massachusetts
                  - abbr: MI
                    name: Michigan
                  - abbr: MN
                    name: Minnesota
                  - abbr: MS
                    name: Mississippi
                  - abbr: MO
                    name: Missouri
                  - abbr: MT
                    name: Montana
                  - abbr: NE
                    name: Nebraska
                  - abbr: NV
                    name: Nevada
                  - abbr: NH
                    name: New Hampshire
                  - abbr: NJ
                    name: New Jersey
                  - abbr: NM
                    name: New Mexico
                  - abbr: NY
                    name: New York
                  - abbr: NC
                    name: North Carolina
                  - abbr: ND
                    name: North Dakota
                  - abbr: OH
                    name: Ohio
                  - abbr: OK
                    name: Oklahoma
                  - abbr: OR
                    name: Oregon
                  - abbr: PA
                    name: Pennsylvania
                  - abbr: RI
                    name: Rhode Island
                  - abbr: SC
                    name: South Carolina
                  - abbr: SD
                    name: South Dakota
                  - abbr: TN
                    name: Tennessee
                  - abbr: TX
                    name: Texas
                  - abbr: UT
                    name: Utah
                  - abbr: VT
                    name: Vermont
                  - abbr: VA
                    name: Virginia
                  - abbr: WA
                    name: Washington
                  - abbr: WV
                    name: West Virginia
                  - abbr: WI
                    name: Wisconsin
                  - abbr: WY
                    name: Wyoming
                - iso: UY
                  iso3: URY
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AR
                    name: Artigas
                  - abbr: CA
                    name: Canelones
                  - abbr: CL
                    name: Cerro Lago
                  - abbr: CO
                    name: Colonia
                  - abbr: DU
                    name: Durazno
                  - abbr: FS
                    name: Flores
                  - abbr: FD
                    name: Florida
                  - abbr: LA
                    name: Lavalleja
                  - abbr: MA
                    name: Maldonado
                  - abbr: MO
                    name: Montevideo
                  - abbr: PA
                    name: Paysandú
                  - abbr: RV
                    name: Rivera
                  - abbr: RO
                    name: Rocha
                  - abbr: RN
                    name: Río Negro
                  - abbr: SA
                    name: Salto
                  - abbr: SJ
                    name: San José
                  - abbr: SO
                    name: Soriano
                  - abbr: TA
                    name: Tacuarembó
                  - abbr: TT
                    name: Treinta y Tres
                - iso: UZ
                  iso3: UZB
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AN
                    name: Andijon
                  - abbr: BU
                    name: Buxoro
                  - abbr: FA
                    name: Farg‘ona
                  - abbr: JI
                    name: Jizzax
                  - abbr: NG
                    name: Namangan
                  - abbr: NW
                    name: Navoiy
                  - abbr: QA
                    name: Qashqadaryo
                  - abbr: QR
                    name: Qoraqalpog‘iston Respublikasi
                  - abbr: SA
                    name: Samarqand
                  - abbr: SI
                    name: Sirdaryo
                  - abbr: SU
                    name: Surxondaryo
                  - abbr: TO
                    name: Toshkent
                  - abbr: TK
                    name: Toshkent City
                  - abbr: XO
                    name: Xorazm
                - iso: VA
                  iso3: VAT
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: VC
                  iso3: VCT
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '01'
                    name: Charlotte
                  - abbr: '06'
                    name: Grenadines
                  - abbr: '02'
                    name: Saint Andrew
                  - abbr: '03'
                    name: Saint David
                  - abbr: '04'
                    name: Saint George
                  - abbr: '05'
                    name: Saint Patrick
                - iso: VE
                  iso3: VEN
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: Z
                    name: Amazonas
                  - abbr: B
                    name: Anzoátegui
                  - abbr: C
                    name: Apure
                  - abbr: D
                    name: Aragua
                  - abbr: E
                    name: Barinas
                  - abbr: F
                    name: Bolívar
                  - abbr: G
                    name: Carabobo
                  - abbr: H
                    name: Cojedes
                  - abbr: "Y"
                    name: Delta Amacuro
                  - abbr: W
                    name: Dependencias Federales
                  - abbr: A
                    name: Distrito Federal
                  - abbr: I
                    name: Falcón
                  - abbr: J
                    name: Guárico
                  - abbr: K
                    name: Lara
                  - abbr: M
                    name: Miranda
                  - abbr: "N"
                    name: Monagas
                  - abbr: L
                    name: Mérida
                  - abbr: O
                    name: Nueva Esparta
                  - abbr: P
                    name: Portuguesa
                  - abbr: R
                    name: Sucre
                  - abbr: T
                    name: Trujillo
                  - abbr: S
                    name: Táchira
                  - abbr: X
                    name: Vargas
                  - abbr: U
                    name: Yaracuy
                  - abbr: V
                    name: Zulia
                - iso: VG
                  iso3: VGB
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: VI
                  iso3: VIR
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: VN
                  iso3: VNM
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '44'
                    name: An Giang
                  - abbr: '43'
                    name: Ba Ria - Vung Tau
                  - abbr: '53'
                    name: Bac Can
                  - abbr: '54'
                    name: Bac Giang
                  - abbr: '55'
                    name: Bac Lieu
                  - abbr: '56'
                    name: Bac Ninh
                  - abbr: '50'
                    name: Ben Tre
                  - abbr: '31'
                    name: Binh Dinh
                  - abbr: '57'
                    name: Binh Duong
                  - abbr: '58'
                    name: Binh Phuoc
                  - abbr: '40'
                    name: Binh Thuan
                  - abbr: '59'
                    name: Ca Mau
                  - abbr: CT
                    name: Can Tho
                  - abbr: '04'
                    name: Cao Bang
                  - abbr: DN
                    name: Da Nang
                  - abbr: '33'
                    name: Dac Lac
                  - abbr: '72'
                    name: Dak Nong
                  - abbr: '71'
                    name: Dien Bien
                  - abbr: '39'
                    name: Dong Nai
                  - abbr: '45'
                    name: Dong Thap
                  - abbr: '30'
                    name: Gia Lai
                  - abbr: '03'
                    name: Ha Giang
                  - abbr: '63'
                    name: Ha Nam
                  - abbr: HN
                    name: Ha Noi
                  - abbr: '23'
                    name: Ha Tinh
                  - abbr: '61'
                    name: Hai Duong
                  - abbr: HP
                    name: Hai Phong
                  - abbr: '73'
                    name: Hau Giang
                  - abbr: SG
                    name: Ho Chi Minh
                  - abbr: '14'
                    name: Hoa Binh
                  - abbr: '66'
                    name: Hung Yen
                  - abbr: '34'
                    name: Khanh Hoa
                  - abbr: '47'
                    name: Kien Giang
                  - abbr: '28'
                    name: Kon Tum
                  - abbr: '01'
                    name: Lai Chau
                  - abbr: '35'
                    name: Lam Dong
                  - abbr: '09'
                    name: Lang Son
                  - abbr: '02'
                    name: Lao Cai
                  - abbr: '41'
                    name: Long An
                  - abbr: '67'
                    name: Nam Dinh
                  - abbr: '22'
                    name: Nghe An
                  - abbr: '18'
                    name: Ninh Binh
                  - abbr: '36'
                    name: Ninh Thuan
                  - abbr: '68'
                    name: Phu Tho
                  - abbr: '32'
                    name: Phu Yen
                  - abbr: '24'
                    name: Quang Binh
                  - abbr: '27'
                    name: Quang Nam
                  - abbr: '29'
                    name: Quang Ngai
                  - abbr: '13'
                    name: Quang Ninh
                  - abbr: '25'
                    name: Quang Tri
                  - abbr: '52'
                    name: Soc Trang
                  - abbr: '05'
                    name: Son La
                  - abbr: '37'
                    name: Tay Ninh
                  - abbr: '20'
                    name: Thai Binh
                  - abbr: '69'
                    name: Thai Nguyen
                  - abbr: '21'
                    name: Thanh Hoa
                  - abbr: '26'
                    name: Thua Thien-Hue
                  - abbr: '46'
                    name: Tien Giang
                  - abbr: '51'
                    name: Tra Vinh
                  - abbr: '07'
                    name: Tuyen Quang
                  - abbr: '49'
                    name: Vinh Long
                  - abbr: '70'
                    name: Vinh Phuc
                  - abbr: '06'
                    name: Yen Bai
                - iso: VU
                  iso3: VUT
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: MAP
                    name: Malampa
                  - abbr: PAM
                    name: Pénama
                  - abbr: SAM
                    name: Sanma
                  - abbr: SEE
                    name: Shéfa
                  - abbr: TAE
                    name: Taféa
                  - abbr: TOB
                    name: Torba
                - iso: WF
                  iso3: WLF
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AL
                    name: Alo
                  - abbr: SG
                    name: Sigave
                  - abbr: UV
                    name: Uvea
                - iso: WS
                  iso3: WSM
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: AA
                    name: A'ana
                  - abbr: AL
                    name: Aiga-i-le-Tai
                  - abbr: AT
                    name: Atua
                  - abbr: FA
                    name: Fa'asaleleaga
                  - abbr: GE
                    name: Gaga'emauga
                  - abbr: GI
                    name: Gagaifomauga
                  - abbr: PA
                    name: Palauli
                  - abbr: SA
                    name: Satupa'itea
                  - abbr: TU
                    name: Tuamasaga
                  - abbr: VF
                    name: Va'a-o-Fonoti
                  - abbr: VS
                    name: Vaisigano
                - iso: YE
                  iso3: YEM
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: AM
                    name: "'Amran"
                  - abbr: AB
                    name: Abyan
                  - abbr: DA
                    name: Ad¸ D¸ali'
                  - abbr: BA
                    name: Al Bayḑā’
                  - abbr: JA
                    name: Al Jawf
                  - abbr: MR
                    name: Al Mahrah
                  - abbr: MW
                    name: Al Mahwit
                  - abbr: HU
                    name: Al Ḩudaydah
                  - abbr: DH
                    name: Dhamar
                  - abbr: HD
                    name: Hadramawt
                  - abbr: HJ
                    name: Hajjah
                  - abbr: IB
                    name: Ibb
                  - abbr: LA
                    name: Laḩij
                  - abbr: MA
                    name: Ma'rib
                  - abbr: SD
                    name: Sa`dah
                  - abbr: SN
                    name: Sanʿā
                  - abbr: SH
                    name: Shabwah
                  - abbr: TA
                    name: Taʿizz
                  - abbr: AD
                    name: ʿAdan
                  - abbr: SA
                    name: صنعاء
                  - abbr: SU
                    name: محافظة أرخبيل سقطرى
                  - abbr: RA
                    name: محافظة ريمة
                - iso: YT
                  iso3: MYT
                  states_required: false
                  zipcode_required: true
                  states: []
                - iso: ZA
                  iso3: ZAF
                  states_required: true
                  zipcode_required: true
                  states:
                  - abbr: EC
                    name: Eastern Cape
                  - abbr: FS
                    name: Free State
                  - abbr: GP
                    name: Gauteng
                  - abbr: ZN
                    name: KwaZulu-Natal
                  - abbr: LP
                    name: Limpopo
                  - abbr: MP
                    name: Mpumalanga
                  - abbr: NW
                    name: North West
                  - abbr: NC
                    name: Northern Cape
                  - abbr: WC
                    name: Western Cape
                - iso: ZM
                  iso3: ZMB
                  states_required: false
                  zipcode_required: true
                  states:
                  - abbr: '02'
                    name: Central
                  - abbr: '08'
                    name: Copperbelt
                  - abbr: '03'
                    name: Eastern
                  - abbr: '04'
                    name: Luapula
                  - abbr: '09'
                    name: Lusaka
                  - abbr: '10'
                    name: Muchinga
                  - abbr: '06'
                    name: North-Western
                  - abbr: '05'
                    name: Northern
                  - abbr: '07'
                    name: Southern
                  - abbr: '01'
                    name: Western
                - iso: ZW
                  iso3: ZWE
                  states_required: false
                  zipcode_required: false
                  states:
                  - abbr: BU
                    name: Bulawayo
                  - abbr: HA
                    name: Harare
                  - abbr: MA
                    name: Manicaland
                  - abbr: MC
                    name: Mashonaland Central
                  - abbr: ME
                    name: Mashonaland East
                  - abbr: MW
                    name: Mashonaland West
                  - abbr: MV
                    name: Masvingo
                  - abbr: MN
                    name: Matabeleland North
                  - abbr: MS
                    name: Matabeleland South
                  - abbr: MI
                    name: Midlands
                meta:
                  count: 240
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/Country"
                  meta:
                    type: object
                    properties:
                      count:
                        type: integer
                        example: 250
                    required:
                    - count
                required:
                - data
                - meta
  "/api/v3/seller/delivery_methods":
    get:
      summary: List delivery methods
      tags:
      - Delivery Methods
      security:
      - bearer_auth: []
      description: |
        How this seller's goods can ship: the methods they created themselves,
        plus any the marketplace shares with its sellers.

        A shared marketplace method comes back with `editable: false` — it is
        listed so the seller can see what already ships their goods, and every
        write 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-Id
        in: header
        required: true
        schema:
          type: string
      - name: q[search]
        in: query
        required: false
        schema:
          type: string
        description: Matches any of name (partial, case-insensitive).
      - name: page
        in: query
        required: false
        description: Page number
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        description: Records per page (max 100)
        schema:
          type: integer
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[name_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `available_to_sellers` | True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `seller_id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `storefront_visible` | True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `available_to_sellers`, `created_at`, `id`, `name`, `seller_id`, `storefront_visible`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: DeliveryMethod
        sortable:
        - available_to_sellers
        - created_at
        - id
        - name
        - seller_id
        - storefront_visible
        - updated_at
      responses:
        '200':
          description: delivery methods listed
          content:
            application/json:
              example:
                data:
                - id: dm_UkLWZg9DAJ
                  name: My courier
                  code: UPS_GROUND_118
                  estimated_transit_business_days_min:
                  estimated_transit_business_days_max:
                  digital: false
                  pickup: false
                  pickup_point: false
                  admin_name:
                  storefront_visible: true
                  tracking_url:
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  rules: []
                  editable: true
                  delivery_profile_id: fp_UkLWZg9DAJ
                  delivery_zone_id:
                  calculator:
                    type: flat_rate
                    preferences:
                      amounts: {}
                      amount: '10.00'
                      currency: USD
                - id: dm_gbHJdmfrXB
                  name: Marketplace post
                  code: UPS_GROUND_119
                  estimated_transit_business_days_min:
                  estimated_transit_business_days_max:
                  digital: false
                  pickup: false
                  pickup_point: false
                  admin_name:
                  storefront_visible: true
                  tracking_url:
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  rules: []
                  editable: false
                  delivery_profile_id: fp_UkLWZg9DAJ
                  delivery_zone_id:
                  calculator:
                    type: flat_rate
                    preferences:
                      amounts: {}
                      amount: '10.00'
                      currency: USD
                meta:
                  page: 1
                  limit: 25
                  count: 2
                  pages: 1
                  from: 1
                  to: 2
                  in: 2
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/DeliveryMethod"
                  meta:
                    "$ref": "#/components/schemas/PaginationMeta"
                required:
                - data
                - meta
    post:
      summary: Create a delivery method
      tags:
      - Delivery Methods
      security:
      - bearer_auth: []
      description: |
        Adds a way for this seller to ship. The method is always the seller's
        own, whatever the payload says.

        Neither the rate provider nor the fulfillment provider is settable: a
        seller 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '201':
          description: delivery method created
          content:
            application/json:
              example:
                id: dm_EfhxLZ9ck8
                name: Next day
                code:
                estimated_transit_business_days_min:
                estimated_transit_business_days_max:
                digital: false
                pickup: false
                pickup_point: false
                admin_name:
                storefront_visible: true
                tracking_url:
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                rules: []
                editable: true
                delivery_profile_id: fp_gbHJdmfrXB
                delivery_zone_id:
                calculator:
                  type: flat_rate
                  preferences:
                    amounts: {}
                    amount: '9.99'
                    currency: USD
              schema:
                "$ref": "#/components/schemas/DeliveryMethod"
        '422':
          description: invalid request
          content:
            application/json:
              example:
                error:
                  code: validation_error
                  message: Name can't be blank
                  details:
                    name:
                    - can't be blank
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/DeliveryMethodCreateParams"
        required: true
  "/api/v3/seller/delivery_methods/{id}":
    parameters:
    - name: id
      in: path
      description: Delivery method ID
      required: true
      schema:
        type: string
    - name: X-Spree-Seller-Id
      in: header
      required: true
      schema:
        type: string
    get:
      summary: Retrieve a delivery method
      tags:
      - Delivery Methods
      security:
      - 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
          content:
            application/json:
              example:
                id: dm_UkLWZg9DAJ
                name: My courier
                code: UPS_GROUND_124
                estimated_transit_business_days_min:
                estimated_transit_business_days_max:
                digital: false
                pickup: false
                pickup_point: false
                admin_name:
                storefront_visible: true
                tracking_url:
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                rules: []
                editable: true
                delivery_profile_id: fp_UkLWZg9DAJ
                delivery_zone_id:
                calculator:
                  type: flat_rate
                  preferences:
                    amounts: {}
                    amount: '10.00'
                    currency: USD
              schema:
                "$ref": "#/components/schemas/DeliveryMethod"
    patch:
      summary: Update a delivery method
      tags:
      - Delivery Methods
      security:
      - bearer_auth: []
      description: Only the seller's own methods can be changed — a marketplace method
        shared 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':
          description: delivery method updated
          content:
            application/json:
              example:
                id: dm_UkLWZg9DAJ
                name: My express courier
                code: UPS_GROUND_126
                estimated_transit_business_days_min:
                estimated_transit_business_days_max:
                digital: false
                pickup: false
                pickup_point: false
                admin_name:
                storefront_visible: true
                tracking_url:
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                rules: []
                editable: true
                delivery_profile_id: fp_UkLWZg9DAJ
                delivery_zone_id:
                calculator:
                  type: flat_rate
                  preferences:
                    amounts: {}
                    amount: '10.00'
                    currency: USD
              schema:
                "$ref": "#/components/schemas/DeliveryMethod"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/DeliveryMethodUpdateParams"
        required: true
    delete:
      summary: Retire a delivery method
      tags:
      - Delivery Methods
      security:
      - 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
  "/api/v3/seller/delivery_methods/rule_types":
    get:
      summary: List the conditions a method can carry
      tags:
      - Delivery Methods
      security:
      - bearer_auth: []
      description: The eligibility rules a seller may put on their own method, with
        the 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: rule types listed
          content:
            application/json:
              example:
                data:
                - type: item_total_rule
                  name: Item total
                  description: Limits the delivery method to carts within an item
                    total range
                  schema:
                    type: object
                    properties:
                      minimum_amount:
                        type:
                        - string
                        - 'null'
                        format: money
                        pattern: "^-?\\d+(\\.\\d+)?$"
                      maximum_amount:
                        type:
                        - string
                        - 'null'
                        format: money
                        pattern: "^-?\\d+(\\.\\d+)?$"
                    additionalProperties: false
                - type: weight_rule
                  name: Weight
                  description: Limits the delivery method to packages within a weight
                    range
                  schema:
                    type: object
                    properties:
                      minimum_weight:
                        type:
                        - string
                        - 'null'
                        pattern: "^-?\\d+(\\.\\d+)?$"
                      maximum_weight:
                        type:
                        - string
                        - 'null'
                        pattern: "^-?\\d+(\\.\\d+)?$"
                    additionalProperties: false
                - type: volume_rule
                  name: Volume
                  description: Limits the delivery method to shipments within a volume
                    range, in cubic meters
                  schema:
                    type: object
                    properties:
                      minimum_volume:
                        type:
                        - string
                        - 'null'
                        pattern: "^-?\\d+(\\.\\d+)?$"
                      maximum_volume:
                        type:
                        - string
                        - 'null'
                        pattern: "^-?\\d+(\\.\\d+)?$"
                    additionalProperties: false
                - type: company_rule
                  name: Company
                  description: Offers the delivery method only to orders placed for
                    a company, or only to orders that are not
                  schema:
                    type: object
                    properties:
                      company_orders_only:
                        type: boolean
                        default: true
                    additionalProperties: false
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                        name:
                          type: string
                        description:
                          type: string
                        schema:
                          type: object
                          description: JSON Schema of the type's `preferences`
                required:
                - data
  "/api/v3/seller/delivery_methods/calculators":
    get:
      summary: List the ways a method can be priced
      tags:
      - Delivery Methods
      security:
      - 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: calculators listed
          content:
            application/json:
              example:
                data:
                - type: flat_percent_item_total
                  name: Flat Percent
                  schema:
                    type: object
                    properties:
                      flat_percent:
                        type: string
                        pattern: "^-?\\d+(\\.\\d+)?$"
                        default: '0'
                    additionalProperties: false
                - type: flat_rate
                  name: Flat rate
                  schema:
                    type: object
                    properties:
                      amounts:
                        type: object
                        propertyNames:
                          type: string
                          format: currency
                          pattern: "^[A-Z]{3}$"
                        additionalProperties:
                          type: string
                          format: money
                          pattern: "^-?\\d+(\\.\\d+)?$"
                        default: {}
                      amount:
                        type:
                        - string
                        - 'null'
                        format: money
                        pattern: "^-?\\d+(\\.\\d+)?$"
                        default: '0'
                      currency:
                        type: string
                        format: currency
                        pattern: "^[A-Z]{3}$"
                    additionalProperties: false
                - type: flexi_rate
                  name: Flexible Rate per package item
                  schema:
                    type: object
                    properties:
                      first_item:
                        type: string
                        format: money
                        pattern: "^-?\\d+(\\.\\d+)?$"
                        default: '0'
                      additional_item:
                        type: string
                        format: money
                        pattern: "^-?\\d+(\\.\\d+)?$"
                        default: '0'
                      max_items:
                        type: integer
                        default: 0
                      currency:
                        type: string
                        format: currency
                        pattern: "^[A-Z]{3}$"
                    additionalProperties: false
                - type: per_item
                  name: Flat rate per package item
                  schema:
                    type: object
                    properties:
                      amounts:
                        type: object
                        propertyNames:
                          type: string
                          format: currency
                          pattern: "^[A-Z]{3}$"
                        additionalProperties:
                          type: string
                          format: money
                          pattern: "^-?\\d+(\\.\\d+)?$"
                        default: {}
                      amount:
                        type:
                        - string
                        - 'null'
                        format: money
                        pattern: "^-?\\d+(\\.\\d+)?$"
                        default: '0'
                      currency:
                        type: string
                        format: currency
                        pattern: "^[A-Z]{3}$"
                    additionalProperties: false
                - type: price_sack
                  name: Price sack
                  schema:
                    type: object
                    properties:
                      minimal_amount:
                        type: string
                        format: money
                        pattern: "^-?\\d+(\\.\\d+)?$"
                        default: '0'
                      normal_amount:
                        type: string
                        format: money
                        pattern: "^-?\\d+(\\.\\d+)?$"
                        default: '0'
                      discount_amount:
                        type: string
                        format: money
                        pattern: "^-?\\d+(\\.\\d+)?$"
                        default: '0'
                      currency:
                        type: string
                        format: currency
                        pattern: "^[A-Z]{3}$"
                    additionalProperties: false
                - type: digital_delivery
                  name: Digital Delivery
                  schema:
                    type: object
                    properties:
                      amounts:
                        type: object
                        propertyNames:
                          type: string
                          format: currency
                          pattern: "^[A-Z]{3}$"
                        additionalProperties:
                          type: string
                          format: money
                          pattern: "^-?\\d+(\\.\\d+)?$"
                        default: {}
                      amount:
                        type:
                        - string
                        - 'null'
                        format: money
                        pattern: "^-?\\d+(\\.\\d+)?$"
                        default: '0'
                      currency:
                        type: string
                        format: currency
                        pattern: "^[A-Z]{3}$"
                    additionalProperties: false
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                        name:
                          type: string
                        schema:
                          type: object
                          description: JSON Schema of the type's `preferences`
                required:
                - data
  "/api/v3/seller/delivery_profiles":
    get:
      summary: List delivery profiles
      tags:
      - Delivery Profiles
      security:
      - bearer_auth: []
      description: |
        The marketplace's delivery profiles — what kind of goods a product is
        (parcel, digital, pallet), which decides how it can be shipped.

        Read only. A seller assigns one to a product as `delivery_profile_id`;
        the profiles themselves, and the zones and methods behind them, are the
        marketplace's. A product created without one lands on the profile
        marked `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-Id
        in: header
        required: true
        schema:
          type: string
      - name: q[search]
        in: query
        required: false
        schema:
          type: string
        description: Matches any of name (partial, case-insensitive).
      - name: page
        in: query
        required: false
        description: Page number
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        description: Records per page (max 100)
        schema:
          type: integer
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[name_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `position` | Number | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `created_at`, `id`, `name`, `position`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: DeliveryProfile
        sortable:
        - created_at
        - id
        - name
        - position
        - updated_at
      responses:
        '200':
          description: delivery profiles listed
          content:
            application/json:
              example:
                data:
                - id: fp_UkLWZg9DAJ
                  name: General
                  default: true
                  digital: false
                - id: fp_gbHJdmfrXB
                  name: Oversized
                  default: false
                  digital: false
                meta:
                  page: 1
                  limit: 25
                  count: 2
                  pages: 1
                  from: 1
                  to: 2
                  in: 2
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/DeliveryProfile"
                  meta:
                    "$ref": "#/components/schemas/PaginationMeta"
                required:
                - data
                - meta
  "/api/v3/seller/delivery_zones":
    get:
      summary: List delivery zones
      tags:
      - Delivery Zones
      security:
      - bearer_auth: []
      description: |
        The marketplace's delivery zones — where its methods may ship to.

        Read only: a seller narrows their own method to one of these and never
        draws one. Pass `delivery_profile_id` to list only the zones under the
        profile a method belongs to, which is what the method form's picker
        asks 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-Id
        in: header
        required: true
        schema:
          type: string
      - name: delivery_profile_id
        in: query
        required: false
        description: Only zones under this delivery profile
        schema:
          type: string
      - name: page
        in: query
        required: false
        description: Page number
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        description: Records per page (max 100)
        schema:
          type: integer
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[name_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `delivery_profile_id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `created_at`, `delivery_profile_id`, `id`, `name`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: DeliveryZone
        sortable:
        - created_at
        - delivery_profile_id
        - id
        - name
        - updated_at
      responses:
        '200':
          description: delivery zones listed
          content:
            application/json:
              example:
                data:
                - id: dz_UkLWZg9DAJ
                  name: Domestic
                  description: Maxime illum debitis veritatis porro accusantium laudantium
                    omnis.
                  delivery_profile_id: fp_gbHJdmfrXB
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/DeliveryZone"
                  meta:
                    "$ref": "#/components/schemas/PaginationMeta"
                required:
                - data
                - meta
  "/api/v3/seller/onboarding":
    get:
      summary: Get onboarding checklist
      tags:
      - Onboarding
      security:
      - bearer_auth: []
      description: |
        What this marketplace asks of the seller before it will admit them.

        Singular: the checklist is always the acting seller's. Every answer is
        computed server-side by the same evaluator the operator's own view uses,
        so the panel and the operator can never show different progress.

        `progress` counts optional requirements too — it is how far along the
        checklist is, not how close to approval. Read `blocking` on each
        requirement for that.

        Each requirement's `id` is what a submission is posted against. A
        marketplace that asks for nothing returns an empty list, which is a
        complete 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: checklist returned
          content:
            application/json:
              example:
                status: approved
                progress:
                  done: 0
                  total: 0
                requirements: []
              schema:
                "$ref": "#/components/schemas/SellerOnboardingResponse"
        '403':
          description: no seller named, or not a member of it
          content:
            application/json:
              example:
                error:
                  code: access_denied
                  message: You do not have access to this seller.
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
  "/api/v3/seller/onboarding/submit_for_review":
    post:
      summary: Submit for review
      tags:
      - Onboarding
      security:
      - bearer_auth: []
      description: |
        Says the seller is ready, moving them from `onboarding` to
        `ready_for_review`.

        Refused with `422` when something required is still outstanding — the
        message names the blocking requirements, and the seller's status is
        unchanged. Returns the same payload as the checklist so the panel can
        re-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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: submitted for review
          content:
            application/json:
              example:
                status: ready_for_review
                progress:
                  done: 0
                  total: 0
                requirements: []
              schema:
                "$ref": "#/components/schemas/SellerOnboardingResponse"
        '422':
          description: something required is still outstanding
          content:
            application/json:
              example:
                error:
                  code: processing_error
                  message: Requirements Accept terms is not complete
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
  "/api/v3/seller/onboarding/payout_account":
    post:
      summary: Get a payout account link
      tags:
      - Onboarding
      security:
      - bearer_auth: []
      description: |
        A fresh link to wherever the marketplace's payout provider collects
        what it needs before it will pay this seller. Ask for it when the
        seller 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: payout account link
          content:
            application/json:
              example:
                url:
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/OnboardingPayoutAccountParams"
        required: true
  "/api/v3/seller/requirements/{requirement_id}/submissions":
    parameters:
    - name: requirement_id
      in: path
      description: Requirement ID, as returned by `GET /api/v3/seller/onboarding`
      required: true
      schema:
        type: string
    post:
      summary: Submit against a requirement
      tags:
      - Onboarding
      security:
      - bearer_auth: []
      description: |
        What the seller says about one requirement: an attestation they tick, a
        document they upload, a reference they paste.

        Create only. A submission records what was said and when, so a seller who
        needs to correct something submits again rather than editing, and the
        latest one counts.

        `file_signed_id` is the `signed_id` returned by
        `POST /api/v3/seller/files`, so the bytes are already in storage
        by the time this runs.

        An attestation is accepted on the spot; a requirement the operator
        reviews 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '201':
          description: submission recorded
          content:
            application/json:
              example:
                id: selsub_UkLWZg9DAJ
                status: accepted
                note: Confirmed.
                review_note:
                reference:
                reviewed_at: '2026-01-15T12:00:00.000Z'
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                file_url:
                file_name:
              schema:
                "$ref": "#/components/schemas/RequirementSubmission"
        '404':
          description: a requirement belonging to another marketplace
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Seller requirement not found
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/RequirementSubmissionParams"
        required: true
  "/api/v3/seller/requirement_submissions/{id}/download":
    parameters:
    - name: id
      in: path
      description: Submission ID
      required: true
      schema:
        type: string
    get:
      summary: Download a submitted document
      tags:
      - Onboarding
      security:
      - bearer_auth: []
      description: |
        Streams the file attached to one of this seller's submissions.

        Served through the API rather than from a storage URL on purpose: these
        are identity and registration documents, so every read is authorized
        against 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' },
            })
            if (!response.ok) throw new Error(`Download failed with status ${response.status}`)
            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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '404':
          description: another seller's submission
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Seller requirement submission not found
            application/octet-stream:
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
  "/api/v3/seller/policies":
    get:
      summary: List policies
      tags:
      - Policies
      security:
      - bearer_auth: []
      description: |
        This seller's own policy documents.

        Rooted in the acting seller, so the marketplace operator's store
        policies and every other seller's are invisible here. A seller starts
        with none: what they are expected to publish is decided by the
        marketplace'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-Id
        in: header
        required: true
        schema:
          type: string
      - name: q[search]
        in: query
        required: false
        schema:
          type: string
        description: Matches any of name (partial, case-insensitive).
      - name: page
        in: query
        required: false
        description: Page number
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        description: Records per page (max 100)
        schema:
          type: integer
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[name_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `owner_id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `owner_type` | Type | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `created_at`, `id`, `name`, `owner_id`, `owner_type`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: Policy
        sortable:
        - created_at
        - id
        - name
        - owner_id
        - owner_type
        - updated_at
      responses:
        '200':
          description: policies listed
          content:
            application/json:
              example:
                data:
                - id: pol_uw2YK1rnl0
                  name: Returns Policy
                  slug: returns-policy
                  body: Send anything back within 30 days.
                  body_html: "<p>Send anything back within 30 days.</p>"
                  updated_at: '2026-01-15T12:00:00.000Z'
                  created_at: '2026-01-15T12:00:00.000Z'
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/Policy"
                  meta:
                    "$ref": "#/components/schemas/PaginationMeta"
                required:
                - data
                - meta
    post:
      summary: Create a policy
      tags:
      - Policies
      security:
      - bearer_auth: []
      description: |
        Publishes one of this seller's policies. `body` accepts HTML and is
        sanitized before it is stored.

        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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '201':
          description: policy created
          content:
            application/json:
              example:
                id: pol_OIJLhNcSbf
                name: Shipping Policy
                slug: shipping-policy
                body: Orders leave the workshop within two working days.
                body_html: "<p>Orders leave the workshop within two working days.</p>"
                updated_at: '2026-01-15T12:00:00.000Z'
                created_at: '2026-01-15T12:00:00.000Z'
              schema:
                "$ref": "#/components/schemas/Policy"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/PolicyCreateParams"
        required: true
  "/api/v3/seller/policies/{id}":
    parameters:
    - name: id
      in: path
      required: true
      description: Policy prefixed ID or slug
      schema:
        type: string
    get:
      summary: Get a policy
      tags:
      - Policies
      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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: policy found
          content:
            application/json:
              example:
                id: pol_uw2YK1rnl0
                name: Returns Policy
                slug: returns-policy
                body: Send anything back within 30 days.
                body_html: "<p>Send anything back within 30 days.</p>"
                updated_at: '2026-01-15T12:00:00.000Z'
                created_at: '2026-01-15T12:00:00.000Z'
              schema:
                "$ref": "#/components/schemas/Policy"
        '404':
          description: policy not found
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Policy not found
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
    patch:
      summary: Update a policy
      tags:
      - Policies
      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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: policy updated
          content:
            application/json:
              example:
                id: pol_uw2YK1rnl0
                name: Returns Policy
                slug: returns-policy
                body: Send anything back within 60 days.
                body_html: "<p>Send anything back within 60 days.</p>"
                updated_at: '2026-01-15T12:00:00.000Z'
                created_at: '2026-01-15T12:00:00.000Z'
              schema:
                "$ref": "#/components/schemas/Policy"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/PolicyUpdateParams"
        required: true
    delete:
      summary: Delete a policy
      tags:
      - Policies
      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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '204':
          description: policy deleted
  "/api/v3/seller/product_types":
    get:
      summary: List product types
      tags:
      - Product Types
      security:
      - bearer_auth: []
      description: |
        The product types a seller may list a product against.

        Read only. A type is the template that hands a product its option types
        and its delivery profile, so a seller picks one when listing; defining
        types 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-Id
        in: header
        required: true
        schema:
          type: string
      - name: q[search]
        in: query
        required: false
        schema:
          type: string
        description: Matches any of name (partial, case-insensitive).
      - name: page
        in: query
        required: false
        description: Page number
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        description: Records per page (max 100)
        schema:
          type: integer
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[name_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `created_at`, `id`, `name`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: ProductType
        sortable:
        - created_at
        - id
        - name
        - updated_at
      responses:
        '200':
          description: product types listed
          content:
            application/json:
              example:
                data:
                - id: pt_UkLWZg9DAJ
                  name: Apparel
                  option_type_labels: []
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/ProductType"
                  meta:
                    "$ref": "#/components/schemas/PaginationMeta"
                required:
                - data
                - meta
  "/api/v3/seller/product_types/{id}":
    get:
      summary: Get a product type
      tags:
      - Product Types
      security:
      - 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-Id
        in: header
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: Product type ID
        schema:
          type: string
      responses:
        '200':
          description: product type found
          content:
            application/json:
              example:
                id: pt_UkLWZg9DAJ
                name: Apparel
                option_type_labels: []
              schema:
                "$ref": "#/components/schemas/ProductType"
  "/api/v3/seller/products/{product_id}/digital_assets":
    parameters:
    - name: product_id
      in: path
      required: true
      description: Product ID
      schema:
        type: string
    get:
      summary: List product digital assets
      tags:
      - Products
      security:
      - bearer_auth: []
      description: Returns the downloadable files on one of this seller's own products,
        oldest first.
      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: digitalAssets } = await client.products.digitalAssets.list('prod_UkLWZg9DAJ')
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: false
        description: Page number
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        description: Records per page (max 100)
        schema:
          type: integer
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[created_at_eq]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `created_at`, `id`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: DigitalAsset
        sortable:
        - created_at
        - id
        - updated_at
      responses:
        '200':
          description: digital assets found
          content:
            application/json:
              example:
                data:
                - id: dig_UkLWZg9DAJ
                  variant_id: variant_UkLWZg9DAJ
                  filename: thinking-cat.jpg
                  content_type: image/jpeg
                  authorized_clicks:
                  authorized_days:
                  byte_size: 18090
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  provider_type:
                  provider_name: File
                  download_url: http://www.example.com/rails/active_storage/disk/eyJfcmFpbHMiOnsiZGF0YSI6eyJrZXkiOiI1Z28wOGZsYWtwNXYyeG4yMGlueHZvbWwyZmRzIiwiZGlzcG9zaXRpb24iOiJhdHRhY2htZW50OyBmaWxlbmFtZT1cInRoaW5raW5nLWNhdC5qcGdcIjsgZmlsZW5hbWUqPVVURi04Jyd0aGlua2luZy1jYXQuanBnIiwiY29udGVudF90eXBlIjoiaW1hZ2UvanBlZyIsInNlcnZpY2VfbmFtZSI6InRlc3QifSwiZXhwIjoiMjAyNi0wMS0xNVQxMjowNTowMC4wMDBaIiwicHVyIjoiYmxvYl9rZXkifX0=--1adbb0b4aeb518c0dbf52eabec0c5343fb37f6a7/thinking-cat.jpg
                  effective_authorized_clicks: 5
                  effective_authorized_days: 7
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/DigitalAsset"
                  meta:
                    "$ref": "#/components/schemas/PaginationMeta"
                required:
                - data
                - meta
        '404':
          description: another seller's product
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Product not found
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
    post:
      summary: Create a product digital asset
      tags:
      - Products
      security:
      - bearer_auth: []
      description: |
        Attaches a downloadable file to one of the product's variants (the
        default variant when `variant_id` is omitted). Upload the file first
        through `POST /api/v3/seller/files` with `visibility: 'private'`, then
        send its `signed_id` here. Leave `authorized_clicks` and
        `authorized_days` out to use the marketplace's download settings.
      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',
          })

          // `signed_id` comes from `files.upload()` with `visibility: 'private'`.
          const digitalAsset = await client.products.digitalAssets.create('prod_UkLWZg9DAJ', {
            signed_id: 'eyJfcmFpbHMiOnsiZGF0YSI6MTIzfX0=--abc123',
            authorized_clicks: 5,
            authorized_days: 30,
          })
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '201':
          description: digital asset created
          content:
            application/json:
              example:
                id: dig_gbHJdmfrXB
                variant_id: variant_UkLWZg9DAJ
                filename: manual.pdf
                content_type: image/jpeg
                authorized_clicks: 5
                authorized_days: 30
                byte_size: 18090
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                provider_type:
                provider_name: File
                download_url: http://www.example.com/rails/active_storage/disk/eyJfcmFpbHMiOnsiZGF0YSI6eyJrZXkiOiJmZ201b2ZidHBzbWhpYnB1cXY1YndjcHZvbXR4IiwiZGlzcG9zaXRpb24iOiJhdHRhY2htZW50OyBmaWxlbmFtZT1cIm1hbnVhbC5wZGZcIjsgZmlsZW5hbWUqPVVURi04JydtYW51YWwucGRmIiwiY29udGVudF90eXBlIjoiaW1hZ2UvanBlZyIsInNlcnZpY2VfbmFtZSI6InRlc3QifSwiZXhwIjoiMjAyNi0wMS0xNVQxMjowNTowMC4wMDBaIiwicHVyIjoiYmxvYl9rZXkifX0=--4a809efdc2e6ec19eb62b2a074d48b25dcf95f88/manual.pdf
                effective_authorized_clicks: 5
                effective_authorized_days: 30
              schema:
                "$ref": "#/components/schemas/DigitalAsset"
        '422':
          description: no file sent
          content:
            application/json:
              example:
                error:
                  code: validation_error
                  message: Attachment can't be blank
                  details:
                    attachment:
                    - can't be blank
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/DigitalAssetCreateParams"
        required: true
  "/api/v3/seller/products/{product_id}/digital_assets/{id}":
    parameters:
    - name: product_id
      in: path
      required: true
      description: Product ID
      schema:
        type: string
    - name: id
      in: path
      required: true
      description: Digital asset ID
      schema:
        type: string
    get:
      summary: Get a product digital asset
      tags:
      - Products
      security:
      - 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 digitalAsset = await client.products.digitalAssets.get('prod_UkLWZg9DAJ', 'dig_k5nR8xLqPz')
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: digital asset found
          content:
            application/json:
              example:
                id: dig_UkLWZg9DAJ
                variant_id: variant_UkLWZg9DAJ
                filename: thinking-cat.jpg
                content_type: image/jpeg
                authorized_clicks:
                authorized_days:
                byte_size: 18090
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                provider_type:
                provider_name: File
                download_url: http://www.example.com/rails/active_storage/disk/eyJfcmFpbHMiOnsiZGF0YSI6eyJrZXkiOiIydGZoM2pnZnBnMGwwemF4NjU2OW0xd3Jud2lhIiwiZGlzcG9zaXRpb24iOiJhdHRhY2htZW50OyBmaWxlbmFtZT1cInRoaW5raW5nLWNhdC5qcGdcIjsgZmlsZW5hbWUqPVVURi04Jyd0aGlua2luZy1jYXQuanBnIiwiY29udGVudF90eXBlIjoiaW1hZ2UvanBlZyIsInNlcnZpY2VfbmFtZSI6InRlc3QifSwiZXhwIjoiMjAyNi0wMS0xNVQxMjowNTowMC4wMDBaIiwicHVyIjoiYmxvYl9rZXkifX0=--f6c26021324728070070e91a164fcd2996107d5d/thinking-cat.jpg
                effective_authorized_clicks: 5
                effective_authorized_days: 7
              schema:
                "$ref": "#/components/schemas/DigitalAsset"
    patch:
      summary: Update a product digital asset
      tags:
      - Products
      security:
      - bearer_auth: []
      description: |
        Changes a file's download limits, or replaces it with a new private
        `signed_id`. Links customers already received keep working and serve
        the new file.
      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',
          })

          // `null` falls back to the marketplace's download settings.
          const digitalAsset = await client.products.digitalAssets.update(
            'prod_UkLWZg9DAJ',
            'dig_k5nR8xLqPz',
            { authorized_clicks: 10, authorized_days: null },
          )
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: digital asset updated
          content:
            application/json:
              example:
                id: dig_UkLWZg9DAJ
                variant_id: variant_UkLWZg9DAJ
                filename: thinking-cat.jpg
                content_type: image/jpeg
                authorized_clicks: 10
                authorized_days:
                byte_size: 18090
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                provider_type:
                provider_name: File
                download_url: http://www.example.com/rails/active_storage/disk/eyJfcmFpbHMiOnsiZGF0YSI6eyJrZXkiOiJmbHRwbWl6azhucWZlb2JjY2EyNzM2N2EzdDV1IiwiZGlzcG9zaXRpb24iOiJhdHRhY2htZW50OyBmaWxlbmFtZT1cInRoaW5raW5nLWNhdC5qcGdcIjsgZmlsZW5hbWUqPVVURi04Jyd0aGlua2luZy1jYXQuanBnIiwiY29udGVudF90eXBlIjoiaW1hZ2UvanBlZyIsInNlcnZpY2VfbmFtZSI6InRlc3QifSwiZXhwIjoiMjAyNi0wMS0xNVQxMjowNTowMC4wMDBaIiwicHVyIjoiYmxvYl9rZXkifX0=--80e4a4219f2521a2e065aed66845d0d9bb4291a3/thinking-cat.jpg
                effective_authorized_clicks: 10
                effective_authorized_days: 7
              schema:
                "$ref": "#/components/schemas/DigitalAsset"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/DigitalAssetUpdateParams"
        required: true
    delete:
      summary: Delete a product digital asset
      tags:
      - Products
      security:
      - bearer_auth: []
      description: Removes the file. Customers who already bought it can no longer
        download 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',
          })

          await client.products.digitalAssets.delete('prod_UkLWZg9DAJ', 'dig_k5nR8xLqPz')
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '204':
          description: digital asset deleted
  "/api/v3/seller/products":
    get:
      summary: List products
      tags:
      - Products
      security:
      - bearer_auth: []
      description: |
        The seller's own catalog — the products they own outright.

        Every call is rooted in the acting seller server-side, so this can never
        return another seller's product or one the marketplace operator sells
        first-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-Id
        in: header
        required: true
        schema:
          type: string
      - name: q[search]
        in: query
        required: false
        schema:
          type: string
        description: Matches product name or variant SKU (partial, case-insensitive),
          and the store's searchable custom fields.
      - name: q[ascend_by_price]
        in: query
        required: false
        schema:
          type: boolean
        description: Set to `true` to apply `ascend_by_price`.
      - name: q[descend_by_price]
        in: query
        required: false
        schema:
          type: boolean
        description: Set to `true` to apply `descend_by_price`.
      - name: q[in_categories][]
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
        description: Applies `in_categories` to the given value.
      - name: q[in_category]
        in: query
        required: false
        schema:
          type: string
        description: Applies `in_category` to the given value.
      - name: q[in_collection]
        in: query
        required: false
        schema:
          type: string
        description: Applies `in_collection` to the given value.
      - name: q[in_stock]
        in: query
        required: false
        schema:
          type: boolean
        description: Set to `true` to apply `in_stock`.
      - name: q[in_taxon]
        in: query
        required: false
        schema:
          type: string
        description: Applies `in_taxon` to the given value.
      - name: q[not_discontinued]
        in: query
        required: false
        schema:
          type: boolean
        description: Set to `true` to apply `not_discontinued`.
      - name: q[out_of_stock]
        in: query
        required: false
        schema:
          type: boolean
        description: Set to `true` to apply `out_of_stock`.
      - name: q[price_between][]
        in: query
        required: false
        schema:
          type: array
          items:
            type: number
          minItems: 2
          maxItems: 2
        description: Applies `price_between` to the given value.
      - name: q[price_gte]
        in: query
        required: false
        schema:
          type: number
        description: Applies `price_gte` to the given value.
      - name: q[price_lte]
        in: query
        required: false
        schema:
          type: number
        description: Applies `price_lte` to the given value.
      - name: q[search_by_name]
        in: query
        required: false
        schema:
          type: string
        description: Applies `search_by_name` to the given value.
      - name: q[with_option_value_ids][]
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
        description: Applies `with_option_value_ids` to the given value.
      - name: page
        in: query
        required: false
        description: Page number
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        description: Records per page (max 100)
        schema:
          type: integer
      - name: sort
        in: query
        required: false
        description: Sort field; prefix with `-` for descending
        schema:
          type: string
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[name_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `available_on` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `description` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `discontinue_on` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `price` | Amount | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `seller_id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `slug` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `status` | One of `draft`, `active`, `archived`, `proposed`, `rejected` | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `available_on`, `created_at`, `description`, `discontinue_on`, `id`, `name`, `price`, `seller_id`, `slug`, `status`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: Product
        sortable:
        - available_on
        - created_at
        - description
        - discontinue_on
        - id
        - name
        - price
        - seller_id
        - slug
        - status
        - updated_at
      responses:
        '200':
          description: products listed
          content:
            application/json:
              example:
                data:
                - id: prod_UkLWZg9DAJ
                  name: Product 2923250
                  slug: product-2923250
                  meta_title:
                  meta_description:
                  meta_keywords:
                  variant_count: 1
                  available_on:
                  preorder_ships_at:
                  purchasable: true
                  preorder: false
                  in_stock: false
                  backorderable: true
                  available: true
                  description: Maiores ut qui dolores ab autem. Architecto quos sequi
                    minus debitis tempora molestiae. Quasi officiis minus voluptatum
                    eveniet incidunt. Nisi laboriosam a aliquam eveniet occaecati
                    ducimus. Provident quo amet nostrum sed assumenda cum odio. Distinctio
                    perferendis quasi nisi exercitationem veritatis minima esse. In
                    velit at corporis nobis. Voluptate mollitia nam pariatur enim.
                    Recusandae necessitatibus earum deserunt sapiente eveniet quidem
                    unde. Consectetur ab perspiciatis veniam dolor tempora. Omnis
                    odit autem quae repellat. Delectus corrupti ea nisi reiciendis
                    atque iure a molestias. Repellendus laboriosam sint molestias
                    debitis in. Minima omnis accusantium modi accusamus doloribus
                    fugit. Accusamus autem sequi perferendis saepe quos perspiciatis.
                  description_html: |-
                    Maiores ut qui dolores ab autem. Architecto quos sequi minus debitis tempora molestiae. Quasi officiis minus voluptatum eveniet incidunt. Nisi laboriosam a aliquam eveniet occaecati ducimus. Provident quo amet nostrum sed assumenda cum odio.
                    Distinctio perferendis quasi nisi exercitationem veritatis minima esse. In velit at corporis nobis. Voluptate mollitia nam pariatur enim. Recusandae necessitatibus earum deserunt sapiente eveniet quidem unde.
                    Consectetur ab perspiciatis veniam dolor tempora. Omnis odit autem quae repellat. Delectus corrupti ea nisi reiciendis atque iure a molestias.
                    Repellendus laboriosam sint molestias debitis in. Minima omnis accusantium modi accusamus doloribus fugit. Accusamus autem sequi perferendis saepe quos perspiciatis.
                  default_variant_id: variant_UkLWZg9DAJ
                  buy_box_variant_id: variant_UkLWZg9DAJ
                  thumbnail_url:
                  tags: []
                  price:
                    id: price_UkLWZg9DAJ
                    currency: USD
                    amount: '19.99'
                    compare_at_amount:
                    price_list_id:
                  original_price:
                  seller_id: sel_UkLWZg9DAJ
                  status: active
                  metadata: {}
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  product_type_id:
                  delivery_profile_id: fp_UkLWZg9DAJ
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/Product"
                  meta:
                    "$ref": "#/components/schemas/PaginationMeta"
                required:
                - data
                - meta
    post:
      summary: Create a product
      tags:
      - Products
      security:
      - bearer_auth: []
      description: |
        Creates a product owned by the acting seller.

        The seller and the store are taken from the request context whatever the
        payload says, so a product cannot be created against another seller.

        The operator's own settings — tax category, delivery profile and whether
        the product is promotionable — are not writable here; they belong to the
        marketplace, 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '201':
          description: product created
          content:
            application/json:
              example:
                id: prod_gbHJdmfrXB
                name: Hand-thrown mug
                slug: hand-thrown-mug
                meta_title:
                meta_description:
                meta_keywords:
                variant_count: 0
                available_on:
                preorder_ships_at:
                purchasable: false
                preorder: false
                in_stock: false
                backorderable: false
                available: false
                description:
                description_html:
                default_variant_id: variant_gbHJdmfrXB
                buy_box_variant_id: variant_gbHJdmfrXB
                thumbnail_url:
                tags: []
                price:
                  id: price_gbHJdmfrXB
                  currency: USD
                  amount: '24.00'
                  compare_at_amount:
                  price_list_id:
                original_price:
                seller_id: sel_UkLWZg9DAJ
                status: draft
                metadata: {}
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                product_type_id:
                delivery_profile_id: fp_UkLWZg9DAJ
              schema:
                "$ref": "#/components/schemas/Product"
        '422':
          description: validation failed
          content:
            application/json:
              example:
                error:
                  code: validation_error
                  message: Name can't be blank
                  details:
                    name:
                    - can't be blank
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ProductCreateParams"
        required: true
  "/api/v3/seller/products/{id}":
    parameters:
    - name: id
      in: path
      description: Product ID
      required: true
      schema:
        type: string
    get:
      summary: Get a product
      tags:
      - Products
      security:
      - bearer_auth: []
      description: |
        A product the acting seller owns.

        An id belonging to another seller answers `404`, not `403` — the seller
        is 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: product returned
          content:
            application/json:
              example:
                id: prod_UkLWZg9DAJ
                name: Product 2956710
                slug: product-2956710
                meta_title:
                meta_description:
                meta_keywords:
                variant_count: 1
                available_on:
                preorder_ships_at:
                purchasable: true
                preorder: false
                in_stock: false
                backorderable: true
                available: true
                description: Aliquid voluptate laudantium necessitatibus quidem eaque.
                  Sapiente at autem eveniet exercitationem odio in dolores. Laborum
                  accusantium nulla autem tempora qui inventore assumenda molestiae.
                  Quisquam voluptas delectus ipsum totam ab incidunt. Sunt excepturi
                  eius provident unde neque in. Earum pariatur enim odit delectus
                  accusamus recusandae. Dolorem eligendi debitis iste voluptate laboriosam
                  ab. Ab aut suscipit illo occaecati. Dolores libero cupiditate provident
                  at itaque temporibus. Adipisci iste beatae quibusdam perferendis
                  ea blanditiis saepe facilis.
                description_html: |-
                  Aliquid voluptate laudantium necessitatibus quidem eaque. Sapiente at autem eveniet exercitationem odio in dolores. Laborum accusantium nulla autem tempora qui inventore assumenda molestiae. Quisquam voluptas delectus ipsum totam ab incidunt. Sunt excepturi eius provident unde neque in.
                  Earum pariatur enim odit delectus accusamus recusandae. Dolorem eligendi debitis iste voluptate laboriosam ab. Ab aut suscipit illo occaecati. Dolores libero cupiditate provident at itaque temporibus. Adipisci iste beatae quibusdam perferendis ea blanditiis saepe facilis.
                default_variant_id: variant_UkLWZg9DAJ
                buy_box_variant_id: variant_UkLWZg9DAJ
                thumbnail_url:
                tags: []
                price:
                  id: price_UkLWZg9DAJ
                  currency: USD
                  amount: '19.99'
                  compare_at_amount:
                  price_list_id:
                original_price:
                seller_id: sel_UkLWZg9DAJ
                status: active
                metadata: {}
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                product_type_id:
                delivery_profile_id: fp_UkLWZg9DAJ
              schema:
                "$ref": "#/components/schemas/Product"
        '404':
          description: another seller's product
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Product not found
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
    patch:
      summary: Update a product
      tags:
      - Products
      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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: product updated
          content:
            application/json:
              example:
                id: prod_UkLWZg9DAJ
                name: Hand-thrown mug, large
                slug: product-2988212
                meta_title:
                meta_description:
                meta_keywords:
                variant_count: 1
                available_on:
                preorder_ships_at:
                purchasable: true
                preorder: false
                in_stock: false
                backorderable: true
                available: true
                description: Vel minima recusandae iure deserunt non. Corrupti soluta
                  pariatur recusandae saepe eveniet. Sequi deserunt fugiat architecto
                  animi. Eum facilis veniam a consequatur minus. Dolor iure facilis
                  repellendus tenetur. Nobis harum perferendis ab maiores labore eius
                  eum quo.
                description_html: |-
                  Vel minima recusandae iure deserunt non. Corrupti soluta pariatur recusandae saepe eveniet. Sequi deserunt fugiat architecto animi.
                  Eum facilis veniam a consequatur minus. Dolor iure facilis repellendus tenetur. Nobis harum perferendis ab maiores labore eius eum quo.
                default_variant_id: variant_UkLWZg9DAJ
                buy_box_variant_id: variant_UkLWZg9DAJ
                thumbnail_url:
                tags: []
                price:
                  id: price_UkLWZg9DAJ
                  currency: USD
                  amount: '19.99'
                  compare_at_amount:
                  price_list_id:
                original_price:
                seller_id: sel_UkLWZg9DAJ
                status: active
                metadata: {}
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                product_type_id:
                delivery_profile_id: fp_UkLWZg9DAJ
              schema:
                "$ref": "#/components/schemas/Product"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ProductUpdateParams"
        required: true
    delete:
      summary: Delete a product
      tags:
      - Products
      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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '204':
          description: product deleted
  "/api/v3/seller/products/{id}/submit":
    parameters:
    - name: id
      in: path
      description: Product ID
      required: true
      schema:
        type: string
    patch:
      summary: Submit a product for review
      tags:
      - Products
      security:
      - bearer_auth: []
      description: |
        Asks the marketplace to put a product on sale. Whether a listing goes
        live is the operator's decision, so a seller submits it for review
        rather than setting its status. Only drafts and rejected listings can
        be submitted.

        Where the marketplace approves seller products automatically, the
        product comes back already `active`.
      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.submit('prod_UkLWZg9DAJ')
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: product submitted
          content:
            application/json:
              example:
                id: prod_gbHJdmfrXB
                name: Product 3017816
                slug: product-3017816
                meta_title:
                meta_description:
                meta_keywords:
                variant_count: 1
                available_on:
                preorder_ships_at:
                purchasable: true
                preorder: false
                in_stock: false
                backorderable: true
                available: false
                description: Enim soluta recusandae id ea incidunt. Sed enim odit
                  ullam fugit exercitationem reiciendis ipsam voluptates. Numquam
                  consequuntur inventore quisquam libero dignissimos cum consectetur
                  distinctio. A praesentium voluptate autem minus officia harum. Repellendus
                  reiciendis aperiam inventore aliquam nulla incidunt laudantium.
                  Placeat esse quaerat corrupti adipisci enim. Quam sapiente aperiam
                  officia ea. Aperiam qui quibusdam dolorem sapiente fuga nemo vitae.
                  Esse tenetur consequatur ut cumque in placeat impedit atque. Molestiae
                  id animi nemo illum laborum rem. Voluptatibus quaerat laborum amet
                  deserunt repellendus sapiente corporis. Distinctio nesciunt voluptates
                  corrupti animi quae magni. Quod iusto necessitatibus dignissimos
                  est voluptate quo voluptatum ab. Hic ad atque cum dolore exercitationem
                  blanditiis accusamus. Ipsam eos sequi mollitia ea quibusdam ut excepturi
                  officiis. Facilis reprehenderit quos odio commodi. Quo praesentium
                  doloremque tempora ducimus magni dignissimos delectus distinctio.
                  Facere totam officiis recusandae eaque illum. Porro facilis ducimus
                  blanditiis voluptas occaecati quaerat voluptates. Architecto assumenda
                  omnis recusandae eius atque temporibus.
                description_html: |-
                  Enim soluta recusandae id ea incidunt. Sed enim odit ullam fugit exercitationem reiciendis ipsam voluptates. Numquam consequuntur inventore quisquam libero dignissimos cum consectetur distinctio. A praesentium voluptate autem minus officia harum.
                  Repellendus reiciendis aperiam inventore aliquam nulla incidunt laudantium. Placeat esse quaerat corrupti adipisci enim. Quam sapiente aperiam officia ea.
                  Aperiam qui quibusdam dolorem sapiente fuga nemo vitae. Esse tenetur consequatur ut cumque in placeat impedit atque. Molestiae id animi nemo illum laborum rem.
                  Voluptatibus quaerat laborum amet deserunt repellendus sapiente corporis. Distinctio nesciunt voluptates corrupti animi quae magni. Quod iusto necessitatibus dignissimos est voluptate quo voluptatum ab. Hic ad atque cum dolore exercitationem blanditiis accusamus. Ipsam eos sequi mollitia ea quibusdam ut excepturi officiis.
                  Facilis reprehenderit quos odio commodi. Quo praesentium doloremque tempora ducimus magni dignissimos delectus distinctio. Facere totam officiis recusandae eaque illum. Porro facilis ducimus blanditiis voluptas occaecati quaerat voluptates. Architecto assumenda omnis recusandae eius atque temporibus.
                default_variant_id: variant_gbHJdmfrXB
                buy_box_variant_id: variant_gbHJdmfrXB
                thumbnail_url:
                tags: []
                price:
                  id: price_gbHJdmfrXB
                  currency: USD
                  amount: '19.99'
                  compare_at_amount:
                  price_list_id:
                original_price:
                seller_id: sel_UkLWZg9DAJ
                status: proposed
                metadata: {}
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                product_type_id:
                delivery_profile_id: fp_UkLWZg9DAJ
              schema:
                "$ref": "#/components/schemas/Product"
        '422':
          description: product cannot be submitted
          content:
            application/json:
              example:
                error:
                  code: processing_error
                  message: Only a draft or a product needing changes can be submitted
                    for review.
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
  "/api/v3/seller/products/{id}/draft":
    parameters:
    - name: id
      in: path
      description: Product ID
      required: true
      schema:
        type: string
    patch:
      summary: Move a product back to draft
      tags:
      - Products
      security:
      - bearer_auth: []
      description: |
        Takes a listing down. Withdrawing your own product is not a review
        decision, so it needs nobody's approval.
      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.draft('prod_UkLWZg9DAJ')
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: product moved to draft
          content:
            application/json:
              example:
                id: prod_UkLWZg9DAJ
                name: Product 303209
                slug: product-303209
                meta_title:
                meta_description:
                meta_keywords:
                variant_count: 1
                available_on:
                preorder_ships_at:
                purchasable: true
                preorder: false
                in_stock: false
                backorderable: true
                available: false
                description: Pariatur quod numquam similique dicta excepturi inventore.
                  Quia sapiente iure rerum voluptatem velit totam. Vero aperiam laborum
                  mollitia voluptatum expedita impedit modi vel. Impedit nulla dolores
                  natus ea doloremque minima consectetur consequuntur. Mollitia recusandae
                  architecto quaerat quos quod dolor. Illo non officiis voluptatem
                  voluptas eos itaque. Doloribus nostrum corporis reiciendis reprehenderit
                  odit minus. Nostrum ullam aperiam dolor ipsa. Maxime officiis excepturi
                  aspernatur delectus quos temporibus. Exercitationem a amet soluta
                  harum aperiam neque corrupti doloremque. Culpa modi quibusdam assumenda
                  voluptatibus ea distinctio porro unde. Distinctio expedita unde
                  asperiores nihil debitis.
                description_html: |-
                  Pariatur quod numquam similique dicta excepturi inventore. Quia sapiente iure rerum voluptatem velit totam. Vero aperiam laborum mollitia voluptatum expedita impedit modi vel. Impedit nulla dolores natus ea doloremque minima consectetur consequuntur.
                  Mollitia recusandae architecto quaerat quos quod dolor. Illo non officiis voluptatem voluptas eos itaque. Doloribus nostrum corporis reiciendis reprehenderit odit minus. Nostrum ullam aperiam dolor ipsa.
                  Maxime officiis excepturi aspernatur delectus quos temporibus. Exercitationem a amet soluta harum aperiam neque corrupti doloremque. Culpa modi quibusdam assumenda voluptatibus ea distinctio porro unde. Distinctio expedita unde asperiores nihil debitis.
                default_variant_id: variant_UkLWZg9DAJ
                buy_box_variant_id: variant_UkLWZg9DAJ
                thumbnail_url:
                tags: []
                price:
                  id: price_UkLWZg9DAJ
                  currency: USD
                  amount: '19.99'
                  compare_at_amount:
                  price_list_id:
                original_price:
                seller_id: sel_UkLWZg9DAJ
                status: draft
                metadata: {}
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                product_type_id:
                delivery_profile_id: fp_UkLWZg9DAJ
              schema:
                "$ref": "#/components/schemas/Product"
  "/api/v3/seller/products/{id}/archive":
    parameters:
    - name: id
      in: path
      description: Product ID
      required: true
      schema:
        type: string
    patch:
      summary: Archive a product
      tags:
      - Products
      security:
      - bearer_auth: []
      description: Retires a product the acting seller owns, taking it off sale without
        deleting 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 product = await client.products.archive('prod_UkLWZg9DAJ')
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: product archived
          content:
            application/json:
              example:
                id: prod_UkLWZg9DAJ
                name: Product 3049405
                slug: product-3049405
                meta_title:
                meta_description:
                meta_keywords:
                variant_count: 1
                available_on:
                preorder_ships_at:
                purchasable: true
                preorder: false
                in_stock: false
                backorderable: true
                available: false
                description: Incidunt mollitia fugiat doloremque amet suscipit. Voluptatem
                  quidem ratione consequuntur ad fugiat sit. Quisquam libero officiis
                  aliquam tempore adipisci eos neque quis. Consequuntur consectetur
                  repudiandae nam modi amet neque. Alias iure amet cupiditate similique
                  autem ea sed praesentium. Numquam consequuntur similique doloribus
                  perferendis alias necessitatibus. Optio ratione delectus dolor laudantium
                  similique. Eos itaque esse sint sed quaerat reprehenderit amet odit.
                description_html: |-
                  Incidunt mollitia fugiat doloremque amet suscipit. Voluptatem quidem ratione consequuntur ad fugiat sit. Quisquam libero officiis aliquam tempore adipisci eos neque quis. Consequuntur consectetur repudiandae nam modi amet neque.
                  Alias iure amet cupiditate similique autem ea sed praesentium. Numquam consequuntur similique doloribus perferendis alias necessitatibus. Optio ratione delectus dolor laudantium similique. Eos itaque esse sint sed quaerat reprehenderit amet odit.
                default_variant_id: variant_UkLWZg9DAJ
                buy_box_variant_id: variant_UkLWZg9DAJ
                thumbnail_url:
                tags: []
                price:
                  id: price_UkLWZg9DAJ
                  currency: USD
                  amount: '19.99'
                  compare_at_amount:
                  price_list_id:
                original_price:
                seller_id: sel_UkLWZg9DAJ
                status: archived
                metadata: {}
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                product_type_id:
                delivery_profile_id: fp_UkLWZg9DAJ
              schema:
                "$ref": "#/components/schemas/Product"
  "/api/v3/seller/products/bulk_submit":
    post:
      summary: Submit products for review
      tags:
      - Products
      security:
      - bearer_auth: []
      description: |
        Submits a selection for the marketplace to review. Only drafts and
        rejected listings can be submitted, so a mixed selection moves what it
        can: `product_count` is what was submitted, and `skipped_count`, present
        only 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: products submitted
          content:
            application/json:
              example:
                product_count: 1
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ProductBulkSubmitParams"
        required: true
  "/api/v3/seller/products/bulk_status_update":
    post:
      summary: Change the status of products
      tags:
      - Products
      security:
      - bearer_auth: []
      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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: statuses changed
          content:
            application/json:
              example:
                product_count: 1
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ProductBulkStatusParams"
        required: true
  "/api/v3/seller/products/bulk_destroy":
    delete:
      summary: Delete products
      tags:
      - Products
      security:
      - bearer_auth: []
      description: |
        Deletes a selection of the acting seller's products. Ids outside this
        seller's catalog are ignored. A product the marketplace refuses to
        delete is skipped: `product_count` is what was deleted, and
        `skipped_count`, present only 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.bulkDestroy({
            ids: ['prod_UkLWZg9DAJ', 'prod_9XbR2kQwLm'],
          })
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: products deleted
          content:
            application/json:
              example:
                product_count: 1
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ProductBulkDestroyParams"
        required: true
  "/api/v3/seller/profile":
    get:
      summary: Get profile
      tags:
      - Profile
      security:
      - bearer_auth: []
      description: |
        The seller's own record.

        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 address
        another 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: profile returned
          content:
            application/json:
              example:
                id: sel_UkLWZg9DAJ
                name: Seller 152
                slug: seller-152
                about: ''
                about_html: ''
                logo_url:
                square_logo_url:
                cover_photo_url:
                timezone: UTC
                status: approved
                legal_name:
                registration_number:
                contact_email:
                billing_email:
                tax_remittance: seller
                payouts_schedule_interval:
                holiday_mode_until:
                terms_accepted_at: '2026-01-15T12:00:00.000Z'
                created_at: '2026-01-15T12:00:00.000Z'
                minimum_payout_amount:
                on_holiday: false
                sellable: true
                default_currency: USD
                supported_currencies:
                - USD
                - EUR
                - GBP
                products_count: 0
              schema:
                "$ref": "#/components/schemas/Profile"
        '403':
          description: no seller named, or not a member of it
          content:
            application/json:
              example:
                error:
                  code: access_denied
                  message: You do not have access to this seller.
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
    patch:
      summary: Update profile
      tags:
      - Profile
      security:
      - bearer_auth: []
      description: |
        Edits presentation, contact details and addresses.

        Readable but **not** writable, by design: `status` — the lifecycle belongs
        to the marketplace operator's workflows — the settlement terms, and
        `slug`, since a seller renaming their own storefront address would break
        every link pointing at it.

        `accept_terms: true` stamps the moment the seller accepted the
        marketplace's terms, which is what the matching onboarding requirement
        reads. One-way — sending `false` does not unmake the stamp.

        `custom_fields` is narrowed server-side to the definitions this
        marketplace's onboarding actually asks this seller for; a field nothing
        asked 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: profile updated
          content:
            application/json:
              example:
                id: sel_UkLWZg9DAJ
                name: Acme Supplies
                slug: seller-154
                about: ''
                about_html: ''
                logo_url:
                square_logo_url:
                cover_photo_url:
                timezone: UTC
                status: approved
                legal_name:
                registration_number:
                contact_email: [email protected]
                billing_email:
                tax_remittance: seller
                payouts_schedule_interval:
                holiday_mode_until:
                terms_accepted_at: '2026-01-15T12:00:00.000Z'
                created_at: '2026-01-15T12:00:00.000Z'
                minimum_payout_amount:
                on_holiday: false
                sellable: true
                default_currency: USD
                supported_currencies:
                - USD
                - EUR
                - GBP
                products_count: 0
              schema:
                "$ref": "#/components/schemas/Profile"
        '422':
          description: validation failed
          content:
            application/json:
              example:
                error:
                  code: validation_error
                  message: Name can't be blank
                  details:
                    name:
                    - can't be blank
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ProfileUpdateParams"
        required: true
  "/api/v3/seller/stock_locations":
    get:
      summary: List stock locations
      tags:
      - Stock Locations
      security:
      - bearer_auth: []
      description: |
        Where this seller keeps stock, and so where their returns are sent.

        Rooted in the acting seller, so the marketplace operator's own warehouses
        never 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-Id
        in: header
        required: true
        schema:
          type: string
      - name: q[search]
        in: query
        required: false
        schema:
          type: string
        description: Matches any of name (partial, case-insensitive).
      - name: page
        in: query
        required: false
        description: Page number
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        description: Records per page (max 100)
        schema:
          type: integer
      - name: sort
        in: query
        required: false
        description: Sort field; prefix with `-` for descending
        schema:
          type: string
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[name_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `active` | True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |
          | `country_code` | One of the `CountryCode` codes | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `default` | True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `kind` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `pickup_enabled` | True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |
          | `returns_enabled` | True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |
          | `seller_id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `state_code` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `active`, `country_code`, `created_at`, `default`, `id`, `kind`, `name`, `pickup_enabled`, `returns_enabled`, `seller_id`, `state_code`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: StockLocation
        sortable:
        - active
        - country_code
        - created_at
        - default
        - id
        - kind
        - name
        - pickup_enabled
        - returns_enabled
        - seller_id
        - state_code
        - updated_at
      responses:
        '200':
          description: stock locations listed
          content:
            application/json:
              example:
                data:
                - id: sloc_UkLWZg9DAJ
                  name: Lesha Stroman
                  address1: 1600 Pennsylvania Ave NW
                  city: Washington
                  zipcode: '20500'
                  country_code: US
                  country_name: United States
                  state_code: AL
                  state_text: AL
                  pickup_ready_in_minutes:
                  pickup_instructions:
                  address2:
                  state_name:
                  phone: "(202) 456-1111"
                  company:
                  active: true
                  default: false
                  kind: warehouse
                  returns_enabled: true
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/StockLocation"
                  meta:
                    "$ref": "#/components/schemas/PaginationMeta"
                required:
                - data
                - meta
    post:
      summary: Create a stock location
      tags:
      - Stock Locations
      security:
      - bearer_auth: []
      description: |
        Adds a place this seller ships from.

        The seller and the store come from the request context whatever the
        payload 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '201':
          description: stock location created
          content:
            application/json:
              example:
                id: sloc_gbHJdmfrXB
                name: Main warehouse
                address1:
                city: Portland
                zipcode:
                country_code: US
                country_name: United States
                state_code:
                state_text:
                pickup_ready_in_minutes:
                pickup_instructions:
                address2:
                state_name:
                phone:
                company:
                active: true
                default: false
                kind: warehouse
                returns_enabled: true
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
              schema:
                "$ref": "#/components/schemas/StockLocation"
        '422':
          description: validation failed
          content:
            application/json:
              example:
                error:
                  code: validation_error
                  message: Name can't be blank
                  details:
                    name:
                    - can't be blank
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/StockLocationCreateParams"
        required: true
  "/api/v3/seller/stock_locations/{id}":
    parameters:
    - name: id
      in: path
      description: Stock location ID
      required: true
      schema:
        type: string
    get:
      summary: Get a stock location
      tags:
      - Stock Locations
      security:
      - bearer_auth: []
      description: |
        A stock location the acting seller owns. An id belonging to another
        seller — 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: stock location returned
          content:
            application/json:
              example:
                id: sloc_UkLWZg9DAJ
                name: Marsha Turner
                address1: 1600 Pennsylvania Ave NW
                city: Washington
                zipcode: '20500'
                country_code: US
                country_name: United States
                state_code: AL
                state_text: AL
                pickup_ready_in_minutes:
                pickup_instructions:
                address2:
                state_name:
                phone: "(202) 456-1111"
                company:
                active: true
                default: false
                kind: warehouse
                returns_enabled: true
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
              schema:
                "$ref": "#/components/schemas/StockLocation"
        '404':
          description: another seller's stock location
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Stock location not found
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
    patch:
      summary: Update a stock location
      tags:
      - Stock Locations
      security:
      - bearer_auth: []
      description: |
        Edits a stock location the acting seller owns.

        There is no delete: a location holds stock levels and is named on
        historical 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: stock location updated
          content:
            application/json:
              example:
                id: sloc_UkLWZg9DAJ
                name: Kiln Lane warehouse
                address1: 1600 Pennsylvania Ave NW
                city: Washington
                zipcode: '20500'
                country_code: US
                country_name: United States
                state_code: AL
                state_text: AL
                pickup_ready_in_minutes:
                pickup_instructions:
                address2:
                state_name:
                phone: "(202) 456-1111"
                company:
                active: true
                default: false
                kind: warehouse
                returns_enabled: true
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
              schema:
                "$ref": "#/components/schemas/StockLocation"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/StockLocationUpdateParams"
        required: true
  "/api/v3/seller/invitations":
    get:
      summary: List pending invitations
      tags:
      - Team
      security:
      - bearer_auth: []
      description: |
        Offers nobody has accepted yet, newest first.

        Pending only — an accepted invitation is a team member, and shows up on
        `GET /api/v3/seller/team` instead.

        Sending an invitation lives on `team`, because that is hiring. Chasing or
        withdrawing 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: invitations listed
          content:
            application/json:
              example:
                data:
                - id: inv_UkLWZg9DAJ
                  email: [email protected]
                  created_at: '2026-01-15T12:00:00.000Z'
                  expires_at: '2026-01-29T12:00:00.000Z'
                  accepted_at:
                  status: pending
                  inviter_email: [email protected]
                  seller:
                    id: sel_UkLWZg9DAJ
                    name: Seller 76
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/Invitation"
                required:
                - data
  "/api/v3/seller/invitations/{invitation_id}/acceptance_link":
    parameters:
    - name: invitation_id
      in: path
      description: Invitation ID
      required: true
      schema:
        type: string
    get:
      summary: Get an invitation acceptance link
      tags:
      - Team
      security:
      - bearer_auth: []
      description: |
        The link a colleague opens to join the team. It carries the invitation's
        token, so the listing never includes it; fetch it when someone asks to
        copy 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: acceptance link found
          content:
            application/json:
              example:
                id: inv_UkLWZg9DAJ
                acceptance_url: http://www.example.com:3000/accept-invitation/inv_UkLWZg9DAJ?token=7La4K2PLxW8oLoXjmz46QYEJ
              schema:
                "$ref": "#/components/schemas/InvitationAcceptanceLink"
  "/api/v3/seller/invitations/{id}/resend":
    parameters:
    - name: id
      in: path
      description: Invitation ID
      required: true
      schema:
        type: string
    patch:
      summary: Resend an invitation
      tags:
      - Team
      security:
      - bearer_auth: []
      description: |
        Sends the invitation email again, for a colleague who never got the first
        one. An invitation whose window has closed is refused rather than
        re-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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: invitation resent
          content:
            application/json:
              example:
                id: inv_UkLWZg9DAJ
                email: [email protected]
                created_at: '2026-01-15T12:00:00.000Z'
                expires_at: '2026-01-29T12:00:00.000Z'
                accepted_at:
                status: pending
                inviter_email: [email protected]
                seller:
                  id: sel_UkLWZg9DAJ
                  name: Seller 78
              schema:
                "$ref": "#/components/schemas/Invitation"
        '404':
          description: another seller's invitation
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Invitation not found
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
  "/api/v3/seller/invitations/{id}":
    parameters:
    - name: id
      in: path
      description: Invitation ID
      required: true
      schema:
        type: string
    delete:
      summary: Revoke an invitation
      tags:
      - Team
      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.delete('inv_xxx')
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '204':
          description: invitation revoked
        '404':
          description: another seller's invitation
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Invitation not found
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
  "/api/v3/seller/team":
    get:
      summary: List team members
      tags:
      - Team
      security:
      - bearer_auth: []
      description: |
        The people who run this seller.

        Rooted at the acting seller throughout, so a seller only ever sees their
        own 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: team members listed
          content:
            application/json:
              example:
                data:
                - id: adm_UkLWZg9DAJ
                  email: [email protected]
                  first_name: Bill
                  last_name: Towne
                  full_name: Bill Towne
                  created_at: '2026-01-15T12:00:00.000Z'
                  avatar_url:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/TeamMember"
                required:
                - data
    post:
      summary: Invite a team member
      tags:
      - Team
      security:
      - bearer_auth: []
      description: |
        Invites a colleague onto this seller's team. They join when they accept,
        on the same invitation rail — and the same email — the marketplace
        operator's own invitations use.

        Hiring is not a lifecycle transition: a trading seller's status is
        untouched by taking someone on.

        The role is not a parameter. Every member holds the seller's own seeded
        role, 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '201':
          description: invitation sent
          content:
            application/json:
              example:
                id: inv_UkLWZg9DAJ
                email: [email protected]
                created_at: '2026-01-15T12:00:00.000Z'
                expires_at: '2026-01-29T12:00:00.000Z'
                accepted_at:
                status: pending
                inviter_email: [email protected]
                seller:
                  id: sel_UkLWZg9DAJ
                  name: Seller 179
              schema:
                "$ref": "#/components/schemas/Invitation"
        '422':
          description: validation failed
          content:
            application/json:
              example:
                error:
                  code: validation_error
                  message: Email is invalid and Email can't be blank
                  details:
                    email:
                    - is invalid
                    - can't be blank
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/TeamMemberCreateParams"
        required: true
  "/api/v3/seller/team/{id}":
    parameters:
    - name: id
      in: path
      description: Team member (user) ID
      required: true
      schema:
        type: string
    delete:
      summary: Remove a team member
      tags:
      - Team
      security:
      - bearer_auth: []
      description: |
        Revokes a member's access, removing every role they hold on this seller.

        The team can never reach zero: emptying it would leave a seller nobody
        can 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.delete('adm_xxx')
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '204':
          description: member removed
        '422':
          description: cannot remove the last remaining member
          content:
            application/json:
              example:
                error:
                  code: processing_error
                  message: A seller needs at least one team member. Invite someone
                    else before removing this one.
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
        '404':
          description: not a member of this seller
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Admin user not found
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
  "/api/v3/seller/files":
    post:
      summary: Upload a file
      tags:
      - Files
      security:
      - bearer_auth: []
      description: |
        Accepts a file and returns a `signed_id` to send wherever the file
        belongs — as a requirement submission's `file_signed_id`, or as
        `logo_signed_id`, `square_logo_signed_id` or `cover_photo_signed_id` on
        the profile. The file is attached to nothing at this point; the
        endpoint that takes the `signed_id` is the one that checks ownership.

        Send the file's metadata as JSON, then `PUT` the bytes to `upload.url`
        with exactly `upload.headers`; or send small files (10 MB by default)
        as a multipart `file` part, in which case `upload` is null.

        `signed_id` is opaque and expires at `expires_at`, one day after the
        upload. `visibility` is `public` (the default, web images, videos and
        CSV only) or `private` (any type). `checksum` is the file's MD5
        digest, 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '201':
          description: upload target created
          content:
            application/json:
              example:
                signed_id: eyJfcmFpbHMiOnsiZGF0YSI6MSwiZXhwIjoiMjAyNi0wMS0xNlQxMjowMDowMC4wMDBaIiwicHVyIjoiYmxvYl9pZCJ9fQ==--aacde269a0019661ac951ab66e97e4338f76c0e3
                filename: registration.pdf
                content_type: application/pdf
                byte_size: 51234
                visibility: private
                expires_at: '2026-01-16T12:00:00.000Z'
                upload:
                  method: PUT
                  url: http://www.example.com/rails/active_storage/disk/eyJfcmFpbHMiOnsiZGF0YSI6eyJrZXkiOiI4NDFrenlvbTQ5cnRhcDk0cmZxbGV6dnM1cGJsIiwiY29udGVudF90eXBlIjoiYXBwbGljYXRpb24vcGRmIiwiY29udGVudF9sZW5ndGgiOjUxMjM0LCJjaGVja3N1bSI6IlZqaHowNGxRdUVHdXY0bkR2aHNhTlE9PSIsInNlcnZpY2VfbmFtZSI6InRlc3QifSwiZXhwIjoiMjAyNi0wMS0xNVQxMjowNTowMC4wMDBaIiwicHVyIjoiYmxvYl90b2tlbiJ9fQ==--25172b4f2478e89864b255331dbb4632f9fd158d
                  headers:
                    Content-Type: application/pdf
              schema:
                "$ref": "#/components/schemas/FileUpload"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/FileUploadCreateParams"
          multipart/form-data:
            schema:
              "$ref": "#/components/schemas/FileUploadCreateParams"
        required: true
  "/api/v3/seller/balances":
    get:
      summary: List balances
      tags:
      - Earnings
      security:
      - bearer_auth: []
      description: |
        Where this seller stands with the marketplace, one row per currency
        they have earned or been paid in: what they have earned (settled
        transfers, refund reversals included), what has reached them, what the
        marketplace still owes, and earnings the payout provider has not yet
        confirmed.

        Computed from the ledger rather than stored, so the rows carry no id
        and 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: balances listed
          content:
            application/json:
              example:
                data:
                - currency: USD
                  settlement_currency: USD
                  converted: false
                  earned: '40.00'
                  pending: '0.00'
                  payable: '40.00'
                  paid: '15.00'
                  balance: '25.00'
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/Balance"
                required:
                - data
  "/api/v3/seller/orders/{order_id}/claims":
    parameters:
    - name: order_id
      in: path
      description: Prefixed order ID
      required: true
      schema:
        type: string
    get:
      summary: List claims
      tags:
      - Claims
      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-Id
        in: header
        required: true
        schema:
          type: string
      - name: q[search]
        in: query
        required: false
        schema:
          type: string
        description: Matches any of number (partial, case-insensitive).
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[number_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `number` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `status` | One of `open`, `approved`, `resolved`, `denied`, `canceled` | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `created_at`, `id`, `number`, `status`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: Claim
        sortable:
        - created_at
        - id
        - number
        - status
        - updated_at
      responses:
        '200':
          description: claims listed
          content:
            application/json:
              example:
                data:
                - id: claim_UkLWZg9DAJ
                  number: CLM1001
                  status: open
                  resolution:
                  order_id: or_UkLWZg9DAJ
                  reason_id:
                  refund_total: '0.00'
                  approved_at:
                  resolved_at:
                  denied_at:
                  canceled_at:
                  memo:
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/Claim"
                required:
                - data
    post:
      summary: Open a claim
      tags:
      - Claims
      security:
      - bearer_auth: []
      description: |
        Reports that something went wrong with a delivery, to be put right
        without necessarily asking for the goods back.

        A replacement variant, if one is offered, comes from this seller's own
        catalogue — 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '201':
          description: claim opened
          content:
            application/json:
              example:
                id: claim_UkLWZg9DAJ
                number: CLM1001
                status: open
                resolution:
                order_id: or_UkLWZg9DAJ
                reason_id:
                refund_total: '0.00'
                approved_at:
                resolved_at:
                denied_at:
                canceled_at:
                memo:
              schema:
                "$ref": "#/components/schemas/Claim"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ClaimCreateParams"
        required: true
  "/api/v3/seller/orders/{order_id}/claims/{id}":
    parameters:
    - name: order_id
      in: path
      description: Prefixed order ID
      required: true
      schema:
        type: string
    - name: id
      in: path
      description: Prefixed claim ID
      required: true
      schema:
        type: string
    get:
      summary: Show a claim
      tags:
      - Claims
      security:
      - bearer_auth: []
      description: One problem reported on one of this seller's orders, with the items
        it covers and the reason given.
      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.get('or_UkLWZg9DAJ', 'claim_UkLWZg9DAJ')
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: claim found
          content:
            application/json:
              example:
                id: claim_UkLWZg9DAJ
                number: CLM1001
                status: open
                resolution:
                order_id: or_UkLWZg9DAJ
                reason_id:
                refund_total: '0.00'
                approved_at:
                resolved_at:
                denied_at:
                canceled_at:
                memo:
              schema:
                "$ref": "#/components/schemas/Claim"
  "/api/v3/seller/orders/{order_id}/claims/{id}/approve":
    parameters:
    - name: order_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    patch:
      summary: Approve a claim
      tags:
      - Claims
      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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: claim approved
          content:
            application/json:
              example:
                id: claim_UkLWZg9DAJ
                number: CLM1001
                status: approved
                resolution:
                order_id: or_UkLWZg9DAJ
                reason_id:
                refund_total: '0.00'
                approved_at: '2026-01-15T12:00:00Z'
                resolved_at:
                denied_at:
                canceled_at:
                memo:
              schema:
                "$ref": "#/components/schemas/Claim"
  "/api/v3/seller/orders/{order_id}/claims/{id}/resolve":
    parameters:
    - name: order_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    patch:
      summary: Resolve a claim
      tags:
      - Claims
      security:
      - bearer_auth: []
      description: |
        Puts the claim right: money back, a replacement shipment, or both.

        A refund is bounded by this order's share of the payment, so one
        seller 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: claim resolved
          content:
            application/json:
              example:
                id: claim_UkLWZg9DAJ
                number: CLM1001
                status: resolved
                resolution: refund
                order_id: or_UkLWZg9DAJ
                reason_id:
                refund_total: '0.00'
                approved_at: '2026-01-15T12:00:00Z'
                resolved_at: '2026-01-15T12:00:00Z'
                denied_at:
                canceled_at:
                memo:
              schema:
                "$ref": "#/components/schemas/Claim"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ClaimResolveParams"
        required: true
  "/api/v3/seller/orders/{order_id}/claims/{id}/deny":
    parameters:
    - name: order_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    patch:
      summary: Deny a claim
      tags:
      - Claims
      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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: claim denied
          content:
            application/json:
              example:
                id: claim_UkLWZg9DAJ
                number: CLM1001
                status: denied
                resolution:
                order_id: or_UkLWZg9DAJ
                reason_id:
                refund_total: '0.00'
                approved_at:
                resolved_at:
                denied_at: '2026-01-15T12:00:00Z'
                canceled_at:
                memo: Reported after the claim window closed
              schema:
                "$ref": "#/components/schemas/Claim"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ClaimDenyParams"
  "/api/v3/seller/orders/{order_id}/claims/{id}/cancel":
    parameters:
    - name: order_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    patch:
      summary: Cancel a claim
      tags:
      - Claims
      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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: claim canceled
          content:
            application/json:
              example:
                id: claim_UkLWZg9DAJ
                number: CLM1001
                status: canceled
                resolution:
                order_id: or_UkLWZg9DAJ
                reason_id:
                refund_total: '0.00'
                approved_at:
                resolved_at:
                denied_at:
                canceled_at: '2026-01-15T12:00:00Z'
                memo: Customer found the missing item
              schema:
                "$ref": "#/components/schemas/Claim"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ClaimCancelParams"
  "/api/v3/seller/claim_reasons":
    get:
      summary: List claim reasons
      tags:
      - Claims
      security:
      - bearer_auth: []
      description: |
        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-Id
        in: header
        required: true
        schema:
          type: string
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[name_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `active` | True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `active`, `created_at`, `id`, `name`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: ClaimReason
        sortable:
        - active
        - created_at
        - id
        - name
        - updated_at
      responses:
        '200':
          description: reasons listed
          content:
            application/json:
              example:
                data:
                - id: clr_UkLWZg9DAJ
                  name: Arrived damaged
                  active: true
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/Reason"
                required:
                - data
  "/api/v3/seller/orders/{order_id}/exchanges":
    parameters:
    - name: order_id
      in: path
      description: Prefixed order ID
      required: true
      schema:
        type: string
    get:
      summary: List exchanges
      tags:
      - Exchanges
      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-Id
        in: header
        required: true
        schema:
          type: string
      - name: q[search]
        in: query
        required: false
        schema:
          type: string
        description: Matches any of number (partial, case-insensitive).
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[number_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `number` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `status` | One of `requested`, `approved`, `received`, `fulfilled`, `canceled` | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `created_at`, `id`, `number`, `status`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: Exchange
        sortable:
        - created_at
        - id
        - number
        - status
        - updated_at
      responses:
        '200':
          description: exchanges listed
          content:
            application/json:
              example:
                data:
                - id: exch_UkLWZg9DAJ
                  number: EX1001
                  status: requested
                  order_id: or_UkLWZg9DAJ
                  reason_id:
                  price_difference: '9.99'
                  approved_at:
                  received_at:
                  fulfilled_at:
                  canceled_at:
                  memo:
                  stock_location_id: sloc_UkLWZg9DAJ
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/Exchange"
                required:
                - data
    post:
      summary: Open an exchange
      tags:
      - Exchanges
      security:
      - bearer_auth: []
      description: |
        Swaps goods for different ones.

        The replacement comes from this seller's own catalogue: it is stock
        they will send, so a variant belonging to another seller is not theirs
        to 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '201':
          description: exchange opened
          content:
            application/json:
              example:
                id: exch_UkLWZg9DAJ
                number: EX1001
                status: requested
                order_id: or_UkLWZg9DAJ
                reason_id:
                price_difference: '9.99'
                approved_at:
                received_at:
                fulfilled_at:
                canceled_at:
                memo:
                stock_location_id: sloc_UkLWZg9DAJ
              schema:
                "$ref": "#/components/schemas/Exchange"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ExchangeCreateParams"
        required: true
  "/api/v3/seller/orders/{order_id}/exchanges/{id}":
    parameters:
    - name: order_id
      in: path
      description: Prefixed order ID
      required: true
      schema:
        type: string
    - name: id
      in: path
      description: Prefixed exchange ID
      required: true
      schema:
        type: string
    get:
      summary: Show an exchange
      tags:
      - Exchanges
      security:
      - bearer_auth: []
      description: One exchange on one of this seller's orders, with what is coming
        back and what goes out in its place.
      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.get('or_UkLWZg9DAJ', 'exch_UkLWZg9DAJ')
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: exchange found
          content:
            application/json:
              example:
                id: exch_UkLWZg9DAJ
                number: EX1001
                status: requested
                order_id: or_UkLWZg9DAJ
                reason_id:
                price_difference: '9.99'
                approved_at:
                received_at:
                fulfilled_at:
                canceled_at:
                memo:
                stock_location_id: sloc_UkLWZg9DAJ
              schema:
                "$ref": "#/components/schemas/Exchange"
  "/api/v3/seller/orders/{order_id}/exchanges/{id}/approve":
    parameters:
    - name: order_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    patch:
      summary: Approve an exchange
      tags:
      - Exchanges
      security:
      - bearer_auth: []
      description: Agrees to the swap, so the customer can send the original goods
        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.approve('or_UkLWZg9DAJ', 'exch_UkLWZg9DAJ')
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: exchange approved
          content:
            application/json:
              example:
                id: exch_UkLWZg9DAJ
                number: EX1001
                status: approved
                order_id: or_UkLWZg9DAJ
                reason_id:
                price_difference: '9.99'
                approved_at: '2026-01-15T12:00:00Z'
                received_at:
                fulfilled_at:
                canceled_at:
                memo:
                stock_location_id: sloc_UkLWZg9DAJ
              schema:
                "$ref": "#/components/schemas/Exchange"
  "/api/v3/seller/orders/{order_id}/exchanges/{id}/receive":
    parameters:
    - name: order_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    patch:
      summary: Receive an exchange
      tags:
      - Exchanges
      security:
      - bearer_auth: []
      description: |
        Records the goods coming back. Send the rows that actually arrived for
        a 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: exchange received
          content:
            application/json:
              example:
                id: exch_UkLWZg9DAJ
                number: EX1001
                status: received
                order_id: or_UkLWZg9DAJ
                reason_id:
                price_difference: '9.99'
                approved_at: '2026-01-15T12:00:00Z'
                received_at: '2026-01-15T12:00:00Z'
                fulfilled_at:
                canceled_at:
                memo:
                stock_location_id: sloc_UkLWZg9DAJ
              schema:
                "$ref": "#/components/schemas/Exchange"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ExchangeReceiveParams"
  "/api/v3/seller/orders/{order_id}/exchanges/{id}/fulfill":
    parameters:
    - name: order_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    patch:
      summary: Send the replacement
      tags:
      - Exchanges
      security:
      - bearer_auth: []
      description: |
        Sends the replacement goods, settling any price difference at the same
        time — 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: replacement sent
          content:
            application/json:
              example:
                id: exch_UkLWZg9DAJ
                number: EX1001
                status: fulfilled
                order_id: or_UkLWZg9DAJ
                reason_id:
                price_difference: '9.99'
                approved_at: '2026-01-15T12:00:00Z'
                received_at: '2026-01-15T12:00:00Z'
                fulfilled_at: '2026-01-15T12:00:00Z'
                canceled_at:
                memo:
                stock_location_id: sloc_UkLWZg9DAJ
              schema:
                "$ref": "#/components/schemas/Exchange"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ExchangeFulfillParams"
  "/api/v3/seller/orders/{order_id}/exchanges/{id}/cancel":
    parameters:
    - name: order_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    patch:
      summary: Cancel an exchange
      tags:
      - Exchanges
      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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: exchange canceled
          content:
            application/json:
              example:
                id: exch_UkLWZg9DAJ
                number: EX1001
                status: canceled
                order_id: or_UkLWZg9DAJ
                reason_id:
                price_difference: '9.99'
                approved_at:
                received_at:
                fulfilled_at:
                canceled_at: '2026-01-15T12:00:00Z'
                memo: Customer kept the original
                stock_location_id: sloc_UkLWZg9DAJ
              schema:
                "$ref": "#/components/schemas/Exchange"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ExchangeCancelParams"
  "/api/v3/seller/exports":
    post:
      summary: Create an export
      tags:
      - Exports
      security:
      - bearer_auth: []
      description: |
        Queues a CSV of this seller's own records.

        Only datasets that can be narrowed to a single seller are offered, so
        an export can never contain another seller's rows however it is
        filtered. The seller and the store come from the request context
        whatever the payload says.

        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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '201':
          description: export queued
          content:
            application/json:
              example:
                id: exp_UkLWZg9DAJ
                number: EF1001
                format: csv
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                type: orders
                user_id: adm_UkLWZg9DAJ
                done: false
                filename:
                byte_size:
                download_url:
              schema:
                "$ref": "#/components/schemas/Export"
        '422':
          description: type cannot be scoped to one seller
          content:
            application/json:
              example:
                error:
                  code: validation_error
                  message: 'Unsupported export type. Supported types: orders, products'
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/SellerExportCreateParams"
        required: true
  "/api/v3/seller/exports/{id}":
    parameters:
    - name: id
      in: path
      description: Export ID
      required: true
      schema:
        type: string
    get:
      summary: Get an export
      tags:
      - Exports
      security:
      - bearer_auth: []
      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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: export found
          content:
            application/json:
              example:
                id: exp_UkLWZg9DAJ
                number: EF1001
                format: csv
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                type: orders
                user_id: adm_UkLWZg9DAJ
                done: false
                filename:
                byte_size:
                download_url:
              schema:
                "$ref": "#/components/schemas/Export"
        '404':
          description: another seller's export
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Export not found
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
  "/api/v3/seller/exports/{id}/download":
    parameters:
    - name: id
      in: path
      description: Export ID
      required: true
      schema:
        type: string
    get:
      summary: Download an export
      tags:
      - Exports
      security:
      - bearer_auth: []
      description: |
        Streams the finished CSV.

        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' },
            })
            if (!response.ok) throw new Error(`Download failed with status ${response.status}`)
            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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '422':
          description: export is still being written
          content:
            application/json:
              example:
                error:
                  code: export_not_ready
                  message: Export is not ready yet
            text/csv:
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
        '404':
          description: another seller's export
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Export not found
            text/csv:
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
  "/api/v3/seller/orders/{order_id}/fulfillments":
    parameters:
    - name: order_id
      in: path
      description: Prefixed order ID
      required: true
      schema:
        type: string
    get:
      summary: List fulfillments
      tags:
      - Fulfillments
      security:
      - bearer_auth: []
      description: |
        The parcels this seller owes on one order.

        Reached through the order, which is itself fetched through the acting
        seller — so a fulfillment on somebody else's order is unreachable
        whatever 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-Id
        in: header
        required: true
        schema:
          type: string
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[number_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `number` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `created_at`, `id`, `number`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: Fulfillment
        sortable:
        - created_at
        - id
        - number
        - updated_at
      responses:
        '200':
          description: fulfillments listed
          content:
            application/json:
              example:
                data:
                - id: ful_UkLWZg9DAJ
                  number: R1001-F1
                  status: unfulfilled
                  tracking: U10000
                  tracking_url:
                  fulfilled_at:
                  delivered_at:
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  fulfillment_type: shipping
                  delivery_method_name: UPS Ground 129
                  stock_location_name: Vernie Lehner
                  stock_location_id: sloc_UkLWZg9DAJ
                  fulfillment_items:
                  - id: fi_UkLWZg9DAJ
                    quantity: 1
                    line_item_id: li_UkLWZg9DAJ
                    variant_id: variant_UkLWZg9DAJ
                    name: Product 2529315
                    sku: SKU-338
                    options_text: ''
                  selected_delivery_rate_id: dr_gbHJdmfrXB
                  delivery_rates:
                  - id: dr_gbHJdmfrXB
                    name: UPS Ground 129
                    selected: true
                    cost: '10.00'
                    total: '10.00'
                    carrier:
                    service_level:
                    estimated_delivery_date:
                    unpriced: false
                  deliveries:
                  - id: dlv_UkLWZg9DAJ
                    tracking_number: U10000
                    carrier:
                    carrier_name:
                    service:
                    status: pending
                    tracking_url:
                    estimated_delivery_at:
                    delivered_at:
                    created_at: '2026-01-15T12:00:00.000Z'
                    updated_at: '2026-01-15T12:00:00.000Z'
                    shipping_label_id:
                  labels: []
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/Fulfillment"
                required:
                - data
  "/api/v3/seller/orders/{order_id}/fulfillments/{id}/fulfill":
    parameters:
    - name: order_id
      in: path
      description: Prefixed order ID
      required: true
      schema:
        type: string
    - name: id
      in: path
      description: Prefixed fulfillment ID
      required: true
      schema:
        type: string
    patch:
      summary: Fulfill (ship) a parcel
      tags:
      - Fulfillments
      security:
      - bearer_auth: []
      description: |
        Marks the parcel shipped.

        This is the same workflow the marketplace operator runs, so the
        customer's dispatch email, the label purchase and any extension hooks
        happen exactly as they would had the operator shipped it.

        `items` narrows the dispatch to part of what the fulfillment holds; the
        remainder 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: parcel shipped
          content:
            application/json:
              example:
                id: ful_UkLWZg9DAJ
                number: R1001-F1
                status: fulfilled
                tracking: TRACK-1
                tracking_url:
                fulfilled_at: '2026-01-15T12:00:00.000Z'
                delivered_at:
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                fulfillment_type: shipping
                delivery_method_name: UPS Ground 130
                stock_location_name: Mirta Herman
                stock_location_id: sloc_UkLWZg9DAJ
                fulfillment_items:
                - id: fi_UkLWZg9DAJ
                  quantity: 1
                  line_item_id: li_UkLWZg9DAJ
                  variant_id: variant_UkLWZg9DAJ
                  name: Product 253961
                  sku: SKU-339
                  options_text: ''
                selected_delivery_rate_id: dr_gbHJdmfrXB
                delivery_rates:
                - id: dr_gbHJdmfrXB
                  name: UPS Ground 130
                  selected: true
                  cost: '10.00'
                  total: '10.00'
                  carrier:
                  service_level:
                  estimated_delivery_date:
                  unpriced: false
                deliveries:
                - id: dlv_UkLWZg9DAJ
                  tracking_number: TRACK-1
                  carrier:
                  carrier_name:
                  service:
                  status: pending
                  tracking_url:
                  estimated_delivery_at:
                  delivered_at:
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  shipping_label_id:
                labels: []
              schema:
                "$ref": "#/components/schemas/Fulfillment"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/FulfillmentFulfillParams"
  "/api/v3/seller/orders/{order_id}/fulfillments/{id}":
    parameters:
    - name: order_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Show a fulfillment
      tags:
      - Fulfillments
      security:
      - bearer_auth: []
      description: 'One of this seller''s parcels: what it holds, where it ships from
        and how it is tracked.'
      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.get('or_UkLWZg9DAJ', 'ful_UkLWZg9DAJ')
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: fulfillment found
          content:
            application/json:
              example:
                id: ful_UkLWZg9DAJ
                number: R1001-F1
                status: unfulfilled
                tracking: U10000
                tracking_url:
                fulfilled_at:
                delivered_at:
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                fulfillment_type: shipping
                delivery_method_name: UPS Ground 131
                stock_location_name: Melony Block
                stock_location_id: sloc_UkLWZg9DAJ
                fulfillment_items:
                - id: fi_UkLWZg9DAJ
                  quantity: 1
                  line_item_id: li_UkLWZg9DAJ
                  variant_id: variant_UkLWZg9DAJ
                  name: Product 2542065
                  sku: SKU-340
                  options_text: ''
                selected_delivery_rate_id: dr_gbHJdmfrXB
                delivery_rates:
                - id: dr_gbHJdmfrXB
                  name: UPS Ground 131
                  selected: true
                  cost: '10.00'
                  total: '10.00'
                  carrier:
                  service_level:
                  estimated_delivery_date:
                  unpriced: false
                deliveries:
                - id: dlv_UkLWZg9DAJ
                  tracking_number: U10000
                  carrier:
                  carrier_name:
                  service:
                  status: pending
                  tracking_url:
                  estimated_delivery_at:
                  delivered_at:
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  shipping_label_id:
                labels: []
              schema:
                "$ref": "#/components/schemas/Fulfillment"
    patch:
      summary: Update tracking
      tags:
      - Fulfillments
      security:
      - bearer_auth: []
      description: |
        Adds or corrects the tracking number and its carrier. Can also move the
        parcel to another of the seller's own stock locations, which quotes its
        rates 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: tracking recorded
          content:
            application/json:
              example:
                id: ful_UkLWZg9DAJ
                number: R1001-F1
                status: unfulfilled
                tracking: TRACK-2
                tracking_url: https://www.ups.com/track?tracknum=TRACK-2
                fulfilled_at:
                delivered_at:
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                fulfillment_type: shipping
                delivery_method_name: UPS Ground 132
                stock_location_name: Eugena Schultz
                stock_location_id: sloc_UkLWZg9DAJ
                fulfillment_items:
                - id: fi_UkLWZg9DAJ
                  quantity: 1
                  line_item_id: li_UkLWZg9DAJ
                  variant_id: variant_UkLWZg9DAJ
                  name: Product 2553170
                  sku: SKU-341
                  options_text: ''
                selected_delivery_rate_id: dr_gbHJdmfrXB
                delivery_rates:
                - id: dr_gbHJdmfrXB
                  name: UPS Ground 132
                  selected: true
                  cost: '10.00'
                  total: '10.00'
                  carrier:
                  service_level:
                  estimated_delivery_date:
                  unpriced: false
                deliveries:
                - id: dlv_UkLWZg9DAJ
                  tracking_number: TRACK-2
                  carrier: ups
                  carrier_name: UPS
                  service:
                  status: pending
                  tracking_url: https://www.ups.com/track?tracknum=TRACK-2
                  estimated_delivery_at:
                  delivered_at:
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  shipping_label_id:
                labels: []
              schema:
                "$ref": "#/components/schemas/Fulfillment"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/FulfillmentUpdateParams"
        required: true
  "/api/v3/seller/orders/{order_id}/fulfillments/{id}/cancel":
    parameters:
    - name: order_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    patch:
      summary: Cancel a parcel
      tags:
      - Fulfillments
      security:
      - bearer_auth: []
      description: |
        A parcel this seller is not going to send after all. The goods go back
        on 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: parcel canceled
          content:
            application/json:
              example:
                id: ful_UkLWZg9DAJ
                number: R1001-F1
                status: canceled
                tracking: U10000
                tracking_url:
                fulfilled_at:
                delivered_at:
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                fulfillment_type: shipping
                delivery_method_name: UPS Ground 133
                stock_location_name: Karyn Moore
                stock_location_id: sloc_UkLWZg9DAJ
                fulfillment_items:
                - id: fi_UkLWZg9DAJ
                  quantity: 1
                  line_item_id: li_UkLWZg9DAJ
                  variant_id: variant_UkLWZg9DAJ
                  name: Product 2567276
                  sku: SKU-342
                  options_text: ''
                selected_delivery_rate_id: dr_gbHJdmfrXB
                delivery_rates:
                - id: dr_gbHJdmfrXB
                  name: UPS Ground 133
                  selected: true
                  cost: '10.00'
                  total: '10.00'
                  carrier:
                  service_level:
                  estimated_delivery_date:
                  unpriced: false
                deliveries:
                - id: dlv_UkLWZg9DAJ
                  tracking_number: U10000
                  carrier:
                  carrier_name:
                  service:
                  status: pending
                  tracking_url:
                  estimated_delivery_at:
                  delivered_at:
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  shipping_label_id:
                labels: []
              schema:
                "$ref": "#/components/schemas/Fulfillment"
  "/api/v3/seller/orders/{order_id}/fulfillments/{id}/split":
    parameters:
    - name: order_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    patch:
      summary: Split a parcel
      tags:
      - Fulfillments
      security:
      - bearer_auth: []
      description: |
        Moves part of what this parcel holds onto a new one, for goods leaving
        separately. Answers with every fulfillment on the order, since
        splitting 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: parcel split
          content:
            application/json:
              example:
                data:
                - id: ful_UkLWZg9DAJ
                  number: R1001-F1
                  status: unfulfilled
                  tracking: U10000
                  tracking_url:
                  fulfilled_at:
                  delivered_at:
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  fulfillment_type: shipping
                  delivery_method_name: UPS Ground 134
                  stock_location_name: Fred Hand
                  stock_location_id: sloc_UkLWZg9DAJ
                  fulfillment_items:
                  - id: fi_gbHJdmfrXB
                    quantity: 1
                    line_item_id: li_gbHJdmfrXB
                    variant_id: variant_gbHJdmfrXB
                    name: Product 2581765
                    sku: SKU-344
                    options_text: ''
                  selected_delivery_rate_id: dr_EfhxLZ9ck8
                  delivery_rates:
                  - id: dr_EfhxLZ9ck8
                    name: UPS Ground 134
                    selected: true
                    cost: '10.00'
                    total: '10.00'
                    carrier:
                    service_level:
                    estimated_delivery_date:
                    unpriced: false
                  deliveries:
                  - id: dlv_UkLWZg9DAJ
                    tracking_number: U10000
                    carrier:
                    carrier_name:
                    service:
                    status: pending
                    tracking_url:
                    estimated_delivery_at:
                    delivered_at:
                    created_at: '2026-01-15T12:00:00.000Z'
                    updated_at: '2026-01-15T12:00:00.000Z'
                    shipping_label_id:
                  labels: []
                - id: ful_gbHJdmfrXB
                  number: R1001-F2
                  status: unfulfilled
                  tracking:
                  tracking_url:
                  fulfilled_at:
                  delivered_at:
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  fulfillment_type: shipping
                  delivery_method_name: UPS Ground 134
                  stock_location_name: Fred Hand
                  stock_location_id: sloc_UkLWZg9DAJ
                  fulfillment_items:
                  - id: fi_EfhxLZ9ck8
                    quantity: 1
                    line_item_id: li_UkLWZg9DAJ
                    variant_id: variant_UkLWZg9DAJ
                    name: Product 2573520
                    sku: SKU-343
                    options_text: ''
                  selected_delivery_rate_id: dr_VqXmZF31wY
                  delivery_rates:
                  - id: dr_VqXmZF31wY
                    name: UPS Ground 134
                    selected: true
                    cost: '10.00'
                    total: '10.00'
                    carrier:
                    service_level:
                    estimated_delivery_date:
                    unpriced: false
                  deliveries: []
                  labels: []
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/FulfillmentSplitParams"
        required: true
  "/api/v3/seller/orders/{order_id}/fulfillments/{fulfillment_id}/deliveries":
    parameters:
    - name: order_id
      in: path
      description: Prefixed order ID
      required: true
      schema:
        type: string
    - name: fulfillment_id
      in: path
      description: Prefixed fulfillment ID
      required: true
      schema:
        type: string
    get:
      summary: List deliveries
      tags:
      - Fulfillments
      security:
      - bearer_auth: []
      description: The consignments of one of this seller's parcels, one per tracking
        number, 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-Id
        in: header
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: false
        description: Page number
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        description: Records per page (max 100)
        schema:
          type: integer
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[carrier_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `carrier` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `status` | One of `pending`, `pre_transit`, `in_transit`, `out_for_delivery`, `available_for_pickup`, `delivered`, `return_to_sender`, `failure`, `unknown` | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `tracking_number` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `carrier`, `created_at`, `id`, `status`, `tracking_number`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: Delivery
        sortable:
        - carrier
        - created_at
        - id
        - status
        - tracking_number
        - updated_at
      responses:
        '200':
          description: deliveries listed
          content:
            application/json:
              example:
                data:
                - id: dlv_UkLWZg9DAJ
                  tracking_number: U10000
                  carrier:
                  carrier_name:
                  service:
                  status: pending
                  tracking_url:
                  estimated_delivery_at:
                  delivered_at:
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  shipping_label_id:
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/Delivery"
                  meta:
                    "$ref": "#/components/schemas/PaginationMeta"
                required:
                - data
                - meta
    post:
      summary: Add a delivery
      tags:
      - Fulfillments
      security:
      - bearer_auth: []
      description: 'Adds a tracked consignment to the parcel: a second box, or a freight
        number 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '201':
          description: delivery added
          content:
            application/json:
              example:
                id: dlv_gbHJdmfrXB
                tracking_number: 1Z879E930346834440
                carrier: ups
                carrier_name: UPS
                service:
                status: pending
                tracking_url: https://www.ups.com/track?tracknum=1Z879E930346834440
                estimated_delivery_at:
                delivered_at:
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                shipping_label_id:
              schema:
                "$ref": "#/components/schemas/Delivery"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/DeliveryCreateParams"
        required: true
  "/api/v3/seller/orders/{order_id}/fulfillments/{fulfillment_id}/deliveries/{id}":
    parameters:
    - name: order_id
      in: path
      description: Prefixed order ID
      required: true
      schema:
        type: string
    - name: fulfillment_id
      in: path
      description: Prefixed fulfillment ID
      required: true
      schema:
        type: string
    - name: id
      in: path
      description: Prefixed delivery ID
      required: true
      schema:
        type: string
    get:
      summary: Show a delivery
      tags:
      - Fulfillments
      security:
      - bearer_auth: []
      description: One consignment of one of this seller's parcels, with its tracking
        number and 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 delivery = await client.orders.fulfillments.deliveries.get(
            'or_UkLWZg9DAJ',
            'ful_UkLWZg9DAJ',
            'dlv_UkLWZg9DAJ',
          )
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: delivery found
          content:
            application/json:
              example:
                id: dlv_UkLWZg9DAJ
                tracking_number: U10000
                carrier:
                carrier_name:
                service:
                status: pending
                tracking_url:
                estimated_delivery_at:
                delivered_at:
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                shipping_label_id:
              schema:
                "$ref": "#/components/schemas/Delivery"
    patch:
      summary: Correct a delivery
      tags:
      - Fulfillments
      security:
      - bearer_auth: []
      description: Corrects the tracking number, carrier or link. A corrected number
        starts 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: delivery updated
          content:
            application/json:
              example:
                id: dlv_UkLWZg9DAJ
                tracking_number: CORRECTED-1
                carrier:
                carrier_name:
                service:
                status: pending
                tracking_url:
                estimated_delivery_at:
                delivered_at:
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                shipping_label_id:
              schema:
                "$ref": "#/components/schemas/Delivery"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/DeliveryUpdateParams"
        required: true
    delete:
      summary: Delete a delivery
      tags:
      - Fulfillments
      security:
      - bearer_auth: []
      description: Removes a consignment entered by mistake. One that a label created
        is refused — delete the label instead.
      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.orders.fulfillments.deliveries.delete(
            'or_UkLWZg9DAJ',
            'ful_UkLWZg9DAJ',
            'dlv_UkLWZg9DAJ',
          )
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '204':
          description: delivery deleted
  "/api/v3/seller/orders/{order_id}/fulfillments/{fulfillment_id}/labels":
    parameters:
    - name: order_id
      in: path
      description: Prefixed order ID
      required: true
      schema:
        type: string
    - name: fulfillment_id
      in: path
      description: Prefixed fulfillment ID
      required: true
      schema:
        type: string
    get:
      summary: List shipping labels
      tags:
      - Fulfillments
      security:
      - 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-Id
        in: header
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: false
        description: Page number
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        description: Records per page (max 100)
        schema:
          type: integer
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[carrier_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `carrier` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `source` | One of `purchased`, `uploaded` | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `status` | One of `purchased`, `refund_requested`, `refunded` | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `tracking_number` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `carrier`, `created_at`, `id`, `source`, `status`, `tracking_number`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: ShippingLabel
        sortable:
        - carrier
        - created_at
        - id
        - source
        - status
        - tracking_number
        - updated_at
      responses:
        '200':
          description: labels listed
          content:
            application/json:
              example:
                data:
                - id: lbl_UkLWZg9DAJ
                  source: purchased
                  status: purchased
                  carrier: ups
                  carrier_name: UPS
                  service: Ground
                  tracking_number: 1Z879E930346830007
                  currency: USD
                  format: pdf
                  external_id: shp_4
                  metadata: {}
                  refunded_at:
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  owner_id: ful_UkLWZg9DAJ
                  owner_type: fulfillment
                  cost: '7.25'
                  integration_id:
                  file_pending: false
                  download_url:
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/ShippingLabel"
                  meta:
                    "$ref": "#/components/schemas/PaginationMeta"
                required:
                - data
                - meta
    post:
      summary: Upload a shipping label
      tags:
      - Fulfillments
      security:
      - bearer_auth: []
      description: |
        Records a label the seller bought elsewhere. Upload the file with
        `POST /files` first and send its `signed_id` as `file_signed_id`.
        Buying a label needs the marketplace's carrier account, so a request
        without 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '201':
          description: label recorded
          content:
            application/json:
              example:
                id: lbl_UkLWZg9DAJ
                source: uploaded
                status: purchased
                carrier:
                carrier_name:
                service:
                tracking_number: SELLER-LBL-1
                currency: USD
                format: pdf
                external_id:
                metadata: {}
                refunded_at:
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                owner_id: ful_UkLWZg9DAJ
                owner_type: fulfillment
                cost: '4.20'
                integration_id:
                file_pending: false
                download_url: "/api/v3/seller/orders/or_UkLWZg9DAJ/fulfillments/ful_UkLWZg9DAJ/labels/lbl_UkLWZg9DAJ/download"
              schema:
                "$ref": "#/components/schemas/ShippingLabel"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ShippingLabelCreateParams"
        required: true
  "/api/v3/seller/orders/{order_id}/fulfillments/{fulfillment_id}/labels/{id}":
    parameters:
    - name: order_id
      in: path
      description: Prefixed order ID
      required: true
      schema:
        type: string
    - name: fulfillment_id
      in: path
      description: Prefixed fulfillment ID
      required: true
      schema:
        type: string
    - name: id
      in: path
      description: Prefixed shipping label ID
      required: true
      schema:
        type: string
    get:
      summary: Show a shipping label
      tags:
      - Fulfillments
      security:
      - bearer_auth: []
      description: One label on one of this seller's parcels, with the link to print
        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 label = await client.orders.fulfillments.labels.get(
            'or_UkLWZg9DAJ',
            'ful_UkLWZg9DAJ',
            'lbl_UkLWZg9DAJ',
          )
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: label found
          content:
            application/json:
              example:
                id: lbl_UkLWZg9DAJ
                source: uploaded
                status: purchased
                carrier: ups
                carrier_name: UPS
                service: Ground
                tracking_number: 1Z879E930346830008
                currency: USD
                format: pdf
                external_id:
                metadata: {}
                refunded_at:
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                owner_id: ful_UkLWZg9DAJ
                owner_type: fulfillment
                cost: '7.25'
                integration_id:
                file_pending: false
                download_url: "/api/v3/seller/orders/or_UkLWZg9DAJ/fulfillments/ful_UkLWZg9DAJ/labels/lbl_UkLWZg9DAJ/download"
              schema:
                "$ref": "#/components/schemas/ShippingLabel"
    delete:
      summary: Delete an uploaded label
      tags:
      - Fulfillments
      security:
      - bearer_auth: []
      description: |
        Removes a label uploaded by mistake, so the right one can be uploaded
        in its place. A label the marketplace bought has postage to refund, so
        only the operator can remove 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',
          })

          await client.orders.fulfillments.labels.delete('or_UkLWZg9DAJ', 'ful_UkLWZg9DAJ', 'lbl_UkLWZg9DAJ')
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '204':
          description: label deleted
  "/api/v3/seller/orders/{order_id}/fulfillments/{fulfillment_id}/labels/{id}/download":
    parameters:
    - name: order_id
      in: path
      description: Prefixed order ID
      required: true
      schema:
        type: string
    - name: fulfillment_id
      in: path
      description: Prefixed fulfillment ID
      required: true
      schema:
        type: string
    - name: id
      in: path
      description: Prefixed shipping label ID
      required: true
      schema:
        type: string
    get:
      summary: Download a shipping label
      tags:
      - Fulfillments
      security:
      - bearer_auth: []
      description: |
        Streams the label file for printing.

        Served through the API rather than from a storage URL, 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',
          })

          const label = await client.orders.fulfillments.labels.get(
            'or_UkLWZg9DAJ',
            'ful_UkLWZg9DAJ',
            'lbl_UkLWZg9DAJ',
          )

          if (label.download_url) {
            // Labels are served through the API, so fetch with the session's token
            // and seller, then drive the browser download for printing:
            const response = await fetch(`https://your-store.com${label.download_url}`, {
              headers: { Authorization: 'Bearer eyJhbGciOi...', 'X-Spree-Seller-Id': 'sel_UkLWZg9DAJ' },
            })
            if (!response.ok) throw new Error(`Download failed with status ${response.status}`)
            const url = URL.createObjectURL(await response.blob())
            const link = Object.assign(document.createElement('a'), {
              href: url,
              download: `label-${label.tracking_number ?? label.id}.${label.format ?? 'pdf'}`,
            })
            link.click()
            URL.revokeObjectURL(url)
          }
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: label file streamed
          content:
            application/pdf:
              schema:
                type: string
                format: binary
            image/png:
              schema:
                type: string
                format: binary
            application/octet-stream:
              schema:
                type: string
                format: binary
  "/api/v3/seller/tracking_carriers":
    get:
      summary: List tracking carriers
      tags:
      - Fulfillments
      security:
      - bearer_auth: []
      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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: carriers listed
          content:
            application/json:
              example:
                data:
                - id: australia_post
                  name: Australia Post
                - id: canada_post
                  name: Canada Post
                - id: chronopost
                  name: Chronopost
                - id: colissimo
                  name: Colissimo
                - id: dhl
                  name: DHL Express
                - id: dpd
                  name: DPD
                - id: deutsche_post
                  name: Deutsche Post DHL
                - id: evri
                  name: Evri
                - id: fedex
                  name: FedEx
                - id: gls
                  name: GLS
                - id: inpost
                  name: InPost
                - id: poczta_polska
                  name: Poczta Polska
                - id: postnl
                  name: PostNL
                - id: royal_mail
                  name: Royal Mail
                - id: ups
                  name: UPS
                - id: usps
                  name: USPS
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                      required:
                      - id
                      - name
                required:
                - data
  "/api/v3/seller/imports":
    get:
      summary: List imports
      tags:
      - Imports
      security:
      - bearer_auth: []
      description: This seller's product CSV imports, queued or finished. Another
        seller'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-Id
        in: header
        required: true
        schema:
          type: string
      - name: q[search]
        in: query
        required: false
        schema:
          type: string
        description: Matches any of number (partial, case-insensitive).
      - name: page
        in: query
        required: false
        description: Page number
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        description: Records per page (max 100)
        schema:
          type: integer
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[number_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `number` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `seller_id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `status` | One of `pending`, `mapping`, `completed_mapping`, `processing`, `completed`, `failed` | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `type` | Type | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `created_at`, `id`, `number`, `seller_id`, `status`, `type`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: Import
        sortable:
        - created_at
        - id
        - number
        - seller_id
        - status
        - type
        - updated_at
      responses:
        '200':
          description: imports listed
          content:
            application/json:
              example:
                data:
                - id: imp_UkLWZg9DAJ
                  number: IM1001
                  rows_count: 0
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  type: products
                  status: pending
                  store_id: store_UkLWZg9DAJ
                  seller_id: sel_UkLWZg9DAJ
                  user_id: adm_UkLWZg9DAJ
                  processing_errors:
                  delimiter: ","
                  original_filename: products_import.csv
                  original_byte_size: 3627
                  original_file_url: "/api/v3/seller/imports/imp_UkLWZg9DAJ/download"
                  completed_rows_count: 0
                  failed_rows_count: 0
                  schema_fields:
                  - name: slug
                    label: Slug
                    required: true
                  - name: sku
                    label: SKU
                    required: true
                  - name: name
                    label: Name
                    required: true
                  - name: price
                    label: Price
                    required: true
                  - name: status
                    label: Status
                    required: false
                  - name: description
                    label: Description
                    required: false
                  - name: meta_title
                    label: Meta Title
                    required: false
                  - name: meta_description
                    label: Meta Description
                    required: false
                  - name: meta_keywords
                    label: Meta Keywords
                    required: false
                  - name: tags
                    label: Tags
                    required: false
                  - name: compare_at_price
                    label: Compare at Price
                    required: false
                  - name: currency
                    label: Currency
                    required: false
                  - name: width
                    label: Width
                    required: false
                  - name: height
                    label: Height
                    required: false
                  - name: depth
                    label: Depth
                    required: false
                  - name: dimensions_unit
                    label: Dimensions Unit
                    required: false
                  - name: weight
                    label: Weight
                    required: false
                  - name: weight_unit
                    label: Weight Unit
                    required: false
                  - name: available_on
                    label: Available On
                    required: false
                  - name: discontinue_on
                    label: Discontinue On
                    required: false
                  - name: track_inventory
                    label: Track Inventory
                    required: false
                  - name: inventory_count
                    label: Inventory Count
                    required: false
                  - name: inventory_backorderable
                    label: Inventory Backorderable
                    required: false
                  - name: stock_location
                    label: Stock Location
                    required: false
                  - name: tax_category
                    label: Tax Category
                    required: false
                  - name: product_type
                    label: Product Type
                    required: false
                  - name: hs_code
                    label: HS Code
                    required: false
                  - name: country_of_origin
                    label: Country of Origin
                    required: false
                  - name: customs_description
                    label: Customs Description
                    required: false
                  - name: carton
                    label: Carton
                    required: false
                  - name: units_per_carton
                    label: Units per Carton
                    required: false
                  - name: carton_weight
                    label: Carton Weight
                    required: false
                  - name: cartons_per_pallet
                    label: Cartons per Pallet
                    required: false
                  - name: image1_src
                    label: Image 1 URL
                    required: false
                  - name: image2_src
                    label: Image 2 URL
                    required: false
                  - name: image3_src
                    label: Image 3 URL
                    required: false
                  - name: option1_name
                    label: Option 1 Name
                    required: false
                  - name: option1_value
                    label: Option 1 Value
                    required: false
                  - name: option2_name
                    label: Option 2 Name
                    required: false
                  - name: option2_value
                    label: Option 2 Value
                    required: false
                  - name: option3_name
                    label: Option 3 Name
                    required: false
                  - name: option3_value
                    label: Option 3 Value
                    required: false
                  - name: category1
                    label: Category 1
                    required: false
                  - name: category2
                    label: Category 2
                    required: false
                  - name: category3
                    label: Category 3
                    required: false
                  csv_headers: []
                  sample_row: {}
                  mappings: []
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/Import"
                  meta:
                    "$ref": "#/components/schemas/PaginationMeta"
                required:
                - data
                - meta
    post:
      summary: Create an import
      tags:
      - Imports
      security:
      - bearer_auth: []
      description: |
        Starts a product CSV import for this seller. Upload the CSV with `POST /files`
        (`visibility: 'private'`) and pass the returned `signed_id` as
        `attachment_signed_id`. On success the import is in the `mapping` state, carrying
        the 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '201':
          description: import created in mapping state
          content:
            application/json:
              example:
                id: imp_gbHJdmfrXB
                number: IM1002
                rows_count: 0
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                type: products
                status: mapping
                store_id: store_UkLWZg9DAJ
                seller_id: sel_UkLWZg9DAJ
                user_id: adm_UkLWZg9DAJ
                processing_errors:
                delimiter: ","
                original_filename: import.csv
                original_byte_size: 44
                original_file_url: "/api/v3/seller/imports/imp_gbHJdmfrXB/download"
                completed_rows_count: 0
                failed_rows_count: 0
                schema_fields:
                - name: slug
                  label: Slug
                  required: true
                - name: sku
                  label: SKU
                  required: true
                - name: name
                  label: Name
                  required: true
                - name: price
                  label: Price
                  required: true
                - name: status
                  label: Status
                  required: false
                - name: description
                  label: Description
                  required: false
                - name: meta_title
                  label: Meta Title
                  required: false
                - name: meta_description
                  label: Meta Description
                  required: false
                - name: meta_keywords
                  label: Meta Keywords
                  required: false
                - name: tags
                  label: Tags
                  required: false
                - name: compare_at_price
                  label: Compare at Price
                  required: false
                - name: currency
                  label: Currency
                  required: false
                - name: width
                  label: Width
                  required: false
                - name: height
                  label: Height
                  required: false
                - name: depth
                  label: Depth
                  required: false
                - name: dimensions_unit
                  label: Dimensions Unit
                  required: false
                - name: weight
                  label: Weight
                  required: false
                - name: weight_unit
                  label: Weight Unit
                  required: false
                - name: available_on
                  label: Available On
                  required: false
                - name: discontinue_on
                  label: Discontinue On
                  required: false
                - name: track_inventory
                  label: Track Inventory
                  required: false
                - name: inventory_count
                  label: Inventory Count
                  required: false
                - name: inventory_backorderable
                  label: Inventory Backorderable
                  required: false
                - name: stock_location
                  label: Stock Location
                  required: false
                - name: tax_category
                  label: Tax Category
                  required: false
                - name: product_type
                  label: Product Type
                  required: false
                - name: hs_code
                  label: HS Code
                  required: false
                - name: country_of_origin
                  label: Country of Origin
                  required: false
                - name: customs_description
                  label: Customs Description
                  required: false
                - name: carton
                  label: Carton
                  required: false
                - name: units_per_carton
                  label: Units per Carton
                  required: false
                - name: carton_weight
                  label: Carton Weight
                  required: false
                - name: cartons_per_pallet
                  label: Cartons per Pallet
                  required: false
                - name: image1_src
                  label: Image 1 URL
                  required: false
                - name: image2_src
                  label: Image 2 URL
                  required: false
                - name: image3_src
                  label: Image 3 URL
                  required: false
                - name: option1_name
                  label: Option 1 Name
                  required: false
                - name: option1_value
                  label: Option 1 Value
                  required: false
                - name: option2_name
                  label: Option 2 Name
                  required: false
                - name: option2_value
                  label: Option 2 Value
                  required: false
                - name: option3_name
                  label: Option 3 Name
                  required: false
                - name: option3_value
                  label: Option 3 Value
                  required: false
                - name: category1
                  label: Category 1
                  required: false
                - name: category2
                  label: Category 2
                  required: false
                - name: category3
                  label: Category 3
                  required: false
                csv_headers:
                - slug
                - sku
                - name
                - price
                sample_row:
                  slug: widget
                  sku: W-1
                  name: Widget
                  price: '10.00'
                mappings:
                - id: immap_UkLWZg9DAJ
                  schema_field: slug
                  file_column: slug
                  required: true
                - id: immap_gbHJdmfrXB
                  schema_field: sku
                  file_column: sku
                  required: true
                - id: immap_EfhxLZ9ck8
                  schema_field: name
                  file_column: name
                  required: true
                - id: immap_VqXmZF31wY
                  schema_field: price
                  file_column: price
                  required: true
                - id: immap_uw2YK1rnl0
                  schema_field: status
                  file_column:
                  required: false
                - id: immap_OIJLhNcSbf
                  schema_field: description
                  file_column:
                  required: false
                - id: immap_AXs1igzRC6
                  schema_field: meta_title
                  file_column:
                  required: false
                - id: immap_p6klVeMgbn
                  schema_field: meta_description
                  file_column:
                  required: false
                - id: immap_nJqfPa3Cpe
                  schema_field: meta_keywords
                  file_column:
                  required: false
                - id: immap_98FqgRua4h
                  schema_field: tags
                  file_column:
                  required: false
                - id: immap_xhoCpeNMWu
                  schema_field: compare_at_price
                  file_column:
                  required: false
                - id: immap_vEmzDoNU0H
                  schema_field: currency
                  file_column:
                  required: false
                - id: immap_2KY5XM6frI
                  schema_field: width
                  file_column:
                  required: false
                - id: immap_HOVtlDrOmL
                  schema_field: height
                  file_column:
                  required: false
                - id: immap_ed6l8wVqSM
                  schema_field: depth
                  file_column:
                  required: false
                - id: immap_s18jaGonyx
                  schema_field: dimensions_unit
                  file_column:
                  required: false
                - id: immap_GZUcnUYI5A
                  schema_field: weight
                  file_column:
                  required: false
                - id: immap_ROeNhrwyV9
                  schema_field: weight_unit
                  file_column:
                  required: false
                - id: immap_L3pHOn63Vw
                  schema_field: available_on
                  file_column:
                  required: false
                - id: immap_PQNMcnNFWw
                  schema_field: discontinue_on
                  file_column:
                  required: false
                - id: immap_C9SrJgpzQ4
                  schema_field: track_inventory
                  file_column:
                  required: false
                - id: immap_YHETxCGlb0
                  schema_field: inventory_count
                  file_column:
                  required: false
                - id: immap_5OQZnCRf8J
                  schema_field: inventory_backorderable
                  file_column:
                  required: false
                - id: immap_F0GX8NaP3Y
                  schema_field: stock_location
                  file_column:
                  required: false
                - id: immap_kOKT9MVfb0
                  schema_field: tax_category
                  file_column:
                  required: false
                - id: immap_3uWpPTcf5W
                  schema_field: product_type
                  file_column:
                  required: false
                - id: immap_D6Psx31WaT
                  schema_field: hs_code
                  file_column:
                  required: false
                - id: immap_msx3nOJap6
                  schema_field: country_of_origin
                  file_column:
                  required: false
                - id: immap_5CQZnCRf8J
                  schema_field: customs_description
                  file_column:
                  required: false
                - id: immap_M2nyloHRUQ
                  schema_field: carton
                  file_column:
                  required: false
                - id: immap_prklVeMgbn
                  schema_field: units_per_carton
                  file_column:
                  required: false
                - id: immap_so8jaGonyx
                  schema_field: carton_weight
                  file_column:
                  required: false
                - id: immap_rsClYtECFI
                  schema_field: cartons_per_pallet
                  file_column:
                  required: false
                - id: immap_8DR0I7fEbw
                  schema_field: image1_src
                  file_column:
                  required: false
                - id: immap_aAtNvLSUAr
                  schema_field: image2_src
                  file_column:
                  required: false
                - id: immap_QiA48cIW7A
                  schema_field: image3_src
                  file_column:
                  required: false
                - id: immap_QDA48cIW7A
                  schema_field: option1_name
                  file_column:
                  required: false
                - id: immap_8cR0I7fEbw
                  schema_field: option1_value
                  file_column:
                  required: false
                - id: immap_oqlrKdXjaP
                  schema_field: option2_name
                  file_column:
                  required: false
                - id: immap_48Olu6p4zZ
                  schema_field: option2_value
                  file_column:
                  required: false
                - id: immap_qp31JYFduR
                  schema_field: option3_name
                  file_column:
                  required: false
                - id: immap_JgaEBgznCp
                  schema_field: option3_value
                  file_column:
                  required: false
                - id: immap_tXyJwvFCuK
                  schema_field: category1
                  file_column:
                  required: false
                - id: immap_NJzXvxTk8u
                  schema_field: category2
                  file_column:
                  required: false
                - id: immap_XLbb5HTmVa
                  schema_field: category3
                  file_column:
                  required: false
              schema:
                "$ref": "#/components/schemas/Import"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ImportCreateParams"
        required: true
  "/api/v3/seller/imports/{id}":
    parameters:
    - name: id
      in: path
      required: true
      description: Import prefixed ID
      schema:
        type: string
    get:
      summary: Get an import
      tags:
      - Imports
      security:
      - bearer_auth: []
      description: |
        One of this seller's imports. Poll it while `status` is `completed_mapping`
        or `processing`; `completed` and `failed` are final. An id belonging to
        another seller 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 productImport = await client.imports.get('imp_UkLWZg9DAJ')
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: import returned
          content:
            application/json:
              example:
                id: imp_UkLWZg9DAJ
                number: IM1001
                rows_count: 0
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                type: products
                status: pending
                store_id: store_UkLWZg9DAJ
                seller_id: sel_UkLWZg9DAJ
                user_id: adm_UkLWZg9DAJ
                processing_errors:
                delimiter: ","
                original_filename: products_import.csv
                original_byte_size: 3627
                original_file_url: "/api/v3/seller/imports/imp_UkLWZg9DAJ/download"
                completed_rows_count: 0
                failed_rows_count: 0
                schema_fields:
                - name: slug
                  label: Slug
                  required: true
                - name: sku
                  label: SKU
                  required: true
                - name: name
                  label: Name
                  required: true
                - name: price
                  label: Price
                  required: true
                - name: status
                  label: Status
                  required: false
                - name: description
                  label: Description
                  required: false
                - name: meta_title
                  label: Meta Title
                  required: false
                - name: meta_description
                  label: Meta Description
                  required: false
                - name: meta_keywords
                  label: Meta Keywords
                  required: false
                - name: tags
                  label: Tags
                  required: false
                - name: compare_at_price
                  label: Compare at Price
                  required: false
                - name: currency
                  label: Currency
                  required: false
                - name: width
                  label: Width
                  required: false
                - name: height
                  label: Height
                  required: false
                - name: depth
                  label: Depth
                  required: false
                - name: dimensions_unit
                  label: Dimensions Unit
                  required: false
                - name: weight
                  label: Weight
                  required: false
                - name: weight_unit
                  label: Weight Unit
                  required: false
                - name: available_on
                  label: Available On
                  required: false
                - name: discontinue_on
                  label: Discontinue On
                  required: false
                - name: track_inventory
                  label: Track Inventory
                  required: false
                - name: inventory_count
                  label: Inventory Count
                  required: false
                - name: inventory_backorderable
                  label: Inventory Backorderable
                  required: false
                - name: stock_location
                  label: Stock Location
                  required: false
                - name: tax_category
                  label: Tax Category
                  required: false
                - name: product_type
                  label: Product Type
                  required: false
                - name: hs_code
                  label: HS Code
                  required: false
                - name: country_of_origin
                  label: Country of Origin
                  required: false
                - name: customs_description
                  label: Customs Description
                  required: false
                - name: carton
                  label: Carton
                  required: false
                - name: units_per_carton
                  label: Units per Carton
                  required: false
                - name: carton_weight
                  label: Carton Weight
                  required: false
                - name: cartons_per_pallet
                  label: Cartons per Pallet
                  required: false
                - name: image1_src
                  label: Image 1 URL
                  required: false
                - name: image2_src
                  label: Image 2 URL
                  required: false
                - name: image3_src
                  label: Image 3 URL
                  required: false
                - name: option1_name
                  label: Option 1 Name
                  required: false
                - name: option1_value
                  label: Option 1 Value
                  required: false
                - name: option2_name
                  label: Option 2 Name
                  required: false
                - name: option2_value
                  label: Option 2 Value
                  required: false
                - name: option3_name
                  label: Option 3 Name
                  required: false
                - name: option3_value
                  label: Option 3 Value
                  required: false
                - name: category1
                  label: Category 1
                  required: false
                - name: category2
                  label: Category 2
                  required: false
                - name: category3
                  label: Category 3
                  required: false
                csv_headers: []
                sample_row: {}
                mappings: []
              schema:
                "$ref": "#/components/schemas/Import"
        '404':
          description: another seller's import
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Import not found
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
    delete:
      summary: Delete an import
      tags:
      - Imports
      security:
      - bearer_auth: []
      description: Deletes one of this seller's imports together with its rows. Products
        it already created are kept.
      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.imports.delete('imp_UkLWZg9DAJ')
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '204':
          description: import deleted
  "/api/v3/seller/imports/{import_id}/rows":
    parameters:
    - name: import_id
      in: path
      required: true
      description: Import prefixed ID
      schema:
        type: string
    get:
      summary: List import rows
      tags:
      - Imports
      security:
      - bearer_auth: []
      description: The rows of one of this seller's imports, each with its status
        and 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-Id
        in: header
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: false
        description: Page number
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        description: Records per page (max 100)
        schema:
          type: integer
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[created_at_eq]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `row_number` | Number | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `status` | One of `pending`, `processing`, `completed`, `failed` | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `created_at`, `id`, `row_number`, `status`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: ImportRow
        sortable:
        - created_at
        - id
        - row_number
        - status
        - updated_at
      responses:
        '200':
          description: rows listed
          content:
            application/json:
              example:
                data:
                - id: imrow_UkLWZg9DAJ
                  row_number: 1
                  status: pending
                  validation_errors:
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  import_id: imp_UkLWZg9DAJ
                  item_type:
                  item_id:
                  data:
                    slug: test-product
                    name: Test Product
                    price: '10.00'
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/ImportRow"
                  meta:
                    "$ref": "#/components/schemas/PaginationMeta"
                required:
                - data
                - meta
  "/api/v3/seller/imports/{id}/complete_mapping":
    parameters:
    - name: id
      in: path
      required: true
      description: Import prefixed ID
      schema:
        type: string
    patch:
      summary: Complete mapping and start processing
      tags:
      - Imports
      security:
      - bearer_auth: []
      description: |
        Applies the submitted column mappings, then starts row processing. Omit `mappings`
        to accept the auto-assigned ones from the create response. Returns 422 when a
        required 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: mapping completed, processing queued
          content:
            application/json:
              example:
                id: imp_UkLWZg9DAJ
                number: IM1001
                rows_count: 0
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                type: products
                status: completed_mapping
                store_id: store_UkLWZg9DAJ
                seller_id: sel_UkLWZg9DAJ
                user_id: adm_UkLWZg9DAJ
                processing_errors:
                delimiter: ","
                original_filename: products_import.csv
                original_byte_size: 3627
                original_file_url: "/api/v3/seller/imports/imp_UkLWZg9DAJ/download"
                completed_rows_count: 0
                failed_rows_count: 0
                schema_fields:
                - name: slug
                  label: Slug
                  required: true
                - name: sku
                  label: SKU
                  required: true
                - name: name
                  label: Name
                  required: true
                - name: price
                  label: Price
                  required: true
                - name: status
                  label: Status
                  required: false
                - name: description
                  label: Description
                  required: false
                - name: meta_title
                  label: Meta Title
                  required: false
                - name: meta_description
                  label: Meta Description
                  required: false
                - name: meta_keywords
                  label: Meta Keywords
                  required: false
                - name: tags
                  label: Tags
                  required: false
                - name: compare_at_price
                  label: Compare at Price
                  required: false
                - name: currency
                  label: Currency
                  required: false
                - name: width
                  label: Width
                  required: false
                - name: height
                  label: Height
                  required: false
                - name: depth
                  label: Depth
                  required: false
                - name: dimensions_unit
                  label: Dimensions Unit
                  required: false
                - name: weight
                  label: Weight
                  required: false
                - name: weight_unit
                  label: Weight Unit
                  required: false
                - name: available_on
                  label: Available On
                  required: false
                - name: discontinue_on
                  label: Discontinue On
                  required: false
                - name: track_inventory
                  label: Track Inventory
                  required: false
                - name: inventory_count
                  label: Inventory Count
                  required: false
                - name: inventory_backorderable
                  label: Inventory Backorderable
                  required: false
                - name: stock_location
                  label: Stock Location
                  required: false
                - name: tax_category
                  label: Tax Category
                  required: false
                - name: product_type
                  label: Product Type
                  required: false
                - name: hs_code
                  label: HS Code
                  required: false
                - name: country_of_origin
                  label: Country of Origin
                  required: false
                - name: customs_description
                  label: Customs Description
                  required: false
                - name: carton
                  label: Carton
                  required: false
                - name: units_per_carton
                  label: Units per Carton
                  required: false
                - name: carton_weight
                  label: Carton Weight
                  required: false
                - name: cartons_per_pallet
                  label: Cartons per Pallet
                  required: false
                - name: image1_src
                  label: Image 1 URL
                  required: false
                - name: image2_src
                  label: Image 2 URL
                  required: false
                - name: image3_src
                  label: Image 3 URL
                  required: false
                - name: option1_name
                  label: Option 1 Name
                  required: false
                - name: option1_value
                  label: Option 1 Value
                  required: false
                - name: option2_name
                  label: Option 2 Name
                  required: false
                - name: option2_value
                  label: Option 2 Value
                  required: false
                - name: option3_name
                  label: Option 3 Name
                  required: false
                - name: option3_value
                  label: Option 3 Value
                  required: false
                - name: category1
                  label: Category 1
                  required: false
                - name: category2
                  label: Category 2
                  required: false
                - name: category3
                  label: Category 3
                  required: false
                csv_headers: []
                sample_row: {}
                mappings:
                - id: immap_UkLWZg9DAJ
                  schema_field: slug
                  file_column: slug
                  required: true
                - id: immap_gbHJdmfrXB
                  schema_field: sku
                  file_column: sku
                  required: true
                - id: immap_EfhxLZ9ck8
                  schema_field: name
                  file_column: name
                  required: true
                - id: immap_VqXmZF31wY
                  schema_field: price
                  file_column: price
                  required: true
                - id: immap_uw2YK1rnl0
                  schema_field: status
                  file_column: status
                  required: false
                - id: immap_OIJLhNcSbf
                  schema_field: description
                  file_column: description
                  required: false
                - id: immap_AXs1igzRC6
                  schema_field: meta_title
                  file_column: meta_title
                  required: false
                - id: immap_p6klVeMgbn
                  schema_field: meta_description
                  file_column: meta_description
                  required: false
                - id: immap_nJqfPa3Cpe
                  schema_field: meta_keywords
                  file_column: meta_keywords
                  required: false
                - id: immap_98FqgRua4h
                  schema_field: tags
                  file_column: tags
                  required: false
                - id: immap_xhoCpeNMWu
                  schema_field: compare_at_price
                  file_column: compare_at_price
                  required: false
                - id: immap_vEmzDoNU0H
                  schema_field: currency
                  file_column: currency
                  required: false
                - id: immap_2KY5XM6frI
                  schema_field: width
                  file_column: width
                  required: false
                - id: immap_HOVtlDrOmL
                  schema_field: height
                  file_column: height
                  required: false
                - id: immap_ed6l8wVqSM
                  schema_field: depth
                  file_column: depth
                  required: false
                - id: immap_s18jaGonyx
                  schema_field: dimensions_unit
                  file_column: dimensions_unit
                  required: false
                - id: immap_GZUcnUYI5A
                  schema_field: weight
                  file_column: weight
                  required: false
                - id: immap_ROeNhrwyV9
                  schema_field: weight_unit
                  file_column: weight_unit
                  required: false
                - id: immap_L3pHOn63Vw
                  schema_field: available_on
                  file_column: available_on
                  required: false
                - id: immap_PQNMcnNFWw
                  schema_field: discontinue_on
                  file_column: discontinue_on
                  required: false
                - id: immap_C9SrJgpzQ4
                  schema_field: track_inventory
                  file_column: track_inventory
                  required: false
                - id: immap_YHETxCGlb0
                  schema_field: inventory_count
                  file_column: inventory_count
                  required: false
                - id: immap_5OQZnCRf8J
                  schema_field: inventory_backorderable
                  file_column: inventory_backorderable
                  required: false
                - id: immap_F0GX8NaP3Y
                  schema_field: stock_location
                  file_column:
                  required: false
                - id: immap_kOKT9MVfb0
                  schema_field: tax_category
                  file_column: tax_category
                  required: false
                - id: immap_3uWpPTcf5W
                  schema_field: product_type
                  file_column:
                  required: false
                - id: immap_D6Psx31WaT
                  schema_field: hs_code
                  file_column:
                  required: false
                - id: immap_msx3nOJap6
                  schema_field: country_of_origin
                  file_column:
                  required: false
                - id: immap_5CQZnCRf8J
                  schema_field: customs_description
                  file_column:
                  required: false
                - id: immap_M2nyloHRUQ
                  schema_field: carton
                  file_column:
                  required: false
                - id: immap_prklVeMgbn
                  schema_field: units_per_carton
                  file_column:
                  required: false
                - id: immap_so8jaGonyx
                  schema_field: carton_weight
                  file_column:
                  required: false
                - id: immap_rsClYtECFI
                  schema_field: cartons_per_pallet
                  file_column:
                  required: false
                - id: immap_8DR0I7fEbw
                  schema_field: image1_src
                  file_column: image1_src
                  required: false
                - id: immap_aAtNvLSUAr
                  schema_field: image2_src
                  file_column: image2_src
                  required: false
                - id: immap_QiA48cIW7A
                  schema_field: image3_src
                  file_column: image3_src
                  required: false
                - id: immap_QDA48cIW7A
                  schema_field: option1_name
                  file_column: option1_name
                  required: false
                - id: immap_8cR0I7fEbw
                  schema_field: option1_value
                  file_column: option1_value
                  required: false
                - id: immap_oqlrKdXjaP
                  schema_field: option2_name
                  file_column: option2_name
                  required: false
                - id: immap_48Olu6p4zZ
                  schema_field: option2_value
                  file_column: option2_value
                  required: false
                - id: immap_qp31JYFduR
                  schema_field: option3_name
                  file_column: option3_name
                  required: false
                - id: immap_JgaEBgznCp
                  schema_field: option3_value
                  file_column: option3_value
                  required: false
                - id: immap_tXyJwvFCuK
                  schema_field: category1
                  file_column: category1
                  required: false
                - id: immap_NJzXvxTk8u
                  schema_field: category2
                  file_column: category2
                  required: false
                - id: immap_XLbb5HTmVa
                  schema_field: category3
                  file_column: category3
                  required: false
              schema:
                "$ref": "#/components/schemas/Import"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ImportCompleteMappingParams"
  "/api/v3/seller/imports/{id}/retry_failed_rows":
    parameters:
    - name: id
      in: path
      required: true
      description: Import prefixed ID
      schema:
        type: string
    patch:
      summary: Retry failed rows
      tags:
      - Imports
      security:
      - bearer_auth: []
      description: |
        Processes the rows that failed again, typically after fixing what they
        referred to. The import goes back to `processing`; poll
        `GET /imports/{id}` until it finishes. Returns 422 when the import has
        no failed rows to retry.
      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.retryFailedRows('imp_UkLWZg9DAJ')
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: retry queued
          content:
            application/json:
              example:
                id: imp_UkLWZg9DAJ
                number: IM1001
                rows_count: 1
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                type: products
                status: processing
                store_id: store_UkLWZg9DAJ
                seller_id: sel_UkLWZg9DAJ
                user_id: adm_UkLWZg9DAJ
                processing_errors:
                delimiter: ","
                original_filename: products_import.csv
                original_byte_size: 3627
                original_file_url: "/api/v3/seller/imports/imp_UkLWZg9DAJ/download"
                completed_rows_count: 0
                failed_rows_count: 1
                schema_fields:
                - name: slug
                  label: Slug
                  required: true
                - name: sku
                  label: SKU
                  required: true
                - name: name
                  label: Name
                  required: true
                - name: price
                  label: Price
                  required: true
                - name: status
                  label: Status
                  required: false
                - name: description
                  label: Description
                  required: false
                - name: meta_title
                  label: Meta Title
                  required: false
                - name: meta_description
                  label: Meta Description
                  required: false
                - name: meta_keywords
                  label: Meta Keywords
                  required: false
                - name: tags
                  label: Tags
                  required: false
                - name: compare_at_price
                  label: Compare at Price
                  required: false
                - name: currency
                  label: Currency
                  required: false
                - name: width
                  label: Width
                  required: false
                - name: height
                  label: Height
                  required: false
                - name: depth
                  label: Depth
                  required: false
                - name: dimensions_unit
                  label: Dimensions Unit
                  required: false
                - name: weight
                  label: Weight
                  required: false
                - name: weight_unit
                  label: Weight Unit
                  required: false
                - name: available_on
                  label: Available On
                  required: false
                - name: discontinue_on
                  label: Discontinue On
                  required: false
                - name: track_inventory
                  label: Track Inventory
                  required: false
                - name: inventory_count
                  label: Inventory Count
                  required: false
                - name: inventory_backorderable
                  label: Inventory Backorderable
                  required: false
                - name: stock_location
                  label: Stock Location
                  required: false
                - name: tax_category
                  label: Tax Category
                  required: false
                - name: product_type
                  label: Product Type
                  required: false
                - name: hs_code
                  label: HS Code
                  required: false
                - name: country_of_origin
                  label: Country of Origin
                  required: false
                - name: customs_description
                  label: Customs Description
                  required: false
                - name: carton
                  label: Carton
                  required: false
                - name: units_per_carton
                  label: Units per Carton
                  required: false
                - name: carton_weight
                  label: Carton Weight
                  required: false
                - name: cartons_per_pallet
                  label: Cartons per Pallet
                  required: false
                - name: image1_src
                  label: Image 1 URL
                  required: false
                - name: image2_src
                  label: Image 2 URL
                  required: false
                - name: image3_src
                  label: Image 3 URL
                  required: false
                - name: option1_name
                  label: Option 1 Name
                  required: false
                - name: option1_value
                  label: Option 1 Value
                  required: false
                - name: option2_name
                  label: Option 2 Name
                  required: false
                - name: option2_value
                  label: Option 2 Value
                  required: false
                - name: option3_name
                  label: Option 3 Name
                  required: false
                - name: option3_value
                  label: Option 3 Value
                  required: false
                - name: category1
                  label: Category 1
                  required: false
                - name: category2
                  label: Category 2
                  required: false
                - name: category3
                  label: Category 3
                  required: false
                csv_headers: []
                sample_row: {}
                mappings: []
              schema:
                "$ref": "#/components/schemas/Import"
        '422':
          description: no failed rows to retry
          content:
            application/json:
              example:
                error:
                  code: validation_error
                  message: Import has no failed rows to retry
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
  "/api/v3/seller/imports/{id}/download":
    parameters:
    - name: id
      in: path
      required: true
      description: Import prefixed ID
      schema:
        type: string
    get:
      summary: Download the uploaded file
      tags:
      - Imports
      security:
      - bearer_auth: []
      description: |
        Streams the CSV exactly as the seller uploaded it — a record of what was
        imported.

        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',
          })

          const productImport = await client.imports.get('imp_UkLWZg9DAJ')

          if (productImport.original_file_url) {
            // The uploaded file is served through the API, so fetch it with the
            // session's token and seller, then drive the browser download:
            const response = await fetch(`https://your-store.com${productImport.original_file_url}`, {
              headers: { Authorization: 'Bearer eyJhbGciOi...', 'X-Spree-Seller-Id': 'sel_UkLWZg9DAJ' },
            })
            if (!response.ok) throw new Error(`Download failed with status ${response.status}`)
            const url = URL.createObjectURL(await response.blob())
            const link = Object.assign(document.createElement('a'), {
              href: url,
              download: productImport.original_filename ?? 'import.csv',
            })
            link.click()
            URL.revokeObjectURL(url)
          }
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: CSV file
          content:
            text/csv:
              schema:
                type: string
                format: binary
  "/api/v3/seller/orders":
    get:
      summary: List orders
      tags:
      - Orders
      security:
      - bearer_auth: []
      description: |
        What this seller has sold.

        On a marketplace a basket spanning several sellers is split into one
        order each, so these are the seller's own orders rather than a filtered
        view of somebody else's — another seller's order is never reachable,
        whatever id is sent.

        Checkouts still in flight are left out: until one completes it is
        nobody'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-Id
        in: header
        required: true
        schema:
          type: string
      - name: q[complete]
        in: query
        required: false
        schema:
          type: boolean
        description: Set to `true` to apply `complete`.
      - name: q[incomplete]
        in: query
        required: false
        schema:
          type: boolean
        description: Set to `true` to apply `incomplete`.
      - name: q[partially_refunded]
        in: query
        required: false
        schema:
          type: boolean
        description: Set to `true` to apply `partially_refunded`.
      - name: q[refunded]
        in: query
        required: false
        schema:
          type: boolean
        description: Set to `true` to apply `refunded`.
      - name: page
        in: query
        required: false
        description: Page number
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        description: Records per page (max 100)
        schema:
          type: integer
      - name: sort
        in: query
        required: false
        description: Sort field; prefix with `-` for descending
        schema:
          type: string
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[number_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `channel_id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `completed_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `currency` | One of the `CurrencyCode` codes | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `customer_id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `delivery_total` | Amount | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `fulfillment_status` | One of `backorder`, `canceled`, `partial`, `unfulfilled`, `fulfilled`, `delivered`, `pending`, `ready`, `shipped` | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `item_total` | Amount | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `locale` | One of the `LocaleCode` codes | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `market_id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `number` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `order_group_id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `payment_status` | One of `none`, `authorized`, `partially_paid`, `paid`, `partially_refunded`, `refunded`, `overcharged`, `voided`, `balance_due`, `credit_owed`, `failed`, `void` | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `po_number` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `seller_id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `status` | One of `draft`, `placed`, `canceled` | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `total` | Amount | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `total_quantity` | Number | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `channel_id`, `completed_at`, `created_at`, `currency`, `customer_id`, `delivery_total`, `fulfillment_status`, `id`, `item_total`, `locale`, `market_id`, `number`, `order_group_id`, `payment_status`, `po_number`, `seller_id`, `status`, `total`, `total_quantity`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: Order
        sortable:
        - channel_id
        - completed_at
        - created_at
        - currency
        - customer_id
        - delivery_total
        - fulfillment_status
        - id
        - item_total
        - locale
        - market_id
        - number
        - order_group_id
        - payment_state
        - payment_status
        - po_number
        - seller_id
        - shipment_state
        - status
        - total
        - total_quantity
        - updated_at
      responses:
        '200':
          description: orders listed
          content:
            application/json:
              example:
                data:
                - id: or_UkLWZg9DAJ
                  number: R1001
                  customer_note:
                  currency: USD
                  total_quantity: 1
                  status: placed
                  fulfillment_status:
                  payment_status:
                  completed_at: '2026-01-15T12:00:00.000Z'
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  internal_note:
                  internal_note_html:
                  item_total: '10.00'
                  delivery_total: '100.00'
                  discount_total: '0.00'
                  adjustment_total: '0.00'
                  included_tax_total: '0.00'
                  additional_tax_total: '0.00'
                  tax_total: '0.00'
                  total: '110.00'
                  payment_total: '0.00'
                  amount_due: '110.00'
                  commission_amount_total: '0.00'
                  commission_tax_total: '0.00'
                  commission_total: '0.00'
                  canceled_at:
                  cancel_reason_name:
                  cancel_note:
                  items:
                  - id: li_UkLWZg9DAJ
                    name: Product 27095
                    options_text: ''
                    quantity: 1
                    currency: USD
                    price: '10.00'
                    discounted_amount: '10.00'
                    additional_tax_total: '0.00'
                    total: '10.00'
                    variant_id: variant_UkLWZg9DAJ
                    sku: SKU-356
                    thumbnail_url:
                  fulfillments:
                  - id: ful_UkLWZg9DAJ
                    number: R1001-F1
                    status: unfulfilled
                    tracking: U10000
                    tracking_url:
                    fulfilled_at:
                    delivered_at:
                    created_at: '2026-01-15T12:00:00.000Z'
                    updated_at: '2026-01-15T12:00:00.000Z'
                    fulfillment_type: shipping
                    delivery_method_name: UPS Ground 146
                    stock_location_name: Roseline Roberts
                    stock_location_id: sloc_UkLWZg9DAJ
                    fulfillment_items:
                    - id: fi_UkLWZg9DAJ
                      quantity: 1
                      line_item_id: li_UkLWZg9DAJ
                      variant_id: variant_UkLWZg9DAJ
                      name: Product 27095
                      sku: SKU-356
                      options_text: ''
                    selected_delivery_rate_id: dr_gbHJdmfrXB
                    delivery_rates:
                    - id: dr_gbHJdmfrXB
                      name: UPS Ground 146
                      selected: true
                      cost: '10.00'
                      total: '10.00'
                      carrier:
                      service_level:
                      estimated_delivery_date:
                      unpriced: false
                    deliveries:
                    - id: dlv_UkLWZg9DAJ
                      tracking_number: U10000
                      carrier:
                      carrier_name:
                      service:
                      status: pending
                      tracking_url:
                      estimated_delivery_at:
                      delivered_at:
                      created_at: '2026-01-15T12:00:00.000Z'
                      updated_at: '2026-01-15T12:00:00.000Z'
                      shipping_label_id:
                    labels: []
                  shipping_address:
                    id: addr_gbHJdmfrXB
                    label:
                    first_name: John
                    last_name: Doe
                    full_name: John Doe
                    address1: 282 Lovely Street
                    address2: Northwest
                    postal_code: '10118'
                    city: New York
                    phone: 555-555-0199
                    company: Company
                    country_name: United States
                    country_code: US
                    state_text: NY
                    state_code: NY
                    quick_checkout: false
                    is_default_billing: false
                    is_default_shipping: false
                    state_name: New York
                  billing_address:
                    id: addr_UkLWZg9DAJ
                    label:
                    first_name: John
                    last_name: Doe
                    full_name: John Doe
                    address1: 281 Lovely Street
                    address2: Northwest
                    postal_code: '10118'
                    city: New York
                    phone: 555-555-0199
                    company: Company
                    country_name: United States
                    country_code: US
                    state_text: NY
                    state_code: NY
                    quick_checkout: false
                    is_default_billing: false
                    is_default_shipping: false
                    state_name: New York
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/Order"
                  meta:
                    "$ref": "#/components/schemas/PaginationMeta"
                required:
                - data
                - meta
  "/api/v3/seller/orders/{id}":
    parameters:
    - name: id
      in: path
      description: Prefixed order ID
      required: true
      schema:
        type: string
    get:
      summary: Get an order
      tags:
      - Orders
      security:
      - bearer_auth: []
      description: |
        One order, as the seller needs it to pack and post the parcel: the
        lines with their SKUs, where it ships to, and a fulfillment per parcel.

        How the customer paid the marketplace is deliberately absent — that is
        between 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: order found
          content:
            application/json:
              example:
                id: or_UkLWZg9DAJ
                number: R1001
                customer_note:
                currency: USD
                total_quantity: 1
                status: placed
                fulfillment_status:
                payment_status:
                completed_at: '2026-01-15T12:00:00.000Z'
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                internal_note:
                internal_note_html:
                item_total: '10.00'
                delivery_total: '100.00'
                discount_total: '0.00'
                adjustment_total: '0.00'
                included_tax_total: '0.00'
                additional_tax_total: '0.00'
                tax_total: '0.00'
                total: '110.00'
                payment_total: '0.00'
                amount_due: '110.00'
                commission_amount_total: '0.00'
                commission_tax_total: '0.00'
                commission_total: '0.00'
                canceled_at:
                cancel_reason_name:
                cancel_note:
                items:
                - id: li_UkLWZg9DAJ
                  name: Product 2719755
                  options_text: ''
                  quantity: 1
                  currency: USD
                  price: '10.00'
                  discounted_amount: '10.00'
                  additional_tax_total: '0.00'
                  total: '10.00'
                  variant_id: variant_UkLWZg9DAJ
                  sku: SKU-357
                  thumbnail_url:
                fulfillments:
                - id: ful_UkLWZg9DAJ
                  number: R1001-F1
                  status: unfulfilled
                  tracking: U10000
                  tracking_url:
                  fulfilled_at:
                  delivered_at:
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  fulfillment_type: shipping
                  delivery_method_name: UPS Ground 147
                  stock_location_name: Woodrow Hand
                  stock_location_id: sloc_UkLWZg9DAJ
                  fulfillment_items:
                  - id: fi_UkLWZg9DAJ
                    quantity: 1
                    line_item_id: li_UkLWZg9DAJ
                    variant_id: variant_UkLWZg9DAJ
                    name: Product 2719755
                    sku: SKU-357
                    options_text: ''
                  selected_delivery_rate_id: dr_gbHJdmfrXB
                  delivery_rates:
                  - id: dr_gbHJdmfrXB
                    name: UPS Ground 147
                    selected: true
                    cost: '10.00'
                    total: '10.00'
                    carrier:
                    service_level:
                    estimated_delivery_date:
                    unpriced: false
                  deliveries:
                  - id: dlv_UkLWZg9DAJ
                    tracking_number: U10000
                    carrier:
                    carrier_name:
                    service:
                    status: pending
                    tracking_url:
                    estimated_delivery_at:
                    delivered_at:
                    created_at: '2026-01-15T12:00:00.000Z'
                    updated_at: '2026-01-15T12:00:00.000Z'
                    shipping_label_id:
                  labels: []
                shipping_address:
                  id: addr_gbHJdmfrXB
                  label:
                  first_name: John
                  last_name: Doe
                  full_name: John Doe
                  address1: 284 Lovely Street
                  address2: Northwest
                  postal_code: '10118'
                  city: New York
                  phone: 555-555-0199
                  company: Company
                  country_name: United States
                  country_code: US
                  state_text: NY
                  state_code: NY
                  quick_checkout: false
                  is_default_billing: false
                  is_default_shipping: false
                  state_name: New York
                billing_address:
                  id: addr_UkLWZg9DAJ
                  label:
                  first_name: John
                  last_name: Doe
                  full_name: John Doe
                  address1: 283 Lovely Street
                  address2: Northwest
                  postal_code: '10118'
                  city: New York
                  phone: 555-555-0199
                  company: Company
                  country_name: United States
                  country_code: US
                  state_text: NY
                  state_code: NY
                  quick_checkout: false
                  is_default_billing: false
                  is_default_shipping: false
                  state_name: New York
              schema:
                "$ref": "#/components/schemas/Order"
        '404':
          description: another seller's order
          content:
            application/json:
              example:
                error:
                  code: order_not_found
                  message: Order not found
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
  "/api/v3/seller/orders/{id}/cancel":
    parameters:
    - name: id
      in: path
      description: Prefixed order ID
      required: true
      schema:
        type: string
    patch:
      summary: Cancel an order
      tags:
      - Orders
      security:
      - bearer_auth: []
      description: |
        Withdraws from an order this seller cannot fulfil, naming a reason from
        the marketplace's own list.

        The goods go back on the shelf and the payment authorization is
        released either way. `refund_payments` also hands back what the buyer
        paid for these goods — a seller is merchant of record for their own
        child order, and on a split checkout only that order's share of the
        group's payment is settled.

        There is no `refund_amount`: withdrawing from the whole order returns
        what 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: order canceled
          content:
            application/json:
              example:
                id: or_UkLWZg9DAJ
                number: R1001
                customer_note:
                currency: USD
                total_quantity: 1
                status: canceled
                fulfillment_status: canceled
                payment_status: none
                completed_at: '2026-01-15T12:00:00.000Z'
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                internal_note:
                internal_note_html:
                item_total: '10.00'
                delivery_total: '100.00'
                discount_total: '0.00'
                adjustment_total: '0.00'
                included_tax_total: '0.00'
                additional_tax_total: '0.00'
                tax_total: '0.00'
                total: '110.00'
                payment_total: '0.00'
                amount_due: '0.00'
                commission_amount_total: '0.00'
                commission_tax_total: '0.00'
                commission_total: '0.00'
                canceled_at: '2026-01-15T12:00:00Z'
                cancel_reason_name:
                cancel_note:
                items:
                - id: li_UkLWZg9DAJ
                  name: Product 2746554
                  options_text: ''
                  quantity: 1
                  currency: USD
                  price: '10.00'
                  discounted_amount: '10.00'
                  additional_tax_total: '0.00'
                  total: '10.00'
                  variant_id: variant_UkLWZg9DAJ
                  sku: SKU-360
                  thumbnail_url:
                fulfillments:
                - id: ful_UkLWZg9DAJ
                  number: R1001-F1
                  status: canceled
                  tracking: U10000
                  tracking_url:
                  fulfilled_at:
                  delivered_at:
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  fulfillment_type: shipping
                  delivery_method_name: UPS Ground 150
                  stock_location_name: Savanna Hills
                  stock_location_id: sloc_UkLWZg9DAJ
                  fulfillment_items:
                  - id: fi_UkLWZg9DAJ
                    quantity: 1
                    line_item_id: li_UkLWZg9DAJ
                    variant_id: variant_UkLWZg9DAJ
                    name: Product 2746554
                    sku: SKU-360
                    options_text: ''
                  selected_delivery_rate_id: dr_gbHJdmfrXB
                  delivery_rates:
                  - id: dr_gbHJdmfrXB
                    name: UPS Ground 150
                    selected: true
                    cost: '10.00'
                    total: '10.00'
                    carrier:
                    service_level:
                    estimated_delivery_date:
                    unpriced: false
                  deliveries:
                  - id: dlv_UkLWZg9DAJ
                    tracking_number: U10000
                    carrier:
                    carrier_name:
                    service:
                    status: pending
                    tracking_url:
                    estimated_delivery_at:
                    delivered_at:
                    created_at: '2026-01-15T12:00:00.000Z'
                    updated_at: '2026-01-15T12:00:00.000Z'
                    shipping_label_id:
                  labels: []
                shipping_address:
                  id: addr_gbHJdmfrXB
                  label:
                  first_name: John
                  last_name: Doe
                  full_name: John Doe
                  address1: 290 Lovely Street
                  address2: Northwest
                  postal_code: '10118'
                  city: New York
                  phone: 555-555-0199
                  company: Company
                  country_name: United States
                  country_code: US
                  state_text: NY
                  state_code: NY
                  quick_checkout: false
                  is_default_billing: false
                  is_default_shipping: false
                  state_name: New York
                billing_address:
                  id: addr_UkLWZg9DAJ
                  label:
                  first_name: John
                  last_name: Doe
                  full_name: John Doe
                  address1: 289 Lovely Street
                  address2: Northwest
                  postal_code: '10118'
                  city: New York
                  phone: 555-555-0199
                  company: Company
                  country_name: United States
                  country_code: US
                  state_text: NY
                  state_code: NY
                  quick_checkout: false
                  is_default_billing: false
                  is_default_shipping: false
                  state_name: New York
              schema:
                "$ref": "#/components/schemas/Order"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/OrderCancelParams"
  "/api/v3/seller/orders/{id}/address":
    parameters:
    - name: id
      in: path
      description: Prefixed order ID
      required: true
      schema:
        type: string
    patch:
      summary: Correct an order address
      tags:
      - Orders
      security:
      - bearer_auth: []
      description: |
        Corrects where the goods go or who the invoice names.

        The seller is merchant of record for their own child order, so a
        delivery address the buyer got wrong is theirs to fix. Send only the
        lines that change — the rest of the address is carried over.

        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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: address corrected
          content:
            application/json:
              example:
                id: or_UkLWZg9DAJ
                number: R1001
                customer_note:
                currency: USD
                total_quantity: 1
                status: placed
                fulfillment_status:
                payment_status:
                completed_at: '2026-01-15T12:00:00.000Z'
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                internal_note:
                internal_note_html:
                item_total: '10.00'
                delivery_total: '100.00'
                discount_total: '0.00'
                adjustment_total: '0.00'
                included_tax_total: '0.00'
                additional_tax_total: '0.00'
                tax_total: '0.00'
                total: '110.00'
                payment_total: '0.00'
                amount_due: '110.00'
                commission_amount_total: '0.00'
                commission_tax_total: '0.00'
                commission_total: '0.00'
                canceled_at:
                cancel_reason_name:
                cancel_note:
                items:
                - id: li_UkLWZg9DAJ
                  name: Product 2755038
                  options_text: ''
                  quantity: 1
                  currency: USD
                  price: '10.00'
                  discounted_amount: '10.00'
                  additional_tax_total: '0.00'
                  total: '10.00'
                  variant_id: variant_UkLWZg9DAJ
                  sku: SKU-361
                  thumbnail_url:
                fulfillments:
                - id: ful_UkLWZg9DAJ
                  number: R1001-F1
                  status: unfulfilled
                  tracking: U10000
                  tracking_url:
                  fulfilled_at:
                  delivered_at:
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  fulfillment_type: shipping
                  delivery_method_name: UPS Ground 151
                  stock_location_name: Rudy Mosciski
                  stock_location_id: sloc_UkLWZg9DAJ
                  fulfillment_items:
                  - id: fi_UkLWZg9DAJ
                    quantity: 1
                    line_item_id: li_UkLWZg9DAJ
                    variant_id: variant_UkLWZg9DAJ
                    name: Product 2755038
                    sku: SKU-361
                    options_text: ''
                  selected_delivery_rate_id: dr_gbHJdmfrXB
                  delivery_rates:
                  - id: dr_gbHJdmfrXB
                    name: UPS Ground 151
                    selected: true
                    cost: '10.00'
                    total: '10.00'
                    carrier:
                    service_level:
                    estimated_delivery_date:
                    unpriced: false
                  deliveries:
                  - id: dlv_UkLWZg9DAJ
                    tracking_number: U10000
                    carrier:
                    carrier_name:
                    service:
                    status: pending
                    tracking_url:
                    estimated_delivery_at:
                    delivered_at:
                    created_at: '2026-01-15T12:00:00.000Z'
                    updated_at: '2026-01-15T12:00:00.000Z'
                    shipping_label_id:
                  labels: []
                shipping_address:
                  id: addr_EfhxLZ9ck8
                  label:
                  first_name: John
                  last_name: Doe
                  full_name: John Doe
                  address1: 9 Corrected Way
                  address2: Northwest
                  postal_code: '10118'
                  city: Fixedton
                  phone: 555-555-0199
                  company: Company
                  country_name: United States
                  country_code: US
                  state_text: NY
                  state_code: NY
                  quick_checkout: false
                  is_default_billing: false
                  is_default_shipping: false
                  state_name: New York
                billing_address:
                  id: addr_UkLWZg9DAJ
                  label:
                  first_name: John
                  last_name: Doe
                  full_name: John Doe
                  address1: 291 Lovely Street
                  address2: Northwest
                  postal_code: '10118'
                  city: New York
                  phone: 555-555-0199
                  company: Company
                  country_name: United States
                  country_code: US
                  state_text: NY
                  state_code: NY
                  quick_checkout: false
                  is_default_billing: false
                  is_default_shipping: false
                  state_name: New York
              schema:
                "$ref": "#/components/schemas/Order"
        '422':
          description: neither address named
          content:
            application/json:
              example:
                error:
                  code: validation_error
                  message: shipping_address or billing_address is required
                  details:
                    base:
                    - shipping_address or billing_address is required
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/OrderAddressCorrectionParams"
        required: true
  "/api/v3/seller/orders/{order_id}/notes":
    parameters:
    - name: order_id
      in: path
      description: Prefixed order ID
      required: true
      schema:
        type: string
    get:
      summary: Get order notes
      tags:
      - Orders
      security:
      - bearer_auth: []
      description: |
        The instructions the buyer left, and the seller's own working note.

        A marketplace basket splits into one order per seller, so the internal
        note here is this seller's alone rather than the operator's note about
        the 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: notes
          content:
            application/json:
              example:
                id: or_UkLWZg9DAJ
                number: R1001
                customer_note:
                currency: USD
                total_quantity: 1
                status: placed
                fulfillment_status:
                payment_status:
                completed_at: '2026-01-15T12:00:00.000Z'
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                internal_note:
                internal_note_html:
                item_total: '10.00'
                delivery_total: '100.00'
                discount_total: '0.00'
                adjustment_total: '0.00'
                included_tax_total: '0.00'
                additional_tax_total: '0.00'
                tax_total: '0.00'
                total: '110.00'
                payment_total: '0.00'
                amount_due: '110.00'
                commission_amount_total: '0.00'
                commission_tax_total: '0.00'
                commission_total: '0.00'
                canceled_at:
                cancel_reason_name:
                cancel_note:
                items:
                - id: li_UkLWZg9DAJ
                  name: Product 2773962
                  options_text: ''
                  quantity: 1
                  currency: USD
                  price: '10.00'
                  discounted_amount: '10.00'
                  additional_tax_total: '0.00'
                  total: '10.00'
                  variant_id: variant_UkLWZg9DAJ
                  sku: SKU-363
                  thumbnail_url:
                fulfillments:
                - id: ful_UkLWZg9DAJ
                  number: R1001-F1
                  status: unfulfilled
                  tracking: U10000
                  tracking_url:
                  fulfilled_at:
                  delivered_at:
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  fulfillment_type: shipping
                  delivery_method_name: UPS Ground 153
                  stock_location_name: Kecia Pollich
                  stock_location_id: sloc_UkLWZg9DAJ
                  fulfillment_items:
                  - id: fi_UkLWZg9DAJ
                    quantity: 1
                    line_item_id: li_UkLWZg9DAJ
                    variant_id: variant_UkLWZg9DAJ
                    name: Product 2773962
                    sku: SKU-363
                    options_text: ''
                  selected_delivery_rate_id: dr_gbHJdmfrXB
                  delivery_rates:
                  - id: dr_gbHJdmfrXB
                    name: UPS Ground 153
                    selected: true
                    cost: '10.00'
                    total: '10.00'
                    carrier:
                    service_level:
                    estimated_delivery_date:
                    unpriced: false
                  deliveries:
                  - id: dlv_UkLWZg9DAJ
                    tracking_number: U10000
                    carrier:
                    carrier_name:
                    service:
                    status: pending
                    tracking_url:
                    estimated_delivery_at:
                    delivered_at:
                    created_at: '2026-01-15T12:00:00.000Z'
                    updated_at: '2026-01-15T12:00:00.000Z'
                    shipping_label_id:
                  labels: []
                shipping_address:
                  id: addr_gbHJdmfrXB
                  label:
                  first_name: John
                  last_name: Doe
                  full_name: John Doe
                  address1: 296 Lovely Street
                  address2: Northwest
                  postal_code: '10118'
                  city: New York
                  phone: 555-555-0199
                  company: Company
                  country_name: United States
                  country_code: US
                  state_text: NY
                  state_code: NY
                  quick_checkout: false
                  is_default_billing: false
                  is_default_shipping: false
                  state_name: New York
                billing_address:
                  id: addr_UkLWZg9DAJ
                  label:
                  first_name: John
                  last_name: Doe
                  full_name: John Doe
                  address1: 295 Lovely Street
                  address2: Northwest
                  postal_code: '10118'
                  city: New York
                  phone: 555-555-0199
                  company: Company
                  country_name: United States
                  country_code: US
                  state_text: NY
                  state_code: NY
                  quick_checkout: false
                  is_default_billing: false
                  is_default_shipping: false
                  state_name: New York
              schema:
                "$ref": "#/components/schemas/Order"
    patch:
      summary: Update order notes
      tags:
      - Orders
      security:
      - bearer_auth: []
      description: |
        Send only the note that changes: an absent key leaves the other alone,
        while an empty string clears it.

        `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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: notes updated
          content:
            application/json:
              example:
                id: or_UkLWZg9DAJ
                number: R1001
                customer_note:
                currency: USD
                total_quantity: 1
                status: placed
                fulfillment_status:
                payment_status:
                completed_at: '2026-01-15T12:00:00.000Z'
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                internal_note: Packed with the fragile insert.
                internal_note_html: "<p>Packed with the fragile insert.</p>"
                item_total: '10.00'
                delivery_total: '100.00'
                discount_total: '0.00'
                adjustment_total: '0.00'
                included_tax_total: '0.00'
                additional_tax_total: '0.00'
                tax_total: '0.00'
                total: '110.00'
                payment_total: '0.00'
                amount_due: '110.00'
                commission_amount_total: '0.00'
                commission_tax_total: '0.00'
                commission_total: '0.00'
                canceled_at:
                cancel_reason_name:
                cancel_note:
                items:
                - id: li_UkLWZg9DAJ
                  name: Product 2785749
                  options_text: ''
                  quantity: 1
                  currency: USD
                  price: '10.00'
                  discounted_amount: '10.00'
                  additional_tax_total: '0.00'
                  total: '10.00'
                  variant_id: variant_UkLWZg9DAJ
                  sku: SKU-364
                  thumbnail_url:
                fulfillments:
                - id: ful_UkLWZg9DAJ
                  number: R1001-F1
                  status: unfulfilled
                  tracking: U10000
                  tracking_url:
                  fulfilled_at:
                  delivered_at:
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  fulfillment_type: shipping
                  delivery_method_name: UPS Ground 154
                  stock_location_name: Ophelia Hartmann
                  stock_location_id: sloc_UkLWZg9DAJ
                  fulfillment_items:
                  - id: fi_UkLWZg9DAJ
                    quantity: 1
                    line_item_id: li_UkLWZg9DAJ
                    variant_id: variant_UkLWZg9DAJ
                    name: Product 2785749
                    sku: SKU-364
                    options_text: ''
                  selected_delivery_rate_id: dr_gbHJdmfrXB
                  delivery_rates:
                  - id: dr_gbHJdmfrXB
                    name: UPS Ground 154
                    selected: true
                    cost: '10.00'
                    total: '10.00'
                    carrier:
                    service_level:
                    estimated_delivery_date:
                    unpriced: false
                  deliveries:
                  - id: dlv_UkLWZg9DAJ
                    tracking_number: U10000
                    carrier:
                    carrier_name:
                    service:
                    status: pending
                    tracking_url:
                    estimated_delivery_at:
                    delivered_at:
                    created_at: '2026-01-15T12:00:00.000Z'
                    updated_at: '2026-01-15T12:00:00.000Z'
                    shipping_label_id:
                  labels: []
                shipping_address:
                  id: addr_gbHJdmfrXB
                  label:
                  first_name: John
                  last_name: Doe
                  full_name: John Doe
                  address1: 298 Lovely Street
                  address2: Northwest
                  postal_code: '10118'
                  city: New York
                  phone: 555-555-0199
                  company: Company
                  country_name: United States
                  country_code: US
                  state_text: NY
                  state_code: NY
                  quick_checkout: false
                  is_default_billing: false
                  is_default_shipping: false
                  state_name: New York
                billing_address:
                  id: addr_UkLWZg9DAJ
                  label:
                  first_name: John
                  last_name: Doe
                  full_name: John Doe
                  address1: 297 Lovely Street
                  address2: Northwest
                  postal_code: '10118'
                  city: New York
                  phone: 555-555-0199
                  company: Company
                  country_name: United States
                  country_code: US
                  state_text: NY
                  state_code: NY
                  quick_checkout: false
                  is_default_billing: false
                  is_default_shipping: false
                  state_name: New York
              schema:
                "$ref": "#/components/schemas/Order"
        '422':
          description: neither note named
          content:
            application/json:
              example:
                error:
                  code: validation_error
                  message: customer_note or internal_note is required
                  details:
                    base:
                    - customer_note or internal_note is required
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/OrderNotesParams"
        required: true
  "/api/v3/seller/order_cancellation_reasons":
    get:
      summary: List order cancellation reasons
      tags:
      - Orders
      security:
      - bearer_auth: []
      description: |
        Why an order was called off, as the marketplace defines it.

        Read-only: a seller picks one when cancelling, and the operator decides
        what 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-Id
        in: header
        required: true
        schema:
          type: string
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[name_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `active` | True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `active`, `created_at`, `id`, `name`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: OrderCancellationReason
        sortable:
        - active
        - created_at
        - id
        - name
        - updated_at
      responses:
        '200':
          description: reasons listed
          content:
            application/json:
              example:
                data:
                - id: ocr_UkLWZg9DAJ
                  name: Out of stock
                  active: true
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/Reason"
                required:
                - data
  "/api/v3/seller/package_types":
    get:
      summary: List package types
      tags:
      - Package Types
      security:
      - bearer_auth: []
      description: |
        What this seller packs their goods into: the boxes their parcels ship
        in, the cartons their products are packed into, the pallets a
        wholesale order leaves on.

        The list carries the marketplace's own packaging alongside the
        seller's, so a seller can pack into the operator's standard cartons
        rather than measuring them again. Those rows report `editable: false`
        and are refused by every write.

        The row marked `default` is the box this seller's parcels are quoted
        with — 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-Id
        in: header
        required: true
        schema:
          type: string
      - name: q[search]
        in: query
        required: false
        schema:
          type: string
        description: Matches any of name (partial, case-insensitive).
      - 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
      - name: page
        in: query
        required: false
        description: Page number
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        description: Records per page (max 100)
        schema:
          type: integer
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[name_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `default` | True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `kind` | One of `box`, `envelope`, `carton`, `pallet`, `container` | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `seller_id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `created_at`, `default`, `id`, `kind`, `name`, `seller_id`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: PackageType
        sortable:
        - created_at
        - default
        - id
        - kind
        - name
        - seller_id
        - updated_at
      responses:
        '200':
          description: package types listed
          content:
            application/json:
              example:
                data:
                - id: pkgtype_UkLWZg9DAJ
                  name: Standard mailer
                  kind: box
                  length: '30.0'
                  width: '20.0'
                  height: '15.0'
                  weight: '0.4'
                  max_weight:
                  default: true
                  metadata: {}
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  dimensions_unit: cm
                  weight_unit: kg
                  volume: '0.009'
                  editable: true
                - id: pkgtype_gbHJdmfrXB
                  name: Marketplace carton
                  kind: carton
                  length: '40.0'
                  width: '30.0'
                  height: '25.0'
                  weight:
                  max_weight: '20.0'
                  default: false
                  metadata: {}
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  dimensions_unit: cm
                  weight_unit: kg
                  volume: '0.03'
                  editable: false
                meta:
                  page: 1
                  limit: 25
                  count: 2
                  pages: 1
                  from: 1
                  to: 2
                  in: 2
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/PackageType"
                  meta:
                    "$ref": "#/components/schemas/PaginationMeta"
                required:
                - data
                - meta
    post:
      summary: Create a package type
      tags:
      - Package Types
      security:
      - bearer_auth: []
      description: |
        Records a piece of the seller's own packaging. Marking it `default`
        makes it the box their parcels are quoted with, and demotes whichever
        of their rows held the flag before — the marketplace's default is a
        different 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '201':
          description: package type created
          content:
            application/json:
              example:
                id: pkgtype_EfhxLZ9ck8
                name: Large mailer
                kind: box
                length: '40.0'
                width: '30.0'
                height: '20.0'
                weight: '0.6'
                max_weight:
                default: false
                metadata: {}
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                dimensions_unit: cm
                weight_unit: kg
                volume: '0.024'
                editable: true
              schema:
                "$ref": "#/components/schemas/PackageType"
        '422':
          description: validation error
          content:
            application/json:
              example:
                error:
                  code: validation_error
                  message: Kind is not included in the list
                  details:
                    kind:
                    - is not included in the list
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/PackageTypeCreateParams"
        required: true
  "/api/v3/seller/package_types/{id}":
    parameters:
    - name: id
      in: path
      required: true
      description: Package type ID
      schema:
        type: string
    get:
      summary: Get a package type
      tags:
      - Package Types
      security:
      - bearer_auth: []
      description: |
        Returns one package type by prefixed ID — the seller's own, or a
        marketplace 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: package type found
          content:
            application/json:
              example:
                id: pkgtype_UkLWZg9DAJ
                name: Standard mailer
                kind: box
                length: '30.0'
                width: '20.0'
                height: '15.0'
                weight: '0.4'
                max_weight:
                default: true
                metadata: {}
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                dimensions_unit: cm
                weight_unit: kg
                volume: '0.009'
                editable: true
              schema:
                "$ref": "#/components/schemas/PackageType"
        '404':
          description: package type not found
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Package type not found
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
    patch:
      summary: Update a package type
      tags:
      - Package Types
      security:
      - bearer_auth: []
      description: |
        Changes the seller's own packaging. A marketplace row is not theirs to
        edit 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: package type updated
          content:
            application/json:
              example:
                id: pkgtype_UkLWZg9DAJ
                name: Standard mailer
                kind: box
                length: '30.0'
                width: '20.0'
                height: '15.0'
                weight: '0.4'
                max_weight: '25.0'
                default: true
                metadata: {}
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                dimensions_unit: cm
                weight_unit: kg
                volume: '0.009'
                editable: true
              schema:
                "$ref": "#/components/schemas/PackageType"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/PackageTypeUpdateParams"
        required: true
    delete:
      summary: Delete a package type
      tags:
      - Package Types
      security:
      - bearer_auth: []
      description: |
        Retires one of the seller's own package types. The default box is
        refused — name another default first, or every parcel silently falls
        back 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '204':
          description: package type deleted
  "/api/v3/seller/payouts":
    get:
      summary: List payouts
      tags:
      - Earnings
      security:
      - bearer_auth: []
      description: |
        Settlements to this seller: each one batches the transfers that had
        accumulated since the last, on the seller's payout schedule. `pending`
        and `processing` rows are owed; `completed` ones reached the seller's
        bank. `transfers_count` says how many earnings a settlement covers —
        list them with `GET /api/v3/seller/transfers?q[payout_id_eq]=…`.

        Read-only: a payout is created by the marketplace's sweep and
        confirmed 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-Id
        in: header
        required: true
        schema:
          type: string
      - name: q[search]
        in: query
        required: false
        schema:
          type: string
        description: Matches any of reference (partial, case-insensitive).
      - name: page
        in: query
        required: false
        description: Page number
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        description: Records per page (max 100)
        schema:
          type: integer
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[provider_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `amount` | Amount | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `currency` | One of the `CurrencyCode` codes | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `period_end` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `period_start` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `provider` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `reference` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `seller_id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `status` | One of `pending`, `processing`, `completed`, `failed`, `unresolved` | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `amount`, `created_at`, `currency`, `id`, `period_end`, `period_start`, `provider`, `reference`, `seller_id`, `status`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: SellerPayout
        sortable:
        - amount
        - created_at
        - currency
        - id
        - period_end
        - period_start
        - provider
        - reference
        - seller_id
        - status
        - updated_at
      responses:
        '200':
          description: payouts listed
          content:
            application/json:
              example:
                data:
                - id: vpo_UkLWZg9DAJ
                  status: pending
                  currency: USD
                  reference:
                  period_start:
                  period_end:
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  amount: '120.00'
                  transfers_count: 1
                  provider: system
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/Payout"
                  meta:
                    "$ref": "#/components/schemas/PaginationMeta"
                required:
                - data
                - meta
  "/api/v3/seller/payouts/{id}":
    parameters:
    - name: id
      in: path
      required: true
      description: Payout prefixed ID
      schema:
        type: string
    get:
      summary: Get a payout
      tags:
      - Earnings
      security:
      - 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: payout found
          content:
            application/json:
              example:
                id: vpo_UkLWZg9DAJ
                status: pending
                currency: USD
                reference:
                period_start:
                period_end:
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                amount: '120.00'
                transfers_count: 1
                provider: system
              schema:
                "$ref": "#/components/schemas/Payout"
        '404':
          description: payout not found
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Seller payout not found
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
  "/api/v3/seller/orders/{order_id}/returns":
    parameters:
    - name: order_id
      in: path
      description: Prefixed order ID
      required: true
      schema:
        type: string
    get:
      summary: List returns
      tags:
      - Returns
      security:
      - bearer_auth: []
      description: |
        Goods coming back on one of this seller's orders.

        Reached through the order, which is itself fetched through the acting
        seller — so a return on somebody else's order is unreachable whatever
        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: returns } = await client.orders.returns.list('or_UkLWZg9DAJ')
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      - name: q[search]
        in: query
        required: false
        schema:
          type: string
        description: Matches any of number (partial, case-insensitive).
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[number_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `number` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `status` | One of `requested`, `approved`, `received`, `refunded`, `canceled` | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `created_at`, `id`, `number`, `status`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: Return
        sortable:
        - created_at
        - id
        - number
        - status
        - updated_at
      responses:
        '200':
          description: returns listed
          content:
            application/json:
              example:
                data:
                - id: ret_UkLWZg9DAJ
                  number: RET1001
                  status: requested
                  order_id: or_UkLWZg9DAJ
                  reason_id:
                  refund_total: '10.00'
                  refund_tax_total: '0.00'
                  approved_at:
                  received_at:
                  refunded_at:
                  canceled_at:
                  memo:
                  stock_location_id: sloc_UkLWZg9DAJ
                  refunded_total: '0.00'
                  refundable_total: '10.00'
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/Return"
                required:
                - data
    post:
      summary: Open a return
      tags:
      - Returns
      security:
      - bearer_auth: []
      description: |
        Takes goods back on one of this seller's orders.

        The units are addressed by fulfillment item and resolved through the
        order, so only what this seller actually shipped can come back. An
        optional stock location says which of the seller's own shelves it
        returns 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '201':
          description: return opened
          content:
            application/json:
              example:
                id: ret_UkLWZg9DAJ
                number: RET1001
                status: requested
                order_id: or_UkLWZg9DAJ
                reason_id:
                refund_total: '10.00'
                refund_tax_total: '0.00'
                approved_at:
                received_at:
                refunded_at:
                canceled_at:
                memo:
                stock_location_id: sloc_UkLWZg9DAJ
                refunded_total: '0.00'
                refundable_total: '10.00'
              schema:
                "$ref": "#/components/schemas/Return"
        '422':
          description: more than was shipped
          content:
            application/json:
              example:
                error:
                  code: processing_error
                  message: Only 1 of Product 3117120 can be returned
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ReturnCreateParams"
        required: true
  "/api/v3/seller/orders/{order_id}/returns/{id}":
    parameters:
    - name: order_id
      in: path
      description: Prefixed order ID
      required: true
      schema:
        type: string
    - name: id
      in: path
      description: Prefixed return ID
      required: true
      schema:
        type: string
    get:
      summary: Show a return
      tags:
      - Returns
      security:
      - bearer_auth: []
      description: One return on one of this seller's orders, with the goods coming
        back and the reason given.
      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.get('or_UkLWZg9DAJ', 'ret_UkLWZg9DAJ')
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: return found
          content:
            application/json:
              example:
                id: ret_UkLWZg9DAJ
                number: RET1001
                status: requested
                order_id: or_UkLWZg9DAJ
                reason_id:
                refund_total: '10.00'
                refund_tax_total: '0.00'
                approved_at:
                received_at:
                refunded_at:
                canceled_at:
                memo:
                stock_location_id: sloc_UkLWZg9DAJ
                refunded_total: '0.00'
                refundable_total: '10.00'
              schema:
                "$ref": "#/components/schemas/Return"
  "/api/v3/seller/orders/{order_id}/returns/{id}/approve":
    parameters:
    - name: order_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    patch:
      summary: Approve a return
      tags:
      - Returns
      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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: return approved
          content:
            application/json:
              example:
                id: ret_UkLWZg9DAJ
                number: RET1001
                status: approved
                order_id: or_UkLWZg9DAJ
                reason_id:
                refund_total: '10.00'
                refund_tax_total: '0.00'
                approved_at: '2026-01-15T12:00:00Z'
                received_at:
                refunded_at:
                canceled_at:
                memo:
                stock_location_id: sloc_UkLWZg9DAJ
                refunded_total: '0.00'
                refundable_total: '10.00'
              schema:
                "$ref": "#/components/schemas/Return"
  "/api/v3/seller/orders/{order_id}/returns/{id}/receive":
    parameters:
    - name: order_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    patch:
      summary: Receive a return
      tags:
      - Returns
      security:
      - bearer_auth: []
      description: |
        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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: return received
          content:
            application/json:
              example:
                id: ret_UkLWZg9DAJ
                number: RET1001
                status: received
                order_id: or_UkLWZg9DAJ
                reason_id:
                refund_total: '10.00'
                refund_tax_total: '0.00'
                approved_at: '2026-01-15T12:00:00Z'
                received_at: '2026-01-15T12:00:00Z'
                refunded_at:
                canceled_at:
                memo:
                stock_location_id: sloc_UkLWZg9DAJ
                refunded_total: '0.00'
                refundable_total: '10.00'
              schema:
                "$ref": "#/components/schemas/Return"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ReturnReceiveParams"
  "/api/v3/seller/orders/{order_id}/returns/{id}/refund":
    parameters:
    - name: order_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    patch:
      summary: Refund a return
      tags:
      - Returns
      security:
      - bearer_auth: []
      description: |
        Gives the customer their money back.

        The seller is merchant of record for their own child order, so this is
        theirs to do. The amount is bounded by what the return is owed and, on
        a 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: return refunded
          content:
            application/json:
              example:
                id: ret_UkLWZg9DAJ
                number: RET1001
                status: refunded
                order_id: or_UkLWZg9DAJ
                reason_id:
                refund_total: '10.00'
                refund_tax_total: '0.00'
                approved_at: '2026-01-15T12:00:00Z'
                received_at: '2026-01-15T12:00:00Z'
                refunded_at: '2026-01-15T12:00:00Z'
                canceled_at:
                memo:
                stock_location_id: sloc_UkLWZg9DAJ
                refunded_total: '10.00'
                refundable_total: '0.00'
              schema:
                "$ref": "#/components/schemas/Return"
        '422':
          description: more than the return is owed
          content:
            application/json:
              example:
                error:
                  code: processing_error
                  message: That is more than the amount still refundable.
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ReturnRefundParams"
  "/api/v3/seller/orders/{order_id}/returns/{id}/cancel":
    parameters:
    - name: order_id
      in: path
      required: true
      schema:
        type: string
    - name: id
      in: path
      required: true
      schema:
        type: string
    patch:
      summary: Cancel a return
      tags:
      - Returns
      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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: return canceled
          content:
            application/json:
              example:
                id: ret_UkLWZg9DAJ
                number: RET1001
                status: canceled
                order_id: or_UkLWZg9DAJ
                reason_id:
                refund_total: '10.00'
                refund_tax_total: '0.00'
                approved_at:
                received_at:
                refunded_at:
                canceled_at: '2026-01-15T12:00:00Z'
                memo: Customer decided to keep the goods
                stock_location_id: sloc_UkLWZg9DAJ
                refunded_total: '0.00'
                refundable_total: '10.00'
              schema:
                "$ref": "#/components/schemas/Return"
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/ReturnCancelParams"
  "/api/v3/seller/return_reasons":
    get:
      summary: List return reasons
      tags:
      - Returns
      security:
      - bearer_auth: []
      description: |
        Why goods come back, as the marketplace defines it.

        Read-only: the vocabulary is the operator's, and a seller picks from
        it. 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-Id
        in: header
        required: true
        schema:
          type: string
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[name_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `active` | True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `active`, `created_at`, `id`, `name`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: ReturnReason
        sortable:
        - active
        - created_at
        - id
        - name
        - updated_at
      responses:
        '200':
          description: reasons listed
          content:
            application/json:
              example:
                data:
                - id: rar_UkLWZg9DAJ
                  name: Damaged in transit
                  active: true
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/Reason"
                required:
                - data
  "/api/v3/seller/tax_identifiers":
    get:
      summary: List tax registrations
      tags:
      - Tax Identifiers
      security:
      - bearer_auth: []
      description: |
        The seller's own registrations — the numbers the marketplace's
        commission invoice is made out to, and what makes EU reverse charge on
        that fee possible.

        A collection rather than a single field: a business trading in more
        than one regime holds a registration in each, and they are not
        alternatives. 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-Id
        in: header
        required: true
        schema:
          type: string
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[created_at_eq]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `created_at`, `id`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: TaxIdentifier
        sortable:
        - created_at
        - id
        - updated_at
      responses:
        '200':
          description: registrations returned
          content:
            application/json:
              example:
                data:
                - id: txi_UkLWZg9DAJ
                  kind: eu_vat
                  value: DE100000008
                  validation_status:
                  validated_at:
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
    post:
      summary: Add a tax registration
      tags:
      - Tax Identifiers
      security:
      - bearer_auth: []
      description: |
        `kind` names the regime — `eu_vat`, `gb_vat`, and whatever else a
        validator is registered for. Any string is accepted; what a kind means
        is decided by its validator, and a kind nothing is registered for is
        stored and used as entered.

        A number a registered validator refuses is rejected outright rather
        than 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '201':
          description: registration recorded
          content:
            application/json:
              example:
                id: txi_UkLWZg9DAJ
                kind: eu_vat
                value: DE100000008
                validation_status:
                validated_at:
        '422':
          description: the number is not valid for its regime
          content:
            application/json:
              example:
                error:
                  code: validation_error
                  message: Number does not look like a valid EU VAT registration
                  details:
                    value:
                    - does not look like a valid EU VAT registration
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/SellerTaxIdentifierCreateParams"
        required: true
  "/api/v3/seller/tax_identifiers/{id}":
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    patch:
      summary: Correct a tax registration
      tags:
      - Tax Identifiers
      security:
      - bearer_auth: []
      description: |
        A changed number drops its validation verdict, because that answer was
        about 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: registration corrected
          content:
            application/json:
              example:
                id: txi_UkLWZg9DAJ
                kind: eu_vat
                value: DE100000016
                validation_status:
                validated_at:
      requestBody:
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/SellerTaxIdentifierUpdateParams"
        required: true
    delete:
      summary: Remove a tax registration
      tags:
      - Tax Identifiers
      security:
      - 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.delete('txi_xxx')
      parameters:
      - name: X-Spree-Seller-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '204':
          description: registration removed
  "/api/v3/seller/tax_identifiers/{id}/validate":
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    post:
      summary: Re-check a registration against its registry
      tags:
      - Tax Identifiers
      security:
      - bearer_auth: []
      description: |
        A registry answers "valid now", so a number verified last year may have
        been deregistered since. Refused when no registry validator is
        installed for the kind — core format-checks EU VAT numbers but asks no
        registry, so a stock install answers 422 here rather than queueing a
        check 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '422':
          description: no registry validator is installed for this kind
          content:
            application/json:
              example:
                error:
                  code: tax_id_not_validatable
                  message: No registry validator is installed for tax identifier kind
                    'eu_vat'
  "/api/v3/seller/transfers":
    get:
      summary: List transfers
      tags:
      - Earnings
      security:
      - bearer_auth: []
      description: |
        What this seller has earned, order by order. A transfer is written
        when an order is fulfilled — the sale less the marketplace's
        commission — and a refund writes a negative `refund_reversal` row
        against it rather than editing it.

        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-Id
        in: header
        required: true
        schema:
          type: string
      - name: q[search]
        in: query
        required: false
        schema:
          type: string
        description: Matches any of reference (partial, case-insensitive).
      - name: page
        in: query
        required: false
        description: Page number
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        description: Records per page (max 100)
        schema:
          type: integer
      - name: q
        in: query
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties: true
        description: Attribute filters, as `q[<attribute>_<predicate>]=value`. See
          Filters above for the list.
      x-mint:
        content: |-
          ## Filters

          Filter with `q[<attribute>_<predicate>]=value`, for example `q[provider_cont]=…`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).

          | Attribute | Kind | Predicates |
          |---|---|---|
          | `amount` | Amount | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |
          | `currency` | One of the `CurrencyCode` codes | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `kind` | One of `earning`, `refund_reversal` | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `order_id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `payout_id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `provider` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `reference` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |
          | `seller_id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `status` | One of `pending`, `processing`, `completed`, `failed`, `unresolved` | `eq` `not_eq` `in` `not_in` `null` `not_null` |
          | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |

          **Sort by:** `amount`, `created_at`, `currency`, `id`, `kind`, `order_id`, `payout_id`, `provider`, `reference`, `seller_id`, `status`, `updated_at`. Prefix a field with `-` to sort descending.
      x-spree-filters:
        table: SellerTransfer
        sortable:
        - amount
        - created_at
        - currency
        - id
        - kind
        - order_id
        - payout_id
        - provider
        - reference
        - seller_id
        - status
        - updated_at
      responses:
        '200':
          description: transfers listed
          content:
            application/json:
              example:
                data:
                - id: vtr_UkLWZg9DAJ
                  kind: earning
                  status: completed
                  currency: USD
                  reference:
                  created_at: '2026-01-15T12:00:00.000Z'
                  updated_at: '2026-01-15T12:00:00.000Z'
                  amount: '42.00'
                  settled_amount: '42.00'
                  settled_currency: USD
                  converted: false
                  order_id: or_UkLWZg9DAJ
                  payout_id:
                  reversed_from_id:
                  order_number: R1001
                  provider: system
                meta:
                  page: 1
                  limit: 25
                  count: 1
                  pages: 1
                  from: 1
                  to: 1
                  in: 1
                  previous:
                  next:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      "$ref": "#/components/schemas/Transfer"
                  meta:
                    "$ref": "#/components/schemas/PaginationMeta"
                required:
                - data
                - meta
  "/api/v3/seller/transfers/{id}":
    parameters:
    - name: id
      in: path
      required: true
      description: Transfer prefixed ID
      schema:
        type: string
    get:
      summary: Get a transfer
      tags:
      - Earnings
      security:
      - 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-Id
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: transfer found
          content:
            application/json:
              example:
                id: vtr_UkLWZg9DAJ
                kind: earning
                status: completed
                currency: USD
                reference:
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                amount: '42.00'
                settled_amount: '42.00'
                settled_currency: USD
                converted: false
                order_id: or_UkLWZg9DAJ
                payout_id:
                reversed_from_id:
                order_number: R1001
                provider: system
              schema:
                "$ref": "#/components/schemas/Transfer"
        '404':
          description: transfer not found
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Seller transfer not found
              schema:
                "$ref": "#/components/schemas/ErrorResponse"
servers:
- url: http://{defaultHost}
  variables:
    defaultHost:
      default: localhost:3000
tags:
- name: Authentication
  description: Seller sign-in, token refresh, logout, and invitation acceptance
- name: Account
  description: The signed-in user, the sellers they may act for, and what they may
    do
- name: Countries
  description: Country and state reference data for the panel's address forms
- name: Delivery Methods
  description: The seller's own ways to ship, and the marketplace methods shared with
    them
- name: Delivery Profiles
  description: The marketplace's delivery vocabulary — what kind of goods a product
    is, which decides how it ships
- name: Delivery Zones
  description: The marketplace's destinations, for narrowing where a seller's own
    method ships
- name: Onboarding
  description: The marketplace checklist a seller completes before admission, and
    what they submit against it
- name: Policies
  description: The seller's own legal documents, as the marketplace asks them to publish
- name: Product Types
  description: The types a seller may list a product against, and what each adds
- name: Products
  description: The seller's own catalog
- name: Profile
  description: The seller's own record — presentation, contact details, addresses,
    and tax registration
- name: Stock Locations
  description: Where the seller keeps stock, and so where their returns are sent
- name: Team
  description: Who runs this seller, and the invitations nobody has accepted yet
- name: Files
  description: Uploading the files a profile, a submission or an import uses
components:
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token for an authenticated seller session (`seller_api` audience)
  schemas:
    PaginationMeta:
      type: object
      properties:
        page:
          type: integer
          example: 1
        limit:
          type: integer
          example: 25
        count:
          type: integer
          example: 100
          description: Total number of records
        pages:
          type: integer
          example: 4
          description: Total number of pages
        from:
          type: integer
          example: 1
          description: Index of first record on this page
        to:
          type: integer
          example: 25
          description: Index of last record on this page
        in:
          type: integer
          example: 25
          description: Number of records on this page
        previous:
          type: integer
          nullable: true
          example:
          description: Previous page number
        next:
          type: integer
          nullable: true
          example: 2
          description: Next page number
      required:
      - page
      - limit
      - count
      - pages
      - from
      - to
      - in
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: record_not_found
            message:
              type: string
              example: Record not found
            details:
              type: object
              description: Field-specific validation errors
              nullable: true
              example:
                name:
                - is too short
                - is required
                email:
                - is invalid
          required:
          - code
          - message
      required:
      - error
      example:
        error:
          code: validation_error
          message: Validation failed
          details:
            name:
            - is too short
            email:
            - is invalid
    AuthResponse:
      type: object
      properties:
        token:
          type: string
          description: JWT access token, `seller_api` audience
        user:
          "$ref": "#/components/schemas/Account"
        sellers:
          type: array
          description: The sellers this user may act for. Pick one and send its `id`
            as `X-Spree-Seller-Id` on every subsequent request.
          items:
            "$ref": "#/components/schemas/SellerSummary"
      required:
      - token
      - user
      - sellers
    PermissionRule:
      type: object
      description: A single permission rule (CanCanCan rule). Rules are applied in
        order, last-matching-wins.
      properties:
        allow:
          type: boolean
          description: true for `can`, false for `cannot`
        actions:
          type: array
          items:
            type: string
          description: Action names, e.g. ["read", "update"] or ["manage"]
        subjects:
          type: array
          items:
            type: string
          description: Subject short names, e.g. ["product"] or ["all"]
        has_conditions:
          type: boolean
          description: True if the server-side rule has per-record conditions. The
            SPA shows the action optimistically and handles 403 from the API.
      required:
      - allow
      - actions
      - subjects
      - has_conditions
    ImportSchemaField:
      type: object
      description: A canonical column of an import type, including per-store custom
        field columns
      properties:
        name:
          type: string
          description: Canonical field name used in mappings
          example: slug
        label:
          type: string
          description: Human-readable label
          example: Slug
        required:
          type: boolean
          description: Whether the field must be mapped before processing
      required:
      - name
      - label
      - required
    CheckoutRequirement:
      type: object
      properties:
        step:
          type: string
          description: Checkout step this requirement belongs to
          example: payment
        field:
          type: string
          description: Field that needs to be satisfied
          example: payment
        message:
          type: string
          description: Human-readable requirement message
          example: Add a payment method
      required:
      - step
      - field
      - message
    CartWarning:
      type: object
      description: A warning about a cart issue (e.g., item removed due to stock change)
      properties:
        code:
          type: string
          description: Machine-readable warning code
          example: line_item_removed
        message:
          type: string
          description: Human-readable warning message
          example: Blue T-Shirt was removed because it was sold out
        line_item_id:
          type: string
          nullable: true
          description: Prefixed line item ID (when applicable)
          example: li_abc123
        variant_id:
          type: string
          nullable: true
          description: Prefixed variant ID (when applicable)
          example: variant_abc123
        item_index:
          type: integer
          nullable: true
          description: Position in the submitted items array, for warnings raised
            while applying a batch of item changes
          example: 1
      required:
      - code
      - message
    FulfillmentManifestItem:
      type: object
      description: An item within a fulfillment — which line item and how many units
        are in this fulfillment
      properties:
        item_id:
          type: string
          description: Line item ID
          example: li_abc123
        variant_id:
          type: string
          description: Variant ID
          example: variant_abc123
        quantity:
          type: integer
          description: Quantity in this fulfillment
          example: 2
      required:
      - item_id
      - variant_id
      - quantity
    AdminUserRoleAssignment:
      type: object
      description: A role assignment for the current store on a staff member
      properties:
        id:
          type: string
          description: Prefixed role ID
          example: role_abc123
        name:
          type: string
          description: Role name
          example: admin
      required:
      - id
      - name
    AdminUserStore:
      type: object
      description: A store the staff member can access through a role assignment
      properties:
        id:
          type: string
          description: Prefixed store ID
          example: store_abc123
        name:
          type: string
          description: Store name
          example: My Store
        code:
          type: string
          description: Store code
          example: my-store
      required:
      - id
      - name
      - code
    PreferenceSchema:
      type: object
      description: 'The JSON Schema (draft 2020-12) of a type''s `preferences`: one
        property per setting, with `format` (`money`, `currency`, `iso-country`, `prefixed-id`,
        …), `enum`, `default`, `x-spree-secret` for a secret and `x-spree-prefix`
        for an id list. Unknown keys are refused.'
      additionalProperties: true
      example:
        type: object
        properties:
          amount:
            type: string
            format: money
            default: '0.0'
        additionalProperties: false
    PromotionActionLineItem:
      type: object
      description: One row in a `create_line_items` action — the variant added to
        the order and how many
      properties:
        variant_id:
          type: string
          example: variant_abc123
        quantity:
          type: integer
          example: 1
      required:
      - variant_id
      - quantity
    SellerSummary:
      type: object
      description: A seller the signed-in user may act for
      properties:
        id:
          type: string
          description: Prefixed seller ID — send as `X-Spree-Seller-Id`
          example: sel_abc123
        name:
          type: string
          example: Acme Supplies
        status:
          type: string
          example: approved
          description: Seller lifecycle status
      required:
      - id
      - name
      - status
    SellerMeSummary:
      type: object
      description: A seller the signed-in user may act for, as `/me` reports it —
        the login response carries the same fields without `slug`.
      properties:
        id:
          type: string
          description: Prefixed seller ID — send as `X-Spree-Seller-Id`
          example: sel_abc123
        name:
          type: string
          example: Acme Supplies
        slug:
          type: string
          example: acme-supplies
        status:
          type: string
          example: approved
          description: Seller lifecycle status
      required:
      - id
      - name
      - slug
      - status
    SellerMeResponse:
      type: object
      description: The signed-in user, the sellers they may act for, and what they
        may do on the selected one
      properties:
        user:
          "$ref": "#/components/schemas/Account"
        sellers:
          type: array
          items:
            "$ref": "#/components/schemas/SellerMeSummary"
        store:
          "$ref": "#/components/schemas/Store"
        permissions:
          type: array
          items:
            "$ref": "#/components/schemas/PermissionRule"
        permission_keys:
          type: array
          items:
            type: string
          description: Permission keys on the selected seller. Empty until `X-Spree-Seller-Id`
            names one — capability is per seller.
          example:
          - read_products
          - write_products
      required:
      - user
      - sellers
      - store
      - permissions
      - permission_keys
    OnboardingProgress:
      type: object
      description: |
        How far along the checklist is — not how close to approval, since
        optional requirements count towards it too.

        Deliberately just the two counts. A percentage is arithmetic over
        them, which a client can do and which would otherwise be a second
        definition of the same fact.
      properties:
        done:
          type: integer
          example: 3
        total:
          type: integer
          example: 5
      required:
      - done
      - total
    SellerOnboardingResponse:
      type: object
      description: What the marketplace asks of this seller before it will admit them
      properties:
        status:
          type: string
          example: onboarding
          description: The seller's lifecycle status
        progress:
          "$ref": "#/components/schemas/OnboardingProgress"
        requirements:
          type: array
          items:
            "$ref": "#/components/schemas/RequirementStatus"
      required:
      - status
      - progress
      - requirements
    AuthProvidersResponse:
      type: object
      description: Sign-in methods this marketplace offers sellers, for the login
        page
      properties:
        providers:
          type: array
          items:
            type: object
            additionalProperties: true
      required:
      - providers
    Category:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        permalink:
          type: string
        position:
          type: number
        depth:
          type: number
        meta_title:
          type: string
          nullable: true
        meta_description:
          type: string
          nullable: true
        meta_keywords:
          type: string
          nullable: true
        children_count:
          type: number
        parent_id:
          type: string
          nullable: true
        description:
          type: string
        description_html:
          type: string
        image_url:
          type: string
          nullable: true
        square_image_url:
          type: string
          nullable: true
        is_root:
          type: boolean
        is_child:
          type: boolean
        is_leaf:
          type: boolean
        parent:
          "$ref": "#/components/schemas/Category"
        children:
          type: array
          items:
            "$ref": "#/components/schemas/Category"
        ancestors:
          type: array
          items:
            "$ref": "#/components/schemas/Category"
        custom_fields:
          type: array
          items:
            "$ref": "#/components/schemas/CustomField"
      required:
      - id
      - name
      - permalink
      - position
      - depth
      - meta_title
      - meta_description
      - meta_keywords
      - children_count
      - parent_id
      - description
      - description_html
      - image_url
      - square_image_url
      - is_root
      - is_child
      - is_leaf
      x-typelizer: true
    CustomField:
      type: object
      properties:
        id:
          type: string
        label:
          type: string
        field_type:
          type: string
          enum:
          - short_text
          - long_text
          - rich_text
          - number
          - boolean
          - json
        key:
          type: string
        value: {}
      required:
      - id
      - label
      - field_type
      - key
      - value
      x-typelizer: true
    OptionType:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        label:
          type: string
        position:
          type: number
        kind:
          type: string
          enum:
          - dropdown
          - color_swatch
          - buttons
        custom_fields:
          type: array
          items:
            "$ref": "#/components/schemas/CustomField"
      required:
      - id
      - name
      - label
      - position
      - kind
      x-typelizer: true
    OptionValue:
      type: object
      properties:
        id:
          type: string
        option_type_id:
          type: string
        name:
          type: string
        label:
          type: string
        position:
          type: number
        color_code:
          type: string
          nullable: true
        option_type_name:
          type: string
        option_type_label:
          type: string
        image_url:
          type: string
          nullable: true
        custom_fields:
          type: array
          items:
            "$ref": "#/components/schemas/CustomField"
      required:
      - id
      - option_type_id
      - name
      - label
      - position
      - color_code
      - option_type_name
      - option_type_label
      - image_url
      x-typelizer: true
    Account:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
        first_name:
          type: string
          nullable: true
        last_name:
          type: string
          nullable: true
        full_name:
          type: string
          nullable: true
        created_at:
          type: string
        avatar_url:
          type: string
          nullable: true
        selected_locale:
          type: string
          nullable: true
      required:
      - id
      - email
      - first_name
      - last_name
      - full_name
      - created_at
      - avatar_url
      - selected_locale
      x-typelizer: true
    Address:
      type: object
      properties:
        id:
          type: string
        label:
          type: string
          nullable: true
        first_name:
          type: string
          nullable: true
        last_name:
          type: string
          nullable: true
        full_name:
          type: string
        address1:
          type: string
          nullable: true
        address2:
          type: string
          nullable: true
        postal_code:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
        company:
          type: string
          nullable: true
        country_name:
          type: string
        country_code:
          type: string
          enum:
          - AD
          - AE
          - AF
          - AG
          - AI
          - AL
          - AM
          - AO
          - AR
          - AS
          - AT
          - AU
          - AW
          - AZ
          - BA
          - BB
          - BD
          - BE
          - BF
          - BG
          - BH
          - BI
          - BJ
          - BL
          - BM
          - BN
          - BO
          - BQ
          - BR
          - BS
          - BT
          - BW
          - BY
          - BZ
          - CA
          - CC
          - CD
          - CF
          - CG
          - CH
          - CI
          - CK
          - CL
          - CM
          - CN
          - CO
          - CR
          - CU
          - CV
          - CW
          - CX
          - CY
          - CZ
          - DE
          - DJ
          - DK
          - DM
          - DO
          - DZ
          - EC
          - EE
          - EG
          - ER
          - ES
          - ET
          - FI
          - FJ
          - FK
          - FM
          - FO
          - FR
          - GA
          - GB
          - GD
          - GE
          - GF
          - GG
          - GH
          - GI
          - GL
          - GM
          - GN
          - GP
          - GQ
          - GR
          - GT
          - GU
          - GW
          - GY
          - HK
          - HN
          - HR
          - HT
          - HU
          - ID
          - IE
          - IL
          - IM
          - IN
          - IQ
          - IR
          - IS
          - IT
          - JE
          - JM
          - JO
          - JP
          - KE
          - KG
          - KH
          - KI
          - KM
          - KN
          - KP
          - KR
          - KW
          - KY
          - KZ
          - LA
          - LB
          - LC
          - LI
          - LK
          - LR
          - LS
          - LT
          - LU
          - LV
          - LY
          - MA
          - MC
          - MD
          - ME
          - MF
          - MG
          - MH
          - MK
          - ML
          - MM
          - MN
          - MO
          - MP
          - MQ
          - MR
          - MS
          - MT
          - MU
          - MV
          - MW
          - MX
          - MY
          - MZ
          - NA
          - NC
          - NE
          - NF
          - NG
          - NI
          - NL
          - 'NO'
          - NP
          - NR
          - NU
          - NZ
          - OM
          - PA
          - PE
          - PF
          - PG
          - PH
          - PK
          - PL
          - PM
          - PN
          - PR
          - PS
          - PT
          - PW
          - PY
          - QA
          - RE
          - RO
          - RS
          - RU
          - RW
          - SA
          - SB
          - SC
          - SD
          - SE
          - SG
          - SH
          - SI
          - SJ
          - SK
          - SL
          - SM
          - SN
          - SO
          - SR
          - SS
          - ST
          - SV
          - SX
          - SY
          - SZ
          - TC
          - TD
          - TG
          - TH
          - TJ
          - TK
          - TL
          - TM
          - TN
          - TO
          - TR
          - TT
          - TV
          - TW
          - TZ
          - UA
          - UG
          - US
          - UY
          - UZ
          - VA
          - VC
          - VE
          - VG
          - VI
          - VN
          - VU
          - WF
          - WS
          - YE
          - YT
          - ZA
          - ZM
          - ZW
        state_text:
          type: string
          nullable: true
        state_code:
          type: string
          nullable: true
        quick_checkout:
          type: boolean
        is_default_billing:
          type: boolean
        is_default_shipping:
          type: boolean
        state_name:
          type: string
          nullable: true
        custom_fields:
          type: array
          items:
            "$ref": "#/components/schemas/CustomField"
      required:
      - id
      - label
      - first_name
      - last_name
      - full_name
      - address1
      - address2
      - postal_code
      - city
      - phone
      - company
      - country_name
      - country_code
      - state_text
      - state_code
      - quick_checkout
      - is_default_billing
      - is_default_shipping
      - state_name
      x-typelizer: true
    Balance:
      type: object
      properties:
        currency:
          type: string
          enum:
          - AED
          - AFN
          - ALL
          - AMD
          - ANG
          - AOA
          - ARS
          - AUD
          - AWG
          - AZN
          - BAM
          - BBD
          - BDT
          - BGN
          - BHD
          - BIF
          - BMD
          - BND
          - BOB
          - BRL
          - BSD
          - BTN
          - BWP
          - BYN
          - BYR
          - BZD
          - CAD
          - CDF
          - CHF
          - CLF
          - CLP
          - CNY
          - COP
          - CRC
          - CUC
          - CUP
          - CVE
          - CZK
          - DJF
          - DKK
          - DOP
          - DZD
          - EEK
          - EGP
          - ERN
          - ETB
          - EUR
          - FJD
          - FKP
          - GBP
          - GEL
          - GHS
          - GIP
          - GMD
          - GNF
          - GTQ
          - GYD
          - HKD
          - HNL
          - HRK
          - HTG
          - HUF
          - IDR
          - ILS
          - INR
          - IQD
          - IRR
          - ISK
          - JMD
          - JOD
          - JPY
          - KES
          - KGS
          - KHR
          - KMF
          - KPW
          - KRW
          - KWD
          - KYD
          - KZT
          - LAK
          - LBP
          - LKR
          - LRD
          - LSL
          - LTL
          - LVL
          - LYD
          - MAD
          - MDL
          - MGA
          - MKD
          - MMK
          - MNT
          - MOP
          - MRO
          - MRU
          - MTL
          - MUR
          - MVR
          - MWK
          - MXN
          - MYR
          - MZN
          - NAD
          - NGN
          - NIO
          - NOK
          - NPR
          - NZD
          - OMR
          - PAB
          - PEN
          - PGK
          - PHP
          - PKR
          - PLN
          - PYG
          - QAR
          - RON
          - RSD
          - RUB
          - RWF
          - SAR
          - SBD
          - SCR
          - SDG
          - SEK
          - SGD
          - SHP
          - SKK
          - SLE
          - SLL
          - SOS
          - SRD
          - SSP
          - STD
          - STN
          - SVC
          - SYP
          - SZL
          - THB
          - TJS
          - TMM
          - TMT
          - TND
          - TOP
          - TRY
          - TTD
          - TWD
          - TZS
          - UAH
          - UGX
          - USD
          - UYI
          - UYU
          - UYW
          - UZS
          - VED
          - VEF
          - VES
          - VND
          - VUV
          - WST
          - XAF
          - XCD
          - XCG
          - XOF
          - XPF
          - YER
          - ZAR
          - ZMK
          - ZMW
          - ZWD
          - ZWG
          - ZWL
          - ZWN
          - ZWR
        settlement_currency:
          type: string
          enum:
          - AED
          - AFN
          - ALL
          - AMD
          - ANG
          - AOA
          - ARS
          - AUD
          - AWG
          - AZN
          - BAM
          - BBD
          - BDT
          - BGN
          - BHD
          - BIF
          - BMD
          - BND
          - BOB
          - BRL
          - BSD
          - BTN
          - BWP
          - BYN
          - BYR
          - BZD
          - CAD
          - CDF
          - CHF
          - CLF
          - CLP
          - CNY
          - COP
          - CRC
          - CUC
          - CUP
          - CVE
          - CZK
          - DJF
          - DKK
          - DOP
          - DZD
          - EEK
          - EGP
          - ERN
          - ETB
          - EUR
          - FJD
          - FKP
          - GBP
          - GEL
          - GHS
          - GIP
          - GMD
          - GNF
          - GTQ
          - GYD
          - HKD
          - HNL
          - HRK
          - HTG
          - HUF
          - IDR
          - ILS
          - INR
          - IQD
          - IRR
          - ISK
          - JMD
          - JOD
          - JPY
          - KES
          - KGS
          - KHR
          - KMF
          - KPW
          - KRW
          - KWD
          - KYD
          - KZT
          - LAK
          - LBP
          - LKR
          - LRD
          - LSL
          - LTL
          - LVL
          - LYD
          - MAD
          - MDL
          - MGA
          - MKD
          - MMK
          - MNT
          - MOP
          - MRO
          - MRU
          - MTL
          - MUR
          - MVR
          - MWK
          - MXN
          - MYR
          - MZN
          - NAD
          - NGN
          - NIO
          - NOK
          - NPR
          - NZD
          - OMR
          - PAB
          - PEN
          - PGK
          - PHP
          - PKR
          - PLN
          - PYG
          - QAR
          - RON
          - RSD
          - RUB
          - RWF
          - SAR
          - SBD
          - SCR
          - SDG
          - SEK
          - SGD
          - SHP
          - SKK
          - SLE
          - SLL
          - SOS
          - SRD
          - SSP
          - STD
          - STN
          - SVC
          - SYP
          - SZL
          - THB
          - TJS
          - TMM
          - TMT
          - TND
          - TOP
          - TRY
          - TTD
          - TWD
          - TZS
          - UAH
          - UGX
          - USD
          - UYI
          - UYU
          - UYW
          - UZS
          - VED
          - VEF
          - VES
          - VND
          - VUV
          - WST
          - XAF
          - XCD
          - XCG
          - XOF
          - XPF
          - YER
          - ZAR
          - ZMK
          - ZMW
          - ZWD
          - ZWG
          - ZWL
          - ZWN
          - ZWR
        converted:
          type: boolean
        earned:
          type: string
        pending:
          type: string
        payable:
          type: string
        paid:
          type: string
        balance:
          type: string
      required:
      - currency
      - settlement_currency
      - converted
      - earned
      - pending
      - payable
      - paid
      - balance
      x-typelizer: true
    ClaimLineItem:
      type: object
      properties:
        id:
          type: string
        quantity:
          type: number
        send_replacement:
          type: boolean
        description:
          type: string
          nullable: true
        refund_amount:
          type: string
        paid_amount:
          type: string
        pre_tax_amount:
          type: string
        included_tax_total:
          type: string
        additional_tax_total:
          type: string
        tax_total:
          type: string
        variant_id:
          type: string
          nullable: true
        replacement_variant_id:
          type: string
          nullable: true
        line_item_id:
          type: string
          nullable: true
        variant:
          "$ref": "#/components/schemas/Variant"
        name:
          type: string
          nullable: true
      required:
      - id
      - quantity
      - send_replacement
      - description
      - refund_amount
      - paid_amount
      - pre_tax_amount
      - included_tax_total
      - additional_tax_total
      - tax_total
      - variant_id
      - replacement_variant_id
      - line_item_id
      - name
      x-typelizer: true
    Claim:
      type: object
      properties:
        id:
          type: string
        number:
          type: string
        status:
          anyOf:
          - type: string
            enum:
            - open
            - approved
            - resolved
            - denied
            - canceled
          - type: string
          description: The values listed are the built-in ones; extensions may add
            more.
        resolution:
          type: string
          nullable: true
          enum:
          - refund
          - replacement
          - refund_and_replacement
        order_id:
          type: string
          nullable: true
        reason_id:
          type: string
          nullable: true
        refund_total:
          type: string
        approved_at:
          type: string
          nullable: true
        resolved_at:
          type: string
          nullable: true
        denied_at:
          type: string
          nullable: true
        canceled_at:
          type: string
          nullable: true
        reason:
          "$ref": "#/components/schemas/Reason"
        claim_line_items:
          type: array
          items:
            "$ref": "#/components/schemas/ClaimLineItem"
        custom_fields:
          type: array
          items:
            "$ref": "#/components/schemas/CustomField"
        memo:
          type: string
          nullable: true
      required:
      - id
      - number
      - status
      - resolution
      - order_id
      - reason_id
      - refund_total
      - approved_at
      - resolved_at
      - denied_at
      - canceled_at
      - memo
      x-typelizer: true
    Country:
      type: object
      properties:
        iso:
          type: string
          enum:
          - AD
          - AE
          - AF
          - AG
          - AI
          - AL
          - AM
          - AO
          - AR
          - AS
          - AT
          - AU
          - AW
          - AZ
          - BA
          - BB
          - BD
          - BE
          - BF
          - BG
          - BH
          - BI
          - BJ
          - BL
          - BM
          - BN
          - BO
          - BQ
          - BR
          - BS
          - BT
          - BW
          - BY
          - BZ
          - CA
          - CC
          - CD
          - CF
          - CG
          - CH
          - CI
          - CK
          - CL
          - CM
          - CN
          - CO
          - CR
          - CU
          - CV
          - CW
          - CX
          - CY
          - CZ
          - DE
          - DJ
          - DK
          - DM
          - DO
          - DZ
          - EC
          - EE
          - EG
          - ER
          - ES
          - ET
          - FI
          - FJ
          - FK
          - FM
          - FO
          - FR
          - GA
          - GB
          - GD
          - GE
          - GF
          - GG
          - GH
          - GI
          - GL
          - GM
          - GN
          - GP
          - GQ
          - GR
          - GT
          - GU
          - GW
          - GY
          - HK
          - HN
          - HR
          - HT
          - HU
          - ID
          - IE
          - IL
          - IM
          - IN
          - IQ
          - IR
          - IS
          - IT
          - JE
          - JM
          - JO
          - JP
          - KE
          - KG
          - KH
          - KI
          - KM
          - KN
          - KP
          - KR
          - KW
          - KY
          - KZ
          - LA
          - LB
          - LC
          - LI
          - LK
          - LR
          - LS
          - LT
          - LU
          - LV
          - LY
          - MA
          - MC
          - MD
          - ME
          - MF
          - MG
          - MH
          - MK
          - ML
          - MM
          - MN
          - MO
          - MP
          - MQ
          - MR
          - MS
          - MT
          - MU
          - MV
          - MW
          - MX
          - MY
          - MZ
          - NA
          - NC
          - NE
          - NF
          - NG
          - NI
          - NL
          - 'NO'
          - NP
          - NR
          - NU
          - NZ
          - OM
          - PA
          - PE
          - PF
          - PG
          - PH
          - PK
          - PL
          - PM
          - PN
          - PR
          - PS
          - PT
          - PW
          - PY
          - QA
          - RE
          - RO
          - RS
          - RU
          - RW
          - SA
          - SB
          - SC
          - SD
          - SE
          - SG
          - SH
          - SI
          - SJ
          - SK
          - SL
          - SM
          - SN
          - SO
          - SR
          - SS
          - ST
          - SV
          - SX
          - SY
          - SZ
          - TC
          - TD
          - TG
          - TH
          - TJ
          - TK
          - TL
          - TM
          - TN
          - TO
          - TR
          - TT
          - TV
          - TW
          - TZ
          - UA
          - UG
          - US
          - UY
          - UZ
          - VA
          - VC
          - VE
          - VG
          - VI
          - VN
          - VU
          - WF
          - WS
          - YE
          - YT
          - ZA
          - ZM
          - ZW
        iso3:
          type: string
        states_required:
          type: boolean
        zipcode_required:
          type: boolean
        states:
          type: array
          items:
            "$ref": "#/components/schemas/State"
      required:
      - iso
      - iso3
      - states_required
      - zipcode_required
      x-typelizer: true
    DeliveryMethodRule:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        type:
          type: string
          description: 'Rule type. Built-in: item_total_rule, weight_rule, excluded_products_rule,
            channel_rule, volume_rule, company_rule. Extensions may register more.'
        preferences:
          "$ref": "#/components/schemas/DeliveryMethodRulePreferences"
      required:
      - id
      - active
      - type
      - preferences
      x-typelizer: true
    DeliveryMethod:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        code:
          type: string
          nullable: true
        estimated_transit_business_days_min:
          type: number
          nullable: true
        estimated_transit_business_days_max:
          type: number
          nullable: true
        digital:
          type: boolean
        pickup:
          type: boolean
        pickup_point:
          type: boolean
        custom_fields:
          type: array
          items:
            "$ref": "#/components/schemas/CustomField"
        admin_name:
          type: string
          nullable: true
        storefront_visible:
          type: boolean
        tracking_url:
          type: string
          nullable: true
        created_at:
          type: string
        updated_at:
          type: string
        rules:
          type: array
          items:
            "$ref": "#/components/schemas/DeliveryMethodRule"
        editable:
          type: boolean
        delivery_profile_id:
          type: string
          nullable: true
        delivery_zone_id:
          type: string
          nullable: true
        calculator:
          allOf:
          - "$ref": "#/components/schemas/DeliveryMethodCalculator"
          nullable: true
      required:
      - id
      - name
      - code
      - estimated_transit_business_days_min
      - estimated_transit_business_days_max
      - digital
      - pickup
      - pickup_point
      - admin_name
      - storefront_visible
      - tracking_url
      - created_at
      - updated_at
      - rules
      - editable
      - delivery_profile_id
      - delivery_zone_id
      - calculator
      x-typelizer: true
    DeliveryProfile:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        default:
          type: boolean
        digital:
          type: boolean
      required:
      - id
      - name
      - default
      - digital
      x-typelizer: true
    DeliveryRate:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        selected:
          type: boolean
        cost:
          type: string
        total:
          type: string
        carrier:
          type: string
          nullable: true
        service_level:
          type: string
          nullable: true
        estimated_delivery_date:
          type: string
          nullable: true
        unpriced:
          type: boolean
      required:
      - id
      - name
      - selected
      - cost
      - total
      - carrier
      - service_level
      - estimated_delivery_date
      - unpriced
      x-typelizer: true
    Delivery:
      type: object
      properties:
        id:
          type: string
        tracking_number:
          type: string
        carrier:
          type: string
          nullable: true
        carrier_name:
          type: string
          nullable: true
        service:
          type: string
          nullable: true
        status:
          type: string
          enum:
          - pending
          - pre_transit
          - in_transit
          - out_for_delivery
          - available_for_pickup
          - delivered
          - return_to_sender
          - failure
          - unknown
        tracking_url:
          type: string
          nullable: true
        estimated_delivery_at:
          type: string
          nullable: true
        delivered_at:
          type: string
          nullable: true
        created_at:
          type: string
        updated_at:
          type: string
        shipping_label_id:
          type: string
          nullable: true
      required:
      - id
      - tracking_number
      - carrier
      - carrier_name
      - service
      - status
      - tracking_url
      - estimated_delivery_at
      - delivered_at
      - created_at
      - updated_at
      - shipping_label_id
      x-typelizer: true
    DeliveryZone:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
          nullable: true
        delivery_profile_id:
          type: string
      required:
      - id
      - name
      - description
      - delivery_profile_id
      x-typelizer: true
    DigitalAsset:
      type: object
      properties:
        id:
          type: string
        variant_id:
          type: string
          nullable: true
        filename:
          type: string
          nullable: true
        content_type:
          type: string
          nullable: true
        authorized_clicks:
          type: number
          nullable: true
        authorized_days:
          type: number
          nullable: true
        byte_size:
          type: number
          nullable: true
        created_at:
          type: string
        updated_at:
          type: string
        provider_type:
          type: string
          nullable: true
          description: 'Digital asset provider; null is an uploaded file. Built-in:
            file. Extensions may register more.'
        provider_name:
          type: string
          description: 'Digital asset provider name. Built-in: File. Extensions may
            register more.'
        download_url:
          type: string
          nullable: true
        effective_authorized_clicks:
          type: number
        effective_authorized_days:
          type: number
      required:
      - id
      - variant_id
      - filename
      - content_type
      - authorized_clicks
      - authorized_days
      - byte_size
      - created_at
      - updated_at
      - provider_type
      - provider_name
      - download_url
      - effective_authorized_clicks
      - effective_authorized_days
      x-typelizer: true
    ExchangeLineItem:
      type: object
      properties:
        id:
          type: string
        quantity:
          type: number
        received_quantity:
          type: number
        resellable:
          type: boolean
        original_price:
          type: string
        new_variant_price:
          type: string
        price_difference:
          type: string
        original_tax_total:
          type: string
        new_tax_total:
          type: string
        original_variant_id:
          type: string
          nullable: true
        new_variant_id:
          type: string
          nullable: true
        line_item_id:
          type: string
          nullable: true
        fulfillment_item_id:
          type: string
          nullable: true
        original_variant:
          "$ref": "#/components/schemas/Variant"
        new_variant:
          "$ref": "#/components/schemas/Variant"
        name:
          type: string
          nullable: true
        new_variant_name:
          type: string
          nullable: true
      required:
      - id
      - quantity
      - received_quantity
      - resellable
      - original_price
      - new_variant_price
      - price_difference
      - original_tax_total
      - new_tax_total
      - original_variant_id
      - new_variant_id
      - line_item_id
      - fulfillment_item_id
      - name
      - new_variant_name
      x-typelizer: true
    Exchange:
      type: object
      properties:
        id:
          type: string
        number:
          type: string
        status:
          anyOf:
          - type: string
            enum:
            - requested
            - approved
            - received
            - fulfilled
            - canceled
          - type: string
          description: The values listed are the built-in ones; extensions may add
            more.
        order_id:
          type: string
          nullable: true
        reason_id:
          type: string
          nullable: true
        price_difference:
          type: string
        approved_at:
          type: string
          nullable: true
        received_at:
          type: string
          nullable: true
        fulfilled_at:
          type: string
          nullable: true
        canceled_at:
          type: string
          nullable: true
        reason:
          "$ref": "#/components/schemas/Reason"
        exchange_line_items:
          type: array
          items:
            "$ref": "#/components/schemas/ExchangeLineItem"
        memo:
          type: string
          nullable: true
        stock_location_id:
          type: string
          nullable: true
      required:
      - id
      - number
      - status
      - order_id
      - reason_id
      - price_difference
      - approved_at
      - received_at
      - fulfilled_at
      - canceled_at
      - memo
      - stock_location_id
      x-typelizer: true
    Export:
      type: object
      properties:
        id:
          type: string
        number:
          type: string
        format:
          type: string
          nullable: true
        created_at:
          type: string
        updated_at:
          type: string
        type:
          type: string
          nullable: true
        user_id:
          type: string
          nullable: true
        done:
          type: boolean
        filename:
          type: string
          nullable: true
        byte_size:
          type: number
          nullable: true
        download_url:
          type: string
          nullable: true
      required:
      - id
      - number
      - format
      - created_at
      - updated_at
      - type
      - user_id
      - done
      - filename
      - byte_size
      - download_url
      x-typelizer: true
    FileUpload:
      type: object
      properties:
        signed_id:
          type: string
        filename:
          type: string
        content_type:
          type: string
        byte_size:
          type: number
        visibility:
          type: string
          enum:
          - public
          - private
        expires_at:
          type: string
        upload:
          allOf:
          - "$ref": "#/components/schemas/FileUploadTarget"
          nullable: true
      required:
      - signed_id
      - filename
      - content_type
      - byte_size
      - visibility
      - expires_at
      - upload
      x-typelizer: true
    FileUploadTarget:
      type: object
      properties:
        method:
          type: string
        url:
          type: string
        headers:
          type: object
      required:
      - method
      - url
      - headers
      x-typelizer: true
    FulfillmentItem:
      type: object
      properties:
        id:
          type: string
        quantity:
          type: number
        line_item_id:
          type: string
          nullable: true
        variant_id:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
        sku:
          type: string
          nullable: true
        options_text:
          type: string
          nullable: true
      required:
      - id
      - quantity
      - line_item_id
      - variant_id
      - name
      - sku
      - options_text
      x-typelizer: true
    Fulfillment:
      type: object
      properties:
        id:
          type: string
        number:
          type: string
        status:
          anyOf:
          - type: string
            enum:
            - unfulfilled
            - fulfilled
            - delivered
            - canceled
          - type: string
          description: The values listed are the built-in ones; extensions may add
            more.
        tracking:
          type: string
          nullable: true
        tracking_url:
          type: string
          nullable: true
        fulfilled_at:
          type: string
          nullable: true
        delivered_at:
          type: string
          nullable: true
        created_at:
          type: string
        updated_at:
          type: string
        fulfillment_type:
          type: string
          nullable: true
        delivery_method_name:
          type: string
          nullable: true
        stock_location_name:
          type: string
          nullable: true
        stock_location_id:
          type: string
          nullable: true
        fulfillment_items:
          type: array
          items:
            "$ref": "#/components/schemas/FulfillmentItem"
        selected_delivery_rate_id:
          type: string
          nullable: true
        delivery_rates:
          type: array
          items:
            "$ref": "#/components/schemas/DeliveryRate"
        deliveries:
          type: array
          items:
            "$ref": "#/components/schemas/Delivery"
        labels:
          type: array
          items:
            "$ref": "#/components/schemas/ShippingLabel"
      required:
      - id
      - number
      - status
      - tracking
      - tracking_url
      - fulfilled_at
      - delivered_at
      - created_at
      - updated_at
      - fulfillment_type
      - delivery_method_name
      - stock_location_name
      - stock_location_id
      - fulfillment_items
      - selected_delivery_rate_id
      - delivery_rates
      - deliveries
      - labels
      x-typelizer: true
    ImportMapping:
      type: object
      properties:
        id:
          type: string
        schema_field:
          type: string
        file_column:
          type: string
          nullable: true
        required:
          type: boolean
      required:
      - id
      - schema_field
      - file_column
      - required
      x-typelizer: true
    ImportRow:
      type: object
      properties:
        id:
          type: string
        row_number:
          type: number
        status:
          anyOf:
          - type: string
            enum:
            - pending
            - processing
            - completed
            - failed
          - type: string
          description: The values listed are the built-in ones; extensions may add
            more.
        validation_errors:
          type: string
          nullable: true
        created_at:
          type: string
        updated_at:
          type: string
        import_id:
          type: string
          nullable: true
        item_type:
          type: string
          nullable: true
        item_id:
          type: string
          nullable: true
        data:
          type: object
      required:
      - id
      - row_number
      - status
      - validation_errors
      - created_at
      - updated_at
      - import_id
      - item_type
      - item_id
      - data
      x-typelizer: true
    Import:
      type: object
      properties:
        id:
          type: string
        number:
          type: string
        rows_count:
          type: number
        created_at:
          type: string
        updated_at:
          type: string
        type:
          type: string
          nullable: true
          description: 'Import type. Built-in: products, product_translations, customers,
            price_list_prices. Extensions may register more.'
        status:
          anyOf:
          - type: string
            enum:
            - pending
            - mapping
            - completed_mapping
            - processing
            - completed
            - failed
          - type: string
          description: The values listed are the built-in ones; extensions may add
            more.
        store_id:
          type: string
          nullable: true
        seller_id:
          type: string
          nullable: true
        user_id:
          type: string
          nullable: true
        processing_errors:
          type: string
          nullable: true
        delimiter:
          type: string
        original_filename:
          type: string
          nullable: true
        original_byte_size:
          type: number
          nullable: true
        original_file_url:
          type: string
          nullable: true
        completed_rows_count:
          type: number
        failed_rows_count:
          type: number
        schema_fields:
          type: array
          items:
            "$ref": "#/components/schemas/ImportSchemaField"
        csv_headers:
          type: array
          items:
            type: string
        sample_row:
          type: object
        mappings:
          type: array
          items:
            "$ref": "#/components/schemas/ImportMapping"
      required:
      - id
      - number
      - rows_count
      - created_at
      - updated_at
      - type
      - status
      - store_id
      - seller_id
      - user_id
      - processing_errors
      - delimiter
      - original_filename
      - original_byte_size
      - original_file_url
      - completed_rows_count
      - failed_rows_count
      - schema_fields
      - csv_headers
      - sample_row
      - mappings
      x-typelizer: true
    InvitationAcceptanceLink:
      type: object
      properties:
        id:
          type: string
        acceptance_url:
          type: string
      required:
      - id
      - acceptance_url
      x-typelizer: true
    Invitation:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
        created_at:
          type: string
        expires_at:
          type: string
          nullable: true
        accepted_at:
          type: string
          nullable: true
        status:
          anyOf:
          - type: string
            enum:
            - pending
            - accepted
          - type: string
          description: The values listed are the built-in ones; extensions may add
            more.
        inviter_email:
          type: string
        invitee_exists:
          type: boolean
        seller:
          type: object
      required:
      - id
      - email
      - created_at
      - expires_at
      - accepted_at
      - status
      - inviter_email
      - seller
      x-typelizer: true
    Media:
      type: object
      properties:
        id:
          type: string
        product_id:
          type: string
          nullable: true
        variant_ids:
          type: array
          items:
            type: string
        position:
          type: number
        alt:
          type: string
          nullable: true
        media_type:
          type: string
          enum:
          - image
          - video
          - external_video
        external_video_url:
          type: string
          nullable: true
        focal_point_x:
          type: number
          nullable: true
        focal_point_y:
          type: number
          nullable: true
        video_provider:
          type: string
          nullable: true
        video_embed_url:
          type: string
          nullable: true
        video_url:
          type: string
          nullable: true
        poster_url:
          type: string
          nullable: true
        original_url:
          type: string
          nullable: true
        mini_url:
          type: string
          nullable: true
        small_url:
          type: string
          nullable: true
        medium_url:
          type: string
          nullable: true
        large_url:
          type: string
          nullable: true
        xlarge_url:
          type: string
          nullable: true
        og_image_url:
          type: string
          nullable: true
        custom_fields:
          type: array
          items:
            "$ref": "#/components/schemas/CustomField"
        created_at:
          type: string
        updated_at:
          type: string
      required:
      - id
      - product_id
      - variant_ids
      - position
      - alt
      - media_type
      - external_video_url
      - focal_point_x
      - focal_point_y
      - video_provider
      - video_embed_url
      - video_url
      - poster_url
      - original_url
      - mini_url
      - small_url
      - medium_url
      - large_url
      - xlarge_url
      - og_image_url
      - created_at
      - updated_at
      x-typelizer: true
    OrderLineItem:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        options_text:
          type: string
          nullable: true
        quantity:
          type: number
        currency:
          type: string
          enum:
          - AED
          - AFN
          - ALL
          - AMD
          - ANG
          - AOA
          - ARS
          - AUD
          - AWG
          - AZN
          - BAM
          - BBD
          - BDT
          - BGN
          - BHD
          - BIF
          - BMD
          - BND
          - BOB
          - BRL
          - BSD
          - BTN
          - BWP
          - BYN
          - BYR
          - BZD
          - CAD
          - CDF
          - CHF
          - CLF
          - CLP
          - CNY
          - COP
          - CRC
          - CUC
          - CUP
          - CVE
          - CZK
          - DJF
          - DKK
          - DOP
          - DZD
          - EEK
          - EGP
          - ERN
          - ETB
          - EUR
          - FJD
          - FKP
          - GBP
          - GEL
          - GHS
          - GIP
          - GMD
          - GNF
          - GTQ
          - GYD
          - HKD
          - HNL
          - HRK
          - HTG
          - HUF
          - IDR
          - ILS
          - INR
          - IQD
          - IRR
          - ISK
          - JMD
          - JOD
          - JPY
          - KES
          - KGS
          - KHR
          - KMF
          - KPW
          - KRW
          - KWD
          - KYD
          - KZT
          - LAK
          - LBP
          - LKR
          - LRD
          - LSL
          - LTL
          - LVL
          - LYD
          - MAD
          - MDL
          - MGA
          - MKD
          - MMK
          - MNT
          - MOP
          - MRO
          - MRU
          - MTL
          - MUR
          - MVR
          - MWK
          - MXN
          - MYR
          - MZN
          - NAD
          - NGN
          - NIO
          - NOK
          - NPR
          - NZD
          - OMR
          - PAB
          - PEN
          - PGK
          - PHP
          - PKR
          - PLN
          - PYG
          - QAR
          - RON
          - RSD
          - RUB
          - RWF
          - SAR
          - SBD
          - SCR
          - SDG
          - SEK
          - SGD
          - SHP
          - SKK
          - SLE
          - SLL
          - SOS
          - SRD
          - SSP
          - STD
          - STN
          - SVC
          - SYP
          - SZL
          - THB
          - TJS
          - TMM
          - TMT
          - TND
          - TOP
          - TRY
          - TTD
          - TWD
          - TZS
          - UAH
          - UGX
          - USD
          - UYI
          - UYU
          - UYW
          - UZS
          - VED
          - VEF
          - VES
          - VND
          - VUV
          - WST
          - XAF
          - XCD
          - XCG
          - XOF
          - XPF
          - YER
          - ZAR
          - ZMK
          - ZMW
          - ZWD
          - ZWG
          - ZWL
          - ZWN
          - ZWR
        price:
          type: string
          nullable: true
        discounted_amount:
          type: string
          nullable: true
        additional_tax_total:
          type: string
          nullable: true
        total:
          type: string
          nullable: true
        variant_id:
          type: string
          nullable: true
        sku:
          type: string
          nullable: true
        thumbnail_url:
          type: string
          nullable: true
      required:
      - id
      - name
      - options_text
      - quantity
      - currency
      - price
      - discounted_amount
      - additional_tax_total
      - total
      - variant_id
      - sku
      - thumbnail_url
      x-typelizer: true
    Order:
      type: object
      properties:
        id:
          type: string
        number:
          type: string
        customer_note:
          type: string
          nullable: true
        currency:
          type: string
          enum:
          - AED
          - AFN
          - ALL
          - AMD
          - ANG
          - AOA
          - ARS
          - AUD
          - AWG
          - AZN
          - BAM
          - BBD
          - BDT
          - BGN
          - BHD
          - BIF
          - BMD
          - BND
          - BOB
          - BRL
          - BSD
          - BTN
          - BWP
          - BYN
          - BYR
          - BZD
          - CAD
          - CDF
          - CHF
          - CLF
          - CLP
          - CNY
          - COP
          - CRC
          - CUC
          - CUP
          - CVE
          - CZK
          - DJF
          - DKK
          - DOP
          - DZD
          - EEK
          - EGP
          - ERN
          - ETB
          - EUR
          - FJD
          - FKP
          - GBP
          - GEL
          - GHS
          - GIP
          - GMD
          - GNF
          - GTQ
          - GYD
          - HKD
          - HNL
          - HRK
          - HTG
          - HUF
          - IDR
          - ILS
          - INR
          - IQD
          - IRR
          - ISK
          - JMD
          - JOD
          - JPY
          - KES
          - KGS
          - KHR
          - KMF
          - KPW
          - KRW
          - KWD
          - KYD
          - KZT
          - LAK
          - LBP
          - LKR
          - LRD
          - LSL
          - LTL
          - LVL
          - LYD
          - MAD
          - MDL
          - MGA
          - MKD
          - MMK
          - MNT
          - MOP
          - MRO
          - MRU
          - MTL
          - MUR
          - MVR
          - MWK
          - MXN
          - MYR
          - MZN
          - NAD
          - NGN
          - NIO
          - NOK
          - NPR
          - NZD
          - OMR
          - PAB
          - PEN
          - PGK
          - PHP
          - PKR
          - PLN
          - PYG
          - QAR
          - RON
          - RSD
          - RUB
          - RWF
          - SAR
          - SBD
          - SCR
          - SDG
          - SEK
          - SGD
          - SHP
          - SKK
          - SLE
          - SLL
          - SOS
          - SRD
          - SSP
          - STD
          - STN
          - SVC
          - SYP
          - SZL
          - THB
          - TJS
          - TMM
          - TMT
          - TND
          - TOP
          - TRY
          - TTD
          - TWD
          - TZS
          - UAH
          - UGX
          - USD
          - UYI
          - UYU
          - UYW
          - UZS
          - VED
          - VEF
          - VES
          - VND
          - VUV
          - WST
          - XAF
          - XCD
          - XCG
          - XOF
          - XPF
          - YER
          - ZAR
          - ZMK
          - ZMW
          - ZWD
          - ZWG
          - ZWL
          - ZWN
          - ZWR
        total_quantity:
          type: number
        status:
          type: string
          enum:
          - draft
          - placed
          - canceled
        fulfillment_status:
          type: string
          nullable: true
          enum:
          - backorder
          - canceled
          - partial
          - unfulfilled
          - fulfilled
          - delivered
          - pending
          - ready
          - shipped
        payment_status:
          type: string
          nullable: true
          enum:
          - none
          - authorized
          - partially_paid
          - paid
          - partially_refunded
          - refunded
          - overcharged
          - voided
        completed_at:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        internal_note:
          type: string
          nullable: true
        internal_note_html:
          type: string
          nullable: true
        item_total:
          type: string
          nullable: true
        delivery_total:
          type: string
          nullable: true
        discount_total:
          type: string
          nullable: true
        adjustment_total:
          type: string
          nullable: true
        included_tax_total:
          type: string
          nullable: true
        additional_tax_total:
          type: string
          nullable: true
        tax_total:
          type: string
          nullable: true
        total:
          type: string
          nullable: true
        payment_total:
          type: string
          nullable: true
        amount_due:
          type: string
          nullable: true
        commission_amount_total:
          type: string
          nullable: true
        commission_tax_total:
          type: string
          nullable: true
        commission_total:
          type: string
          nullable: true
        canceled_at:
          type: string
          nullable: true
        cancel_reason_name:
          type: string
          nullable: true
        cancel_note:
          type: string
          nullable: true
        items:
          type: array
          items:
            "$ref": "#/components/schemas/OrderLineItem"
        payment_splits:
          type: array
          items:
            "$ref": "#/components/schemas/PaymentSplit"
        fulfillments:
          type: array
          items:
            "$ref": "#/components/schemas/Fulfillment"
        shipping_address:
          "$ref": "#/components/schemas/Address"
        billing_address:
          "$ref": "#/components/schemas/Address"
      required:
      - id
      - number
      - customer_note
      - currency
      - total_quantity
      - status
      - fulfillment_status
      - payment_status
      - completed_at
      - created_at
      - updated_at
      - internal_note
      - internal_note_html
      - item_total
      - delivery_total
      - discount_total
      - adjustment_total
      - included_tax_total
      - additional_tax_total
      - tax_total
      - total
      - payment_total
      - amount_due
      - commission_amount_total
      - commission_tax_total
      - commission_total
      - canceled_at
      - cancel_reason_name
      - cancel_note
      - items
      - fulfillments
      - shipping_address
      - billing_address
      x-typelizer: true
    PackageType:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        kind:
          type: string
          enum:
          - box
          - envelope
          - carton
          - pallet
          - container
        length:
          type: string
          nullable: true
        width:
          type: string
          nullable: true
        height:
          type: string
          nullable: true
        weight:
          type: string
          nullable: true
        max_weight:
          type: string
          nullable: true
        default:
          type: boolean
        metadata:
          type: object
          nullable: true
        created_at:
          type: string
        updated_at:
          type: string
        dimensions_unit:
          type: string
          enum:
          - mm
          - cm
          - in
          - ft
        weight_unit:
          type: string
          enum:
          - g
          - kg
          - lb
          - oz
        volume:
          type: string
          nullable: true
        editable:
          type: boolean
      required:
      - id
      - name
      - kind
      - length
      - width
      - height
      - weight
      - max_weight
      - default
      - metadata
      - created_at
      - updated_at
      - dimensions_unit
      - weight_unit
      - volume
      - editable
      x-typelizer: true
    PaymentSplit:
      type: object
      properties:
        id:
          type: string
        currency:
          type: string
          enum:
          - AED
          - AFN
          - ALL
          - AMD
          - ANG
          - AOA
          - ARS
          - AUD
          - AWG
          - AZN
          - BAM
          - BBD
          - BDT
          - BGN
          - BHD
          - BIF
          - BMD
          - BND
          - BOB
          - BRL
          - BSD
          - BTN
          - BWP
          - BYN
          - BYR
          - BZD
          - CAD
          - CDF
          - CHF
          - CLF
          - CLP
          - CNY
          - COP
          - CRC
          - CUC
          - CUP
          - CVE
          - CZK
          - DJF
          - DKK
          - DOP
          - DZD
          - EEK
          - EGP
          - ERN
          - ETB
          - EUR
          - FJD
          - FKP
          - GBP
          - GEL
          - GHS
          - GIP
          - GMD
          - GNF
          - GTQ
          - GYD
          - HKD
          - HNL
          - HRK
          - HTG
          - HUF
          - IDR
          - ILS
          - INR
          - IQD
          - IRR
          - ISK
          - JMD
          - JOD
          - JPY
          - KES
          - KGS
          - KHR
          - KMF
          - KPW
          - KRW
          - KWD
          - KYD
          - KZT
          - LAK
          - LBP
          - LKR
          - LRD
          - LSL
          - LTL
          - LVL
          - LYD
          - MAD
          - MDL
          - MGA
          - MKD
          - MMK
          - MNT
          - MOP
          - MRO
          - MRU
          - MTL
          - MUR
          - MVR
          - MWK
          - MXN
          - MYR
          - MZN
          - NAD
          - NGN
          - NIO
          - NOK
          - NPR
          - NZD
          - OMR
          - PAB
          - PEN
          - PGK
          - PHP
          - PKR
          - PLN
          - PYG
          - QAR
          - RON
          - RSD
          - RUB
          - RWF
          - SAR
          - SBD
          - SCR
          - SDG
          - SEK
          - SGD
          - SHP
          - SKK
          - SLE
          - SLL
          - SOS
          - SRD
          - SSP
          - STD
          - STN
          - SVC
          - SYP
          - SZL
          - THB
          - TJS
          - TMM
          - TMT
          - TND
          - TOP
          - TRY
          - TTD
          - TWD
          - TZS
          - UAH
          - UGX
          - USD
          - UYI
          - UYU
          - UYW
          - UZS
          - VED
          - VEF
          - VES
          - VND
          - VUV
          - WST
          - XAF
          - XCD
          - XCG
          - XOF
          - XPF
          - YER
          - ZAR
          - ZMK
          - ZMW
          - ZWD
          - ZWG
          - ZWL
          - ZWN
          - ZWR
        created_at:
          type: string
        authorized_amount:
          type: string
        captured_amount:
          type: string
        refunded_amount:
          type: string
        claimed_amount:
          type: string
        net_captured_amount:
          type: string
        refundable_amount:
          type: string
      required:
      - id
      - currency
      - created_at
      - authorized_amount
      - captured_amount
      - refunded_amount
      - claimed_amount
      - net_captured_amount
      - refundable_amount
      x-typelizer: true
    Payout:
      type: object
      properties:
        id:
          type: string
        status:
          type: string
        currency:
          type: string
          enum:
          - AED
          - AFN
          - ALL
          - AMD
          - ANG
          - AOA
          - ARS
          - AUD
          - AWG
          - AZN
          - BAM
          - BBD
          - BDT
          - BGN
          - BHD
          - BIF
          - BMD
          - BND
          - BOB
          - BRL
          - BSD
          - BTN
          - BWP
          - BYN
          - BYR
          - BZD
          - CAD
          - CDF
          - CHF
          - CLF
          - CLP
          - CNY
          - COP
          - CRC
          - CUC
          - CUP
          - CVE
          - CZK
          - DJF
          - DKK
          - DOP
          - DZD
          - EEK
          - EGP
          - ERN
          - ETB
          - EUR
          - FJD
          - FKP
          - GBP
          - GEL
          - GHS
          - GIP
          - GMD
          - GNF
          - GTQ
          - GYD
          - HKD
          - HNL
          - HRK
          - HTG
          - HUF
          - IDR
          - ILS
          - INR
          - IQD
          - IRR
          - ISK
          - JMD
          - JOD
          - JPY
          - KES
          - KGS
          - KHR
          - KMF
          - KPW
          - KRW
          - KWD
          - KYD
          - KZT
          - LAK
          - LBP
          - LKR
          - LRD
          - LSL
          - LTL
          - LVL
          - LYD
          - MAD
          - MDL
          - MGA
          - MKD
          - MMK
          - MNT
          - MOP
          - MRO
          - MRU
          - MTL
          - MUR
          - MVR
          - MWK
          - MXN
          - MYR
          - MZN
          - NAD
          - NGN
          - NIO
          - NOK
          - NPR
          - NZD
          - OMR
          - PAB
          - PEN
          - PGK
          - PHP
          - PKR
          - PLN
          - PYG
          - QAR
          - RON
          - RSD
          - RUB
          - RWF
          - SAR
          - SBD
          - SCR
          - SDG
          - SEK
          - SGD
          - SHP
          - SKK
          - SLE
          - SLL
          - SOS
          - SRD
          - SSP
          - STD
          - STN
          - SVC
          - SYP
          - SZL
          - THB
          - TJS
          - TMM
          - TMT
          - TND
          - TOP
          - TRY
          - TTD
          - TWD
          - TZS
          - UAH
          - UGX
          - USD
          - UYI
          - UYU
          - UYW
          - UZS
          - VED
          - VEF
          - VES
          - VND
          - VUV
          - WST
          - XAF
          - XCD
          - XCG
          - XOF
          - XPF
          - YER
          - ZAR
          - ZMK
          - ZMW
          - ZWD
          - ZWG
          - ZWL
          - ZWN
          - ZWR
        reference:
          type: string
          nullable: true
        period_start:
          type: string
          nullable: true
        period_end:
          type: string
          nullable: true
        created_at:
          type: string
        updated_at:
          type: string
        amount:
          type: string
        transfers_count:
          type: number
        provider:
          type: string
          description: 'Payout provider. Built-in: system. Provider gems register
            more (e.g. stripe).'
      required:
      - id
      - status
      - currency
      - reference
      - period_start
      - period_end
      - created_at
      - updated_at
      - amount
      - transfers_count
      - provider
      x-typelizer: true
    Policy:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        slug:
          type: string
        body:
          type: string
          nullable: true
        body_html:
          type: string
          nullable: true
        updated_at:
          type: string
        created_at:
          type: string
      required:
      - id
      - name
      - slug
      - body
      - body_html
      - updated_at
      - created_at
      x-typelizer: true
    PriceHistory:
      type: object
      properties:
        id:
          type: string
        currency:
          type: string
          enum:
          - AED
          - AFN
          - ALL
          - AMD
          - ANG
          - AOA
          - ARS
          - AUD
          - AWG
          - AZN
          - BAM
          - BBD
          - BDT
          - BGN
          - BHD
          - BIF
          - BMD
          - BND
          - BOB
          - BRL
          - BSD
          - BTN
          - BWP
          - BYN
          - BYR
          - BZD
          - CAD
          - CDF
          - CHF
          - CLF
          - CLP
          - CNY
          - COP
          - CRC
          - CUC
          - CUP
          - CVE
          - CZK
          - DJF
          - DKK
          - DOP
          - DZD
          - EEK
          - EGP
          - ERN
          - ETB
          - EUR
          - FJD
          - FKP
          - GBP
          - GEL
          - GHS
          - GIP
          - GMD
          - GNF
          - GTQ
          - GYD
          - HKD
          - HNL
          - HRK
          - HTG
          - HUF
          - IDR
          - ILS
          - INR
          - IQD
          - IRR
          - ISK
          - JMD
          - JOD
          - JPY
          - KES
          - KGS
          - KHR
          - KMF
          - KPW
          - KRW
          - KWD
          - KYD
          - KZT
          - LAK
          - LBP
          - LKR
          - LRD
          - LSL
          - LTL
          - LVL
          - LYD
          - MAD
          - MDL
          - MGA
          - MKD
          - MMK
          - MNT
          - MOP
          - MRO
          - MRU
          - MTL
          - MUR
          - MVR
          - MWK
          - MXN
          - MYR
          - MZN
          - NAD
          - NGN
          - NIO
          - NOK
          - NPR
          - NZD
          - OMR
          - PAB
          - PEN
          - PGK
          - PHP
          - PKR
          - PLN
          - PYG
          - QAR
          - RON
          - RSD
          - RUB
          - RWF
          - SAR
          - SBD
          - SCR
          - SDG
          - SEK
          - SGD
          - SHP
          - SKK
          - SLE
          - SLL
          - SOS
          - SRD
          - SSP
          - STD
          - STN
          - SVC
          - SYP
          - SZL
          - THB
          - TJS
          - TMM
          - TMT
          - TND
          - TOP
          - TRY
          - TTD
          - TWD
          - TZS
          - UAH
          - UGX
          - USD
          - UYI
          - UYU
          - UYW
          - UZS
          - VED
          - VEF
          - VES
          - VND
          - VUV
          - WST
          - XAF
          - XCD
          - XCG
          - XOF
          - XPF
          - YER
          - ZAR
          - ZMK
          - ZMW
          - ZWD
          - ZWG
          - ZWL
          - ZWN
          - ZWR
        amount:
          type: string
          nullable: true
        recorded_at:
          type: string
      required:
      - id
      - currency
      - amount
      - recorded_at
      x-typelizer: true
    Price:
      type: object
      properties:
        id:
          type: string
        currency:
          type: string
          nullable: true
          enum:
          - AED
          - AFN
          - ALL
          - AMD
          - ANG
          - AOA
          - ARS
          - AUD
          - AWG
          - AZN
          - BAM
          - BBD
          - BDT
          - BGN
          - BHD
          - BIF
          - BMD
          - BND
          - BOB
          - BRL
          - BSD
          - BTN
          - BWP
          - BYN
          - BYR
          - BZD
          - CAD
          - CDF
          - CHF
          - CLF
          - CLP
          - CNY
          - COP
          - CRC
          - CUC
          - CUP
          - CVE
          - CZK
          - DJF
          - DKK
          - DOP
          - DZD
          - EEK
          - EGP
          - ERN
          - ETB
          - EUR
          - FJD
          - FKP
          - GBP
          - GEL
          - GHS
          - GIP
          - GMD
          - GNF
          - GTQ
          - GYD
          - HKD
          - HNL
          - HRK
          - HTG
          - HUF
          - IDR
          - ILS
          - INR
          - IQD
          - IRR
          - ISK
          - JMD
          - JOD
          - JPY
          - KES
          - KGS
          - KHR
          - KMF
          - KPW
          - KRW
          - KWD
          - KYD
          - KZT
          - LAK
          - LBP
          - LKR
          - LRD
          - LSL
          - LTL
          - LVL
          - LYD
          - MAD
          - MDL
          - MGA
          - MKD
          - MMK
          - MNT
          - MOP
          - MRO
          - MRU
          - MTL
          - MUR
          - MVR
          - MWK
          - MXN
          - MYR
          - MZN
          - NAD
          - NGN
          - NIO
          - NOK
          - NPR
          - NZD
          - OMR
          - PAB
          - PEN
          - PGK
          - PHP
          - PKR
          - PLN
          - PYG
          - QAR
          - RON
          - RSD
          - RUB
          - RWF
          - SAR
          - SBD
          - SCR
          - SDG
          - SEK
          - SGD
          - SHP
          - SKK
          - SLE
          - SLL
          - SOS
          - SRD
          - SSP
          - STD
          - STN
          - SVC
          - SYP
          - SZL
          - THB
          - TJS
          - TMM
          - TMT
          - TND
          - TOP
          - TRY
          - TTD
          - TWD
          - TZS
          - UAH
          - UGX
          - USD
          - UYI
          - UYU
          - UYW
          - UZS
          - VED
          - VEF
          - VES
          - VND
          - VUV
          - WST
          - XAF
          - XCD
          - XCG
          - XOF
          - XPF
          - YER
          - ZAR
          - ZMK
          - ZMW
          - ZWD
          - ZWG
          - ZWL
          - ZWN
          - ZWR
        amount:
          type: string
          nullable: true
        compare_at_amount:
          type: string
          nullable: true
        price_list_id:
          type: string
          nullable: true
      required:
      - id
      - currency
      - amount
      - compare_at_amount
      - price_list_id
      x-typelizer: true
    Product:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        slug:
          type: string
        meta_title:
          type: string
          nullable: true
        meta_description:
          type: string
          nullable: true
        meta_keywords:
          type: string
          nullable: true
        variant_count:
          type: number
        available_on:
          type: string
          nullable: true
        preorder_ships_at:
          type: string
          nullable: true
        purchasable:
          type: boolean
        preorder:
          type: boolean
        in_stock:
          type: boolean
        backorderable:
          type: boolean
        available:
          type: boolean
        description:
          type: string
          nullable: true
        description_html:
          type: string
          nullable: true
        default_variant_id:
          type: string
        buy_box_variant_id:
          type: string
          nullable: true
        thumbnail_url:
          type: string
          nullable: true
        tags:
          type: array
          items:
            type: string
        price:
          "$ref": "#/components/schemas/Price"
        original_price:
          allOf:
          - "$ref": "#/components/schemas/Price"
          nullable: true
        seller_id:
          type: string
          nullable: true
        seller:
          "$ref": "#/components/schemas/Seller"
        primary_media:
          "$ref": "#/components/schemas/Media"
        media:
          type: array
          items:
            "$ref": "#/components/schemas/Media"
        variants:
          type: array
          items:
            "$ref": "#/components/schemas/Variant"
        default_variant:
          "$ref": "#/components/schemas/Variant"
        option_types:
          type: array
          items:
            "$ref": "#/components/schemas/OptionType"
        option_values:
          type: array
          items:
            "$ref": "#/components/schemas/OptionValue"
        categories:
          type: array
          items:
            "$ref": "#/components/schemas/Category"
        custom_fields:
          type: array
          items:
            "$ref": "#/components/schemas/CustomField"
        prior_price:
          allOf:
          - "$ref": "#/components/schemas/PriceHistory"
          nullable: true
        status:
          anyOf:
          - type: string
            enum:
            - draft
            - active
            - archived
            - proposed
            - rejected
          - type: string
          description: The values listed are the built-in ones; extensions may add
            more.
        metadata:
          type: object
        created_at:
          type: string
        updated_at:
          type: string
        product_type_id:
          type: string
          nullable: true
        delivery_profile_id:
          type: string
          nullable: true
        submission:
          allOf:
          - "$ref": "#/components/schemas/ProductSubmission"
          nullable: true
      required:
      - id
      - name
      - slug
      - meta_title
      - meta_description
      - meta_keywords
      - variant_count
      - available_on
      - preorder_ships_at
      - purchasable
      - preorder
      - in_stock
      - backorderable
      - available
      - description
      - description_html
      - default_variant_id
      - buy_box_variant_id
      - thumbnail_url
      - tags
      - price
      - original_price
      - seller_id
      - status
      - metadata
      - created_at
      - updated_at
      - product_type_id
      - delivery_profile_id
      x-typelizer: true
    ProductSubmission:
      type: object
      properties:
        id:
          type: string
        status:
          anyOf:
          - type: string
            enum:
            - pending
            - approved
            - rejected
            - withdrawn
          - type: string
          description: The values listed are the built-in ones; extensions may add
            more.
        review_note:
          type: string
          nullable: true
        reviewed_at:
          type: string
          nullable: true
        created_at:
          type: string
        product_id:
          type: string
      required:
      - id
      - status
      - review_note
      - reviewed_at
      - created_at
      - product_id
      x-typelizer: true
    ProductType:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        option_type_labels:
          type: array
          items:
            type: string
      required:
      - id
      - name
      - option_type_labels
      x-typelizer: true
    Profile:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        slug:
          type: string
        about:
          type: string
        about_html:
          type: string
        logo_url:
          type: string
          nullable: true
        square_logo_url:
          type: string
          nullable: true
        cover_photo_url:
          type: string
          nullable: true
        custom_fields:
          type: array
          items:
            "$ref": "#/components/schemas/CustomField"
        timezone:
          anyOf:
          - type: string
            enum:
            - Africa/Algiers
            - Africa/Cairo
            - Africa/Casablanca
            - Africa/Harare
            - Africa/Johannesburg
            - Africa/Monrovia
            - Africa/Nairobi
            - America/Argentina/Buenos_Aires
            - America/Asuncion
            - America/Bogota
            - America/Caracas
            - America/Chicago
            - America/Chihuahua
            - America/Denver
            - America/Guatemala
            - America/Guyana
            - America/Halifax
            - America/Indiana/Indianapolis
            - America/Juneau
            - America/La_Paz
            - America/Lima
            - America/Los_Angeles
            - America/Mazatlan
            - America/Mexico_City
            - America/Monterrey
            - America/Montevideo
            - America/New_York
            - America/Nuuk
            - America/Phoenix
            - America/Puerto_Rico
            - America/Regina
            - America/Santiago
            - America/Sao_Paulo
            - America/St_Johns
            - America/Tijuana
            - Asia/Almaty
            - Asia/Baghdad
            - Asia/Baku
            - Asia/Bangkok
            - Asia/Chongqing
            - Asia/Colombo
            - Asia/Dhaka
            - Asia/Hong_Kong
            - Asia/Irkutsk
            - Asia/Jakarta
            - Asia/Jerusalem
            - Asia/Kabul
            - Asia/Kamchatka
            - Asia/Karachi
            - Asia/Kathmandu
            - Asia/Kolkata
            - Asia/Krasnoyarsk
            - Asia/Kuala_Lumpur
            - Asia/Kuwait
            - Asia/Magadan
            - Asia/Muscat
            - Asia/Novosibirsk
            - Asia/Riyadh
            - Asia/Seoul
            - Asia/Shanghai
            - Asia/Singapore
            - Asia/Srednekolymsk
            - Asia/Taipei
            - Asia/Tashkent
            - Asia/Tbilisi
            - Asia/Tehran
            - Asia/Tokyo
            - Asia/Ulaanbaatar
            - Asia/Urumqi
            - Asia/Vladivostok
            - Asia/Yakutsk
            - Asia/Yangon
            - Asia/Yekaterinburg
            - Asia/Yerevan
            - Atlantic/Azores
            - Atlantic/Cape_Verde
            - Atlantic/South_Georgia
            - Australia/Adelaide
            - Australia/Brisbane
            - Australia/Canberra
            - Australia/Darwin
            - Australia/Hobart
            - Australia/Melbourne
            - Australia/Perth
            - Australia/Sydney
            - Etc/GMT+12
            - Europe/Amsterdam
            - Europe/Athens
            - Europe/Belgrade
            - Europe/Berlin
            - Europe/Bratislava
            - Europe/Brussels
            - Europe/Bucharest
            - Europe/Budapest
            - Europe/Copenhagen
            - Europe/Dublin
            - Europe/Helsinki
            - Europe/Istanbul
            - Europe/Kaliningrad
            - Europe/Kyiv
            - Europe/Lisbon
            - Europe/Ljubljana
            - Europe/London
            - Europe/Madrid
            - Europe/Minsk
            - Europe/Moscow
            - Europe/Paris
            - Europe/Prague
            - Europe/Riga
            - Europe/Rome
            - Europe/Samara
            - Europe/Sarajevo
            - Europe/Skopje
            - Europe/Sofia
            - Europe/Stockholm
            - Europe/Tallinn
            - Europe/Vienna
            - Europe/Vilnius
            - Europe/Volgograd
            - Europe/Warsaw
            - Europe/Zagreb
            - Europe/Zurich
            - Pacific/Apia
            - Pacific/Auckland
            - Pacific/Chatham
            - Pacific/Fakaofo
            - Pacific/Fiji
            - Pacific/Guadalcanal
            - Pacific/Guam
            - Pacific/Honolulu
            - Pacific/Majuro
            - Pacific/Midway
            - Pacific/Noumea
            - Pacific/Pago_Pago
            - Pacific/Port_Moresby
            - Pacific/Tongatapu
            - UTC
          - type: string
            nullable: true
          description: Common IANA time zones; any other IANA time zone identifier
            is accepted too.
        status:
          anyOf:
          - type: string
            enum:
            - pending
            - invited
            - canceled
            - onboarding
            - ready_for_review
            - approved
            - rejected
            - suspended
          - type: string
          description: The values listed are the built-in ones; extensions may add
            more.
        legal_name:
          type: string
          nullable: true
        registration_number:
          type: string
          nullable: true
        contact_email:
          type: string
          nullable: true
        billing_email:
          type: string
          nullable: true
        tax_remittance:
          type: string
          enum:
          - seller
          - platform
        payouts_schedule_interval:
          type: string
          nullable: true
          enum:
          - daily
          - weekly
          - biweekly
          - monthly
          - manual
        holiday_mode_until:
          type: string
          nullable: true
        terms_accepted_at:
          type: string
          nullable: true
        created_at:
          type: string
        minimum_payout_amount:
          type: string
          nullable: true
        policies:
          type: array
          items:
            "$ref": "#/components/schemas/Policy"
        on_holiday:
          type: boolean
        sellable:
          type: boolean
        default_currency:
          type: string
          enum:
          - AED
          - AFN
          - ALL
          - AMD
          - ANG
          - AOA
          - ARS
          - AUD
          - AWG
          - AZN
          - BAM
          - BBD
          - BDT
          - BGN
          - BHD
          - BIF
          - BMD
          - BND
          - BOB
          - BRL
          - BSD
          - BTN
          - BWP
          - BYN
          - BYR
          - BZD
          - CAD
          - CDF
          - CHF
          - CLF
          - CLP
          - CNY
          - COP
          - CRC
          - CUC
          - CUP
          - CVE
          - CZK
          - DJF
          - DKK
          - DOP
          - DZD
          - EEK
          - EGP
          - ERN
          - ETB
          - EUR
          - FJD
          - FKP
          - GBP
          - GEL
          - GHS
          - GIP
          - GMD
          - GNF
          - GTQ
          - GYD
          - HKD
          - HNL
          - HRK
          - HTG
          - HUF
          - IDR
          - ILS
          - INR
          - IQD
          - IRR
          - ISK
          - JMD
          - JOD
          - JPY
          - KES
          - KGS
          - KHR
          - KMF
          - KPW
          - KRW
          - KWD
          - KYD
          - KZT
          - LAK
          - LBP
          - LKR
          - LRD
          - LSL
          - LTL
          - LVL
          - LYD
          - MAD
          - MDL
          - MGA
          - MKD
          - MMK
          - MNT
          - MOP
          - MRO
          - MRU
          - MTL
          - MUR
          - MVR
          - MWK
          - MXN
          - MYR
          - MZN
          - NAD
          - NGN
          - NIO
          - NOK
          - NPR
          - NZD
          - OMR
          - PAB
          - PEN
          - PGK
          - PHP
          - PKR
          - PLN
          - PYG
          - QAR
          - RON
          - RSD
          - RUB
          - RWF
          - SAR
          - SBD
          - SCR
          - SDG
          - SEK
          - SGD
          - SHP
          - SKK
          - SLE
          - SLL
          - SOS
          - SRD
          - SSP
          - STD
          - STN
          - SVC
          - SYP
          - SZL
          - THB
          - TJS
          - TMM
          - TMT
          - TND
          - TOP
          - TRY
          - TTD
          - TWD
          - TZS
          - UAH
          - UGX
          - USD
          - UYI
          - UYU
          - UYW
          - UZS
          - VED
          - VEF
          - VES
          - VND
          - VUV
          - WST
          - XAF
          - XCD
          - XCG
          - XOF
          - XPF
          - YER
          - ZAR
          - ZMK
          - ZMW
          - ZWD
          - ZWG
          - ZWL
          - ZWN
          - ZWR
        supported_currencies:
          type: array
          items:
            type: string
            enum:
            - AED
            - AFN
            - ALL
            - AMD
            - ANG
            - AOA
            - ARS
            - AUD
            - AWG
            - AZN
            - BAM
            - BBD
            - BDT
            - BGN
            - BHD
            - BIF
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BTN
            - BWP
            - BYN
            - BYR
            - BZD
            - CAD
            - CDF
            - CHF
            - CLF
            - CLP
            - CNY
            - COP
            - CRC
            - CUC
            - CUP
            - CVE
            - CZK
            - DJF
            - DKK
            - DOP
            - DZD
            - EEK
            - EGP
            - ERN
            - ETB
            - EUR
            - FJD
            - FKP
            - GBP
            - GEL
            - GHS
            - GIP
            - GMD
            - GNF
            - GTQ
            - GYD
            - HKD
            - HNL
            - HRK
            - HTG
            - HUF
            - IDR
            - ILS
            - INR
            - IQD
            - IRR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KGS
            - KHR
            - KMF
            - KPW
            - KRW
            - KWD
            - KYD
            - KZT
            - LAK
            - LBP
            - LKR
            - LRD
            - LSL
            - LTL
            - LVL
            - LYD
            - MAD
            - MDL
            - MGA
            - MKD
            - MMK
            - MNT
            - MOP
            - MRO
            - MRU
            - MTL
            - MUR
            - MVR
            - MWK
            - MXN
            - MYR
            - MZN
            - NAD
            - NGN
            - NIO
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - PYG
            - QAR
            - RON
            - RSD
            - RUB
            - RWF
            - SAR
            - SBD
            - SCR
            - SDG
            - SEK
            - SGD
            - SHP
            - SKK
            - SLE
            - SLL
            - SOS
            - SRD
            - SSP
            - STD
            - STN
            - SVC
            - SYP
            - SZL
            - THB
            - TJS
            - TMM
            - TMT
            - TND
            - TOP
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - UGX
            - USD
            - UYI
            - UYU
            - UYW
            - UZS
            - VED
            - VEF
            - VES
            - VND
            - VUV
            - WST
            - XAF
            - XCD
            - XCG
            - XOF
            - XPF
            - YER
            - ZAR
            - ZMK
            - ZMW
            - ZWD
            - ZWG
            - ZWL
            - ZWN
            - ZWR
        products_count:
          type: number
        billing_address:
          "$ref": "#/components/schemas/Address"
        returns_address:
          "$ref": "#/components/schemas/Address"
      required:
      - id
      - name
      - slug
      - about
      - about_html
      - logo_url
      - square_logo_url
      - cover_photo_url
      - timezone
      - status
      - legal_name
      - registration_number
      - contact_email
      - billing_email
      - tax_remittance
      - payouts_schedule_interval
      - holiday_mode_until
      - terms_accepted_at
      - created_at
      - minimum_payout_amount
      - on_holiday
      - sellable
      - default_currency
      - supported_currencies
      - products_count
      x-typelizer: true
    Reason:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        active:
          type: boolean
      required:
      - id
      - name
      - active
      x-typelizer: true
    RequirementCustomField:
      type: object
      properties:
        id:
          type: string
        key:
          type: string
        label:
          type: string
        field_type:
          type: string
          enum:
          - short_text
          - long_text
          - rich_text
          - number
          - boolean
          - json
        value: {}
      required:
      - id
      - key
      - label
      - field_type
      - value
      x-typelizer: true
    RequirementStatus:
      type: object
      properties:
        id:
          type: string
        kind:
          type: string
          description: 'Requirement kind. Built-in: accept_terms, complete_profile,
            billing_address, returns_address, delivery_method, package_type, minimum_products,
            payout_account, required_custom_fields, policy, attestation, operator_review,
            document. Extensions may register more.'
        name:
          type: string
        description:
          type: string
          nullable: true
        required:
          type: boolean
        position:
          type: number
        status:
          type: string
          enum:
          - complete
          - incomplete
          - pending
          - rejected
        action_url:
          type: string
          nullable: true
        blocker:
          type: object
          nullable: true
        blocking:
          type: boolean
        accepts_submissions:
          type: boolean
        requires_file:
          type: boolean
        accepted_content_types:
          type: array
          items:
            type: string
        required_policy_name:
          type: string
          nullable: true
        terms_html:
          type: string
          nullable: true
        submission:
          "$ref": "#/components/schemas/RequirementSubmission"
        custom_fields:
          type: array
          items:
            "$ref": "#/components/schemas/RequirementCustomField"
      required:
      - id
      - kind
      - name
      - description
      - required
      - position
      - status
      - action_url
      - blocker
      - blocking
      - accepts_submissions
      - requires_file
      - accepted_content_types
      - required_policy_name
      - terms_html
      x-typelizer: true
    RequirementSubmission:
      type: object
      properties:
        id:
          type: string
        status:
          anyOf:
          - type: string
            enum:
            - pending
            - accepted
            - rejected
            - waived
          - type: string
          description: The values listed are the built-in ones; extensions may add
            more.
        note:
          type: string
          nullable: true
        review_note:
          type: string
          nullable: true
        reference:
          type: string
          nullable: true
        reviewed_at:
          type: string
          nullable: true
        created_at:
          type: string
        updated_at:
          type: string
        file_url:
          type: string
          nullable: true
        file_name:
          type: string
          nullable: true
      required:
      - id
      - status
      - note
      - review_note
      - reference
      - reviewed_at
      - created_at
      - updated_at
      - file_url
      - file_name
      x-typelizer: true
    ReturnLineItem:
      type: object
      properties:
        id:
          type: string
        quantity:
          type: number
        received_quantity:
          type: number
        resellable:
          type: boolean
        pre_tax_amount:
          type: string
        included_tax_total:
          type: string
        additional_tax_total:
          type: string
        tax_total:
          type: string
        refund_amount:
          type: string
        variant_id:
          type: string
          nullable: true
        line_item_id:
          type: string
          nullable: true
        fulfillment_item_id:
          type: string
          nullable: true
        variant:
          "$ref": "#/components/schemas/Variant"
        name:
          type: string
          nullable: true
      required:
      - id
      - quantity
      - received_quantity
      - resellable
      - pre_tax_amount
      - included_tax_total
      - additional_tax_total
      - tax_total
      - refund_amount
      - variant_id
      - line_item_id
      - fulfillment_item_id
      - name
      x-typelizer: true
    Return:
      type: object
      properties:
        id:
          type: string
        number:
          type: string
        status:
          anyOf:
          - type: string
            enum:
            - requested
            - approved
            - received
            - refunded
            - canceled
          - type: string
          description: The values listed are the built-in ones; extensions may add
            more.
        order_id:
          type: string
          nullable: true
        reason_id:
          type: string
          nullable: true
        refund_total:
          type: string
        refund_tax_total:
          type: string
        approved_at:
          type: string
          nullable: true
        received_at:
          type: string
          nullable: true
        refunded_at:
          type: string
          nullable: true
        canceled_at:
          type: string
          nullable: true
        reason:
          "$ref": "#/components/schemas/Reason"
        return_line_items:
          type: array
          items:
            "$ref": "#/components/schemas/ReturnLineItem"
        custom_fields:
          type: array
          items:
            "$ref": "#/components/schemas/CustomField"
        memo:
          type: string
          nullable: true
        stock_location_id:
          type: string
          nullable: true
        refunded_total:
          type: string
        refundable_total:
          type: string
      required:
      - id
      - number
      - status
      - order_id
      - reason_id
      - refund_total
      - refund_tax_total
      - approved_at
      - received_at
      - refunded_at
      - canceled_at
      - memo
      - stock_location_id
      - refunded_total
      - refundable_total
      x-typelizer: true
    ShippingLabel:
      type: object
      properties:
        id:
          type: string
        source:
          type: string
          enum:
          - purchased
          - uploaded
        status:
          anyOf:
          - type: string
            enum:
            - purchased
            - refund_requested
            - refunded
          - type: string
          description: The values listed are the built-in ones; extensions may add
            more.
        carrier:
          type: string
          nullable: true
        carrier_name:
          type: string
          nullable: true
        service:
          type: string
          nullable: true
        tracking_number:
          type: string
          nullable: true
        currency:
          type: string
          nullable: true
          enum:
          - AED
          - AFN
          - ALL
          - AMD
          - ANG
          - AOA
          - ARS
          - AUD
          - AWG
          - AZN
          - BAM
          - BBD
          - BDT
          - BGN
          - BHD
          - BIF
          - BMD
          - BND
          - BOB
          - BRL
          - BSD
          - BTN
          - BWP
          - BYN
          - BYR
          - BZD
          - CAD
          - CDF
          - CHF
          - CLF
          - CLP
          - CNY
          - COP
          - CRC
          - CUC
          - CUP
          - CVE
          - CZK
          - DJF
          - DKK
          - DOP
          - DZD
          - EEK
          - EGP
          - ERN
          - ETB
          - EUR
          - FJD
          - FKP
          - GBP
          - GEL
          - GHS
          - GIP
          - GMD
          - GNF
          - GTQ
          - GYD
          - HKD
          - HNL
          - HRK
          - HTG
          - HUF
          - IDR
          - ILS
          - INR
          - IQD
          - IRR
          - ISK
          - JMD
          - JOD
          - JPY
          - KES
          - KGS
          - KHR
          - KMF
          - KPW
          - KRW
          - KWD
          - KYD
          - KZT
          - LAK
          - LBP
          - LKR
          - LRD
          - LSL
          - LTL
          - LVL
          - LYD
          - MAD
          - MDL
          - MGA
          - MKD
          - MMK
          - MNT
          - MOP
          - MRO
          - MRU
          - MTL
          - MUR
          - MVR
          - MWK
          - MXN
          - MYR
          - MZN
          - NAD
          - NGN
          - NIO
          - NOK
          - NPR
          - NZD
          - OMR
          - PAB
          - PEN
          - PGK
          - PHP
          - PKR
          - PLN
          - PYG
          - QAR
          - RON
          - RSD
          - RUB
          - RWF
          - SAR
          - SBD
          - SCR
          - SDG
          - SEK
          - SGD
          - SHP
          - SKK
          - SLE
          - SLL
          - SOS
          - SRD
          - SSP
          - STD
          - STN
          - SVC
          - SYP
          - SZL
          - THB
          - TJS
          - TMM
          - TMT
          - TND
          - TOP
          - TRY
          - TTD
          - TWD
          - TZS
          - UAH
          - UGX
          - USD
          - UYI
          - UYU
          - UYW
          - UZS
          - VED
          - VEF
          - VES
          - VND
          - VUV
          - WST
          - XAF
          - XCD
          - XCG
          - XOF
          - XPF
          - YER
          - ZAR
          - ZMK
          - ZMW
          - ZWD
          - ZWG
          - ZWL
          - ZWN
          - ZWR
        format:
          type: string
          nullable: true
          enum:
          - pdf
          - png
          - zpl
        external_id:
          type: string
          nullable: true
        metadata:
          type: object
        refunded_at:
          type: string
          nullable: true
        created_at:
          type: string
        updated_at:
          type: string
        owner_id:
          type: string
        owner_type:
          type: string
          enum:
          - fulfillment
          - return
        cost:
          type: string
        integration_id:
          type: string
          nullable: true
        file_pending:
          type: boolean
        download_url:
          type: string
          nullable: true
      required:
      - id
      - source
      - status
      - carrier
      - carrier_name
      - service
      - tracking_number
      - currency
      - format
      - external_id
      - metadata
      - refunded_at
      - created_at
      - updated_at
      - owner_id
      - owner_type
      - cost
      - integration_id
      - file_pending
      - download_url
      x-typelizer: true
    State:
      type: object
      properties:
        abbr:
          type: string
        name:
          type: string
      required:
      - abbr
      - name
      x-typelizer: true
    StockLevel:
      type: object
      properties:
        id:
          type: string
        count_on_hand:
          type: number
        backorderable:
          type: boolean
        stock_location_id:
          type: string
          nullable: true
        variant_id:
          type: string
          nullable: true
        created_at:
          type: string
        updated_at:
          type: string
        allocated_count:
          type: number
        available_count:
          type: number
        stock_location:
          "$ref": "#/components/schemas/StockLocation"
      required:
      - id
      - count_on_hand
      - backorderable
      - stock_location_id
      - variant_id
      - created_at
      - updated_at
      - allocated_count
      - available_count
      x-typelizer: true
    StockLocation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        address1:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        zipcode:
          type: string
          nullable: true
        country_code:
          type: string
          nullable: true
          enum:
          - AD
          - AE
          - AF
          - AG
          - AI
          - AL
          - AM
          - AO
          - AR
          - AS
          - AT
          - AU
          - AW
          - AZ
          - BA
          - BB
          - BD
          - BE
          - BF
          - BG
          - BH
          - BI
          - BJ
          - BL
          - BM
          - BN
          - BO
          - BQ
          - BR
          - BS
          - BT
          - BW
          - BY
          - BZ
          - CA
          - CC
          - CD
          - CF
          - CG
          - CH
          - CI
          - CK
          - CL
          - CM
          - CN
          - CO
          - CR
          - CU
          - CV
          - CW
          - CX
          - CY
          - CZ
          - DE
          - DJ
          - DK
          - DM
          - DO
          - DZ
          - EC
          - EE
          - EG
          - ER
          - ES
          - ET
          - FI
          - FJ
          - FK
          - FM
          - FO
          - FR
          - GA
          - GB
          - GD
          - GE
          - GF
          - GG
          - GH
          - GI
          - GL
          - GM
          - GN
          - GP
          - GQ
          - GR
          - GT
          - GU
          - GW
          - GY
          - HK
          - HN
          - HR
          - HT
          - HU
          - ID
          - IE
          - IL
          - IM
          - IN
          - IQ
          - IR
          - IS
          - IT
          - JE
          - JM
          - JO
          - JP
          - KE
          - KG
          - KH
          - KI
          - KM
          - KN
          - KP
          - KR
          - KW
          - KY
          - KZ
          - LA
          - LB
          - LC
          - LI
          - LK
          - LR
          - LS
          - LT
          - LU
          - LV
          - LY
          - MA
          - MC
          - MD
          - ME
          - MF
          - MG
          - MH
          - MK
          - ML
          - MM
          - MN
          - MO
          - MP
          - MQ
          - MR
          - MS
          - MT
          - MU
          - MV
          - MW
          - MX
          - MY
          - MZ
          - NA
          - NC
          - NE
          - NF
          - NG
          - NI
          - NL
          - 'NO'
          - NP
          - NR
          - NU
          - NZ
          - OM
          - PA
          - PE
          - PF
          - PG
          - PH
          - PK
          - PL
          - PM
          - PN
          - PR
          - PS
          - PT
          - PW
          - PY
          - QA
          - RE
          - RO
          - RS
          - RU
          - RW
          - SA
          - SB
          - SC
          - SD
          - SE
          - SG
          - SH
          - SI
          - SJ
          - SK
          - SL
          - SM
          - SN
          - SO
          - SR
          - SS
          - ST
          - SV
          - SX
          - SY
          - SZ
          - TC
          - TD
          - TG
          - TH
          - TJ
          - TK
          - TL
          - TM
          - TN
          - TO
          - TR
          - TT
          - TV
          - TW
          - TZ
          - UA
          - UG
          - US
          - UY
          - UZ
          - VA
          - VC
          - VE
          - VG
          - VI
          - VN
          - VU
          - WF
          - WS
          - YE
          - YT
          - ZA
          - ZM
          - ZW
        country_name:
          type: string
          nullable: true
        state_code:
          type: string
          nullable: true
        state_text:
          type: string
          nullable: true
        pickup_ready_in_minutes:
          type: number
          nullable: true
        pickup_instructions:
          type: string
          nullable: true
        address2:
          type: string
          nullable: true
        state_name:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
        company:
          type: string
          nullable: true
        active:
          type: boolean
        default:
          type: boolean
        kind:
          anyOf:
          - type: string
            enum:
            - warehouse
            - store
            - fulfillment_center
          - type: string
          description: The values listed are the built-in ones; extensions may add
            more.
        returns_enabled:
          type: boolean
        created_at:
          type: string
        updated_at:
          type: string
      required:
      - id
      - name
      - address1
      - city
      - zipcode
      - country_code
      - country_name
      - state_code
      - state_text
      - pickup_ready_in_minutes
      - pickup_instructions
      - address2
      - state_name
      - phone
      - company
      - active
      - default
      - kind
      - returns_enabled
      - created_at
      - updated_at
      x-typelizer: true
    Store:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        seller_digital_assets_enabled:
          type: boolean
        seller_digital_asset_content_types:
          type: array
          items:
            type: string
        review_seller_digital_asset_changes:
          type: boolean
      required:
      - id
      - name
      - seller_digital_assets_enabled
      - seller_digital_asset_content_types
      - review_seller_digital_asset_changes
      x-typelizer: true
    TaxIdentifier:
      type: object
      properties:
        id:
          type: string
        kind:
          type: string
          description: 'Tax identifier kind, keyed to a registered validator. Built-in:
            eu_vat. Extensions may register more.'
        value:
          type: string
        validation_status:
          type: string
          nullable: true
          enum:
          - pending
          - verified
          - unverified
          - unavailable
          - unsupported
        validated_at:
          type: string
          nullable: true
      required:
      - id
      - kind
      - value
      - validation_status
      - validated_at
      x-typelizer: true
    TeamMember:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
        first_name:
          type: string
          nullable: true
        last_name:
          type: string
          nullable: true
        full_name:
          type: string
          nullable: true
        created_at:
          type: string
        avatar_url:
          type: string
          nullable: true
      required:
      - id
      - email
      - first_name
      - last_name
      - full_name
      - created_at
      - avatar_url
      x-typelizer: true
    Transfer:
      type: object
      properties:
        id:
          type: string
        kind:
          type: string
        status:
          type: string
        currency:
          type: string
          enum:
          - AED
          - AFN
          - ALL
          - AMD
          - ANG
          - AOA
          - ARS
          - AUD
          - AWG
          - AZN
          - BAM
          - BBD
          - BDT
          - BGN
          - BHD
          - BIF
          - BMD
          - BND
          - BOB
          - BRL
          - BSD
          - BTN
          - BWP
          - BYN
          - BYR
          - BZD
          - CAD
          - CDF
          - CHF
          - CLF
          - CLP
          - CNY
          - COP
          - CRC
          - CUC
          - CUP
          - CVE
          - CZK
          - DJF
          - DKK
          - DOP
          - DZD
          - EEK
          - EGP
          - ERN
          - ETB
          - EUR
          - FJD
          - FKP
          - GBP
          - GEL
          - GHS
          - GIP
          - GMD
          - GNF
          - GTQ
          - GYD
          - HKD
          - HNL
          - HRK
          - HTG
          - HUF
          - IDR
          - ILS
          - INR
          - IQD
          - IRR
          - ISK
          - JMD
          - JOD
          - JPY
          - KES
          - KGS
          - KHR
          - KMF
          - KPW
          - KRW
          - KWD
          - KYD
          - KZT
          - LAK
          - LBP
          - LKR
          - LRD
          - LSL
          - LTL
          - LVL
          - LYD
          - MAD
          - MDL
          - MGA
          - MKD
          - MMK
          - MNT
          - MOP
          - MRO
          - MRU
          - MTL
          - MUR
          - MVR
          - MWK
          - MXN
          - MYR
          - MZN
          - NAD
          - NGN
          - NIO
          - NOK
          - NPR
          - NZD
          - OMR
          - PAB
          - PEN
          - PGK
          - PHP
          - PKR
          - PLN
          - PYG
          - QAR
          - RON
          - RSD
          - RUB
          - RWF
          - SAR
          - SBD
          - SCR
          - SDG
          - SEK
          - SGD
          - SHP
          - SKK
          - SLE
          - SLL
          - SOS
          - SRD
          - SSP
          - STD
          - STN
          - SVC
          - SYP
          - SZL
          - THB
          - TJS
          - TMM
          - TMT
          - TND
          - TOP
          - TRY
          - TTD
          - TWD
          - TZS
          - UAH
          - UGX
          - USD
          - UYI
          - UYU
          - UYW
          - UZS
          - VED
          - VEF
          - VES
          - VND
          - VUV
          - WST
          - XAF
          - XCD
          - XCG
          - XOF
          - XPF
          - YER
          - ZAR
          - ZMK
          - ZMW
          - ZWD
          - ZWG
          - ZWL
          - ZWN
          - ZWR
        reference:
          type: string
          nullable: true
        created_at:
          type: string
        updated_at:
          type: string
        amount:
          type: string
        settled_amount:
          type: string
          nullable: true
        settled_currency:
          type: string
          nullable: true
          enum:
          - AED
          - AFN
          - ALL
          - AMD
          - ANG
          - AOA
          - ARS
          - AUD
          - AWG
          - AZN
          - BAM
          - BBD
          - BDT
          - BGN
          - BHD
          - BIF
          - BMD
          - BND
          - BOB
          - BRL
          - BSD
          - BTN
          - BWP
          - BYN
          - BYR
          - BZD
          - CAD
          - CDF
          - CHF
          - CLF
          - CLP
          - CNY
          - COP
          - CRC
          - CUC
          - CUP
          - CVE
          - CZK
          - DJF
          - DKK
          - DOP
          - DZD
          - EEK
          - EGP
          - ERN
          - ETB
          - EUR
          - FJD
          - FKP
          - GBP
          - GEL
          - GHS
          - GIP
          - GMD
          - GNF
          - GTQ
          - GYD
          - HKD
          - HNL
          - HRK
          - HTG
          - HUF
          - IDR
          - ILS
          - INR
          - IQD
          - IRR
          - ISK
          - JMD
          - JOD
          - JPY
          - KES
          - KGS
          - KHR
          - KMF
          - KPW
          - KRW
          - KWD
          - KYD
          - KZT
          - LAK
          - LBP
          - LKR
          - LRD
          - LSL
          - LTL
          - LVL
          - LYD
          - MAD
          - MDL
          - MGA
          - MKD
          - MMK
          - MNT
          - MOP
          - MRO
          - MRU
          - MTL
          - MUR
          - MVR
          - MWK
          - MXN
          - MYR
          - MZN
          - NAD
          - NGN
          - NIO
          - NOK
          - NPR
          - NZD
          - OMR
          - PAB
          - PEN
          - PGK
          - PHP
          - PKR
          - PLN
          - PYG
          - QAR
          - RON
          - RSD
          - RUB
          - RWF
          - SAR
          - SBD
          - SCR
          - SDG
          - SEK
          - SGD
          - SHP
          - SKK
          - SLE
          - SLL
          - SOS
          - SRD
          - SSP
          - STD
          - STN
          - SVC
          - SYP
          - SZL
          - THB
          - TJS
          - TMM
          - TMT
          - TND
          - TOP
          - TRY
          - TTD
          - TWD
          - TZS
          - UAH
          - UGX
          - USD
          - UYI
          - UYU
          - UYW
          - UZS
          - VED
          - VEF
          - VES
          - VND
          - VUV
          - WST
          - XAF
          - XCD
          - XCG
          - XOF
          - XPF
          - YER
          - ZAR
          - ZMK
          - ZMW
          - ZWD
          - ZWG
          - ZWL
          - ZWN
          - ZWR
        converted:
          type: boolean
        order_id:
          type: string
          nullable: true
        payout_id:
          type: string
          nullable: true
        reversed_from_id:
          type: string
          nullable: true
        order_number:
          type: string
          nullable: true
        provider:
          type: string
          description: 'Payout provider. Built-in: system. Provider gems register
            more (e.g. stripe).'
      required:
      - id
      - kind
      - status
      - currency
      - reference
      - created_at
      - updated_at
      - amount
      - settled_amount
      - settled_currency
      - converted
      - order_id
      - payout_id
      - reversed_from_id
      - order_number
      - provider
      x-typelizer: true
    Variant:
      type: object
      properties:
        id:
          type: string
        product_id:
          type: string
        sku:
          type: string
          nullable: true
        options_text:
          type: string
        track_inventory:
          type: boolean
        media_count:
          type: number
        preorder_ships_at:
          type: string
          nullable: true
        thumbnail_url:
          type: string
          nullable: true
        purchasable:
          type: boolean
        in_stock:
          type: boolean
        backorderable:
          type: boolean
        preorder:
          type: boolean
        weight:
          type: number
          nullable: true
        height:
          type: number
          nullable: true
        width:
          type: number
          nullable: true
        depth:
          type: number
          nullable: true
        weight_unit:
          type: string
          enum:
          - g
          - kg
          - lb
          - oz
        dimensions_unit:
          type: string
          enum:
          - mm
          - cm
          - in
          - ft
        minimum_order_quantity:
          type: number
          nullable: true
        order_multiple:
          type: number
          nullable: true
        purchase_unit:
          type: string
          nullable: true
          enum:
          - unit
          - carton
        units_per_carton:
          type: number
          nullable: true
        price:
          "$ref": "#/components/schemas/Price"
        original_price:
          allOf:
          - "$ref": "#/components/schemas/Price"
          nullable: true
        seller_id:
          type: string
          nullable: true
        seller:
          "$ref": "#/components/schemas/Seller"
        primary_media:
          "$ref": "#/components/schemas/Media"
        media:
          type: array
          items:
            "$ref": "#/components/schemas/Media"
        option_values:
          type: array
          items:
            "$ref": "#/components/schemas/OptionValue"
        custom_fields:
          type: array
          items:
            "$ref": "#/components/schemas/CustomField"
        prior_price:
          allOf:
          - "$ref": "#/components/schemas/PriceHistory"
          nullable: true
        metadata:
          type: object
        position:
          type: number
        cost_currency:
          type: string
          nullable: true
          enum:
          - AED
          - AFN
          - ALL
          - AMD
          - ANG
          - AOA
          - ARS
          - AUD
          - AWG
          - AZN
          - BAM
          - BBD
          - BDT
          - BGN
          - BHD
          - BIF
          - BMD
          - BND
          - BOB
          - BRL
          - BSD
          - BTN
          - BWP
          - BYN
          - BYR
          - BZD
          - CAD
          - CDF
          - CHF
          - CLF
          - CLP
          - CNY
          - COP
          - CRC
          - CUC
          - CUP
          - CVE
          - CZK
          - DJF
          - DKK
          - DOP
          - DZD
          - EEK
          - EGP
          - ERN
          - ETB
          - EUR
          - FJD
          - FKP
          - GBP
          - GEL
          - GHS
          - GIP
          - GMD
          - GNF
          - GTQ
          - GYD
          - HKD
          - HNL
          - HRK
          - HTG
          - HUF
          - IDR
          - ILS
          - INR
          - IQD
          - IRR
          - ISK
          - JMD
          - JOD
          - JPY
          - KES
          - KGS
          - KHR
          - KMF
          - KPW
          - KRW
          - KWD
          - KYD
          - KZT
          - LAK
          - LBP
          - LKR
          - LRD
          - LSL
          - LTL
          - LVL
          - LYD
          - MAD
          - MDL
          - MGA
          - MKD
          - MMK
          - MNT
          - MOP
          - MRO
          - MRU
          - MTL
          - MUR
          - MVR
          - MWK
          - MXN
          - MYR
          - MZN
          - NAD
          - NGN
          - NIO
          - NOK
          - NPR
          - NZD
          - OMR
          - PAB
          - PEN
          - PGK
          - PHP
          - PKR
          - PLN
          - PYG
          - QAR
          - RON
          - RSD
          - RUB
          - RWF
          - SAR
          - SBD
          - SCR
          - SDG
          - SEK
          - SGD
          - SHP
          - SKK
          - SLE
          - SLL
          - SOS
          - SRD
          - SSP
          - STD
          - STN
          - SVC
          - SYP
          - SZL
          - THB
          - TJS
          - TMM
          - TMT
          - TND
          - TOP
          - TRY
          - TTD
          - TWD
          - TZS
          - UAH
          - UGX
          - USD
          - UYI
          - UYU
          - UYW
          - UZS
          - VED
          - VEF
          - VES
          - VND
          - VUV
          - WST
          - XAF
          - XCD
          - XCG
          - XOF
          - XPF
          - YER
          - ZAR
          - ZMK
          - ZMW
          - ZWD
          - ZWG
          - ZWL
          - ZWN
          - ZWR
        barcode:
          type: string
          nullable: true
        backorder_limit:
          type: number
          nullable: true
        hs_code:
          type: string
          nullable: true
        country_of_origin:
          type: string
          nullable: true
          enum:
          - AD
          - AE
          - AF
          - AG
          - AI
          - AL
          - AM
          - AO
          - AR
          - AS
          - AT
          - AU
          - AW
          - AZ
          - BA
          - BB
          - BD
          - BE
          - BF
          - BG
          - BH
          - BI
          - BJ
          - BL
          - BM
          - BN
          - BO
          - BQ
          - BR
          - BS
          - BT
          - BW
          - BY
          - BZ
          - CA
          - CC
          - CD
          - CF
          - CG
          - CH
          - CI
          - CK
          - CL
          - CM
          - CN
          - CO
          - CR
          - CU
          - CV
          - CW
          - CX
          - CY
          - CZ
          - DE
          - DJ
          - DK
          - DM
          - DO
          - DZ
          - EC
          - EE
          - EG
          - ER
          - ES
          - ET
          - FI
          - FJ
          - FK
          - FM
          - FO
          - FR
          - GA
          - GB
          - GD
          - GE
          - GF
          - GG
          - GH
          - GI
          - GL
          - GM
          - GN
          - GP
          - GQ
          - GR
          - GT
          - GU
          - GW
          - GY
          - HK
          - HN
          - HR
          - HT
          - HU
          - ID
          - IE
          - IL
          - IM
          - IN
          - IQ
          - IR
          - IS
          - IT
          - JE
          - JM
          - JO
          - JP
          - KE
          - KG
          - KH
          - KI
          - KM
          - KN
          - KP
          - KR
          - KW
          - KY
          - KZ
          - LA
          - LB
          - LC
          - LI
          - LK
          - LR
          - LS
          - LT
          - LU
          - LV
          - LY
          - MA
          - MC
          - MD
          - ME
          - MF
          - MG
          - MH
          - MK
          - ML
          - MM
          - MN
          - MO
          - MP
          - MQ
          - MR
          - MS
          - MT
          - MU
          - MV
          - MW
          - MX
          - MY
          - MZ
          - NA
          - NC
          - NE
          - NF
          - NG
          - NI
          - NL
          - 'NO'
          - NP
          - NR
          - NU
          - NZ
          - OM
          - PA
          - PE
          - PF
          - PG
          - PH
          - PK
          - PL
          - PM
          - PN
          - PR
          - PS
          - PT
          - PW
          - PY
          - QA
          - RE
          - RO
          - RS
          - RU
          - RW
          - SA
          - SB
          - SC
          - SD
          - SE
          - SG
          - SH
          - SI
          - SJ
          - SK
          - SL
          - SM
          - SN
          - SO
          - SR
          - SS
          - ST
          - SV
          - SX
          - SY
          - SZ
          - TC
          - TD
          - TG
          - TH
          - TJ
          - TK
          - TL
          - TM
          - TN
          - TO
          - TR
          - TT
          - TV
          - TW
          - TZ
          - UA
          - UG
          - US
          - UY
          - UZ
          - VA
          - VC
          - VE
          - VG
          - VI
          - VN
          - VU
          - WF
          - WS
          - YE
          - YT
          - ZA
          - ZM
          - ZW
        customs_description:
          type: string
          nullable: true
        created_at:
          type: string
        updated_at:
          type: string
        cost_price:
          type: string
          nullable: true
        preorderable:
          type: boolean
        available_stock:
          type: number
          nullable: true
        total_on_hand:
          type: number
          nullable: true
        prices:
          type: array
          items:
            "$ref": "#/components/schemas/Price"
        stock_levels:
          type: array
          items:
            "$ref": "#/components/schemas/StockLevel"
      required:
      - id
      - product_id
      - sku
      - options_text
      - track_inventory
      - media_count
      - preorder_ships_at
      - thumbnail_url
      - purchasable
      - in_stock
      - backorderable
      - preorder
      - weight
      - height
      - width
      - depth
      - weight_unit
      - dimensions_unit
      - minimum_order_quantity
      - order_multiple
      - purchase_unit
      - units_per_carton
      - price
      - original_price
      - seller_id
      - option_values
      - metadata
      - position
      - cost_currency
      - barcode
      - backorder_limit
      - hs_code
      - country_of_origin
      - customs_description
      - created_at
      - updated_at
      - cost_price
      - preorderable
      - available_stock
      - total_on_hand
      x-typelizer: true
    Seller:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        slug:
          type: string
        about:
          type: string
        about_html:
          type: string
        logo_url:
          type: string
          nullable: true
        square_logo_url:
          type: string
          nullable: true
        cover_photo_url:
          type: string
          nullable: true
        policies:
          type: array
          items:
            "$ref": "#/components/schemas/Policy"
        custom_fields:
          type: array
          items:
            "$ref": "#/components/schemas/CustomField"
      required:
      - id
      - name
      - slug
      - about
      - about_html
      - logo_url
      - square_logo_url
      - cover_photo_url
      x-typelizer: true
    DeliveryCalculatorDigitalDeliveryPreferences:
      type: object
      properties:
        amounts:
          type: object
          additionalProperties:
            type: string
            format: money
            pattern: "^-?\\d+(\\.\\d+)?$"
          default: {}
          x-spree-property-names:
            type: string
            format: currency
            pattern: "^[A-Z]{3}$"
        amount:
          type: string
          format: money
          pattern: "^-?\\d+(\\.\\d+)?$"
          default: '0'
          nullable: true
        currency:
          type: string
          format: currency
          pattern: "^[A-Z]{3}$"
      additionalProperties: false
    DeliveryCalculatorFlatPercentItemTotalPreferences:
      type: object
      properties:
        flat_percent:
          type: string
          pattern: "^-?\\d+(\\.\\d+)?$"
          default: '0'
      additionalProperties: false
    DeliveryCalculatorFlatRatePreferences:
      type: object
      properties:
        amounts:
          type: object
          additionalProperties:
            type: string
            format: money
            pattern: "^-?\\d+(\\.\\d+)?$"
          default: {}
          x-spree-property-names:
            type: string
            format: currency
            pattern: "^[A-Z]{3}$"
        amount:
          type: string
          format: money
          pattern: "^-?\\d+(\\.\\d+)?$"
          default: '0'
          nullable: true
        currency:
          type: string
          format: currency
          pattern: "^[A-Z]{3}$"
      additionalProperties: false
    DeliveryCalculatorFlexiRatePreferences:
      type: object
      properties:
        first_item:
          type: string
          format: money
          pattern: "^-?\\d+(\\.\\d+)?$"
          default: '0'
        additional_item:
          type: string
          format: money
          pattern: "^-?\\d+(\\.\\d+)?$"
          default: '0'
        max_items:
          type: integer
          default: 0
        currency:
          type: string
          format: currency
          pattern: "^[A-Z]{3}$"
      additionalProperties: false
    DeliveryCalculatorPerItemPreferences:
      type: object
      properties:
        amounts:
          type: object
          additionalProperties:
            type: string
            format: money
            pattern: "^-?\\d+(\\.\\d+)?$"
          default: {}
          x-spree-property-names:
            type: string
            format: currency
            pattern: "^[A-Z]{3}$"
        amount:
          type: string
          format: money
          pattern: "^-?\\d+(\\.\\d+)?$"
          default: '0'
          nullable: true
        currency:
          type: string
          format: currency
          pattern: "^[A-Z]{3}$"
      additionalProperties: false
    DeliveryCalculatorPriceSackPreferences:
      type: object
      properties:
        minimal_amount:
          type: string
          format: money
          pattern: "^-?\\d+(\\.\\d+)?$"
          default: '0'
        normal_amount:
          type: string
          format: money
          pattern: "^-?\\d+(\\.\\d+)?$"
          default: '0'
        discount_amount:
          type: string
          format: money
          pattern: "^-?\\d+(\\.\\d+)?$"
          default: '0'
        currency:
          type: string
          format: currency
          pattern: "^[A-Z]{3}$"
      additionalProperties: false
    DeliveryCalculatorPreferences:
      description: Settings of a delivery calculator, shaped by its `type` (see `x-spree-preferences-by-type`).
        A type an extension registers is a plain object, described by the `schema`
        its `/types` entry carries.
      anyOf:
      - "$ref": "#/components/schemas/DeliveryCalculatorDigitalDeliveryPreferences"
      - "$ref": "#/components/schemas/DeliveryCalculatorFlatPercentItemTotalPreferences"
      - "$ref": "#/components/schemas/DeliveryCalculatorFlatRatePreferences"
      - "$ref": "#/components/schemas/DeliveryCalculatorFlexiRatePreferences"
      - "$ref": "#/components/schemas/DeliveryCalculatorPerItemPreferences"
      - "$ref": "#/components/schemas/DeliveryCalculatorPriceSackPreferences"
      - type: object
        additionalProperties: true
      x-spree-preferences-by-type:
        digital_delivery: "#/components/schemas/DeliveryCalculatorDigitalDeliveryPreferences"
        flat_percent_item_total: "#/components/schemas/DeliveryCalculatorFlatPercentItemTotalPreferences"
        flat_rate: "#/components/schemas/DeliveryCalculatorFlatRatePreferences"
        flexi_rate: "#/components/schemas/DeliveryCalculatorFlexiRatePreferences"
        per_item: "#/components/schemas/DeliveryCalculatorPerItemPreferences"
        price_sack: "#/components/schemas/DeliveryCalculatorPriceSackPreferences"
    DeliveryMethodRuleChannelRulePreferences:
      type: object
      properties:
        channel_ids:
          type: array
          items:
            type: string
            format: prefixed-id
            pattern: "^ch_[A-Za-z0-9]+$"
            x-spree-prefix: ch
          default: []
      additionalProperties: false
    DeliveryMethodRuleCompanyRulePreferences:
      type: object
      properties:
        company_orders_only:
          type: boolean
          default: true
      additionalProperties: false
    DeliveryMethodRuleExcludedProductsRulePreferences:
      type: object
      properties: {}
      additionalProperties: false
    DeliveryMethodRuleItemTotalRulePreferences:
      type: object
      properties:
        minimum_amount:
          type: string
          format: money
          pattern: "^-?\\d+(\\.\\d+)?$"
          nullable: true
        maximum_amount:
          type: string
          format: money
          pattern: "^-?\\d+(\\.\\d+)?$"
          nullable: true
      additionalProperties: false
    DeliveryMethodRuleVolumeRulePreferences:
      type: object
      properties:
        minimum_volume:
          type: string
          pattern: "^-?\\d+(\\.\\d+)?$"
          nullable: true
        maximum_volume:
          type: string
          pattern: "^-?\\d+(\\.\\d+)?$"
          nullable: true
      additionalProperties: false
    DeliveryMethodRuleWeightRulePreferences:
      type: object
      properties:
        minimum_weight:
          type: string
          pattern: "^-?\\d+(\\.\\d+)?$"
          nullable: true
        maximum_weight:
          type: string
          pattern: "^-?\\d+(\\.\\d+)?$"
          nullable: true
      additionalProperties: false
    DeliveryMethodRulePreferences:
      description: Settings of a delivery method rule, shaped by its `type` (see `x-spree-preferences-by-type`).
        A type an extension registers is a plain object, described by the `schema`
        its `/types` entry carries.
      anyOf:
      - "$ref": "#/components/schemas/DeliveryMethodRuleChannelRulePreferences"
      - "$ref": "#/components/schemas/DeliveryMethodRuleCompanyRulePreferences"
      - "$ref": "#/components/schemas/DeliveryMethodRuleExcludedProductsRulePreferences"
      - "$ref": "#/components/schemas/DeliveryMethodRuleItemTotalRulePreferences"
      - "$ref": "#/components/schemas/DeliveryMethodRuleVolumeRulePreferences"
      - "$ref": "#/components/schemas/DeliveryMethodRuleWeightRulePreferences"
      - type: object
        additionalProperties: true
      x-spree-preferences-by-type:
        channel_rule: "#/components/schemas/DeliveryMethodRuleChannelRulePreferences"
        company_rule: "#/components/schemas/DeliveryMethodRuleCompanyRulePreferences"
        excluded_products_rule: "#/components/schemas/DeliveryMethodRuleExcludedProductsRulePreferences"
        item_total_rule: "#/components/schemas/DeliveryMethodRuleItemTotalRulePreferences"
        volume_rule: "#/components/schemas/DeliveryMethodRuleVolumeRulePreferences"
        weight_rule: "#/components/schemas/DeliveryMethodRuleWeightRulePreferences"
    DeliveryMethodCalculator:
      type: object
      description: How the delivery method prices a shipment
      properties:
        type:
          type: string
          example: flat_rate
          description: Wire shorthand for the calculator subclass
        preferences:
          "$ref": "#/components/schemas/DeliveryCalculatorPreferences"
      required:
      - type
      - preferences
    CurrencyCode:
      type: string
      enum:
      - AED
      - AFN
      - ALL
      - AMD
      - ANG
      - AOA
      - ARS
      - AUD
      - AWG
      - AZN
      - BAM
      - BBD
      - BDT
      - BGN
      - BHD
      - BIF
      - BMD
      - BND
      - BOB
      - BRL
      - BSD
      - BTN
      - BWP
      - BYN
      - BYR
      - BZD
      - CAD
      - CDF
      - CHF
      - CLF
      - CLP
      - CNY
      - COP
      - CRC
      - CUC
      - CUP
      - CVE
      - CZK
      - DJF
      - DKK
      - DOP
      - DZD
      - EEK
      - EGP
      - ERN
      - ETB
      - EUR
      - FJD
      - FKP
      - GBP
      - GEL
      - GHS
      - GIP
      - GMD
      - GNF
      - GTQ
      - GYD
      - HKD
      - HNL
      - HRK
      - HTG
      - HUF
      - IDR
      - ILS
      - INR
      - IQD
      - IRR
      - ISK
      - JMD
      - JOD
      - JPY
      - KES
      - KGS
      - KHR
      - KMF
      - KPW
      - KRW
      - KWD
      - KYD
      - KZT
      - LAK
      - LBP
      - LKR
      - LRD
      - LSL
      - LTL
      - LVL
      - LYD
      - MAD
      - MDL
      - MGA
      - MKD
      - MMK
      - MNT
      - MOP
      - MRO
      - MRU
      - MTL
      - MUR
      - MVR
      - MWK
      - MXN
      - MYR
      - MZN
      - NAD
      - NGN
      - NIO
      - NOK
      - NPR
      - NZD
      - OMR
      - PAB
      - PEN
      - PGK
      - PHP
      - PKR
      - PLN
      - PYG
      - QAR
      - RON
      - RSD
      - RUB
      - RWF
      - SAR
      - SBD
      - SCR
      - SDG
      - SEK
      - SGD
      - SHP
      - SKK
      - SLE
      - SLL
      - SOS
      - SRD
      - SSP
      - STD
      - STN
      - SVC
      - SYP
      - SZL
      - THB
      - TJS
      - TMM
      - TMT
      - TND
      - TOP
      - TRY
      - TTD
      - TWD
      - TZS
      - UAH
      - UGX
      - USD
      - UYI
      - UYU
      - UYW
      - UZS
      - VED
      - VEF
      - VES
      - VND
      - VUV
      - WST
      - XAF
      - XCD
      - XCG
      - XOF
      - XPF
      - YER
      - ZAR
      - ZMK
      - ZMW
      - ZWD
      - ZWG
      - ZWL
      - ZWN
      - ZWR
    CountryCode:
      type: string
      enum:
      - AD
      - AE
      - AF
      - AG
      - AI
      - AL
      - AM
      - AO
      - AR
      - AS
      - AT
      - AU
      - AW
      - AZ
      - BA
      - BB
      - BD
      - BE
      - BF
      - BG
      - BH
      - BI
      - BJ
      - BL
      - BM
      - BN
      - BO
      - BQ
      - BR
      - BS
      - BT
      - BW
      - BY
      - BZ
      - CA
      - CC
      - CD
      - CF
      - CG
      - CH
      - CI
      - CK
      - CL
      - CM
      - CN
      - CO
      - CR
      - CU
      - CV
      - CW
      - CX
      - CY
      - CZ
      - DE
      - DJ
      - DK
      - DM
      - DO
      - DZ
      - EC
      - EE
      - EG
      - ER
      - ES
      - ET
      - FI
      - FJ
      - FK
      - FM
      - FO
      - FR
      - GA
      - GB
      - GD
      - GE
      - GF
      - GG
      - GH
      - GI
      - GL
      - GM
      - GN
      - GP
      - GQ
      - GR
      - GT
      - GU
      - GW
      - GY
      - HK
      - HN
      - HR
      - HT
      - HU
      - ID
      - IE
      - IL
      - IM
      - IN
      - IQ
      - IR
      - IS
      - IT
      - JE
      - JM
      - JO
      - JP
      - KE
      - KG
      - KH
      - KI
      - KM
      - KN
      - KP
      - KR
      - KW
      - KY
      - KZ
      - LA
      - LB
      - LC
      - LI
      - LK
      - LR
      - LS
      - LT
      - LU
      - LV
      - LY
      - MA
      - MC
      - MD
      - ME
      - MF
      - MG
      - MH
      - MK
      - ML
      - MM
      - MN
      - MO
      - MP
      - MQ
      - MR
      - MS
      - MT
      - MU
      - MV
      - MW
      - MX
      - MY
      - MZ
      - NA
      - NC
      - NE
      - NF
      - NG
      - NI
      - NL
      - 'NO'
      - NP
      - NR
      - NU
      - NZ
      - OM
      - PA
      - PE
      - PF
      - PG
      - PH
      - PK
      - PL
      - PM
      - PN
      - PR
      - PS
      - PT
      - PW
      - PY
      - QA
      - RE
      - RO
      - RS
      - RU
      - RW
      - SA
      - SB
      - SC
      - SD
      - SE
      - SG
      - SH
      - SI
      - SJ
      - SK
      - SL
      - SM
      - SN
      - SO
      - SR
      - SS
      - ST
      - SV
      - SX
      - SY
      - SZ
      - TC
      - TD
      - TG
      - TH
      - TJ
      - TK
      - TL
      - TM
      - TN
      - TO
      - TR
      - TT
      - TV
      - TW
      - TZ
      - UA
      - UG
      - US
      - UY
      - UZ
      - VA
      - VC
      - VE
      - VG
      - VI
      - VN
      - VU
      - WF
      - WS
      - YE
      - YT
      - ZA
      - ZM
      - ZW
    DimensionUnit:
      type: string
      enum:
      - mm
      - cm
      - in
      - ft
    WeightUnit:
      type: string
      enum:
      - g
      - kg
      - lb
      - oz
    AccountUpdateParams:
      type: object
      properties:
        first_name:
          type: string
          example: Ada
        last_name:
          type: string
          example: Lovelace
        selected_locale:
          type: string
          description: The panel's display language, as a code the panel ships.
          example: de
        avatar_signed_id:
          type: string
          description: A `signed_id` from `POST /files` to set the photo, or `null`
            to remove it. Omit to leave the current one alone.
          nullable: true
    ClaimCancelParams:
      type: object
      properties:
        reason:
          type: string
          description: A note on why the claim was canceled.
    ClaimCreateParams:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              line_item_id:
                type: string
              quantity:
                type: integer
              description:
                type: string
                nullable: true
              send_replacement:
                type: boolean
              replacement_variant_id:
                type: string
                description: One of this seller's own variants.
                nullable: true
              refund_amount:
                type: string
                format: decimal
                pattern: "^-?\\d+(\\.\\d+)?$"
                nullable: true
            required:
            - line_item_id
            - quantity
        reason_id:
          type: string
          nullable: true
        memo:
          type: string
          nullable: true
      required:
      - items
    ClaimDenyParams:
      type: object
      properties:
        reason:
          type: string
          description: Recorded on the claim for the customer.
    ClaimResolveParams:
      type: object
      properties:
        resolution:
          type: string
          enum:
          - refund
          - replacement
          - refund_and_replacement
        refund_method:
          type: string
          enum:
          - original_payment
          - store_credit
          description: Defaults to `store_credit`.
        amount:
          type: string
          format: decimal
          pattern: "^-?\\d+(\\.\\d+)?$"
          nullable: true
        replacement_line_item_ids:
          type: array
          items:
            type: string
          description: Which claimed lines to replace. Omit to keep the lines the
            claim was opened with.
      required:
      - resolution
    CustomFieldValueParams:
      type: object
      properties:
        id:
          type: string
        custom_field_definition_id:
          type: string
        value:
          description: A scalar for text, number and boolean fields; a list or a hash
            for JSON fields.
    DeliveryCreateParams:
      type: object
      properties:
        tracking_number:
          type: string
          description: A carrier tracking number, a freight PRO or container number,
            or a full tracking link. A corrected number resets the carrier status
            to `pending`.
        carrier:
          type: string
          description: Free text; detected from the number's format when omitted.
        service:
          type: string
        tracking_url:
          type: string
      required:
      - tracking_number
    DeliveryMethodCreateParams:
      type: object
      properties:
        name:
          type: string
        admin_name:
          type: string
          nullable: true
        code:
          type: string
          nullable: true
        delivery_profile_id:
          type: string
          description: One of the marketplace's delivery profiles.
        delivery_zone_id:
          type: string
          description: Narrows where the method ships; null serves everywhere the
            profile reaches.
          nullable: true
        storefront_visible:
          type: boolean
        tracking_url:
          type: string
          nullable: true
        estimated_transit_business_days_min:
          type: integer
          nullable: true
        estimated_transit_business_days_max:
          type: integer
          nullable: true
        calculator:
          type: object
          properties:
            type:
              type: string
              example: flat_rate
            preferences:
              type: object
              additionalProperties: true
              example:
                amount: '12.5'
          description: 'How the method is priced: a type from `/delivery_methods/calculators`
            and its preferences, per that type''s `schema`.'
        rules:
          type: array
          items:
            "$ref": "#/components/schemas/DeliveryMethodRuleParams"
          description: 'Replaces the whole set: a rule dropped here is deleted, so
            re-send surviving rules with their `id`. An empty list clears every condition.'
      required:
      - name
    DeliveryMethodRuleParams:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          description: A type from `/delivery_methods/rule_types`.
        active:
          type: boolean
        preferences:
          type: object
          additionalProperties: true
      required:
      - type
    DeliveryMethodUpdateParams:
      type: object
      properties:
        name:
          type: string
        admin_name:
          type: string
          nullable: true
        code:
          type: string
          nullable: true
        delivery_profile_id:
          type: string
          description: One of the marketplace's delivery profiles.
        delivery_zone_id:
          type: string
          description: Narrows where the method ships; null serves everywhere the
            profile reaches.
          nullable: true
        storefront_visible:
          type: boolean
        tracking_url:
          type: string
          nullable: true
        estimated_transit_business_days_min:
          type: integer
          nullable: true
        estimated_transit_business_days_max:
          type: integer
          nullable: true
        calculator:
          type: object
          properties:
            type:
              type: string
              example: flat_rate
            preferences:
              type: object
              additionalProperties: true
              example:
                amount: '12.5'
          description: 'How the method is priced: a type from `/delivery_methods/calculators`
            and its preferences, per that type''s `schema`.'
        rules:
          type: array
          items:
            "$ref": "#/components/schemas/DeliveryMethodRuleParams"
          description: 'Replaces the whole set: a rule dropped here is deleted, so
            re-send surviving rules with their `id`. An empty list clears every condition.'
    DeliveryUpdateParams:
      type: object
      properties:
        tracking_number:
          type: string
          description: A carrier tracking number, a freight PRO or container number,
            or a full tracking link. A corrected number resets the carrier status
            to `pending`.
        carrier:
          type: string
          description: Free text; detected from the number's format when omitted.
        service:
          type: string
        tracking_url:
          type: string
    DigitalAssetCreateParams:
      type: object
      properties:
        signed_id:
          type: string
          description: 'A `signed_id` from `files.upload()` with `visibility: ''private''`.
            On update it replaces the file for everyone who already bought it. A seller''s
            file must be of a content type the marketplace accepts, checked against
            the file''s own signature where it has one.'
        variant_id:
          type: string
          description: On create, defaults to the product's default variant when omitted.
            On update, omitting it keeps the current variant.
        authorized_clicks:
          type: integer
          description: Null means the store's download settings apply.
          nullable: true
        authorized_days:
          type: integer
          description: Null means the store's download settings apply.
          nullable: true
      required:
      - signed_id
    DigitalAssetUpdateParams:
      type: object
      properties:
        signed_id:
          type: string
          description: 'A `signed_id` from `files.upload()` with `visibility: ''private''`.
            On update it replaces the file for everyone who already bought it. A seller''s
            file must be of a content type the marketplace accepts, checked against
            the file''s own signature where it has one.'
        variant_id:
          type: string
          description: On create, defaults to the product's default variant when omitted.
            On update, omitting it keeps the current variant.
        authorized_clicks:
          type: integer
          description: Null means the store's download settings apply.
          nullable: true
        authorized_days:
          type: integer
          description: Null means the store's download settings apply.
          nullable: true
    ExchangeCancelParams:
      type: object
      properties:
        reason:
          type: string
          description: A note on why the exchange was canceled.
    ExchangeCreateParams:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              fulfillment_item_id:
                type: string
              new_variant_id:
                type: string
                description: One of this seller's own variants.
              quantity:
                type: integer
            required:
            - fulfillment_item_id
            - new_variant_id
            - quantity
        reason_id:
          type: string
          nullable: true
        stock_location_id:
          type: string
          description: One of this seller's own stock locations, where the goods are
            restocked.
          nullable: true
        memo:
          type: string
          nullable: true
      required:
      - items
    ExchangeFulfillParams:
      type: object
      properties:
        refund_method:
          type: string
          enum:
          - original_payment
          - store_credit
          description: Defaults to `store_credit`.
    ExchangeReceiveParams:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              exchange_line_item_id:
                type: string
              quantity:
                type: integer
              resellable:
                type: boolean
                description: Goods that cannot be resold are received but never restocked.
                  Defaults to true.
            required:
            - exchange_line_item_id
            - quantity
          description: What actually arrived. Omit to receive everything as requested
            and resellable.
    FileUploadCreateParams:
      type: object
      properties:
        filename:
          type: string
          example: registration.pdf
        content_type:
          type: string
          example: application/pdf
        byte_size:
          type: integer
          example: 51234
        checksum:
          type: string
          description: Base64-encoded MD5 digest of the file; the storage service
            checks the bytes against it.
          example: rL0Y20zC+Fzt72VPzMSk2A==
        visibility:
          type: string
          enum:
          - public
          - private
          description: "`public` (the default) for images, videos and CSV files anyone
            may fetch, `private` for any type."
        file:
          type: string
          format: binary
          description: The bytes, for a multipart upload.
      required:
      - filename
      - content_type
    FulfillmentFulfillParams:
      type: object
      properties:
        tracking:
          type: string
          description: Carrier tracking number.
        tracking_carrier:
          type: string
          description: Carrier name.
        notify_customer:
          type: boolean
          description: Send the dispatch email (default true).
        items:
          type: array
          items:
            type: object
            properties:
              item_id:
                type: string
                description: Prefixed line item ID.
              quantity:
                type: integer
            required:
            - item_id
            - quantity
          description: Ship only these lines; the rest split onto a new fulfillment.
    FulfillmentSplitParams:
      type: object
      properties:
        variant_id:
          type: string
          description: The variant being moved out.
        quantity:
          type: integer
        stock_location_id:
          type: string
          description: One of this seller's own stock locations. Defaults to the source
            fulfillment's location.
      required:
      - variant_id
      - quantity
    FulfillmentUpdateParams:
      type: object
      properties:
        tracking:
          type: string
          nullable: true
        tracking_carrier:
          type: string
          nullable: true
        stock_location_id:
          type: string
          description: One of this seller's own stock locations; the rates requote
            from there.
        selected_delivery_rate_id:
          type: string
          description: One of the rates quoted for this parcel from its current origin.
    ImportCompleteMappingParams:
      type: object
      properties:
        mappings:
          type: array
          items:
            type: object
            properties:
              schema_field:
                type: string
                description: Canonical schema field name.
              file_column:
                type: string
                description: CSV header to read the field from; `null` unmaps the
                  field.
                nullable: true
            required:
            - schema_field
            - file_column
          description: Column assignments to apply before processing starts.
    ImportCreateParams:
      type: object
      properties:
        type:
          type: string
          enum:
          - products
        attachment_signed_id:
          type: string
          description: 'The `signed_id` of the uploaded CSV, from `POST /files` with
            `visibility: ''private''`.'
        delimiter:
          type: string
          description: CSV column separator. Defaults to a comma.
        results_url:
          type: string
          description: Absolute URL of the panel's imports view; the import-done email
            links back to it. Honored only when it matches one of the store's allowed
            origins.
      required:
      - type
      - attachment_signed_id
    InvitationAcceptParams:
      type: object
      properties:
        password:
          type: string
          description: Sets the password of a new account, or confirms the password
            of an existing one, unless the request is already signed in as that account.
        password_confirmation:
          type: string
        first_name:
          type: string
          description: Used only when the invitation creates a new account.
        last_name:
          type: string
          description: Used only when the invitation creates a new account.
    LoginParams:
      type: object
      properties:
        provider:
          type: string
          enum:
          - email
          description: The authentication method. Defaults to `email`.
        email:
          type: string
          example: [email protected]
        password:
          type: string
          example: password123
      required:
      - email
      - password
    OnboardingPayoutAccountParams:
      type: object
      properties:
        refresh_url:
          type: string
          format: uri
          description: Where the provider sends the seller back. Must be on the seller
            panel's origin; any other address is replaced with the panel's.
        return_url:
          type: string
          format: uri
          description: Where the provider sends the seller back. Must be on the seller
            panel's origin; any other address is replaced with the panel's.
      required:
      - refresh_url
      - return_url
    OrderAddressCorrectionParams:
      type: object
      properties:
        shipping_address:
          allOf:
          - "$ref": "#/components/schemas/OrderAddressParams"
          description: Only the lines that change; the rest of the address is carried
            over.
        billing_address:
          allOf:
          - "$ref": "#/components/schemas/OrderAddressParams"
          description: Only the lines that change; the rest of the address is carried
            over.
    OrderAddressParams:
      type: object
      properties:
        first_name:
          type: string
        last_name:
          type: string
        address1:
          type: string
        city:
          type: string
        postal_code:
          type: string
        company:
          type: string
          nullable: true
        address2:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
        alternative_phone:
          type: string
          nullable: true
        state_code:
          type: string
          nullable: true
        state_name:
          type: string
          nullable: true
        label:
          type: string
          nullable: true
        country_code:
          allOf:
          - "$ref": "#/components/schemas/CountryCode"
          example: US
    OrderCancelParams:
      type: object
      properties:
        cancel_reason_id:
          type: string
          description: A reason from the order cancellation reasons endpoint.
          nullable: true
        cancel_note:
          type: string
          description: Free text beside the reason.
          nullable: true
        refund_payments:
          type: boolean
          description: Hand back what the buyer paid for this order's goods.
        notify_customer:
          type: boolean
          description: Email the customer about the cancellation.
    OrderNotesParams:
      type: object
      properties:
        customer_note:
          type: string
          description: What the buyer asked for.
          nullable: true
        internal_note:
          type: string
          description: The seller's own working note, as HTML. Sanitized on save;
            `internal_note_html` reads it back.
          nullable: true
    PackageTypeCreateParams:
      type: object
      properties:
        name:
          type: string
        kind:
          type: string
          enum:
          - box
          - envelope
          - carton
          - pallet
          - container
        length:
          type: number
          nullable: true
        width:
          type: number
          nullable: true
        height:
          type: number
          nullable: true
        dimensions_unit:
          allOf:
          - "$ref": "#/components/schemas/DimensionUnit"
          nullable: true
        weight:
          type: number
          description: The empty package's own weight, added to every quote.
          nullable: true
        max_weight:
          type: number
          nullable: true
        weight_unit:
          allOf:
          - "$ref": "#/components/schemas/WeightUnit"
          nullable: true
        default:
          type: boolean
          description: Makes this the box this seller's parcels are quoted with. One
            default per seller, so it never displaces the marketplace's.
        metadata:
          type: object
          additionalProperties: true
          nullable: true
      required:
      - name
    PackageTypeUpdateParams:
      type: object
      properties:
        name:
          type: string
        kind:
          type: string
          enum:
          - box
          - envelope
          - carton
          - pallet
          - container
        length:
          type: number
          nullable: true
        width:
          type: number
          nullable: true
        height:
          type: number
          nullable: true
        dimensions_unit:
          allOf:
          - "$ref": "#/components/schemas/DimensionUnit"
          nullable: true
        weight:
          type: number
          description: The empty package's own weight, added to every quote.
          nullable: true
        max_weight:
          type: number
          nullable: true
        weight_unit:
          allOf:
          - "$ref": "#/components/schemas/WeightUnit"
          nullable: true
        default:
          type: boolean
          description: Makes this the box this seller's parcels are quoted with. One
            default per seller, so it never displaces the marketplace's.
        metadata:
          type: object
          additionalProperties: true
          nullable: true
    PasswordResetCreateParams:
      type: object
      properties:
        email:
          type: string
          example: [email protected]
        redirect_url:
          type: string
          description: Must match an allowed origin of the store; ignored otherwise.
          example: https://sellers.your-store.com/reset-password
      required:
      - email
    PasswordResetUpdateParams:
      type: object
      properties:
        password:
          type: string
          example: new-password-123
        password_confirmation:
          type: string
          example: new-password-123
      required:
      - password
      - password_confirmation
    PolicyCreateParams:
      type: object
      properties:
        name:
          type: string
          description: 'When the marketplace requires a named policy, use that exact
            name: the onboarding check matches on it.'
          example: Shipping Policy
        slug:
          type: string
          example: shipping-policy
        body:
          type: string
          description: HTML, sanitized before it is stored. `body_html` on the response
            is the rendering of what was stored.
          example: "<p>Orders leave the workshop within two working days.</p>"
          nullable: true
      required:
      - name
    PolicyUpdateParams:
      type: object
      properties:
        name:
          type: string
          description: 'When the marketplace requires a named policy, use that exact
            name: the onboarding check matches on it.'
          example: Shipping Policy
        slug:
          type: string
          example: shipping-policy
        body:
          type: string
          description: HTML, sanitized before it is stored. `body_html` on the response
            is the rendering of what was stored.
          example: "<p>Orders leave the workshop within two working days.</p>"
          nullable: true
    ProductBulkDestroyParams:
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
          description: Ids outside this seller's catalog are ignored; products the
            store refuses to delete are counted in `skipped_count`.
      required:
      - ids
    ProductBulkStatusParams:
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
          example:
          - prod_UkLWZg9DAJ
        status:
          type: string
          enum:
          - draft
          - archived
          description: A listing goes on sale only when the marketplace approves it,
            so there is no bulk route onto `active`.
      required:
      - ids
      - status
    ProductBulkSubmitParams:
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
          description: Only drafts and rejected listings are submitted; the rest are
            counted in `skipped_count`.
      required:
      - ids
    ProductCreateParams:
      type: object
      properties:
        name:
          type: string
          example: Hand-thrown mug
        description:
          type: string
        slug:
          type: string
          example: hand-thrown-mug
        meta_title:
          type: string
        meta_description:
          type: string
        meta_keywords:
          type: string
        metadata:
          type: object
          additionalProperties: true
        product_type_id:
          type: string
          description: The marketplace's product type this product is listed against,
            from the product types endpoint. Null detaches it. Saving with a type
            seeds its option types onto the product.
          nullable: true
        delivery_profile_id:
          type: string
          description: Which of the marketplace's delivery profiles the product ships
            under. A new product sent without one lands on the profile marked default.
        prices:
          type: array
          items:
            type: object
            properties:
              currency:
                allOf:
                - "$ref": "#/components/schemas/CurrencyCode"
                description: Omit to price in the store's currency. A seller has no
                  currency of their own.
                example: USD
              amount:
                type: string
                format: decimal
                pattern: "^-?\\d+(\\.\\d+)?$"
                description: 'A canonical decimal string (`"1234.56"`: period decimal,
                  no grouping). The API does not parse localized input.'
                example: '24.00'
              compare_at_amount:
                type: string
                format: decimal
                pattern: "^-?\\d+(\\.\\d+)?$"
                example: '30.00'
                nullable: true
            required:
            - amount
          description: 'Shorthand for a simple (no-options) product: per-currency
            prices that forward to the product''s sole variant.'
        media:
          type: array
          items:
            "$ref": "#/components/schemas/SellerProductMediaParams"
          description: 'The gallery, as a whole: a file absent from the list is removed.
            `signed_id` attaches a fresh upload; `id` updates one already there.'
        variants:
          type: array
          items:
            "$ref": "#/components/schemas/ProductVariantParams"
          description: 'The variants, as a whole: one absent from the list is removed.
            Pass `id` to update an existing variant.'
      required:
      - name
    ProductUpdateParams:
      type: object
      properties:
        name:
          type: string
          example: Hand-thrown mug
        description:
          type: string
        slug:
          type: string
          example: hand-thrown-mug
        meta_title:
          type: string
        meta_description:
          type: string
        meta_keywords:
          type: string
        metadata:
          type: object
          additionalProperties: true
        product_type_id:
          type: string
          description: The marketplace's product type this product is listed against,
            from the product types endpoint. Null detaches it. Saving with a type
            seeds its option types onto the product.
          nullable: true
        delivery_profile_id:
          type: string
          description: Which of the marketplace's delivery profiles the product ships
            under. A new product sent without one lands on the profile marked default.
        prices:
          type: array
          items:
            type: object
            properties:
              currency:
                allOf:
                - "$ref": "#/components/schemas/CurrencyCode"
                description: Omit to price in the store's currency. A seller has no
                  currency of their own.
                example: USD
              amount:
                type: string
                format: decimal
                pattern: "^-?\\d+(\\.\\d+)?$"
                description: 'A canonical decimal string (`"1234.56"`: period decimal,
                  no grouping). The API does not parse localized input.'
                example: '24.00'
              compare_at_amount:
                type: string
                format: decimal
                pattern: "^-?\\d+(\\.\\d+)?$"
                example: '30.00'
                nullable: true
            required:
            - amount
          description: 'Shorthand for a simple (no-options) product: per-currency
            prices that forward to the product''s sole variant.'
        media:
          type: array
          items:
            "$ref": "#/components/schemas/SellerProductMediaParams"
          description: 'The gallery, as a whole: a file absent from the list is removed.
            `signed_id` attaches a fresh upload; `id` updates one already there.'
        variants:
          type: array
          items:
            "$ref": "#/components/schemas/ProductVariantParams"
          description: 'The variants, as a whole: one absent from the list is removed.
            Pass `id` to update an existing variant.'
    ProductVariantParams:
      allOf:
      - "$ref": "#/components/schemas/VariantParams"
      - type: object
        properties:
          id:
            type: string
    ProfileUpdateParams:
      type: object
      properties:
        name:
          type: string
          example: Acme Supplies
        contact_email:
          type: string
          format: email
          nullable: true
        billing_email:
          type: string
          format: email
          nullable: true
        about:
          type: string
          description: 'Sanitized HTML: the seller''s public description.'
          nullable: true
        legal_name:
          type: string
          description: The business a commission invoice is made out to.
          nullable: true
        registration_number:
          type: string
          nullable: true
        logo_signed_id:
          type: string
          description: A `signed_id` from `POST /files`; `null` removes the image.
          nullable: true
        square_logo_signed_id:
          type: string
          description: A `signed_id` from `POST /files`; `null` removes the image.
          nullable: true
        cover_photo_signed_id:
          type: string
          description: A `signed_id` from `POST /files`; `null` removes the image.
          nullable: true
        billing_address:
          "$ref": "#/components/schemas/SellerAddressParams"
        custom_fields:
          type: array
          items:
            "$ref": "#/components/schemas/CustomFieldValueParams"
          description: Answers to the custom fields this marketplace's onboarding
            asks for. A field nothing asked for is ignored rather than written.
        accept_terms:
          type: boolean
          description: 'Stamps the moment the seller accepted the marketplace''s terms.
            One-way: sending `false` does not unmake the stamp.'
    RequirementSubmissionParams:
      type: object
      properties:
        note:
          type: string
          description: Anything the seller wants to say alongside the submission.
        reference:
          type: string
          description: A reference number or external identifier, for requirements
            that ask for one.
        file_signed_id:
          type: string
          description: A `signed_id` from `POST /files`, for requirements that ask
            for a document.
    ReturnCancelParams:
      type: object
      properties:
        reason:
          type: string
          description: A note on why the return was canceled.
    ReturnCreateParams:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              fulfillment_item_id:
                type: string
              quantity:
                type: integer
            required:
            - fulfillment_item_id
            - quantity
        reason_id:
          type: string
          nullable: true
        stock_location_id:
          type: string
          description: One of this seller's own stock locations, where the goods are
            restocked.
          nullable: true
        memo:
          type: string
          nullable: true
      required:
      - items
    ReturnReceiveParams:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              return_line_item_id:
                type: string
              quantity:
                type: integer
              resellable:
                type: boolean
                description: Defaults to true.
            required:
            - return_line_item_id
            - quantity
          description: What actually arrived. Omit to receive everything as requested
            and resellable.
    ReturnRefundParams:
      type: object
      properties:
        amount:
          type: string
          format: decimal
          pattern: "^-?\\d+(\\.\\d+)?$"
          nullable: true
        refund_method:
          type: string
          enum:
          - original_payment
          - store_credit
          description: Defaults to `original_payment`.
    SellerAddressParams:
      type: object
      properties:
        first_name:
          type: string
        last_name:
          type: string
        company:
          type: string
        address1:
          type: string
        address2:
          type: string
        city:
          type: string
        postal_code:
          type: string
        phone:
          type: string
        label:
          type: string
        country_code:
          allOf:
          - "$ref": "#/components/schemas/CountryCode"
          description: ISO 3166-1 alpha-2 code, such as `US`.
          example: US
        state_code:
          type: string
          description: The state or province abbreviation, such as `NY`.
          example: NY
        state_name:
          type: string
          description: For countries without states in the database.
    SellerExportCreateParams:
      type: object
      properties:
        type:
          type: string
          enum:
          - orders
          - products
          description: Which dataset to export.
        record_selection:
          type: string
          enum:
          - filtered
          - all
          description: "`filtered` (default) keeps `search_params`; `all` exports
            everything this seller owns."
        search_params:
          type: object
          additionalProperties: true
          description: Ransack predicates, the same shape the list endpoints take.
            Ignored when `record_selection` is `all`.
        results_url:
          type: string
          description: Panel URL the export-done email links back to. Honored only
            when it matches one of the store's allowed origins.
      required:
      - type
    SellerProductMediaParams:
      type: object
      properties:
        id:
          type: string
        signed_id:
          type: string
          description: A `signed_id` from `POST /files`.
        alt:
          type: string
          example: Front view
          nullable: true
        position:
          type: integer
          example: 1
        media_type:
          type: string
          enum:
          - image
          - video
          - external_video
          description: Defaults to `image`. `video` needs a `signed_id`; `external_video`
            needs an `external_video_url`.
          example: image
        external_video_url:
          type: string
          description: YouTube or Vimeo link. Required when `media_type` is `external_video`.
          nullable: true
        poster_signed_id:
          type: string
          description: A `signed_id` from `files.upload()` for a video's poster frame.
        focal_point_x:
          type: number
          description: Where the image is anchored when cropped, from 0 to 1.
          nullable: true
        focal_point_y:
          type: number
          description: Where the image is anchored when cropped, from 0 to 1.
          nullable: true
        variant_ids:
          type: array
          items:
            type: string
          description: Replaces the variants this media is linked to. An empty list
            clears them.
    SellerTaxIdentifierCreateParams:
      type: object
      properties:
        kind:
          type: string
          description: 'The registration the number belongs to, such as `eu_vat` or
            `gb_vat`. Any kind is accepted; one with a registered validator is checked
            by it. Built-in: `eu_vat`. Extensions may register more. One registration
            per kind.'
          example: eu_vat
        value:
          type: string
          description: A number the validator for its kind refuses is rejected rather
            than stored.
          example: DE100000008
      required:
      - kind
      - value
    SellerTaxIdentifierUpdateParams:
      type: object
      properties:
        kind:
          type: string
          description: 'The registration the number belongs to, such as `eu_vat` or
            `gb_vat`. Any kind is accepted; one with a registered validator is checked
            by it. Built-in: `eu_vat`. Extensions may register more. One registration
            per kind.'
          example: eu_vat
        value:
          type: string
          description: A number the validator for its kind refuses is rejected rather
            than stored.
          example: DE100000008
    ShippingLabelCreateParams:
      type: object
      properties:
        file_signed_id:
          type: string
          description: A `signed_id` from `files.upload()`.
        tracking_number:
          type: string
          description: The number printed on the label.
        carrier:
          type: string
          description: Free text; a forwarder's name is as valid as a carrier slug.
            Detected from the number when omitted.
        service:
          type: string
          description: Carrier service the label was bought at.
        cost:
          type: string
          format: decimal
          pattern: "^-?\\d+(\\.\\d+)?$"
          description: What the seller paid the carrier. Accounting data only; it
            never touches the order's shipping charge.
        currency:
          allOf:
          - "$ref": "#/components/schemas/CurrencyCode"
          description: Currency of the cost.
        file_format:
          type: string
          enum:
          - pdf
          - png
          - zpl
          description: Taken from the file when omitted.
        tracking_url:
          type: string
          description: Tracking page for the consignment the label mints.
      required:
      - file_signed_id
      - tracking_number
    StockLevelParams:
      type: object
      properties:
        stock_location_id:
          type: string
          description: The location holding the stock (`sloc_...`).
        count_on_hand:
          type: integer
          description: 'Units physically at the location, not units available to sell:
            stock promised to placed orders counts until it ships. Sent as the count
            the shelf should end at; the API records the difference as an adjustment
            in the stock history.'
        backorderable:
          type: boolean
          description: Whether this location sells the variant beyond what it holds.
      required:
      - stock_location_id
      - count_on_hand
    StockLocationCreateParams:
      type: object
      properties:
        name:
          type: string
          example: Main warehouse
        admin_name:
          type: string
          nullable: true
        active:
          type: boolean
          description: 'Set `false` to retire a location: there is no delete.'
        default:
          type: boolean
        kind:
          anyOf:
          - type: string
            enum:
            - warehouse
            - store
            - fulfillment_center
          - type: string
          description: Categorizes the location. The values listed are the built-in
            ones; extensions may add more.
          example: warehouse
        propagate_all_variants:
          type: boolean
        backorderable_default:
          type: boolean
        address1:
          type: string
          nullable: true
        address2:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        zipcode:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
        company:
          type: string
          nullable: true
        country_code:
          allOf:
          - "$ref": "#/components/schemas/CountryCode"
          description: ISO-3166 alpha-2 country code.
          example: US
          nullable: true
        state_code:
          type: string
          description: State or province abbreviation, resolved against the selected
            country's states.
          example: OR
          nullable: true
        state_name:
          type: string
          description: Free-text state for countries that don't have a states list.
          nullable: true
        pickup_enabled:
          type: boolean
        pickup_stock_policy:
          type: string
          enum:
          - local
          - any
          description: "`local` collects only items at this location; `any` lets items
            transfer in from other locations (ship-to-store)."
        pickup_ready_in_minutes:
          type: integer
          nullable: true
        returns_enabled:
          type: boolean
          description: Whether customers may send returns to this location.
        pickup_instructions:
          type: string
          nullable: true
      required:
      - name
    StockLocationUpdateParams:
      type: object
      properties:
        name:
          type: string
          example: Main warehouse
        admin_name:
          type: string
          nullable: true
        active:
          type: boolean
          description: 'Set `false` to retire a location: there is no delete.'
        default:
          type: boolean
        kind:
          anyOf:
          - type: string
            enum:
            - warehouse
            - store
            - fulfillment_center
          - type: string
          description: Categorizes the location. The values listed are the built-in
            ones; extensions may add more.
          example: warehouse
        propagate_all_variants:
          type: boolean
        backorderable_default:
          type: boolean
        address1:
          type: string
          nullable: true
        address2:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        zipcode:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
        company:
          type: string
          nullable: true
        country_code:
          allOf:
          - "$ref": "#/components/schemas/CountryCode"
          description: ISO-3166 alpha-2 country code.
          example: US
          nullable: true
        state_code:
          type: string
          description: State or province abbreviation, resolved against the selected
            country's states.
          example: OR
          nullable: true
        state_name:
          type: string
          description: Free-text state for countries that don't have a states list.
          nullable: true
        pickup_enabled:
          type: boolean
        pickup_stock_policy:
          type: string
          enum:
          - local
          - any
          description: "`local` collects only items at this location; `any` lets items
            transfer in from other locations (ship-to-store)."
        pickup_ready_in_minutes:
          type: integer
          nullable: true
        returns_enabled:
          type: boolean
          description: Whether customers may send returns to this location.
        pickup_instructions:
          type: string
          nullable: true
    TeamMemberCreateParams:
      type: object
      properties:
        email:
          type: string
          example: [email protected]
      required:
      - email
    VariantOptionParams:
      type: object
      properties:
        name:
          type: string
          example: size
        value:
          type: string
          example: Small
      required:
      - name
      - value
    VariantParams:
      type: object
      properties:
        sku:
          type: string
        barcode:
          type: string
        cost_price:
          type: string
          format: decimal
          pattern: "^-?\\d+(\\.\\d+)?$"
          nullable: true
        cost_currency:
          "$ref": "#/components/schemas/CurrencyCode"
        weight:
          type: number
          nullable: true
        height:
          type: number
          nullable: true
        width:
          type: number
          nullable: true
        depth:
          type: number
          nullable: true
        weight_unit:
          allOf:
          - "$ref": "#/components/schemas/WeightUnit"
          description: Null falls back to the store's weight unit.
          nullable: true
        dimensions_unit:
          allOf:
          - "$ref": "#/components/schemas/DimensionUnit"
          description: Null falls back to the store's unit system.
          nullable: true
        hs_code:
          type: string
        customs_description:
          type: string
        country_of_origin:
          "$ref": "#/components/schemas/CountryCode"
        minimum_order_quantity:
          type: integer
          nullable: true
        order_multiple:
          type: integer
          nullable: true
        purchase_unit:
          type: string
          enum:
          - unit
          - carton
          nullable: true
        units_per_carton:
          type: integer
          description: How many units fill one carton.
          nullable: true
        carton_package_type_id:
          type: string
          description: 'The carton this variant is packed into: a package type of
            kind `carton`. Its dimensions are shared by every product packed the same
            way, so a corrected carton size fixes all of them at once.'
          nullable: true
        carton_weight:
          type: number
          description: What one packed carton weighs, in the variant's weight unit.
          nullable: true
        cartons_per_pallet:
          type: integer
          description: How many cartons stack on one pallet.
          nullable: true
        track_inventory:
          type: boolean
        preorderable:
          type: boolean
          description: Sell this variant before it's in stock. Adds the pre-order
            label and ships-by promise; the cap comes from `backorder_limit`, an incoming
            stock count, or backorder.
        preorder_ships_at:
          type: string
          format: date-time
          description: The "ships by" date shown to customers while the variant is
            a pre-order. Once it passes, the variant is no longer a pre-order. Null
            clears it.
          nullable: true
        backorder_limit:
          type: integer
          description: Maximum units sellable beyond available stock, capping backorders
            and pre-orders. Null is unlimited.
          nullable: true
        position:
          type: integer
        options:
          type: array
          items:
            "$ref": "#/components/schemas/VariantOptionParams"
          description: One pair per option type the variant takes part in (size, color).
            Option types and values are created when missing.
        prices:
          type: array
          items:
            type: object
            properties:
              currency:
                allOf:
                - "$ref": "#/components/schemas/CurrencyCode"
                description: Omit to price in the store's currency. A seller has no
                  currency of their own.
                example: USD
              amount:
                type: string
                format: decimal
                pattern: "^-?\\d+(\\.\\d+)?$"
                description: 'A canonical decimal string (`"1234.56"`: period decimal,
                  no grouping). The API does not parse localized input.'
                example: '24.00'
              compare_at_amount:
                type: string
                format: decimal
                pattern: "^-?\\d+(\\.\\d+)?$"
                example: '30.00'
                nullable: true
            required:
            - amount
          description: Per-currency prices. Upserted by currency.
        stock_levels:
          type: array
          items:
            "$ref": "#/components/schemas/StockLevelParams"
          description: 'Stock per location, at this seller''s own locations only:
            a location belonging to anyone else is ignored.'
  x-spree-filter-tables:
    Claim:
      attributes:
        created_at: datetime
        id: id
        number: text
        status:
          enum:
          - open
          - approved
          - resolved
          - denied
          - canceled
        updated_at: datetime
      associations: {}
      scopes:
        search: text
    ClaimReason:
      attributes:
        active: boolean
        created_at: datetime
        id: id
        name: text
        updated_at: datetime
      associations: {}
      scopes: {}
    Delivery:
      attributes:
        carrier: text
        created_at: datetime
        id: id
        status:
          enum:
          - pending
          - pre_transit
          - in_transit
          - out_for_delivery
          - available_for_pickup
          - delivered
          - return_to_sender
          - failure
          - unknown
        tracking_number: text
        updated_at: datetime
      associations: {}
      scopes: {}
    DeliveryMethod:
      attributes:
        available_to_sellers: boolean
        created_at: datetime
        id: id
        name: text
        seller_id: id
        storefront_visible: boolean
        updated_at: datetime
      associations: {}
      scopes:
        search: text
    DeliveryProfile:
      attributes:
        created_at: datetime
        id: id
        name: text
        position: integer
        updated_at: datetime
      associations: {}
      scopes:
        search: text
    DeliveryZone:
      attributes:
        created_at: datetime
        delivery_profile_id: id
        id: id
        name: text
        updated_at: datetime
      associations: {}
      scopes: {}
    DigitalAsset:
      attributes:
        created_at: datetime
        id: id
        updated_at: datetime
      associations: {}
      scopes: {}
    Exchange:
      attributes:
        created_at: datetime
        id: id
        number: text
        status:
          enum:
          - requested
          - approved
          - received
          - fulfilled
          - canceled
        updated_at: datetime
      associations: {}
      scopes:
        search: text
    Fulfillment:
      attributes:
        created_at: datetime
        id: id
        number: text
        updated_at: datetime
      associations: {}
      scopes: {}
    Import:
      attributes:
        created_at: datetime
        id: id
        number: text
        seller_id: id
        status:
          enum:
          - pending
          - mapping
          - completed_mapping
          - processing
          - completed
          - failed
        type: type
        updated_at: datetime
      associations: {}
      scopes:
        search: text
    ImportRow:
      attributes:
        created_at: datetime
        id: id
        row_number: integer
        status:
          enum:
          - pending
          - processing
          - completed
          - failed
        updated_at: datetime
      associations: {}
      scopes: {}
    Order:
      attributes:
        channel_id: id
        completed_at: datetime
        created_at: datetime
        currency:
          code: CurrencyCode
        customer_id: id
        delivery_total: decimal
        fulfillment_status:
          enum:
          - backorder
          - canceled
          - partial
          - unfulfilled
          - fulfilled
          - delivered
          - pending
          - ready
          - shipped
        id: id
        item_total: decimal
        locale:
          code: LocaleCode
        market_id: id
        number: text
        order_group_id: id
        payment_state:
          enum:
          - none
          - authorized
          - partially_paid
          - paid
          - partially_refunded
          - refunded
          - overcharged
          - voided
          - balance_due
          - credit_owed
          - failed
          - void
        payment_status:
          enum:
          - none
          - authorized
          - partially_paid
          - paid
          - partially_refunded
          - refunded
          - overcharged
          - voided
          - balance_due
          - credit_owed
          - failed
          - void
        po_number: text
        seller_id: id
        shipment_state:
          enum:
          - backorder
          - canceled
          - partial
          - unfulfilled
          - fulfilled
          - delivered
          - pending
          - ready
          - shipped
        status:
          enum:
          - draft
          - placed
          - canceled
        total: decimal
        total_quantity: integer
        updated_at: datetime
      associations: {}
      scopes:
        complete: boolean
        incomplete: boolean
        partially_refunded: boolean
        refunded: boolean
    OrderCancellationReason:
      attributes:
        active: boolean
        created_at: datetime
        id: id
        name: text
        updated_at: datetime
      associations: {}
      scopes: {}
    PackageType:
      attributes:
        created_at: datetime
        default: boolean
        id: id
        kind:
          enum:
          - box
          - envelope
          - carton
          - pallet
          - container
        name: text
        seller_id: id
        updated_at: datetime
      associations: {}
      scopes:
        search: text
    Policy:
      attributes:
        created_at: datetime
        id: id
        name: text
        owner_id: id
        owner_type: type
        updated_at: datetime
      associations: {}
      scopes:
        search: text
    Product:
      attributes:
        available_on: datetime
        created_at: datetime
        description: text
        discontinue_on: datetime
        id: id
        name: text
        price: decimal
        seller_id: id
        slug: text
        status:
          enum:
          - draft
          - active
          - archived
          - proposed
          - rejected
        updated_at: datetime
      associations: {}
      scopes:
        ascend_by_price: boolean
        descend_by_price: boolean
        in_categories:
          list: id
        in_category: id
        in_collection: id
        in_stock: boolean
        in_taxon: id
        not_discontinued: boolean
        out_of_stock: boolean
        price_between:
        - decimal
        - decimal
        price_gte: decimal
        price_lte: decimal
        search: text
        search_by_name: text
        with_option_value_ids:
          list: id
    ProductType:
      attributes:
        created_at: datetime
        id: id
        name: text
        updated_at: datetime
      associations: {}
      scopes:
        search: text
    Return:
      attributes:
        created_at: datetime
        id: id
        number: text
        status:
          enum:
          - requested
          - approved
          - received
          - refunded
          - canceled
        updated_at: datetime
      associations: {}
      scopes:
        search: text
    ReturnReason:
      attributes:
        active: boolean
        created_at: datetime
        id: id
        name: text
        updated_at: datetime
      associations: {}
      scopes: {}
    SellerPayout:
      attributes:
        amount: decimal
        created_at: datetime
        currency:
          code: CurrencyCode
        id: id
        period_end: datetime
        period_start: datetime
        provider: text
        reference: text
        seller_id: id
        status:
          enum:
          - pending
          - processing
          - completed
          - failed
          - unresolved
        updated_at: datetime
      associations: {}
      scopes:
        search: text
    SellerTransfer:
      attributes:
        amount: decimal
        created_at: datetime
        currency:
          code: CurrencyCode
        id: id
        kind:
          enum:
          - earning
          - refund_reversal
        order_id: id
        payout_id: id
        provider: text
        reference: text
        seller_id: id
        status:
          enum:
          - pending
          - processing
          - completed
          - failed
          - unresolved
        updated_at: datetime
      associations: {}
      scopes:
        search: text
    ShippingLabel:
      attributes:
        carrier: text
        created_at: datetime
        id: id
        source:
          enum:
          - purchased
          - uploaded
        status:
          enum:
          - purchased
          - refund_requested
          - refunded
        tracking_number: text
        updated_at: datetime
      associations: {}
      scopes: {}
    StockLocation:
      attributes:
        active: boolean
        country_code:
          code: CountryCode
        created_at: datetime
        default: boolean
        id: id
        kind: text
        name: text
        pickup_enabled: boolean
        returns_enabled: boolean
        seller_id: id
        state_code: text
        updated_at: datetime
      associations: {}
      scopes:
        search: text
    TaxIdentifier:
      attributes:
        created_at: datetime
        id: id
        updated_at: datetime
      associations: {}
      scopes: {}
  x-spree-filter-predicates:
    text:
    - eq
    - not_eq
    - in
    - not_in
    - cont
    - i_cont
    - not_cont
    - start
    - end
    - 'null'
    - not_null
    - present
    - blank
    decimal:
    - eq
    - not_eq
    - in
    - not_in
    - lt
    - lteq
    - gt
    - gteq
    - 'null'
    - not_null
    integer:
    - eq
    - not_eq
    - in
    - not_in
    - lt
    - lteq
    - gt
    - gteq
    - 'null'
    - not_null
    date:
    - eq
    - not_eq
    - in
    - not_in
    - lt
    - lteq
    - gt
    - gteq
    - 'null'
    - not_null
    datetime:
    - eq
    - not_eq
    - in
    - not_in
    - lt
    - lteq
    - gt
    - gteq
    - 'null'
    - not_null
    enum:
    - eq
    - not_eq
    - in
    - not_in
    - 'null'
    - not_null
    id:
    - eq
    - not_eq
    - in
    - not_in
    - 'null'
    - not_null
    type:
    - eq
    - not_eq
    - in
    - not_in
    - 'null'
    - not_null
    boolean:
    - eq
    - not_eq
    - in
    - not_in
    - 'true'
    - 'false'
    - 'null'