> ## Documentation Index > Fetch the complete documentation index at: https://docs.closient.com/llms.txt > Use this file to discover all available pages before exploring further. # Archive a lot template > Archive a template so it can no longer generate runs until it is unarchived. ## OpenAPI ````yaml /openapi/openapi-products.json post /products/api/v1/lots/templates/{template_id}/archive/ openapi: 3.1.0 info: title: Products API version: 1.0.0 description: > Look up, claim, and browse GTINs in the Closient product repository. ## Authentication All endpoints require an API key passed via the `X-API-Key` HTTP header, unless otherwise noted. ``` X-API-Key: csb__ ``` Generate API keys in **Settings > API Keys** in your dashboard, or via the Account API. Session-based (cookie) authentication is also accepted for browser-based access. ## Rate Limits | Tier | Requests / minute | Requests / day | |-------------|-------------------|----------------| | Default | 300 | 10,000 | | Custom | Contact us | Contact us | Rate-limit headers are included on every response so callers can self-throttle without hitting our 429s ("informed governor"): - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400` - `RateLimit-Limit` — quota for the **most-restrictive** currently-active window - `RateLimit-Remaining` — requests left in that window - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew safe) Legacy `X-RateLimit-*` aliases are also emitted for back-compat. `X-RateLimit-Reset` keeps the absolute Unix-timestamp shape to avoid breaking existing consumers. When rate-limited, you receive `429 Too Many Requests` with a `retry_after_seconds` field in the error envelope and a `Retry-After` header. ## Pagination List endpoints return paginated results in this envelope: ```json { "data": [...], "pagination": { "page": 1, "page_size": 25, "total_count": 342, "total_pages": 14, "has_next": true, "has_previous": false } } ``` Use `?page=2&page_size=50` query parameters. Maximum page size is 100. ## Error Responses All errors conform to [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) with `Content-Type: application/problem+json`: ```json { "type": "https://closient.com/docs/errors/not_found", "title": "Not Found", "status": 404, "detail": "The requested resource was not found.", "error_code": "not_found", "retryable": false, "timestamp": "2026-03-31T12:00:00+00:00" } ``` Common error codes: `unauthorized` (401), `forbidden` (403), `not_found` (404), `validation_error` (422), `rate_limited` (429), `internal_error` (500). termsOfService: https://www.closient.com/terms/ servers: - url: https://www.closient.com security: [] tags: - name: Products description: Look up, claim, and browse products and trade items. - name: Product Group description: Manage GDSN packaging hierarchy relationships. - name: Import description: Bulk import products from CSV files. - name: QR description: Generate QR codes encoding GS1 Digital Link URLs. - name: Codes description: Generate GS1 DataMatrix and 1D barcodes (EAN/UPC/ITF-14/Code128). - name: Digital Link description: >- Parse GS1 Digital Link URIs into structured AIs (GTIN, lot, expiry, serial). - name: Labels description: >- Bulk label-export jobs: ZIPs of QR / DataMatrix / 1D symbols and multi-up sheet PDFs, async via Celery with status polling. - name: Lots description: >- Lot generator v2: format templates with persistent counters, reserve/commit/discard runs, soft/hard collision handling, and an async Celery path with SSE progress. externalDocs: description: Closient Documentation url: https://docs.closient.com paths: /products/api/v1/lots/templates/{template_id}/archive/: post: tags: - Lots summary: Archive a lot template description: >- Archive a template so it can no longer generate runs until it is unarchived. operationId: apps_products_api_lots_archive_lot_template parameters: - in: path name: template_id schema: description: Template id (UUID or 22-char shortuuid). title: Template Id type: string required: true description: Template id (UUID or 22-char shortuuid). responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LotTemplateOut' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorOut' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorOut' '422': description: Unprocessable Content content: application/json: schema: $ref: '#/components/schemas/ErrorOut' security: - APIKeyHeaderAuth: [] - OAuthTokenAuth: [] - SessionAuth: [] components: schemas: LotTemplateOut: description: A saved generation recipe (latest version). examples: - character_set: GS1_AI82 check_digit_algorithm: none created: '2026-05-02T10:00:00Z' description: Daily lot codes for the Tomato Sauce line. format_string: LOT-{YYYY}{JJJ}-{####} id: AbCdEfGhIjKlMnOpQrStUv is_archived: false max_collision_retries: 5 modified: '2026-05-02T10:00:00Z' name: Default Lot reset_condition: daily scope_kind: per_product starting_value: 1 target_field: lot version: 1 properties: id: description: >- Template id (22-char shortuuid). Use in `/lots/templates/{id}/` paths. title: Id type: string name: description: Human-readable template name. title: Name type: string description: default: '' description: Optional free-text notes. title: Description type: string target_field: $ref: '#/components/schemas/LotTargetFieldEnum' description: Which GS1 field the identifiers populate. format_string: description: >- Token format, e.g. `LOT-{YYYY}{JJJ}-{####}` renders as `LOT-2026123-0001`. title: Format String type: string character_set: description: Alphabet identifier or literal characters. Defaults to GS1 AI 82. title: Character Set type: string check_digit_algorithm: $ref: '#/components/schemas/LotCheckDigitAlgorithmEnum' description: Optional check character appended after token expansion. reset_condition: $ref: '#/components/schemas/LotResetConditionEnum' description: When the counter resets to its starting value. reset_threshold: anyOf: - type: integer - type: 'null' description: >- Counter value that triggers a reset when `reset_condition=on_count_reached`. title: Reset Threshold scope_kind: $ref: '#/components/schemas/LotScopeKindEnum' description: How the counter is partitioned (the scope_key shape). starting_value: description: Counter value used after a reset (first sequence emitted). title: Starting Value type: integer max_collision_retries: description: >- Soft-retry budget per identifier for random-source tokens before a hard collision. title: Max Collision Retries type: integer version: description: >- Current template version. Bumps on a format-affecting edit while in use. title: Version type: integer parent_template_id: anyOf: - type: string - type: 'null' description: >- Reserved for row-per-version chains; null in the current in-place versioning scheme. title: Parent Template Id is_archived: description: Archived templates cannot generate until unarchived. title: Is Archived type: boolean created: description: Creation timestamp (ISO-8601). format: date-time title: Created type: string modified: description: Last-modified timestamp (ISO-8601). format: date-time title: Modified type: string required: - id - name - target_field - format_string - character_set - check_digit_algorithm - reset_condition - scope_kind - starting_value - max_collision_retries - version - is_archived - created - modified title: LotTemplateOut type: object ErrorOut: description: |- RFC 9457 Problem Details response. All API errors are returned in this format with Content-Type: application/problem+json. examples: - detail: The requested resource was not found. error_code: not_found retryable: false status: 404 timestamp: '2026-03-31T12:00:00+00:00' title: Not Found type: https://closient.com/docs/errors/not_found - detail: Validation error. details: - loc: - body - name msg: Field required type: missing error_code: validation_error retryable: false status: 422 timestamp: '2026-03-31T12:00:00+00:00' title: Validation Error type: https://closient.com/docs/errors/validation_error - detail: Rate limit exceeded. Please try again later. error_code: rate_limited retry_after: 31 retryable: true status: 429 timestamp: '2026-03-31T12:00:00+00:00' title: Rate Limited type: https://closient.com/docs/errors/rate_limited properties: type: description: URI reference identifying the error type. title: Type type: string title: description: Short human-readable summary of the error. title: Title type: string status: description: HTTP status code. title: Status type: integer detail: description: Human-readable explanation of this specific occurrence. title: Detail type: string error_code: description: Machine-readable error code (e.g. not_found, unauthorized). title: Error Code type: string retryable: default: false description: Whether retrying the same request can succeed. title: Retryable type: boolean timestamp: description: ISO 8601 timestamp of when the error occurred. title: Timestamp type: string retry_after: anyOf: - type: integer - type: 'null' description: Seconds to wait before retrying (when applicable). title: Retry After owner_action_required: anyOf: - type: boolean - type: 'null' description: Whether the error requires account owner intervention. title: Owner Action Required details: description: Additional context (validation errors, etc.). title: Details required: - type - title - status - detail - error_code - timestamp title: ErrorOut type: object LotTargetFieldEnum: description: >- Which GS1 field a template's identifiers populate. Mirrors :class:`apps.products.models.TargetField`. ``lot`` = AI(10) batch/lot number (the only target the run service reserves today); ``serial`` = AI(21) serial number (separate surface, C-2712). enum: - lot - serial title: LotTargetFieldEnum type: string LotCheckDigitAlgorithmEnum: description: >- Optional check character appended after token expansion. Mirrors :class:`apps.products.models.CheckDigitAlgorithm`. ``mod10`` is the GS1 weighted mod-10 (digits only); ``iso7064_11_2`` is ISO 7064 mod 11,2 over the GS1 AI 82 charset (0-9 or ``X``). enum: - none - mod10 - iso7064_11_2 title: LotCheckDigitAlgorithmEnum type: string LotResetConditionEnum: description: >- When a template's counter resets to its starting value. Mirrors :class:`apps.products.models.ResetCondition`. ``on_count_reached`` requires ``reset_threshold``; ``manual`` never auto-resets. enum: - never - daily - weekly - monthly - on_product_change - on_count_reached - manual title: LotResetConditionEnum type: string LotScopeKindEnum: description: >- How a template's counter is partitioned (the ``scope_key`` shape). Mirrors :class:`apps.products.models.ScopeKind`. ``global`` shares one counter; ``per_product`` keys on GTIN; ``per_product_per_date_bucket`` keys on ``GTIN|YYYY-MM-DD``; ``tag`` keys on a caller-supplied tag. enum: - global - per_product - per_product_per_date_bucket - tag title: LotScopeKindEnum type: string securitySchemes: APIKeyHeaderAuth: type: apiKey in: header name: X-API-Key OAuthTokenAuth: type: http scheme: bearer SessionAuth: type: apiKey in: cookie name: sessionid ````