Freight charges
Expected, actual or adjustment charge for the freight of one shipment.
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Kind | kind | Constant | Yes | Fixed option from the allowed set for this field. |
| Day | date | Date | Yes | Calendar date for this value. |
| Shipment | logisticsshipmentId | Reference | Yes | |
| Carrier | carrierId | Reference | Yes | |
| Freight quote | logisticsfreightquoteId | Reference | ||
| Amount | amount | Currency | Yes | Monetary amount in the applicable currency for this record. |
| Quote currency | currency | Constant | Yes | Value from the table catalog for this field. |
| Description | description | Text Area | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Canceled by | canceledBy | User | ||
| Canceled at | canceledAt | Date and Time |
Relations
| Field | Points to | Kind |
|---|---|---|
Shipment logisticsshipmentId | Shipments | reference |
Carrier carrierId | Carriers | reference |
Freight quote logisticsfreightquoteId | Freight quotes | reference |
Actions
What you can do with a record. Every action also sends the webhook event logisticsfreightcharges.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Cancel | cancel | Cancel the freight charge when it is not billed. | App · WebMCP · API · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.