> ## Documentation Index > Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt > Use this file to discover all available pages before exploring further. # List package types > 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. ## Filters Filter with `q[_]=value`, for example `q[name_cont]=…`. Send a list as `q[_in][]=a&q[_in][]=b`. [How filters work](/docs/api-reference/admin-api/querying.md#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. ## OpenAPI ````yaml /api-reference/seller.yaml get /api/v3/seller/package_types openapi: 3.0.3 info: title: Seller API contact: name: Spree Commerce url: https://spreecommerce.org email: hello@spreecommerce.org 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 `. 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 servers: - url: http://{defaultHost} variables: defaultHost: default: localhost:3000 security: [] 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 paths: /api/v3/seller/package_types: get: tags: - Package Types summary: List package types 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. 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[_]=value`. See Filters above for the list. 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: null 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: null 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: null next: null schema: type: object properties: data: type: array items: $ref: '#/components/schemas/PackageType' meta: $ref: '#/components/schemas/PaginationMeta' required: - data - meta 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: packageTypes } = await client.packageTypes.list({ owner: 'mine' }) components: schemas: 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 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: null description: Previous page number next: type: integer nullable: true example: 2 description: Next page number required: - page - limit - count - pages - from - to - in securitySchemes: bearer_auth: type: http scheme: bearer bearerFormat: JWT description: JWT token for an authenticated seller session (`seller_api` audience) ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.