Publications | Struct Docs

Get Product single page publication

get

Use this method to get single page publications. Fetch the publication by product, template and language.

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Product Id

languageIdinteger · int32Required

Language Id

templateExternalRefstringRequired

Template external reference

Responses

200

OK

application/octet-stream

Responseinteger · int32

get

/v1/publications/{templateExternalRef}/{id}/{languageId}

GET /v1/publications/{templateExternalRef}/{id}/{languageId} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

Get Product single page publication

post

Use this method to get single page publications. Fetch the publication by product, template, segments, language and custom values.

Authorizations

AuthorizationstringRequired

Body

TemplateExternalRefstring · nullableOptional

The external reference of the template to use for generating the PDF

LanguageIdinteger · int32Optional

The id of the language to use for the PDF generation

Idsinteger · int32[] · nullableOptional

Ids of the products to build single page PDF's for

ItemTypeinteger · enumOptional

20 = Product
30 = Variant
50 = VariantGroup

Possible values:

PageSizeinteger · enumOptional

1 = A0
2 = A1
3 = A2
4 = A3
5 = A4
6 = A5
7 = A6
8 = A7
9 = A8
10 = A9
11 = Letter
15 = A10
20 = Letter11x17

Possible values:

CatalogueUidstring · uuid · nullableOptional

Category data from catalogue

CustomValuesany · nullableOptional

Custom values to use when generating the PDF

DisableCachebooleanOptional

Set to disable cache. Cache is default enabled on all single page publications.

Responses

200

OK

application/octet-stream

Responseinteger · int32

post

/v1/publications/singlepage

POST /v1/publications/singlepage HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 297

{
  "TemplateExternalRef": "text",
  "LanguageId": 1,
  "Ids": [
    1
  ],
  "ItemType": 20,
  "PageSize": 1,
  "Segments": [
    {
      "DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
      "SegmentUid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "CatalogueUid": "123e4567-e89b-12d3-a456-426614174000",
  "CustomValues": null,
  "DisableCache": true
}

200

OK

Get Product multi page publication

post

Use this method to get multi page publications. Fetch the publication by products, template and language.

Authorizations

AuthorizationstringRequired

Body

TemplateExternalRefstring · nullableOptional

External reference of the template to use for generating the PDF

LanguageIdinteger · int32Optional

The id of the language to use for the PDF generation

Idsinteger · int32[] · nullableOptional

Ids of the products to include in the PDF

ItemTypeinteger · enumOptional

20 = Product
30 = Variant
50 = VariantGroup

Possible values:

InsertsFrontinteger · int32[] · nullableOptional

Ids of PDF files in the mediabank to use as inserts on the front of the PDF

InsertsBackinteger · int32[] · nullableOptional

Ids of PDF files in the mediabank to use as inserts on the back of the PDF

PageSizeinteger · enumOptional

1 = A0
2 = A1
3 = A2
4 = A3
5 = A4
6 = A5
7 = A6
8 = A7
9 = A8
10 = A9
11 = Letter
15 = A10
20 = Letter11x17

Possible values:

CatalogueUidstring · uuid · nullableOptional

Category data from catalogue

CustomValuesany · nullableOptional

Custom values to use when generating the PDF

Responses

200

OK

application/octet-stream

Responseinteger · int32

post

/v1/publications/multipage

POST /v1/publications/multipage HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 314

{
  "TemplateExternalRef": "text",
  "LanguageId": 1,
  "Ids": [
    1
  ],
  "ItemType": 20,
  "InsertsFront": [
    1
  ],
  "InsertsBack": [
    1
  ],
  "PageSize": 1,
  "Segments": [
    {
      "DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
      "SegmentUid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "CatalogueUid": "123e4567-e89b-12d3-a456-426614174000",
  "CustomValues": null
}

200

OK

Get Product PDF publication

post

Use this method to get pdf publications. Fetch the publication by products, template, segments and language.

Authorizations

AuthorizationstringRequired

Body

TemplateExternalRefstring · nullableOptional

External reference of the template to use for generating the PDF

LanguageIdinteger · int32Optional

The id of the language to use for the PDF generation

Idsinteger · int32[] · nullableOptional

Ids of the products to include in the PDF

ItemTypeinteger · enumOptional

20 = Product
30 = Variant
50 = VariantGroup

Possible values:

InsertsFrontinteger · int32[] · nullableOptional

Ids of PDF files in the mediabank to use as inserts on the front of the PDF

InsertsBackinteger · int32[] · nullableOptional

Ids of PDF files in the mediabank to use as inserts on the back of the PDF

PageSizeinteger · enumOptional

1 = A0
2 = A1
3 = A2
4 = A3
5 = A4
6 = A5
7 = A6
8 = A7
9 = A8
10 = A9
11 = Letter
15 = A10
20 = Letter11x17

Possible values:

CatalogueUidstring · uuid · nullableOptional

Category data from catalogue

CustomValuesany · nullableOptional

Custom values to use when generating the PDF

Responses

200

OK

application/octet-stream

Responseinteger · int32

post

/v1/publications/pdf

POST /v1/publications/pdf HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 314

{
  "TemplateExternalRef": "text",
  "LanguageId": 1,
  "Ids": [
    1
  ],
  "ItemType": 20,
  "InsertsFront": [
    1
  ],
  "InsertsBack": [
    1
  ],
  "PageSize": 1,
  "Segments": [
    {
      "DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
      "SegmentUid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "CatalogueUid": "123e4567-e89b-12d3-a456-426614174000",
  "CustomValues": null
}

200

OK

Get Product data only publication

post

Use this method to get data only publications. Fetch the publication by products, template, segments and language.

Authorizations

AuthorizationstringRequired

Body

TemplateExternalRefstring · nullableOptional

LanguageIdinteger · int32Optional

Idsinteger · int32[] · nullableOptional

ItemTypeinteger · enumOptional

20 = Product
30 = Variant
50 = VariantGroup

Possible values:

CatalogueUidstring · uuid · nullableOptional

CustomValuesany · nullableOptional

Responses

200

OK

application/octet-stream

Responseinteger · int32

post

/v1/publications/dataonly

POST /v1/publications/dataonly HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 264

{
  "TemplateExternalRef": "text",
  "LanguageId": 1,
  "Ids": [
    1
  ],
  "ItemType": 20,
  "Segments": [
    {
      "DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
      "SegmentUid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "CatalogueUid": "123e4567-e89b-12d3-a456-426614174000",
  "CustomValues": null
}

200

OK

Get configured print publications in the publication module

get

#Available from v.3.15.0 Use this endpoint to get a list of all configured print publications

Authorizations

AuthorizationstringRequired

Responses

200

OK

application/json

get

/v1/publications/prints

GET /v1/publications/prints HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Name": "text",
    "CategoryId": 1,
    "Active": true
  }
]

Get produced XML data feed from a configured print publication in the publication module

get

#Available from v.3.15.0

Authorizations

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Responses

200

OK

application/json

Responseinteger · int32

get

/v1/publications/prints/{uid}/produce

GET /v1/publications/prints/{uid}/produce HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

Enqueue Product single page publication

get

Use this method to enqueue single page publications. Enqueue the publication by product, template and language.

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Product Id

languageIdinteger · int32Required

Language Id

templateExternalRefstringRequired

Template external reference

Responses

200

OK

application/json

Responseinteger · int32

get

/v1/publications/enqueue/{templateExternalRef}/{id}/{languageId}

GET /v1/publications/enqueue/{templateExternalRef}/{id}/{languageId} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

Enqueue Product single page publication

post

Use this method to enqueue single page publications. Enqueue the publication by product, template, segments, language and custom values.

Authorizations

AuthorizationstringRequired

Body

TemplateExternalRefstring · nullableOptional

The external reference of the template to use for generating the PDF

LanguageIdinteger · int32Optional

The id of the language to use for the PDF generation

Idsinteger · int32[] · nullableOptional

Ids of the products to build single page PDF's for

ItemTypeinteger · enumOptional

20 = Product
30 = Variant
50 = VariantGroup

Possible values:

PageSizeinteger · enumOptional

1 = A0
2 = A1
3 = A2
4 = A3
5 = A4
6 = A5
7 = A6
8 = A7
9 = A8
10 = A9
11 = Letter
15 = A10
20 = Letter11x17

Possible values:

CatalogueUidstring · uuid · nullableOptional

Category data from catalogue

CustomValuesany · nullableOptional

Custom values to use when generating the PDF

DisableCachebooleanOptional

Set to disable cache. Cache is default enabled on all single page publications.

Responses

200

OK

application/json

Responsestring · uuid

post

/v1/publications/enqueue/singlepage

POST /v1/publications/enqueue/singlepage HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 297

{
  "TemplateExternalRef": "text",
  "LanguageId": 1,
  "Ids": [
    1
  ],
  "ItemType": 20,
  "PageSize": 1,
  "Segments": [
    {
      "DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
      "SegmentUid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "CatalogueUid": "123e4567-e89b-12d3-a456-426614174000",
  "CustomValues": null,
  "DisableCache": true
}

200

OK

123e4567-e89b-12d3-a456-426614174000

Enqueue Product multi page publication

post

Use this method to enqueue multi page publications. Enqueue the publication by products, template and language.

Authorizations

AuthorizationstringRequired

Body

TemplateExternalRefstring · nullableOptional

External reference of the template to use for generating the PDF

LanguageIdinteger · int32Optional

The id of the language to use for the PDF generation

Idsinteger · int32[] · nullableOptional

Ids of the products to include in the PDF

ItemTypeinteger · enumOptional

20 = Product
30 = Variant
50 = VariantGroup

Possible values:

InsertsFrontinteger · int32[] · nullableOptional

Ids of PDF files in the mediabank to use as inserts on the front of the PDF

InsertsBackinteger · int32[] · nullableOptional

Ids of PDF files in the mediabank to use as inserts on the back of the PDF

PageSizeinteger · enumOptional

1 = A0
2 = A1
3 = A2
4 = A3
5 = A4
6 = A5
7 = A6
8 = A7
9 = A8
10 = A9
11 = Letter
15 = A10
20 = Letter11x17

Possible values:

CatalogueUidstring · uuid · nullableOptional

Category data from catalogue

CustomValuesany · nullableOptional

Custom values to use when generating the PDF

Responses

200

OK

application/json

Responsestring · uuid

post

/v1/publications/enqueue/multipage

POST /v1/publications/enqueue/multipage HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 314

{
  "TemplateExternalRef": "text",
  "LanguageId": 1,
  "Ids": [
    1
  ],
  "ItemType": 20,
  "InsertsFront": [
    1
  ],
  "InsertsBack": [
    1
  ],
  "PageSize": 1,
  "Segments": [
    {
      "DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
      "SegmentUid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "CatalogueUid": "123e4567-e89b-12d3-a456-426614174000",
  "CustomValues": null
}

200

OK

123e4567-e89b-12d3-a456-426614174000

Enqueue Product PDF publication

post

Use this method to enqueue pdf publications. Enqueue the publication by products, template, segments and language.

Authorizations

AuthorizationstringRequired

Body

TemplateExternalRefstring · nullableOptional

External reference of the template to use for generating the PDF

LanguageIdinteger · int32Optional

The id of the language to use for the PDF generation

Idsinteger · int32[] · nullableOptional

Ids of the products to include in the PDF

ItemTypeinteger · enumOptional

20 = Product
30 = Variant
50 = VariantGroup

Possible values:

InsertsFrontinteger · int32[] · nullableOptional

Ids of PDF files in the mediabank to use as inserts on the front of the PDF

InsertsBackinteger · int32[] · nullableOptional

Ids of PDF files in the mediabank to use as inserts on the back of the PDF

PageSizeinteger · enumOptional

1 = A0
2 = A1
3 = A2
4 = A3
5 = A4
6 = A5
7 = A6
8 = A7
9 = A8
10 = A9
11 = Letter
15 = A10
20 = Letter11x17

Possible values:

CatalogueUidstring · uuid · nullableOptional

Category data from catalogue

CustomValuesany · nullableOptional

Custom values to use when generating the PDF

Responses

200

OK

application/json

Responsestring · uuid

post

/v1/publications/enqueue/pdf

POST /v1/publications/enqueue/pdf HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 314

{
  "TemplateExternalRef": "text",
  "LanguageId": 1,
  "Ids": [
    1
  ],
  "ItemType": 20,
  "InsertsFront": [
    1
  ],
  "InsertsBack": [
    1
  ],
  "PageSize": 1,
  "Segments": [
    {
      "DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
      "SegmentUid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "CatalogueUid": "123e4567-e89b-12d3-a456-426614174000",
  "CustomValues": null
}

200

OK

123e4567-e89b-12d3-a456-426614174000

Enqueue Product data only publication

post

Use this method to enqueue data only publications. Enqueue the publication by products, template, segments and language.

Authorizations

AuthorizationstringRequired

Body

TemplateExternalRefstring · nullableOptional

LanguageIdinteger · int32Optional

Idsinteger · int32[] · nullableOptional

ItemTypeinteger · enumOptional

20 = Product
30 = Variant
50 = VariantGroup

Possible values:

CatalogueUidstring · uuid · nullableOptional

CustomValuesany · nullableOptional

Responses

200

OK

application/json

Responsestring · uuid

post

/v1/publications/enqueue/dataonly

POST /v1/publications/enqueue/dataonly HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 264

{
  "TemplateExternalRef": "text",
  "LanguageId": 1,
  "Ids": [
    1
  ],
  "ItemType": 20,
  "Segments": [
    {
      "DimensionUid": "123e4567-e89b-12d3-a456-426614174000",
      "SegmentUid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "CatalogueUid": "123e4567-e89b-12d3-a456-426614174000",
  "CustomValues": null
}

200

OK

123e4567-e89b-12d3-a456-426614174000

Enqueue produced XML data feed from a configured print publication in the publication module

get

#Available from v.3.15.0

Authorizations

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Responses

200

OK

application/json

Responsestring · uuid

get

/v1/publications/enqueue/prints/{uid}/produce

GET /v1/publications/enqueue/prints/{uid}/produce HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

123e4567-e89b-12d3-a456-426614174000

Get publication task status

get

Use this method to get the task status of a publication.

Authorizations

AuthorizationstringRequired

Path parameters

taskGuidstring · uuidRequired

Task Id

Responses

200

OK

application/json

Responseany

get

/v1/publications/buildstatus/{taskGuid}

GET /v1/publications/buildstatus/{taskGuid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content

Get built publication

get

Use this method to get a prebuilt publication.

Authorizations

AuthorizationstringRequired

Path parameters

taskGuidstring · uuidRequired

Task Id

Responses

200

OK

No content

get

/v1/publications/buildresult/{taskGuid}

GET /v1/publications/buildresult/{taskGuid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content

hashtagGet Product single page publication

hashtagGet Product single page publication

hashtagGet Product multi page publication

hashtagGet Product PDF publication

hashtagGet Product data only publication

hashtagGet configured print publications in the publication module

hashtagGet produced XML data feed from a configured print publication in the publication module

hashtagEnqueue Product single page publication

hashtagEnqueue Product single page publication

hashtagEnqueue Product multi page publication

hashtagEnqueue Product PDF publication

hashtagEnqueue Product data only publication

hashtagEnqueue produced XML data feed from a configured print publication in the publication module

hashtagGet publication task status

hashtagGet built publication

Get Product single page publication

Get Product single page publication

Get Product multi page publication

Get Product PDF publication

Get Product data only publication

Get configured print publications in the publication module

Get produced XML data feed from a configured print publication in the publication module

Enqueue Product single page publication

Enqueue Product single page publication

Enqueue Product multi page publication

Enqueue Product PDF publication

Enqueue Product data only publication

Enqueue produced XML data feed from a configured print publication in the publication module

Get publication task status

Get built publication