Content Management Suggestions API
The Suggestions 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 suggestion is a set of field values sent by your partner on a product. It enables you to examine the suggested fields values before applying them on your products.
The Suggestions API Swagger definition is available on our Product-Live API portal here.
General information
- Rate limit: 50 requests per minute
Get Suggestion by id
Request URL
Path path
Parameter | Type | Description |
---|---|---|
suggestionId | string | A suggestion 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/suggestions/2185' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'
1
2
3
4
2
3
4
Response example
json
{
"object": "suggestion",
"id": "2185",
"updatedAt": "2022-05-13T07:54:59.000Z",
"createdAt": "2022-05-13T07:54:55.000Z",
"toItemId": "1958624",
"hasCreatedItem": true,
"isAcknowledged": false,
"fromAccountId": "3568",
"fields": [
{
"key": "EAN",
"type": "IDENTIFIER",
"value": {
"data": "8710103533825"
}
},
{
"key": "LENGTH",
"type": "NUMBER",
"value": {
"data": 42,
"suffix": "cm"
}
}
],
"deletedFields": [
{
"key": "DESIGNATION",
"type": "SINGLE_LINE_TEXT"
}
]
}
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
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
List Suggestions
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/suggestions?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": "suggestion",
"id": "2185",
"updatedAt": "2022-05-13T07:54:59.000Z",
"createdAt": "2022-05-13T07:54:55.000Z",
"toItemId": "1958624",
"hasCreatedItem": true,
"isAcknowledged": false,
"fromAccountId": "3568",
"fields": [
{
"key": "EAN",
"type": "IDENTIFIER",
"value": {
"data": "8710103533825"
}
},
{
"key": "LENGTH",
"type": "NUMBER",
"value": {
"data": 42,
"suffix": "cm"
}
}
],
"deletedFields": [
{
"key": "DESIGNATION",
"type": "SINGLE_LINE_TEXT"
}
]
}
],
"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
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
Find Suggestions
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",
"field": "hasCreatedItem",
"value": true
}
1
2
3
4
5
2
3
4
5
json
{
"type": "and",
"queries": [
{
"type": "eq",
"field": "hasCreatedItem",
"value": true
},
{
"type": "eq",
"field": "isAcknowledged",
"value": false
}
]
}
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
Request Example
bash
curl -X 'POST' \
'https://api.product-live.com/v1/suggestions/find?page=0&size=1' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'
-d '{
"type": "and",
"queries": [
{
"type": "eq",
"field": "hasCreatedItem",
"value": true
},
{
"type": "eq",
"field": "isAcknowledged",
"value": false
}
]
}'
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
Response example
json
{
"object": "list",
"data": [
{
"object": "suggestion",
"id": "2185",
"updatedAt": "2022-05-13T07:54:59.000Z",
"createdAt": "2022-05-13T07:54:55.000Z",
"toItemId": "1958624",
"hasCreatedItem": true,
"isAcknowledged": false,
"fromAccountId": "3568",
"fields": [
{
"key": "EAN",
"type": "IDENTIFIER",
"value": {
"data": "8710103533825"
}
},
{
"key": "LENGTH",
"type": "NUMBER",
"value": {
"data": 42,
"suffix": "cm"
}
}
],
"deletedFields": [
{
"key": "DESIGNATION",
"type": "SINGLE_LINE_TEXT"
}
]
}
],
"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
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
Apply some fields of a Suggestion
Request URL
Path parameters
Parameter | Type | Description |
---|---|---|
suggestionId | string | A suggestion id |
Request parameters
None
Request Body
json
{
"isAcknowledged": true,
"fieldsKey": [
"EAN",
"CLASSIFICATION",
"DESCRIPTION"
]
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
json
{
"fieldsKey": [
"EAN",
"CLASSIFICATION",
"DESCRIPTION"
]
}
1
2
3
4
5
6
7
2
3
4
5
6
7
json
{
"isAcknowledged": true
}
1
2
3
2
3
TIP
You can either mark a suggestion as read (acknowledged) and/or apply fields from that suggestion.
When applying fields, you must provide a valid list of field keys (one to many keys). If a field key is missing in the suggestion, no field is applied.
There is no difference for applying a field value or a field deletion. You just have to list the field. Depending on there is a suggested value or deletion, the field will be updated with the suggested value or emptied.
Request Example
bash
curl -X 'POST' \
'https://api.product-live.com/v1/suggestions/88/apply' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'
-d '{
"isAcknowledged": true,
"fieldsKey": [
"EAN",
"CLASSIFICATION",
"DESCRIPTION"
]
}'
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
Response example
None
Apply all fields of a Suggestion
Request URL
Path parameters
Parameter | Type | Description |
---|---|---|
suggestionId | string | A suggestion id |
Request parameters
None
Request Body
json
{
"isAcknowledged": true
}
1
2
3
2
3
json
1
TIP
When applying all suggested fields, you can optionnaly mark the suggestion as read (acknowledged).
Both suggested fields values and suggested fields deletion are applied.
Request Example
bash
curl -X 'POST' \
'https://api.product-live.com/v1/suggestions/88/apply' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'
-d '{
"isAcknowledged": true
}'
1
2
3
4
5
6
7
2
3
4
5
6
7
Response example
None
Create a Suggestion
Request URL
Path parameters
None
Request parameters
None
Request Body
json
{
"object": "suggestion-create",
"itemId": "1958624",
"screenId": "531059",
"hasCreatedItem": true,
"publicationId": "694314"
}
1
2
3
4
5
6
7
2
3
4
5
6
7
json
{
"object": "suggestion-create",
"itemId": "1958624",
"screenId": "531059",
"hasCreatedItem": true,
"publicationId": "694314",
"includedFieldKeys": [
"LENGTH"
],
"excludedFieldKeys": [
"DESIGNATION"
]
}
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
json
{
"object": "suggestion-create",
"itemId": "1958624",
"screenId": "531059",
"hasCreatedItem": true,
"emitterName": "My ERP",
"fields": [
{
"key": "EAN",
"value": {
"data": "8710103533825"
}
},
{
"key": "LENGTH",
"value": {
"data": 42,
"suffix": "cm"
}
}
],
"deletedFields": [
"DESIGNATION",
"OFFER"
]
}
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
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
TIP
When a suggestion is created, whether from a publication or from scratch, only the fields available on the target screen are included in the suggestion. All fields, from the publication or the list, that do not exist on the target screen are omitted in the created suggestion.
Request Example
bash
curl -X 'POST' \
'https://api.product-live.com/v1/publications' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'
-d '{
"object": "suggestion-create",
"itemId": "1958624",
"screenId": "531059",
"hasCreatedItem": true,
"publicationId": "694314"
}'
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
Response example
json
{
"object": "suggestion",
"id": "2185",
"updatedAt": "2022-05-13T07:54:59.000Z",
"createdAt": "2022-05-13T07:54:55.000Z",
"toItemId": "1958624",
"hasCreatedItem": false,
"isAcknowledged": false,
"fromAccountId": "3568",
"fields": [
{
"key": "ID",
"type": "IDENTIFIER",
"value": {
"data": "8710103533825"
}
},
{
"key": "LENGTH",
"type": "NUMBER",
"value": {
"data": 42,
"suffix": "cm"
}
}
],
"deletedFields": [
{
"key": "DESIGNATION",
"type": "SINGLE_LINE_TEXT"
}
]
}
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
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