> ## 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.

# ShippingRun

> A shipping run: many sales orders delivered in one go.



**Kind**: `object`

## Fields

**`id`**: `UUID!`

The ID of the shipping run.

---

**`status`**: `ShippingRunStatus!`

Where the run stands.

---

**`allowPartialDelivery`**: `Boolean!`

Whether sales orders that are only partially deliverable were delivered partially.

---

**`createShippingLabels`**: `Boolean!`

Whether labels were requested for the new packages.

---

**`markAsShipped`**: `Boolean!`

Whether the new packages were marked as shipped.

---

**`totalCount`**: `Int!`

How many sales orders the run contains.

---

**`deliveredCount`**: `Int!`

How many were delivered.

---

**`skippedCount`**: `Int!`

How many were skipped because they are blocked or not deliverable.

---

**`failedCount`**: `Int!`

How many were not delivered because the delivery failed.

---

**`labelFailedCount`**: `Int!`

How many delivered sales orders have at least one package without a label although labels were requested.

---

**`requestedAt`**: `DateTime!`

When the run was accepted.

---

**`requestedBy`**: `ID`

The user who started the run.

---

**`finishedAt`**: `DateTime`

When the run ended. Absent while it is queued or running.

---

**`failureCode`**: `String`

The error code when the run failed.