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

# FulfillmentGroupFilter

> Which fulfillment groups to include. Fields set side by side must all match; `and`, `or` and `not` nest up to 4 levels and 50 filters in all, and each `contains` counts as 5. A field a group doesn't have, such as a label that was never printed, counts as false or empty.

**addressVerified** `Boolean`

Whether the destination address was verified.

**and** `[\[FulfillmentGroupFilter!\]](/docs/api-reference/v3/reference/shipping/fulfillment-group-filter)`

Every one of these filters matches.

**assignee** `[IdFilter](/docs/api-reference/v3/reference/common/id-filter)`

The team member the group is assigned to, by `TeamMember.id`.

**fields**

**anyOf** `[ID!]`

One of these ids (at most 100).

**noneOf** `[ID!]`

None of these ids (at most 100).

**carrier** `[StringListFilter](/docs/api-reference/v3/reference/common/string-list-filter)`

The carrier of the group's selected rate, by carrier code (for example `USPS`, `UPS`, `FedEx`, `DHLExpress`). `USPS`, `UPS` and `FedEx` include their sub-services. A code that names no carrier matches nothing.

**fields**

**allOf** `[String!]`

Contains every one of these values (at most 100).

**anyOf** `[String!]`

Contains at least one of these values (at most 100).

**noneOf** `[String!]`

Contains none of these values (at most 100).

**createdAt** `[DateTimeFilter](/docs/api-reference/v3/reference/common/date-time-filter)`

When Redo created the group, as `FulfillmentGroup.createdAt` returns it.

**fields**

**gt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

After this instant.

**gte** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

At or after this instant.

**lt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

Before this instant.

**lte** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

At or before this instant.

**customFields** `[\[FulfillmentGroupCustomFieldFilter!\]](/docs/api-reference/v3/reference/shipping/fulfillment-group-custom-field-filter)`

Custom fields the store set up, by key, as `fulfillmentGroupCustomFields` lists them. Every one must match.

**fields**

**date** `[DateTimeFilter](/docs/api-reference/v3/reference/common/date-time-filter)`

For a DATE field.

**fields**

**gt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

After this instant.

**gte** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

At or after this instant.

**lt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

Before this instant.

**lte** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

At or before this instant.

**key** `String!` *required*

The metafield's `namespace.key`, or the attribute's name, as `fulfillmentGroupCustomFields` lists it.

**number** `[FloatFilter](/docs/api-reference/v3/reference/common/float-filter)`

For a NUMBER field.

**fields**

**gt** `Float`

Greater than this value.

**gte** `Float`

At least this value.

**lt** `Float`

Less than this value.

**lte** `Float`

At most this value.

**source** `[FulfillmentGroupCustomFieldSource!](/docs/api-reference/v3/reference/shipping/fulfillment-group-custom-field-source)` *required*

Where the field reads its value.

**text** `[StringListFilter](/docs/api-reference/v3/reference/common/string-list-filter)`

For a TEXT field.

**fields**

**allOf** `[String!]`

Contains every one of these values (at most 100).

**anyOf** `[String!]`

Contains at least one of these values (at most 100).

**noneOf** `[String!]`

Contains none of these values (at most 100).

**deliveryMethod** `[DeliveryMethodKindFilter](/docs/api-reference/v3/reference/common/delivery-method-kind-filter)`

How the group's orders are delivered.

**fields**

**allOf** `[\[DeliveryMethodKind!\]](/docs/api-reference/v3/reference/shipping/delivery-method-kind)`

Every one of these values.

**anyOf** `[\[DeliveryMethodKind!\]](/docs/api-reference/v3/reference/shipping/delivery-method-kind)`

One of these values.

**noneOf** `[\[DeliveryMethodKind!\]](/docs/api-reference/v3/reference/shipping/delivery-method-kind)`

None of these values.

**destinationCountryCode** `[StringListFilter](/docs/api-reference/v3/reference/common/string-list-filter)`

The ISO 3166-1 alpha-2 country code of the address the group ships to.

**fields**

**allOf** `[String!]`

Contains every one of these values (at most 100).

**anyOf** `[String!]`

Contains at least one of these values (at most 100).

**noneOf** `[String!]`

Contains none of these values (at most 100).

**fulfillBy** `[DateTimeFilter](/docs/api-reference/v3/reference/common/date-time-filter)`

When the group must ship by.

**fields**

**gt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

After this instant.

**gte** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

At or after this instant.

**lt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

Before this instant.

**lte** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

At or before this instant.

**fulfillerAccount** `[IdFilter](/docs/api-reference/v3/reference/common/id-filter)`

The account that ships the group, by account id.

**fields**

**anyOf** `[ID!]`

One of these ids (at most 100).

**noneOf** `[ID!]`

None of these ids (at most 100).

**itemQuantity** `[FloatFilter](/docs/api-reference/v3/reference/common/float-filter)`

How many items the group holds in all.

**fields**

**gt** `Float`

Greater than this value.

**gte** `Float`

At least this value.

**lt** `Float`

Less than this value.

**lte** `Float`

At most this value.

**labelPrinted** `Boolean`

Whether the group's shipping label was printed.

**labelPurchasedAt** `[DateTimeFilter](/docs/api-reference/v3/reference/common/date-time-filter)`

When the group's shipping label was bought.

**fields**

**gt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

After this instant.

**gte** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

At or after this instant.

**lt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

Before this instant.

**lte** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

At or before this instant.

**merchantAccount** `[IdFilter](/docs/api-reference/v3/reference/common/id-filter)`

The store that owns the group, by account id. Useful to a 3PL narrowing to one client.

**fields**

**anyOf** `[ID!]`

One of these ids (at most 100).

**noneOf** `[ID!]`

None of these ids (at most 100).

**not** `[FulfillmentGroupFilter](/docs/api-reference/v3/reference/shipping/fulfillment-group-filter)`

This filter does not match.

**or** `[\[FulfillmentGroupFilter!\]](/docs/api-reference/v3/reference/shipping/fulfillment-group-filter)`

At least one of these filters matches.

**orderCreatedAt** `[DateTimeFilter](/docs/api-reference/v3/reference/common/date-time-filter)`

When the group's order was placed.

**fields**

**gt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

After this instant.

**gte** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

At or after this instant.

**lt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

Before this instant.

**lte** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

At or before this instant.

**orderName** `[ContainsStringListFilter](/docs/api-reference/v3/reference/common/contains-string-list-filter)`

The names of the group's orders, as the sales channel shows them (for example `#1001`).

**fields**

**allOf** `[String!]`

Contains every one of these values (at most 100).

**anyOf** `[String!]`

Contains at least one of these values (at most 100).

**contains** `String`

Contains a value with this text anywhere in it (3 to 200 characters).

**noneOf** `[String!]`

Contains none of these values (at most 100).

**notContains** `String`

Contains no value with this text anywhere in it (3 to 200 characters).

**packingSlipPrinted** `Boolean`

Whether the group's packing slip was printed.

**requestedService** `[PrefixStringListFilter](/docs/api-reference/v3/reference/common/prefix-string-list-filter)`

The shipping option the customer chose at checkout, by name (for example `Standard Shipping`).

**fields**

**allOf** `[String!]`

Contains every one of these values (at most 100).

**anyOf** `[String!]`

Contains at least one of these values (at most 100).

**noneOf** `[String!]`

Contains none of these values (at most 100).

**notStartsWith** `String`

Contains no value starting with this text (1 to 200 characters).

**startsWith** `String`

Contains a value starting with this text (1 to 200 characters).

**scanVerified** `Boolean`

Whether the group's items were scan verified.

**shippedAt** `[DateTimeFilter](/docs/api-reference/v3/reference/common/date-time-filter)`

When the group shipped.

**fields**

**gt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

After this instant.

**gte** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

At or after this instant.

**lt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

Before this instant.

**lte** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

At or before this instant.

**sku** `[ContainsStringListFilter](/docs/api-reference/v3/reference/common/contains-string-list-filter)`

The SKUs of the group's items.

**fields**

**allOf** `[String!]`

Contains every one of these values (at most 100).

**anyOf** `[String!]`

Contains at least one of these values (at most 100).

**contains** `String`

Contains a value with this text anywhere in it (3 to 200 characters).

**noneOf** `[String!]`

Contains none of these values (at most 100).

**notContains** `String`

Contains no value with this text anywhere in it (3 to 200 characters).

**status** `[FulfillmentGroupStatusFilter](/docs/api-reference/v3/reference/common/fulfillment-group-status-filter)`

The group's status.

**fields**

**anyOf** `[\[FulfillmentGroupStatus!\]](/docs/api-reference/v3/reference/shipping/fulfillment-group-status)`

One of these values.

**noneOf** `[\[FulfillmentGroupStatus!\]](/docs/api-reference/v3/reference/shipping/fulfillment-group-status)`

None of these values.

**tags** `[StringListFilter](/docs/api-reference/v3/reference/common/string-list-filter)`

The group's tags, by name.

**fields**

**allOf** `[String!]`

Contains every one of these values (at most 100).

**anyOf** `[String!]`

Contains at least one of these values (at most 100).

**noneOf** `[String!]`

Contains none of these values (at most 100).

**updatedAt** `[DateTimeFilter](/docs/api-reference/v3/reference/common/date-time-filter)`

When Redo last updated the group.

**fields**

**gt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

After this instant.

**gte** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

At or after this instant.

**lt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

Before this instant.

**lte** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

At or before this instant.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.