Content Management Item Links API
The Item Links 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 link is a link between one of your item and one of your partner item on the same table. It enables you, while collecting data, to easily retrieve the previously linked item and create a suggestion on it, even if is identifiers change.
The Item Links API Swagger definition is available on our Product-Live API portal here.
General information
- Rate limit: 50 requests per minute
Get Item Links by id
Request URL
Path path
| Parameter | Type | Description |
|---|---|---|
| itemLinkId | string | An Item Link id |
Request parameters
None
Request headers
| Header | Type | Description |
|---|---|---|
| accept | string | */* |
| X-Api-Key | string | Your account API key |
Request Body
None
Request Example
bash
curl -X 'GET' \
'GET https://api.product-live.com/v1/item_links/88' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'1
2
3
4
2
3
4
Response example
json
{
"object": "item_link",
"id": "88",
"updatedAt": "2024-07-17T15:42:11.000Z",
"createdAt": "2024-07-17T15:42:11.000Z",
"fromItemId": "90684",
"toItemId": "90688"
}1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
List Item Links
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 | Description |
|---|---|---|
| accept | string | */* |
| X-Api-Key | string | Your account API key |
Request Body
None
Example
bash
curl -X 'GET' \
'https://api.product-live.com/v1/item_links?size=1&page=0' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>1
2
3
4
2
3
4
Response example
json
{
"object": "list",
"data": [
{
"object": "item_link",
"id": "88",
"updatedAt": "2024-07-17T15:42:11.000Z",
"createdAt": "2024-07-17T15:42:11.000Z",
"fromItemId": "90684",
"toItemId": "90688"
}
],
"totalElements": 1
}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
Find Item Links
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
See more details on the find request body in the dedicated page Find Request.
json
{
"type": "eq",
"caseSensitive": true,
"field": "fromItemId",
"value": "90684"
}1
2
3
4
5
6
2
3
4
5
6
json
{
"type": "and",
"queries": [
{
"type": "eq",
"caseSensitive": true,
"field": "fromItemId",
"value": "90684"
},
{
"type": "eq",
"caseSensitive": true,
"field": "toItemId",
"value": "90688"
}
]
}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/item_links/find?page=0&size=1' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'
-d '{
"type": "and",
"queries": [
{
"type": "eq",
"caseSensitive": true,
"field": "fromItemId",
"value": "90684"
},
{
"type": "eq",
"caseSensitive": true,
"field": "toItemId",
"value": "90688"
}
]
}'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
Response example
json
{
"object": "list",
"data": [
{
"object": "item_link",
"id": "88",
"updatedAt": "2024-07-17T15:42:11.000Z",
"createdAt": "2024-07-17T15:42:11.000Z",
"fromItemId": "90684",
"toItemId": "90688"
}
],
"totalElements": 1
}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
Create Item Links
Request URL
Path parameters
None
Request parameters
None
Request Body
json
{
"object": "item_link_create",
"fromItemId": "90684",
"toItemId": "90688"
}1
2
3
4
5
2
3
4
5
Request Example
bash
curl -X 'POST' \
'https://api.product-live.com/v1/item_links' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'
-d '{
"object": "item_link_create",
"fromItemId": "90684",
"toItemId": "90688"
}'1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Response example
json
{
"object": "item_link",
"id": "88",
"updatedAt": "2024-07-17T15:42:11.000Z",
"createdAt": "2024-07-17T15:42:11.000Z",
"fromItemId": "90684",
"toItemId": "90688"
}1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
Delete Item Links
Request URL
Path parameters
| Parameter | Type | Description |
|---|---|---|
| itemLinkId | string | An Item Link id |
Request parameters
None
Request Headers
| Header | Type | Description |
|---|---|---|
| accept | string | */* |
| X-Api-Key | string | Your account API key |
Request Body
None
Request Example
bash
curl -X 'DELETE' \
'https://api.product-live.com/v1/item_links/88' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'1
2
3
4
2
3
4
Response Example
None. Only the HTTP status code informs of the completion of the request.