Operations

• PUB salesOrder.created

  Inform about a new sales order

  Accepts the following message:

  SalesOrderCreated

  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

  Accepts the following message:

  SalesOrderSent

  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

  Accepts the following message:

  SalesOrderUpdated

  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

  Accepts the following message:

  SalesOrderImported

  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

  Accepts the following message:

  SalesOrderReleased

  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

  Accepts the following message:

  SalesOrderDispatched

  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

  Accepts the following message:

  SalesOrderAutoshipmentProcessed

  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

  Accepts the following message:

  SalesOrderArchived

  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

  Accepts the following message:

  SalesOrderProtocolCreated

  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 product.created

  Inform about a new product

  Accepts the following message:

  ProductCreated

  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

  Accepts the following message:

  ProductUpdated

  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

  Accepts the following message:

  ProductDeleted

  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

  Accepts the following message:

  ProductPropertiesCreated

  Payload

  Expand all

  restricted any

  Inform about new product properties

  id

  required

  integer

  Unique identifier for the product

  properties

  Expand all

  required

  array<object>

  id

  integer

  name

  string

  value

  string

  unit

  string | null

  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

  Accepts the following message:

  ProductPropertiesUpdated

  Payload

  Expand all

  restricted any

  Inform about updated product properties

  id

  required

  integer

  Unique identifier for the product

  properties

  Expand all

  required

  array<object>

  id

  integer

  name

  string

  value

  string

  unit

  string | null

  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

  Accepts the following message:

  ProductPropertiesDeleted

  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>

  id

  integer

  Examples

  Payload

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

  This example has been generated automatically.

• PUB salesPrice.created

  Inform about new SalesPrice

  Accepts the following message:

  SalesPriceCreated

  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,
    "units": 0,
    "price": {
      "amount": 0,
      "currency": "string"
    },
    "validFrom": "2019-08-24",
    "expiresAt": "2019-08-24"
  }
  

  This example has been generated automatically.

• PUB salesPrice.updated

  Inform about updated SalesPrice

  Accepts the following message:

  SalesPriceUpdated

  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,
    "units": 0,
    "price": {
      "amount": 0,
      "currency": "string"
    },
    "validFrom": "2019-08-24",
    "expiresAt": "2019-08-24"
  }
  

  This example has been generated automatically.

• PUB salesPrice.deleted

  Inform about removal of SalesPrice

  Accepts the following message:

  SalesPriceDeleted

  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

  Accepts the following message:

  PurchasePriceCreated

  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,
    "packageAmount": 0,
    "price": {
      "amount": 0,
      "currency": "string"
    },
    "validFrom": "string",
    "expiresAt": "string"
  }
  

  This example has been generated automatically.

• PUB purchasePrice.updated

  Inform about purchase price updated

  Accepts the following message:

  PurchasePriceUpdated

  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,
    "packageAmount": 0,
    "price": {
      "amount": 0,
      "currency": "string"
    },
    "validFrom": "string",
    "expiresAt": "string"
  }
  

  This example has been generated automatically.

• PUB purchasePrice.deleted

  Inform about purchase price deleted

  Accepts the following message:

  PurchasePriceDeleted

  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

  Accepts the following message:

  ProductCategoryCreated

  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

  Accepts the following message:

  ProductCategoryUpdated

  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

  Accepts the following message:

  ProductCategoryDeleted

  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

  Accepts the following message:

  PurchaseOrderCreated

  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

  Accepts the following message:

  PurchaseOrderSent

  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

  Accepts the following message:

  PurchaseOrderUpdated

  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

  Accepts the following message:

  PurchaseOrderReleased

  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

  Accepts the following message:

  PurchaseOrderArchived

  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

  Accepts the following message:

  PurchaseOrderCanceled

  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

  Accepts the following message:

  PurchaseOrderDeleted

  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

  Accepts the following message:

  PurchaseOrderProtocolCreated

  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

  Accepts the following message:

  ReturnCreated

  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

  Accepts the following message:

  ReturnSent

  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

  Accepts the following message:

  ReturnUpdated

  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

  Accepts the following message:

  ReturnReleased

  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

  Accepts the following message:

  ReturnArchived

  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

  Accepts the following message:

  ReturnCanceled

  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

  Accepts the following message:

  ReturnDeleted

  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

  Accepts the following message:

  ReturnProtocolCreated

  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

  Accepts the following message:

  DeliveryNoteCreated

  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

  Accepts the following message:

  DeliveryNoteSent

  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

  Accepts the following message:

  DeliveryNoteUpdated

  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

  Accepts the following message:

  DeliveryNoteReleased

  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

  Accepts the following message:

  DeliveryNoteArchived

  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

  Accepts the following message:

  DeliveryNoteCanceled

  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

  Accepts the following message:

  DeliveryNoteDeleted

  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

  Accepts the following message:

  DeliveryNoteProtocolCreated

  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 production.canceled

  Inform about a production canceled

  Accepts the following message:

  ProductionCanceled

  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

  Accepts the following message:

  ProductionDeleted

  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

  Accepts the following message:

  ProductionCompleted

  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

  Accepts the following message:

  ProductionCreated

  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

  Accepts the following message:

  ProductionProtocolCreated

  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

  Accepts the following message:

  ProductionReleased

  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

  Accepts the following message:

  ProductionSent

  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

  Accepts the following message:

  ProductionStarted

  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

  Accepts the following message:

  ProductionUpdated

  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

  Accepts the following message:

  InvoiceCreated

  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

  Accepts the following message:

  InvoiceSent

  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

  Accepts the following message:

  InvoiceUpdated

  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

  Accepts the following message:

  InvoiceReleased

  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

  Accepts the following message:

  InvoiceArchived

  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

  Accepts the following message:

  InvoiceCanceled

  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

  Accepts the following message:

  InvoiceDeleted

  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

  Accepts the following message:

  InvoiceProtocolCreated

  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

  Accepts the following message:

  LiabilityCreated

  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

  Accepts the following message:

  LiabilityUpdated

  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

  Accepts the following message:

  LiabilityReleased

  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

  Accepts the following message:

  LiabilityCanceled

  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

  Accepts the following message:

  LiabilityDeleted

  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

  Accepts the following message:

  LiabilityProtocolCreated

  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

  Accepts the following message:

  CreditNoteCreated

  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.updated

  Inform about a credit note updated

  Accepts the following message:

  CreditNoteUpdated

  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

  Accepts the following message:

  CreditNoteReleased

  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

  Accepts the following message:

  CreditNoteArchived

  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

  Accepts the following message:

  CreditNoteCanceled

  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

  Accepts the following message:

  CreditNoteDeleted

  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

  Accepts the following message:

  CreditNoteProtocolCreated

  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

  Accepts the following message:

  OfferCreated

  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

  Accepts the following message:

  OfferSent

  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

  Accepts the following message:

  OfferUpdated

  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

  Accepts the following message:

  OfferReleased

  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

  Accepts the following message:

  OfferArchived

  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

  Accepts the following message:

  OfferCanceled

  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

  Accepts the following message:

  OfferDeleted

  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

  Accepts the following message:

  OfferProtocolCreated

  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 storageItem.movement

  Inform about a quantity changed of a storage item

  Accepts the following message:

  StorageItemMovement

  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 shipment.created

  Inform about a shipment creation

  Accepts the following message:

  ShipmentCreated

  Payload

  Expand all

  restricted any

  Inform about a shipment creation

  shipmentId

  required

  integer

  Unique identifier for the shipment

  deliveryNote

  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,
    "deliveryNote": 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

  Accepts the following message:

  ShipmentLabelCreationSuccessful

  Payload

  Expand all

  restricted any

  Inform about a shipment label creation successful

  shipmentId

  required

  integer

  Unique identifier for the shipment

  deliveryNote

  integer

  Unique identifier for the deliver note

  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,
    "deliveryNote": 0,
    "carrier": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.