Medipim USA - API V4

Developer documentation

Field Glossary

(Last updated: )

Languages

The platform supports the native spoken languages for USA
We have also included English as this is the most common language among web development.

Possible values are: en

Localized fields will always look like:

  • xxx:
    • language_iso2: ...

Country regions

The platforms supports the following country regions for USA.
code label
US-AK Alaska
US-AL Alabama
US-AR Arkansas
US-AS American Samoa
US-AZ Arizona
US-CA California
US-CO Colorado
US-CT Connecticut
US-DC District of Columbia
US-DE Delaware
US-FL Florida
US-GA Georgia
US-GU Guam
US-HI Hawaii
US-IA Iowa
US-ID Idaho
US-IL Illinois
US-IN Indiana
US-KS Kansas
US-KY Kentucky
US-LA Louisiana
US-MA Massachusetts
US-MD Maryland
US-ME Maine
US-MI Michigan
US-MN Minnesota
US-MO Missouri
US-MP Northern Mariana Islands
US-MS Mississippi
US-MT Montana
US-NC North Carolina
US-ND North Dakota
US-NE Nebraska
US-NH New Hampshire
US-NJ New Jersey
US-NM New Mexico
US-NV Nevada
US-NY New York
US-OH Ohio
US-OK Oklahoma
US-OR Oregon
US-PA Pennsylvania
US-PR Puerto Rico
US-RI Rhode Island
US-SC South Carolina
US-SD South Dakota
US-TN Tennessee
US-TX Texas
US-UM United States Minor Outlying Islands
US-UT Utah
US-VA Virginia
US-VI Virgin Islands, U.S.
US-VT Vermont
US-WA Washington
US-WI Wisconsin
US-WV West Virginia
US-WY Wyoming

Product identifier codes

  • gtin: GTIN stands for Global Trade Number, it's a globally recognised number issued by GS1 that's tied to a specific product. GTINs are usually 8, 12, 13, or 14 digits long. This number needs to be padded with zeros in the front to match the 14 digits length restriction.
  • UPC 10: UPC 10 Code.
  • UPC 11: UPC 11 Code.
  • UPC 12: UPC 12 Code.

Target groups

The content on Medipim is designed for multiple target groups.

  • public
  • pharmacist
  • doctor
  • homecare
  • hospital
  • nurse
  • physiotherapist
  • webshop

Media

Media types

We have different media types available:

  • photo
  • frontal
  • link

Photo types

A photo can have one of the following types:

  • packshot
  • productshot
  • lifestyle_image
  • pillshot

Visible sides

The following sides of the product can be visible on a photo:

  • front
  • left
  • right
  • back
  • bottom
  • top

Link types

Links on Medipim can have one of the following types:

  • app
  • brochure
  • video
  • website

Product descriptions

Description types

code en
full_description General description
faq Frequently asked questions
measurements Measurements
legal_text Legal text
indication Indications
contra_indication Contra indications
usage Uses
usage_extended Uses extended
composition Composition
properties Properties
side_effects Side effects
nutritional_value Nutritional value
usage_type Uses type
pregnancy_description Pregnancy description
pregnancy_description_extended Pregnancy description extended
breastfeeding_description Breastfeeding description
breastfeeding_description_extended Breastfeeding description extended
interactions Interactions
warnings Warnings
keywords Keywords

hasContent

The hasContent filter allows you to filter products if they have a specific field. Let's say you want to get all products which have a weight value. Then you would just use this filter in the body:

"hasContent": {
 "flag" : "weight"
}

This is a very effective way to refine your selection and get optimized results. Of course, this can be combined with different filters. Such as the AND, NOT, OR filters. You can use the get-fields] endpoint to get a list of all the possible flags to filter on.

Add a locale parameter for fields that have localized values.

"hasContent": {
 "flag": "descriptions.usage",
 "locale": "en"
}

For descriptions you can also specify who generated the content.
Possible values are: system_generated, user_generated, ai_generated

"hasContent": {
 "flag": "user_generated.descriptions.usage",
 "locale": "en"
}

Dietary Restrictions

code en
alcohol_free Alcohol-free
allergens_free Allergens free
bio Bio
dairy_free Dairy free
fragrance_free Fragrance free
gluten_free Gluten free
halal Halal
kosher Kosher
lactose_free Lactose free
latex_free Latex free
low_carbs Poor in carbohydrates
low_in_purine Low in purine
no_nuts Nut free
protein_rich Protein rich
salt_free_diet Salt free
soy_free Soy free
sugar_free Sugar free
vegan Vegan
vegetarian Vegetarian
without_dyes Without dyes
without_fructose Without fructose
without_palm_oil Without palm oil
without_preservatives Without preservatives
yeast_free Yeast free

Colors

code en
beige Beige
black Black
blue Blue
bordeaux Bordeaux
brown Brown
gold Gold
gray Gray
green Green
khaki Khaki
multicolor Multicolor
ocher Ocher
orange Orange
pink Pink
purple Purple
red Red
transparent Transparent
white White
yellow Yellow

HTML content

Tags that are not allowed (or invalid HTML) are stripped from the content.
Allowed HTML tags and their allowed properties:

  • <b>:
  • <i>:
  • <p>: `style`
  • <table>: `style`, `border`
  • <tbody>:
  • <thead>:
  • <tfoot>:
  • <tr>:
  • <th>: `style`, `colspan`, `rowspan`
  • <td>: `style`, `colspan`, `rowspan`
  • <ol>:
  • <ul>:
  • <li>:
  • <span>: `style`
  • <strong>:
  • <em>:
  • <div>: `class`, `style`
  • <h1>:
  • <h2>:
  • <h3>:
  • <h4>:
  • <h5>:
  • <h6>:
  • <dl>:
  • <dt>:
  • <dd>:
  • <blockquote>:
  • <sup>:
  • <sub>:

Numerical operators

Numerical operators are used in specific filters on Medipim; Their value can be one of the following:

  • eq
  • gt
  • gte
  • lt
  • lte
  • neq