---
title: "GET /api/batches/{id}"
method: GET
path: "/api/batches/{id}"
tags: ["Products/Batches"]
---

# GET /api/batches/{id}

`GET /api/batches/{id}`

## Path parameters

- `id` string, required

## Response `200`

Default Response

- object
  - `metadata` object, required
    - `success` boolean, required — True when the request succeeded.
  - `data` object, required
    - `id` string, required
    - `name` string, required
    - `code` string, required
    - `creationDate` string, required
    - `quantity` number, required
    - `quantityUnit` string, required
    - `modelNumber` string
    - `description` string, required
    - `styleId` string, required
    - `entityData` object, required
      - `id` string, required
      - `forCompanyId` string
      - `name` string, required
      - `codes` object[], required
        - `codeId` string, required — Identifier type for the code. Single-use (each may appear at most once): ERP_ID, PLM_ID, MAIN_SUPPLIERS_ID, PIM_ID, UPC_GTIN_12, EAN_GTIN_13, ZALANDO_ID, FASHIONCLOUD_ID. Multi-use (append a numeric suffix for additional entries, e.g. OTHER_ID1, OTHER_ID2): OTHER_ID, ALTERNATIVE_SUPPLIERS_ID.
        - `codeValue` string, required — The unique code value for this identifier, e.g. "ERP-001234".
      - `description` string
      - `gender` string
      - `styleLevelId` string, required
      - `styleTypeId` string, required
      - `brands` string[]
      - `departments` string[]
      - `collections` string[]
      - `claimIntentions` string[]
      - `customProperties` string
      - `suppliers` string[]
      - `vendors` string[]
      - `isComponent` boolean
      - `createdAt` string
      - `createdByImpersonateId` string
      - `createdByUserId` string
      - `createdByCompanyId` string
      - `createdByApiKeyId` string
      - `createdByApiKeyLabel` string
      - `updatedAt` string
      - `updatedByImpersonateId` string
      - `updatedByUserId` string
      - `updatedByCompanyId` string
      - `updatedByApiKeyId` string
      - `updatedByApiKeyLabel` string
      - `mainSupplier` string
      - `imagesFileIds` string[]
      - `color` string
      - `dimension` string
      - `styleId` string
      - `overriddenFlag` string[]
      - `variantId` string
    - `bomData` object, required
      - `header` object, required
        - `id` string, required
        - `name` string, required
        - `effectiveStartDate` string, required
        - `effectiveEndDate` string, required
        - `version` number, required
      - `lines` object[], required
        - `id` string, required
        - `placementId` string, required
        - `quantity` number, required
        - `quantityUnit` string, required
        - `weight` number, required
        - `weightUnit` string, required
        - `countryOfOrigin` string, required
        - `styleId` string, required
        - `isMainComponent` boolean, required
        - `suppliers` string[]
        - `mainSupplier` string
        - `entity` object
          - `id` string, required
          - `forCompanyId` string, required
          - `name` string, required
          - `codes` object[], required
            - `codeId` string, required — Identifier type for the code. Single-use (each may appear at most once): ERP_ID, PLM_ID, MAIN_SUPPLIERS_ID, PIM_ID, UPC_GTIN_12, EAN_GTIN_13, ZALANDO_ID, FASHIONCLOUD_ID. Multi-use (append a numeric suffix for additional entries, e.g. OTHER_ID1, OTHER_ID2): OTHER_ID, ALTERNATIVE_SUPPLIERS_ID.
            - `codeValue` string, required — The unique code value for this identifier, e.g. "ERP-001234".
          - `description` string, required
        - `placement` object
          - `id` string, required
          - `value` string, required
          - `forCompanyId` string, required
          - `createdAt` union, required
            - string
            - string, date-time
          - `updatedAt` union, required
            - string
            - string, date-time
    - `materialData` object, required
      - `header` object, required
        - `id` string, required
        - `name` string, required
        - `description` string, required
      - `lines` object[], required
        - `id` string, required
        - `rawMaterialId` string, required
        - `percentage` number, required
        - `weights` number, required
        - `weightUnit` string, required
        - `parentId` string, required
        - `hierarchy` number, required
        - `position` number, required
        - `countriesOfOrigin` string[], required
    - `forCompanyId` string, required
    - `createdAt` string, date-time, required
    - `createdByUserId` string, required
    - `createdByCompanyId` string, required
    - `updatedAt` string, date-time, required
    - `updatedByUserId` string, required
    - `updatedByCompanyId` string, required

---

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