> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# s_shipment table

> Contains info about one shipment. The addresses are stored in s_shipment_addr

## s\_shipment Table (334)

Contains info about one shipment. The addresses are stored in s\_shipment\_addr

## Fields

| Name                      | Description                                                                                                                                                                     | Type                                                  | Nullable |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | :------: |
| id                        | Primary key                                                                                                                                                                     | PK                                                    |    No    |
| description               | Describes the shipment                                                                                                                                                          | String(255)                                           |    Yes   |
| message\_id               | The id of the message that is sent in this shipment                                                                                                                             | FK [s\_message](./s-message.mdx)                      |    No    |
| start\_date               | The date and time when to start this shipment                                                                                                                                   | DateTime                                              |    Yes   |
| end\_date                 | Is set when this shipment is ended                                                                                                                                              | DateTime                                              |    Yes   |
| from\_addr                | Email address to put in the From header of the messages                                                                                                                         | String(255)                                           |    No    |
| reply\_addr               | Email address to put in the Reply To: header of the messages                                                                                                                    | String(255)                                           |    Yes   |
| envelope\_from            | Email address for the MTA envelope (where bounces are returned)                                                                                                                 | String(255)                                           |    Yes   |
| smtp\_serv                | The server to use for this shipment.                                                                                                                                            | String(255)                                           |    Yes   |
| smtp\_port                | The port of the SMTP server to use for this shipment.                                                                                                                           | Int                                                   |    No    |
| send\_rate                | Maximum number of messages sent per minute.                                                                                                                                     | Int                                                   |    No    |
| status                    | Sending/stopped/failed etc.                                                                                                                                                     | Enum [ShipmentStatus](./enums/shipmentstatus.mdx)     |    No    |
| recipients                | The total number of recipients to send message to.                                                                                                                              | Int                                                   |    No    |
| actual\_rate              | The actual rate of messages per minute. can be lower than send\_rate                                                                                                            | Int                                                   |    No    |
| actual\_time              | The time of the last checkpoint                                                                                                                                                 | DateTime                                              |    Yes   |
| actual\_count             | Number of emails sent at the last checkpoint                                                                                                                                    | Int                                                   |    No    |
| current\_sender           | Timestamp to identify which ejsender that owns this shipment                                                                                                                    | Int                                                   |    Yes   |
| ticket\_owner             | The owner of the ticket if any is created while sending out a shipment. -1 if no ticket should be automatically delegated, 1 if the ticket is unassigned, \&gt;1 for all others | Int                                                   |    Yes   |
| ticket\_category          | The category of tickets created while sending out if any. -1 if no ticket should be created                                                                                     | Int                                                   |    Yes   |
| flags                     | Various flags for a shipment                                                                                                                                                    | UInt                                                  |    Yes   |
| folder\_id                | The folder which this shipment belongs to. -1 indicates that the shipment is on the root                                                                                        | Int                                                   |    No    |
| configuration             | This field indicates what kind of shipment this is.                                                                                                                             | Int                                                   |    No    |
| selection\_id             | Set if this shipment should be related to a Selection                                                                                                                           | FK [selection](./selection.mdx)                       |    Yes   |
| project\_id               | Set if this shipment should be related to a Project                                                                                                                             | FK [project](./project.mdx)                           |    Yes   |
| generated\_document\_id   | ID of the merged document that is the result of the shipment                                                                                                                    | FK [document](./document.mdx)                         |    Yes   |
| registered                | Registered when                                                                                                                                                                 | UtcDateTime                                           |    Yes   |
| registered\_associate\_id | Registered by whom                                                                                                                                                              | FK [associate](./associate.mdx)                       |    Yes   |
| updated                   | Last updated when                                                                                                                                                               | UtcDateTime                                           |    Yes   |
| updated\_associate\_id    | Last updated by whom                                                                                                                                                            | FK [associate](./associate.mdx)                       |    Yes   |
| updatedCount              | Number of updates made to this record                                                                                                                                           | UShort                                                |    Yes   |
| active\_pane              | The currently active pane in the mailing wizard                                                                                                                                 | Int                                                   |    Yes   |
| sorting                   | Which sorting should be used on the document mailing recipient list, used when generating PDF                                                                                   | Enum [RecipientSorting](./enums/recipientsorting.mdx) |    No    |
| delivered\_num            | Number of mails sent minus bounces                                                                                                                                              | Int                                                   |    Yes   |
| open\_num                 | Number of opened emails count                                                                                                                                                   | Int                                                   |    Yes   |
| open\_rate                | Open rate % (open\_num / delivered\_num)                                                                                                                                        | Double                                                |    Yes   |
| click\_num                | Number of links clicked                                                                                                                                                         | Int                                                   |    Yes   |
| click\_rate               | Click rate % (click\_num / delivered\_num)                                                                                                                                      | Double                                                |    Yes   |
| hardbounce\_num           | Number of hard bounces                                                                                                                                                          | Int                                                   |    Yes   |
| hardbounce\_rate          | Hard bounce rate % (hardbounce\_num / number\_transmitted)                                                                                                                      | Double                                                |    Yes   |
| softbounce\_num           | Number of soft bounces                                                                                                                                                          | Int                                                   |    Yes   |
| softbounce\_rate          | Soft bounce rate % (softbounce\_num / number\_transmitted)                                                                                                                      | Double                                                |    Yes   |
| totalbounce\_num          | Total number of bounces                                                                                                                                                         | Int                                                   |    Yes   |
| totalbounce\_rate         | Total bounce rate % (totalbounce\_num / number\_transmitted)                                                                                                                    | Double                                                |    Yes   |
| are\_statistics\_dirty    | Indicates if shipment needs statistics calculation, set by code that changes the shipment or receives clicks/opens                                                              | Bool                                                  |    No    |
| sent\_num                 | Number of mails sent                                                                                                                                                            | Int                                                   |    Yes   |
| shipmenttype\_id          | Id of subscriptionType that this shipment has, so we may check for reservations                                                                                                 | FK [ShipmentType](./shipmenttype.mdx)                 |    Yes   |

<img src="https://mintcdn.com/superofficeas/8-OIGQQJR0VGDXy_/media/loc/en/database/tables/s_shipment.png?fit=max&auto=format&n=8-OIGQQJR0VGDXy_&q=85&s=e4e3a42e984784976f61c3699162f3c2" alt="s_shipment table relationship diagram" width="1016" height="943" data-path="media/loc/en/database/tables/s_shipment.png" />

## Indexes

| Fields                     | Types    | Description |
| -------------------------- | -------- | ----------- |
| message\_id                | FK       | Index       |
| are\_statistics\_dirty, id | Bool, PK | Index       |

## Relationships

| Table                                                     | Description                                                                                                                                                                                                                                                                                                                               |
| --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [associate](./associate)                                  | Employees, resources and other users - except for External persons                                                                                                                                                                                                                                                                        |
| [document](./document)                                    | Documents, this table is an extension of the Appointment table.  There is always a corresponding appointment record; the relation between appointment and document is navigable in both directions. A document-type appointment record always has a corresponding document record and a record in VisibleFor specifying who may see this. |
| [form](./form)                                            | A form which can be published on a webpage and submitted by visitors                                                                                                                                                                                                                                                                      |
| [project](./project)                                      | Projects                                                                                                                                                                                                                                                                                                                                  |
| [s\_bounce\_shipment](./s-bounce-shipment)                | Email bounces from customers                                                                                                                                                                                                                                                                                                              |
| [s\_link\_customer](./s-link-customer)                    | A connection between a customer and a link. Registered customers are identified when clicking on a link                                                                                                                                                                                                                                   |
| [s\_link\_customer\_statical](./s-link-customer-statical) | A connection between a customer and a link. Registered customers are identified when clicking on a link                                                                                                                                                                                                                                   |
| [s\_list\_shipment](./s-list-shipment)                    | A connector between shipment and list so that one shipment can have many lists, and one list can have many shipments                                                                                                                                                                                                                      |
| [s\_message](./s-message)                                 | A message used in a shipment. Can be html and/or plain text                                                                                                                                                                                                                                                                               |
| [s\_sent\_message](./s-sent-message)                      | Emarketeer message control                                                                                                                                                                                                                                                                                                                |
| [s\_shipment\_addr](./s-shipment-addr)                    | Addresses that are ready to be sent in a shipment.                                                                                                                                                                                                                                                                                        |
| [s\_smtp\_servers](./s-smtp-servers)                      | Contains the smtp server for a shipment                                                                                                                                                                                                                                                                                                   |
| [selection](./selection)                                  | Selections                                                                                                                                                                                                                                                                                                                                |
| [ShipmentType](./shipmenttype)                            | Shipment type list table. Classification of a mailing, allowing recipients to subscribe to lists                                                                                                                                                                                                                                          |
| [sms](./sms)                                              | This table will hold outgoing sms messages when transmitted with WebServices                                                                                                                                                                                                                                                              |

## Replication Flags

* None

## Security Flags

* No access control via user's Role.


## Related topics

- [s_shipment_addr table](/en/database/tables/s-shipment-addr.md)
- [s_bounce_shipment table](/en/database/tables/s-bounce-shipment.md)
- [s_list_shipment table](/en/database/tables/s-list-shipment.md)
- [ShipmentType table](/en/database/tables/shipmenttype.md)
- [What's new in version 10.2.6.1248](/release-notes/database/changes-10.2.6.md)
- [What's new in version 10.2.7.5452](/release-notes/database/changes-10.2.7.md)
