Content Management Items API
The Item 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
An item is a set of data similar to a line in Excel, stored in a partition (and thus in a table). An item contains a set of identifiers, classifications and fields, each of them composed by a unique identifier and a value. The fields of an item are defined by the schema of the table in which it is stored.
The Items API Swagger definition is available on our Product-Live API portal here.
General information
- An item contains at least one field of type
IDENTIFIER. - Rate limit: 50 requests per minute
Get an Item by Id
Request URL
Path parameters
| Parameter | Type | Description |
|---|---|---|
| itemId | string | Required The id of the item. |
Request parameters
None
Request headers
| Header | Type | Value |
|---|---|---|
| accept | string | application/json |
| X-Api-Key | string | Your account API key |
Request Body
None
Request Example
bash
curl -X 'GET' \
'https://api.product-live.com/v1/items/391432' \
-H 'accept: application/json' \
-H 'X-Api-Key: <REDACTED>'1
2
3
4
2
3
4
Response Example
json
{
"fields": {
"EAN": {
"id": "314719",
"type": "IDENTIFIER",
"value": {
"data": "8710103533825"
}
},
"BRAND_CODE": {
"id": "315359",
"type": "SINGLE_SELECT",
"value": {
"data": "BRANDX"
}
},
"SUPPLIER_CODE": {
"id": "316912",
"type": "SINGLE_SELECT",
"value": {
"data": "SUPPLIERX"
}
}
},
"parent": null,
"children": null,
"object": "item",
"id": "391432",
"createdAt": "2021-01-25T08:57:13.000Z",
"updatedAt": "2021-01-26T15:35:33.000Z",
"itemMetadata": {
"createdAt": "2021-01-25T08:57:13.000Z",
"updatedAt": "2021-01-26T15:35:33.000Z",
"tableId": "154",
"tableKey": "A06_PRODUCTS",
"tableOwnerAccountId": "69",
"levelId": "170",
"levelKey": "PRODUCT",
"partitionId": "280"
}
}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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
List Items
Request URL
Path parameters
None
Request parameters
| Parameter | Type | Description |
|---|---|---|
| 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 |
Request headers
| Header | Type | Value |
|---|---|---|
| accept | string | application/json |
| X-Api-Key | string | Your account API key |
Request Body
None
Request Example
bash
curl -X 'GET' \
'https://api.product-live.com/v1/items?size=1&page=0' \
-H 'accept: application/json' \
-H 'X-Api-Key: <REDACTED>'1
2
3
4
2
3
4
ts
1
Response Example
json
{
"object": "list",
"data": [
{
"fields": {
"EAN": {
"id": "314719",
"type": "IDENTIFIER",
"value": {
"data": "8710103533825"
}
},
"BRAND_CODE": {
"id": "315359",
"type": "SINGLE_SELECT",
"value": {
"data": "BRANDX"
}
},
"SUPPLIER_CODE": {
"id": "316912",
"type": "SINGLE_SELECT",
"value": {
"data": "SUPPLIERX"
}
}
},
"parent": null,
"children": null,
"object": "item",
"id": "391432",
"createdAt": "2021-01-25T08:57:13.000Z",
"updatedAt": "2021-01-26T15:35:33.000Z",
"itemMetadata": {
"createdAt": "2021-01-25T08:57:13.000Z",
"updatedAt": "2021-01-26T15:35:33.000Z",
"tableId": "154",
"tableKey": "A06_PRODUCTS",
"tableOwnerAccountId": "69",
"levelId": "170",
"levelKey": "PRODUCT",
"partitionId": "280"
}
}
],
"totalElements": 1
}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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
Find Items by Partition Id
TIP
It is possible to find items on owned table's partitions, and also on shared table's partitions.
Request URL
Path parameters
None
Request parameters
| Parameter | Type | Description |
|---|---|---|
| partitionId | integer | Mandatory The partition Id to search for items in |
| 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 |
Request Headers
| Header | Type | Value |
|---|---|---|
| accept | string | */* |
| Content-Type | string | application/json |
| X-Api-Key | string | Your account API key |
Request Body
See more details on the find request body in the dedicated page Find request.
json
{
"type": "in",
"caseSensitive": true,
"field": "id",
"value": ["391432"]
}1
2
3
4
5
6
2
3
4
5
6
json
{
"type": "eq",
"field": {
"target": "item.fields",
"key": "EAN"
},
"value": "8710103533825"
}1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
Request Example
bash
curl -X 'POST' \
'https://api.product-live.com/v1/items/find?partitionId=280&size=10&page=0' \
-H 'accept: application/json' \
-H 'X-Api-Key: [REDACTED]' \
-H 'Content-Type: application/json' \
-d '{
"type": "in",
"caseSensitive": true,
"field": "id",
"value": ["391432"]
}'1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
bash
curl -X 'POST' \
'https://api.product-live.com/v1/items/find?partitionId=280&size=10&page=0' \
-H 'accept: application/json' \
-H 'X-Api-Key: [REDACTED]' \
-H 'Content-Type: application/json' \
-d '{
"type": "eq",
"field": {
"target": "item.fields",
"key": "EAN"
},
"value": "8710103533825"
}'1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
Response Example
json
{
"object": "list",
"data": [
{
"fields": {
"EAN": {
"id": "314719",
"type": "IDENTIFIER",
"value": {
"data": "8710103533825"
}
},
"BRAND_CODE": {
"id": "315359",
"type": "SINGLE_SELECT",
"value": {
"data": "BRANDX"
}
},
"SUPPLIER_CODE": {
"id": "316912",
"type": "SINGLE_SELECT",
"value": {
"data": "SUPPLIERX"
}
}
},
"parent": null,
"children": null,
"object": "item",
"id": "391432",
"createdAt": "2021-01-25T08:57:13.000Z",
"updatedAt": "2021-01-26T15:35:33.000Z",
"itemMetadata": {
"createdAt": "2021-01-25T08:57:13.000Z",
"updatedAt": "2021-01-26T15:35:33.000Z",
"tableId": "154",
"tableKey": "A06_PRODUCTS",
"tableOwnerAccountId": "69",
"levelId": "170",
"levelKey": "PRODUCT",
"partitionId": "280"
}
}
],
"totalElements": 1
}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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
WARNING
It is possible to find items on non-visible partitions. This happens when you have imported items on a shared table and partition that are no longer shared with your account. You can still find these items because they belong to your account.
Create or Update an Item
Request URL
Path parameters
None
Request parameters
None
Request Headers
| Header | Type | Value |
|---|---|---|
| accept | string | */* |
| Content-Type | string | application/json |
| X-Api-Key | string | Your account API key |
Request Body
json
{
"object": "item_create",
"fields": {
"EAN": {
"value": {
"data": "8710103533825"
},
"type": "IDENTIFIER"
}
},
"itemMetadata": {
"partitionId": "280"
}
}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
json
{
"object": "item_create",
"fields": {
"EAN": {
"type": "IDENTIFIER"
"value": {
"data": "8710103533825"
},
},
"BRAND_CODE": {
"type": "SINGLE_SELECT",
"value": {
"data": "BRANDX"
}
},
"HIERARCHY": {
"value": {
"data": "SHAVER"
},
"type": "CLASSIFICATION"
},
"DESIGNATION": {
"value": {
"data": "Modern service cellar"
},
"type": "SINGLE_LINE_TEXT"
},
"OFFER": {
"value": {
"data": "UP TO €60 REIMBURSED* FOR THE PURCHASE OF A PHILIPS SHAVER"
},
"type": "LONG_TEXT"
},
"LONG_DESCRIPTION": {
"value": {
"data": "Discover this superb men's shaver, a benchmark in the field!<br/>With this new technology and a 360° flexible head, it delivers a precise, irritation-free shave, whether wet or dry. Its rechargeable Li-ion battery guarantees 60 minutes of autonomy after just 1 hour's charging. What's more, this shaver with quick-clean base includes 7 cartridges. Its elegant green design is sure to win you over. Made in China, it comes with a 10-year warranty.<br/>Energy class E guarantees good energy performance."
},
"type": "HTML_TEXT"
},
"MANUFACTURING_COUNTRY": {
"value": {
"data": "CHINA"
},
"type": "SINGLE_SELECT"
},
"COLOR": {
"value": {
"data": [
"BLACK"
]
},
"type": "MULTIPLE_SELECT"
},
"ACCESSORIES": {
"value": {
"data": [
{
"key": "BRUSH",
"quantity": 2
},
{
"key": "CABLE",
"quantity": 1
}
]
},
"type": "MULTIPLE_SELECT_QUANTIFIED"
},
"BATTERY": {
"value": {
"data": [
{
"key": "AA",
"quantity": 2,
"comment": "RECHARGEABLE"
}
]
},
"type": "MULTIPLE_SELECT_QUANTIFIED_WITH_COMMENTS"
},
"PRICE": {
"value": {
"data": 178.60,
"suffix": "EUROS"
},
"type": "NUMBER"
},
"ODR_START_DATE": {
"value": {
"data": "2024-09-26"
},
"type": "DATE"
},
"ODR_END_DATE": {
"value": {
"data": "2024-10-27T00:00:00.000Z"
},
"type": "DATE_TIME"
},
"MAIN_IMAGE": {
"value": {
"data": "https://asset.prod.product-live.com/file-map/5fcf4cc59996ce7867966017_documents/redirect/35b9dee447d5a0d65561825211c00f49f445db173a9c98c07fee6530b4a4572c/35b9dee447d5a0d65561825211c00f49f445db173a9c98c07fee6530b4a4572c"
},
"type": "IMAGE"
},
"TECHNICAL_DATA_SHEET": {
"value": {
"data": "https://asset.prod.product-live.com/file-map/5fcf4cc59996ce7867966017_documents/redirect/36bbf6826bd9a559bd1046d7e6f6a24350249e2b74309e0820a2c2db5ce749fa/36bbf6826bd9a559bd1046d7e6f6a24350249e2b74309e0820a2c2db5ce749fa"
},
"type": "ATTACHMENT"
}
},
"itemMetadata": {
"partitionId": "280"
}
}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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
json
{
"object": "item_create",
"fields": {
"PRODUCT_CODE": {
"value": {
"data": "0039989"
},
"type": "IDENTIFIER"
}
},
"itemMetadata": {
"partitionId": "576"
}
}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
json
{
"object": "item_create",
"fields": {
"COLOR_ID": {
"value": {
"data": "36165600399890004"
},
"type": "IDENTIFIER"
}
},
"parentId": "4638723",
"itemMetadata": {
"partitionId": "576"
}
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
TIP
You do not import an item on a table. You import items on a table's partition. To get the table's partition, use the Partitions API.
On multi-levels tables only, you can import an item on sub-levels by referencing the parent item id in the
parentIdparameter. You do not have to import parent item identifier as you do in Data Factorytable-import-itemstask
Request Example
bash
curl -X 'POST' \
'https://api.product-live.com/v1/items/create-or-update' \
-H 'accept: application/json' \
-H 'X-Api-Key: [REDACTED]' \
-H 'Content-Type: application/json' \
-d '{
"object": "item_create",
"fields": {
"EAN": {
"value": {
"data": "8710103533825"
},
"type": "IDENTIFIER"
}
},
"itemMetadata": {
"partitionId": "280"
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
bash
curl -X 'POST' \
'https://api.product-live.com/v1/items/create-or-update' \
-H 'accept: application/json' \
-H 'X-Api-Key: [REDACTED]' \
-H 'Content-Type: application/json' \
-d '{
"object": "item_create",
"fields": {
"EAN": {
"type": "IDENTIFIER"
"value": {
"data": "8710103533825"
},
},
"BRAND_CODE": {
"type": "SINGLE_SELECT",
"value": {
"data": "BRANDX"
}
},
"HIERARCHY": {
"value": {
"data": "SHAVER"
},
"type": "CLASSIFICATION"
},
"DESIGNATION": {
"value": {
"data": "Modern service cellar"
},
"type": "SINGLE_LINE_TEXT"
},
"OFFER": {
"value": {
"data": ""UP TO €60 REIMBURSED* FOR THE PURCHASE OF A PHILIPS SHAVER""
},
"type": "LONG_TEXT"
},
"LONG_DESCRIPTION": {
"value": {
"data": "Discover this superb men's shaver, a benchmark in the field!<br/>With SkinIQ technology and a 360° flexible head, it delivers a precise, irritation-free shave, whether wet or dry. Its rechargeable Li-ion battery guarantees 60 minutes of autonomy after just 1 hour's charging. What's more, this shaver with quick-clean base includes 7 cartridges. Its elegant green design is sure to win you over. Made in China, it comes with a 10-year warranty.<br/>Energy class E guarantees good energy performance.<br/>EAN code: 8710103964896."
},
"type": "HTML_TEXT"
},
"MANUFACTURING_COUNTRY": {
"value": {
"data": "CHINA"
},
"type": "SINGLE_SELECT"
},
"COLOR": {
"value": {
"data": [
"BLACK"
]
},
"type": "MULTIPLE_SELECT"
},
"ACCESSORIES": {
"value": {
"data": [
{
"key": "BRUSH",
"quantity": 2
},
{
"key": "CABLE",
"quantity": 1
}
]
},
"type": "MULTIPLE_SELECT_QUANTIFIED"
},
"BATTERY": {
"value": {
"data": [
{
"key": "AA",
"quantity": 2,
"comment": "RECHARGEABLE"
}
]
},
"type": "MULTIPLE_SELECT_QUANTIFIED_WITH_COMMENTS"
},
"PRICE": {
"value": {
"data": 178.60,
"suffix": "EUROS"
},
"type": "NUMBER"
},
"ODR_START_DATE": {
"value": {
"data": "2024-09-26"
},
"type": "DATE"
},
"ODR_END_DATE": {
"value": {
"data": "2024-10-27T00:00:00.000Z"
},
"type": "DATE_TIME"
},
"MAIN_IMAGE": {
"value": {
"data": "https://asset.prod.product-live.com/file-map/5fcf4cc59996ce7867966017_documents/redirect/35b9dee447d5a0d65561825211c00f49f445db173a9c98c07fee6530b4a4572c/35b9dee447d5a0d65561825211c00f49f445db173a9c98c07fee6530b4a4572c"
},
"type": "IMAGE"
},
"TECHNICAL_DATA_SHEET": {
"value": {
"data": "https://asset.prod.product-live.com/file-map/5fcf4cc59996ce7867966017_documents/redirect/36bbf6826bd9a559bd1046d7e6f6a24350249e2b74309e0820a2c2db5ce749fa/36bbf6826bd9a559bd1046d7e6f6a24350249e2b74309e0820a2c2db5ce749fa"
},
"type": "ATTACHMENT"
}
},
"itemMetadata": {
"partitionId": "280"
}
}'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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
bash
curl -X 'POST' \
'https://api.product-live.com/v1/items/create-or-update' \
-H 'accept: application/json' \
-H 'X-Api-Key: [REDACTED]' \
-H 'Content-Type: application/json' \
-d '{
"object": "item_create",
"fields": {
"PRODUCT_CODE": {
"value": {
"data": "0039989"
},
"type": "IDENTIFIER"
}
},
"itemMetadata": {
"partitionId": "576"
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
bash
curl -X 'POST' \
'https://api.product-live.com/v1/items/create-or-update' \
-H 'accept: application/json' \
-H 'X-Api-Key: [REDACTED]' \
-H 'Content-Type: application/json' \
-d '{
"object": "item_create",
"fields": {
"COLOR_ID": {
"value": {
"data": "36165600399890004"
},
"type": "IDENTIFIER"
}
},
"parentId": "4638723",
"itemMetadata": {
"partitionId": "576"
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
Response Example
json
{
"fields": {
"EAN": {
"id": "314719",
"type": "IDENTIFIER",
"value": {
"data": "8710103533825"
}
}
},
"parent": null,
"children": null,
"object": "item",
"id": "391432",
"createdAt": "2021-01-25T08:57:13.000Z",
"updatedAt": "2021-01-26T15:35:33.000Z",
"itemMetadata": {
"createdAt": "2021-01-25T08:57:13.000Z",
"updatedAt": "2021-01-26T15:35:33.000Z",
"tableId": "154",
"tableKey": "A06_PRODUCTS",
"tableOwnerAccountId": "69",
"levelId": "170",
"levelKey": "PRODUCT",
"partitionId": "280"
}
}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