> ## 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. # Create a package type > Adds a kind of packaging to the store. `weight` is the empty package's own weight, added to content weight on every quote; `max_weight` is what it can hold. Setting `default` makes this the box every parcel quote is built on, and demotes whichever row held that before. A variant references a `carton`-kind row to say what it is packed into; other kinds are the merchant's own vocabulary. **Required scope:** `write_package_types` (for API-key authentication). ## OpenAPI ````yaml /api-reference/admin.yaml post /api/v3/admin/package_types openapi: 3.0.3 info: title: Admin API contact: name: Spree Commerce url: https://spreecommerce.org email: hello@spreecommerce.org description: > Spree Admin API v3 - Administrative API for managing products, orders, and store settings. ## Authentication The Admin API requires a secret API key passed in the `x-spree-api-key` header. Secret API keys can be generated in the Spree admin dashboard. ## Response Format All responses are JSON. List endpoints return paginated responses with `data` and `meta` keys. Single resource endpoints return a flat JSON object. ## Resource IDs Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`, `variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths, request bodies, and Ransack filters all accept them directly. ## 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: Admin user login, logout, token refresh, and current user profile - name: Allowed Origins description: CORS allowlist for storefront and admin client origins - name: API Keys description: Secret and publishable API keys - name: Categories description: >- Hierarchical product categories — tree management, repositioning, and product assignments - name: Channels description: >- Sales channels, product publication across channels, and per-channel order routing rules - name: Custom Fields description: >- Custom field definitions for products, variants, customers, and other resources - name: Customer Groups description: >- Customer groups for segmenting customers (e.g. wholesale, VIP) used by pricing and promotions - name: Customers description: Customer profiles, addresses, credit cards, and store credits - name: Email Templates description: >- Customer email templates, the email layout and shared partials: drafts, previews, publishing and history - name: Exports description: Async CSV exports of admin resources - name: Files description: Uploading the files that product media, imports, logos and documents use - name: Fulfillments description: Order fulfillments — shipments, fulfill, cancel, resume, split - name: Gift Cards description: Gift cards and gift card batches - name: Imports description: >- Async CSV imports of admin resources, with per-row status and failed-row retry - name: Markets description: >- Markets — geographic groupings of countries used for pricing, tax, and fulfillment rules - name: Option Types description: >- Option types and option values used to build product variants (e.g. Size, Color) - name: Orders description: Orders, order items, applied gift cards, and applied store credits - name: Payment Methods description: Configured payment providers and their available types - name: Payments description: Order payments — list, capture, void - name: Pricing description: >- Prices and price lists for currency-, market-, and customer-group-specific pricing - name: Products description: >- Products, taxons/categories, product custom field values, and bulk product operations - name: Policies description: The store's legal documents — terms of service, privacy, returns, shipping - name: Reasons description: >- Merchant-owned vocabularies for why a return, claim, refund, cancellation or tax exemption happened - name: Promotions description: Promotions, promotion rules, promotion actions, and coupon codes - name: Refunds description: Order refunds - name: Settings description: Store-level settings — store profile, tags, and configuration - name: Staff description: Admin users, roles, and invitations to the store - name: Stock Locations description: Warehouses and physical fulfillment locations - name: Store Credits description: Prepaid customer balances across all customers, and each balance's ledger - name: Variants description: >- Product variants — the individual SKUs (size/color combinations) sold under a product - name: Webhooks description: Webhook endpoints and webhook delivery history paths: /api/v3/admin/package_types: post: tags: - Package Types summary: Create a package type description: |- Adds a kind of packaging to the store. `weight` is the empty package's own weight, added to content weight on every quote; `max_weight` is what it can hold. Setting `default` makes this the box every parcel quote is built on, and demotes whichever row held that before. A variant references a `carton`-kind row to say what it is packed into; other kinds are the merchant's own vocabulary. **Required scope:** `write_package_types` (for API-key authentication). parameters: - name: x-spree-api-key in: header required: true schema: type: string - name: Authorization in: header required: true description: Bearer token for admin authentication schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PackageTypeCreateParams' required: true responses: '201': description: package type created content: application/json: example: id: pkgtype_gbHJdmfrXB name: Euro pallet kind: pallet length: '120.0' width: '80.0' height: '15.0' weight: null max_weight: null default: false metadata: {} created_at: '2026-01-15T12:00:00.000Z' updated_at: '2026-01-15T12:00:00.000Z' dimensions_unit: cm weight_unit: lb volume: '0.144' seller_id: null seller_name: null 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: - value: crate code: inclusion message: is not included in the list specific: false schema: $ref: '#/components/schemas/ErrorResponse' security: - api_key: [] bearer_auth: [] x-codeSamples: - lang: javascript label: Spree Admin SDK source: |- import { createAdminClient } from '@spree/admin-sdk' const client = createAdminClient({ baseUrl: 'https://your-store.com', secretKey: 'sk_xxx', }) const carton = await client.packageTypes.create({ name: 'Master carton', kind: 'carton', length: 40, width: 30, height: 25, dimensions_unit: 'cm', max_weight: 20, weight_unit: 'kg', }) - lang: bash label: Spree CLI source: >- spree api post /package_types -d '{"name":"Master carton","kind":"carton","length":40,"width":30,"height":25,"dimensions_unit":"cm","max_weight":20,"weight_unit":"kg"}' components: schemas: PackageTypeCreateParams: type: object properties: name: type: string description: Unique within the store. example: Euro pallet kind: type: string enum: - box - envelope - carton - pallet - container description: >- What this packaging is: the box parcels ship in, or the carton, pallet or container a wholesale order leaves on. example: pallet length: type: number nullable: true width: type: number nullable: true height: type: number nullable: true dimensions_unit: allOf: - $ref: '#/components/schemas/DimensionUnit' description: >- Unit the three dimensions are in; falls back to the store's unit system. example: cm nullable: true weight: type: number description: >- The empty package's own weight, added to content weight on every quote. nullable: true max_weight: type: number description: What the package can hold, not the same as its own weight. nullable: true weight_unit: allOf: - $ref: '#/components/schemas/WeightUnit' example: kg nullable: true default: type: boolean description: >- The box every parcel quote is built on. Setting this demotes whichever row held it. metadata: type: object additionalProperties: true required: - name - kind 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 seller_id: type: string nullable: true seller_name: type: string nullable: true required: - id - name - kind - length - width - height - weight - max_weight - default - metadata - created_at - updated_at - dimensions_unit - weight_unit - volume - seller_id - seller_name x-typelizer: true 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 DimensionUnit: type: string enum: - mm - cm - in - ft WeightUnit: type: string enum: - g - kg - lb - oz securitySchemes: api_key: type: apiKey name: x-spree-api-key in: header description: Secret API key for admin access bearer_auth: type: http scheme: bearer bearerFormat: JWT description: JWT token for admin user authentication ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.