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
{
"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
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.