## Input objects

GraphQL operations might accept arguments to configure their behavior. These arguments are often scalars or enums, but they sometimes need to represent more complex values.

To configure fields with complex values, we use input objects. Input objects are objects used as arguments.




```json+Sample Input Object
{
    organisationId: "org-1"
}

```

OrderFilterInput

The unique identifier of the organization.

### OrderFilterInput

Specifies the orders to be retrieved when using the ```orders``` query.

```json+Sample Input Object
{
    "filter": {
        "payloadTypes": [
            "S3_KEYPATH",
            "EMAIL_NOTIFICATION",
            "SIMPLE_MESSAGE",
            "FIELD_UPDATED"
        ]
    }
}
```

OrderTimelineFilterInput

The list of payload types to be retrieved.

### OrderTimelineFilterInput

Specifies the type of order updates to be retrieved when querying the ```history``` field in the ```Order``` object.

```json+Sample Input Object
{
    "comment": "Order paid. Package shipped.",
    "orderId": "e97cebe4-72a8-4d5c-a3f4-90095cehc1de",
    "shippingStatus": "SHIPPED",
    "paymentStatus": "PAID",
    "isHiddenFromUsers": false
}
```

UpdateOrderInput

The new content for the comment associated with the order. Overwrites the current comment.

The new shipping status for the order. Overwrites the current shipping status.

The new payment status for the order. Overwrites the current payment status.

Whether the update is visible to the customer or not.

### UpdateOrderInput

Specifies the information to be updated on an order when using the ```updatedOrder``` mutation.

```json+Sample Input Object
{
    "metadata": {
        "shippingStatus": "DELIVERED",
        "updatedBy": "John Doe",
        "internalOrderNumber": "10"
    },
    "orderId": "e97cebe4-72a8-4d5c-a3f4-90095cefc1ce"
}
```

UpdateOrderMetadataInput

The new metafields to add to the existing ```meta``` object for the order. Must be an object with string values.

### UpdateOrderMetadataInput

Specifies the information to be updated on an order when using the ```updateOrderMetadata``` mutation.

Reference

Guides

Input objects

OrderFilterInput

OrderTimelineFilterInput

UpdateOrderInput

UpdateOrderMetadataInput