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

curl -X 'GET' \
  'GET https://api.product-live.com/v1/suggestions/2185' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>'

Response example

{
    "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": {
        "EAN": {
            "id": "1526709",
            "type": "IDENTIFIER",
            "value": "8710103533825"
        },
        "LENGTH": {
            "id": "174025",
            "type": "NUMBER",
            "value": {
                "data": 42,
                "suffix": "cm"
            }
        }
    },
    "deletedFields": [
        {
            "id": "1749364",
            "type": "DESIGNATION",
            "key": "SINGLE-LINE-TEXT"
        }
    ]
}

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

curl -X 'GET' \
  'https://api.product-live.com/v1/suggestions?size=1&page=0' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>

Response example

{
    "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": {
                "EAN": {
                    "id": "1526709",
                    "type": "IDENTIFIER",
                    "value": "8710103533825"
                },
                "LENGTH": {
                    "id": "174025",
                    "type": "NUMBER",
                    "value": {
                        "data": 42,
                        "suffix": "cm"
                    }
                }
            },
            "deletedFields": [
                {
                    "id": "1749364",
                    "type": "DESIGNATION",
                    "key": "SINGLE-LINE-TEXT"
                }
            ]
        }
    ],
    "totalElements": 1
}

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.

Single parameter research

{
  "type": "eq",
  "field": "hasCreatedItem",
  "value": true
}

Multiple parameters research

{
  "type": "and",
  "queries": [
    {
      "type": "eq",
      "field": "hasCreatedItem",
      "value": true
    },
    {
      "type": "eq",
      "field": "isAcknowledged",
      "value": false
    }
  ]
}

Request Example

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
    }
  ]
}'

Response example

{
    "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": {
                "EAN": {
                    "id": "1526709",
                    "type": "IDENTIFIER",
                    "value": "8710103533825"
                },
                "LENGTH": {
                    "id": "174025",
                    "type": "NUMBER",
                    "value": {
                        "data": 42,
                        "suffix": "cm"
                    }
                }
            },
            "deletedFields": [
                {
                    "id": "1749364",
                    "type": "DESIGNATION",
                    "key": "SINGLE-LINE-TEXT"
                }
            ]
        }
    ],
    "totalElements": 1
}

Apply some fields of a Suggestion

Request URL

Path parameters

Parameter	Type	Description
suggestionId	string	A suggestion id

Request parameters

None

Request Body

Apply suggestion fields and mark it as read

{
  "isAcknowledged": true,
  "fieldsKey": [
    "EAN",
    "CLASSIFICATION",
    "DESCRIPTION"
  ]
}

Apply suggestion fields only

{
  "fieldsKey": [
    "EAN",
    "CLASSIFICATION",
    "DESCRIPTION"
  ]
}

Only mark a suggestion as read

{
  "isAcknowledged": true
}

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

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"
  ]
}'

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

Apply all suggestion fields and mark it as read

{
  "isAcknowledged": true
}

Apply all suggestion fields and do not mark it as read

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

curl -X 'POST' \
  'https://api.product-live.com/v1/suggestions/88/apply' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>'
  -d '{
  "isAcknowledged": true
}'

Response example

None

Create a Suggestion

Request URL

Path parameters

None

Request parameters

None

Request Body

Create a Suggestion from a Publication

{
    "object": "suggestion-create",
    "itemId": "1958624",
    "screenId": "531059",
    "hasCreatedItem": true,
    "publicationId": "694314"
}

Create a Suggestion from scratch

{
    "object": "suggestion-create",
    "itemId": "1958624",
    "screenId": "531059",
    "hasCreatedItem": true,
    "emitterName": "My ERP",
    "fields": [
        {
            "id": "1526709",
            "type": "IDENTIFIER",
            "value": {
                "data": "8710103533825"
            }
        },
        {
            "id": "174025",
            "type": "NUMBER",
            "value": {
                "data": 42,
                "suffix": "cm"
            }
        }
    ],
    "deletedFields": [
        {
            "id": "1749364",
            "type": "DESIGNATION",
            "key": "SINGLE-LINE-TEXT"
        }
    ]
}

Request Example

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"
}'

Response example

{
    "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": {
        "ID": {
            "id": "1526709",
            "type": "IDENTIFIER",
            "value": "8710103533825"
        },
        "LENGTH": {
            "id": "174025",
            "type": "NUMBER",
            "value": {
                "data": 42,
                "suffix": "cm"
            }
        }
    },
    "deletedFields": [
        {
            "id": "1749364",
            "type": "DESIGNATION",
            "key": "SINGLE-LINE-TEXT"
        }
    ]
}