Medipim ES - API V4

Developer documentation

Field Glossary

(Last updated: )

Languages

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

Possible values are: es, en

Localized fields will always look like:

  • xxx:
    • language_iso2: ...

Country regions

The platforms supports the following country regions for ES.
code label
ES-A Alacant*
ES-AB Albacete
ES-AL Almería
ES-AN Andalucía
ES-AR Aragón
ES-AS Asturias, Principado de
ES-AV Ávila
ES-B Barcelona [Barcelona]
ES-BA Badajoz
ES-BI Bizkaia
ES-BU Burgos
ES-C A Coruña [La Coruña]
ES-CA Cádiz
ES-CB Cantabria
ES-CC Cáceres
ES-CE Ceuta
ES-CL Castilla y León
ES-CM Castilla-La Mancha
ES-CN Canarias
ES-CO Córdoba
ES-CR Ciudad Real
ES-CS Castelló*
ES-CT Catalunya [Cataluña]
ES-CU Cuenca
ES-EX Extremadura
ES-GA Galicia [Galicia]
ES-GC Las Palmas
ES-GI Girona [Gerona]
ES-GR Granada
ES-GU Guadalajara
ES-H Huelva
ES-HU Huesca
ES-IB Illes Balears [Islas Baleares]
ES-J Jaén
ES-L Lleida [Lérida]
ES-LE León
ES-LO La Rioja
ES-LU Lugo [Lugo]
ES-M Madrid
ES-MA Málaga
ES-MC Murcia, Región de
ES-MD Madrid, Comunidad de
ES-ML Melilla
ES-MU Murcia
ES-NA Nafarroa*
ES-NC Nafarroako Foru Komunitatea*
ES-O Asturias
ES-OR Ourense [Orense]
ES-P Palencia
ES-PM Illes Balears [Islas Baleares]
ES-PO Pontevedra [Pontevedra]
ES-PV Euskal Herria
ES-RI La Rioja
ES-S Cantabria
ES-SA Salamanca
ES-SE Sevilla
ES-SG Segovia
ES-SO Soria
ES-SS Gipuzkoa
ES-T Tarragona [Tarragona]
ES-TE Teruel
ES-TF Santa Cruz de Tenerife
ES-TO Toledo
ES-V Valencia
ES-VA Valladolid
ES-VC Valenciana, Comunidad
ES-VI Araba*
ES-Z Zaragoza
ES-ZA Zamora

Product identifier codes

  • ean: EAN stands for European Article Number, which is a global trade number (GTIN) issued by GS1. GTINs are usually 8, 12, 13, or 14 digits long.
    This field is designed to hold current and legacy EAN-info about the product, thus it can contain multiple values.
  • 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 field is designed to hold legacy GTIN-info about the product. (⚠️ deprecated use eanGtin14 instead)
  • eanGtin8: EAN 8 is used to identify products using 8-digit global trade number (GTIN 8). It is typically used outside the US and Canada.
  • eanGtin12: EAN12 is used to identify products using a 12-digit global trade number (GTIN 12). It is typically used within the US and Canada though.
  • eanGtin13: EAN13 is used to identify products using a 13-digit global trade number (GTIN 13). It is typically used outside the US and Canada.
  • eanGtin14: EAN 14 / GTIN is used to identify products using a 14-digit global trade number (GTIN 14). It is typically used outside the US and Canada.
  • cn: The National Parapharmacy Code is a rapid identification system or computer tool, which aims to help and facilitate the management of pharmacies in the acquisition of parapharmacy products on the national market by means of computer processing of these products. This code is 6 digits long.

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 es en
full_description Descripción general General description
faq Preguntas frecuentes Frequently asked questions
measurements Dimensiones Measurements
legal_text Texto legal Legal text
indication Indicacións Indications
contra_indication Contra indicación Contra indications
usage Uso Uses
usage_extended Uso extendido Uses extended
composition Composición Composition
properties Propiedades Properties
side_effects Efectos secundarios Side effects
nutritional_value Valor nutricional Nutritional value
usage_type Tipo de uso Uses type
pregnancy_description Descripción del embarazo Pregnancy description
pregnancy_description_extended Descripción del embarazo ampliada Pregnancy description extended
breastfeeding_description Descripción de la lactancia Breastfeeding description
breastfeeding_description_extended Ampliación de la descripción de la lactancia Breastfeeding description extended
interactions Interacciones Interactions
warnings Advertencias Warnings
keywords Palabras clave 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": "es"
}

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": "es"
}

Dietary Restrictions

code es en
alcohol_free Sin alcohol Alcohol-free
allergens_free Sin Alérgenos Allergens free
bio Bio Bio
dairy_free Sin lácteos Dairy free
fragrance_free Sin perfume Fragrance free
gluten_free Sin gluten Gluten free
halal Halal Halal
kosher Comestible según la ley judía Kosher
lactose_free Sin lactosa Lactose free
latex_free Sin látex Latex free
low_carbs Pobre en carbohidratos Poor in carbohydrates
low_in_purine Bajo en purina Low in purine
no_nuts Libre de nueces Nut free
protein_rich Rico en proteínas Protein rich
salt_free_diet Libre de sal Salt free
soy_free Sin soya Soy free
sugar_free Sin azúcar Sugar free
vegan Vegano Vegan
vegetarian Vegetariano Vegetarian
without_dyes Sin tintes Without dyes
without_fructose Sin fructosa Without fructose
without_palm_oil Sin aceite de palma Without palm oil
without_preservatives Sin conservantes Without preservatives
yeast_free Sin levadura Yeast free

Colors

code es en
beige Beige Beige
black Negro Black
blue Azul Blue
bordeaux Burdeos Bordeaux
brown Marrón Brown
gold Oro Gold
gray Gris Gray
green Verde Green
khaki Caqui Khaki
multicolor Multicolor Multicolor
ocher Ocre Ocher
orange Naranja Orange
pink Rosa Pink
purple Púrpura Purple
red Rojo Red
transparent Transparente Transparent
white Blanco White
yellow Amarillo 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