#Publications
#Available from v.3.1.0 Publications support two different outputs. Publications can be used to auto-generate PDF product sheets, pricelists etc. or even complete catalogues ready for print or to generate an XML data file, which is directly importable to Adobe InDesign. Templates for the PDF's and XML structure are maintained in the publications module itself.
GET /publications/{templateExternalRef}/{id}/{languageId} Get Product single page catalogue
#Available from v.3.1.0 Use this method to get single page catalogues for a single product. Fetch the catalogue by product, template and language.
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| id | path | integer |
Item id |
| languageId | path | integer |
Language |
| templateExternalRef | path | string |
External reference for template |
Response status OK (200)
POST /publications/dataonly Get Product data only catalogue
#Available from v.3.1.0 Use this method to get data only catalogues. Fetch the catalogue by products, template and language.
{
"TemplateExternalRef": "Pricelist",
"LanguageId": 2,
"Ids": [
23001,
38532,
95398,
98324,
598435,
2385,
942,
430954
],
"ItemType": 20,
"CustomValues": {
"CutomerName": "Struct A/S",
"CustomerAddress": "Wichmandsgade 1, 5000 Odense C, Denmark"
}
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| model | body | object : DataOnlyRequestModel |
Model containing itemids, template and language |
| Property name | Data type | Description |
|---|---|---|
| TemplateExternalRef | string | |
| LanguageId | integer | |
| Ids | array | |
| ItemType | string | |
| CustomValues | object |
Response status OK (200)
POST /publications/multipage Get Product multi page catalogue
#Available from v.3.1.0 Use this method to get multi page catalogues. Fetch the catalogue by products, template and language.
{
"TemplateExternalRef": "Pricelist",
"LanguageId": 2,
"Ids": [
23001,
38532,
95398,
98324,
598435,
2385,
942,
430954
],
"ItemType": 20,
"InsertsFront": [
1265
],
"InsertsBack": [
2564
],
"PageSize": 5,
"CustomValues": {
"CutomerName": "Struct A/S",
"CustomerAddress": "Wichmandsgade 1, 5000 Odense C, Denmark",
"Expires": "2023-08-14T13:29:21.3214361+02:00"
}
}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 |
| CustomValues | object |
Custom values to use when generating the PDF |
Response status OK (200)
POST /publications/singlepage Get Product single page catalogue
#Available from v.3.1.0 Use this method to get single page catalogues. Fetch the catalogue by product, template, language and custom values.
{
"TemplateExternalRef": "productsheet",
"LanguageId": 2,
"Ids": [
23001,
38532
],
"ItemType": 20,
"PageSize": 6,
"CustomValues": {
"CutomerName": "Struct A/S",
"CustomerAddress": "Wichmandsgade 1, 5000 Odense C, Denmark"
}
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| model | body | object : SinglePageRequestModel |
Model containing itemid, template, 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 |
| CustomValues | object |
Custom values to use when generating the PDF |