Operations

• PUB salesOrder.created

  Inform about a new sales order

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a new sales order

  salesOrderId

  required

  integer

  Unique identifier for the order

  createdAt

  required

  string

  format: date-time

  Order creation date and time

  Examples

  Payload

  {
    "salesOrderId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB salesOrder.sent

  Inform about a sales order sent

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a sales order sent

  salesOrderId

  required

  integer

  Unique identifier for the order

  updatedAt

  required

  string

  format: date-time

  Order sent date and time

  Examples

  Payload

  {
    "salesOrderId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB salesOrder.updated

  Inform about a sales order updated

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a sales order updated

  salesOrderId

  required

  integer

  Unique identifier for the order

  updatedAt

  required

  string

  format: date-time

  Order update date and time

  Examples

  Payload

  {
    "salesOrderId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB salesOrder.imported

  Inform about a sales order imported

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a sales order imported

  salesOrderId

  required

  integer

  Unique identifier for the order

  updatedAt

  required

  string

  format: date-time

  Order Imported date and time

  Examples

  Payload

  {
    "salesOrderId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB salesOrder.released

  Inform about a sales order released

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a sales order release

  salesOrderId

  required

  integer

  Unique identifier for the order

  updatedAt

  required

  string

  format: date-time

  Order released date and time

  Examples

  Payload

  {
    "salesOrderId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB salesOrder.dispatched

  Inform about a sales order dispatched

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a sales order dispatched

  salesOrderId

  required

  integer

  Unique identifier for the order

  updatedAt

  required

  string

  format: date-time

  Order dispatch date and time

  Examples

  Payload

  {
    "salesOrderId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB salesOrder.autoshipmentProcessed

  Inform about a sales order auto shipment processed

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a sales order auto shipment processed

  salesOrderId

  required

  integer

  Unique identifier for the order

  updatedAt

  required

  string

  format: date-time

  Order auto shipment date and time

  Examples

  Payload

  {
    "salesOrderId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB salesOrder.archived

  Inform about a sales order archived

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a sales order archived

  salesOrderId

  required

  integer

  Unique identifier for the order

  updatedAt

  required

  string

  format: date-time

  Order archive date and time

  Examples

  Payload

  {
    "salesOrderId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB salesOrder.protocolCreated

  Inform about a sales order protocol

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a sales order protocol

  salesOrderProtocolId

  required

  integer

  Unique identifier for the order protocol

  salesOrderId

  required

  integer

  Unique identifier for the order

  createdAt

  required

  string

  format: date-time

  Order protocol date and time

  Examples

  Payload

  {
    "salesOrderProtocolId": 0,
    "salesOrderId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB user.changedPage

  Triggered when the user visits a new page

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Triggered when the user visits a new page

  userId

  required

  integer

  Unique identifier for the user

  mainVal

  required

  string

  Main tracking value which is typically the module or the main route

  secondVal

  required

  string

  Secondary tracking value which is typically a combination query parameters or some nested route

  createdAt

  required

  string

  format: date-time

  Date and time of the login operation

  Examples

  Payload

  {
    "userId": 0,
    "mainVal": "string",
    "secondVal": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB user.loggedIn

  Inform about a successful login operation of a user

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a successful login operation of a user

  userId

  required

  integer

  Unique identifier for the user

  mainVal

  required

  string

  Main tracking value which is in this case a constant with value 'login'

  secondVal

  required

  string

  Secondary tracking value which is in this an empty string

  createdAt

  required

  string

  format: date-time

  Date and time of the login operation

  Examples

  Payload

  {
    "userId": 0,
    "mainVal": "string",
    "secondVal": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB user.loggedOut

  Inform about a logout operation of a user

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a logout operation of a user

  userId

  required

  integer

  Unique identifier for the user

  mainVal

  required

  string

  Main tracking value which is in this case a constant with value 'logout'

  secondVal

  required

  string

  Secondary tracking value which is in this an empty string

  createdAt

  required

  string

  format: date-time

  Date and time of the login operation

  Examples

  Payload

  {
    "userId": 0,
    "mainVal": "string",
    "secondVal": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB product.created

  Inform about a new product

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a new product

  id

  required

  integer

  Unique identifier for the product

  number

  required

  string

  number of the product

  name

  string

  description

  string | null

  customsTariffNumber

  string

  ean

  string

  project

  Expand all

  object

  id

  integer

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": 0,
    "number": "string",
    "name": "string",
    "description": "string",
    "customsTariffNumber": "string",
    "ean": "string",
    "project": {
      "id": 0
    }
  }
  

  This example has been generated automatically.

• PUB product.updated

  Inform about an updated product

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about an updated product

  id

  required

  integer

  Unique identifier for the product

  number

  required

  string

  number of the product

  name

  string

  description

  string | null

  customsTariffNumber

  string

  ean

  string

  project

  Expand all

  object

  id

  integer

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": 0,
    "number": "string",
    "name": "string",
    "description": "string",
    "customsTariffNumber": "string",
    "ean": "string",
    "project": {
      "id": 0
    }
  }
  

  This example has been generated automatically.

• PUB product.deleted

  Inform about a deleted product

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a deleted product

  id

  required

  integer

  Unique identifier of the product

  Examples

  Payload

  {
    "id": 0
  }
  

  This example has been generated automatically.

• PUB product.propertiesCreated

  Inform about a new product property

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about new product properties

  id

  required

  integer

  Unique identifier for the product

  properties

  Expand all

  required

  array<object>

  object

  id

  integer

  name

  string

  value

  string | null

  unit

  string | null

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "id": 0,
    "properties": [
      {
        "id": 0,
        "name": "string",
        "value": "string",
        "unit": "string"
      }
    ]
  }
  

  This example has been generated automatically.

• PUB product.propertiesUpdated

  Inform about an updated product property

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about updated product properties

  id

  required

  integer

  Unique identifier for the product

  properties

  Expand all

  required

  array<object>

  object

  id

  integer

  name

  string

  value

  string

  unit

  string | null

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "id": 0,
    "properties": [
      {
        "id": 0,
        "name": "string",
        "value": "string",
        "unit": "string"
      }
    ]
  }
  

  This example has been generated automatically.

• PUB product.propertiesDeleted

  Inform about a deleted product property

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about deleted product properties

  id

  required

  integer

  Unique identifier for the product id

  properties

  Expand all

  required

  array<object>

  object

  id

  integer

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "id": 0,
    "properties": [
      {
        "id": 0
      }
    ]
  }
  

  This example has been generated automatically.

• PUB product.tagsReplaced

  Inform about product tags replacement

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Information about replaced product tags

  id

  required

  integer

  Unique Product ID

  tags

  Expand all

  required

  array<object>

  object

  id

  required

  integer

  Unique Tag ID

  name

  required

  string

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": 0,
    "tags": [
      {
        "id": 0,
        "name": "string"
      }
    ]
  }
  

  This example has been generated automatically.

• PUB product.variantCreated

  Inform about a product variant creation

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a new product variant

  id

  required

  integer

  Unique identifier for the product variant

  variantOf

  required

  integer

  Unique identifier of the variant's base product

  number

  string

  Number of the product variant

  additionalSupplierDesignation

  string | null

  Additional designation which should be appended to supplier's description

  Examples

  Payload

  {
    "id": 0,
    "variantOf": 0,
    "number": "string",
    "additionalSupplierDesignation": "string"
  }
  

  This example has been generated automatically.

• PUB salesPrice.created

  Inform about new SalesPrice

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about new SalesPrice

  id

  required

  integer

  ID

  product

  Expand all

  required

  object

  id

  required

  integer

  Additional properties are NOT allowed.

  customer

  Expand all

  object | null

  id

  required

  integer

  Additional properties are NOT allowed.

  customerGroup

  Expand all

  object | null

  id

  required

  integer

  Additional properties are NOT allowed.

  amount

  number

  format: float

  units

  number

  format: float

  price

  Expand all

  object

  amount

  required

  number

  format: float

  currency

  required

  string

  must match: [A-Z]{3}

  Additional properties are NOT allowed.

  validFrom

  string | null

  format: date

  expiresAt

  string | null

  format: date

  Examples

  Payload

  {
    "id": 0,
    "product": {
      "id": 0
    },
    "customer": {
      "id": 0
    },
    "customerGroup": {
      "id": 0
    },
    "amount": 0.1,
    "units": 0.1,
    "price": {
      "amount": 0.1,
      "currency": "string"
    },
    "validFrom": "2019-08-24",
    "expiresAt": "2019-08-24"
  }
  

  This example has been generated automatically.

• PUB salesPrice.updated

  Inform about updated SalesPrice

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about updated SalesPrice

  id

  required

  integer

  ID

  product

  Expand all

  required

  object

  id

  required

  integer

  Additional properties are NOT allowed.

  customer

  Expand all

  object | null

  id

  required

  integer

  Additional properties are NOT allowed.

  customerGroup

  Expand all

  object | null

  id

  required

  integer

  Additional properties are NOT allowed.

  amount

  number

  format: float

  units

  number

  format: float

  price

  Expand all

  object

  amount

  required

  number

  format: float

  currency

  required

  string

  must match: [A-Z]{3}

  Additional properties are NOT allowed.

  validFrom

  string | null

  format: date

  expiresAt

  string | null

  format: date

  Examples

  Payload

  {
    "id": 0,
    "product": {
      "id": 0
    },
    "customer": {
      "id": 0
    },
    "customerGroup": {
      "id": 0
    },
    "amount": 0.1,
    "units": 0.1,
    "price": {
      "amount": 0.1,
      "currency": "string"
    },
    "validFrom": "2019-08-24",
    "expiresAt": "2019-08-24"
  }
  

  This example has been generated automatically.

• PUB salesPrice.deleted

  Inform about removal of SalesPrice

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about removal of SalesPrice

  id

  required

  integer

  ID

  Examples

  Payload

  {
    "id": 0
  }
  

  This example has been generated automatically.

• PUB purchasePrice.created

  Inform about a new purchase price

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a new purchase price

  id

  required

  integer

  Unique identifier for the purchase price

  product

  Expand all

  required

  object

  id

  required

  integer

  Additional properties are NOT allowed.

  supplier

  Expand all

  required

  object

  id

  required

  integer

  Additional properties are NOT allowed.

  isStandardSupplier

  boolean

  supplierDesignation

  string

  supplierItemNumber

  string

  fromQuantity

  required

  number

  format: float

  packageAmount

  number | null

  format: float

  price

  Expand all

  required

  object

  amount

  required

  number

  format: float

  currency

  required

  string

  Additional properties are NOT allowed.

  validFrom

  required

  string | null

  expiresAt

  required

  string | null

  Examples

  Payload

  {
    "id": 0,
    "product": {
      "id": 0
    },
    "supplier": {
      "id": 0
    },
    "isStandardSupplier": true,
    "supplierDesignation": "string",
    "supplierItemNumber": "string",
    "fromQuantity": 0.1,
    "packageAmount": 0,
    "price": {
      "amount": 0.1,
      "currency": "string"
    },
    "validFrom": "string",
    "expiresAt": "string"
  }
  

  This example has been generated automatically.

• PUB purchasePrice.updated

  Inform about purchase price updated

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about an updated purchase price

  id

  required

  integer

  Unique identifier for the purchase price

  product

  Expand all

  required

  object

  id

  required

  integer

  Additional properties are NOT allowed.

  supplier

  Expand all

  required

  object

  id

  required

  integer

  Additional properties are NOT allowed.

  isStandardSupplier

  boolean

  supplierDesignation

  string

  supplierItemNumber

  string

  fromQuantity

  required

  number

  format: float

  packageAmount

  number | null

  format: float

  price

  Expand all

  required

  object

  amount

  required

  number

  format: float

  currency

  required

  string

  Additional properties are NOT allowed.

  validFrom

  required

  string | null

  expiresAt

  required

  string | null

  Examples

  Payload

  {
    "id": 0,
    "product": {
      "id": 0
    },
    "supplier": {
      "id": 0
    },
    "isStandardSupplier": true,
    "supplierDesignation": "string",
    "supplierItemNumber": "string",
    "fromQuantity": 0.1,
    "packageAmount": 0,
    "price": {
      "amount": 0.1,
      "currency": "string"
    },
    "validFrom": "string",
    "expiresAt": "string"
  }
  

  This example has been generated automatically.

• PUB purchasePrice.deleted

  Inform about purchase price deleted

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a deleted purchase price

  id

  required

  integer

  Unique identifier of the purchase price

  Examples

  Payload

  {
    "id": 0
  }
  

  This example has been generated automatically.

• PUB productCategory.created

  Inform about a new product category

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a new product category

  id

  required

  integer

  Unique identifier for the product category

  parentId

  required

  integer | null

  Unique identifier for the product category parent category

  Examples

  Payload

  {
    "id": 0,
    "parentId": 0
  }
  

  This example has been generated automatically.

• PUB productCategory.updated

  Inform about an update of a product category

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about an update of a product category

  id

  required

  integer

  Unique identifier for the product category

  parentId

  required

  integer | null

  Unique identifier for the product category parent category

  Examples

  Payload

  {
    "id": 0,
    "parentId": 0
  }
  

  This example has been generated automatically.

• PUB productCategory.deleted

  Inform about a deletion of a product category

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a deletion of a product category

  id

  required

  integer

  Unique identifier for the product category

  parentId

  required

  integer | null

  Unique identifier for the product category parent category

  Examples

  Payload

  {
    "id": 0,
    "parentId": 0
  }
  

  This example has been generated automatically.

• PUB purchaseOrder.created

  Inform about a purchase order created

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a purchase order creation

  purchaseOrderId

  required

  integer

  Unique identifier for the purchase order

  createdAt

  required

  string

  format: date-time

  Purchase order created date and time

  Examples

  Payload

  {
    "purchaseOrderId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB purchaseOrder.sent

  Inform about a purchase order sent

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a purchase order sent

  purchaseOrderId

  required

  integer

  Unique identifier for the purchase order

  updatedAt

  required

  string

  format: date-time

  Purchase order sent date and time

  Examples

  Payload

  {
    "purchaseOrderId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB purchaseOrder.updated

  Inform about a purchase order updated

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a purchase order update

  purchaseOrderId

  required

  integer

  Unique identifier for the purchase order

  updatedAt

  required

  string

  format: date-time

  Purchase order update date and time

  Examples

  Payload

  {
    "purchaseOrderId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB purchaseOrder.released

  Inform about a purchase order released

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a purchase order released

  purchaseOrderId

  required

  integer

  Unique identifier for the purchase order

  updatedAt

  required

  string

  format: date-time

  Purchase order release date and time

  Examples

  Payload

  {
    "purchaseOrderId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB purchaseOrder.archived

  Inform about a purchase order archived

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a purchase order archived

  purchaseOrderId

  required

  integer

  Unique identifier for the purchase order

  updatedAt

  required

  string

  format: date-time

  Purchase order archived date and time

  Examples

  Payload

  {
    "purchaseOrderId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB purchaseOrder.canceled

  Inform about a purchase order canceled

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a purchase order cancellation

  purchaseOrderId

  required

  integer

  Unique identifier for the purchase order

  updatedAt

  required

  string

  format: date-time

  Purchase order Canceled date and time

  Examples

  Payload

  {
    "purchaseOrderId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB purchaseOrder.deleted

  Inform about a purchase order deleted

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a purchase order deleted

  purchaseOrderId

  required

  integer

  Unique identifier for the purchase order

  updatedAt

  required

  string

  format: date-time

  Purchase order Deleted date and time

  Examples

  Payload

  {
    "purchaseOrderId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB purchaseOrder.protocolCreated

  Inform about a purchase order protocol created

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about an purchase order protocol created

  purchaseOrderProtocolId

  required

  integer

  Unique identifier for the purchase order protocol

  purchaseOrderId

  required

  integer

  Unique identifier for the purchase order

  createdAt

  required

  string

  format: date-time

  Purchase order created date and time

  Examples

  Payload

  {
    "purchaseOrderProtocolId": 0,
    "purchaseOrderId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB return.created

  Inform about a return created

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a return creation

  returnId

  required

  integer

  Unique identifier for the return

  createdAt

  required

  string

  format: date-time

  Return created date and time

  Examples

  Payload

  {
    "returnId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB return.sent

  Inform about a return sent

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a return sent

  returnId

  required

  integer

  Unique identifier for the return

  updatedAt

  required

  string

  format: date-time

  Return sent date and time

  Examples

  Payload

  {
    "returnId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB return.updated

  Inform about a return updated

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a return update

  returnId

  required

  integer

  Unique identifier for the return

  updatedAt

  required

  string

  format: date-time

  Return update date and time

  Examples

  Payload

  {
    "returnId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB return.released

  Inform about a return released

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a return released

  returnId

  required

  integer

  Unique identifier for the return

  updatedAt

  required

  string

  format: date-time

  Return release date and time

  Examples

  Payload

  {
    "returnId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB return.archived

  Inform about a return archived

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a return archived

  returnId

  required

  integer

  Unique identifier for the return

  updatedAt

  required

  string

  format: date-time

  Return archived date and time

  Examples

  Payload

  {
    "returnId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB return.canceled

  Inform about a return canceled

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a return canceled

  returnId

  required

  integer

  Unique identifier for the return

  updatedAt

  required

  string

  format: date-time

  Return canceled date and time

  Examples

  Payload

  {
    "returnId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB return.deleted

  Inform about a return deleted

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a return deleted

  returnId

  required

  integer

  Unique identifier for the return

  updatedAt

  required

  string

  format: date-time

  Return deleted date and time

  Examples

  Payload

  {
    "returnId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB return.protocolCreated

  Inform about an return protocol created

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about an return protocol created

  returnProtocolId

  required

  integer

  Unique identifier for the return protocol

  returnId

  required

  integer

  Unique identifier for the return

  createdAt

  required

  string

  format: date-time

  Return created date and time

  Examples

  Payload

  {
    "returnProtocolId": 0,
    "returnId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB deliveryNote.created

  Inform about a delivery note created

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a delivery note creation

  deliveryNoteId

  required

  integer

  Unique identifier for the delivery note

  createdAt

  required

  string

  format: date-time

  Delivery note created date and time

  Examples

  Payload

  {
    "deliveryNoteId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB deliveryNote.sent

  Inform about a delivery note sent

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a delivery note sent

  deliveryNoteId

  required

  integer

  Unique identifier for the delivery note

  updatedAt

  required

  string

  format: date-time

  Delivery note sent date and time

  Examples

  Payload

  {
    "deliveryNoteId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB deliveryNote.updated

  Inform about a delivery note updated

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a delivery note updated

  deliveryNoteId

  required

  integer

  Unique identifier for the delivery note

  updatedAt

  required

  string

  format: date-time

  Delivery note updated date and time

  Examples

  Payload

  {
    "deliveryNoteId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB deliveryNote.released

  Inform about a delivery note released

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a delivery note released

  deliveryNoteId

  required

  integer

  Unique identifier for the delivery note

  updatedAt

  required

  string

  format: date-time

  Delivery note release date and time

  Examples

  Payload

  {
    "deliveryNoteId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB deliveryNote.archived

  Inform about a delivery note archived

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a delivery note archived

  deliveryNoteId

  required

  integer

  Unique identifier for the delivery note

  updatedAt

  required

  string

  format: date-time

  Delivery note archived date and time

  Examples

  Payload

  {
    "deliveryNoteId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB deliveryNote.canceled

  Inform about a delivery note canceled

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a delivery note canceled

  deliveryNoteId

  required

  integer

  Unique identifier for the delivery note

  updatedAt

  required

  string

  format: date-time

  Delivery note canceled date and time

  Examples

  Payload

  {
    "deliveryNoteId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB deliveryNote.deleted

  Inform about a delivery note deleted

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a delivery note deleted

  deliveryNoteId

  required

  integer

  Unique identifier for the delivery note

  updatedAt

  required

  string

  format: date-time

  Delivery note deleted date and time

  Examples

  Payload

  {
    "deliveryNoteId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB deliveryNote.protocolCreated

  Inform about an delivery note protocol created

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about an delivery note protocol created

  deliveryNoteProtocolId

  required

  integer

  Unique identifier for the delivery note protocol

  deliveryNoteId

  required

  integer

  Unique identifier for the delivery note

  createdAt

  required

  string

  format: date-time

  Delivery note created date and time

  Examples

  Payload

  {
    "deliveryNoteProtocolId": 0,
    "deliveryNoteId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB proformaInvoice.created

  Inform about a proforma invoice created

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a new proforma invoice

  proformaInvoiceId

  required

  integer

  Unique identifier for the proforma invoice

  createdAt

  required

  string

  format: date-time

  Proforma invoice creation date and time

  Examples

  Payload

  {
    "proformaInvoiceId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB proformaInvoice.sent

  Inform about a proforma invoice sent

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a proforma invoice sent

  proformaInvoiceId

  required

  integer

  Unique identifier for the proforma invoice

  updatedAt

  required

  string

  format: date-time

  Proforma invoice sent date and time

  Examples

  Payload

  {
    "proformaInvoiceId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB proformaInvoice.updated

  Inform about a proforma invoice updated

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a proforma invoice updated

  proformaInvoiceId

  required

  integer

  Unique identifier for the proforma invoice

  updatedAt

  required

  string

  format: date-time

  Proforma invoice update date and time

  Examples

  Payload

  {
    "proformaInvoiceId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB proformaInvoice.released

  Inform about a proforma invoice released

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a proforma invoice release

  proformaInvoiceId

  required

  integer

  Unique identifier for the proforma invoice

  updatedAt

  required

  string

  format: date-time

  Proforma invoice released date and time

  Examples

  Payload

  {
    "proformaInvoiceId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB proformaInvoice.archived

  Inform about a proforma invoice archived

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a proforma invoice archived

  proformaInvoiceId

  required

  integer

  Unique identifier for the proforma invoice

  updatedAt

  required

  string

  format: date-time

  Proforma invoice archived date and time

  Examples

  Payload

  {
    "proformaInvoiceId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB proformaInvoice.canceled

  Inform about a proforma invoice canceled

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a proforma invoice cancellation

  proformaInvoiceId

  required

  integer

  Unique identifier for the proforma invoice

  updatedAt

  required

  string

  format: date-time

  Proforma invoice canceled date and time

  Examples

  Payload

  {
    "proformaInvoiceId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB proformaInvoice.deleted

  Inform about a proforma invoice deleted

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a proforma invoice deleted

  proformaInvoiceId

  required

  integer

  Unique identifier for the proforma invoice

  updatedAt

  required

  string

  format: date-time

  Proforma invoice deleted date and time

  Examples

  Payload

  {
    "proformaInvoiceId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB proformaInvoice.protocolCreated

  Inform about an proforma invoice protocol created

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a invoice protocol

  proformaInvoiceProtocolId

  required

  integer

  Unique identifier for the proforma invoice protocol

  proformaInvoiceId

  required

  integer

  Unique identifier for the proforma invoice

  createdAt

  required

  string

  format: date-time

  Proforma invoice protocol date and time

  Examples

  Payload

  {
    "proformaInvoiceProtocolId": 0,
    "proformaInvoiceId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB production.canceled

  Inform about a production canceled

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a production canceled

  productionId

  required

  integer

  Unique identifier for the production

  updatedAt

  required

  string

  format: date-time

  Production canceled date and time

  Examples

  Payload

  {
    "productionId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB production.deleted

  Inform about a production deleted

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a production deleted

  productionId

  required

  integer

  Unique identifier for the production

  updatedAt

  required

  string

  format: date-time

  Production deleted date and time

  Examples

  Payload

  {
    "productionId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB production.completed

  Inform about a production completed

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a production completed

  productionId

  required

  integer

  Unique identifier for the production

  updatedAt

  required

  string

  format: date-time

  Production completed date and time

  Examples

  Payload

  {
    "productionId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB production.created

  Inform about a production created

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a production creation

  productionId

  required

  integer

  Unique identifier for the production

  createdAt

  required

  string

  format: date-time

  Production created date and time

  Examples

  Payload

  {
    "productionId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB production.protocolCreated

  Inform about a production protocol created

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a production creation

  productionProtocolId

  required

  integer

  Unique identifier for the production protocol

  productionId

  required

  integer

  Unique identifier for the production

  createdAt

  required

  string

  format: date-time

  Production created date and time

  Examples

  Payload

  {
    "productionProtocolId": 0,
    "productionId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB production.released

  Inform about a production released

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a production released

  productionId

  required

  integer

  Unique identifier for the production

  updatedAt

  required

  string

  format: date-time

  Production release date and time

  Examples

  Payload

  {
    "productionId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB production.sent

  Inform about a production sent

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a production sent

  productionId

  required

  integer

  Unique identifier for the production

  updatedAt

  required

  string

  format: date-time

  Production sent date and time

  Examples

  Payload

  {
    "productionId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB production.started

  Inform about a production started

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a production started

  productionId

  required

  integer

  Unique identifier for the production

  updatedAt

  required

  string

  format: date-time

  Production start date and time

  Examples

  Payload

  {
    "productionId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB production.updated

  Inform about a production updated

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a production update

  productionId

  required

  integer

  Unique identifier for the production

  updatedAt

  required

  string

  format: date-time

  Production update date and time

  Examples

  Payload

  {
    "productionId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB invoice.created

  Inform about a invoice created

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a new invoice

  invoiceId

  required

  integer

  Unique identifier for the invoice

  createdAt

  required

  string

  format: date-time

  Invoice creation date and time

  Examples

  Payload

  {
    "invoiceId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB invoice.sent

  Inform about a invoice sent

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a invoice sent

  invoiceId

  required

  integer

  Unique identifier for the invoice

  updatedAt

  required

  string

  format: date-time

  Invoice sent date and time

  Examples

  Payload

  {
    "invoiceId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB invoice.updated

  Inform about a invoice updated

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a invoice updated

  invoiceId

  required

  integer

  Unique identifier for the invoice

  updatedAt

  required

  string

  format: date-time

  Invoice update date and time

  Examples

  Payload

  {
    "invoiceId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB invoice.released

  Inform about a invoice released

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a invoice release

  invoiceId

  required

  integer

  Unique identifier for the invoice

  updatedAt

  required

  string

  format: date-time

  Invoice released date and time

  Examples

  Payload

  {
    "invoiceId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB invoice.archived

  Inform about a invoice archived

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a invoice archived

  invoiceId

  required

  integer

  Unique identifier for the invoice

  updatedAt

  required

  string

  format: date-time

  Invoice archived date and time

  Examples

  Payload

  {
    "invoiceId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB invoice.canceled

  Inform about a invoice canceled

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a invoice cancellation

  invoiceId

  required

  integer

  Unique identifier for the invoice

  updatedAt

  required

  string

  format: date-time

  Invoice canceled date and time

  Examples

  Payload

  {
    "invoiceId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB invoice.deleted

  Inform about a invoice deleted

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a invoice deleted

  invoiceId

  required

  integer

  Unique identifier for the invoice

  updatedAt

  required

  string

  format: date-time

  Invoice deleted date and time

  Examples

  Payload

  {
    "invoiceId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB invoice.protocolCreated

  Inform about an invoice protocol created

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a invoice protocol

  invoiceProtocolId

  required

  integer

  Unique identifier for the invoice protocol

  invoiceId

  required

  integer

  Unique identifier for the invoice

  createdAt

  required

  string

  format: date-time

  Invoice protocol date and time

  Examples

  Payload

  {
    "invoiceProtocolId": 0,
    "invoiceId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB liability.created

  Inform about a liability created

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a new liability

  liabilityId

  required

  integer

  Unique identifier for the liability

  createdAt

  required

  string

  format: date-time

  Liability creation date and time

  Examples

  Payload

  {
    "liabilityId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB liability.updated

  Inform about a liability updated

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a liability updated

  liabilityId

  required

  integer

  Unique identifier for the liability

  updatedAt

  required

  string

  format: date-time

  Liability update date and time

  Examples

  Payload

  {
    "liabilityId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB liability.released

  Inform about a liability released

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a liability release

  liabilityId

  required

  integer

  Unique identifier for the liability

  updatedAt

  required

  string

  format: date-time

  Liability released date and time

  Examples

  Payload

  {
    "liabilityId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB liability.canceled

  Inform about a liability canceled

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a liability cancellation

  liabilityId

  required

  integer

  Unique identifier for the liability

  updatedAt

  required

  string

  format: date-time

  Liability canceled date and time

  Examples

  Payload

  {
    "liabilityId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB liability.deleted

  Inform about a liability deleted

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a liability deleted

  liabilityId

  required

  integer

  Unique identifier for the liability

  updatedAt

  required

  string

  format: date-time

  Liability deleted date and time

  Examples

  Payload

  {
    "liabilityId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB liability.protocolCreated

  Inform about an liability protocol created

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a liability protocol

  liabilityProtocolId

  required

  integer

  Unique identifier for the liability protocol

  liabilityId

  required

  integer

  Unique identifier for the liability

  createdAt

  required

  string

  format: date-time

  Liability protocol date and time

  Examples

  Payload

  {
    "liabilityProtocolId": 0,
    "liabilityId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB creditNote.created

  Inform about a credit note created

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a new credit note

  creditNoteId

  required

  integer

  Unique identifier for the credit note

  createdAt

  required

  string

  format: date-time

  Credit Note creation date and time

  Examples

  Payload

  {
    "creditNoteId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB creditNote.sent

  Inform about a credit note sent

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a credit note sent

  creditNoteId

  required

  integer

  Unique identifier for the credit note

  updatedAt

  required

  string

  format: date-time

  Credit note sent date and time

  Examples

  Payload

  {
    "creditNoteId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB creditNote.updated

  Inform about a credit note updated

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a credit note updated

  creditNoteId

  required

  integer

  Unique identifier for the credit note

  updatedAt

  required

  string

  format: date-time

  Credit note update date and time

  Examples

  Payload

  {
    "creditNoteId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB creditNote.released

  Inform about a credit note released

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a credit note release

  creditNoteId

  required

  integer

  Unique identifier for the credit note

  updatedAt

  required

  string

  format: date-time

  Credit note released date and time

  Examples

  Payload

  {
    "creditNoteId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB creditNote.archived

  Inform about a credit note archived

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a credit note archived

  creditNoteId

  required

  integer

  Unique identifier for the credit note

  updatedAt

  required

  string

  format: date-time

  Credit note archived date and time

  Examples

  Payload

  {
    "creditNoteId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB creditNote.canceled

  Inform about a credit note canceled

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a credit note cancellation

  creditNoteId

  required

  integer

  Unique identifier for the credit note

  updatedAt

  required

  string

  format: date-time

  Credit Note canceled date and time

  Examples

  Payload

  {
    "creditNoteId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB creditNote.deleted

  Inform about a credit note deleted

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a credit note deleted

  creditNoteId

  required

  integer

  Unique identifier for the credit note

  updatedAt

  required

  string

  format: date-time

  Credit Note deleted date and time

  Examples

  Payload

  {
    "creditNoteId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB creditNote.protocolCreated

  Inform about an credit note protocol created

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a credit note protocol

  creditNoteProtocolId

  required

  integer

  Unique identifier for the credit note protocol

  creditNoteId

  required

  integer

  Unique identifier for the credit note

  createdAt

  required

  string

  format: date-time

  Credit Note protocol date and time

  Examples

  Payload

  {
    "creditNoteProtocolId": 0,
    "creditNoteId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB offer.created

  Inform about a offer created

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a offer creation

  offerId

  required

  integer

  Unique identifier for the offer

  createdAt

  required

  string

  format: date-time

  Offer created date and time

  Examples

  Payload

  {
    "offerId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB offer.sent

  Inform about a offer sent

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a offer sent

  offerId

  required

  integer

  Unique identifier for the offer

  updatedAt

  required

  string

  format: date-time

  Offer sent date and time

  Examples

  Payload

  {
    "offerId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB offer.updated

  Inform about a offer updated

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a offer update

  offerId

  required

  integer

  Unique identifier for the offer

  updatedAt

  required

  string

  format: date-time

  Offer update date and time

  Examples

  Payload

  {
    "offerId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB offer.released

  Inform about a offer released

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a offer released

  offerId

  required

  integer

  Unique identifier for the offer

  updatedAt

  required

  string

  format: date-time

  Offer release date and time

  Examples

  Payload

  {
    "offerId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB offer.archived

  Inform about a offer archived

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a offer archived

  offerId

  required

  integer

  Unique identifier for the offer

  updatedAt

  required

  string

  format: date-time

  Offer archived date and time

  Examples

  Payload

  {
    "offerId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB offer.canceled

  Inform about a offer canceled

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a offer canceled

  offerId

  required

  integer

  Unique identifier for the offer

  updatedAt

  required

  string

  format: date-time

  Offer canceled date and time

  Examples

  Payload

  {
    "offerId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB offer.deleted

  Inform about a offer deleted

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a offer deleted

  offerId

  required

  integer

  Unique identifier for the offer

  updatedAt

  required

  string

  format: date-time

  Offer deleted date and time

  Examples

  Payload

  {
    "offerId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB offer.protocolCreated

  Inform about an offer protocol created

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a offer creation

  offerProtocolId

  required

  integer

  Unique identifier for the offer protocol

  offerId

  required

  integer

  Unique identifier for the offer

  createdAt

  required

  string

  format: date-time

  Offer created date and time

  Examples

  Payload

  {
    "offerProtocolId": 0,
    "offerId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB order.fetched

  Inform orders fetched from sales channel

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform orders fetched from sales channel

  salesChannel

  required

  string

  Sales channel type

  orderNumbers

  Expand all

  required

  array<string>

  Sales channel type

  Items:

  string

  createdAt

  required

  string

  format: date-time

  Order creation date and time

  Examples

  Payload

  {
    "salesChannel": "string",
    "orderNumbers": [
      "string"
    ],
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB stock.synchronized

  Inform stock was synchronized to a sales channel

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform stock was synchronized to a sales channel

  salesChannel

  required

  string

  Sales channel type

  productNumbers

  Expand all

  required

  array<string>

  number of the product

  Items:

  string

  createdAt

  string

  format: date-time

  product import date and time

  Examples

  Payload

  {
    "salesChannel": "string",
    "productNumbers": [
      "string"
    ],
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB product.exported

  Inform product exported to a sales channel

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform product exported to a sales channel

  salesChannel

  required

  string

  Sales channel type

  productNumber

  required

  string

  number of the product

  createdAt

  string

  format: date-time

  product export date and time

  Examples

  Payload

  {
    "salesChannel": "string",
    "productNumber": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB product.imported

  Inform product imported from sales channel

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform product imported to a sales channel

  salesChannel

  required

  string

  Sales channel type

  productNumber

  required

  string

  number of the product

  createdAt

  string

  format: date-time

  product import date and time

  Examples

  Payload

  {
    "salesChannel": "string",
    "productNumber": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB storageItem.movement

  Inform about a quantity changed of a storage item

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a quantity changed of a storage item

  productId

  required

  integer

  Unique identifier for the product

  storageLocationId

  required

  integer

  Identifier of the storage location the operation was done on

  updatedAt

  required

  string

  format: date-time

  Date and time of operation

  Examples

  Payload

  {
    "productId": 0,
    "storageLocationId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB reservation.changed

  Inform about a reservation-change for a product

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a reservation-change for a product

  productId

  required

  integer

  Unique identifier for the product

  updatedAt

  required

  string

  format: date-time

  Date and time of operation

  Examples

  Payload

  {
    "productId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB report.exported

  Inform about a report exported

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a report exported

  reportId

  required

  integer

  Unique identifier for the report

  exportedAt

  required

  string

  format: date-time

  Report export date and time

  Examples

  Payload

  {
    "reportId": 0,
    "exportedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB report.viewed

  Inform about a report viewed

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a report viewed

  reportId

  required

  integer

  Unique identifier for the report

  viewedAt

  required

  string

  format: date-time

  Report view date and time

  Examples

  Payload

  {
    "reportId": 0,
    "viewedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB extendedOrderProposal.execution

  Inform about the execution of a extended order proposal

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about the execution of a extended order proposal

  createdAt

  required

  string

  format: date-time

  execution date and time

  Examples

  Payload

  {
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB orderProposal.execution

  Inform about the execution of a order proposal

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about the execution of a order proposal

  createdAt

  required

  string

  format: date-time

  execution date and time

  Examples

  Payload

  {
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB dropshippingWarehouse.orderCreated

  Inform about the execution of dropshipping warehouse order creation

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about the execution of dropshipping warehouse order creation

  originSalesOrderId

  required

  integer

  Unique identifier for the origin sales Order

  childSalesOrderIds

  Expand all

  required

  array<integer>

  Unique identifier for the child sales OrderIds

  Items:

  integer

  createdAt

  required

  string

  format: date-time

  execution date and time

  Examples

  Payload

  {
    "originSalesOrderId": 0,
    "childSalesOrderIds": [
      0
    ],
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB dropshippingSupplier.orderCreated

  Inform about the execution of dropshipping supplier order creation

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about the execution of dropshipping supplier order creation

  originSalesOrderId

  required

  integer

  Unique identifier for the origin sales Order

  childSalesOrderIds

  Expand all

  required

  array<integer>

  Unique identifier for the child sales OrderIds

  Items:

  integer

  purchaseOrderIds

  Expand all

  required

  array<integer>

  Unique identifier for the created purchase OrderIds

  Items:

  integer

  createdAt

  required

  string

  format: date-time

  execution date and time

  Examples

  Payload

  {
    "originSalesOrderId": 0,
    "childSalesOrderIds": [
      0
    ],
    "purchaseOrderIds": [
      0
    ],
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB dispatchCenter.orderProcessed

  Inform about the processing a order in dispatch center

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about the processing a order in dispatch center

  deliveryNoteId

  required

  integer

  Unique identifier for the delivery Note

  createdAt

  required

  string

  format: date-time

  Order Dispatched date and time

  Examples

  Payload

  {
    "deliveryNoteId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB shipment.created

  Inform about a shipment creation

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a shipment creation

  shipmentId

  required

  integer

  Unique identifier for the shipment

  deliveryNoteId

  required

  integer

  Unique identifier for the deliver note

  carrier

  string | null

  carrier

  trackingNumber

  string | null

  tracking number

  trackingUrl

  string | null

  tracking url

  createdAt

  required

  string

  format: date-time

  Shipment creation date and time

  Examples

  Payload

  {
    "shipmentId": 0,
    "deliveryNoteId": 0,
    "carrier": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB shipment.labelCreationSuccessful

  Inform about a shipment label creation successful

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a shipment label creation successful

  shipmentId

  required

  integer

  Unique identifier for the shipment

  deliveryNoteId

  required

  integer

  Unique identifier for the corresponding delivery note

  salesOrderId

  integer | null

  Unique identifier for the corresponding sales order

  carrier

  required

  string

  carrier

  trackingNumber

  required

  string

  tracking number

  trackingUrl

  string | null

  tracking url

  createdAt

  required

  string

  format: date-time

  Shipment label creation date and time

  Examples

  Payload

  {
    "shipmentId": 0,
    "deliveryNoteId": 0,
    "salesOrderId": 0,
    "carrier": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB picklist.generated

  Inform about a picklist generated

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a picklist generated

  picklistId

  required

  integer

  Unique identifier for the picklist

  createdAt

  required

  string

  format: date-time

  picklist creation date and time

  Examples

  Payload

  {
    "picklistId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB picklist.created

  Inform about a picklist created

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a pick list creation

  pickListId

  required

  integer

  Unique identifier for the pick list

  Examples

  Payload

  {
    "pickListId": 0
  }
  

  This example has been generated automatically.

• PUB autoshipment.dispatched

  Inform about a dispatched autoshipment

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a dispatched autoshipment

  createdAt

  required

  string

  format: date-time

  autoshipment dispatch date and time

  salesOrderIds

  Expand all

  array<integer>

  Items:

  integer

  Examples

  Payload

  {
    "createdAt": "2019-08-24T14:15:22Z",
    "salesOrderIds": [
      0
    ]
  }
  

  This example has been generated automatically.

• PUB transfer.jobSuccessful

  Inform about a Job transferred successfully

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a Job transferred successfully

  doctype

  required

  string

  Document type transferred

  createdAt

  required

  string

  format: date-time

  Order creation date and time

  doctypeId

  integer | null

  Unique identifier for the document

  Examples

  Payload

  {
    "doctype": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "doctypeId": 0
  }
  

  This example has been generated automatically.

• PUB transfer.jobError

  Inform about an Error on a Transfer Job

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about an Error on a Transfer Job

  doctype

  required

  string

  Document type failed on transfer

  createdAt

  required

  string

  format: date-time

  Order creation date and time

  doctypeId

  integer | null

  Unique identifier for the document

  errorDescription

  required

  string

  short description about the error

  Examples

  Payload

  {
    "doctype": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "doctypeId": 0,
    "errorDescription": "string"
  }
  

  This example has been generated automatically.

• PUB return.goodsReceived

  Inform about goods received for a return

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about goods received for a return

  returnId

  required

  integer

  Unique identifier for the return

  returnFullyReceived

  required

  boolean

  is return completely fully received

  updatedAt

  required

  string

  format: date-time

  goods received date and time

  Examples

  Payload

  {
    "returnId": 0,
    "returnFullyReceived": true,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB purchaseOrder.goodsReceived

  Inform about goods received for a purchase order

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about goods received for a purchase order

  purchase orderId

  integer

  Unique identifier for the purchase order

  purchaseOrderFullyReceived

  required

  boolean

  is purchase order completely fully received

  updatedAt

  required

  string

  format: date-time

  goods received created date and time

  Examples

  Payload

  {
    "purchase orderId": 0,
    "purchaseOrderFullyReceived": true,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB paymentList.imported

  Inform about a imported payment list

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a imported payment list

  paymentAccountId

  required

  integer

  paymentIds

  Expand all

  array<integer>

  Items:

  integer

  updatedAt

  required

  string

  format: date-time

  import date and time

  Examples

  Payload

  {
    "paymentAccountId": 0,
    "paymentIds": [
      0
    ],
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB dunning.started

  Inform about starting dunning

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about dunning started

  updatedAt

  required

  string

  format: date-time

  start date and time

  Examples

  Payload

  {
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB outgoingPayment.created

  Inform about an outgoing payment created

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about an outgoing payment created

  createdAt

  required

  string

  format: date-time

  creation date and time

  Examples

  Payload

  {
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB datev.exported

  Inform about an datev export

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about an datev export

  updatedAt

  required

  string

  format: date-time

  start date and time

  Examples

  Payload

  {
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB pos.orderCreated

  Inform about an pos order was created

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about an pos order was created

  createdAt

  required

  string

  format: date-time

  creation date and time

  Examples

  Payload

  {
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB project.created

  Inform about a project creation

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a new invoice

  projectId

  required

  integer

  Unique identifier for the project

  createdAt

  required

  string

  format: date-time

  Project creation date and time

  Examples

  Payload

  {
    "projectId": 0,
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB importer.executed

  Inform about an importer executed

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about an importer executed

  importerId

  required

  integer

  Unique identifier for the Importer

  updatedAt

  required

  string

  format: date-time

  import date and time

  Examples

  Payload

  {
    "importerId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB exporter.executed

  Inform about an exporter executed

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about an exporter executed

  exporterId

  required

  integer

  Unique identifier for the Exporter

  updatedAt

  required

  string

  format: date-time

  export date and time

  Examples

  Payload

  {
    "exporterId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB ticket.received

  Inform about an ticket received

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a ticket received

  ticketId

  required

  integer

  Unique identifier for the ticket

  updatedAt

  required

  string

  format: date-time

  Ticket receive date and time

  Examples

  Payload

  {
    "ticketId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB ticket.replySent

  Inform about an ticket reply sent

  Operation IDpublish

  Available only on servers:

  • kafka

  Channel Extensions

  Expand all

  object

  x-internal

  true

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about a ticket reply sent

  ticketId

  required

  integer

  Unique identifier for the ticket

  updatedAt

  required

  string

  format: date-time

  Ticket answered date and time

  Examples

  Payload

  {
    "ticketId": 0,
    "updatedAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

• PUB product.mediaCreated

  Inform about a new product media

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about new product media

  id

  required

  integer

  Unique identifier for the product media

  product

  Expand all

  required

  object

  id

  integer

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": 0,
    "product": {
      "id": 0
    }
  }
  

  This example has been generated automatically.

• PUB product.partsListPositionCreated

  Informs about created parts list position of a product

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Informs about a new product parts list position

  id

  required

  integer

  Unique identifier for the product parts list position

  product

  Expand all

  required

  object

  Unique identifier for the product

  id

  integer

  Additional properties are allowed.

  productPart

  Expand all

  required

  object

  Unique identifier for the product part

  id

  integer

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": 0,
    "product": {
      "id": 0
    },
    "productPart": {
      "id": 0
    }
  }
  

  This example has been generated automatically.

• PUB product.mediaUpdated

  Inform about updated product media

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about updated product media

  id

  required

  integer

  Unique identifier for the product media

  product

  Expand all

  required

  object

  id

  integer

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": 0,
    "product": {
      "id": 0
    }
  }
  

  This example has been generated automatically.

• PUB product.partsListPositionUpdated

  Informs about updated parts list position of a product

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Informs about an updated product parts list position

  id

  required

  integer

  Unique identifier for the product parts list position

  product

  Expand all

  required

  object

  Unique identifier for the product

  id

  integer

  Additional properties are allowed.

  productPart

  Expand all

  required

  object

  Unique identifier for the product part

  id

  integer

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": 0,
    "product": {
      "id": 0
    },
    "productPart": {
      "id": 0
    }
  }
  

  This example has been generated automatically.

• PUB product.mediaDeleted

  Inform about deleted product media

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Inform about deleted product media

  id

  required

  integer

  Unique identifier for the product media

  product

  Expand all

  required

  object

  id

  integer

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": 0,
    "product": {
      "id": 0
    }
  }
  

  This example has been generated automatically.

• PUB product.crossSellingCreated

  Informs about created cross selling information of a product

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Informs about created cross selling information of a product

  id

  required

  integer

  Unique identifier for the cross selling

  product

  Expand all

  required

  object

  Unique identifier for the product

  id

  integer

  Additional properties are allowed.

  crossSellingProduct

  Expand all

  required

  object

  Unique identifier for the cross selling product

  id

  integer

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": 0,
    "product": {
      "id": 0
    },
    "crossSellingProduct": {
      "id": 0
    }
  }
  

  This example has been generated automatically.

• PUB product.crossSellingUpdated

  Informs about updated cross selling information of a product

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Informs about updated cross selling information of a product

  id

  required

  integer

  Unique identifier for the cross selling

  product

  Expand all

  required

  object

  Unique identifier for the product

  id

  integer

  Additional properties are allowed.

  crossSellingProduct

  Expand all

  required

  object

  Unique identifier for the cross selling product

  id

  integer

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": 0,
    "product": {
      "id": 0
    },
    "crossSellingProduct": {
      "id": 0
    }
  }
  

  This example has been generated automatically.

• PUB product.crossSellingDeleted

  Informs about deleted cross selling information of a product

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Informs about deleted cross selling information of a product

  id

  required

  integer

  Unique identifier for the cross selling

  product

  Expand all

  required

  object

  Unique identifier for the product

  id

  integer

  Additional properties are allowed.

  crossSellingProduct

  Expand all

  required

  object

  Unique identifier for the cross selling product

  id

  integer

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": 0,
    "product": {
      "id": 0
    },
    "crossSellingProduct": {
      "id": 0
    }
  }
  

  This example has been generated automatically.

• PUB product.partsListPositionDeleted

  Informs about deleted parts list position of a product

  Operation IDpublish

  Available only on servers:

  • kafka

  Accepts the following message:

  Payload

  Expand all

  restricted any

  Informs about a deleted product parts list position

  id

  required

  integer

  Unique identifier for the product parts list position

  product

  Expand all

  required

  object

  Unique identifier for the product

  id

  integer

  Additional properties are allowed.

  productPart

  Expand all

  required

  object

  Unique identifier for the product part

  id

  integer

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": 0,
    "product": {
      "id": 0
    },
    "productPart": {
      "id": 0
    }
  }
  

  This example has been generated automatically.