Content Management Publications API

The Publications 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 publication is a set of field values sent to your partner on a product. It enables you to examine the fields values you suggested on your products for your partner.

The Publications API Swagger definition is available on our Product-Live API portal here.

General information

• Rate limit: 50 requests per minute

Get Publication by id

Request URL

Path path

Parameter	Type	Description
publicationId	string	A publication 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

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

Response example

{
    "object": "publication",
    "id": "38643",
    "updatedAt": "2024-05-17T07:39:23.000Z",
    "createdAt": "2024-05-17T07:38:54.000Z",
    "sentAt": "2024-05-17T07:38:54.000Z",
    "fromItemId": "80303",
    "toAccountId": "6326",
    "tableId": "1353",
    "partitionId": "2342",
    "screenId": "7421",
    "status": "RECEIVED",
    "fields": {
        "EAN": {
            "id": "238",
            "type": "IDENTIFIER",
            "value": "3610011803438"
        },
        "TYPOLOGY": {
            "id": "241",
            "type": "CLASSIFICATION",
            "value": "FRIDGE"
        }
    }
}

List Publications

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-next.product-live.com/v1/publications?size=1&page=0' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>

Response example

{
    "object": "list",
    "data": [
        {
            "object": "publication",
            "id": "38643",
            "updatedAt": "2024-05-17T07:39:23.000Z",
            "createdAt": "2024-05-17T07:38:54.000Z",
            "sentAt": "2024-05-17T07:38:54.000Z",
            "fromItemId": "80303",
            "toAccountId": "6326",
            "tableId": "1353",
            "partitionId": "2342",
            "screenId": "7421",
            "status": "RECEIVED",
            "fields": {
                "EAN": {
                    "id": "238",
                    "type": "IDENTIFIER",
                    "value": "3610011803438"
                },
                "TYPOLOGY": {
                    "id": "241",
                    "type": "CLASSIFICATION",
                    "value": "FRIDGE"
                }
            }
        }
    ],
    "totalElements": 246
}

Find Publications

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",
  "caseSensitive": true,
  "field": "status",
  "value": "RECEIVED"
}

Multiple parameters research

{
  "type": "and",
  "queries": [
    {
      "type": "eq",
      "caseSensitive": true,
      "field": "status",
      "value": "RECEIVED"
    },
    {
      "type": "eq",
      "caseSensitive": true,
      "field": "toAccountId",
      "value": "6326"
    }
  ]
}

Request Example

curl -X 'POST' \
  'https://api-next.product-live.com/v1/publications/find?page=0&size=1' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>'
  -d '{
  "type": "and",
  "queries": [
    {
      "type": "eq",
      "caseSensitive": true,
      "field": "status",
      "value": "RECEIVED"
    },
    {
      "type": "eq",
      "caseSensitive": true,
      "field": "toAccountId",
      "value": "6326"
    }
  ]
}'

Response example

{
    "object": "list",
    "data": [
        {
            "object": "publication",
            "id": "38643",
            "updatedAt": "2024-05-17T07:39:23.000Z",
            "createdAt": "2024-05-17T07:38:54.000Z",
            "sentAt": "2024-05-17T07:38:54.000Z",
            "fromItemId": "80303",
            "toAccountId": "6326",
            "tableId": "1353",
            "partitionId": "2342",
            "screenId": "7421",
            "status": "RECEIVED",
            "fields": {
                "EAN": {
                    "id": "238",
                    "type": "IDENTIFIER",
                    "value": "3610011803438"
                },
                "TYPOLOGY": {
                    "id": "241",
                    "type": "CLASSIFICATION",
                    "value": "FRIDGE"
                }
            }
        }
    ],
    "totalElements": 34
}

Create a Publication

Request URL

Path parameters

None

Request parameters

None

Request Body

{
    "fromItemId": "4623",
    "toAccountId": "4931432",
    "screenId": "5642"
}

Request Example

curl -X 'POST' \
  'https://api.product-live.com/v1/publications' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>'
  -d '{
    "fromItemId": "80303",
    "toAccountId": "6326",
    "screenId": "5642"
}'

Response example

{
    "object": "publication",
    "id": "38643",
    "updatedAt": "2024-05-17T07:39:23.000Z",
    "createdAt": "2024-05-17T07:38:54.000Z",
    "sentAt": "2024-05-17T07:38:54.000Z",
    "fromItemId": "80303",
    "toAccountId": "6326",
    "tableId": "1353",
    "partitionId": "2342",
    "screenId": "7421",
    "status": "SENT",
    "fields": {
        "EAN": {
            "id": "238",
            "type": "IDENTIFIER",
            "value": "3610011803438"
        },
        "TYPOLOGY": {
            "id": "241",
            "type": "CLASSIFICATION",
            "value": "FRIDGE"
        }
    }
}

Update a Publication status

Request URL

Path parameters

Parameter	Type	Description
publicationId	string	A publication id

Request parameters

None

Request Body

Confirm publication reception

{
    "status": "RECEIVED"
}

Reject publication

{
    "status": "REJECTED"
}

Request Example

curl -X 'POST' \
  'https://api-next.product-live.com/v1/publications/38643/update' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>'
  -d '{
    "status": "RECEIVED"
}'

Response example

None. Only the HTTP status code informs of the completion of the call.