@medusajs/medusa 1.1.52 → 1.1.56

package/dist/api/routes/admin/products/create-product.d.ts

@@ -0,0 +1,256 @@
+import { ProductStatus } from ".";
+declare const _default: (req: any, res: any) => Promise<void>;
+/**
+ * @oas [post] /products
+ * operationId: "PostProducts"
+ * summary: "Create a Product"
+ * x-authenticated: true
+ * description: "Creates a Product"
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       required:
+ *         - title
+ *         - subtitle
+ *         - description
+ *       schema:
+ *         required:
+ *           - title
+ *         properties:
+ *           title:
+ *             description: "The title of the Product"
+ *             type: string
+ *           subtitle:
+ *             description: "The subtitle of the Product"
+ *             type: string
+ *           description:
+ *             description: "A description of the Product."
+ *             type: string
+ *           is_giftcard:
+ *             description: A flag to indicate if the Product represents a Gift Card. Purchasing Products with this flag set to `true` will result in a Gift Card being created.
+ *             type: boolean
+ *           discountable:
+ *             description: A flag to indicate if discounts can be applied to the LineItems generated from this Product
+ *             type: boolean
+ *           images:
+ *             description: Images of the Product.
+ *             type: array
+ *             items:
+ *               type: string
+ *           thumbnail:
+ *             description: The thumbnail to use for the Product.
+ *             type: string
+ *           handle:
+ *             description: A unique handle to identify the Product by.
+ *             type: string
+ *           type:
+ *             description: The Product Type to associate the Product with.
+ *             type: object
+ *             properties:
+ *               value:
+ *                 description: The value of the Product Type.
+ *                 type: string
+ *           collection_id:
+ *             description: The id of the Collection the Product should belong to.
+ *             type: string
+ *           tags:
+ *             description: Tags to associate the Product with.
+ *             type: array
+ *             items:
+ *               properties:
+ *                 id:
+ *                   description: The id of an existing Tag.
+ *                   type: string
+ *                 value:
+ *                   description: The value of the Tag, these will be upserted.
+ *                   type: string
+ *           options:
+ *             description: The Options that the Product should have. These define on which properties the Product's Product Variants will differ.
+ *             type: array
+ *             items:
+ *               properties:
+ *                 title:
+ *                   description: The title to identify the Product Option by.
+ *                   type: string
+ *           variants:
+ *             description: A list of Product Variants to create with the Product.
+ *             type: array
+ *             items:
+ *               properties:
+ *                 title:
+ *                   description: The title to identify the Product Variant by.
+ *                   type: string
+ *                 sku:
+ *                   description: The unique SKU for the Product Variant.
+ *                   type: string
+ *                 ean:
+ *                   description: The EAN number of the item.
+ *                   type: string
+ *                 upc:
+ *                   description: The UPC number of the item.
+ *                   type: string
+ *                 barcode:
+ *                   description: A generic GTIN field for the Product Variant.
+ *                   type: string
+ *                 hs_code:
+ *                   description: The Harmonized System code for the Product Variant.
+ *                   type: string
+ *                 inventory_quantity:
+ *                   description: The amount of stock kept for the Product Variant.
+ *                   type: integer
+ *                 allow_backorder:
+ *                   description: Whether the Product Variant can be purchased when out of stock.
+ *                   type: boolean
+ *                 manage_inventory:
+ *                   description: Whether Medusa should keep track of the inventory for this Product Variant.
+ *                   type: boolean
+ *                 weight:
+ *                   description: The wieght of the Product Variant.
+ *                   type: string
+ *                 length:
+ *                   description: The length of the Product Variant.
+ *                   type: string
+ *                 height:
+ *                   description: The height of the Product Variant.
+ *                   type: string
+ *                 width:
+ *                   description: The width of the Product Variant.
+ *                   type: string
+ *                 origin_country:
+ *                   description: The country of origin of the Product Variant.
+ *                   type: string
+ *                 mid_code:
+ *                   description: The Manufacturer Identification code for the Product Variant.
+ *                   type: string
+ *                 material:
+ *                   description: The material composition of the Product Variant.
+ *                   type: string
+ *                 metadata:
+ *                   description: An optional set of key-value pairs with additional information.
+ *                   type: object
+ *                 prices:
+ *                   type: array
+ *                   items:
+ *                     properties:
+ *                       region_id:
+ *                         description: The id of the Region for which the price is used.
+ *                         type: string
+ *                       currency_code:
+ *                         description: The 3 character ISO currency code for which the price will be used.
+ *                         type: string
+ *                       amount:
+ *                         description: The amount to charge for the Product Variant.
+ *                         type: integer
+ *                       sale_amount:
+ *                         description: The sale amount to charge for the Product Variant.
+ *                         type: integer
+ *                 options:
+ *                   type: array
+ *                   items:
+ *                     properties:
+ *                       value:
+ *                         description: The value to give for the Product Option at the same index in the Product's `options` field.
+ *                         type: string
+ *           weight:
+ *             description: The wieght of the Product.
+ *             type: string
+ *           length:
+ *             description: The length of the Product.
+ *             type: string
+ *           height:
+ *             description: The height of the Product.
+ *             type: string
+ *           width:
+ *             description: The width of the Product.
+ *             type: string
+ *           origin_country:
+ *             description: The country of origin of the Product.
+ *             type: string
+ *           mid_code:
+ *             description: The Manufacturer Identification code for the Product.
+ *             type: string
+ *           material:
+ *             description: The material composition of the Product.
+ *             type: string
+ *           metadata:
+ *             description: An optional set of key-value pairs with additional information.
+ *             type: object
+ * tags:
+ *   - Product
+ * responses:
+ *   200:
+ *     description: OK
+ *     content:
+ *       application/json:
+ *         schema:
+ *           properties:
+ *             product:
+ *               $ref: "#/components/schemas/product"
+ */
+export default _default;
+declare class ProductTypeReq {
+    id?: string;
+    value: string;
+}
+declare class ProductTagReq {
+    id?: string;
+    value: string;
+}
+declare class ProductVariantOptionReq {
+    value: string;
+}
+declare class ProductOptionReq {
+    title: string;
+}
+declare class ProductVariantPricesReq {
+    region_id?: string;
+    currency_code?: string;
+    amount: number;
+    sale_amount?: number;
+}
+declare class ProductVariantReq {
+    title: string;
+    sku?: string;
+    ean?: string;
+    upc?: string;
+    barcode?: string;
+    hs_code?: string;
+    inventory_quantity: number;
+    allow_backorder?: boolean;
+    manage_inventory?: boolean;
+    weight?: number;
+    length?: number;
+    height?: number;
+    width?: number;
+    origin_country?: string;
+    mid_code?: string;
+    material?: string;
+    metadata?: object;
+    prices: ProductVariantPricesReq[];
+    options?: ProductVariantOptionReq[];
+}
+export declare class AdminPostProductsReq {
+    title: string;
+    subtitle?: string;
+    description?: string;
+    is_giftcard: boolean;
+    discountable: boolean;
+    images?: string[];
+    thumbnail?: string;
+    handle?: string;
+    status?: ProductStatus;
+    type?: ProductTypeReq;
+    collection_id?: string;
+    tags?: ProductTagReq;
+    options?: ProductOptionReq[];
+    variants?: ProductVariantReq[];
+    weight?: number;
+    length?: number;
+    height?: number;
+    width?: number;
+    hs_code?: string;
+    origin_country?: string;
+    mid_code?: string;
+    material?: string;
+    metadata?: object;
+}