Content Management Publications API
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: 100 requests per minute
- Each endpoint is available in two versions: V1 (
https://api.product-live.com/v1/publications/...) and V2 (https://api.product-live.com/v2/publications/...), with the same routes and parameters. They differ only in the shape ofIMAGEandATTACHMENTfield values: V2 returns them enriched with the full File object, while V1 returns only theirhashandfilename. See the V1/V2 tabs of the Get Publication by id response example.
Get Publication by id
Request URL
Path parameters
| 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
bash
curl -X 'GET' \
'GET https://api.product-live.com/v1/publications/38643' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'1
2
3
4
2
3
4
Response example
json
{
"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": [
{
"key": "EAN",
"type": "IDENTIFIER",
"value": {
"data": "3610011803438"
}
},
{
"key": "TYPOLOGY",
"type": "CLASSIFICATION",
"value": {
"data": "FRIDGE"
}
},
{
"key": "MAIN_IMAGE",
"type": "IMAGE",
"value": {
"data": {
"hash": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"filename": "front-image.jpg"
}
}
},
{
"key": "TECHNICAL_DATA_SHEET",
"type": "ATTACHMENT",
"value": {
"data": {
"hash": "fedcba9876543210fedcba9876543210fedcba9876543210fedcba9876543210",
"filename": "technical_sheet.pdf"
}
}
},
{
"key": "TITLE",
"type": "COMPOSITE",
"multiValued": true,
"value": {
"data": [
{
"data": [
{
"key": "LOCAL_LANGUAGE",
"type": "SINGLE-SELECT",
"value": {
"data": "FRA"
}
},
{
"key": "LOCAL_TITLE",
"type": "SINGLE-LINE-TEXT",
"value": {
"data": "Smartphone 13 mini 5,4\"\" 5G 512 Go Double SIM Vert"
}
}
],
"id": "01KJZ2B0RYBZ8NCMVXFRTTE9VK",
"position": 0
},
{
"data": [
{
"key": "LOCAL_LANGUAGE",
"type": "SINGLE-SELECT",
"value": {
"data": "ENG"
}
},
{
"key": "LOCAL_TITLE",
"type": "SINGLE-LINE-TEXT",
"value": {
"data": "Smartphone 13 mini 5.4\"\" 5G 512GB Dual SIM Green"
}
}
],
"id": "01KJZ2B37XE4731VHS0AF8KZBN",
"position": 1
},
{
"data": [
{
"key": "LOCAL_LANGUAGE",
"type": "SINGLE-SELECT",
"value": {
"data": "DEU"
}
},
{
"key": "LOCAL_TITLE",
"type": "SINGLE-LINE-TEXT",
"value": {
"data": "Smartphone 13 mini 5.4\"\" 5G 512GB Dual SIM Groen"
}
}
],
"id": "01KJZ2B3XYZJGVD8YHTB7Z4MCS",
"position": 2
}
]
}
}
]
}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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
json
{
"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": [
{
"key": "EAN",
"type": "IDENTIFIER",
"value": {
"data": "3610011803438"
}
},
{
"key": "TYPOLOGY",
"type": "CLASSIFICATION",
"value": {
"data": "FRIDGE"
}
},
{
"key": "MAIN_IMAGE",
"type": "IMAGE",
"value": {
"data": {
"object": "file",
"id": "1a2b3c4d5e6f70819203a4b5c6d7e8f91a2b3c4d5e6f70819203a4b5c6d7e8f9",
"hash": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"url": "https://asset.product-live.com/documents/1234/0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef/1a2b3c4d5e6f70819203a4b5c6d7e8f91a2b3c4d5e6f70819203a4b5c6d7e8f9/front-image.jpg",
"filename": "front-image.jpg",
"extension": "jpg",
"sha256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"md5": "0123456789abcdef0123456789abcdef",
"size": 51930,
"sizeKiloBytes": 52,
"mimeType": "image/jpeg",
"imageWidthPixel": 1200,
"imageHeightPixel": 800
}
}
},
{
"key": "TECHNICAL_DATA_SHEET",
"type": "ATTACHMENT",
"value": {
"data": {
"object": "file",
"id": "2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f8091a",
"hash": "fedcba9876543210fedcba9876543210fedcba9876543210fedcba9876543210",
"url": "https://asset.product-live.com/documents/1234/fedcba9876543210fedcba9876543210fedcba9876543210fedcba9876543210/2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f8091a/technical_sheet.pdf",
"filename": "technical_sheet.pdf",
"extension": "pdf",
"sha256": "fedcba9876543210fedcba9876543210fedcba9876543210fedcba9876543210",
"md5": "fedcba9876543210fedcba9876543210",
"size": 253191,
"sizeKiloBytes": 253,
"mimeType": "application/pdf"
}
}
},
{
"key": "TITLE",
"type": "COMPOSITE",
"multiValued": true,
"value": {
"data": [
{
"data": [
{
"key": "LOCAL_LANGUAGE",
"type": "SINGLE-SELECT",
"value": {
"data": "FRA"
}
},
{
"key": "LOCAL_TITLE",
"type": "SINGLE-LINE-TEXT",
"value": {
"data": "Smartphone 13 mini 5,4\"\" 5G 512 Go Double SIM Vert"
}
}
],
"id": "01KJZ2B0RYBZ8NCMVXFRTTE9VK",
"position": 0
},
{
"data": [
{
"key": "LOCAL_LANGUAGE",
"type": "SINGLE-SELECT",
"value": {
"data": "ENG"
}
},
{
"key": "LOCAL_TITLE",
"type": "SINGLE-LINE-TEXT",
"value": {
"data": "Smartphone 13 mini 5.4\"\" 5G 512GB Dual SIM Green"
}
}
],
"id": "01KJZ2B37XE4731VHS0AF8KZBN",
"position": 1
},
{
"data": [
{
"key": "LOCAL_LANGUAGE",
"type": "SINGLE-SELECT",
"value": {
"data": "DEU"
}
},
{
"key": "LOCAL_TITLE",
"type": "SINGLE-LINE-TEXT",
"value": {
"data": "Smartphone 13 mini 5.4\"\" 5G 512GB Dual SIM Groen"
}
}
],
"id": "01KJZ2B3XYZJGVD8YHTB7Z4MCS",
"position": 2
}
]
}
}
]
}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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
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
bash
curl -X 'GET' \
'https://api.product-live.com/v1/publications?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": "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": [
{
"key": "EAN",
"type": "IDENTIFIER",
"value": {
"data": "3610011803438"
}
},
{
"key": "TYPOLOGY",
"type": "CLASSIFICATION",
"value": {
"data": "FRIDGE"
}
},
{
"key": "TITLE",
"type": "COMPOSITE",
"multiValued": true,
"value": {
"data": [
{
"data": [
{
"key": "LOCAL_LANGUAGE",
"type": "SINGLE-SELECT",
"value": {
"data": "FRA"
}
},
{
"key": "LOCAL_TITLE",
"type": "SINGLE-LINE-TEXT",
"value": {
"data": "Smartphone 13 mini 5,4\"\" 5G 512 Go Double SIM Vert"
}
}
],
"id": "01KJZ2B0RYBZ8NCMVXFRTTE9VK",
"position": 0
},
{
"data": [
{
"key": "LOCAL_LANGUAGE",
"type": "SINGLE-SELECT",
"value": {
"data": "ENG"
}
},
{
"key": "LOCAL_TITLE",
"type": "SINGLE-LINE-TEXT",
"value": {
"data": "Smartphone 13 mini 5.4\"\" 5G 512GB Dual SIM Green"
}
}
],
"id": "01KJZ2B37XE4731VHS0AF8KZBN",
"position": 1
},
{
"data": [
{
"key": "LOCAL_LANGUAGE",
"type": "SINGLE-SELECT",
"value": {
"data": "DEU"
}
},
{
"key": "LOCAL_TITLE",
"type": "SINGLE-LINE-TEXT",
"value": {
"data": "Smartphone 13 mini 5.4\"\" 5G 512GB Dual SIM Groen"
}
}
],
"id": "01KJZ2B3XYZJGVD8YHTB7Z4MCS",
"position": 2
}
]
}
}
]
}
],
"totalElements": 246
}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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
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.
json
{
"type": "eq",
"caseSensitive": true,
"field": "status",
"value": "RECEIVED"
}1
2
3
4
5
6
2
3
4
5
6
json
{
"type": "and",
"queries": [
{
"type": "eq",
"caseSensitive": true,
"field": "status",
"value": "RECEIVED"
},
{
"type": "eq",
"caseSensitive": true,
"field": "toAccountId",
"value": "6326"
}
]
}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/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"
}
]
}'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": "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": [
{
"key": "EAN",
"type": "IDENTIFIER",
"value": {
"data": "3610011803438"
}
},
{
"key": "TYPOLOGY",
"type": "CLASSIFICATION",
"value": {
"data": "FRIDGE"
}
},
{
"key": "TITLE",
"type": "COMPOSITE",
"multiValued": true,
"value": {
"data": [
{
"data": [
{
"key": "LOCAL_LANGUAGE",
"type": "SINGLE-SELECT",
"value": {
"data": "FRA"
}
},
{
"key": "LOCAL_TITLE",
"type": "SINGLE-LINE-TEXT",
"value": {
"data": "Smartphone 13 mini 5,4\"\" 5G 512 Go Double SIM Vert"
}
}
],
"id": "01KJZ2B0RYBZ8NCMVXFRTTE9VK",
"position": 0
},
{
"data": [
{
"key": "LOCAL_LANGUAGE",
"type": "SINGLE-SELECT",
"value": {
"data": "ENG"
}
},
{
"key": "LOCAL_TITLE",
"type": "SINGLE-LINE-TEXT",
"value": {
"data": "Smartphone 13 mini 5.4\"\" 5G 512GB Dual SIM Green"
}
}
],
"id": "01KJZ2B37XE4731VHS0AF8KZBN",
"position": 1
},
{
"data": [
{
"key": "LOCAL_LANGUAGE",
"type": "SINGLE-SELECT",
"value": {
"data": "DEU"
}
},
{
"key": "LOCAL_TITLE",
"type": "SINGLE-LINE-TEXT",
"value": {
"data": "Smartphone 13 mini 5.4\"\" 5G 512GB Dual SIM Groen"
}
}
],
"id": "01KJZ2B3XYZJGVD8YHTB7Z4MCS",
"position": 2
}
]
}
}
]
}
],
"totalElements": 34
}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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
Create a Publication
Request URL
Path parameters
None
Request parameters
None
Request Body
json
{
"fromItemId": "4623",
"toAccountId": "4931432",
"screenId": "5642"
}1
2
3
4
5
2
3
4
5
Request Example
bash
curl -X 'POST' \
'https://api.product-live.com/v1/publications' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'
-d '{
"fromItemId": "80303",
"toAccountId": "6326",
"screenId": "5642"
}'1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Response example
json
{
"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": [
{
"key": "EAN",
"type": "IDENTIFIER",
"value": {
"data": "3610011803438"
}
},
{
"key": "TYPOLOGY",
"type": "CLASSIFICATION",
"value": {
"data": "FRIDGE"
}
},
{
"key": "TITLE",
"type": "COMPOSITE",
"multiValued": true,
"value": {
"data": [
{
"data": [
{
"key": "LOCAL_LANGUAGE",
"type": "SINGLE-SELECT",
"value": {
"data": "FRA"
}
},
{
"key": "LOCAL_TITLE",
"type": "SINGLE-LINE-TEXT",
"value": {
"data": "Smartphone 13 mini 5,4\"\" 5G 512 Go Double SIM Vert"
}
}
],
"id": "01KJZ2B0RYBZ8NCMVXFRTTE9VK",
"position": 0
},
{
"data": [
{
"key": "LOCAL_LANGUAGE",
"type": "SINGLE-SELECT",
"value": {
"data": "ENG"
}
},
{
"key": "LOCAL_TITLE",
"type": "SINGLE-LINE-TEXT",
"value": {
"data": "Smartphone 13 mini 5.4\"\" 5G 512GB Dual SIM Green"
}
}
],
"id": "01KJZ2B37XE4731VHS0AF8KZBN",
"position": 1
},
{
"data": [
{
"key": "LOCAL_LANGUAGE",
"type": "SINGLE-SELECT",
"value": {
"data": "DEU"
}
},
{
"key": "LOCAL_TITLE",
"type": "SINGLE-LINE-TEXT",
"value": {
"data": "Smartphone 13 mini 5.4\"\" 5G 512GB Dual SIM Groen"
}
}
],
"id": "01KJZ2B3XYZJGVD8YHTB7Z4MCS",
"position": 2
}
]
}
}
]
}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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
Update a Publication status
Request URL
Path parameters
| Parameter | Type | Description |
|---|---|---|
| publicationId | string | A publication id |
Request parameters
None
Request Body
json
{
"status": "RECEIVED"
}1
2
3
2
3
json
{
"status": "REJECTED"
}1
2
3
2
3
Request Example
bash
curl -X 'PATCH' \
'https://api.product-live.com/v1/publications/38643' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>'
-d '{
"status": "RECEIVED"
}'1
2
3
4
5
6
7
2
3
4
5
6
7
Response example
None. Only the HTTP status code informs of the completion of the call.