OUTTRA DataHub API

Postman collection → OpenAPI spec →

Introduction

Documentation for the OUTTRA DataHub API

Base URL: https://api.outtra.com

This documentation aims to provide all the information you need to work with our API.

This is how a general structure of our product looks like:

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can request a token from our support team at support-en@outtra.com

Endpoints

GET api/v2/datahub/products

GET

https://datahub_api.test

/api/v2/datahub/products

requires authentication

Query the DataHub for product information.

Important:

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

language

string

Returns the data in the specific language, if available. Expects a ISO-639-1 two-character language code. Fallback is english (en).

Example:

page[size]

integer

Set the number of elements returned. Max is 30.

Example:

page[number]

integer

Pagination found under the links attribute in the response.

Example:

filter[brand]

integer

Filters the data to a brand. Expects an ID that can be retrieved via the /datahub/my/brands endpoint.

Example:

136

filter[gtin]

string

The global identifier for a certain product. You can request for information about up to 1.000 gtins (or eans) seperated by comma.

Example:

04251422560870

filter[manufacturerArticleNumber]

string

Filters the data to a specific manufacturer article number. Best combined with the brand filter as manufacturer article numbers may not be unique.

Example:

3391022XL

filter[productSetId]

number

Filters the data to a specific product set. A product set includes all GTINs across all sizes and colors in a product.

Example:

5487

filter[colorSetId]

number

Filters the data to a specific color set.

Example:

filter[season]

string

Filters the data to a specific season. There are the two values "autumn_winter" and "spring_sumer", followed by a "-" and a year with four digits.

Example:

autumn_winter-2023

filter[updatedAfter]

string

Filters the response to only include data that has been updated after the given date.

Example:

2022-06-30

filter[manufacturerColor]

string

Filters the data to a specific manufacturer color. Best combined with the brand filter as manufacturer colors may not be unique.

Example:

sulphur-green

Response Fields

type

string

The type of the returned data. Example: variant

gtin

string

EAN Code / UPC Code. Example: 01234567890123

outtra_product_set_id

integer

OUTTRA ProductSetId. Example: 123456

outtra_color_set_id

integer

OUTTRA ColorSetId. Example: 0001

attributes

object

gln

string

Supplier. Example: supplier-1

product_identifier

string

Produkt No / Model No / Style No. Example: 784544

product_short_description

string

Name of Product/Modell/Style without Brand, Sex, Color or other attributes Example: Men's Rain Jacket

brand

object

updated_at

string

Date of the last update of this variant in YYYY-MM-DD format. Example: 2023-02-13

media

string[]

Array of media objects.

images

string[]

Array of image objects.

url

string

URL to the image. Example: https://example.com/image.jpg

position

integer

Position of the image in the order of the product images. Example: 2

hash

string

Hash value of the image. Example: ec809ddf66ed7087

updatedAt

string

The day the image was last udpated. Date format is YYYY-MM-DD. Example: 2023-04-09

shootType

string

Type of the image. Can be detail, model, main, unknown or other. Example: detail

productView

string

Describes the angle of the shoot. Can be front, back, top, bottom, side. Example: front

videos

string[]

Array of video objects.

fedas_code

string

Product Group Code according FEDAS. Example: 201042

category_level_1

string

Brand Webshop Product Group highest Level. Example: Clothing

category_level_2

string

Brand Webshop Product Group 2. Level. Example: Jackets

sex

string

Gender information. Can be empty if no information is available. Possible values, if information is available: Male FemaleUnisex. Example: Male

kids

boolean

Identification of Kids-Products.Can be empty if no information is available. Possible values, if information is available: true false. Example: false

age_group

string

Identifies the target audiences age group. Can be empty if no information is available. Possible values, if information is available: adults kids no age. Example: adults

country_of_origin

string

Country of Origin (Country in which item is manufactured). Example: DE

customs_tariff_ch

integer

Customs Tariff CH. Example: 123456

customs_tariff_eu

integer

Customs Tariff EU. Example: 123456

customs_tariff_scandinavia

integer

Customs Tariff Scandinavia. Example: 123456

sales_unit

integer

Sales unit Example: 1

packing_unit

integer

Number of pieces in Packing Unit Example: 1

weight_packing_unit

integer

Packing Unit weight in gramm Example: 420

product_longtext

string

Product description according Brand-Homepage Example: Lorem ipsum dolor sit amet

usps

string

USP's of Product top features Example: Lorem ipsum dolor sit amet

activity

string

Usage of Product (Bike, Urban+City, Backpacking, Camping, Climbing, Hiking, etc.) Example: Hiking

sustainability

string

Sustainability feature of Product Example: Fair Wear Foundation

goretex

boolean

Tagging of used GORE-TEX Material Technology. Can be empty if no information is available. Possible values, if information is available: true false. Example: true

vegan

boolean

The product is vegan. Can be empty if no information is available. Possible values, if information is available: true false. Example: false

features

string

Specific Product feature, to be used as comparing/filter criteria Example: Breathable, Cooling, Quick drying

material

string

Material composition Example: 80% Cotton|20% Polyester

main_material

string

Material composition of the main material Example: 80% Cotton

main_material_information

string

Marketing description of the main material by the manufacturer

outer_material

string

Material composition of the outer material Example: 80% Cotton

outer_material_information

string

Marketing description of the outer material by the manufacturer

outer_material_2

string

Further material composition of the outer material Example: 20% Polyester

outer_material_information_2

string

Marketing description of the further outer material by the manufacturer

inner_material

string

Material composition of the inner material Example: 80% Cotton

inner_material_information

string

Marketing description of the inner material by the manufacturer

inner_material_2

string

Further material composition of the inner material Example: 20% Polyester

inner_material_information_2

string

Marketing description of the further inner material by the manufacturer

liner_material

string

Material composition of the liner material Example: 80% Cotton

liner_material_information

string

Marketing description of the liner material by the manufacturer

filling_material

string

Material composition of the filling material Example: 80% Cotton

filling_material_information

string

Marketing description of the filling material by the manufacturer

sole

string

Material composition

sole_information

string

Brand/Marketing description of material composition of the sole

care_instructions

string

Care / Washing instructions Example: Wash at 30°C, Do not bleach, Do not tumble dry, Do not iron, Do not dry clean

textile_care_washing

string

Washing instructions Example: Wash at 30°C

textile_care_bleaching

string

Bleaching instructions Example: Do not bleach

textile_care_drying

string

Drying instructions Example: Do not tumble dry

textile_care_ironing

string

Ironing instructions Example: Do not iron

textile_professional_textile_care

string

Professional cleaning instructions Example: Do not dry clean

hazard_note

string

Download Link for Prduct Hazard Note Example: https://example.com/hazard-note.pdf

product_instructions_url

string

Download Link for Product User Manual Example: https://example.com/user-manual.pdf

hang_tag_url

string

Download Link for Hang Tag Example: https://example.com/hang-tag.pdf

size_table_shoes

string

Download Link for Size Table Shoes Example: https://example.com/size-table-shoes.pdf

size_table_men_url

string

Download Link for Size Table Men Apparel Example: https://example.com/size-table-men.pdf

size_table_women_url

string

Download Link for Size Table Women Apparel Example: https://example.com/size-table-women.pdf

size_table_kids_url

string

Download Link for Size Table Kids Apparel Example: https://example.com/size-table-kids.pdf

manufacturer_color_code

string

Model-Color Number of the Brand Example: 98754

manufacturer_color

string

Model-Color of the Brand Example: green moss

base_color

string

Description of color family (eg. red, blue, black, green, yellow, pink, etc.) Example: red

seasons

string

Season of the Model-Color Example: Autumn / Winter 2023

seasons_code

string

Season code of the Model-Color Example: autumn_winter-2023

spin_360

string

Download Link for Product Picture 360° Example: https://example.com/360.jpg

product_dimensional_drawing_url

string

Download Link for Product Dimensional Drawing Example: https://example.com/dimensional-drawing.pdf

fedas_code_size

string

Size Code according to FEDAS Example: 54687

size_range

string

Definition of size system Example: S-XXXL

manufacturer_size_code

string

Size code provided by the manufacturer Example: 3XL

size_description

string

Size Description (eg. S / M / L / XL / 42 / 43 …) Example: S

size_description_2

string

2nd Size Description eg. for trousers with various leg lengths or backpacks with various back length Example: 32

volume

string

2nd Volume in Liter (eg. For Backpacks, Bags) Example: 20

volume_additional

string

Additional Volume as extension for Backpacks, Bags Example: 5

gtin

string

EAN Code / UPC Code Example: 01234567891234

sku_supplier

string

Supplier Code of Stock Keeping Unit Example: JK-1234

weight

integer

Article weight Example: 380

weight_unit

string

Article weight unit Example: g

weight_info

string

If weight is not delivers by size: Standard size to be mentioned Example: S

wholesale_price

string

Purchasing Price (PP) no discounts deducted excluding VAT Example: 85,00

wholesale_price_unit

string

Currency of PP in ISO 4217 format. Example: EUR

wholesale_price_valid_from_date

string

Valid from date of PP Example: 2023-01-01

rrp

string

Recommended Retail Price incl. VAT Example: 99,99

rrp_unit

string

Currency of RRP in ISO 4217 format. Example: EUR

rrp_2

string

Recommended Retail Price incl. VAT Example: 99,99

rrp_2_unit

string

Currency of RRP in ISO 4217 format. Example: USD

rrp_3

string

Recommended Retail Price incl. VAT Example: 99,99

rrp_3_unit

string

Currency of RRP in ISO 4217 format. Example: CHF

rrp_price_valid_from_date

string

Valid from date of RRP Example: 2023-01-01

delivery_date

string

earliest possible delivery date Example: 2023-01-01

height

integer

Height of the item Example: 100

height_unit

string

Height unit Example: cm

width

integer

Width of the item Example: 100

width_unit

string

Width unit Example: cm

length

integer

Length of the item Example: 100

length_unit

string

Length unit Example: cm

diameter

integer

Diameter of the item Example: 100

diameter_unit

string

Diameter unit Example: cm

packing_unit_height

integer

Height of the packing unit Example: 100

packing_unit_height_unit

string

Height unit Example: cm

packing_unit_width

integer

Width of the packing unit Example: 100

packing_unit_width_unit

string

Width unit Example: cm

packing_unit_length

integer

Length of the packing unit Example: 100

packing_unit_length_unit

string

Length unit Example: cm

packing_unit_diameter

integer

Diameter of the packing unit Example: 100

packing_unit_diameter_unit

string

Diameter unit Example: cm

delivery_unit_height

integer

Height of the delivery unit Example: 100

delivery_unit_height_unit

string

Height unit Example: cm

delivery_unit_width

integer

Width of the delivery unit Example: 100

delivery_unit_width_unit

string

Width unit Example: cm

delivery_unit_length

integer

Length of the delivery unit Example: 100

delivery_unit_length_unit

string

Length unit Example: cm

delivery_unit_diameter

integer

Diameter of the delivery unit Example: 100

delivery_unit_diameter_unit

string

Diameter unit Example: cm

carry_over_from_style

string

Style to carry over from Example: winter-2022

carry_over_to_style

string

Style to carry over to Example: winter-2023

carry_over_from_stylecolor

string

Style & color to carry over from Example: AB12345

carry_over_to_stylecolor

string

Style &color to carry over to Example: CD67890

workbook_picture_url

string

Download Link for Workbook Picture Example: https://example.com/workbook.jpg

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://datahub_api.test/api/v2/datahub/products?language=de&page%5Bsize%5D=2&page%5Bnumber%5D=1&filter%5Bbrand%5D=136&filter%5Bgtin%5D=04251422560870&filter%5BmanufacturerArticleNumber%5D=3391022XL&filter%5BproductSetId%5D=5487&filter%5BcolorSetId%5D=1&filter%5Bseason%5D=autumn_winter-2023&filter%5BupdatedAfter%5D=2022-06-30&filter%5BmanufacturerColor%5D=sulphur-green" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "type": "variant",
            "gtin": "01234567891234",
            "attributes": {
                "gln": "supplier-1",
                "product_identifier": "784544",
                "product_short_description": "Men's Rain Jacket",
                "brand": {
                    "id": "845",
                    "name": "Example Brand"
                },
                "media": {
                    "images": [
                        {
                            "url": "https://imagehub.outtra.com/images/asd7nxil2i/3247hnoiau7n/01234567891234/mens-rain-jacket--B-01.png",
                            "position": 1,
                            "hash": "ec809ddf66ed7087",
                            "updatedAt": "2023-04-09",
                            "shootType": "hollow",
                            "productView": "front"
                        },
                        {
                            "url": "https://imagehub.outtra.com/images/asd7nxil2i/3247hnoiau7n/01234567891234/mens-rain-jacket--B-02.png",
                            "position": 2,
                            "hash": "bd4b61e1c2700ecb",
                            "updatedAt": "2023-04-09",
                            "shootType": "model",
                            "productView": "front"
                        },
                        {
                            "url": "https://imagehub.outtra.com/images/asd7nxil2i/3247hnoiau7n/01234567891234/mens-rain-jacket--M-01.jpg",
                            "position": 3,
                            "hash": "fbba25e06c2fe2d6",
                            "updatedAt": "2023-04-09",
                            "shootType": "hollow",
                            "productView": "back"
                        },
                        {
                            "url": "https://imagehub.outtra.com/images/asd7nxil2i/3247hnoiau7n/01234567891234/mens-rain-jacket--M-02.jpg",
                            "position": 4,
                            "hash": "45273a6fac1bc168",
                            "updatedAt": "2023-04-09",
                            "shootType": "hollow",
                            "productView": "left"
                        },
                        {
                            "url": "https://imagehub.outtra.com/images/asd7nxil2i/3247hnoiau7n/01234567891234/mens-rain-jacket--D-01.jpg",
                            "position": 5,
                            "hash": "335506130662c784",
                            "updatedAt": "2023-04-09",
                            "shootType": "hollow",
                            "productView": "right"
                        },
                        {
                            "url": "https://imagehub.outtra.com/images/asd7nxil2i/3247hnoiau7n/01234567891234/mens-rain-jacket--D-02.jpg",
                            "position": 6,
                            "hash": "0814878367256eca",
                            "updatedAt": "2023-04-09",
                            "shootType": "detail",
                            "productView": "unkown"
                        }
                    ],
                    "videos": [
                        {
                            "url": "https://www.example.com/123456789",
                            "type": "video_product"
                        },
                        {
                            "url": "https://www.example.com/123456789",
                            "type": "video_instruction"
                        }
                    ]
                },
                "fedas_code": "201042",
                "category_level_1": "Clothing",
                "category_level_2": "Jackets",
                "category_level_3": "Rain Jackets",
                "sex": "Male",
                "kids": false,
                "age_group": "1",
                "country_of_origin": "DE",
                "customs_tariff_ch": "123456",
                "customs_tariff_eu": "123456",
                "customs_tariff_scandinavia": "123456",
                "sales_unit": "1",
                "packing_unit": "1",
                "weight_packing_unit": "420",
                "usps": "Robust, elastic, lightweight rain jacket",
                "material": "100% Polyester",
                "product_longtext": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.",
                "activity": "Hiking",
                "sustainability": "Fair Wear Foundation",
                "goretex": true,
                "vibram": false,
                "features": "Breathable, Cooling, Quick drying",
                "vegan": false,
                "care_instructions": "Wash at 30°C, Do not bleach, Do not tumble dry, Do not iron, Do not dry clean",
                "video_product": "",
                "video_instruction": "",
                "hazard_note": "https://www.example.com/123456789",
                "product_instructions_url": "https://www.example.com/123456789",
                "hang_tag_url": "https://www.example.com/123456789",
                "size_table_shoes_url": "https://www.example.com/123456789",
                "size_table_men_url": "https://www.example.com/123456789",
                "size_table_women_url": "https://www.example.com/123456789",
                "size_table_kids_url": "https://www.example.com/123456789",
                "manufacturer_color_code": "98754",
                "manufacturer_color": "green moss",
                "base_color": "Green",
                "season": "autumn_winter-2023",
                "spin_360": "https://www.example.com/123456789",
                "product_dimensional_drawing_url": "https://www.example.com/123456789",
                "fedas_code_size": "54687",
                "size_range": "S-XXL",
                "manufacturer_size_code": "L",
                "size_description": "L",
                "size_description_2": "32",
                "volume": "",
                "volume_additional": "",
                "gtin": "01234567891234",
                "sku_supplier": "JK-1234",
                "weight": "380",
                "weight_unit": "g",
                "weight_info": "Weight in gramm",
                "wholesale_price": "85",
                "wholesale_price_unit": "EUR",
                "wholesale_price_valid_from_date": "2023-01-01",
                "rrp": "199",
                "rrp_unit": "EUR",
                "rrp_2": "",
                "rrp_2_unit": "",
                "rrp_3": "",
                "rrp_3_unit": "",
                "rrp_valid_from_date": "2023-01-01",
                "delivery_date": "2023-01-01",
                "height": "100",
                "height_unit": "cm",
                "width": "100",
                "width_unit": "cm",
                "length": "100",
                "length_unit": "cm",
                "diameter": "100",
                "diameter_unit": "cm",
                "packing_unit_height": "100",
                "packing_unit_height_unit": "cm",
                "packing_unit_width": "100",
                "packing_unit_width_unit": "cm",
                "packing_unit_length": "100",
                "packing_unit_length_unit": "cm",
                "packing_unit_diameter": "100",
                "packing_unit_diameter_unit": "cm",
                "delivery_unit_height": "100",
                "delivery_unit_height_unit": "cm",
                "delivery_unit_width": "100",
                "delivery_unit_width_unit": "cm",
                "delivery_unit_length": "100",
                "delivery_unit_length_unit": "cm",
                "carry_over_from_style": "winter-2022",
                "carry_over_to_style": "winter-2023",
                "carry_over_from_stylecolor": "AB12345",
                "carry_over_to_stylecolor": "CD67890",
                "main_material": "",
                "main_material_information": "",
                "outer_material": "",
                "outer_material_information": "",
                "outer_material_2": "",
                "outer_material_2_information": "",
                "inner_material": "",
                "inner_material_information": "",
                "inner_material_2": "",
                "inner_material_2_information": "",
                "liner_material": "",
                "liner_material_information": "",
                "filling_material": "",
                "filling_material_information": "",
                "sole": "",
                "sole_information": "",
                "textile_care_washing": "",
                "textile_care_bleaching": "",
                "textile_care_drying": "",
                "textile_care_ironing": "",
                "textile_care_professional_textile_care": "",
                "workbook_picture_url": ""
            }
        }
    ],
    "links": {
        "first": "https://api.outtra.com/api/v2/datahub/products?filter%5Bbrand%5D=136&page%5Bnumber%5D=1",
        "last": null,
        "prev": null,
        "next": "https://api.outtra.com/api/v2/datahub/products?filter%5Bbrand%5D=136&page%5Bnumber%5D=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "https://api.outtra.com/api/v2/datahub/products",
        "per_page": 30,
        "to": 30
    }
}

GET api/v2/datahub/units

GET

https://datahub_api.test

/api/v2/datahub/units

requires authentication

Query the DataHub for unit information.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://datahub_api.test/api/v2/datahub/units" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "type": "unit",
            "outtra_unit_id": 1,
            "attributes": {
                "name": "Kilogramm",
                "abbreviation": "kg"
            }
        },
        {
            "type": "unit",
            "outtra_unit_id": 2,
            "attributes": {
                "name": "Gramm",
                "abbreviation": "g"
            }
        },
        {
            "type": "unit",
            "outtra_unit_id": 3,
            "attributes": {
                "name": "Liter",
                "abbreviation": "l"
            }
        },
        {
            "type": "unit",
            "outtra_unit_id": 4,
            "attributes": {
                "name": "Milliliter",
                "abbreviation": "ml"
            }
        },
        {
            "type": "unit",
            "outtra_unit_id": 5,
            "attributes": {
                "name": "Millimeter",
                "abbreviation": "mm"
            }
        },
        {
            "type": "unit",
            "outtra_unit_id": 6,
            "attributes": {
                "name": "Meter",
                "abbreviation": "m"
            }
        },
        {
            "type": "unit",
            "outtra_unit_id": 7,
            "attributes": {
                "name": "Centimeter",
                "abbreviation": "cm"
            }
        },
        {
            "type": "unit",
            "outtra_unit_id": 8,
            "attributes": {
                "name": "Grad Celsius",
                "abbreviation": "° C"
            }
        },
        {
            "type": "unit",
            "outtra_unit_id": 9,
            "attributes": {
                "name": "Percent",
                "abbreviation": "%"
            }
        },
        {
            "type": "unit",
            "outtra_unit_id": 13,
            "attributes": {
                "name": "CHF",
                "abbreviation": "CHF"
            }
        },
        {
            "type": "unit",
            "outtra_unit_id": 10,
            "attributes": {
                "name": "Euro",
                "abbreviation": "€"
            }
        },
        {
            "type": "unit",
            "outtra_unit_id": 11,
            "attributes": {
                "name": "Pound Sterling",
                "abbreviation": "£"
            }
        },
        {
            "type": "unit",
            "outtra_unit_id": 12,
            "attributes": {
                "name": "US Dollar",
                "abbreviation": "$"
            }
        },
        {
            "type": "unit",
            "outtra_unit_id": 14,
            "attributes": {
                "name": "Kubikzentimeter",
                "abbreviation": "cm³"
            }
        },
        {
            "type": "unit",
            "outtra_unit_id": 15,
            "attributes": {
                "name": "Norwegische Kronen",
                "abbreviation": "NOK"
            }
        },
        {
            "type": "unit",
            "outtra_unit_id": 16,
            "attributes": {
                "name": "Inch",
                "abbreviation": "in"
            }
        }
    ]
}

GET api/v2/datahub/seasons

GET

https://datahub_api.test

/api/v2/datahub/seasons

requires authentication

Query the DataHub for season information.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

language

string

Returns the data in the specific language, if available. Expects a ISO-639-1 two-character language code. Fallback is english (en).

Example:

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://datahub_api.test/api/v2/datahub/seasons?language=de" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "type": "season",
            "outtra_season_id": 8,
            "attributes": {
                "name": "Frühjahr / Sommer 2020",
                "code": "spring_summer-2020"
            }
        },
        {
            "type": "season",
            "outtra_season_id": 7,
            "attributes": {
                "name": "Herbst / Winter 2020",
                "code": "autumn_winter-2020"
            }
        },
        {
            "type": "season",
            "outtra_season_id": 6,
            "attributes": {
                "name": "Frühjahr / Sommer 2021",
                "code": "spring_summer-2021"
            }
        },
        {
            "type": "season",
            "outtra_season_id": 5,
            "attributes": {
                "name": "Herbst / Winter 2021",
                "code": "autumn_winter-2021"
            }
        },
        {
            "type": "season",
            "outtra_season_id": 1,
            "attributes": {
                "name": "Frühjahr / Sommer 2022",
                "code": "spring_summer-2022"
            }
        },
        {
            "type": "season",
            "outtra_season_id": 2,
            "attributes": {
                "name": "Herbst / Winter 2022",
                "code": "autumn_winter-2022"
            }
        },
        {
            "type": "season",
            "outtra_season_id": 3,
            "attributes": {
                "name": "Frühjahr / Sommer 2023",
                "code": "spring_summer-2023"
            }
        },
        {
            "type": "season",
            "outtra_season_id": 4,
            "attributes": {
                "name": "Herbst / Winter 2023",
                "code": "autumn_winter-2023"
            }
        },
        {
            "type": "season",
            "outtra_season_id": 9,
            "attributes": {
                "name": "Frühjahr / Sommer 2024",
                "code": "spring_summer-2024"
            }
        },
        {
            "type": "season",
            "outtra_season_id": 10,
            "attributes": {
                "name": "Herbst / Winter 2024",
                "code": "autumn_winter-2024"
            }
        }
    ]
}

GET api/v2/datahub/my/brands

GET

https://datahub_api.test

/api/v2/datahub/my/brands

requires authentication

Query the DataHub for brands you have access to.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Response Fields

type

string

The type of the returned data. Example: brand

integer

The id of the brand. Example: 136

attributes

object

name

string

The name of the brand. Example: Ortovox

url

string

The url of the brand. Example: https://www.ortovox.com/

permissions

object

products

object

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://datahub_api.test/api/v2/datahub/my/brands" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "type": "brand",
            "id": "136",
            "attributes": {
                "name": "Ortovox",
                "url": "https://www.ortovox.de/",
                "permissions": {
                    "dataAccess": true,
                    "imageAccess": true
                },
                "products": {
                    "available": 763,
                    "updated": "2023-04-09"
                }
            }
        },
        {
            "type": "brand",
            "id": "150",
            "attributes": {
                "name": "Ziener",
                "url": "https://ziener.com/",
                "permissions": {
                    "dataAccess": true,
                    "imageAccess": true
                },
                "products": {
                    "available": 595,
                    "updated": "2023-02-22"
                }
            }
        },
        {
            "type": "brand",
            "id": "221",
            "attributes": {
                "name": "Hanwag",
                "url": "https://www.hanwag.de",
                "permissions": {
                    "dataAccess": true,
                    "imageAccess": true
                },
                "products": {
                    "available": 218,
                    "updated": "2023-03-04"
                }
            }
        }
    ],
    "links": {
        "first": "https://api.outtra.com/api/v2/datahub/my/brands?page%5Bnumber%5D=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "https://api.outtra.com/api/v2/datahub/my/brands",
        "per_page": 30,
        "to": 3
    }
}

Retailer Insights (Enterprise)

Lost Sales

GET Retailer Lost Sales Statistics

GET

https://datahub_api.test

/api/v2/retailer-insights/{outtraBrandId}/lost-sales/{customerExternalId}

requires authentication

Returns lost sales statistics for a specific dealer of a brand. The dealer is identified by the brand's internal customer ID.

This is an Enterprise feature. Access requires an active Enterprise subscription for the authenticated tenant.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

outtraBrandId

integer

required

The OUTTRA brand ID. Must match a brand accessible by the authenticated tenant.

Example:

134

customerExternalId

string

required

The brand's internal customer ID for the dealer.

Example:

MAG-42

Query Parameters

date_min

string

required

Start date in d.m.Y format.

Example:

01.01.2026

date_max

string

required

End date in d.m.Y format. Must not exceed 12 months from date_min.

Example:

31.01.2026

Body Parameters

date_min

string

required

Must be a valid date in the format d.m.Y.

Example:

19.04.2026

date_max

string

required

Must be a valid date in the format d.m.Y. Must be a date after or equal to date_min.

Example:

2033-12-09

Response Fields

data

object

dealer_name

string

Name of the dealer. Example: Bike Shop Mueller

customer_external_id

string

The brand's customer ID for this dealer. Example: MAG-42

brand_id

integer

The OUTTRA brand ID. Example: 134

brand_name

string

Name of the brand. Example: MAGURA

date_min

string

Start of the queried date range. Example: 01.01.2026

date_max

string

End of the queried date range. Example: 31.01.2026

outtra_connected

boolean

True if the dealer submits stock_items for this brand to OUTTRA, false otherwise. Example: true

kpis

object

impressions

integer

How often the dealer appeared in Dealer Locator results across all devices (mobile, tablet, desktop). Example: 279

product_searches

integer

Number of product search events where this dealer was listed for the brand's products, regardless of stock status. Example: 350

market_potential_in_eur

number

Total recommended retail price (UVP) across all product searches where the dealer appeared. Represents the full revenue potential if every searched product had been available. Example: 78888.00

lost_sales_in_eur

number

Total UVP of product searches where the dealer appeared but the product was out of stock or not stocked. Example: 70254.00

highlights

integer

Number of product searches where the dealer had the product in stock. Example: 279

products

string[]

Top 20 products sorted by lost revenue (UVP sum), descending.

product_identifier

string

Product model/style identifier as used by the brand. Example: Mt7

article_number

string

Manufacturer article number. May be null if not available. Example: mdp-9

gtin

string

Global Trade Item Number (EAN). One representative GTIN per product. May be null. Example: 04055184026014

article_name_de

string

Product name in German. May be null. Example: Bremsscheibe MDR-P

article_name_en

string

Product name in English. May be null. Example: Brake Disc MDR-P

searches

integer

Number of unique search events for this product where the dealer appeared. Example: 120

lost_revenue_in_eur

number

Total UVP across all search events for this product. Example: 3548.00

uvp_max

number

Highest recommended retail price (UVP) seen for this product in the queried period. Example: 89.90

chart_data

string[]

Time series data points. Uses daily intervals for ranges up to 31 days, monthly intervals for longer ranges.

Auth

Bearer

Headers

URL Parameters

Query Parameters

Body

{ "date_min": "19.04.2026", "date_max": "2033-12-09" }

Received response

Example request:

curl --request GET \
    --get "https://datahub_api.test/api/v2/retailer-insights/134/lost-sales/MAG-42?date_min=01.01.2026&date_max=31.01.2026" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"date_min\": \"19.04.2026\",
    \"date_max\": \"2033-12-09\"
}"

Example response:

{
    "data": {
        "dealer_name": "Bike Shop Mueller",
        "customer_external_id": "MAG-42",
        "brand_id": 134,
        "brand_name": "MAGURA",
        "date_min": "01.01.2026",
        "date_max": "31.01.2026",
        "outtra_connected": true,
        "kpis": {
            "impressions": 279,
            "product_searches": 350,
            "market_potential_in_eur": 78888,
            "lost_sales_in_eur": 70254,
            "highlights": 279
        },
        "products": [
            {
                "product_identifier": "Mt7",
                "article_number": "mdp-9",
                "gtin": "04055184026014",
                "article_name_de": "Bremsscheibe MDR-P",
                "article_name_en": "Brake Disc MDR-P",
                "searches": 120,
                "lost_revenue_in_eur": 3548,
                "uvp_max": 89.9
            }
        ],
        "chart_data": [
            {
                "label": "2026-01-15T00:00:00.000Z",
                "market_potential_in_eur": 5000,
                "lost_sales_in_eur": 3500,
                "impressions": 25
            }
        ]
    }
}