Content Management Fields API
The Fields API is in phase and is not yet available to users. You can contact the Product-Live team at contact@product-live.com if you want more details and get an early access.
Introduction
A field represents a property on an item. A field have a data type, which defines how the property is edited and how the data is represented. However a field is not the value of a property of an item, it is its definition.
The Fields API Swagger definition is available on our Product-Live API portal here.
General information
- Rate limit: 50 requests per minute
Get Field by id
Request URL
Path parameters
| Parameter | Type | Description |
|---|---|---|
| fieldId | string | A field id |
Request parameters
None
Request headers
| Header | Type | Value |
|---|---|---|
| accept | string | application/json |
| X-Api-Key | string | Your account API key |
| X-Context | number | The account id of your partner in order to get the list of table fields he shared with you |
Request Body
None
Request Example
bash
curl -X 'GET' \
'GET https://api.product-live.com/v1/fields/2330458' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>' \
-H 'X-Context: 4013'
**Response Example**
```json
{
"object": "field",
"id": "2330458",
"updatedAt": "2025-01-06T14:39:15.000Z",
"createdAt": "2025-01-06T14:39:15.000Z",
"metadata": {},
"tableId": "1470",
"levelId": "1685",
"key": "EAN",
"type": "IDENTIFIER",
"title": "EAN 13"
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
List Fields
Request URL
Path parameters
None
Request parameters
| Parameter | Type | Description |
|---|---|---|
| tableId | string | A table id |
| page | integer | Optional The page number to retrieve. Default value if missing : 0 |
| size | integer | Optional The number of items per page. Default value if missing : 10 |
| sort | string | Optional The field property to use to sort results |
| sortOrder | string | Optional The sort direction: ASC or DESC |
Request headers
| Header | Type | Value |
|---|---|---|
| accept | string | application/json |
| X-Api-Key | string | Your account API key |
| X-Context | number | The account id of your partner in order to get the list of table fields he shared with you |
Request Body
None
Request Example
bash
curl -X 'GET' \
'https://api.product-live.com/v1/fields?tableId=1470size=1&page=0&sort=id&sortOrder=ASC' \
-H 'accept: application/json' \
-H 'X-Api-Key: <REDACTED>' \
-H 'X-Context: 4013'
**Response example**
```json
{
"object": "list",
"data": [
{
"object": "field",
"id": "2330458",
"updatedAt": "2025-01-06T14:39:15.000Z",
"createdAt": "2025-01-06T14:39:15.000Z",
"metadata": {},
"tableId": "1470",
"levelId": "1685",
"key": "EAN",
"type": "IDENTIFIER",
"title": "EAN 13"
}
],
"totalElements": 55
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
Find Fields
Request URL
Path parameters
None
Request parameters
| Parameter | Type | Description |
|---|---|---|
| tableId | string | A table id |
| page | integer | Optional The page number to retrieve. Default value if missing : 0 |
| size | integer | Optional The number of items per page. Default value if missing : 10 |
| sort | string | Optional The field property to use to sort results |
| sortOrder | string | Optional The sort direction: ASC or DESC |
Request headers
| Header | Type | Value |
|---|---|---|
| accept | string | application/json |
| X-Api-Key | string | Your account API key |
| X-Context | number | The account id of your partner in order to get the list of table fields he shared with you |
Request Body
See more details on the find request body in the dedicated page Find request.
json
{
"type": "search",
"caseSensitive": true,
"field": "name",
"value": "EAN%"
}1
2
3
4
5
6
2
3
4
5
6
json
{
"type": "and",
"queries": [
{
"type": "search",
"caseSensitive": true,
"field": "title",
"value": "EAN%"
},
{
"type": "greaterOrEqual",
"caseSensitive": true,
"field": "createdAt",
"value": "2025-01-06T14:39:15.000Z"
}
]
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Request Example
bash
curl -X 'POST' \
'https://api.product-live.com/v1/fields/find?tableId=1470size=1&page=0&sort=id&sortOrder=ASC' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>' \
-H 'X-Context: 4013'
-d '{
"type": "and",
"queries": [
{
"type": "search",
"caseSensitive": true,
"field": "title",
"value": "EAN%"
},
{
"type": "greaterOrEqual",
"caseSensitive": true,
"field": "createdAt",
"value": "2025-01-06T14:39:15.000Z"
}
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Response example
json
{
"object": "list",
"data": [
{
"object": "field",
"id": "2330458",
"updatedAt": "2025-01-06T14:39:15.000Z",
"createdAt": "2025-01-06T14:39:15.000Z",
"metadata": {},
"tableId": "1470",
"levelId": "1685",
"key": "EAN",
"type": "IDENTIFIER",
"title": "EAN 13"
}
],
"totalElements": 1
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Update Fields
Request URL
Path parameters
None
Request parameters
| Parameter | Type | Description |
|---|---|---|
| fieldId | string | A field id |
Request headers
| Header | Type | Value |
|---|---|---|
| accept | string | application/json |
| X-Api-Key | string | Your account API key |
Request Body
Only the following properties can be updated:
- metadata
- title
- titleLocal
- description
- descriptionLocal
The field id is required in the request body.
json
{
"id": "2330459",
"metadata": {
"SOURCE-SYSTEM": "PIM"
},
"title": "Désignation",
"titleLocal": {
"deu": "Bezeichnung"
},
"description": "Désignation du produit",
"descriptionLocal": {
"deu": "Produktbezeichnung"
}
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
Request Example
bash
curl -X 'PATCH' \
'https://api.product-live.com/v1/fields/2330459' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'
-d '{
"id": "2330459",
"metadata": {
"SOURCE-SYSTEM": "PIM"
},
"title": "Désignation",
"titleLocal": {
"deu": "Bezeichnung"
},
"description": "Désignation du produit",
"descriptionLocal": {
"deu": "Produktbezeichnung"
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Response example
json
{
"object": "field",
"id": "2330459",
"updatedAt": "2025-03-11T15:24:37.000Z",
"createdAt": "2024-11-22T09:37:46.000Z",
"metadata": {
"SOURCE-SYSTEM": "PIM"
},
"tableId": "226",
"levelId": "243",
"displayInfo": {},
"key": "SINGLE_LINE_TEXT",
"type": "SINGLE_LINE_TEXT",
"title": "Désignation",
"titleLocal": {
"deu": "Bezeichnung"
},
"description": "Désignation du produit",
"descriptionLocal": {
"deu": "Produktbezeichnung"
}
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22