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

# backInStockSubscriptions

> List back-in-stock subscriptions for this store, oldest first.

**Required scopes:** [`customers_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-customers_read)

**Store must have one of:** `EMAIL_SMS`

## Arguments

**after** `String`

Return subscriptions after this cursor. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.

**filter** `[BackInStockSubscriptionFilter](/docs/api-reference/v3/reference/marketing/back-in-stock-subscription-filter)`

Which subscriptions to include.

**fields**

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

Only subscriptions created within these bounds. Omit a bound to leave that side open.

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

**productIds** `[ID!]`

Only subscriptions for these products. An unknown id matches nothing.

**status** `[BackInStockSubscriptionStatus](/docs/api-reference/v3/reference/marketing/back-in-stock-subscription-status)`

Only subscriptions in this state.

**first** `Int`

How many subscriptions to return (max 100, default 25). Use with `after`.

## Returns

**backInStockSubscriptions** `[BackInStockSubscriptionConnection!](/docs/api-reference/v3/pagination)` *required*

A paginated list of BackInStockSubscription items.

**fields**

**edges** `[\[BackInStockSubscriptionEdge!\]!](/docs/api-reference/v3/pagination)` *required*

The list of edges (each a node plus its pagination `cursor`).

**fields**

**cursor** `String!` *required*

Opaque cursor for this item; pass to `after`/`before` to page from here.

**node** `[BackInStockSubscription!](/docs/api-reference/v3/reference/marketing/back-in-stock-subscription)` *required*

The item at this edge.

**fields**

**email** `String`

The email to notify. At least one of email and phone is set.

**id** `ID!` *required*

The id of this subscription.

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

When a send took this subscription. Null while waiting.

**phone** `String`

The phone number to notify. At least one of email and phone is set.

**product** `[Product](/docs/api-reference/v3/reference/catalog/product)`

The product the shopper is waiting on. Null when that variant is no longer in the catalog.

**Requires:** [`products_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-products_read)

**status** `[BackInStockSubscriptionStatus!](/docs/api-reference/v3/reference/marketing/back-in-stock-subscription-status)` *required*

Whether this subscriber is still waiting.

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

When the shopper subscribed.

**nodes** `[\[BackInStockSubscription!\]!](/docs/api-reference/v3/reference/marketing/back-in-stock-subscription)` *required*

The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.

**fields**

**email** `String`

The email to notify. At least one of email and phone is set.

**id** `ID!` *required*

The id of this subscription.

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

When a send took this subscription. Null while waiting.

**phone** `String`

The phone number to notify. At least one of email and phone is set.

**product** `[Product](/docs/api-reference/v3/reference/catalog/product)`

The product the shopper is waiting on. Null when that variant is no longer in the catalog.

**Requires:** [`products_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-products_read)

**fields**

**attribute** `[Attribute](/docs/api-reference/v3/reference/catalog/attribute)`

Look up a single attribute on this product by its name, if set.

**Requires:** [`products_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-products_read)

**fields**

**Arguments**

**name** `String!` *required*

The machine name of the attribute to look up.

**attributes** `[\[Attribute!\]!](/docs/api-reference/v3/reference/catalog/attribute)` *required*

The merchant-defined attributes set on this product.

**barcodes** `[String!]!` *required*

Barcodes associated with this product.

**cost** `[Money](/docs/api-reference/v3/reference/common/money)`

The merchant's unit cost for the product.

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

When the record was created.

**description** `String!` *required*

The product's long-form description.

**dimensions** `[Dimensions](/docs/api-reference/v3/reference/catalog/dimensions)`

The product's length, width, and height, expressed in a single shared unit.

**hsCode** `String`

The Harmonized System code used for customs.

**id** `ID!` *required*

The id of this product.

**image** `[ProductImage](/docs/api-reference/v3/reference/catalog/product-image)`

The first (default) image for this product, if any.

**Requires:** [`products_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-products_read)

**images** `[ProductImageConnection!](/docs/api-reference/v3/pagination)` *required*

A paginated list of the product's images.

**Requires:** [`products_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-products_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.

**before** `String`

Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.

**first** `Int`

Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**importRestrictions** `[ProductImportRestrictionConnection!](/docs/api-reference/v3/pagination)` *required*

The import restrictions the product trips, one per destination country and rule. Only countries of enabled markets with restriction screening on are screened, and a restriction drops off 21 days after screening last found it.

**Requires:** [`markets_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-markets_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns import restrictions after it.

**before** `String`

Backward pagination cursor — returns import restrictions before it.

**first** `Int`

Forward pagination: returns the first N import restrictions (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N import restrictions (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**inventoryItems** `[InventoryItemConnection!](/docs/api-reference/v3/pagination)` *required*

Traceable inventory units for this product.

**Requires:** [`inventory_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-inventory_read)

**fields**

**Arguments**

**after** `String`

**before** `String`

**first** `Int`

**last** `Int`

**inventoryLevel** `[LocationInventoryLevel](/docs/api-reference/v3/reference/inventory/location-inventory-level)`

This product's inventory level at a single location, if any.

**Requires:** [`inventory_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-inventory_read)

**fields**

**Arguments**

**locationId** `ID!` *required*

The id of the location to fetch the level at.

**inventoryLevels** `[LocationInventoryLevelConnection!](/docs/api-reference/v3/pagination)` *required*

Per-location inventory levels for this product.

**Requires:** [`inventory_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-inventory_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.

**before** `String`

Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.

**first** `Int`

Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**marketPublishing** `[\[ProductMarketPublishing!\]](/docs/api-reference/v3/reference/markets/product-market-publishing)`

Publishing per destination country where the product trips an import restriction, or has a publish override. Only countries of enabled markets with restriction screening on are screened. Null when publishing can't be read.

**Requires:** [`markets_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-markets_read)

**options** `[\[ProductOptionValue!\]!](/docs/api-reference/v3/reference/catalog/product-option-value)` *required*

The variant's selected option values (e.g. Size: M, Color: Red), ordered by the family's option positions.

**originCountry** `String`

The country of origin, as a country code.

**physicalItem** `Boolean!` *required*

Whether the product is a physical, shippable item.

**price** `[Money](/docs/api-reference/v3/reference/common/money)`

The product's selling price.

**productFamily** `[ProductFamily](/docs/api-reference/v3/reference/catalog/product-family)`

The product family this product belongs to, if any.

**Requires:** [`products_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-products_read)

**sku** `String`

The stock keeping unit identifying this product.

**tags** `[String!]!` *required*

Free-form tags applied to the product.

**taxCode** `String`

The tax code used to classify the product for taxation.

**taxable** `Boolean!` *required*

Whether the product is subject to tax.

**title** `String!` *required*

The product's title.

**upc** `String`

The Universal Product Code for this product.

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

When the record was last updated.

**vendor** `String`

The vendor or manufacturer of the product.

**weight** `[Weight](/docs/api-reference/v3/reference/catalog/weight)`

The product's weight.

**status** `[BackInStockSubscriptionStatus!](/docs/api-reference/v3/reference/marketing/back-in-stock-subscription-status)` *required*

Whether this subscriber is still waiting.

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

When the shopper subscribed.

**pageInfo** `[PageInfo!](/docs/api-reference/v3/pagination)` *required*

Pagination metadata for the current page.

**fields**

**endCursor** `String`

Cursor of the last edge in this page; pass to `after` to page forward.

**hasNextPage** `Boolean!` *required*

Whether more items exist after this page (drives forward pagination with `first`/`after`).

**hasPreviousPage** `Boolean!` *required*

Whether more items exist before this page (drives backward pagination with `last`/`before`).

**startCursor** `String`

Cursor of the first edge in this page; pass to `before` to page backward.

## Example

```graphql theme={null}
query {
  backInStockSubscriptions(after: "...", filter: { ... }, first: 10) {
    nodes {
      email
      id
      notifiedAt
      phone
      status
      subscribedAt
    }
    pageInfo { hasNextPage endCursor }
  }
}
```


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