Clone a product

POST 
/api/products/:id/clone

Clone a product

Request

Path Parameters

id stringrequired

Responses

200

A product object

application/json

Schema

Schema

id uuidrequired

Unique identifier of the product (in uuid format). Read Only (defined by the platform on creation). While updating through the API, content providers should ensure they'll not nullify or overwrite existing datas that are still relevant or that they cannot provide.

active boolean

Define if the product is active or not. An inactive product can only be seen by the content managers for the product an dby the platform administrators, and is "hidden" for any other user. Product.active attribute via API (PUT POST) : back-end must force Product.active=false if team for this product is team.active=false

name object

Name of the product (e.g. Lemon)

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

team_id int64

The team id of the product. Read Only (managed by the platform).

creator_id int64

The creator id of the product. Read Only (managed by the platform).

gtin string

Global Trade Item Number (GS1) if available. In write/update mode, The GUI will ensure that a contractual relationship exist with GS1's (availability and accuracy of the producers's GLN within BDPL217). API content providers must ensure this themself.

gtin_status string

Status of the GTIN. For a product with synced GTIN, we consider GS1 as the master data source for this product's description (which are "read only" for anyone else but the platform's admins).

gtin_sync boolean

Sync status of the GTIN. For a product with synced GTIN, we consider GS1 as the master data source for this product's description (which are "read only" for anyone else but the platform's admins).

brand string

Brand of the product (if it's branded internally in an another name)

external_id string

External id of the product (used for an external reference from the producer)

external_type string

External type of the product (used for an external reference from the producer)

external_ids object[]
A list of external ids related to the product (please merge existing values if you just want to update the list). Object of keyValueObject type that are not mandatory and not always standardized (please ensure that you manage correctly the type of the value). More infos on taxonomy here https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
Array [
id string
Key of the external id (could be the ID, slug, uuid that you use as reference)
type string
Type of the external id (see the list of supported external providers to create that)
]
description object

Description of the product

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

volumes_stocks_availabilities object

Volume stocks availabilities description of the product

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

price_policy object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

category string

Category of the product (id). (A valid GS1 brick ID - see https://gpc-browser.gs1.org/)

category_name string

Category name of the product (read only)

tags object[]
Tags related to the product (see https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists). Tags are used to group things without hierarchy based on a predefined list.
Array [
id int64
Unique identifier of the tag
name object
Name of the tag
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
icon object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
slug object
Short human readable identifier (no accentuation + whitespaces replaced by hyphens)
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
ref_id string
Reference id of the tag (used by the provider that created the tag). null if it's created internally
ref_type string
Reference type of the tag (used by the provider that created the tag). null if it's created internally
type stringrequired
Type of the tag (e.g. labels, uom, Allergen, etc..)
order_column string
Order by sequence within the tag type
active boolean
Active status of the tag (true or false)
created_at string
Date of creation of the tag
updated_at string
Date of last update of the tag
]
product_weight object

Weight of the product (see https://bdl217-docs.collegedesproducteurs.be/docs/intro#uom)

key string

The weight unit ref (code) (see https://bdl217-api.collegedesproducteurs.be/api/categories?type=uom&per_page=100)

type string

The weight unit ref (type) (see https://bdl217-api.collegedesproducteurs.be/api/categories?type=uom&per_page=100)

value integer

The weight in number (no decimal), according to the unit defined in “code” (no decimals)

product_dimensions object

Dimension of the product (see https://bdl217-docs.collegedesproducteurs.be/docs/intro#uom)

key string

The dimension unit ref (code) (see https://bdl217-api.collegedesproducteurs.be/api/categories?type=uom&per_page=100)

type string

The dimension unit ref (type) (see https://bdl217-api.collegedesproducteurs.be/api/categories?type=uom&per_page=100)

value integer

The dimension in number (no decimal), according to the unit defined in “code”

allergens object

List of allergens present in the product (see https://eur-lex.europa.eu/legal-content/FR/TXT/?uri=celex%3A32011R1169)

soy boolean

If it contains soy as allergen

eggs boolean

If it contains eggs as allergen

peanuts boolean

If it contains peanuts as allergen

nuts boolean

If it contains tree nuts as allergen

lupin boolean

If it contains lupin as allergen

celery boolean

If it contains celery as allergen

milk boolean

If it contains milk as allergen

fish boolean

If it contains fish as allergen

gluten boolean

If it contains gluten as allergen

sesame boolean

If it contains sesame as allergen

mustard boolean

If it contains mustard as allergen

molluscs boolean

If it contains molluscs as allergen

shellfish boolean

If it contains shellfish as allergen

sulphur_dioxide boolean

If it contains sulphur dioxide as allergen

nutritional_values object

Nutritional values of a product (number is in mg per 100g)

fat string

Fat value (number is in mg per 100g)

salt string

Salt value (number is in mg per 100g)

sugar string

Sugar value (number is in mg per 100g)

energy string

Energy value (number is in kcal per 100g)

proteins string

Proteins value (number is in mg per 100g)

carbohydrates string

Carbohydrates value (number is in mg per 100g)

saturated_fat string

Saturated fat value (number is in mg per 100g)

created_at string

Date of creation of the product

updated_at string

Date of last update of the product

images object[]
URL to images of the product (first one is the main image)
Array [
src stringrequired
URL of the image (GUI content providers will be able to upload images and have the URL set here. API content providers must mention a public image's URL.)
alt string
Alt text of the image (if available)
ratio string
Ratio of the image (e.g. 16:9, 4:3, etc...)
type string
Type of the image (e.g. logo, main, etc...)
]
visibility object
Define who can see the object based on team_type categories of a team
limit integer
Maximum distance (in kilometers) a producer agrees to cover to (self) deliver this product. Predefined thresholds are 25, 40 and 80 km. “everywhere” is valued as 0
unauthorized object[]
Define which team categories (commercial segments) cannot see this product. When consulting, content gatherer will not get the product infos if their own commercial segments is in this restriction list. In addition, this restriction list is provided to help "global" content gatherers target the (producer defined) product's intended business segments through a substractive (black list) approach.
Array [
id int64
name objectrequired
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
code string
Code of the category
level integer
Level of the category
description object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
active boolean
Active status of the category (true or false)
slug object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
type stringrequired
Type of the category (e.g. product, service, etc..)
_lft integer
Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
_rgt integer
Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
parent_id integer
Parent category id
created_at string
Date of creation of the category
updated_at string
Date of last update of the category
]
updater object

User object that are part of a team or multiple teams

id int64required

Unique identifier of the user

name stringrequired

Name of the user (e.g. John Doe)

language string

Language of the user in ISO 639-1 format (e.g. en, fr, es, etc..)

first_name string

First name of the user

last_name string

Last name of the user

email emailrequired

Email of the user

current_team object

Current team of the user

id int64

Unique identifier of the team

addresses object[]

The addresses list of the team

Array [

id string

name stringrequired

The name of the address (possible suggested values: billing, shipping, main, etc...)

address stringrequired

The full complete address (street, number, city, postcode, country)

model_type stringrequired

The model type of the address (possible values: \App\Models\Team, \App\Models\User, \App\Models\Product))

model_id stringrequired

The model ID of the related model_type (possible value is the ID of the related model)

country string

role stringrequired

Role of the address (possible suggested values: billing, shipping, main, etc...)

organization string

Organization name related to the address (if different from Team Name)

name_prefix string

Prefix of the name (e.g. Mr, Mrs, etc...)

name_suffix string

Suffix of the name (e.g. Jr, Sr, etc...)

first_name string

First name of the address

last_name string

Last name of the address

street string

Street of the address

building_number string

Building number of the address

building_flat string

Building flat of the address

city string

City of the address

city_prefix string

City prefix of the address

city_suffix string

City suffix of the address

state string

State of the address

state_code string

State code of the address

postcode string

Postcode of the address

lat string

Latitude of the address

lng string

Longitude of the address

line1 string

Address line 1 (will be automatically generated from the address field)

line2 string

Address line 2 (will be automatically generated from the address field)

line3 string

Address line 3 (will be automatically generated from the address field)

created_at string

Date of creation of the address

updated_at string

Date of last update of the address

]

contacts object[]

The contacts list of the team

Array [

name string

Name of the contact

phone string

Phone of the contact

mobile_phone string

Mobile Phone of the contact

email string

Email of the contact

role string

Role of the contact

lang string

Language of the contact

type string

Type of the contact

]

categories object[]

Categories of Team (ref team_type)

Array [

id int64

name objectrequired

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

code string

Code of the category

level integer

Level of the category

description object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

active boolean

Active status of the category (true or false)

slug object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

type stringrequired

Type of the category (e.g. product, service, etc..)

_lft integer

Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

_rgt integer

Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

parent_id integer

Parent category id

created_at string

Date of creation of the category

updated_at string

Date of last update of the category

]

user_id string

The user id of the creator of the team (team_type). See

name stringrequired

Official business name

active boolean

Define if the team is active or not

created_at string

Date of creation of the team

updated_at string

Date of last update of the team

gln_status string

Possible values: [active, inactive, pending, refused]

Current status of the GLN registration request in GS1

images object[]

The images list of the team (logo, etc..)

Array [

src stringrequired

URL of the image (GUI content providers will be able to upload images and have the URL set here. API content providers must mention a public image's URL.)

alt string

Alt text of the image (if available)

ratio string

Ratio of the image (e.g. 16:9, 4:3, etc...)

type string

Type of the image (e.g. logo, main, etc...)

]

gln string

GS1's producer ID, if known

company_number string

The company number of the team (might differ from VAT in some country)

vat string

The VAT number of the team

vat_exemption boolean

Define if the team is VAT exempted

main_language string

The main language of the team

other_languages object[]

The other languages of the team (iso

Array [

id string

label string

]

name_friendly string

Name towards customers. Official one used if this one is empty

website string

The website of the Organization

short_bio object

Short bio of the team

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

long_bio object

Long bio of the team

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

personal_team boolean

Define if the team is a personal team (single user organization)

distance numbernullable

Distance

farmer_sectors object[]nullable

Farming sectors (if applicable) See /api/categories?type=farmer_sector&per_page=100

Array [

id int64

name objectrequired

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

code string

Code of the category

level integer

Level of the category

description object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

active boolean

Active status of the category (true or false)

slug object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

type stringrequired

Type of the category (e.g. product, service, etc..)

_lft integer

Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

_rgt integer

Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

parent_id integer

Parent category id

created_at string

Date of creation of the category

updated_at string

Date of last update of the category

]

role stringnullable

Role of the user in the team. If null the user is not part of the team

total_members integernullable

Total members of the team

visibility objectnullable

Define what can of categories team_type can see the team

info object

Define who can see the info of the team

limit integer

Maximum distance (in kilometers) a producer agrees to cover to (self) deliver this product. Predefined thresholds are 25, 40 and 80 km. “everywhere” is valued as 0

unauthorized object[]

Define which team categories (commercial segments) cannot see this product. When consulting, content gatherer will not get the product infos if their own commercial segments is in this restriction list. In addition, this restriction list is provided to help "global" content gatherers target the (producer defined) product's intended business segments through a substractive (black list) approach.

Array [

id int64

name objectrequired

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

code string

Code of the category

level integer

Level of the category

description object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

active boolean

Active status of the category (true or false)

slug object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

type stringrequired

Type of the category (e.g. product, service, etc..)

_lft integer

Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

_rgt integer

Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

parent_id integer

Parent category id

created_at string

Date of creation of the category

updated_at string

Date of last update of the category

]

products object

Define who can see the products info of the team

limit integer

Maximum distance (in kilometers) a producer agrees to cover to (self) deliver this product. Predefined thresholds are 25, 40 and 80 km. “everywhere” is valued as 0

unauthorized object[]

Define which team categories (commercial segments) cannot see this product. When consulting, content gatherer will not get the product infos if their own commercial segments is in this restriction list. In addition, this restriction list is provided to help "global" content gatherers target the (producer defined) product's intended business segments through a substractive (black list) approach.

Array [

id int64

name objectrequired

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

code string

Code of the category

level integer

Level of the category

description object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

active boolean

Active status of the category (true or false)

slug object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

type stringrequired

Type of the category (e.g. product, service, etc..)

_lft integer

Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

_rgt integer

Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

parent_id integer

Parent category id

created_at string

Date of creation of the category

updated_at string

Date of last update of the category

]

prices object

Define who can see the prices info of the team

limit integer

Maximum distance (in kilometers) a producer agrees to cover to (self) deliver this product. Predefined thresholds are 25, 40 and 80 km. “everywhere” is valued as 0

unauthorized object[]

Define which team categories (commercial segments) cannot see this product. When consulting, content gatherer will not get the product infos if their own commercial segments is in this restriction list. In addition, this restriction list is provided to help "global" content gatherers target the (producer defined) product's intended business segments through a substractive (black list) approach.

Array [

id int64

name objectrequired

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

code string

Code of the category

level integer

Level of the category

description object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

active boolean

Active status of the category (true or false)

slug object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

type stringrequired

Type of the category (e.g. product, service, etc..)

_lft integer

Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

_rgt integer

Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

parent_id integer

Parent category id

created_at string

Date of creation of the category

updated_at string

Date of last update of the category

]

teams object[]required

Teams of the user

Array [

id int64

Unique identifier of the team

addresses object[]

The addresses list of the team

Array [

id string

name stringrequired

The name of the address (possible suggested values: billing, shipping, main, etc...)

address stringrequired

The full complete address (street, number, city, postcode, country)

model_type stringrequired

The model type of the address (possible values: \App\Models\Team, \App\Models\User, \App\Models\Product))

model_id stringrequired

The model ID of the related model_type (possible value is the ID of the related model)

country string

role stringrequired

Role of the address (possible suggested values: billing, shipping, main, etc...)

organization string

Organization name related to the address (if different from Team Name)

name_prefix string

Prefix of the name (e.g. Mr, Mrs, etc...)

name_suffix string

Suffix of the name (e.g. Jr, Sr, etc...)

first_name string

First name of the address

last_name string

Last name of the address

street string

Street of the address

building_number string

Building number of the address

building_flat string

Building flat of the address

city string

City of the address

city_prefix string

City prefix of the address

city_suffix string

City suffix of the address

state string

State of the address

state_code string

State code of the address

postcode string

Postcode of the address

lat string

Latitude of the address

lng string

Longitude of the address

line1 string

Address line 1 (will be automatically generated from the address field)

line2 string

Address line 2 (will be automatically generated from the address field)

line3 string

Address line 3 (will be automatically generated from the address field)

created_at string

Date of creation of the address

updated_at string

Date of last update of the address

]

contacts object[]

The contacts list of the team

Array [

name string

Name of the contact

phone string

Phone of the contact

mobile_phone string

Mobile Phone of the contact

email string

Email of the contact

role string

Role of the contact

lang string

Language of the contact

type string

Type of the contact

]

categories object[]

Categories of Team (ref team_type)

Array [

id int64

name objectrequired

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

code string

Code of the category

level integer

Level of the category

description object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

active boolean

Active status of the category (true or false)

slug object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

type stringrequired

Type of the category (e.g. product, service, etc..)

_lft integer

Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

_rgt integer

Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

parent_id integer

Parent category id

created_at string

Date of creation of the category

updated_at string

Date of last update of the category

]

user_id string

The user id of the creator of the team (team_type). See

name stringrequired

Official business name

active boolean

Define if the team is active or not

created_at string

Date of creation of the team

updated_at string

Date of last update of the team

gln_status string

Possible values: [active, inactive, pending, refused]

Current status of the GLN registration request in GS1

images object[]

The images list of the team (logo, etc..)

Array [

src stringrequired

URL of the image (GUI content providers will be able to upload images and have the URL set here. API content providers must mention a public image's URL.)

alt string

Alt text of the image (if available)

ratio string

Ratio of the image (e.g. 16:9, 4:3, etc...)

type string

Type of the image (e.g. logo, main, etc...)

]

gln string

GS1's producer ID, if known

company_number string

The company number of the team (might differ from VAT in some country)

vat string

The VAT number of the team

vat_exemption boolean

Define if the team is VAT exempted

main_language string

The main language of the team

other_languages object[]

The other languages of the team (iso

Array [

id string

label string

]

name_friendly string

Name towards customers. Official one used if this one is empty

website string

The website of the Organization

short_bio object

Short bio of the team

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

long_bio object

Long bio of the team

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

personal_team boolean

Define if the team is a personal team (single user organization)

distance numbernullable

Distance

farmer_sectors object[]nullable

Farming sectors (if applicable) See /api/categories?type=farmer_sector&per_page=100

Array [

id int64

name objectrequired

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

code string

Code of the category

level integer

Level of the category

description object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

active boolean

Active status of the category (true or false)

slug object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

type stringrequired

Type of the category (e.g. product, service, etc..)

_lft integer

Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

_rgt integer

Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

parent_id integer

Parent category id

created_at string

Date of creation of the category

updated_at string

Date of last update of the category

]

role stringnullable

Role of the user in the team. If null the user is not part of the team

total_members integernullable

Total members of the team

visibility objectnullable

Define what can of categories team_type can see the team

info object

Define who can see the info of the team

limit integer

Maximum distance (in kilometers) a producer agrees to cover to (self) deliver this product. Predefined thresholds are 25, 40 and 80 km. “everywhere” is valued as 0

unauthorized object[]

Define which team categories (commercial segments) cannot see this product. When consulting, content gatherer will not get the product infos if their own commercial segments is in this restriction list. In addition, this restriction list is provided to help "global" content gatherers target the (producer defined) product's intended business segments through a substractive (black list) approach.

Array [

id int64

name objectrequired

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

code string

Code of the category

level integer

Level of the category

description object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

active boolean

Active status of the category (true or false)

slug object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

type stringrequired

Type of the category (e.g. product, service, etc..)

_lft integer

Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

_rgt integer

Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

parent_id integer

Parent category id

created_at string

Date of creation of the category

updated_at string

Date of last update of the category

]

products object

Define who can see the products info of the team

limit integer

Maximum distance (in kilometers) a producer agrees to cover to (self) deliver this product. Predefined thresholds are 25, 40 and 80 km. “everywhere” is valued as 0

unauthorized object[]

Define which team categories (commercial segments) cannot see this product. When consulting, content gatherer will not get the product infos if their own commercial segments is in this restriction list. In addition, this restriction list is provided to help "global" content gatherers target the (producer defined) product's intended business segments through a substractive (black list) approach.

Array [

id int64

name objectrequired

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

code string

Code of the category

level integer

Level of the category

description object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

active boolean

Active status of the category (true or false)

slug object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

type stringrequired

Type of the category (e.g. product, service, etc..)

_lft integer

Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

_rgt integer

Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

parent_id integer

Parent category id

created_at string

Date of creation of the category

updated_at string

Date of last update of the category

]

prices object

Define who can see the prices info of the team

limit integer

Maximum distance (in kilometers) a producer agrees to cover to (self) deliver this product. Predefined thresholds are 25, 40 and 80 km. “everywhere” is valued as 0

unauthorized object[]

Define which team categories (commercial segments) cannot see this product. When consulting, content gatherer will not get the product infos if their own commercial segments is in this restriction list. In addition, this restriction list is provided to help "global" content gatherers target the (producer defined) product's intended business segments through a substractive (black list) approach.

Array [

id int64

name objectrequired

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

code string

Code of the category

level integer

Level of the category

description object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

active boolean

Active status of the category (true or false)

slug object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

type stringrequired

Type of the category (e.g. product, service, etc..)

_lft integer

Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

_rgt integer

Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

parent_id integer

Parent category id

created_at string

Date of creation of the category

updated_at string

Date of last update of the category

]

]

current_team_id integer

Current team id of the user

created_at stringrequired

Date of creation of the user

updated_at string

Date of last update of the user

seasonality object

Seasonality of the product (from 0 (no availability) to 5 (max availability))

january integer

Possible values: <= 5

february integer

Possible values: <= 5

march integer

Possible values: <= 5

april integer

Possible values: <= 5

may integer

Possible values: <= 5

june integer

Possible values: <= 5

july integer

Possible values: <= 5

augustus integer

Possible values: <= 5

september integer

Possible values: <= 5

october integer

Possible values: <= 5

november integer

Possible values: <= 5

december integer

Possible values: <= 5

life_expectancy_dmm integer

Date de Durabilité Minimale (jours)

life_expectancy_dlc integer

Date Limite de Consommation (jours)

life_expectancy_after_opening integer

Durée de conservation après ouverture (jours)

storage_temperature_type string

ref_id to take from : /api/tags?type=TradeItemTemperatureConditionTypeCodes

ce_approval_number string

Numéro d'agrément CE

team object
Team have members and are defined with their team_type categories, they might have products, team_members and prices. Team are an organization but can also be a single user organization.
id int64
Unique identifier of the team
addresses object[]
The addresses list of the team
Array [
id string
name stringrequired
The name of the address (possible suggested values: billing, shipping, main, etc...)
address stringrequired
The full complete address (street, number, city, postcode, country)
model_type stringrequired
The model type of the address (possible values: \App\Models\Team, \App\Models\User, \App\Models\Product))
model_id stringrequired
The model ID of the related model_type (possible value is the ID of the related model)
country string
role stringrequired
Role of the address (possible suggested values: billing, shipping, main, etc...)
organization string
Organization name related to the address (if different from Team Name)
name_prefix string
Prefix of the name (e.g. Mr, Mrs, etc...)
name_suffix string
Suffix of the name (e.g. Jr, Sr, etc...)
first_name string
First name of the address
last_name string
Last name of the address
street string
Street of the address
building_number string
Building number of the address
building_flat string
Building flat of the address
city string
City of the address
city_prefix string
City prefix of the address
city_suffix string
City suffix of the address
state string
State of the address
state_code string
State code of the address
postcode string
Postcode of the address
lat string
Latitude of the address
lng string
Longitude of the address
line1 string
Address line 1 (will be automatically generated from the address field)
line2 string
Address line 2 (will be automatically generated from the address field)
line3 string
Address line 3 (will be automatically generated from the address field)
created_at string
Date of creation of the address
updated_at string
Date of last update of the address
]
contacts object[]
The contacts list of the team
Array [
name string
Name of the contact
phone string
Phone of the contact
mobile_phone string
Mobile Phone of the contact
email string
Email of the contact
role string
Role of the contact
lang string
Language of the contact
type string
Type of the contact
]
categories object[]
Categories of Team (ref team_type)
Array [
id int64
name object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
code string
Code of the category
level integer
Level of the category
description object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
active boolean
Active status of the category (true or false)
slug object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
type stringrequired
Type of the category (e.g. product, service, etc..)
_lft integer
Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
_rgt integer
Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
parent_id integer
Parent category id
created_at string
Date of creation of the category
updated_at string
Date of last update of the category
]
user_id string
The user id of the creator of the team (team_type). See
name stringrequired
Official business name
active boolean
Define if the team is active or not
created_at string
Date of creation of the team
updated_at string
Date of last update of the team
gln_status string
Possible values: [active, inactive, pending, refused]
Current status of the GLN registration request in GS1
images object[]
The images list of the team (logo, etc..)
Array [
src stringrequired
URL of the image (GUI content providers will be able to upload images and have the URL set here. API content providers must mention a public image's URL.)
alt string
Alt text of the image (if available)
ratio string
Ratio of the image (e.g. 16:9, 4:3, etc...)
type string
Type of the image (e.g. logo, main, etc...)
]
gln string
GS1's producer ID, if known
company_number string
The company number of the team (might differ from VAT in some country)
vat string
The VAT number of the team
vat_exemption boolean
Define if the team is VAT exempted
main_language string
The main language of the team
other_languages object[]
The other languages of the team (iso
Array [
id string
label string
]
name_friendly string
Name towards customers. Official one used if this one is empty
website string
The website of the Organization
short_bio object
Short bio of the team
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
long_bio object
Long bio of the team
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
personal_team boolean
Define if the team is a personal team (single user organization)
distance numbernullable
Distance
farmer_sectors object[]nullable
Farming sectors (if applicable) See /api/categories?type=farmer_sector&per_page=100
Array [
id int64
name object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
code string
Code of the category
level integer
Level of the category
description object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
active boolean
Active status of the category (true or false)
slug object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
type stringrequired
Type of the category (e.g. product, service, etc..)
_lft integer
Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
_rgt integer
Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
parent_id integer
Parent category id
created_at string
Date of creation of the category
updated_at string
Date of last update of the category
]
role stringnullable
Role of the user in the team. If null the user is not part of the team
total_members integernullable
Total members of the team
visibility objectnullable
Define what can of categories team_type can see the team
info object
Define who can see the info of the team
limit integer
Maximum distance (in kilometers) a producer agrees to cover to (self) deliver this product. Predefined thresholds are 25, 40 and 80 km. “everywhere” is valued as 0
unauthorized object[]
Define which team categories (commercial segments) cannot see this product. When consulting, content gatherer will not get the product infos if their own commercial segments is in this restriction list. In addition, this restriction list is provided to help "global" content gatherers target the (producer defined) product's intended business segments through a substractive (black list) approach.
Array [
id int64
name objectrequired
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
code string
Code of the category
level integer
Level of the category
description object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
active boolean
Active status of the category (true or false)
slug object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
type stringrequired
Type of the category (e.g. product, service, etc..)
_lft integer
Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
_rgt integer
Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
parent_id integer
Parent category id
created_at string
Date of creation of the category
updated_at string
Date of last update of the category
]
products object
Define who can see the products info of the team
limit integer
Maximum distance (in kilometers) a producer agrees to cover to (self) deliver this product. Predefined thresholds are 25, 40 and 80 km. “everywhere” is valued as 0
unauthorized object[]
Define which team categories (commercial segments) cannot see this product. When consulting, content gatherer will not get the product infos if their own commercial segments is in this restriction list. In addition, this restriction list is provided to help "global" content gatherers target the (producer defined) product's intended business segments through a substractive (black list) approach.
Array [
id int64
name objectrequired
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
code string
Code of the category
level integer
Level of the category
description object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
active boolean
Active status of the category (true or false)
slug object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
type stringrequired
Type of the category (e.g. product, service, etc..)
_lft integer
Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
_rgt integer
Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
parent_id integer
Parent category id
created_at string
Date of creation of the category
updated_at string
Date of last update of the category
]
prices object
Define who can see the prices info of the team
limit integer
Maximum distance (in kilometers) a producer agrees to cover to (self) deliver this product. Predefined thresholds are 25, 40 and 80 km. “everywhere” is valued as 0
unauthorized object[]
Define which team categories (commercial segments) cannot see this product. When consulting, content gatherer will not get the product infos if their own commercial segments is in this restriction list. In addition, this restriction list is provided to help "global" content gatherers target the (producer defined) product's intended business segments through a substractive (black list) approach.
Array [
id int64
name objectrequired
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
code string
Code of the category
level integer
Level of the category
description object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
active boolean
Active status of the category (true or false)
slug object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
type stringrequired
Type of the category (e.g. product, service, etc..)
_lft integer
Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
_rgt integer
Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
parent_id integer
Parent category id
created_at string
Date of creation of the category
updated_at string
Date of last update of the category
]

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "active": true,
  "name": {
    "fr": "string",
    "nl": "string",
    "en": "string",
    "de": "string"
  },
  "team_id": 0,
  "creator_id": 0,
  "gtin": "string",
  "gtin_status": "string",
  "gtin_sync": true,
  "brand": "string",
  "external_id": "string",
  "external_type": "string",
  "external_ids": [
    {
      "id": "string",
      "type": "string"
    }
  ],
  "description": {
    "fr": "string",
    "nl": "string",
    "en": "string",
    "de": "string"
  },
  "volumes_stocks_availabilities": {
    "fr": "string",
    "nl": "string",
    "en": "string",
    "de": "string"
  },
  "price_policy": {
    "fr": "string",
    "nl": "string",
    "en": "string",
    "de": "string"
  },
  "category": "string",
  "category_name": "string",
  "tags": [
    {
      "id": 0,
      "name": {
        "fr": "string",
        "nl": "string",
        "en": "string",
        "de": "string"
      },
      "icon": {
        "fr": "string",
        "nl": "string",
        "en": "string",
        "de": "string"
      },
      "slug": {
        "fr": "string",
        "nl": "string",
        "en": "string",
        "de": "string"
      },
      "ref_id": "string",
      "ref_type": "string",
      "type": "string",
      "order_column": "string",
      "active": true,
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "product_weight": {
    "key": "string",
    "type": "string",
    "value": 0
  },
  "product_dimensions": {
    "key": "string",
    "type": "string",
    "value": 0
  },
  "allergens": {
    "soy": true,
    "eggs": true,
    "peanuts": true,
    "nuts": true,
    "lupin": true,
    "celery": true,
    "milk": true,
    "fish": true,
    "gluten": true,
    "sesame": true,
    "mustard": true,
    "molluscs": true,
    "shellfish": true,
    "sulphur_dioxide": true
  },
  "nutritional_values": {
    "fat": "string",
    "salt": "string",
    "sugar": "string",
    "energy": "string",
    "proteins": "string",
    "carbohydrates": "string",
    "saturated_fat": "string"
  },
  "created_at": "string",
  "updated_at": "string",
  "images": [
    {
      "src": "string",
      "alt": "string",
      "ratio": "string",
      "type": "string"
    }
  ],
  "visibility": {
    "limit": 0,
    "unauthorized": [
      {
        "id": 0,
        "name": {
          "fr": "string",
          "nl": "string",
          "en": "string",
          "de": "string"
        },
        "code": "string",
        "level": 0,
        "description": {
          "fr": "string",
          "nl": "string",
          "en": "string",
          "de": "string"
        },
        "active": true,
        "slug": {
          "fr": "string",
          "nl": "string",
          "en": "string",
          "de": "string"
        },
        "type": "string",
        "_lft": 0,
        "_rgt": 0,
        "parent_id": 0,
        "created_at": "string",
        "updated_at": "string"
      }
    ]
  },
  "updater": {
    "id": 0,
    "name": "string",
    "language": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "current_team": {
      "id": 0,
      "addresses": [
        {
          "id": "string",
          "name": "string",
          "address": "string",
          "model_type": "string",
          "model_id": "string",
          "country": "string",
          "role": "string",
          "organization": "string",
          "name_prefix": "string",
          "name_suffix": "string",
          "first_name": "string",
          "last_name": "string",
          "street": "string",
          "building_number": "string",
          "building_flat": "string",
          "city": "string",
          "city_prefix": "string",
          "city_suffix": "string",
          "state": "string",
          "state_code": "string",
          "postcode": "string",
          "lat": "string",
          "lng": "string",
          "line1": "string",
          "line2": "string",
          "line3": "string",
          "created_at": "string",
          "updated_at": "string"
        }
      ],
      "contacts": [
        {
          "name": "string",
          "phone": "string",
          "mobile_phone": "string",
          "email": "string",
          "role": "string",
          "lang": "string",
          "type": "string"
        }
      ],
      "categories": [
        {
          "id": 0,
          "name": {
            "fr": "string",
            "nl": "string",
            "en": "string",
            "de": "string"
          },
          "code": "string",
          "level": 0,
          "description": {
            "fr": "string",
            "nl": "string",
            "en": "string",
            "de": "string"
          },
          "active": true,
          "slug": {
            "fr": "string",
            "nl": "string",
            "en": "string",
            "de": "string"
          },
          "type": "string",
          "_lft": 0,
          "_rgt": 0,
          "parent_id": 0,
          "created_at": "string",
          "updated_at": "string"
        }
      ],
      "user_id": "string",
      "name": "string",
      "active": true,
      "created_at": "string",
      "updated_at": "string",
      "gln_status": "active",
      "images": [
        {
          "src": "string",
          "alt": "string",
          "ratio": "string",
          "type": "string"
        }
      ],
      "gln": "string",
      "company_number": "string",
      "vat": "string",
      "vat_exemption": true,
      "main_language": "string",
      "other_languages": [
        {
          "id": "string",
          "label": "string"
        }
      ],
      "name_friendly": "string",
      "website": "string",
      "short_bio": {
        "fr": "string",
        "nl": "string",
        "en": "string",
        "de": "string"
      },
      "long_bio": {
        "fr": "string",
        "nl": "string",
        "en": "string",
        "de": "string"
      },
      "personal_team": true,
      "distance": 0,
      "farmer_sectors": [
        {
          "id": 0,
          "name": {
            "fr": "string",
            "nl": "string",
            "en": "string",
            "de": "string"
          },
          "code": "string",
          "level": 0,
          "description": {
            "fr": "string",
            "nl": "string",
            "en": "string",
            "de": "string"
          },
          "active": true,
          "slug": {
            "fr": "string",
            "nl": "string",
            "en": "string",
            "de": "string"
          },
          "type": "string",
          "_lft": 0,
          "_rgt": 0,
          "parent_id": 0,
          "created_at": "string",
          "updated_at": "string"
        }
      ],
      "role": "admin|editor|viewer|null",
      "total_members": 0,
      "visibility": {
        "info": {
          "limit": 0,
          "unauthorized": [
            {
              "id": 0,
              "name": {
                "fr": "string",
                "nl": "string",
                "en": "string",
                "de": "string"
              },
              "code": "string",
              "level": 0,
              "description": {
                "fr": "string",
                "nl": "string",
                "en": "string",
                "de": "string"
              },
              "active": true,
              "slug": {
                "fr": "string",
                "nl": "string",
                "en": "string",
                "de": "string"
              },
              "type": "string",
              "_lft": 0,
              "_rgt": 0,
              "parent_id": 0,
              "created_at": "string",
              "updated_at": "string"
            }
          ]
        },
        "products": {
          "limit": 0,
          "unauthorized": [
            {
              "id": 0,
              "name": {
                "fr": "string",
                "nl": "string",
                "en": "string",
                "de": "string"
              },
              "code": "string",
              "level": 0,
              "description": {
                "fr": "string",
                "nl": "string",
                "en": "string",
                "de": "string"
              },
              "active": true,
              "slug": {
                "fr": "string",
                "nl": "string",
                "en": "string",
                "de": "string"
              },
              "type": "string",
              "_lft": 0,
              "_rgt": 0,
              "parent_id": 0,
              "created_at": "string",
              "updated_at": "string"
            }
          ]
        },
        "prices": {
          "limit": 0,
          "unauthorized": [
            {
              "id": 0,
              "name": {
                "fr": "string",
                "nl": "string",
                "en": "string",
                "de": "string"
              },
              "code": "string",
              "level": 0,
              "description": {
                "fr": "string",
                "nl": "string",
                "en": "string",
                "de": "string"
              },
              "active": true,
              "slug": {
                "fr": "string",
                "nl": "string",
                "en": "string",
                "de": "string"
              },
              "type": "string",
              "_lft": 0,
              "_rgt": 0,
              "parent_id": 0,
              "created_at": "string",
              "updated_at": "string"
            }
          ]
        }
      }
    },
    "teams": [
      {
        "id": 0,
        "addresses": [
          {
            "id": "string",
            "name": "string",
            "address": "string",
            "model_type": "string",
            "model_id": "string",
            "country": "string",
            "role": "string",
            "organization": "string",
            "name_prefix": "string",
            "name_suffix": "string",
            "first_name": "string",
            "last_name": "string",
            "street": "string",
            "building_number": "string",
            "building_flat": "string",
            "city": "string",
            "city_prefix": "string",
            "city_suffix": "string",
            "state": "string",
            "state_code": "string",
            "postcode": "string",
            "lat": "string",
            "lng": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "created_at": "string",
            "updated_at": "string"
          }
        ],
        "contacts": [
          {
            "name": "string",
            "phone": "string",
            "mobile_phone": "string",
            "email": "string",
            "role": "string",
            "lang": "string",
            "type": "string"
          }
        ],
        "categories": [
          {
            "id": 0,
            "name": {
              "fr": "string",
              "nl": "string",
              "en": "string",
              "de": "string"
            },
            "code": "string",
            "level": 0,
            "description": {
              "fr": "string",
              "nl": "string",
              "en": "string",
              "de": "string"
            },
            "active": true,
            "slug": {
              "fr": "string",
              "nl": "string",
              "en": "string",
              "de": "string"
            },
            "type": "string",
            "_lft": 0,
            "_rgt": 0,
            "parent_id": 0,
            "created_at": "string",
            "updated_at": "string"
          }
        ],
        "user_id": "string",
        "name": "string",
        "active": true,
        "created_at": "string",
        "updated_at": "string",
        "gln_status": "active",
        "images": [
          {
            "src": "string",
            "alt": "string",
            "ratio": "string",
            "type": "string"
          }
        ],
        "gln": "string",
        "company_number": "string",
        "vat": "string",
        "vat_exemption": true,
        "main_language": "string",
        "other_languages": [
          {
            "id": "string",
            "label": "string"
          }
        ],
        "name_friendly": "string",
        "website": "string",
        "short_bio": {
          "fr": "string",
          "nl": "string",
          "en": "string",
          "de": "string"
        },
        "long_bio": {
          "fr": "string",
          "nl": "string",
          "en": "string",
          "de": "string"
        },
        "personal_team": true,
        "distance": 0,
        "farmer_sectors": [
          {
            "id": 0,
            "name": {
              "fr": "string",
              "nl": "string",
              "en": "string",
              "de": "string"
            },
            "code": "string",
            "level": 0,
            "description": {
              "fr": "string",
              "nl": "string",
              "en": "string",
              "de": "string"
            },
            "active": true,
            "slug": {
              "fr": "string",
              "nl": "string",
              "en": "string",
              "de": "string"
            },
            "type": "string",
            "_lft": 0,
            "_rgt": 0,
            "parent_id": 0,
            "created_at": "string",
            "updated_at": "string"
          }
        ],
        "role": "admin|editor|viewer|null",
        "total_members": 0,
        "visibility": {
          "info": {
            "limit": 0,
            "unauthorized": [
              {
                "id": 0,
                "name": {
                  "fr": "string",
                  "nl": "string",
                  "en": "string",
                  "de": "string"
                },
                "code": "string",
                "level": 0,
                "description": {
                  "fr": "string",
                  "nl": "string",
                  "en": "string",
                  "de": "string"
                },
                "active": true,
                "slug": {
                  "fr": "string",
                  "nl": "string",
                  "en": "string",
                  "de": "string"
                },
                "type": "string",
                "_lft": 0,
                "_rgt": 0,
                "parent_id": 0,
                "created_at": "string",
                "updated_at": "string"
              }
            ]
          },
          "products": {
            "limit": 0,
            "unauthorized": [
              {
                "id": 0,
                "name": {
                  "fr": "string",
                  "nl": "string",
                  "en": "string",
                  "de": "string"
                },
                "code": "string",
                "level": 0,
                "description": {
                  "fr": "string",
                  "nl": "string",
                  "en": "string",
                  "de": "string"
                },
                "active": true,
                "slug": {
                  "fr": "string",
                  "nl": "string",
                  "en": "string",
                  "de": "string"
                },
                "type": "string",
                "_lft": 0,
                "_rgt": 0,
                "parent_id": 0,
                "created_at": "string",
                "updated_at": "string"
              }
            ]
          },
          "prices": {
            "limit": 0,
            "unauthorized": [
              {
                "id": 0,
                "name": {
                  "fr": "string",
                  "nl": "string",
                  "en": "string",
                  "de": "string"
                },
                "code": "string",
                "level": 0,
                "description": {
                  "fr": "string",
                  "nl": "string",
                  "en": "string",
                  "de": "string"
                },
                "active": true,
                "slug": {
                  "fr": "string",
                  "nl": "string",
                  "en": "string",
                  "de": "string"
                },
                "type": "string",
                "_lft": 0,
                "_rgt": 0,
                "parent_id": 0,
                "created_at": "string",
                "updated_at": "string"
              }
            ]
          }
        }
      }
    ],
    "current_team_id": 0,
    "created_at": "string",
    "updated_at": "string"
  },
  "seasonality": {
    "january": 0,
    "february": 0,
    "march": 0,
    "april": 0,
    "may": 0,
    "june": 0,
    "july": 0,
    "augustus": 0,
    "september": 0,
    "october": 0,
    "november": 0,
    "december": 0
  },
  "life_expectancy_dmm": 0,
  "life_expectancy_dlc": 0,
  "life_expectancy_after_opening": 0,
  "storage_temperature_type": "string",
  "ce_approval_number": "string",
  "team": {
    "id": 0,
    "addresses": [
      {
        "id": "string",
        "name": "string",
        "address": "string",
        "model_type": "string",
        "model_id": "string",
        "country": "string",
        "role": "string",
        "organization": "string",
        "name_prefix": "string",
        "name_suffix": "string",
        "first_name": "string",
        "last_name": "string",
        "street": "string",
        "building_number": "string",
        "building_flat": "string",
        "city": "string",
        "city_prefix": "string",
        "city_suffix": "string",
        "state": "string",
        "state_code": "string",
        "postcode": "string",
        "lat": "string",
        "lng": "string",
        "line1": "string",
        "line2": "string",
        "line3": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "contacts": [
      {
        "name": "string",
        "phone": "string",
        "mobile_phone": "string",
        "email": "string",
        "role": "string",
        "lang": "string",
        "type": "string"
      }
    ],
    "categories": [
      {
        "id": 0,
        "name": {
          "fr": "string",
          "nl": "string",
          "en": "string",
          "de": "string"
        },
        "code": "string",
        "level": 0,
        "description": {
          "fr": "string",
          "nl": "string",
          "en": "string",
          "de": "string"
        },
        "active": true,
        "slug": {
          "fr": "string",
          "nl": "string",
          "en": "string",
          "de": "string"
        },
        "type": "string",
        "_lft": 0,
        "_rgt": 0,
        "parent_id": 0,
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "user_id": "string",
    "name": "string",
    "active": true,
    "created_at": "string",
    "updated_at": "string",
    "gln_status": "active",
    "images": [
      {
        "src": "string",
        "alt": "string",
        "ratio": "string",
        "type": "string"
      }
    ],
    "gln": "string",
    "company_number": "string",
    "vat": "string",
    "vat_exemption": true,
    "main_language": "string",
    "other_languages": [
      {
        "id": "string",
        "label": "string"
      }
    ],
    "name_friendly": "string",
    "website": "string",
    "short_bio": {
      "fr": "string",
      "nl": "string",
      "en": "string",
      "de": "string"
    },
    "long_bio": {
      "fr": "string",
      "nl": "string",
      "en": "string",
      "de": "string"
    },
    "personal_team": true,
    "distance": 0,
    "farmer_sectors": [
      {
        "id": 0,
        "name": {
          "fr": "string",
          "nl": "string",
          "en": "string",
          "de": "string"
        },
        "code": "string",
        "level": 0,
        "description": {
          "fr": "string",
          "nl": "string",
          "en": "string",
          "de": "string"
        },
        "active": true,
        "slug": {
          "fr": "string",
          "nl": "string",
          "en": "string",
          "de": "string"
        },
        "type": "string",
        "_lft": 0,
        "_rgt": 0,
        "parent_id": 0,
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "role": "admin|editor|viewer|null",
    "total_members": 0,
    "visibility": {
      "info": {
        "limit": 0,
        "unauthorized": [
          {
            "id": 0,
            "name": {
              "fr": "string",
              "nl": "string",
              "en": "string",
              "de": "string"
            },
            "code": "string",
            "level": 0,
            "description": {
              "fr": "string",
              "nl": "string",
              "en": "string",
              "de": "string"
            },
            "active": true,
            "slug": {
              "fr": "string",
              "nl": "string",
              "en": "string",
              "de": "string"
            },
            "type": "string",
            "_lft": 0,
            "_rgt": 0,
            "parent_id": 0,
            "created_at": "string",
            "updated_at": "string"
          }
        ]
      },
      "products": {
        "limit": 0,
        "unauthorized": [
          {
            "id": 0,
            "name": {
              "fr": "string",
              "nl": "string",
              "en": "string",
              "de": "string"
            },
            "code": "string",
            "level": 0,
            "description": {
              "fr": "string",
              "nl": "string",
              "en": "string",
              "de": "string"
            },
            "active": true,
            "slug": {
              "fr": "string",
              "nl": "string",
              "en": "string",
              "de": "string"
            },
            "type": "string",
            "_lft": 0,
            "_rgt": 0,
            "parent_id": 0,
            "created_at": "string",
            "updated_at": "string"
          }
        ]
      },
      "prices": {
        "limit": 0,
        "unauthorized": [
          {
            "id": 0,
            "name": {
              "fr": "string",
              "nl": "string",
              "en": "string",
              "de": "string"
            },
            "code": "string",
            "level": 0,
            "description": {
              "fr": "string",
              "nl": "string",
              "en": "string",
              "de": "string"
            },
            "active": true,
            "slug": {
              "fr": "string",
              "nl": "string",
              "en": "string",
              "de": "string"
            },
            "type": "string",
            "_lft": 0,
            "_rgt": 0,
            "parent_id": 0,
            "created_at": "string",
            "updated_at": "string"
          }
        ]
      }
    }
  }
}

Loading...