# Publications
Generate publications from template setup in PIM.
GET /publications/{templateExternalRef}/{id}/{languageId} Get Product single page publication
Use this method to get single page publications. Fetch the publication by product, template and language.
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| id | path | integer |
Product Id |
| languageId | path | integer |
Language Id |
| templateExternalRef | path | string |
Template external reference |
Response status OK (200)
GET /publications/buildresult/{taskGuid} Get built publication
Use this method to get a prebuilt publication.
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| taskGuid | path | string |
Task Id |
Response status OK (200)
GET /publications/buildstatus/{taskGuid} Get publication task status
Use this method to get the task status of a publication.
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| taskGuid | path | string |
Task Id |
Response status OK (200)
POST /publications/dataonly Get Product data only publication
Use this method to get data only publications. Fetch the publication by products, template, segments and language.
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| model | body | object : DataOnlyRequestModel |
Model containing itemids, template, segments and language |
| Property name | Data type | Description |
|---|---|---|
| TemplateExternalRef | string | |
| LanguageId | integer | |
| Ids | array | |
| ItemType | string | |
| Segments | array : Segment | |
| CatalogueUid | string | |
| CustomValues | object |
| Property name | Data type | Description |
|---|---|---|
| DimensionUid | string | |
| SegmentUid | string |
Response status OK (200)
GET /publications/enqueue/{templateExternalRef}/{id}/{languageId} Enqueue Product single page publication
Use this method to enqueue single page publications. Enqueue the publication by product, template and language.
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| id | path | integer |
Product Id |
| languageId | path | integer |
Language Id |
| templateExternalRef | path | string |
Template external reference |
Response status OK (200)
POST /publications/enqueue/dataonly Enqueue Product data only publication
Use this method to enqueue data only publications. Enqueue the publication by products, template, segments and language.
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| model | body | object : DataOnlyRequestModel |
Model containing itemids, template, segments and language |
| Property name | Data type | Description |
|---|---|---|
| TemplateExternalRef | string | |
| LanguageId | integer | |
| Ids | array | |
| ItemType | string | |
| Segments | array : Segment | |
| CatalogueUid | string | |
| CustomValues | object |
| Property name | Data type | Description |
|---|---|---|
| DimensionUid | string | |
| SegmentUid | string |
Response status OK (200)
POST /publications/enqueue/multipage Enqueue Product multi page publication
Use this method to enqueue multi page publications. Enqueue the publication by products, template and language.
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| model | body | object : MultiPageRequestModel |
Model containing itemids, template and language |
| Property name | Data type | Description |
|---|---|---|
| TemplateExternalRef | string |
External reference of the template to use for generating the PDF |
| LanguageId | integer |
The id of the language to use for the PDF generation |
| Ids | array |
Ids of the products to include in the PDF |
| ItemType | string |
Set type of Ids (Product or Variant). If variant, only specified variants will be included per product. |
| InsertsFront | array |
Ids of PDF files in the mediabank to use as inserts on the front of the PDF |
| InsertsBack | array |
Ids of PDF files in the mediabank to use as inserts on the back of the PDF |
| PageSize | string |
Resize to custom page size |
| Segments | array : Segment |
The segments to use |
| CatalogueUid | string |
Category data from catalogue |
| CustomValues | object |
Custom values to use when generating the PDF |
| Property name | Data type | Description |
|---|---|---|
| DimensionUid | string | |
| SegmentUid | string |
Response status OK (200)
POST /publications/enqueue/pdf Enqueue Product PDF publication
Use this method to enqueue pdf publications. Enqueue the publication by products, template, segments and language.
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| model | body | object : MultiPageRequestModel |
Model containing itemids, template, segments and language |
| Property name | Data type | Description |
|---|---|---|
| TemplateExternalRef | string |
External reference of the template to use for generating the PDF |
| LanguageId | integer |
The id of the language to use for the PDF generation |
| Ids | array |
Ids of the products to include in the PDF |
| ItemType | string |
Set type of Ids (Product or Variant). If variant, only specified variants will be included per product. |
| InsertsFront | array |
Ids of PDF files in the mediabank to use as inserts on the front of the PDF |
| InsertsBack | array |
Ids of PDF files in the mediabank to use as inserts on the back of the PDF |
| PageSize | string |
Resize to custom page size |
| Segments | array : Segment |
The segments to use |
| CatalogueUid | string |
Category data from catalogue |
| CustomValues | object |
Custom values to use when generating the PDF |
| Property name | Data type | Description |
|---|---|---|
| DimensionUid | string | |
| SegmentUid | string |
Response status OK (200)
GET /publications/enqueue/prints/{uid}/produce Enqueue produced XML data feed from a configured print publication in the publication module
#Available from v.3.15.0
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Response status OK (200)
POST /publications/enqueue/singlepage Enqueue Product single page publication
Use this method to enqueue single page publications. Enqueue the publication by product, template, segments, language and custom values.
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| model | body | object : SinglePageRequestModel |
Model containing itemid, template, segments, language and custom values |
| Property name | Data type | Description |
|---|---|---|
| TemplateExternalRef | string |
The external reference of the template to use for generating the PDF |
| LanguageId | integer |
The id of the language to use for the PDF generation |
| Ids | array |
Ids of the products to build single page PDF's for |
| ItemType | string |
Set type of Ids (Product or Variant). If variant, only specified variants will be included per product. |
| PageSize | string |
Resize to custom page size |
| Segments | array : Segment |
The segments to use |
| CatalogueUid | string |
Category data from catalogue |
| CustomValues | object |
Custom values to use when generating the PDF |
| Property name | Data type | Description |
|---|---|---|
| DimensionUid | string | |
| SegmentUid | string |
Response status OK (200)
POST /publications/multipage Get Product multi page publication
Use this method to get multi page publications. Fetch the publication by products, template and language.
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| model | body | object : MultiPageRequestModel |
Model containing itemids, template and language |
| Property name | Data type | Description |
|---|---|---|
| TemplateExternalRef | string |
External reference of the template to use for generating the PDF |
| LanguageId | integer |
The id of the language to use for the PDF generation |
| Ids | array |
Ids of the products to include in the PDF |
| ItemType | string |
Set type of Ids (Product or Variant). If variant, only specified variants will be included per product. |
| InsertsFront | array |
Ids of PDF files in the mediabank to use as inserts on the front of the PDF |
| InsertsBack | array |
Ids of PDF files in the mediabank to use as inserts on the back of the PDF |
| PageSize | string |
Resize to custom page size |
| Segments | array : Segment |
The segments to use |
| CatalogueUid | string |
Category data from catalogue |
| CustomValues | object |
Custom values to use when generating the PDF |
| Property name | Data type | Description |
|---|---|---|
| DimensionUid | string | |
| SegmentUid | string |
Response status OK (200)
POST /publications/pdf Get Product PDF publication
Use this method to get pdf publications. Fetch the publication by products, template, segments and language.
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| model | body | object : MultiPageRequestModel |
Model containing itemids, template, segments and language |
| Property name | Data type | Description |
|---|---|---|
| TemplateExternalRef | string |
External reference of the template to use for generating the PDF |
| LanguageId | integer |
The id of the language to use for the PDF generation |
| Ids | array |
Ids of the products to include in the PDF |
| ItemType | string |
Set type of Ids (Product or Variant). If variant, only specified variants will be included per product. |
| InsertsFront | array |
Ids of PDF files in the mediabank to use as inserts on the front of the PDF |
| InsertsBack | array |
Ids of PDF files in the mediabank to use as inserts on the back of the PDF |
| PageSize | string |
Resize to custom page size |
| Segments | array : Segment |
The segments to use |
| CatalogueUid | string |
Category data from catalogue |
| CustomValues | object |
Custom values to use when generating the PDF |
| Property name | Data type | Description |
|---|---|---|
| DimensionUid | string | |
| SegmentUid | string |
Response status OK (200)
GET /publications/prints Get configured print publications in the publication module
#Available from v.3.15.0 Use this endpoint to get a list of all configured print publications
[
{
"Uid": "0a9a9ff1-7333-4a07-b53a-14359f3dec4b",
"Name": "Spring catalogue (English)",
"CategoryId": 0,
"Active": true
},
{
"Uid": "d4d3c6ea-c061-474e-8a0f-83c41a982e30",
"Name": "Week 42 catalogue (Danish)",
"CategoryId": 0,
"Active": true
},
{
"Uid": "ff3efa6a-5951-488f-82f4-d0d6602f1753",
"Name": "Week 42 catalogue (English)",
"CategoryId": 0,
"Active": true
}
]Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Gets or sets the unique identifier of the print publication. |
| Name | string |
Gets or sets the name of the print publication. |
| CategoryId | integer |
Gets or sets the category of the print publication. |
| Active | boolean |
Gets or sets a value indicating whether the print publication is active. |
GET /publications/prints/{uid}/produce Get produced XML data feed from a configured print publication in the publication module
#Available from v.3.15.0
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Response status OK (200)
POST /publications/singlepage Get Product single page publication
Use this method to get single page publications. Fetch the publication by product, template, segments, language and custom values.
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| model | body | object : SinglePageRequestModel |
Model containing itemid, template, segments, language and custom values |
| Property name | Data type | Description |
|---|---|---|
| TemplateExternalRef | string |
The external reference of the template to use for generating the PDF |
| LanguageId | integer |
The id of the language to use for the PDF generation |
| Ids | array |
Ids of the products to build single page PDF's for |
| ItemType | string |
Set type of Ids (Product or Variant). If variant, only specified variants will be included per product. |
| PageSize | string |
Resize to custom page size |
| Segments | array : Segment |
The segments to use |
| CatalogueUid | string |
Category data from catalogue |
| CustomValues | object |
Custom values to use when generating the PDF |
| Property name | Data type | Description |
|---|---|---|
| DimensionUid | string | |
| SegmentUid | string |