📐 Product schemas

Product schemas define public request contracts and reusable product shapes. Reusable shapes are strict where the source sets additionalProperties: false; request contracts below preserve source locations and requiredness.

Inventory

Export	Request location	Contract
productSchema	N/A	Reusable strict object shape.
createProductImageSchema	Body	Source-defined request contract.
ProductImage	N/A	Public TypeScript image shape.
NormalizedProductImage	N/A	Public TypeScript image shape.
productVariantSchema	N/A	Reusable strict object shape.
createProductSchema	Body	Source-defined request contract.
updateProductSchema	Path, body	Source-defined request contract.
createProductBatchSchema	Body	Source-defined request contract.
updateProductBatchSchema	Body	Source-defined request contract.
deleteProductBatchSchema	Body	Source-defined request contract.
copyProductBatchSchema	Body	Source-defined request contract.
getProductSchema	Path	Source-defined request contract.
deleteProductSchema	Path	Source-defined request contract.
copyProductSchema	Path	Source-defined request contract.
findProductsSchema	Query	Source-defined request contract.
deleteProductImageSchema	Path	Source-defined request contract.
createProductVariantSchema	Path, body	Source-defined request contract.
getProductVariantSchema	Path	Source-defined request contract.
updateProductVariantSchema	Path, body	Source-defined request contract.
deleteProductVariantSchema	Path	Source-defined request contract.
findProductVariantsSchema	Path, Query	Source-defined request contract.
createProductVariantBulkSchema	Path, body	Source-defined request contract.
updateProductVariantBulkSchema	Path, body	Source-defined request contract.
deleteProductVariantBulkSchema	Path, body	Source-defined request contract.
getProductLikersSchema	Path	Source-defined request contract.

Details

productSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
N/A	description	string	No	additionalProperties: false.
N/A	name	string	No	additionalProperties: false.

Used by route: None

Used by feature: None

Used by schemas: createProductSchema, updateProductSchema, createProductBatchSchema, updateProductBatchSchema.

View complete source

export const productSchema = {
  $schema: 'http://json-schema.org/draft-07/schema#',
  additionalProperties: false,
  properties: {
    description: { type: 'string' },
    name: { type: 'string' },
  },
  type: 'object',
} as const satisfies SchemaDefinition;

---

createProductImageSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Body	objectId	string	Yes	UUID format; JSON body required.
Body	type	string	Yes	JSON body required; inherited strict object.

Used by route: createProductImageRoute

Used by feature: createProductImageFeature

View complete source

export const createProductImageSchema = withSchema({
  requestBody: {
    content: {
      'application/json': {
        schema: {
          ...productImageSchema,
          required: ['objectId', 'type'],
        },
      },
    },
    required: true,
  },
});

---

ProductImage

Definition

This exported TypeScript shape describes stored or normalized product image data.

Location	Field	Type	Required	Constraints
N/A	objectId	string	Yes	Stored image object identifier.
N/A	type	string	Yes	Stored image type.

Used by route: None

Used by feature: None

View complete source

export type ProductImage = {
  objectId: string;
  type: string;
};

---

NormalizedProductImage

Definition

This exported TypeScript shape describes stored or normalized product image data.

Location	Field	Type	Required	Constraints
N/A	url	string	Yes	Public normalized URL.
N/A	type	string	Yes	Image type.

Used by route: None

Used by feature: None

View complete source

export type NormalizedProductImage = {
  url: string;
  type: string;
};

---

productVariantSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
N/A	description	string	No	additionalProperties: false.
N/A	imageIds	string[]	No	Array items are strings.
N/A	price.amount	number	No	Nested price object is strict.
N/A	price.currency	string	No	Nested price object is strict.
N/A	price.taxIncluded	boolean	No	Nested price object is strict.
N/A	price.taxable	boolean	No	Nested price object is strict.
N/A	sku	string	No	Strict reusable shape.
N/A	title	string	No	Strict reusable shape.

Used by route: None

Used by feature: None

Used by schemas: createProductVariantSchema, updateProductVariantSchema, createProductVariantBulkSchema, updateProductVariantBulkSchema.

View complete source

export const productVariantSchema: SchemaDefinition = {
  $schema: 'http://json-schema.org/draft-07/schema#',
  additionalProperties: false,
  properties: {
    description: { type: 'string' },
    // TODO: Go back and add images to update product schema and update here to follow same structure
    imageIds: {
      items: { type: 'string' },
      type: 'array',
    },
    price: {
      additionalProperties: false,
      properties: {
        amount: { type: 'number' },
        currency: { type: 'string' },
        taxIncluded: { type: 'boolean' },
        taxable: { type: 'boolean' },
      },
      type: 'object',
    },
    sku: { type: 'string' },
    title: { type: 'string' },
  },
  type: 'object',
};

---

createProductSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Body	description	string	Yes	JSON body required; inherited from productSchema.
Body	name	string	Yes	JSON body required; inherited from productSchema.

Used by route: createProductRoute

Used by feature: createProductFeature

View complete source

export const createProductSchema = withSchema({
  requestBody: {
    content: {
      'application/json': {
        schema: {
          ...productSchema,
          required: ['name', 'description'],
        },
      },
    },
    required: true,
  },
});

---

updateProductSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Path	productId	string	Yes	Shared path parameter.
Body	description	string	No	JSON body itself is required; strict product shape.
Body	name	string	No	JSON body itself is required; strict product shape.

Used by route: updateProductRoute

Used by feature: editProductFeatures

View complete source

export const updateProductSchema = withSchema({
  parameters: [{ ...productIdPathParameter }],
  requestBody: {
    content: {
      'application/json': {
        schema: {
          ...productSchema,
          required: [],
        },
      },
    },
    required: true,
  },
});

---

createProductBatchSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Body	[]	Product[]	Yes	JSON array; each item requires name and description, using strict productSchema.

Used by route: createProductBatchRoute

Used by feature: createProductBatchFeature

View complete source

export const createProductBatchSchema = withSchema({
  requestBody: {
    content: {
      'application/json': {
        schema: {
          $schema: 'http://json-schema.org/draft-07/schema#',
          items: {
            ...productSchema,
            required: ['name', 'description'],
          },
          type: 'array',
        },
      },
    },
    required: true,
  },
});

---

updateProductBatchSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Body	ids	string[]	Yes	arrayOfStringsSchema.
Body	data	Product	Yes	Strict productSchema with no required fields.

Used by route: updateProductBatchRoute

Used by feature: editProductBatchFeatures

View complete source

export const updateProductBatchSchema = withSchema({
  requestBody: {
    content: {
      'application/json': {
        schema: {
          $schema: 'http://json-schema.org/draft-07/schema#',
          additionalProperties: false,
          properties: {
            data: { ...productSchema, required: [] },
            ids: { ...arrayOfStringsSchema },
          },
          required: ['ids', 'data'],
          type: 'object',
        },
      },
    },
    required: true,
  },
});

---

deleteProductBatchSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Body	[]	string[]	Yes	arrayOfStringsSchema; JSON body required.

Used by route: deleteProductBatchRoute

Used by feature: deleteProductBatchFeatures

View complete source

export const deleteProductBatchSchema = withSchema({
  requestBody: {
    content: {
      'application/json': {
        schema: {
          ...arrayOfStringsSchema,
        },
      },
    },
    required: true,
  },
});

---

copyProductBatchSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Body	[]	string[]	Yes	arrayOfStringsSchema; JSON body required.

Used by route: copyProductBatchRoute

Used by feature: copyProductBatchFeatures

View complete source

export const copyProductBatchSchema = withSchema({
  requestBody: {
    content: {
      'application/json': {
        schema: {
          ...arrayOfStringsSchema,
        },
      },
    },
    required: true,
  },
});

---

getProductSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Path	productId	string	Yes	Shared path parameter.

Used by route: getProductRoute

Used by feature: getProductFeatures

View complete source

export const getProductSchema = withSchema({
  parameters: [{ ...productIdPathParameter }],
});

---

deleteProductSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Path	productId	string	Yes	Shared path parameter.

Used by route: deleteProductRoute

Used by feature: deleteProductFeatures

View complete source

export const deleteProductSchema = withSchema({
  parameters: [{ ...productIdPathParameter }],
});

---

copyProductSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Path	productId	string	Yes	Shared path parameter.

Used by route: copyProductRoute

Used by feature: copyProductFeatures

View complete source

export const copyProductSchema = withSchema({
  parameters: [{ ...productIdPathParameter }],
});

---

findProductsSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Query	name	string	No	Product name filter.
Query	description	string	No	Product description filter.
Query	pagination parameters	Shared	No	Spread from paginationQueryParametersSchema.

Used by route: findProductsRoute

Used by feature: findProductsFeatures

View complete source

export const findProductsSchema = withSchema({
  parameters: [
    {
      in: 'query',
      name: 'name',
      required: false,
      schema: {
        type: 'string',
      },
    },
    {
      in: 'query',
      name: 'description',
      required: false,
      schema: {
        type: 'string',
      },
    },
    ...paginationQueryParametersSchema,
  ],
});

---

deleteProductImageSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Path	productId	string	Yes	Shared path parameter.
Path	imageId	string	Yes	Shared path parameter.

Used by route: deleteProductImageRoute

Used by feature: deleteProductImageFeature

View complete source

export const deleteProductImageSchema = withSchema({
  parameters: [{ ...productIdPathParameter }, { ...imageIdPathParameter }],
});

---

createProductVariantSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Path	productId	string	Yes	Shared path parameter.
Body	title	string	Yes	JSON body required; strict variant shape.
Body	description, imageIds, price, sku	Variant fields	No	Inherited from productVariantSchema.

Used by route: createProductVariantRoute

Used by feature: createProductVariantFeature

View complete source

export const createProductVariantSchema = withSchema({
  parameters: [{ ...productIdPathParameter }],
  requestBody: {
    content: {
      'application/json': {
        schema: {
          ...productVariantSchema,
          required: ['title'],
        },
      },
    },
    required: true,
  },
});

---

getProductVariantSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Path	productId	string	Yes	Shared path parameter.
Path	productVariantId	string	Yes	Shared path parameter.

Used by route: getProductVariantRoute

Used by feature: getProductVariantFeature

View complete source

export const getProductVariantSchema = withSchema({
  parameters: [
    { ...productIdPathParameter },
    { ...productVariantIdPathParameter },
  ],
});

---

updateProductVariantSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Path	productId	string	Yes	Shared path parameter.
Path	productVariantId	string	Yes	Shared path parameter.
Body	variant fields	productVariantSchema	No	Body is present in the operation but requestBody.required is omitted.

Used by route: updateProductVariantRoute

Used by feature: updateProductVariantFeature

View complete source

export const updateProductVariantSchema = withSchema({
  parameters: [
    { ...productIdPathParameter },
    { ...productVariantIdPathParameter },
  ],
  requestBody: {
    content: {
      'application/json': {
        schema: {
          ...productVariantSchema,
          required: [],
        },
      },
    },
  },
});

---

deleteProductVariantSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Path	productId	string	Yes	Shared path parameter.
Path	productVariantId	string	Yes	Shared path parameter.

Used by route: deleteProductVariantRoute

Used by feature: deleteProductVariantFeature

View complete source

export const deleteProductVariantSchema = withSchema({
  parameters: [
    { ...productIdPathParameter },
    { ...productVariantIdPathParameter },
  ],
});

---

findProductVariantsSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Path	productId	string	Yes	Shared path parameter.
Query	pagination parameters	Shared	No	Spread from paginationQueryParametersSchema.

Used by route: findProductVariantsRoute

Used by feature: findProductVariantsFeature

View complete source

export const findProductVariantsSchema = withSchema({
  parameters: [
    { ...productIdPathParameter },
    ...paginationQueryParametersSchema,
  ],
});

---

createProductVariantBulkSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Path	productId	string	Yes	Shared path parameter.
Body	[]	ProductVariant[]	Yes	JSON array, 1–100 items; each requires title.

Used by route: createProductVariantBulkRoute

Used by feature: createProductVariantBulkFeature

View complete source

export const createProductVariantBulkSchema = withSchema({
  parameters: [{ ...productIdPathParameter }],
  requestBody: {
    content: {
      'application/json': {
        schema: {
          $schema: 'http://json-schema.org/draft-07/schema#',
          items: {
            ...productVariantSchema,
            required: ['title'],
          },
          maxItems: 100,
          minItems: 1,
          type: 'array',
        },
      },
    },
    required: true,
  },
});

---

updateProductVariantBulkSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Path	productId	string	Yes	Shared path parameter.
Body	ids	string[]	Yes	arrayOfStringsSchema, 1–100 items.
Body	data	object	Yes	Variant properties, no required nested fields.

Used by route: updateProductVariantBulkRoute

Used by feature: updateProductVariantBulkFeature

View complete source

export const updateProductVariantBulkSchema = withSchema({
  parameters: [{ ...productIdPathParameter }],
  requestBody: {
    content: {
      'application/json': {
        schema: {
          ...productVariantSchema,
          properties: {
            data: {
              properties: { ...productVariantSchema.properties },
              required: [],
              type: 'object',
            },
            ids: { ...arrayOfStringsSchema, maxItems: 100, minItems: 1 },
          },
          required: ['ids', 'data'],
        },
      },
    },
  },
});

---

deleteProductVariantBulkSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Path	productId	string	Yes	Shared path parameter.
Body	[]	string[]	Yes	arrayOfStringsSchema, 1–100 items.

Used by route: deleteProductVariantBulkRoute

Used by feature: deleteProductVariantBulkFeature

View complete source

export const deleteProductVariantBulkSchema = withSchema({
  parameters: [{ ...productIdPathParameter }],
  requestBody: {
    content: {
      'application/json': {
        schema: {
          ...arrayOfStringsSchema,
          maxItems: 100,
          minItems: 1,
        },
      },
    },
    required: true,
  },
});

---

getProductLikersSchema

Definition

This export defines the source-backed request or reusable validation shape.

Location	Field	Type	Required	Constraints
Path	productId	string	Yes	Shared path parameter.

Used by route: getProductLikersRoute

Used by feature: getProductLikersFeature

View complete source

export const getProductLikersSchema = withSchema({
  parameters: [{ ...productIdPathParameter }],
});

---