# Shipments Lists shipments that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object. ## Documentation Lists shipments that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object. - Catalog: `Magento` - Schema: `Sales` - Primary Keys: `entity_id` This is a read-only table function. The Magento API may not support changing the data or the Invantive UniversalSQL driver for Magento does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Magento API. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `Shipments`. 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 | |---|:---:|:---:|:---:|---| | `searchCriteria[currentPage]` | `` | ☐ | | Current page. | | `searchCriteria[filterGroups][0][filters][0][conditionType]` | `` | ☐ | | Condition type | | `searchCriteria[filterGroups][0][filters][0][field]` | `` | ☐ | | Field | | `searchCriteria[filterGroups][0][filters][0][value]` | `` | ☐ | | Value | | `searchCriteria[pageSize]` | `` | ☐ | | Page size. | | `searchCriteria[sortOrders][0][direction]` | `` | ☐ | | Sorting direction. | | `searchCriteria[sortOrders][0][field]` | `` | ☐ | | Sorting field. | ## Columns of Table Function The columns of the table function `Shipments` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `billing_address_id` | `int64` | | ☐ | Billing address ID. | | `created_at` | `varchar2` | | ☐ | Created-at timestamp. | | `customer_id` | `int64` | | ☐ | Customer ID. | | `email_sent` | `int64` | | ☐ | Email-sent flag value. | | `entity_id` | `int64` | | ☐ | Shipment ID. | | `extension_attributes_source_code` | `varchar2` | | ☐ | | | `increment_id` | `varchar2` | | ☐ | Increment ID. | | `order_id` | `int64` | | ☐ | Order ID. | | `shipment_status` | `int64` | | ☐ | Shipment status. | | `shipping_address_id` | `int64` | | ☐ | Shipping address ID. | | `shipping_label` | `varchar2` | | ☐ | Shipping label. | | `store_id` | `int64` | | ☐ | Store ID. | | `total_qty` | `decimal` | | ☐ | Total quantity. | | `total_weight` | `decimal` | | ☐ | Total weight. | | `updated_at` | `varchar2` | | ☐ | Updated-at timestamp. |