> For the complete documentation index, see [llms.txt](https://docs.pyck.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pyck.cloud/graphql-api/mutations/createpickingoutboundshipmentnotification.md).

# Create Picking Outbound Shipment Notification

createPickingOutboundShipmentNotification Mutation

Audience: Programmer

Creates a new `PickingOutboundShipmentNotification` linked to an existing picking order. Outbound shipment notifications allow downstream consumers to react when an outbound shipment completes.

## Arguments

| Name    | Type                                              | Description                              |
| ------- | ------------------------------------------------- | ---------------------------------------- |
| `input` | `CreatePickingOutboundShipmentNotificationInput!` | Input data for creating the notification |

## Return Type

`PickingOutboundShipmentNotificationOutput` - Contains the created notification and any associated workflows.

## Input Fields

`CreatePickingOutboundShipmentNotificationInput`:

| Field          | Type     | Description                                        |
| -------------- | -------- | -------------------------------------------------- |
| `dataTypeID`   | `UUID`   | Optional data type ID for custom validation        |
| `dataTypeSlug` | `String` | Optional data type slug for custom validation      |
| `data`         | `Map`    | Custom JSONB data associated with the notification |
| `orderID`      | `ID!`    | Required ID of the parent picking order            |

## Response Fields

`PickingOutboundShipmentNotificationOutput`:

| Field                                 | Type                                  | Description                             |
| ------------------------------------- | ------------------------------------- | --------------------------------------- |
| `pickingOutboundShipmentNotification` | `PickingOutboundShipmentNotification` | The created notification                |
| `workflows`                           | `[TemporalWorkflow]`                  | Any workflows triggered by the creation |

## Usage Example

```graphql
mutation {
  createPickingOutboundShipmentNotification(
    input: {
      orderID: "550e8400-e29b-41d4-a716-446655440000",
      data: {
        "carrier": "DHL",
        "tracking_number": "TRK987654321",
        "shipped_at": "2026-04-10T10:30:00Z",
        "notes": "Express delivery"
      }
    }
  ) {
    pickingOutboundShipmentNotification {
      id
      tenantID
      orderID
      data
      createdAt
      createdBy
      order {
        id
        customerID
      }
    }
    workflows {
      id
      type
      runID
      status
    }
  }
}
```

## JavaScript Example

```javascript
const createMutation = `
  mutation CreatePickingOutboundShipmentNotification($input: CreatePickingOutboundShipmentNotificationInput!) {
    createPickingOutboundShipmentNotification(input: $input) {
      pickingOutboundShipmentNotification {
        id
        orderID
        data
        createdAt
      }
      workflows {
        id
        type
        runID
        status
      }
    }
  }
`;

const variables = {
  input: {
    orderID: "550e8400-e29b-41d4-a716-446655440000",
    data: {
      carrier: "DHL",
      tracking_number: "TRK987654321",
      shipped_at: "2026-04-10T10:30:00Z",
      notes: "Express delivery"
    }
  }
};

const response = await fetch('/graphql', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_TOKEN'
  },
  body: JSON.stringify({ query: createMutation, variables })
});

const result = await response.json();
console.log('Created notification:', result.data.createPickingOutboundShipmentNotification);
```

## Notes

* The parent picking order referenced by `orderID` must exist and be accessible to the current user.
* The `data` field is validated against the data type schema if `dataTypeID` or `dataTypeSlug` is provided.
* Creating a notification may trigger Temporal workflows for downstream consumers; inspect the `workflows` field in the response to track them.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pyck.cloud/graphql-api/mutations/createpickingoutboundshipmentnotification.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.