/products/

Endpoints to get sustainability fields of subscribed products.

https://connect.consupedia.com/api/v2/subscribe/

This endpoint enables the subscription of products. The request should have a JSON object in the body.

Request body

The JSON formatted body (Content-type application/json) should by an Array of products.

A product is required to have at least gtin field:

[
    {
        "gtin": "123456789010"
    },
    {
        "gtin": "923456789010"
    }
];

If you want to supply more product data, the following fields may also be added:

[
    {
      "gtin": STRING,
      "name": STRING,
      "ingredients": STRING,
      "origin": STRING,
      "category": STRING,
      "brand": STRING,
      "size": FLOAT,
      "size_unit": STRING,
      "image_url": TEXT,
      "price": FLOAT,
      "price_currency": STRING,
      "is_eco": INTEGER (1 or 0),
      "certificates": STRING
    }
];

Here is the available fields in table form with short descriptions:

Supported Languages

For best results, add text data in Swedish or English.

Update a subscription with more data

If you got more/changed product information and would like to update your subscription, use the same method and body as a new subscription. If the subscription already exists, the subscription will be updated.

cURL example

  curl -X POST 'https://connect.consupedia.com/api/v2/subscribe/' \
  -H 'X-API-KEY: your_api_key' \
  -H 'Content-Type: application/json' \
  -d '[
    {
        "gtin": "123456789010"
    },
     {
        "gtin": "923456789010"
    }
]'

Response example

{
  "status": "success",
  "message": "Products subscribed",
  "client": "Consupedia",
  "productsSubscribed": 1,
  "unknownProductsSubscribed": 1,
  "productsSkipped": 0
}

https://connect.consupedia.com/api/v2/subscribe/more/add

This endpoint enables the subscription of products with rich product data. The request should have a JSON object in the body.

Request body

The JSON formatted body (Content-type application/json) should be a product represented as a single object.

A product is required to have at least gtin or client_identifier field:

{
  "gtin": "12345678901011",
}

If you want to supply more product data, the following fields may also be added:

{
      "gtin": STRING,
      "client_identifier": STRING,
      "name": STRING,
      "information_provider_gln": STRING,
      "category": STRING,
      "subcategory": INTEGER,
      "brand_name": STRING,
      "external_name": STRING,
      "functional_name": STRING,
      "packaging_label": STRING,
      "country_of_origin": STRING,
      "provenance_statement": STRING,
      "raw_material_origin": STRING,
      "packaging_type": STRING,
      "packaging_material": STRING,
      "packaging_material_quantity": FLOAT,
      "packaging_material_unit": STRING,
      "ingredients": TEXT,
      "size": STRING,
      "alcohol_percentage": FLOAT,
      "preparation_state": STRING,
      "nutrient_basis_quantity": FLOAT,
      "nutrient_basis_unit": STRING,
      "quantity_energy_kj": FLOAT,
      "quantity_energy_kcal": FLOAT,
      "quantity_fat": FLOAT,
      "quantity_part_saturated_fat": FLOAT,
      "quantity_part_monounsaturated_fat": FLOAT,
      "quantity_part_polyunsaturated_fat": FLOAT,
      "quantity_carbohydrate": FLOAT,
      "quantity_part_sugars": FLOAT,
      "quantity_part_polyols": FLOAT,
      "quantity_part_starch": FLOAT,
      "quantity_fibre": FLOAT,
      "quantity_protein": FLOAT,
      "quantity_salt":FLOAT,
      "secondary_preparation_state": STRING,
      "secondary_nutrient_basis_quantity": FLOAT,
      "secondary_nutrient_basis_unit": STRING,
      "secondary_quantity_energy_kj": FLOAT,
      "secondary_quantity_energy_kcal": FLOAT,
      "secondary_quantity_fat": FLOAT,
      "secondary_quantity_part_saturated_fat": FLOAT,
      "secondary_quantity_part_monounsaturated_fat": FLOAT,
      "secondary_quantity_part_polyunsaturated_fat": FLOAT,
      "secondary_quantity_carbohydrate": FLOAT,
      "secondary_quantity_part_sugars": FLOAT,
      "secondary_quantity_part_polyols": FLOAT,
      "secondary_quantity_part_starch": FLOAT,
      "secondary_quantity_fibre": FLOAT,
      "secondary_quantity_protein": FLOAT,
      "secondary_quantity_salt":FLOAT,
      "marketing_message": TEXT,
      "image_original": STRING,
      "image_high_res": STRING,
      "image_low_res": STRING
    }

Here is the available fields in table form with short descriptions:

Supported Languages

For best results, add text data in Swedish or English.

Update a subscription with more data

If you got more/changed product information and would like to update your subscription, use the same method and body as a new subscription. If the subscription already exists, the subscription will be updated.

cURL example

  curl -X POST 'https://connect.consupedia.com/api/v2/subscribe/add/more' \
  -H 'X-API-KEY: your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "gtin": "123456789010"
  }'
  

Response example

{
    "status": "success",
    "action": "subscription_created",
    "client": "Demo Company Inc.",
    "subscriptions": {
        "current_count": 124,
        "max_limit": 2000
    }
}

End a product subscription by calling /subscribe/:gtin with the DELETE method.

Path Parameters

• id: Global Trade Item Number (GTIN)
  • Description: The unique identifier for the product.
  • Type: String
  • Example: "0000000000001"

cURL example

curl --location --request DELETE 'https://connect.consupedia.com/api/v2/subscribe/123456789010' --header 'X-API-KEY: your_api_key'

End a product subscription by client_identifier.

Path Parameters

• client_identifier: Your own identifier associated with a subscribed product.
  • Description: The unique identifier for the product.
  • Type: String
  • Example: "abc0000000000001"

cURL example

curl --location --request DELETE 'https://connect.consupedia.com/api/v2/subscribe/unsubscribeById/abc-123' --header 'X-API-KEY: your_api_key'

Response

{
    "status": "success",
    "message": "Product unsubscribed",
    "action": "product_unsubscribed",
    "client": "Consupedia"
}