PRoductS v5

Category names

Get translated category names for a product

To get the translated category names, used in the product model, you can use the API endpoint:

GET https://t3-dev-api.tipser.com/v5/categories?market=se

Fetch product preview by id

This endpoint returns a slim version of a product model. It should be used for a product preview controls, like product tiles, carousels or banners in your articles.

We recommend to use this endpoint for fetching product because it is optimized for high traffic usages.

GET https://t3-prod-api.tipser.com/v5/products/:productId/preview(?pos=:posId)

Query string parameters

  • productId: string

  • pos: string (optional) - posId needed to ie. show pos-specific discounts etc.

Example requests (try me):

https://t3-prod-api.tipser.com/v5/products/5889a1648aa0ce36b8cd5663/preview

https://t3-prod-api.tipser.com/v5/products/5889a1648aa0ce36b8cd5663/preview?pos=54fdfcf378415516b41e88c8

Fetch full product by id

This endpoint returns a full product model. Please use it only when you need additional information like list of variants.

This endpoint contains all the information about the product.

GET https://t3-prod-api.tipser.com/v5/products/:productId(?pos=:posId)

Query string parameters

  • productId: string

  • pos: string (optional) - posId needed to ie. show pos-specific discounts etc.

Example requests (try me):

https://t3-prod-api.tipser.com/v5/products/5889a1648aa0ce36b8cd5663

https://t3-prod-api.tipser.com/v5/products/5889a1648aa0ce36b8cd5663?pos=54fdfcf378415516b41e88c8

Fetch product by Merchant url

GET https://t3-prod-api.tipser.com/v5/products/bymerchanturl?posId=:posId&market=:market&url=:url

Query string parameters

  • posId: string (optional) - posId needed to ie. show pos-specific discounts etc.

  • market: string - determines from which market product is taken. Uses ISO_3166-1 country codes. All supported values can be checked using: GET https://t3-prod-api.tipser.com/v4/markets

  • url: string - merchant product url

models

Product Preview Model

{

id: string,

title: string,

brand: string,

images: [{

50x50: URI,

250x: URI,

450x: URI,

960x: URI,

id: string,

original: URI

},

{...}

],

priceIncVat: {

value: decimal,

currency: string,

formatted: string

},

discountPriceIncVat: {

value: decimal,

currency: string,

formatted: string

},

isInStock: boolean

}

Full Product Model

{

id: string,

title: string,

description: string,

priceIncVat: {

value: decimal,

currency: string,

formatted: string

},

priceIncVat: {

value: decimal,

currency: string,

formatted: string

},

vat: {

value: integer,

formatted: string

},

currency: string,

deliveryTime: string,

deliveryCost: {

value: decimal,

currency: string,

formatted: string

},

brand: string,

category: {

name: string,

id: string

},

market: string,

merchant: string,

merchantName: string,

accessRights: string,

isInStock: boolean,

images: [{

50x50: URI,

250x: URI,

450x: URI,

960x: URI,

id: string,

original: URI

},

{...}

],

variants: [{

id: string,

productId: string,

title: string,

description: string,

stockCount: integer,

stockCountUnlimited: boolean,

attributes: {

key: string

},

attributesValue: string,

priceIncVat: {

value: decimal,

currency: string,

formatted: string

},

discountPriceIncVat: {

value: decimal,

currency: string,

formatted: string

},

vat: {

value: integer,

formatted: string

},

currency: string,

images: [{

50x50: URI,

250x: URI,

450x: URI,

960x: URI,

id: string,

original: URI

},

{...}

],

sku: string,

isInStock: boolean,

gtin: {

type: string,

value: string

},

mpn: string,

unitPrice: {

value: decimal,

currency: string,

formatted: string

},

unitPriceBaseMeasure: {

value: decimal,

unit: string

},

metadata: {

color: {

values: [ string, ... ]

},

material: {

values: [ string, ... ]

},

pattern: {

values: [ string, ...]

},

gender: {

values: [ string, ... ]

}

}

},

{...}

],

lastUpdateDate: date,

freeReturn: boolean,

posTags: [

{

name: string,

values: [ string, ...]

}

]

}

Essential product model attributes

  • id: used to reference for the product when adding to cart or getting to know more about it (ie. list of variants, similar products)

  • images: a list of image objects, keyed by the resolution (250,450,960) but also with an option to get the original size. Also, note underlined URI fragment (h_50,w_50), that you may modify to get the desired image size.

  • priceIncVat: original price of an item

  • discountPriceIncVat: the price that we currently sell the item for. If it is equal to the price, it means that there's no any sale. If the price is lower, then it means the product is on a sale

  • available: if true, you should be able to add it to cart. else no

  • variants: all SKUs nested into the master product

  • attributes: what concrete product variant is that (color, size, sex etc)

Pos tags

It is possible to set custom tags on the products by the POS which will be returned in the product API returning full product model. Tags are also stored in the orders. The tags can be added in Tipser Portal by POS users (https://app.tipser.com) on the product detail page.

Before you can start defining custom tags you have to send us desired tag families with allowed values.

Example response:

"posTags":[

{

"name":"SUSTAINABILITY",

"values":[

"ORGANIC",

"NATURAL"

]

}

]