Data & Image Hub API Product Endpoint

Here you will find detailed information about how to use our Data & Image Hub API Product Endpoint

Information about the documentation

In this documentation your will find details about the OUTTRA Data & Image Hub API Product Endpoint.

The colored fields will tell you the following information:

This ins an example filter / response.

This will tell you which fixed resonses you can get.

 

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

products_clolors_sizes

Request structure

Endpoint

https://api.outtra.com/api/v1/datahub/products

Method

GET

Authorization

Bearer-Token

You will get your token from the OUTTRA support team.

Parameters

To filter your response you can use the filter parameter as an array.

Example query:

https://api.outtra.com/api/v1/datahub/products?filter[gtin]=0423456789123,0438726123748,04239287362517&filter[brandId]=123&filter[updated_after]=2022-07-01

 

Available Filters

You can add filters to your query. They have the following structure:

?fiter[$FILTER_NAME]=$FILTER_VALUE

At least one of the following filters has to be used to receive a response.


brand
: A numeric identifier for a brand.

?filter[brand]=150


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

?filter[gtin]=0423456789123,0438726123748,04239287362517


season
: Identify a certain season. There are the two values "autumn_winter" and "spring_sumer", followed by a "-" and a year with four digits. For example:

?filter[season]=autumn_winter-2022

?filter[season]=spring_summer-2023


updatedAfter
: You can send a data string here an you'll get as response all products which had a change in the product information or media assets. For example:

?filter[updatedAfter]=2022-06-30


manufacturerArticleNumber:
You can filter for a manufacturer article number here.

?filter[manufacturerArticleNumber]=224102


manufacturerColor:
You can filter for a manufacturer color here.

?filter[manufacturerColor]=black


productSetId:
  The product set id can be used as a filter here.

?filter[productSetId]=18024


colorSetId:
A color set id can be also used as filter criteria.

?filter[colorSetId]=0001

 

Response wrapper

The response wrapper consists of three keys: data, links and meta.

 

Data

Contains the response objects pertaining to your request. There will be up to 100 items in the response. Pagination is available for more than 100 items.

Links

This contains the pagination information.

"links": {
        "first": "https://api.outtra.com/api/v1/datahub/product/link-to-first-page",
        "last": "https://api.outtra.com/api/v1/datahub/product/link-to-last-page",
        "prev": "https://api.outtra.com/api/v1/datahub/product/link-to-previous-page",
        "next": "https://api.outtra.com/api/v1/datahub/product/link-to-next-page"
    }


Meta

Here you find meta information about the current response.

"meta": {
        "current_page": 2,
        "from": 31,
        "last_page": 19,
        "links": [
            {
                "url": null,
                "label": "« Zurück",
                "active": false
            },
            {
                "url": "https://api.outtra.com/api/v1/datahub/products/demo-url",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Weiter »",
                "active": false
            }
        ],
        "path": "https://api.outtra.com/api/v1/datahub/products",
        "per_page": 30,
        "to": 60,
        "total": 560
    }

Structure

type        
gtin        
attributes      
  name      
  productSetId      
  colorSetId      
  manufacturerArticleNumber    
  season      
  seasonYear      
  gender      
  size      
  sizeSystem      
  colors      
  updatedAt      
  brand    
    id    
    name    
  media      
    images    
      url  
      position  
      hash  
      updatedAt  
    videos    
      url  
 
 
 
   
 
      value  
      properties  
        language
     
    description  
      value  
      properties  
        language
    manufacturerColor  
    manufacturerColorCode  
    manufacturerSize  
    materialsText    
      value  
      properties  
        language
    tarifNo    
    weight    
      unit  
        id
        abbreviation
      value  
    height    
      unit  
        id
        abbreviation
      value  
    width    
      unit  
        id
        abbreviation
      value  
    depth    
      unit  
        id
        abbreviation
      value  

 

Overview

Every resonse consist of different sections.

  • general informationHere you find the information about the type of the resonse and the gtin.

  • attributes
    This section contains several product specifit attributes like the name, season and different ther IDs and informantion.

  • media
    In this section you will find linkt to images and videos about this gtin.

  • manufacturerAttributes
    Here you will find different attributes which are forwarded directly form the manufacturer.

General information

type

This element tells you which type of response you get.

"type": "variant"


gtin

Here you will find the GTIN number of this product variant.

"gtin": "04063833539136"

attributes

Within the attribites object you will find all the other information.

name

Here you will find the name of the product.

"name": "TILFA lady jacket"


productSetId

The productSetId describes the highest grouping ID of a certain product. It is unique.

 "productSetId": "18024"


colorSetId
The color set id describes a specific color set within the main product. One productSetId can contain many colorSetIds.

"colorSetId": "0001"


manufacturerArticleNumber

Here you will find the manufacturer article number.

"manufacturerArticleNumber": "224102"


season

The season field contains the season of the product. This can be the following:

spring_summer

autumn_winter

 
seasonYear
Here you will find the specific year for the product.
"seasonYear": "2022"
 
gender
This tells you for which gender this product is. It can contain the following values.

Unisex
Babys
Men
Women
Kids
Girls
Boys
NoGender
BabyBoys
BabyGirls


size

You will find the size of this specific product here. Sizes are normalized from the manufacturer size. Check the manufacturerAttributes section for the original size.

"size": "42"


sizeSystem

Here you find the matching size system for the size value.

"sizeSystem": "EU"
 
colors (array)
Here you will find the normalized colors for this product.
"colors": [
   "Black",
   "Red"
]
Possible colors are the following.

White
Black
Red
Pink
Blue
Purple
Grey
Yellow
Green
Brown
Orange
Turquoise
Beige
Multicoloured
Silver
Olive
No Color


updatedAt
This date tells you when something at this product changed.
"updatedAt": "2022-07-30"

brand (object)
This object contains the information about the brand of the product. This information consists of an id and a name.
"brand": {
    "id": "150",
    "name": "Ziener"
}

media (object)

This object contains all the information about media assets like images and videos.

It has up to two keys.

images

videos


images

This can contain multiple objects for each image.  This objects contain the following values.

url: the url to download this image

position: the position of this image, f.e. 1 or 2

hash: the hash value for this image

updatedAt: a  date value when this images was last updated

An example for such an image key can look like this.

"images": [
      {
         "url": "https://imagehub.outtra.com/images/example1.jpg",
         "position": 1,
         "hash": "905eba49a24c309b",
         "updatedAt": "2022-06-30"
        },
       {
           "url": "https://imagehub.outtra.com/images/example2.jpg",
           "position": 2,
           "hash": "75a40277da616fbb",
           "updatedAt": "2022-06-30"
        }
]


videos
This can contain multiple objects for each video.  This objects contain the following values.

url: the embed url for the video

"videos": [
                        {
                            "url": "https://youtu.be/5MxUqpoV7bY"
                        }
                        {
                            "url": "https://youtu.be/5MxUqpoV7bY"
                        }
]

manufacturerAttributes

In this object you will find all the information about attributes which are forwarded directly from the manufacturer. 

careInstructions
There you will find language specific care instructions for the product. It is an array which contains multiple objects with the fields value, and the object properties with the key language.
See the following example.
"careInstructions": [
   {
         "value": "--- Pflegeanleitung ---\n- Maschienenwäsche 30°C, pflegeleicht\n- nicht bleichen\n- nicht im Trockner trocknen\n- nicht bügeln\n- keine chemische Reinigung\n- keinen Weichspüler verwenden\n- separat waschen\n- alle Verschlüsse vor dem Waschen schließen",
          "properties": {
                "language": "de"
            }
       },
       {
         "value": "--- Washing instructions ---\n- machine wash 30°C gentle\n- do not bleach\n- do not tumble dry\n- do not iron\n- no professional textil care\n- do not use softener\n- wash with similar colours\n- close all fastenings before cleaning",
              "properties": {
                    "language": "en"
                }
            }
]

countryOfOrigin
Here you find the country in which the product was produced.
"countryOfOrigin": "Vietnam"
 
description
This object contains and array with multiple objects with the multilang description.
value: contains the description text
properties: contains a key language, which tells the language of the description.
"description": [
    {
    "value": "Die funktionelle, wattierte ZIENER Damen Skijacke TILFA LADY überzeugt mit ihren zahlreichen Detaillösungen sowie dem Einsatz von hochwertigen Materialien.",
     "properties": {
              "language": "de"
               }
        },
        {
       "value": "The functional, padded ZIENER ladies’ ski jacket TILFA LADY impresses with its numerous detailed solutions and the use of high-quality materials.",
       "properties": {
               "language": "en"
                 }
        }
]

manufacturerColor
Here you will find the manufacturer color.
"manufacturerColor": "black"

manufacturerColorCode
This field contains the manufacturer color code.
"manufacturerColorCode": "12"

manufacturerSize
Here you will find the size from the manufacturer for this product.
"manufacturerSize": "42"
 
materialsText
This object contains and array with multiple objects with the multilang material description.
value: contains the materials text
properties: contains a key language, which tells the language of the material text.
"materialsText": [
     {
      "value": "Obermaterial: 1 00% Polyester;  Futter: 1. 100% Polyester, 2. 100% Polyamid; Wattierung: 100% Polyester;",
      "properties": {
              "language": "de"
               }
        },
        {
         "value": "Shell: 100% Polyester;  Lining: 1. 100% Polyester, 2. 100% Polyamide; Insulation: 100% Polyester;",
              "properties": {
                     "language": "en"
                }
           }
]

tarifNo
In this field you find the tarif number for this product.
"tarifNo": "62105000"
weight
This contains the weight of the product. There is an object unit which includes an id and an 
abbreviation. Additional to this, there is a value wich contains the weight.
"weight": [
        {
            "unit": {
                 "id": 1,
                 "abbreviation": "kg"
              },
              "value": "0.94"
           }
]

height
This contains the height of the product. There is an object unit which includes an id and an 
abbreviation. Additional to this, there is a value wich contains the height.
"height": [
          {
              "unit": {
               "id": 7,
               "abbreviation": "cm"
                },
               "value": "80"
           }
 ]
 
width
This contains the width of the product. There is an object unit which includes an id and an 
abbreviation. Additional to this, there is a value wich contains the width.
"width": [
          {
              "unit": {
                     "id": 7,
                      "abbreviation": "cm"
                 },
                 "value": "60"
              }
]
 
depth
This contains the depth of the product. There is an object unit which includes an id and an 
abbreviation. Additional to this, there is a value wich contains the width.
"depth": [
          {
               "unit": {
                      "id": 7,
                      "abbreviation": "cm"
                },
           "value": "10"
           }
]