Method

POST

URL

https://api.us.medipim.com/v4/products/create

Headers

• Authorization

Body

• organizations[]: The full list of organization IDs that should be associated with this product.
• product: Name and identifier code are required fields to create products. It is advised to check if the code doesn’t already exist in the database. This is valid to check to be certain double products aren’t created. The rest of the fields are optional.
  • status: Product status ( active, inactive, replaced, no_selection )
  • replacement: Medipim ID of the replacing product (only in case product status is "replaced")
  • name.{...}: Name (string, localized)
  • seoName.{...}: SEO friendly name (string, localized)
  • officialDeletionAt: Official date on which the product became unavailable. (unix timestamp)
  • ean[]: EAN codes (⚠️ a product may have multiple EAN codes) (integer[])
  • gtin: GTIN code (integer) (⚠️ use ean field instead)
  • hsCode: Harmonised System (HS) code (integer)
  • supplierReference: Supplier reference code (string)
  • hri: Health Related Item (string)
  • ndc: National Drug Code (string)
  • pin: Product Identification Number (string)
  • upc10: Universal Product Code 10 (string)
  • upc11: Universal Product Code 11 (string)
  • upc12: Universal Product Code 12 (string)
  • hamacherCode: Hamacher Code (string)
  • atc: ATC code (string) (⚠️ deprecated use atcCategory instead)
  • atcCategory[]: List of ATC category codes associated with this product (string[])
  • conservation: Conservation for a given product. Possible values: room, refrigerator, fresh, frozen (string)
  • weight: Weight (integer, in grams) (⚠️ deprecated use weightWithUnit instead)
  • width: Width (integer, in millimeters) (⚠️ deprecated use widthWithUnit instead)
  • length: Length (integer, in millimeters) (⚠️ deprecated use lengthWithUnit instead)
  • depth: Depth (integer, in millimeters) (⚠️ deprecated use depthWithUnit instead)
  • weightWithUnit: Weight(object)
    • value: value (integer)
    • unit: unit (string)
  • widthWithUnit: Length(object)
    • value: value (integer)
    • unit: unit (string)
  • lengthWithUnit: Length(object)
    • value: value (integer)
    • unit: unit (string)
  • depthWithUnit: Length(object)
    • value: value (integer)
    • unit: unit (string)
  • packageContent: Number of packages (integer)
  • packageQuantity: How many units are in the package (string)
  • packagingUnit: Packaging unit (string)
  • publicCategories[]: The full list of publicCategory IDs that should be associated with this product.
  • fineLineCategory[]: The full list of Fine Line Category IDs that should be associated with this product.
  • brands[]: The full list of brand IDs that should be associated with this product.
  • attributes[]: The full list of attributes IDs that should be associated with this product.
  • activeIngredients[]: The full list of active ingredient IDs that should be associated with this product.

Body

• product:
  • id, name, ...: product information (same format as product search results)