> ## 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. # Create or replace product nutrition header > Create the nutrition-facts header for a product, or update it in place when one already exists (the header is one-per-product). Nutrient rows are managed separately via the ``/nutrients`` endpoints. Requires the ``organization.contribute_organization`` permission on the membership. ## OpenAPI ````yaml /openapi/openapi-dashboard.json put /dashboard/api/v1/trade-items/{organization_id}/{gtin}/nutrition openapi: 3.1.0 info: title: Brand Dashboard API (Internal) version: 1.0.0 description: > Internal endpoints powering the brand dashboard UI. Not intended for external integrations — use the Products, Brands, and other public APIs instead. ## 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: [] externalDocs: description: Closient Documentation url: https://docs.closient.com paths: /dashboard/api/v1/trade-items/{organization_id}/{gtin}/nutrition: put: tags: - Nutrition summary: Create or replace product nutrition header description: >- Create the nutrition-facts header for a product, or update it in place when one already exists (the header is one-per-product). Nutrient rows are managed separately via the ``/nutrients`` endpoints. Requires the ``organization.contribute_organization`` permission on the membership. operationId: apps_dashboard_api_nutrition_put_nutrition parameters: - in: path name: organization_id schema: description: UUID of the organization that owns the product. format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Organization Id type: string required: true description: UUID of the organization that owns the product. - in: path name: gtin schema: description: >- GTIN-8/12/13/14 of the target product. Normalized to GTIN-14 by zero-padding before lookup. pattern: ^\d{8,14}$ title: Gtin type: string required: true description: >- GTIN-8/12/13/14 of the target product. Normalized to GTIN-14 by zero-padding before lookup. requestBody: content: application/json: schema: $ref: '#/components/schemas/NutritionHeaderIn' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NutritionOut' security: - APIKeyHeaderAuth: [] - OAuthTokenAuth: [] - SessionAuth: [] components: schemas: NutritionHeaderIn: description: Request body for creating or replacing a product's nutrition header. examples: - label_format: US_FDA serving_size: 1 cup (240ml) serving_size_g: 240 servings_per_container: 8 properties: serving_size: description: >- Free-text serving size as printed on the label (e.g. ``1 cup (240ml)``). examples: - 1 cup (240ml) maxLength: 100 title: Serving Size type: string serving_size_g: anyOf: - minimum: 0 type: number - type: 'null' description: >- Numeric serving size expressed in grams. Null when the label uses non-mass units (e.g. mL, count). examples: - 240 title: Serving Size G servings_per_container: anyOf: - minimum: 0 type: number - type: 'null' description: >- Number of declared servings per container. May be fractional (e.g. ``2.5``). examples: - 8 title: Servings Per Container label_format: allOf: - $ref: '#/components/schemas/LabelFormatEnum' default: US_FDA description: Regulatory format the panel is laid out for. Defaults to ``US_FDA``. examples: - US_FDA required: - serving_size title: NutritionHeaderIn type: object NutritionOut: description: >- Structured nutrition-facts panel for a product, including nutrient row ids. examples: - label_format: US_FDA nutrients: [] serving_size: 1 cup (240ml) serving_size_g: 240 servings_per_container: 8 properties: serving_size: description: >- Free-text serving size as printed on the label (e.g. ``1 cup (240ml)``). title: Serving Size type: string serving_size_g: anyOf: - minimum: 0 type: number - type: 'null' description: >- Numeric serving size expressed in grams. Null when the label uses non-mass units. title: Serving Size G servings_per_container: anyOf: - minimum: 0 type: number - type: 'null' description: Number of declared servings per container. May be fractional. title: Servings Per Container label_format: $ref: '#/components/schemas/LabelFormatEnum' description: Regulatory format the panel is laid out for. nutrients: description: >- Per-serving nutrient rows on the panel, in label order. Empty list when none recorded. items: $ref: '#/components/schemas/NutrientOut' title: Nutrients type: array required: - serving_size - label_format - nutrients title: NutritionOut type: object LabelFormatEnum: description: |- Regulatory format of a nutrition-facts label. Mirrors :class:`apps.products.models.LabelFormat`. Determines the regulator the label is laid out for; the same nutrient values may appear under different rounding/format rules across regimes. enum: - US_FDA - EU - CA_CFIA - AU_NZ - UK title: LabelFormatEnum type: string NutrientOut: description: A single nutrient row on a nutrition-facts label, with its row id. examples: - amount: 8 daily_value_pct: 10 id: keATfB8VP2gSjcnTbsMNQL name: Total Fat nutrient_type: TOTAL_FAT unit: G properties: id: description: >- URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (``xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx``). format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Id type: string nutrient_type: $ref: '#/components/schemas/NutrientTypeEnum' description: >- Canonical nutrient identifier. Stable across regulatory label formats. name: description: >- Localized display name for the nutrient (e.g. ``Total Fat``). Derived from ``nutrient_type``. title: Name type: string amount: description: >- Quantity of the nutrient per serving, in the units specified by ``unit``. minimum: 0 title: Amount type: number unit: $ref: '#/components/schemas/NutrientUnitEnum' description: Unit of measurement for ``amount``. daily_value_pct: anyOf: - minimum: 0 type: integer - type: 'null' description: >- Percent of the regulatory daily value covered by one serving. Null when not declared. title: Daily Value Pct required: - id - nutrient_type - name - amount - unit title: NutrientOut type: object NutrientTypeEnum: description: |- Canonical nutrient identifier on a nutrition-facts row. Mirrors :class:`apps.products.models.NutrientType`. Stable wire values across label formats (a US_FDA "Total Fat" row and an EU "Total Fat" row share ``TOTAL_FAT``). enum: - CALORIES - TOTAL_FAT - SATURATED_FAT - TRANS_FAT - CHOLESTEROL - SODIUM - TOTAL_CARBS - DIETARY_FIBER - TOTAL_SUGARS - ADDED_SUGARS - PROTEIN - VITAMIN_D - CALCIUM - IRON - POTASSIUM title: NutrientTypeEnum type: string NutrientUnitEnum: description: |- Unit of measurement for an individual nutrient row. Mirrors :class:`apps.products.models.NutrientUnit`. ``KCAL`` for calories; mass in ``G`` / ``MG`` / ``MCG``; ``IU`` for vitamin activity-equivalent doses. enum: - G - MG - MCG - KCAL - KJ - IU - ML title: NutrientUnitEnum type: string securitySchemes: APIKeyHeaderAuth: type: apiKey in: header name: X-API-Key OAuthTokenAuth: type: http scheme: bearer SessionAuth: type: apiKey in: cookie name: sessionid ````