---
title: "🔒 View production V3"
method: GET
path: "/api/v3/productions/{id}"
tags: ["Production"]
---

# 🔒 View production V3

`GET /api/v3/productions/{id}`

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: `production:read`.

View a single production.

## Path parameters

- `id` string, required

## Query parameters

- `include` string[]

## Response `200`

View a single production.

- object
  - `data` object — Production document
    - `id` string — ID of the production
    - `documentNumber` string — Production document number. For drafts, this will be null.
    - `documentDate` string, date — Main date date of the production document
    - `status` 'draft' | 'started' | 'released' | 'completed' | 'cancelled' — Status of the production document
    - `writeProtection` boolean — Indicates if the production is write protected
    - `address` union — Address entity of the production. By default, only the ID is returned. To get the full Address object, use the `include` parameter.
      - object
        - `id` string, required
        - `isDeleted` boolean — Flagged if the entry was deleted.
        - `createdAt` string, date-time, required — Creation timestamp
        - `updatedAt` string, date-time, required — Last update timestamp
      - object
        - `id` string
    - `project` union — Project entity of the production. By default, only the ID is returned. To get the full Project object, use the `include` parameter.
      - object
        - `id` string, required
        - `name` string, required
        - `abbreviation` string, required
      - object
        - `id` string
    - `salesOrder` object — Sales order reference associated with the production
      - `id` string
    - `produceProduct` union — Product entity to be produced. By default, only the ID is returned. To get the full Product object, use the `include` parameter.
      - object
        - `id` string, required
        - `number` unknown, required
        - `createdAt` string, date-time — Creation timestamp
        - `updatedAt` string, date-time — Last update timestamp
      - object
        - `id` string
    - `produceQuantity` unknown
    - `tags` string[] — Tags for categorizing the production
    - `internalDesignation` string — Internal designation
    - `materials` object[] — Materials (line items) for the production. By default, this is not loaded. Use the `include` parameter to load.
      - `id` string — ID of the line item
      - `number` string — The Number of the material. Usually the product SKU, but can be adjusted if required.
      - `name` string — The name of the material Usually the product name, but can be adjusted if required.
      - `description` string — The description of the material. Usually the product description, but can be adjusted if required.
      - `quantity` number, float — The quantity of the material
      - `product` object — The product of the line item
      - `hasChildLineItems` boolean — Indicates if this line item has child line items (exploded line items)
      - `parentLineItem` object — If this line item is a child line item, this will contain the parent line item ID
        - `id` string
      - `sort` integer — The sort order of the line item
      - `updatedAt` string, date-time — The date and time when the line item was last updated
      - `createdAt` string, date-time — The date and time when the line item was created
    - `materialReservation` string — Material reservation method
    - `materialRetrieval` string — Material retrieval method
    - `resolveMultiLevelBOM` boolean — Whether to resolve multi-level bill of materials
    - `functionTest` boolean — Whether function testing is required
    - `createSerialNumbers` boolean — Whether to create serial numbers
    - `recordSubSerialNumbers` boolean — Whether to record sub-serial numbers
    - `stockRetrievalDate` string, date — Stock retrieval date
    - `stockProvisioningDate` string, date — Stock provisioning date
    - `productionStartDate` string, date — Production start date
    - `productionEndDate` string, date — Production end date
    - `bodyText` string — Body text for production notes
    - `internalComment` string — Internal comment
    - `printSettings` object — Print settings configuration
      - `showTaskDescription` boolean — Whether to show task descriptions when printing
    - `preferredWarehouse` object — Preferred warehouse for the production. If set, only stock from this warehouse is considered for stock reservations, and the production cannot be started if the selected warehouse does not have sufficient stock.
      - `id` string
    - `activity` object[] — Activity log entries for the production. By default, this is not loaded. Use the `include` parameter to load.
      - `message` string, required
      - `causer` string, required
      - `causedAt` string, date-time, required
    - `updatedAt` string, date-time — Timestamp of the last update
    - `createdAt` string, date-time — Timestamp of creation

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `429` — Too Many Requests

---

[API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/revisions/8a27ba392442/schema)