Products

Product objects describe goods that can be purchased by customers. In difference to tickets they are usually not directly linked to an event. Using Product Streams predefined combinations can be offered during a shopping experience.

Endpoints

Create a Product

Payload

name

Required

string

The name of the product

type

Required

string

The type of the product

voucherproductdonation

Optional Attributes

Collapse all

description

Optional

string

The description of the product

image

Optional

string

The image of the product

variants

Optional

array

variants[].taxable

Required

boolean

Whether the product is taxable or not

Optional Attributes

Collapse all

variants[].price

Optional

number float

The price of the product

variants[].priceType

Optional

string

fixedrange

variants[].priceRange

Optional

object

Optional Attributes

Collapse all

variants[].priceRange.min

Optional

number float

The minimum price of the product

variants[].priceRange.max

Optional

number float

The maximum price of the product

variants[].taxRate

Optional

number float

The tax rate of the product

variants[].compareAtPrice

Optional

number float

The recommended retail price to compare with the actual price.

variants[].taxServiceTypeId

Optional

string

The ID of the tax service of the product

voucherSettings

Optional

object

If the product is of type voucher

Optional Attributes

Collapse all

voucherSettings.limitedValidityPeriod

Optional

boolean

Whether the voucher should expire

voucherSettings.validityConfig

Optional

object

Optional Attributes

Collapse all

voucherSettings.validityConfig.amount

Optional

number float

voucherSettings.validityConfig.type

Optional

number float

voucherSettings.validityConfig.untilEndOfPeriod

Optional

boolean

voucherSettings.pdfImage

Optional

string

A marketing image printed onto voucher pdf

voucherSettings.disclaimer

Optional

string

A disclaimer text printed onto voucher pdf

voucherSettings.documentTemplateSettings

Optional

object

Optional Attributes

Collapse all

voucherSettings.documentTemplateSettings.templates

Optional

array

voucherSettings.documentTemplateSettings.templates[].templateId

Required

string

The ID of the document template

voucherSettings.documentTemplateSettings.templates[].format

Required

string

The format of document template for the dimensions.

A4LETTERLEGALBOARDING-PASSPLASTIC-CARDCARDLABELCUSTOMAPPLEGOOGLE

voucherSettings.documentTemplateSettings.templates[].target

Required

string

The target of document template for which targets it should be used.

thermaldigitalwallet

voucherSettings.documentTemplateSettings.templates[].type

Required

string

The type of document template for which document it should be used. ticket = The document template will be used on tickets. invoice = The document template will be used on invoices.

ticketinvoicevouchermember-cardheader-card

active

Optional

boolean

Whether the product is active and can be distributed

Get a Product

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "_id": "string",
  "name": "string",
  "active": true,
  "isFulfillable": true,
  "type": "voucher",
  "image": "string",
  "description": "string",
  "variants": [
    {
      "_id": "string",
      "priceType": "fixed",
      "price": 10.5,
      "priceRange": {
        "min": 10.5,
        "max": 10.5
      },
      "taxable": true,
      "taxRate": 10.5,
      "compareAtPrice": 10.5,
      "taxServiceTypeId": "string"
    }
  ],
  "voucherSettings": {
    "limitedValidityPeriod": true,
    "validityConfig": {
      "amount": 10.5,
      "type": 10.5,
      "untilEndOfPeriod": true
    },
    "pdfImage": "string",
    "disclaimer": "string",
    "documentTemplateSettings": {
      "templates": [
        {
          "templateId": "string",
          "format": "A4",
          "target": "thermal",
          "type": "ticket"
        }
      ]
    }
  },
  "sellerId": "string",
  "meta": {},
  "localization": {},
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Update a Product

Payload

name

Required

string

The name of the product

type

Required

string

The type of the product

voucherproductdonation

Optional Attributes

Collapse all

description

Optional

string

The description of the product

image

Optional

string

The image of the product

variants

Optional

array

variants[]._id

Required

string

The ID of the product variant of the product

variants[].taxable

Required

boolean

Whether the product is taxable or not

Optional Attributes

Collapse all

variants[].price

Optional

number float

The price of the product

variants[].priceType

Optional

string

fixedrange

variants[].priceRange

Optional

object

Optional Attributes

Collapse all

variants[].priceRange.min

Optional

number float

The minimum price of the product

variants[].priceRange.max

Optional

number float

The maximum price of the product

variants[].taxRate

Optional

number float

The tax rate of the product

variants[].compareAtPrice

Optional

number float

The recommended retail price to compare with the actual price.

variants[].taxServiceTypeId

Optional

string

The ID of the tax service of the product

voucherSettings

Optional

object

If the product is of type voucher

Optional Attributes

Collapse all

voucherSettings.limitedValidityPeriod

Optional

boolean

Whether the voucher should expire

voucherSettings.validityConfig

Optional

object

Optional Attributes

Collapse all

voucherSettings.validityConfig.amount

Optional

number float

voucherSettings.validityConfig.type

Optional

number float

voucherSettings.validityConfig.untilEndOfPeriod

Optional

boolean

voucherSettings.pdfImage

Optional

string

A marketing image printed onto voucher pdf

voucherSettings.disclaimer

Optional

string

A disclaimer text printed onto voucher pdf

voucherSettings.documentTemplateSettings

Optional

object

Optional Attributes

Collapse all

voucherSettings.documentTemplateSettings.templates

Optional

array

voucherSettings.documentTemplateSettings.templates[].templateId

Required

string

The ID of the document template

voucherSettings.documentTemplateSettings.templates[].format

Required

string

The format of document template for the dimensions.

A4LETTERLEGALBOARDING-PASSPLASTIC-CARDCARDLABELCUSTOMAPPLEGOOGLE

voucherSettings.documentTemplateSettings.templates[].target

Required

string

The target of document template for which targets it should be used.

thermaldigitalwallet

voucherSettings.documentTemplateSettings.templates[].type

Required

string

The type of document template for which document it should be used. ticket = The document template will be used on tickets. invoice = The document template will be used on invoices.

ticketinvoicevouchermember-cardheader-card

active

Optional

boolean

Whether the product is active and can be distributed

Delete a Product

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "_id": "string",
  "name": "string",
  "active": true,
  "isFulfillable": true,
  "type": "voucher",
  "image": "string",
  "description": "string",
  "variants": [
    {
      "_id": "string",
      "priceType": "fixed",
      "price": 10.5,
      "priceRange": {
        "min": 10.5,
        "max": 10.5
      },
      "taxable": true,
      "taxRate": 10.5,
      "compareAtPrice": 10.5,
      "taxServiceTypeId": "string"
    }
  ],
  "voucherSettings": {
    "limitedValidityPeriod": true,
    "validityConfig": {
      "amount": 10.5,
      "type": 10.5,
      "untilEndOfPeriod": true
    },
    "pdfImage": "string",
    "disclaimer": "string",
    "documentTemplateSettings": {
      "templates": [
        {
          "templateId": "string",
          "format": "A4",
          "target": "thermal",
          "type": "ticket"
        }
      ]
    }
  },
  "sellerId": "string",
  "meta": {},
  "localization": {},
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get all Products

Query

top

Optional

number float

A limit on the number of objects to be returned. Can range between 1 and 1000.

skip

Optional

number float

The number of objects to skip for the requested result

name

Optional

string

The name of the product

type

Optional

string

The type of the product

voucherproductdonation

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "docs": [
    {
      "_id": "string",
      "name": "string",
      "active": true,
      "isFulfillable": true,
      "type": "voucher",
      "image": "string",
      "description": "string",
      "variants": [
        {
          "_id": "string",
          "priceType": "fixed",
          "price": 10.5,
          "priceRange": {
            "min": 10.5,
            "max": 10.5
          },
          "taxable": true,
          "taxRate": 10.5,
          "compareAtPrice": 10.5,
          "taxServiceTypeId": "string"
        }
      ],
      "voucherSettings": {
        "limitedValidityPeriod": true,
        "validityConfig": {
          "amount": 10.5,
          "type": 10.5,
          "untilEndOfPeriod": true
        },
        "pdfImage": "string",
        "disclaimer": "string",
        "documentTemplateSettings": {
          "templates": [
            {
              "templateId": "string",
              "format": "A4",
              "target": "thermal",
              "type": "ticket"
            }
          ]
        }
      },
      "sellerId": "string",
      "meta": {},
      "localization": {},
      "createdAt": "2030-01-23T23:00:00.123Z",
      "updatedAt": "2030-01-23T23:00:00.123Z"
    }
  ],
  "total": 1
}

Create a Product Stream

Payload

name

Required

string

The name of the product stream.

Optional Attributes

Collapse all

active

Optional

boolean

Whether the product stream is active or not.

products

Optional

array<string>

The products in the product stream.

201

Created

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "name": "string",
  "active": true,
  "products": []
}

{
  "_id": "string",
  "name": "string",
  "sellerId": "string",
  "products": [],
  "active": true,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get a Product Stream

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "_id": "string",
  "name": "string",
  "sellerId": "string",
  "products": [],
  "active": true,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Update a Product Stream

Payload

name

Required

string

The name of the product stream.

Optional Attributes

Collapse all

active

Optional

boolean

Whether the product stream is active or not.

products

Optional

array<string>

The products in the product stream.

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "name": "string",
  "active": true,
  "products": []
}

{
  "_id": "string",
  "name": "string",
  "sellerId": "string",
  "products": [],
  "active": true,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Delete a Product Stream

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "_id": "string",
  "name": "string",
  "sellerId": "string",
  "products": [],
  "active": true,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get all Product Streams

Query

top

Optional

number float

A limit on the number of objects to be returned. Can range between 1 and 1000.

skip

Optional

number float

The number of objects to skip for the requested result

name

Optional

string

The name of the product stream

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "docs": [
    {
      "_id": "string",
      "name": "string",
      "sellerId": "string",
      "products": [],
      "active": true,
      "createdAt": "2030-01-23T23:00:00.123Z",
      "updatedAt": "2030-01-23T23:00:00.123Z"
    }
  ],
  "total": 1
}

PUBLIC

Get a Product Stream's Products

Query

No supported query parameters

200

400

Bad Request

404

Not Found

Was this section helpful?

Yes No

[
  {
    "_id": "string",
    "name": "string",
    "active": true,
    "isFulfillable": true,
    "type": "voucher",
    "image": "string",
    "description": "string",
    "variants": [
      {
        "_id": "string",
        "priceType": "fixed",
        "price": 10.5,
        "priceRange": {
          "min": 10.5,
          "max": 10.5
        },
        "taxable": true,
        "taxRate": 10.5,
        "compareAtPrice": 10.5,
        "taxServiceTypeId": "string"
      }
    ],
    "voucherSettings": {
      "limitedValidityPeriod": true,
      "validityConfig": {
        "amount": 10.5,
        "type": 10.5,
        "untilEndOfPeriod": true
      },
      "pdfImage": "string",
      "disclaimer": "string",
      "documentTemplateSettings": {
        "templates": [
          {
            "templateId": "string",
            "format": "A4",
            "target": "thermal",
            "type": "ticket"
          }
        ]
      }
    },
    "sellerId": "string",
    "meta": {},
    "localization": {},
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z"
  }
]