---
displayed_sidebar: productReference
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# ProductDTO

A product's data.

<ParameterTypes parameters={[
  {
    "name": "categories",
    "type": "`null` \\| [ProductCategoryDTO](product.ProductCategoryDTO.mdx)[]",
    "description": "The associated product categories.",
    "optional": true,
    "defaultValue": "",
    "expandable": true,
    "children": []
  },
  {
    "name": "collection",
    "type": "[ProductCollectionDTO](product.ProductCollectionDTO.mdx)",
    "description": "The associated product collection.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": [
      {
        "name": "deleted_at",
        "type": "`string` \\| `Date`",
        "description": "When the product collection was deleted.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "handle",
        "type": "`string`",
        "description": "The handle of the product collection. The handle can be used to create slug URL paths.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "The ID of the product collection.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "metadata",
        "type": "`null` \\| `Record<string, unknown>`",
        "description": "Holds custom data in key-value pairs.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "products",
        "type": "[ProductDTO](product.ProductDTO.mdx)[]",
        "description": "The associated products.",
        "optional": true,
        "defaultValue": "",
        "expandable": true,
        "children": [
          {
            "name": "categories",
            "type": "`null` \\| [ProductCategoryDTO](product.ProductCategoryDTO.mdx)[]",
            "description": "The associated product categories.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "collection",
            "type": "[ProductCollectionDTO](product.ProductCollectionDTO.mdx)",
            "description": "The associated product collection.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "created_at",
            "type": "`string` \\| `Date`",
            "description": "When the product was created.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "deleted_at",
            "type": "`string` \\| `Date`",
            "description": "When the product was deleted.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "description",
            "type": "`null` \\| `string`",
            "description": "The description of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "discountable",
            "type": "`boolean`",
            "description": "Whether the product can be discounted.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "external_id",
            "type": "`null` \\| `string`",
            "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "handle",
            "type": "`null` \\| `string`",
            "description": "The handle of the product. The handle can be used to create slug URL paths.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "height",
            "type": "`null` \\| `number`",
            "description": "The height of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "hs_code",
            "type": "`null` \\| `string`",
            "description": "The HS Code of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "The ID of the product.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "images",
            "type": "[ProductImageDTO](product.ProductImageDTO.mdx)[]",
            "description": "The associated product images.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "is_giftcard",
            "type": "`boolean`",
            "description": "Whether the product is a gift card.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "length",
            "type": "`null` \\| `number`",
            "description": "The length of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "material",
            "type": "`null` \\| `string`",
            "description": "The material of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "metadata",
            "type": "`Record<string, unknown>`",
            "description": "Holds custom data in key-value pairs.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "mid_code",
            "type": "`null` \\| `string`",
            "description": "The MID Code of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "options",
            "type": "[ProductOptionDTO](product.ProductOptionDTO.mdx)[]",
            "description": "The associated product options.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "origin_country",
            "type": "`null` \\| `string`",
            "description": "The origin country of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "status",
            "type": "[ProductStatus](../enums/product.ProductStatus.mdx)",
            "description": "The status of the product.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "subtitle",
            "type": "`null` \\| `string`",
            "description": "The subttle of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "tags",
            "type": "[ProductTagDTO](product.ProductTagDTO.mdx)[]",
            "description": "The associated product tags.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "thumbnail",
            "type": "`null` \\| `string`",
            "description": "The URL of the product's thumbnail.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "title",
            "type": "`string`",
            "description": "The title of the product.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "type",
            "type": "[ProductTypeDTO](product.ProductTypeDTO.mdx)[]",
            "description": "The associated product type.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "updated_at",
            "type": "`string` \\| `Date`",
            "description": "When the product was updated.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "variants",
            "type": "[ProductVariantDTO](product.ProductVariantDTO.mdx)[]",
            "description": "The associated product variants.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "weight",
            "type": "`null` \\| `number`",
            "description": "The weight of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "width",
            "type": "`null` \\| `number`",
            "description": "The width of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      },
      {
        "name": "title",
        "type": "`string`",
        "description": "The title of the product collection.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "created_at",
    "type": "`string` \\| `Date`",
    "description": "When the product was created.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "deleted_at",
    "type": "`string` \\| `Date`",
    "description": "When the product was deleted.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "description",
    "type": "`null` \\| `string`",
    "description": "The description of the product.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "discountable",
    "type": "`boolean`",
    "description": "Whether the product can be discounted.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "external_id",
    "type": "`null` \\| `string`",
    "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "handle",
    "type": "`null` \\| `string`",
    "description": "The handle of the product. The handle can be used to create slug URL paths.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "height",
    "type": "`null` \\| `number`",
    "description": "The height of the product.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "hs_code",
    "type": "`null` \\| `string`",
    "description": "The HS Code of the product.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "id",
    "type": "`string`",
    "description": "The ID of the product.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "images",
    "type": "[ProductImageDTO](product.ProductImageDTO.mdx)[]",
    "description": "The associated product images.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": [
      {
        "name": "deleted_at",
        "type": "`string` \\| `Date`",
        "description": "When the product image was deleted.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "The ID of the product image.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "metadata",
        "type": "`null` \\| `Record<string, unknown>`",
        "description": "Holds custom data in key-value pairs.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "url",
        "type": "`string`",
        "description": "The URL of the product image.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "is_giftcard",
    "type": "`boolean`",
    "description": "Whether the product is a gift card.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "length",
    "type": "`null` \\| `number`",
    "description": "The length of the product.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "material",
    "type": "`null` \\| `string`",
    "description": "The material of the product.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "metadata",
    "type": "`Record<string, unknown>`",
    "description": "Holds custom data in key-value pairs.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "mid_code",
    "type": "`null` \\| `string`",
    "description": "The MID Code of the product.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "options",
    "type": "[ProductOptionDTO](product.ProductOptionDTO.mdx)[]",
    "description": "The associated product options.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": [
      {
        "name": "deleted_at",
        "type": "`string` \\| `Date`",
        "description": "When the product option was deleted.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "The ID of the product option.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "metadata",
        "type": "`null` \\| `Record<string, unknown>`",
        "description": "Holds custom data in key-value pairs.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "product",
        "type": "[ProductDTO](product.ProductDTO.mdx)",
        "description": "The associated product.",
        "optional": false,
        "defaultValue": "",
        "expandable": true,
        "children": [
          {
            "name": "categories",
            "type": "`null` \\| [ProductCategoryDTO](product.ProductCategoryDTO.mdx)[]",
            "description": "The associated product categories.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "collection",
            "type": "[ProductCollectionDTO](product.ProductCollectionDTO.mdx)",
            "description": "The associated product collection.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "created_at",
            "type": "`string` \\| `Date`",
            "description": "When the product was created.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "deleted_at",
            "type": "`string` \\| `Date`",
            "description": "When the product was deleted.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "description",
            "type": "`null` \\| `string`",
            "description": "The description of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "discountable",
            "type": "`boolean`",
            "description": "Whether the product can be discounted.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "external_id",
            "type": "`null` \\| `string`",
            "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "handle",
            "type": "`null` \\| `string`",
            "description": "The handle of the product. The handle can be used to create slug URL paths.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "height",
            "type": "`null` \\| `number`",
            "description": "The height of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "hs_code",
            "type": "`null` \\| `string`",
            "description": "The HS Code of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "The ID of the product.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "images",
            "type": "[ProductImageDTO](product.ProductImageDTO.mdx)[]",
            "description": "The associated product images.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "is_giftcard",
            "type": "`boolean`",
            "description": "Whether the product is a gift card.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "length",
            "type": "`null` \\| `number`",
            "description": "The length of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "material",
            "type": "`null` \\| `string`",
            "description": "The material of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "metadata",
            "type": "`Record<string, unknown>`",
            "description": "Holds custom data in key-value pairs.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "mid_code",
            "type": "`null` \\| `string`",
            "description": "The MID Code of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "options",
            "type": "[ProductOptionDTO](product.ProductOptionDTO.mdx)[]",
            "description": "The associated product options.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "origin_country",
            "type": "`null` \\| `string`",
            "description": "The origin country of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "status",
            "type": "[ProductStatus](../enums/product.ProductStatus.mdx)",
            "description": "The status of the product.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "subtitle",
            "type": "`null` \\| `string`",
            "description": "The subttle of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "tags",
            "type": "[ProductTagDTO](product.ProductTagDTO.mdx)[]",
            "description": "The associated product tags.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "thumbnail",
            "type": "`null` \\| `string`",
            "description": "The URL of the product's thumbnail.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "title",
            "type": "`string`",
            "description": "The title of the product.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "type",
            "type": "[ProductTypeDTO](product.ProductTypeDTO.mdx)[]",
            "description": "The associated product type.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "updated_at",
            "type": "`string` \\| `Date`",
            "description": "When the product was updated.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "variants",
            "type": "[ProductVariantDTO](product.ProductVariantDTO.mdx)[]",
            "description": "The associated product variants.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "weight",
            "type": "`null` \\| `number`",
            "description": "The weight of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "width",
            "type": "`null` \\| `number`",
            "description": "The width of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      },
      {
        "name": "title",
        "type": "`string`",
        "description": "The title of the product option.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "values",
        "type": "[ProductOptionValueDTO](product.ProductOptionValueDTO.mdx)[]",
        "description": "The associated product option values.",
        "optional": false,
        "defaultValue": "",
        "expandable": true,
        "children": [
          {
            "name": "deleted_at",
            "type": "`string` \\| `Date`",
            "description": "When the product option value was deleted.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "The ID of the product option value.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "metadata",
            "type": "`null` \\| `Record<string, unknown>`",
            "description": "Holds custom data in key-value pairs.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "option",
            "type": "[ProductOptionDTO](product.ProductOptionDTO.mdx)",
            "description": "The associated product option. It may only be available if the `option` relation is expanded.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "value",
            "type": "`string`",
            "description": "The value of the product option value.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "variant",
            "type": "[ProductVariantDTO](product.ProductVariantDTO.mdx)",
            "description": "The associated product variant. It may only be available if the `variant` relation is expanded.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      }
    ]
  },
  {
    "name": "origin_country",
    "type": "`null` \\| `string`",
    "description": "The origin country of the product.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "status",
    "type": "[ProductStatus](../enums/product.ProductStatus.mdx)",
    "description": "The status of the product.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "DRAFT",
        "type": "`\"draft\"`",
        "description": "",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "PROPOSED",
        "type": "`\"proposed\"`",
        "description": "",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "PUBLISHED",
        "type": "`\"published\"`",
        "description": "",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "REJECTED",
        "type": "`\"rejected\"`",
        "description": "",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "subtitle",
    "type": "`null` \\| `string`",
    "description": "The subttle of the product.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "tags",
    "type": "[ProductTagDTO](product.ProductTagDTO.mdx)[]",
    "description": "The associated product tags.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": [
      {
        "name": "id",
        "type": "`string`",
        "description": "The ID of the product tag.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "metadata",
        "type": "`null` \\| `Record<string, unknown>`",
        "description": "Holds custom data in key-value pairs.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "products",
        "type": "[ProductDTO](product.ProductDTO.mdx)[]",
        "description": "The associated products.",
        "optional": true,
        "defaultValue": "",
        "expandable": true,
        "children": [
          {
            "name": "categories",
            "type": "`null` \\| [ProductCategoryDTO](product.ProductCategoryDTO.mdx)[]",
            "description": "The associated product categories.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "collection",
            "type": "[ProductCollectionDTO](product.ProductCollectionDTO.mdx)",
            "description": "The associated product collection.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "created_at",
            "type": "`string` \\| `Date`",
            "description": "When the product was created.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "deleted_at",
            "type": "`string` \\| `Date`",
            "description": "When the product was deleted.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "description",
            "type": "`null` \\| `string`",
            "description": "The description of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "discountable",
            "type": "`boolean`",
            "description": "Whether the product can be discounted.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "external_id",
            "type": "`null` \\| `string`",
            "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "handle",
            "type": "`null` \\| `string`",
            "description": "The handle of the product. The handle can be used to create slug URL paths.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "height",
            "type": "`null` \\| `number`",
            "description": "The height of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "hs_code",
            "type": "`null` \\| `string`",
            "description": "The HS Code of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "The ID of the product.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "images",
            "type": "[ProductImageDTO](product.ProductImageDTO.mdx)[]",
            "description": "The associated product images.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "is_giftcard",
            "type": "`boolean`",
            "description": "Whether the product is a gift card.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "length",
            "type": "`null` \\| `number`",
            "description": "The length of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "material",
            "type": "`null` \\| `string`",
            "description": "The material of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "metadata",
            "type": "`Record<string, unknown>`",
            "description": "Holds custom data in key-value pairs.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "mid_code",
            "type": "`null` \\| `string`",
            "description": "The MID Code of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "options",
            "type": "[ProductOptionDTO](product.ProductOptionDTO.mdx)[]",
            "description": "The associated product options.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "origin_country",
            "type": "`null` \\| `string`",
            "description": "The origin country of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "status",
            "type": "[ProductStatus](../enums/product.ProductStatus.mdx)",
            "description": "The status of the product.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "subtitle",
            "type": "`null` \\| `string`",
            "description": "The subttle of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "tags",
            "type": "[ProductTagDTO](product.ProductTagDTO.mdx)[]",
            "description": "The associated product tags.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "thumbnail",
            "type": "`null` \\| `string`",
            "description": "The URL of the product's thumbnail.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "title",
            "type": "`string`",
            "description": "The title of the product.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "type",
            "type": "[ProductTypeDTO](product.ProductTypeDTO.mdx)[]",
            "description": "The associated product type.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "updated_at",
            "type": "`string` \\| `Date`",
            "description": "When the product was updated.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "variants",
            "type": "[ProductVariantDTO](product.ProductVariantDTO.mdx)[]",
            "description": "The associated product variants.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "weight",
            "type": "`null` \\| `number`",
            "description": "The weight of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "width",
            "type": "`null` \\| `number`",
            "description": "The width of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      },
      {
        "name": "value",
        "type": "`string`",
        "description": "The value of the product tag.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "thumbnail",
    "type": "`null` \\| `string`",
    "description": "The URL of the product's thumbnail.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "title",
    "type": "`string`",
    "description": "The title of the product.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "type",
    "type": "[ProductTypeDTO](product.ProductTypeDTO.mdx)[]",
    "description": "The associated product type.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": [
      {
        "name": "deleted_at",
        "type": "`string` \\| `Date`",
        "description": "When the product type was deleted.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "The ID of the product type.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "metadata",
        "type": "`null` \\| `Record<string, unknown>`",
        "description": "Holds custom data in key-value pairs.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "value",
        "type": "`string`",
        "description": "The value of the product type.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "updated_at",
    "type": "`string` \\| `Date`",
    "description": "When the product was updated.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "variants",
    "type": "[ProductVariantDTO](product.ProductVariantDTO.mdx)[]",
    "description": "The associated product variants.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": [
      {
        "name": "allow_backorder",
        "type": "`boolean`",
        "description": "Whether the product variant can be ordered when it's out of stock.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "barcode",
        "type": "`null` \\| `string`",
        "description": "The barcode of the product variant.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "created_at",
        "type": "`string` \\| `Date`",
        "description": "When the product variant was created.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "deleted_at",
        "type": "`string` \\| `Date`",
        "description": "When the product variant was deleted.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "ean",
        "type": "`null` \\| `string`",
        "description": "The EAN of the product variant.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "height",
        "type": "`null` \\| `number`",
        "description": "The height of the product variant.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "hs_code",
        "type": "`null` \\| `string`",
        "description": "The HS Code of the product variant.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "The ID of the product variant.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "inventory_quantity",
        "type": "`number`",
        "description": "The inventory quantiy of the product variant.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "length",
        "type": "`null` \\| `number`",
        "description": "The length of the product variant.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "manage_inventory",
        "type": "`boolean`",
        "description": "Whether the product variant's inventory should be managed by the core system.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "material",
        "type": "`null` \\| `string`",
        "description": "The material of the product variant.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "metadata",
        "type": "`null` \\| `Record<string, unknown>`",
        "description": "Holds custom data in key-value pairs.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "mid_code",
        "type": "`null` \\| `string`",
        "description": "The MID Code of the product variant.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "options",
        "type": "[ProductOptionValueDTO](product.ProductOptionValueDTO.mdx)[]",
        "description": "The associated product options.",
        "optional": false,
        "defaultValue": "",
        "expandable": true,
        "children": [
          {
            "name": "deleted_at",
            "type": "`string` \\| `Date`",
            "description": "When the product option value was deleted.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "The ID of the product option value.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "metadata",
            "type": "`null` \\| `Record<string, unknown>`",
            "description": "Holds custom data in key-value pairs.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "option",
            "type": "[ProductOptionDTO](product.ProductOptionDTO.mdx)",
            "description": "The associated product option. It may only be available if the `option` relation is expanded.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "value",
            "type": "`string`",
            "description": "The value of the product option value.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "variant",
            "type": "[ProductVariantDTO](product.ProductVariantDTO.mdx)",
            "description": "The associated product variant. It may only be available if the `variant` relation is expanded.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      },
      {
        "name": "origin_country",
        "type": "`null` \\| `string`",
        "description": "The origin country of the product variant.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "product",
        "type": "[ProductDTO](product.ProductDTO.mdx)",
        "description": "The associated product.",
        "optional": false,
        "defaultValue": "",
        "expandable": true,
        "children": [
          {
            "name": "categories",
            "type": "`null` \\| [ProductCategoryDTO](product.ProductCategoryDTO.mdx)[]",
            "description": "The associated product categories.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "collection",
            "type": "[ProductCollectionDTO](product.ProductCollectionDTO.mdx)",
            "description": "The associated product collection.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "created_at",
            "type": "`string` \\| `Date`",
            "description": "When the product was created.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "deleted_at",
            "type": "`string` \\| `Date`",
            "description": "When the product was deleted.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "description",
            "type": "`null` \\| `string`",
            "description": "The description of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "discountable",
            "type": "`boolean`",
            "description": "Whether the product can be discounted.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "external_id",
            "type": "`null` \\| `string`",
            "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "handle",
            "type": "`null` \\| `string`",
            "description": "The handle of the product. The handle can be used to create slug URL paths.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "height",
            "type": "`null` \\| `number`",
            "description": "The height of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "hs_code",
            "type": "`null` \\| `string`",
            "description": "The HS Code of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "The ID of the product.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "images",
            "type": "[ProductImageDTO](product.ProductImageDTO.mdx)[]",
            "description": "The associated product images.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "is_giftcard",
            "type": "`boolean`",
            "description": "Whether the product is a gift card.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "length",
            "type": "`null` \\| `number`",
            "description": "The length of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "material",
            "type": "`null` \\| `string`",
            "description": "The material of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "metadata",
            "type": "`Record<string, unknown>`",
            "description": "Holds custom data in key-value pairs.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "mid_code",
            "type": "`null` \\| `string`",
            "description": "The MID Code of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "options",
            "type": "[ProductOptionDTO](product.ProductOptionDTO.mdx)[]",
            "description": "The associated product options.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "origin_country",
            "type": "`null` \\| `string`",
            "description": "The origin country of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "status",
            "type": "[ProductStatus](../enums/product.ProductStatus.mdx)",
            "description": "The status of the product.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "subtitle",
            "type": "`null` \\| `string`",
            "description": "The subttle of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "tags",
            "type": "[ProductTagDTO](product.ProductTagDTO.mdx)[]",
            "description": "The associated product tags.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "thumbnail",
            "type": "`null` \\| `string`",
            "description": "The URL of the product's thumbnail.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "title",
            "type": "`string`",
            "description": "The title of the product.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "type",
            "type": "[ProductTypeDTO](product.ProductTypeDTO.mdx)[]",
            "description": "The associated product type.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "updated_at",
            "type": "`string` \\| `Date`",
            "description": "When the product was updated.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "variants",
            "type": "[ProductVariantDTO](product.ProductVariantDTO.mdx)[]",
            "description": "The associated product variants.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "weight",
            "type": "`null` \\| `number`",
            "description": "The weight of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "width",
            "type": "`null` \\| `number`",
            "description": "The width of the product.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      },
      {
        "name": "product_id",
        "type": "`string`",
        "description": "The ID of the associated product.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "sku",
        "type": "`null` \\| `string`",
        "description": "The SKU of the product variant.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "title",
        "type": "`string`",
        "description": "The tile of the product variant.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "upc",
        "type": "`null` \\| `string`",
        "description": "The UPC of the product variant.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "updated_at",
        "type": "`string` \\| `Date`",
        "description": "When the product variant was updated.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "variant_rank",
        "type": "`null` \\| `number`",
        "description": "he ranking of the variant among other variants associated with the product.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "weight",
        "type": "`null` \\| `number`",
        "description": "The weight of the product variant.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "width",
        "type": "`null` \\| `number`",
        "description": "The width of the product variant.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "weight",
    "type": "`null` \\| `number`",
    "description": "The weight of the product.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "width",
    "type": "`null` \\| `number`",
    "description": "The width of the product.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />
