Generate a document

POST 
/v1/documents/generate

Generate any document. This API is designed to be used to generate GS1 labels, invoices and any document that requires external data.

Request

application/json

Body

template_id string

The template name. Required if template is not provided.

template string

The template content. Required if template_id is not provided.

doc_format string

The format of the document

doc_name string

The file name

data

object

The template data

property name* any

Default value: [object Object]

The template data

options

object

The template rendering options

property name* any

The template rendering options

Responses

201

application/json

Schema

Schema

template_id string

The template name

doc_format string

The format of the document

doc_name string

The file name

doc_file stringrequired

A base64 file content

Example (from schema)

{
  "template_id": "string",
  "doc_format": "string",
  "doc_name": "string",
  "doc_file": "string"
}

400

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

404

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

500

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

Loading...