# shipment

This document is auto-generated from the JSDoc comments in `src/store` by running `npm run api-doc`.

## `shipment.create`

*Source: `src/store/shipment/create.js`*

Creates a new shipment manifest for an order. Validates that all article positions belong to the order and do not exceed remaining ordered quantities.

**Parameters**

| Name | Type | Description |
| --- | --- | --- |
| `provider` | `import('../../providers/provider.js').DatabaseProvider` |  |

## `shipment.delete`

*Source: `src/store/shipment/delete.js`*

Deletes a shipment manifest of the selected company. Shipped shipments (with packages in 'shipped' state) cannot be deleted.

**Parameters**

| Name | Type | Description |
| --- | --- | --- |
| `provider` | `import('../../providers/provider.js').DatabaseProvider` |  |

## `shipment.getById`

*Source: `src/store/shipment/getById.js`*

Retrieves a shipment manifest by ID for the selected company, including lines and packages.

**Parameters**

| Name | Type | Description |
| --- | --- | --- |
| `provider` | `import('../../providers/provider.js').DatabaseProvider` |  |

## `shipment.listByOrderId`

*Source: `src/store/shipment/listByOrderId.js`*

Lists all shipment manifests belonging to an order.

**Parameters**

| Name | Type | Description |
| --- | --- | --- |
| `provider` | `import('../../providers/provider.js').DatabaseProvider` |  |