Skip to content

Shipment Dialogue

Shipment dialogue table stores information about communication happened inside specific shipment between all the users who has shipment access.

Attributes

shipmentDialogueId: Primary key for the table.

orgId: Foreign key of Organisation table. This field stores the information of the organisation whose shipment is being used to send message.

shipmentId: Foreign key of Shipment table. This field stores the information of the shipment where dialogue is added.

subject: Subject of the message used to send the message through email.

dialogueByName: Name of the user who sent the message/dialogue.

dialogueByEmail: Email id of the user who sent the message/dialogue.

commentOnlyFor: Email id of the user who can see the message/dialogue. This is only available if message is not public.

commentOnlyForName: Name of the user who can see the message/dialogue. This is only available if message is not public.

isPublic: Boolean value indicating whether the dialogue is public or not. If set to true, this dialogue will be visible to all users who has access to this shipment.

isDeleted: Boolean value indicating whether the dialogue is deleted by the user or not. It's always soft delete.

isPinned: Boolean value indicating whether the dialogue is pinned or not in shipment chat window.

dialogueType: Type of event that caused the dialogue creation event.

Possible values

  1. SYSTEM_TRIGGERED_TRANSACTIONAL
  2. SYSTEM_TRIGGERED_USERDRIVEN
  3. PO_EVENT
  4. INVOICE_EVENT
  5. OTHER_DOCUMENT_EVENT
  6. EXTERNAL_EVENT
  7. API_EVENT
  8. CRON_EVENT
  9. BULK_EVENT
  10. EXTERNAL_USER_EVENT
  11. USER_COMMENT
  12. USER_EMAIL_COMMENT
  13. FINANCING_EVENT

comment: Actual shipment dialogue/message.

commentTitle: Title of the message/dialogue.

Example

  1. Shipment linked.
  2. Shipment Unlinked.
  3. Email Sent etc.

meta: JSON object to stores information about other meta data.


Associations

Organisation

Shipment dialogue always belongs any one Organisation.

Shipment

Shipment dialogue always belongs any one Shipment.