# TransferOrderShipmentsByTypeOrderId Gets the shipments of a single transfer order A transfer order with lines from several source warehouses has one shipment per source warehouse. Sample request: `GET /transferorders/TR/000100/shipment` ## Documentation A transfer order with lines from several source warehouses has one shipment per source warehouse. Sample request: `GET /transferorders/TR/000100/shipment` - Catalog: `NgSalesOrders` - Schema: `TransferOrders` This is a read-only table function. The Visma.net Financials API may not support changing the data or the Invantive UniversalSQL driver for Visma.net Financials does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Visma.net Financials API. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `TransferOrderShipmentsByTypeOrderId`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values. Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three. Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third. | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `orderId` | `` | ☑ | | The id of the transfer order | | `type` | `` | ☑ | | The transfer order type, `TR` or a custom order type derived from it | ## Columns of Table Function The columns of the table function `TransferOrderShipmentsByTypeOrderId` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `COMPANY_CODE` | `varchar2(30)` | Company Code | ☑ | Partition code, segmenting the data. | | `COMPANY_NAME` | `varchar2(240)` | Company Name | ☑ | Name of the partition. | | `date` | `datetime` | Date | ☐ | The date of the shipment | | `id` | `varchar2` | ID | ☐ | The id of the shipment | | `inventoryCorrectionDocumentType` | `varchar2` | | ☐ | The type of inventory correction document created for the shipment | | `inventoryCorrectionReferenceId` | `varchar2` | | ☐ | The id of the inventory correction document created for the shipment | | `inventoryDocumentType` | `varchar2` | | ☐ | The type of inventory document created for the shipment | | `inventoryReferenceId` | `varchar2` | | ☐ | The id of the inventory document created for the shipment | | `operation` | `varchar2` | Operation | ☐ | The operation of the shipment | | `quantity` | `double` | Quantity | ☐ | The quantity of goods on the shipment | | `sourceWarehouse_description` | `varchar2` | | ☐ | The description | | `sourceWarehouse_id` | `varchar2` | | ☐ | The id | | `status` | `varchar2` | Status | ☐ | The status of the shipment | | `type` | `varchar2` | Type | ☐ | The type of the shipment | | `volume` | `double` | | ☐ | The volume of the shipped goods | | `weight` | `double` | Weight | ☐ | The weight of the shipped goods |