> ## Documentation Index
> Fetch the complete documentation index at: https://developer.jtl-software.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ShipPackage

> Ships a package by setting the shipping date.

If a request with this mutation's Idempotency-Key was already completed, the response's `extensions` contains an `idempotency.{responseName}` entry with `wasReplayed: true`.



**mutation** `ShipPackage(request: ShipPackageCommandRequestInput!): ShipPackageCommandResponse!`

## Arguments

**`request`**: `ShipPackageCommandRequestInput!` (required)

## Returns

`ShipPackageCommandResponse!`

**`package`**: `Package!`

The package that has been shipped successfully.

---

**`overwritten`**: `Boolean!`

Indicates whether existing shipping information for a package has been overwritten or not.

## Examples

```graphql Mutation
mutation ShipPackage($request: ShipPackageCommandRequestInput!) {
  ShipPackage(request: $request) {
    package {
      id
      deliveryNoteId
      weight
      shippingDate
      trackingNumber
    }
    overwritten
  }
}
```

```json Variables
{
  "request": {
    "packageId": "id"
  }
}
```

```json Response
{
  "data": {
    "ShipPackage": {
      "package": {
        "id": "id",
        "deliveryNoteId": "id",
        "weight": "value",
        "shippingDate": "value",
        "trackingNumber": "string"
      },
      "overwritten": true
    }
  }
}
```
