---
title: "Dynamic Ship – Codeunit Dynamic Ship Freight Quote Management"
app: "Dynamic Ship"
section: "Developer"
last_updated: "2024-04-25"
url: "https://insight-works.com/kb/dynamic-ship/dynamic-ship-codeunit-dynamic-ship-freight-quote-management/"
---

# Dynamic Ship – Codeunit Dynamic Ship Freight Quote Management

These are signatures available for codeunit_DSHIP Freight Quote Management_ .

### Parameters

| **Name** | **Value** |
| --- | --- |
| ID | 23044605 |

### Methods

#### GetFreightQuotesExternal

Allows the retrieval of freight quote rates based on a sales header and a buffer of packages.

```
procedure GetFreightQuotesExternal(var salesHeader: Record "Sales Header", var salesLine: Record "Sales Line", var lpHeaderBuffer: Record "IWX LP Header" temporary, var shipmentOptions: Record "DSHIP Shipment Options", var packageOptions: Record "DSHIP Package Options", var rateBuffer: Record "DSHIP Carrier Rate Buffer" temporary, var shipMessageBuffer: Record "DSHIP Shipment Message Buffer" temporary): Text
```

**Parameters**

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| salesHeader | Record “Sales Header” | A real or temporary sales header that contains the destination address in the ship-to fields and a location code. Optional: the customer number, campaign no, amount, and shipping agent and service. If the customer number, campaign, amount, or shipping agent and service is provided, it is used for customer options and freight prices. The shipping agent is used to limit rate shopping. |
| salesLine | Record “Sales Line” | Optional. A filtered set of real records or an inserted set of temp records. When a non-empty set is provided, triggers event OnGetFreightQuotesExternalSalesLine. |
| lpHeaderBuffer | Record “IWX LP Header” temporary | A temporary set of License Plate Headers. If this is not populated, then OnGetFreightQuotesExternalSalesLine must be handled to create it. |
| shipmentOptions | Record “DSHIP Shipment Options” | Optional. A real or temporary shipment options record to use for quoting. Note that most options do not affect quoting. |
| packageOptions | Record “DSHIP Package Options” | Optional. A real or temporary package options record to use for quoting. Most options do not affect quoting. |
| rateBuffer | Record “DSHIP Carrier Rate Buffer” temporary | Any carrier returned rates. |
| shipMessageBuffer | Record “DSHIP Shipment Message Buffer” temporary | Any carrier returned messages. |

**Returns**

| **Type** | **Description** |
| --- | --- |
| Text | Blank if no errors were encountered; otherwise, text containing them. |

 Note: The location code, customer number, and shipping agent must refer to real Business Central data when supplied.

#### GetFreightQuotesExternal

Allows the retrieval of freight quote rates based on a sales header and a buffer of packages.

```
procedure GetFreightQuotesExternal(var salesHeader: Record "Sales Header", var salesLine: Record "Sales Line", var lpHeaderBuffer: Record "IWX LP Header" temporary, var rateBuffer: Record "DSHIP Carrier Rate Buffer" temporary, var shipMessageBuffer: Record "DSHIP Shipment Message Buffer" temporary): Text
```

**Parameters**

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| salesHeader | Record “Sales Header” | A real or temporary sales header that contains the destination address in the ship-to fields and a location code. Optional: the customer number, campaign no, amount, and shipping agent and service. If the customer number, campaign, amount, or shipping agent and service is provided, it is used for customer options and freight prices. The shipping agent is used to limit rate shopping. |
| salesLine | Record “Sales Line” | Optional. A filtered set of real records or an inserted set of temp records. When a non-empty set is provided, triggers event OnGetFreightQuotesExternalSalesLine. |
| lpHeaderBuffer | Record “IWX LP Header” temporary | A temporary set of License Plate Headers. If this is not populated, then OnGetFreightQuotesExternalSalesLine must be handled to create it. |
| shipmentOptions | Record “DSHIP Shipment Options” | Optional. A real or temporary shipment options record to use for quoting. Note that most options do not affect quoting. |
| packageOptions | Record “DSHIP Package Options” | Optional. A real or temporary package options record to use for quoting. Most options do not affect quoting. |
| rateBuffer | Record “DSHIP Carrier Rate Buffer” temporary | Any carrier returned rates. |
| shipMessageBuffer | Record “DSHIP Shipment Message Buffer” temporary | Any carrier returned messages. |

**Returns**

| **Type** | **Description** |
| --- | --- |
| Text | Blank if no errors were encountered; otherwise, text containing them. |

 Note: The location code, customer number, and shipping agent must refer to real Business Central data when supplied.

#### GetFreightQuotesExternal

Allows the retrieval of freight quote rates based on a sales header and a buffer of packages.

```
procedure GetFreightQuotesExternal(var salesHeader: Record "Sales Header", var lpHeaderBuffer: Record "IWX LP Header" temporary, var shipmentOptions: Record "DSHIP Shipment Options", var packageOptions: Record "DSHIP Package Options", var rateBuffer: Record "DSHIP Carrier Rate Buffer" temporary, var shipMessageBuffer: Record "DSHIP Shipment Message Buffer" temporary): Text
```

**Parameters**

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| salesHeader | Record “Sales Header” | A real or temporary sales header that contains the destination address in the ship-to fields and a location code. Optional: the customer number, campaign no, amount, and shipping agent and service. If the customer number, campaign, amount, or shipping agent and service is provided it is used for customer options and freight prices. The shipping agent is used to limit rate shopping. |
| lpHeaderBuffer | Record “IWX LP Header” temporary | A temporary set of License Plate Headers. |
| shipmentOptions | Record “DSHIP Shipment Options” | Optional. A real or temporary shipment options record to use for quoting. Note that most options do not affect quoting. |
| packageOptions | Record “DSHIP Package Options” | Optional. A real or temporary package options record to use for quoting. Note that most options do not affect quoting. |
| rateBuffer | Record “DSHIP Carrier Rate Buffer” temporary | Any carrier returned rates. |
| shipMessageBuffer | Record “DSHIP Shipment Message Buffer” temporary | Any carrier returned messages. |

**Returns**

| **Type** | **Description** |
| --- | --- |
| Text | Blank if no errors were encountered; otherwise, text containing them. |

 Note: The location code, customer number, and shipping agent must refer to real Business Central data when supplied.

#### GetFreightQuotesExternal

Allows the retrieval of freight quote rates based on a sales header and a buffer of packages.

```
procedure GetFreightQuotesExternal(var salesHeader: Record "Sales Header", var lpHeaderBuffer: Record "IWX LP Header" temporary, var rateBuffer: Record "DSHIP Carrier Rate Buffer" temporary, var shipMessageBuffer: Record "DSHIP Shipment Message Buffer" temporary): Text
```

**Parameters**

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| salesHeader | Record “Sales Header” | A real or temporary sales header that contains the destination address in the ship-to fields and a location code. Optional: the customer number, campaign no, amount, and shipping agent and service. If the customer number, campaign, amount, or shipping agent and service is provided it is used for customer options and freight prices. The shipping agent is used to limit rate shopping. |
| lpHeaderBuffer | Record “IWX LP Header” temporary | A temporary set of License Plate Headers. |
| rateBuffer | Record “DSHIP Carrier Rate Buffer” temporary | Any carrier returned rates. |
| shipMessageBuffer | Record “DSHIP Shipment Message Buffer” temporary | Any carrier returned messages. |

**Returns**

| **Type** | **Description** |
| --- | --- |
| Text | Blank if no errors were encountered; otherwise, text containing them. |

 Note: The location code, customer number, and shipping agent must refer to real Business Central data when supplied.

#### GetFreightQuotesExternal

Allows the retrieval of freight quote rates based on a sales header and a count of packages using a template.

```
procedure GetFreightQuotesExternal(var salesHeader: Record "Sales Header", packageTemplateCode: Code[50], packageCount: Integer, packageWeight: Decimal, packageWeightUom: Code[50], var shipmentOptions: Record "DSHIP Shipment Options", var packageOptions: Record "DSHIP Package Options", var rateBuffer: Record "DSHIP Carrier Rate Buffer" temporary, var shipMessageBuffer: Record "DSHIP Shipment Message Buffer" temporary): Text
```

**Parameters**

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| salesHeader | Record “Sales Header” | A real or temporary sales header that contains the destination address in the ship-to fields and a location code. Optional: the customer number, campaign no, amount, and shipping agent and service. If the customer number, campaign, amount, or shipping agent and service is provided it is used for customer options and freight prices. The shipping agent is used to limit rate shopping. |
| packageTemplateCode | Code[50] | A License Plate Template Code with shipment dimensions defined. |
| packageCount | Integer | The number of packages to create from the template. |
| packageWeight | Decimal | The weight of each package. |
| packageWeightUom | Code[50] | The unit of measure used for the weight. |
| shipmentOptions | Record “DSHIP Shipment Options” | Optional. A real or temporary shipment options record to use for quoting. Note that most options do not affect quoting. |
| packageOptions | Record “DSHIP Package Options” | Optional. A real or temporary package options record to use for quoting. Note that most options do not affect quoting. |
| rateBuffer | Record “DSHIP Carrier Rate Buffer” temporary | Any carrier returned rates. |
| shipMessageBuffer | Record “DSHIP Shipment Message Buffer” temporary | Any carrier returned messages. |

**Returns**

| **Type** | **Description** |
| --- | --- |
| Text | Blank if no errors were encountered; otherwise, text containing them. |

 Note: The location code, customer number, and shipping agent must refer to real Business Central data when supplied.

#### GetFreightQuotesExternal

Allows the retrieval of freight quote rates based on a sales header and a count of packages using a template.

```
procedure GetFreightQuotesExternal(var salesHeader: Record "Sales Header", packageTemplateCode: Code[50], packageCount: Integer, packageWeight: Decimal, packageWeightUom: Code[50], var rateBuffer: Record "DSHIP Carrier Rate Buffer" temporary, var shipMessageBuffer: Record "DSHIP Shipment Message Buffer" temporary): Text
```

**Parameters**

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| salesHeader | Record “Sales Header” | A real or temporary sales header that contains the destination address in the ship-to fields and a location code. Optional: the customer number, campaign no, amount, and shipping agent and service. If the customer number, campaign, amount, or shipping agent and service is provided it is used for customer options and freight prices. The shipping agent is used to limit rate shopping. |
| packageTemplateCode | Code[50] | A License Plate Template Code with shipment dimensions defined. |
| packageCount | Integer | The number of packages to create from the template. |
| packageWeight | Decimal | The weight of each package. |
| packageWeightUom | Code[50] | The unit of measure used for the weight. |
| rateBuffer | Record “DSHIP Carrier Rate Buffer” temporary | Any carrier returned rates. |
| shipMessageBuffer | Record “DSHIP Shipment Message Buffer” temporary | Any carrier returned messages. |

**Returns**

| **Type** | **Description** |
| --- | --- |
| Text | Blank if no errors were encountered; otherwise, text containing them. |

 Note: The location code, customer number, and shipping agent must refer to real Business Central data when supplied.

#### GetFreightQuotesExternal

Allows the retrieval of freight quote rates based on a destination address, a location, and a buffer of packages.

```
procedure GetFreightQuotesExternal(destinationAddress: Record "DSHIP Address Buffer" temporary, location: Code[50], var lpHeaderBuffer: Record "IWX LP Header" temporary, var shipmentOptions: Record "DSHIP Shipment Options", var packageOptions: Record "DSHIP Package Options", var rateBuffer: Record "DSHIP Carrier Rate Buffer" temporary, var shipMessageBuffer: Record "DSHIP Shipment Message Buffer" temporary): Text
```

**Parameters**

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| destinationAddress | Record “DSHIP Address Buffer” temporary | The destination address to quote for. |
| location | Code[50] | The location to use as an origin address. Must refer to a real Business Central location. |
| lpHeaderBuffer | Record “IWX LP Header” temporary | A temporary set of License Plate Headers. |
| shipmentOptions | Record “DSHIP Shipment Options” | Optional. A real or temporary shipment options record to use for quoting. Note that most options do not affect quoting. |
| packageOptions | Record “DSHIP Package Options” | Optional. A real or temporary package options record to use for quoting. Note that most options do not affect quoting. |
| rateBuffer | Record “DSHIP Carrier Rate Buffer” temporary | Any carrier returned rates. |
| shipMessageBuffer | Record “DSHIP Shipment Message Buffer” temporary | Any carrier returned messages. |

**Returns**

| **Type** | **Description** |
| --- | --- |
| Text | Blank if no errors were encountered; otherwise, text containing them. |

#### GetFreightQuotesExternal

Allows the retrieval of freight quote rates based on a destination address, a location, and a buffer of packages.

```
procedure GetFreightQuotesExternal(destinationAddress: Record "DSHIP Address Buffer" temporary, location: Code[50], var lpHeaderBuffer: Record "IWX LP Header" temporary, var rateBuffer: Record "DSHIP Carrier Rate Buffer" temporary, var shipMessageBuffer: Record "DSHIP Shipment Message Buffer" temporary): Text
```

**Parameters**

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| destinationAddress | Record “DSHIP Address Buffer” temporary | The destination address to quote for. |
| location | Code[50] | The location to use as an origin address. Must refer to a real Business Central location. |
| lpHeaderBuffer | Record “IWX LP Header” temporary | A temporary set of License Plate Headers. |
| rateBuffer | Record “DSHIP Carrier Rate Buffer” temporary | Any carrier returned rates. |
| shipMessageBuffer | Record “DSHIP Shipment Message Buffer” temporary | Any carrier returned messages. |

**Returns**

| **Type** | **Description** |
| --- | --- |
| Text | Blank if no errors were encountered; otherwise, text containing them. |

#### GetFreightQuotesExternal

Allows the retrieval of freight quote rates based on a destination address, a location, and a buffer of packages.

```
procedure GetFreightQuotesExternal(destinationAddress: Record "DSHIP Address Buffer" temporary, location: Code[50], packageTemplateCode: Code[50], packageCount: Integer, packageWeight: Decimal, packageWeightUom: Code[50], var shipmentOptions: Record "DSHIP Shipment Options", var packageOptions: Record "DSHIP Package Options", var rateBuffer: Record "DSHIP Carrier Rate Buffer" temporary, var shipMessageBuffer: Record "DSHIP Shipment Message Buffer" temporary): Text
```

**Parameters**

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| destinationAddress | Record “DSHIP Address Buffer” temporary | The destination address to quote for. |
| location | Code[50] | The location to use as an origin address. Must refer to a real Business Central location. |
| packageTemplateCode | Code[50] | A License Plate Template Code with shipment dimensions defined. |
| packageCount | Integer | The number of packages to create from the template. |
| packageWeight | Decimal | The weight of each package. |
| packageWeightUom | Code[50] | The unit of measure used for the weight. |
| shipmentOptions | Record “DSHIP Shipment Options” | Optional. A real or temporary shipment options record to use for quoting. Note that most options do not affect quoting. |
| packageOptions | Record “DSHIP Package Options” | Optional. A real or temporary package options record to use for quoting. Note that most options do not affect quoting. |
| rateBuffer | Record “DSHIP Carrier Rate Buffer” temporary | Any carrier returned rates. |
| shipMessageBuffer | Record “DSHIP Shipment Message Buffer” temporary | Any carrier returned messages. |

**Returns**

| **Type** | **Description** |
| --- | --- |
| Text | Blank if no errors were encountered; otherwise, text containing them. |

#### GetFreightQuotesExternal

Allows the retrieval of freight quote rates based on a destination address, a location, and a buffer of packages.

```
procedure GetFreightQuotesExternal(destinationAddress: Record "DSHIP Address Buffer" temporary, location: Code[50], packageTemplateCode: Code[50], packageCount: Integer, packageWeight: Decimal, packageWeightUom: Code[50], var rateBuffer: Record "DSHIP Carrier Rate Buffer" temporary, var shipMessageBuffer: Record "DSHIP Shipment Message Buffer" temporary): Text
```

**Parameters**

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| destinationAddress | Record “DSHIP Address Buffer” temporary | The destination address to quote for. |
| location | Code[50] | The location to use as an origin address. Must refer to a real Business Central location. |
| packageTemplateCode | Code[50] | A License Plate Template Code with shipment dimensions defined. |
| packageCount | Integer | The number of packages to create from the template. |
| packageWeight | Decimal | The weight of each package. |
| packageWeightUom | Code[50] | The unit of measure used for the weight. |
| rateBuffer | Record “DSHIP Carrier Rate Buffer” temporary | Any carrier returned rates. |
| shipMessageBuffer | Record “DSHIP Shipment Message Buffer” temporary | Any carrier returned messages. |

**Returns**

| **Type** | **Description** |
| --- | --- |
| Text | Blank if no errors were encountered; otherwise, text containing them. |
