---
title: "ShipmentByNumber (Visma.net Financials)"
description: "Shipments by Number"
language: en
source_language: en
translation_state: complete
canonical: https://documentation.invantive.eu/en/datamodels/vismanet/VismaNet.Shipment.ShipmentByNumber
original: https://documentation.invantive.eu/en/datamodels/vismanet/VismaNet.Shipment.ShipmentByNumber
updated: 2026-11-01T17:49:50Z
license: https://documentation.invantive.eu/en/
---

# ShipmentByNumber: Visma.net Financials Shipments by Number

`read only` `REST`

- Catalog: `VismaNet`
- Schema: `Shipment`
- Label: Shipments by Number

Get a specific Shipment
Data for a single Shipment. 
The response headers include an ETag after a successful GET operation.

Can only retrieve data.

## Summary

Data for a single Shipment. <br></br>
The response headers include an ETag after a successful GET operation.

## API Source

- Endpoint: `/v1/shipment/{shipmentNbr}`
- Operation: `get /v1/shipment/{shipmentNbr}`

## Performance Characteristics

| Characteristic | Value |
|---|---:|
| Average access latency (ms) | 155 |
| Full scan rows per minute | 29,100 |
| Point query rows per minute | 387 |

The result can be cached on the client.

## Parameters

| Name | Data Type | Required | Default | Documentation |
|---|---|:---:|---|---|
| `includeCustomFreeFields` | `` | [ ] |  | Optional parameter to request custom free fields. |
| `shipmentNbr` | `` | [x] |  | Identifies the Shipment |

## Table Columns

The columns of the table `ShipmentByNumber` are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|:---:|---|---|
| `COMPANY_CODE` | `varchar2(30)` | Company Code | [x] | writable | Partition code, segmenting the data. |
| `COMPANY_NAME` | `varchar2(240)` | Company Name | [x] | writable | Name of the partition. |
| `container` | `char` | itgen_vnet_container | [ ] | filters on the platform, writable, `container` | Delivery settings tab &gt; Intrastat section &gt; Container &gt; This check box indicates (if selected) that the shipment gets marked as shipped in container for Intrastat reporting purposes. |
| `controlQuantity` | `double` | Control Quantity | [ ] | filters on the platform, writable, `controlQuantity` | The top part &gt; Control quantity &gt; The control value, which you manually enter as a value equal to the shipped quantity if the Validate shipment total on confirmation check box has been selected in the Sales orders preferences (SO101000) window. |
| `currencyId` | `varchar2` | Currency ID | [ ] | filters on the platform, writable, `currencyId` | Delivery settings tab &gt; Freight currency &gt; By default, it is the currency of the sales order, but you can change it if needed. |
| `customDateTimeUTC1` | `datetime` | itgen_vnet_customdatetimeutc1 | [ ] | filters on the platform, writable, `customDateTimeUTC1` | A free custom colum of type DateTime - in UTC timezone |
| `customDec1` | `double` | itgen_vnet_customdec1 | [ ] | filters on the platform, writable, `customDec1` | A free custom colum of type decimal with max 4 decimals. |
| `customDec2` | `double` | itgen_vnet_customdec2 | [ ] | filters on the platform, writable, `customDec2` | A free custom colum of type decimal with max 4 decimals. |
| `customInt1` | `int32` | itgen_vnet_customint1 | [ ] | filters on the platform, writable, `customInt1` | A free custom colum of type int |
| `customInt2` | `int32` | itgen_vnet_customint2 | [ ] | filters on the platform, writable, `customInt2` | A free custom colum of type int |
| `customStr1` | `varchar2` | itgen_vnet_customstr1 | [ ] | filters on the platform, writable, `customStr1` | A free custom colum of type string with max length 100. |
| `customStr2` | `varchar2` | itgen_vnet_customstr2 | [ ] | filters on the platform, writable, `customStr2` | A free custom colum of type string with max length 100. |
| `customStr3` | `varchar2` | itgen_vnet_customstr3 | [ ] | filters on the platform, writable, `customStr3` | A free custom colum of type string with max length 100. |
| `customStr4` | `varchar2` | itgen_vnet_customstr4 | [ ] | filters on the platform, writable, `customStr4` | A free custom colum of type string with max length 100. |
| `customStr5` | `varchar2` | itgen_vnet_customstr5 | [ ] | filters on the platform, writable, `customStr5` | A free custom colum of type string with max length 100. |
| `customer_internalId` | `int32` | Customer Internal ID | [ ] | filters on the platform, writable, `customer.internalId` |  |
| `customer_name` | `varchar2` | Customer Name | [ ] | filters on the platform, writable, `customer.name` | The name of the particular destination of the selected type. |
| `customer_number` | `varchar2` | Customer Number | [ ] | filters on the platform, writable, `customer.number` | The identifier of the particular destination of the selected type. |
| `deliveryAddress_addressId` | `int32` | Delivery Address ID | [ ] | filters on the platform, writable, `deliveryAddress.addressId` |  |
| `deliveryAddress_addressLine1` | `varchar2` | Delivery Address Line 1 | [ ] | filters on the platform, writable, `deliveryAddress.addressLine1` | Address 1 &gt; The first line of the customer's/supplier's/company's/employee's contact address. |
| `deliveryAddress_addressLine2` | `varchar2` | Delivery Address Line 2 | [ ] | filters on the platform, writable, `deliveryAddress.addressLine2` | Address 2 &gt; The second line of the address. |
| `deliveryAddress_addressLine3` | `varchar2` | Delivery Address Line 3 | [ ] | filters on the platform, writable, `deliveryAddress.addressLine3` | Address 3 &gt; The third line of the address. |
| `deliveryAddress_city` | `varchar2` | Delivery Address City | [ ] | filters on the platform, writable, `deliveryAddress.city` | City &gt; The city. |
| `deliveryAddress_country_errorInfo` | `varchar2` | itgen_vnet_deliveryaddress_country_errorinfo | [ ] | filters on the platform, writable, `deliveryAddress.country.errorInfo` |  |
| `deliveryAddress_country_id` | `varchar2` | Delivery Address Country ID | [ ] | filters on the platform, writable, `deliveryAddress.country.id` | Mandatory field: Country ID* &gt; The unique two-letter country ID according to international standard ISO 3166. |
| `deliveryAddress_country_metadata_maxPageSize` | `int64` | itgen_vnet_deliveryaddress_country_metadata_maxpagesize | [ ] | filters on the platform, writable, `deliveryAddress.country.metadata.maxPageSize` |  |
| `deliveryAddress_country_metadata_totalCount` | `int64` | itgen_vnet_deliveryaddress_country_metadata_totalcount | [ ] | filters on the platform, writable, `deliveryAddress.country.metadata.totalCount` |  |
| `deliveryAddress_country_name` | `varchar2` | Delivery Address Country Name | [ ] | filters on the platform, writable, `deliveryAddress.country.name` | Mandatory field: Country name* &gt; The complete name of the country. |
| `deliveryAddress_county_id` | `varchar2` | Delivery Address County ID | [ ] | filters on the platform, writable, `deliveryAddress.county.id` | Click the magnifier &gt; The identifier |
| `deliveryAddress_county_name` | `varchar2` | Delivery Address County Name | [ ] | filters on the platform, writable, `deliveryAddress.county.name` | Click the magnifier &gt; The displayed name |
| `deliveryAddress_overrideAddress` | `char` | itgen_vnet_deliveryaddress_overrideaddress | [ ] | filters on the platform, writable, `deliveryAddress.overrideAddress` | Override address &gt; A check box that you select to not include the default address information and to type new address information. |
| `deliveryAddress_postalCode` | `varchar2` | Delivery Address Postal Code | [ ] | filters on the platform, writable, `deliveryAddress.postalCode` | Postcode &gt; The postcode. |
| `deliveryContact_attention` | `varchar2` | Delivery Contact Attention | [ ] | filters on the platform, writable, `deliveryContact.attention` | Attention &gt; The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person. |
| `deliveryContact_contactId` | `int32` | Delivery Contact ID | [ ] | filters on the platform, writable, `deliveryContact.contactId` |  |
| `deliveryContact_email` | `varchar2` | Delivery Contact Email Address | [ ] | filters on the platform, writable, `deliveryContact.email` | Email &gt; The email address of the customer/supplier/company as a business entity. |
| `deliveryContact_fax` | `varchar2` | Delivery Contact Fax | [ ] | filters on the platform, writable, `deliveryContact.fax` | Fax &gt; The fax number. |
| `deliveryContact_name` | `varchar2` | Delivery Contact Name | [ ] | filters on the platform, writable, `deliveryContact.name` | Name &gt; The legal name of to appear on the documents. |
| `deliveryContact_overrideContact` | `char` | itgen_vnet_deliverycontact_overridecontact | [ ] | filters on the platform, writable, `deliveryContact.overrideContact` | Override contact &gt; A check box that you select to not use+ the default contact information and to type new contact information. |
| `deliveryContact_phone1` | `varchar2` | Delivery Contact Phone 1 | [ ] | filters on the platform, writable, `deliveryContact.phone1` | Phone 1 &gt; The default phone number. |
| `deliveryContact_phone2` | `varchar2` | Delivery Contact Phone 2 | [ ] | filters on the platform, writable, `deliveryContact.phone2` | Phone 2 &gt; An additional phone number. |
| `deliveryContact_web` | `varchar2` | Delivery Contact Website | [ ] | filters on the platform, writable, `deliveryContact.web` | Web &gt; The website of the company, if one exists. |
| `errorInfo` | `varchar2` | Error Message | [ ] | filters on the platform, writable, `errorInfo` |  |
| `fobPoint_description` | `varchar2` | FOB Point Description | [ ] | filters on the platform, writable, `fobPoint.description` | Click on the magnifier. &gt; The description. |
| `fobPoint_id` | `varchar2` | FOB Point ID | [ ] | filters on the platform, writable, `fobPoint.id` | Click on the magnifier. &gt; The identifier. |
| `freightAmt` | `double` | itgen_vnet_freightamt | [ ] | filters on the platform, writable, `freightAmt` | Delivery settings tab &gt; Shipping information section &gt; Freight amt. &gt; The amount of freight the customer will be charged for the shipment in base currency. |
| `freightCost` | `double` | itgen_vnet_freightcost | [ ] | filters on the platform, writable, `freightCost` | Delivery settings tab &gt; Shipping information section &gt; Freight cost &gt; The freight cost of the shipment in base currency. |
| `freightCurAmt` | `double` | itgen_vnet_freightcuramt | [ ] | filters on the platform, writable, `freightCurAmt` | Delivery settings tab &gt; Shipping information section &gt; Freight amt. &gt; The amount of freight the customer will be charged for the shipment in freight currency. |
| `freightCurCost` | `double` | itgen_vnet_freightcurcost | [ ] | filters on the platform, writable, `freightCurCost` | Delivery settings tab &gt; Shipping information section &gt; Freight cost &gt; The freight cost of the shipment in freight currency. |
| `fromWarehouse_description` | `varchar2` | itgen_vnet_fromwarehouse_description | [ ] | filters on the platform, writable, `fromWarehouse.description` | Click on the magnifier. &gt; The description. |
| `fromWarehouse_id` | `varchar2` | itgen_vnet_fromwarehouse_id | [ ] | filters on the platform, writable, `fromWarehouse.id` | Click on the magnifier. &gt; The identifier. |
| `hold` | `char` | Hold | [ ] | filters on the platform, writable, `hold` | The top part &gt; Hold &gt; This check box indicates (if selected) that the documents cannot be processed further until the check box is cleared. |
| `insurance` | `char` | Insurance | [ ] | filters on the platform, writable, `insurance` | Delivery settings tab &gt; Shipping information section &gt; Insurance &gt; This check box indicates (if selected) that insurance is required for the shipment. |
| `lastModifiedDateTime` | `datetime` | Last Modified | [ ] | filters on the platform, writable, `lastModifiedDateTime` | System generated information. |
| `location_countryId` | `varchar2` | Location Country ID | [ ] | filters on the platform, writable, `location.countryId` | Location*. |
| `location_id` | `varchar2` | Location ID | [ ] | filters on the platform, writable, `location.id` | Click the magnifier &gt; The identifier |
| `location_name` | `varchar2` | Location Name | [ ] | filters on the platform, writable, `location.name` | Click the magnifier &gt; The displayed name |
| `metadata_maxPageSize` | `int64` | Metadata Max Pagesize | [ ] | filters on the platform, writable, `metadata.maxPageSize` |  |
| `metadata_totalCount` | `int64` | Total Count | [ ] | filters on the platform, writable, `metadata.totalCount` |  |
| `modeOfTrasport_description` | `varchar2` | itgen_vnet_modeoftrasport_description | [ ] | filters on the platform, writable, `modeOfTrasport.description` | Click on the magnifier. &gt; The description. |
| `modeOfTrasport_id` | `int32` | itgen_vnet_modeoftrasport_id | [ ] | filters on the platform, writable, `modeOfTrasport.id` | Click on the magnifier. &gt; The identifier. |
| `note` | `varchar2` | Note | [ ] | filters on the platform, writable, `note` |  |
| `operation` | `varchar2` | Operation | [ ] | filters on the platform, writable, `operation` | The top part &gt; Operation &gt; The operation to be performed in the Inventory workspace for this shipment: Issue or Receipt. |
| `owner_id` | `guid` | Owner ID | [ ] | filters on the platform, writable, `owner.id` | Click the magnifier &gt; The identifier |
| `owner_name` | `varchar2` | Owner Name | [ ] | filters on the platform, writable, `owner.name` | Click the magnifier &gt; The displayed name |
| `packages` | `int32` | Packages | [ ] | filters on the platform, writable, `packages` | The top part &gt; Packages &gt; The number of boxes included in this shipment. |
| `packagesVolume` | `double` | itgen_vnet_packagesvolume | [ ] | filters on the platform, writable, `packagesVolume` | The top part &gt; Package volume &gt; The total volume of the shipment that includes the volume of boxes (for boxes determined automatically). |
| `packagesWeight` | `double` | Packages Weight | [ ] | filters on the platform, writable, `packagesWeight` | The top part &gt; Package weight &gt; The total weight of the shipment that includes the weight of boxes (for boxes determined automatically). |
| `residentialDelivery` | `char` | Residential Delivery | [ ] | filters on the platform, writable, `residentialDelivery` | Delivery settings tab &gt; Shipping information section &gt; Residential delivery &gt; This check box indicates (if selected) that the shipping address is a residential one. |
| `saturdayDelivery` | `char` | Saturday Delivery | [ ] | filters on the platform, writable, `saturdayDelivery` | Delivery settings tab &gt; Shipping information section &gt; Saturday delivery &gt; This check box indicates delivery on saturday. |
| `shipVia_description` | `varchar2` | Ship via Description | [ ] | filters on the platform, writable, `shipVia.description` | Click on the magnifier. &gt; The description. |
| `shipVia_id` | `varchar2` | Ship via ID | [ ] | filters on the platform, writable, `shipVia.id` | Click on the magnifier. &gt; The identifier. |
| `shipmentDate` | `datetime` | Shipment Date | [ ] | filters on the platform, writable, `shipmentDate` | Mandatory field: The top part &gt; Shipment date* &gt; The date when the document has been created. |
| `shipmentNumber` | `varchar2` | Shipment Number | [ ] | filters on the platform, writable, `shipmentNumber` | The top part &gt; Shipment no &gt; The unique reference number of the document, which is automatically generated by the system. |
| `shipmentType` | `varchar2` | Shipment Type | [ ] | filters on the platform, writable, `shipmentType` | The top part &gt; Type &gt; The type of the shipment document, which can be one of the following options: Shipment, Transfer. |
| `shippedQuantity` | `double` | itgen_vnet_shippedquantity | [ ] | filters on the platform, writable, `shippedQuantity` | The top part &gt; Shipped quantity &gt; The quantity of goods shipped. |
| `shippedVolume` | `double` | Shipped Volume | [ ] | filters on the platform, writable, `shippedVolume` | The top part &gt; Shipped volume &gt; The total volume of the items in the shipment. |
| `shippedWeight` | `double` | Shipped Weight | [ ] | filters on the platform, writable, `shippedWeight` | The top part &gt; Shipped weight &gt; The weight of the goods shipped. |
| `shippingTerms_description` | `varchar2` | Shipping Terms Description | [ ] | filters on the platform, writable, `shippingTerms.description` | Click on the magnifier. &gt; The description. |
| `shippingTerms_id` | `varchar2` | Shipping Terms ID | [ ] | filters on the platform, writable, `shippingTerms.id` | Click on the magnifier. &gt; The identifier. |
| `shippingZone_description` | `varchar2` | Shipping Zone Description | [ ] | filters on the platform, writable, `shippingZone.description` | Click on the magnifier. &gt; The description. |
| `shippingZone_id` | `varchar2` | Shipping Zone ID | [ ] | filters on the platform, writable, `shippingZone.id` | Click on the magnifier. &gt; The identifier. |
| `status` | `varchar2` | Status | [ ] | filters on the platform, writable, `status` | The top part &gt; Status &gt; The status of the document. |
| `timeStamp` | `blob` | Timestamp | [ ] | filters on the platform, writable, `timeStamp` |  |
| `toWarehouse_description` | `varchar2` | To Warehouse Description | [ ] | filters on the platform, writable, `toWarehouse.description` | Click on the magnifier. &gt; The description. |
| `toWarehouse_id` | `varchar2` | To Warehouse ID | [ ] | filters on the platform, writable, `toWarehouse.id` | Click on the magnifier. &gt; The identifier. |
| `transactionType_description` | `varchar2` | Transaction Type Description | [ ] | filters on the platform, writable, `transactionType.description` | Click on the magnifier. &gt; The description. |
| `transactionType_id` | `int32` | Transaction Type ID | [ ] | filters on the platform, writable, `transactionType.id` | Click on the magnifier. &gt; The identifier. |
| `useCustomerAccount` | `char` | itgen_vnet_usecustomeraccount | [ ] | filters on the platform, writable, `useCustomerAccount` |  |



## Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver:

- [Visma.net Financials](/en/release-notes/drivers?driver=visma-net-financials)

