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.
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.
"first": "https://api.outtra.com/api/v1/datahub/product/link-to-first-page",
Meta
Here you find meta information about the current response.
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.
gtin
Here you will find the GTIN number of this product variant.
attributes
Within the attribites object you will find all the other information.
name
Here you will find the name of the product.
productSetId
The productSetId describes the highest grouping ID of a certain product. It is unique.
colorSetId
The color set id describes a specific color set within the main product. One productSetId can contain many colorSetIds.
manufacturerArticleNumber
Here you will find the manufacturer article number.
season
The season field contains the season of the product. This can be the following:
spring_summer
autumn_winter
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.
sizeSystem
Here you find the matching size system for the size value.
"Red"
White
Black
Red
Pink
Blue
Purple
Grey
Yellow
Green
Brown
Orange
Turquoise
Beige
Multicoloured
Silver
Olive
No Color
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.
videos
This can contain multiple objects for each video. This objects contain the following values.
url: the embed url for the video
In this object you will find all the information about attributes which are forwarded directly from the manufacturer.