> ## Documentation Index
> Fetch the complete documentation index at: https://docs.joinluminous.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a carton template

> Update an existing carton template. Every field is optional — send only the fields you
intend to change. `name`, if provided, must remain unique among non-deleted cartons.

This endpoint also accepts `PATCH /carton-templates/{cartonTemplateId}`.




## OpenAPI

````yaml /api-reference/build.yaml put /carton-templates/{cartonTemplateId}
openapi: 3.0.0
info:
  title: Luminous API
  version: 1.0.0
  description: API documentation for Luminous
servers:
  - url: https://{companyName}.api.joinluminous.com/external/api/v1
    variables:
      companyName:
        default: companyName
        description: Your company-specific subdomain
security: []
tags:
  - name: Products
    description: Get and manage products
  - name: Pricing
    description: Manage price schedules, levels, and customizations
  - name: BOMs
    description: Manage Bills of Materials (BOMs)
  - name: Labels
    description: Label rendering via Labelary ZPL service
  - name: Companies
    description: Manage business accounts and their associated data
  - name: Contacts
    description: Manage contact information for individuals
  - name: Suppliers
    description: Manage suppliers (factories) — vendors used on purchase orders
  - name: Supplier SKUs
    description: Manage per-supplier SKU and unit-cost overrides for products
  - name: Locations
    description: Manage warehouses and locations
  - name: Inventory
    description: Get and adjust product stock levels
  - name: Lots
    description: Create, update, and delete product lots (batches)
  - name: Transfer Orders
    description: Manage transfer orders
  - name: Fulfillment Orders
    description: Manage fulfillment orders and picklists
  - name: Fulfillment Priority Lists
    description: Configure fulfillment routing priority lists
  - name: Purchase Orders
    description: Get and modify purchase orders
  - name: Supplier Portal
    description: >-
      Read a supplier's response to a purchase order and control the one-click
      portal link
  - name: Receiving Reports
    description: Manage receiving reports
  - name: Payment Obligations
    description: Manage payment obligations for purchase orders
  - name: Sales Orders
    description: Manage sales orders and sales order shipments
  - name: Purgatory
    description: >-
      Inspect and resolve non-posted sales orders in the purgatory staging
      workflow
  - name: PickFlow Shipping
    description: >-
      Provider-agnostic shipping rates, services, packages, and label purchase
      for PickFlow
  - name: Cycle Counts
    description: >-
      Create, drive, and post PickFlow cycle counts — batches, per-warehouse
      sessions, and CSV import/export
  - name: Print Stations
    description: List paired print stations and enqueue print jobs to them
  - name: Invoices
    description: Get and manage invoices
  - name: Work Orders
    description: >-
      Manage work orders — production lifecycle, steps, materials, links,
      shipments, and comments
  - name: Production Batches
    description: Group and manage work orders as production batches
  - name: Bills
    description: >-
      Accounts payable bill management, payments, attachments, allocations, and
      variance
  - name: Prepayments
    description: Manage vendor prepayments and applications
  - name: Vendor Credits
    description: Manage vendor credits and applications
  - name: Vendor Returns
    description: Manage vendor returns and credit generation
  - name: Customer Returns
    description: Manage customer returns (sales returns), receiving, and restock behavior
  - name: Stock Snapshot
    description: Point-in-time stock snapshots with export support
  - name: Consumption
    description: Consumption reports and exports
  - name: Inventory Aging
    description: Cost-layer-based inventory aging reports
  - name: Bills Reports
    description: Accounts payable bills aging reports
  - name: Forecast
    description: Materialized forecast data
  - name: Reports
    description: Close the books, inventory discrepancy, transaction COGS, and EDI reports
  - name: Tags
    description: Add/remove tags across various resources
  - name: Custom Fields
    description: Get and set custom fields across various resources
  - name: Currency
    description: Currency configuration, exchange rates, and conversion
  - name: Integration Mappings
    description: Manage integration mappings for external systems
  - name: Integration Field Mappings
    description: Manage field-level mappings between Luminous and external systems
paths:
  /carton-templates/{cartonTemplateId}:
    put:
      tags:
        - Carton Templates
      summary: Update a carton template
      description: >
        Update an existing carton template. Every field is optional — send only
        the fields you

        intend to change. `name`, if provided, must remain unique among
        non-deleted cartons.


        This endpoint also accepts `PATCH /carton-templates/{cartonTemplateId}`.
      operationId: updateCartonTemplate
      parameters:
        - in: path
          name: cartonTemplateId
          required: true
          schema:
            type: integer
          description: Carton template ID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >
                Create/update payload for a carton template. On create, only
                `name` is required; all other

                fields fall back to their column defaults. On update every field
                is optional — send only the

                fields you intend to change.
              properties:
                name:
                  type: string
                  maxLength: 255
                  description: >-
                    Carton name (unique among non-deleted templates). Required
                    on create.
                type:
                  type: string
                  enum:
                    - box
                    - envelope
                    - custom
                  description: Container type. Defaults to `box`.
                inner_length_in:
                  type: number
                  format: float
                  nullable: true
                  minimum: 0
                  description: Usable interior length, in inches.
                inner_width_in:
                  type: number
                  format: float
                  nullable: true
                  minimum: 0
                  description: Usable interior width, in inches.
                inner_height_in:
                  type: number
                  format: float
                  nullable: true
                  minimum: 0
                  description: Usable interior height, in inches.
                tare_weight_oz:
                  type: number
                  format: float
                  nullable: true
                  minimum: 0
                  description: The empty carton's own weight, in ounces.
                max_weight_oz:
                  type: number
                  format: float
                  nullable: true
                  minimum: 0
                  description: Maximum content weight the carton can hold, in ounces.
                cost:
                  type: number
                  format: float
                  nullable: true
                  minimum: 0
                  description: Cost of the carton itself.
                fill_limit_pct:
                  type: integer
                  nullable: true
                  minimum: 1
                  maximum: 100
                  description: >-
                    Maximum fill (1–100) of the carton's volume the engine will
                    pack. Defaults to `100`.
                allowed_packing_classes:
                  type: array
                  nullable: true
                  items:
                    type: string
                  description: >-
                    List of packing-class values this carton accepts. `null` (or
                    omitted) means any class.
                requires_dry_ice:
                  type: boolean
                  description: >-
                    Whether shipments packed in this carton require dry ice.
                    Defaults to `false`.
                dry_ice_weight_oz:
                  type: number
                  format: float
                  nullable: true
                  minimum: 0
                  description: Weight of dry ice to add, in ounces.
                default_package_code:
                  type: string
                  maxLength: 255
                  nullable: true
                  description: >-
                    Carrier package-type code used when buying a label for this
                    carton.
                priority:
                  type: integer
                  description: >-
                    Selection priority. Higher-priority cartons are preferred by
                    the engine. Defaults to `0`.
                is_active:
                  type: boolean
                  description: >-
                    Whether the carton is active and available for
                    cartonization. Defaults to `true`.
            example:
              priority: 20
              is_active: false
      responses:
        '200':
          description: Carton template updated.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    description: >
                      A carton template — a shipping box, envelope, or
                      packer-custom container in the carton

                      catalog that the cartonization engine can choose from when
                      packing a shipment. Dimensions

                      are stored in inches and weights in ounces.
                    properties:
                      id:
                        type: integer
                        description: Unique identifier for the carton template.
                      name:
                        type: string
                        description: Carton name (unique among non-deleted templates).
                      type:
                        type: string
                        enum:
                          - box
                          - envelope
                          - custom
                        description: Container type. Defaults to `box`.
                      inner_length_in:
                        type: number
                        format: float
                        nullable: true
                        description: Usable interior length, in inches.
                      inner_width_in:
                        type: number
                        format: float
                        nullable: true
                        description: Usable interior width, in inches.
                      inner_height_in:
                        type: number
                        format: float
                        nullable: true
                        description: Usable interior height, in inches.
                      tare_weight_oz:
                        type: number
                        format: float
                        nullable: true
                        description: The empty carton's own weight, in ounces.
                      max_weight_oz:
                        type: number
                        format: float
                        nullable: true
                        description: Maximum content weight the carton can hold, in ounces.
                      cost:
                        type: number
                        format: float
                        nullable: true
                        description: Cost of the carton itself.
                      fill_limit_pct:
                        type: integer
                        nullable: true
                        description: >-
                          Maximum fill (1–100) of the carton's volume the engine
                          will pack. Defaults to `100`.
                      allowed_packing_classes:
                        type: array
                        nullable: true
                        items:
                          type: string
                        description: >-
                          List of packing-class values this carton accepts.
                          `null` means any class is allowed.
                      requires_dry_ice:
                        type: boolean
                        description: >-
                          Whether shipments packed in this carton require dry
                          ice.
                      dry_ice_weight_oz:
                        type: number
                        format: float
                        nullable: true
                        description: Weight of dry ice to add, in ounces.
                      default_package_code:
                        type: string
                        nullable: true
                        description: >-
                          Carrier package-type code used when buying a label for
                          this carton.
                      priority:
                        type: integer
                        description: >-
                          Selection priority. Higher-priority cartons are
                          preferred by the engine. Defaults to `0`.
                      is_active:
                        type: boolean
                        description: >-
                          Whether the carton is active and available for
                          cartonization. Defaults to `true`.
                      created_at:
                        type: string
                        format: date-time
                        nullable: true
                      updated_at:
                        type: string
                        format: date-time
                        nullable: true
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: Carton template not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '422':
          description: Validation error — e.g. duplicate `name` or an invalid `type`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate using a bearer token. To create a token, navigate to
        /settings/api-tokens and click Create API Token.

````