Files
medusa-store/docs/api/admin/components/schemas/InventoryItemDTO.yaml
github-actions[bot] 7963c16233 chore(docs): Generated API Reference (#4054)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2023-05-09 18:12:00 +03:00

79 lines
2.3 KiB
YAML

type: object
required:
- sku
properties:
sku:
description: The Stock Keeping Unit (SKU) code of the Inventory Item.
type: string
hs_code:
description: >-
The Harmonized System code of the Inventory Item. May be used by
Fulfillment Providers to pass customs information to shipping carriers.
type: string
origin_country:
description: >-
The country in which the Inventory Item was produced. May be used by
Fulfillment Providers to pass customs information to shipping carriers.
type: string
mid_code:
description: >-
The Manufacturers Identification code that identifies the manufacturer of
the Inventory Item. May be used by Fulfillment Providers to pass customs
information to shipping carriers.
type: string
title:
description: Title of the inventory item
type: string
description:
description: Description of the inventory item
type: string
thumbnail:
description: Thumbnail for the inventory item
type: string
material:
description: >-
The material and composition that the Inventory Item is made of, May be
used by Fulfillment Providers to pass customs information to shipping
carriers.
type: string
weight:
description: >-
The weight of the Inventory Item. May be used in shipping rate
calculations.
type: number
height:
description: >-
The height of the Inventory Item. May be used in shipping rate
calculations.
type: number
width:
description: >-
The width of the Inventory Item. May be used in shipping rate
calculations.
type: number
length:
description: >-
The length of the Inventory Item. May be used in shipping rate
calculations.
type: number
requires_shipping:
description: Whether the item requires shipping.
type: boolean
metadata:
type: object
description: An optional key-value map with additional details
example:
car: white
created_at:
type: string
description: The date with timezone at which the resource was created.
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
format: date-time