Stories

Queries

searchStories

Searches Stories

Arguments

• after (String) — A cursor to search after (only include first & after or last & before)
• before (String) — A cursor to search before (only include first & after or last & before)
• filters ([SearchFilterInput!]) — A set of filters to apply
• first (Int) — The number of results to fetch when searching forward (only include first & after or last & before)
• last (Int) — The number of results to fetch when searching backward (only include first & after or last & before)
• search (String) — A search query to filter results
• sortBy (SortStoriesBy) — The sort key
• sortDir (SortDirection) — The sort direction

Returns: StoryConnection! — A connection to a list of items.

storiesByIds

A list of Stories by IDs

Arguments

• ids ([ID!]!) — The IDs of the Stories

Returns: [Story]! — A collection of items to share

story

A single Story by ID

Arguments

• id (ID!) — The unique identifier of the Story

Returns: Story — A collection of items to share

storyItem

A single StoryItem by ID

Arguments

• id (ID!) — The unique identifier of the StoryItem

Returns: StoryItem — An item within a Story

storyItems

Lists StoryItems

Arguments

• after (String) — A cursor to search after (only include first & after or last & before)
• before (String) — A cursor to search before (only include first & after or last & before)
• first (Int) — The number of results to fetch when searching forward (only include first & after or last & before)
• last (Int) — The number of results to fetch when searching backward (only include first & after or last & before)
• search (String) — A search query to filter results
• sortBy (SortStoryItemsBy) — The sort key
• sortDir (SortDirection) — The sort direction
• storyId (ID!) — An ID for a Story to filter by
• storySectionId (ID!) — An ID for a StorySection to filter by

Returns: StoryItemConnection! — A connection to a list of items.

storySection

A single StorySection by ID

Arguments

• id (ID!) — The unique identifier of the StorySection

Returns: StorySection — A section with a Story

Mutations

addSectionToStory

Adds a StorySection to a Story

Arguments

• storyId (ID!) — The unique identifier of the Story

Returns: AddSectionToStoryPayload!

createStory

Creates a Story

Arguments

• checkoutIntegrationId (ID) — The ID of the checkout-enabled Integration to use for the Story
• description (String) — The description of the Story
• items ([StoryItemInput!]) — Items to create the Story with
• title (String) — The title of the Story

Returns: CreateStoryPayload!

removeItemFromStorySection

Removes a StoryItem from a StorySection

Arguments

• storyItemId (ID!) — The unique identifier of the StoryItem
• storySectionId (ID!) — The unique identifier of the StorySection

Returns: RemoveItemFromStorySectionPayload!

removeSectionFromStory

Removes a StorySection from a Story

Arguments

• storyId (ID!) — The unique identifier of the Story
• storySectionId (ID!) — The unique identifier of the StorySection

Returns: RemoveSectionFromStoryPayload!

reorderStoryItems

Updates a StoryItem's position in a StorySection

Arguments

• id (ID!) — The unique identifier of the StoryItem
• position (NonNegativeInt!) — The position of the StoryItem

Returns: ReorderStoryItemsPayload!

reorderStorySections

Updates a StorySection's position in a Story

Arguments

• id (ID!) — The unique identifier of the StorySection
• position (NonNegativeInt!) — The position of the StorySection

Returns: ReorderStorySectionsPayload!

updateStory

Updates a Story

Arguments

• description (String) — The description of the Story
• id (ID!) — The unique identifier of the Story
• title (String) — The title of the Story

Returns: UpdateStoryPayload!

updateStoryItem

Updates a StoryItem

Arguments

• comments (String) — The comments of the StoryItem
• id (ID!) — The unique identifier of the StoryItem
• storyId (ID!) — The unique identifier of the Story
• title (String) — The title of the StoryItem
• useForCoverPhoto (Boolean) — Whether to use this item for the cover photo of the Story

Returns: UpdateStoryItemPayload!

updateStorySection

Updates a StorySection

Arguments

• description (String) — The description of the StorySection
• id (ID!) — The unique identifier of the StorySection
• storyId (ID!) — The unique identifier of the Story
• title (String) — The title of the StorySection

Returns: UpdateStorySectionPayload!

Objects

AddSectionToStoryError

Fields

• code (AddSectionToStoryErrorCode!)
• human_readable_message (String!)

AddSectionToStoryFailure

Fields

• errors ([AddSectionToStoryError!]!)

AddSectionToStorySuccess

Fields

• operation (OperationStatus!)

CreateStoryError

Fields

• code (CreateStoryErrorCode!)
• human_readable_message (String!)

CreateStoryFailure

Fields

• errors ([CreateStoryError!]!)

CreateStorySuccess

Fields

• story (Story!)

RemoveItemFromStorySectionError

Fields

• code (RemoveItemFromStorySectionErrorCode!)
• human_readable_message (String!)

RemoveItemFromStorySectionFailure

Fields

• errors ([RemoveItemFromStorySectionError!]!)

RemoveItemFromStorySectionSuccess

Fields

• operation (OperationStatus!)

RemoveSectionFromStoryError

Fields

• code (RemoveSectionFromStoryErrorCode!)
• human_readable_message (String!)

RemoveSectionFromStoryFailure

Fields

• errors ([RemoveSectionFromStoryError!]!)

RemoveSectionFromStorySuccess

Fields

• operation (OperationStatus!)

ReorderStoryItemsError

Fields

• code (ReorderStoryItemsErrorCode!)
• human_readable_message (String!)

ReorderStoryItemsFailure

Fields

• errors ([ReorderStoryItemsError!]!)

ReorderStoryItemsSuccess

Fields

• operation (OperationStatus!)

ReorderStorySectionsError

Fields

• code (ReorderStorySectionsErrorCode!)
• human_readable_message (String!)

ReorderStorySectionsFailure

Fields

• errors ([ReorderStorySectionsError!]!)

ReorderStorySectionsSuccess

Fields

• operation (OperationStatus!)

Story

A collection of items to share

Fields

• created_at (DateTime!) — The date the Story was created
• created_in_team (Team) — The Team that the Story was created in
• creator (User) — The User who created the Story
• deleted_at (DateTime) — When the Story was deleted
• description (String) — The description of the Story
• id (ID!) — The unique identifier of the Story
• preview_image_url (String!) — The preview image URL of the Story
• preview_link_url (String!) — The preview link URL of the Story
• sections ([StorySection!]!) — The sections of the Story
• tags ([String!]!) — The tags of the Story
• title (String) — The title of the Story
• total_items (Int!) — The number of items in the Story
• updated_at (DateTime!) — The date the Story was last updated

StoryConnection

A connection to a list of items.

Fields

• edges ([StoryEdge]) — A list of edges.
• pageInfo (PageInfo!) — Information to aid in pagination.
• total (Int)

StoryEdge

An edge in a connection.

Fields

• cursor (String!) — A cursor for use in pagination
• node (Story) — The item at the end of the edge

StoryItem

An item within a Story

Fields

• comments (String) — The comments of the StoryItem
• created_at (DateTime!) — The date the StoryItem was created
• id (ID!) — The unique identifier of the StoryItem
• media (StoryItemMedia!) — The media of the StoryItem
• position (Int) — The position of the StoryItem
• resource (StoryItemResource!) — The resource of the StoryItem
• section (StorySection) — The StorySection the StoryItem belongs to
• story (Story!) — The Story the StoryItem belongs to
• title (String) — The title of the StoryItem
• updated_at (DateTime!) — The date the StoryItem was last updated

StoryItemAsset

Fields

• aspect_ratio (NonNegativeFloat)
• height (NonNegativeInt)
• id (ID!)
• link_url (URL)
• mime_type (String)
• price (Money)
• size_in_bytes (NonNegativeInt)
• title (String)
• type (StoryItemAssetType!)
• width (NonNegativeInt)

StoryItemConnection

A connection to a list of items.

Fields

• edges ([StoryItemEdge]) — A list of edges.
• pageInfo (PageInfo!) — Information to aid in pagination.

StoryItemEdge

An edge in a connection.

Fields

• cursor (String!) — A cursor for use in pagination
• node (StoryItem) — The item at the end of the edge

StoryItemMediaFile

Fields

• alt (String)
• aspect_ratio (Float)
• height (Int)
• id (ID!)
• preview_url (URL)
• source (URL)
• width (Int)

StoryItemMediaImage

Fields

• alt (String)
• aspect_ratio (Float)
• height (Int)
• id (ID!)
• preview_url (URL)
• source (URL)
• source_set (String)
• width (Int)

StoryItemMediaVideo

Fields

• alt (String)
• aspect_ratio (Float)
• height (Int)
• id (ID!)
• preview_url (URL)
• source (URL)
• sources ([StoryItemMediaVideoSource!]!)
• width (Int)

StoryItemMediaVideoSource

Fields

• src (URL!)
• type (String!)

StorySection

A section with a Story

Fields

• created_at (DateTime!) — The date the StorySection was created
• description (String) — The description of the StorySection
• id (ID!) — The unique identifier of the StorySection
• position (Int) — The position of the StorySection
• story (Story!) — The Story the StorySection belongs to
• title (String) — The title of the StorySection
• updated_at (DateTime!) — The date the StorySection was last updated

UpdateStoryError

Fields

• code (UpdateStoryErrorCode!)
• human_readable_message (String!)

UpdateStoryFailure

Fields

• errors ([UpdateStoryError!]!)

UpdateStoryItemError

Fields

• code (UpdateStoryItemErrorCode!)
• human_readable_message (String!)

UpdateStoryItemFailure

Fields

• errors ([UpdateStoryItemError!]!)

UpdateStoryItemSuccess

Fields

• storyItem (StoryItem!)

UpdateStorySectionError

Fields

• code (UpdateStorySectionErrorCode!)
• human_readable_message (String!)

UpdateStorySectionFailure

Fields

• errors ([UpdateStorySectionError!]!)

UpdateStorySectionSuccess

Fields

• storySection (StorySection!)

UpdateStorySuccess

Fields

• story (Story!)

Unions

AddSectionToStoryPayload

Possible types

• AddSectionToStoryFailure
• AddSectionToStorySuccess

CreateStoryPayload

Possible types

• CreateStoryFailure
• CreateStorySuccess

RemoveItemFromStorySectionPayload

Possible types

• RemoveItemFromStorySectionFailure
• RemoveItemFromStorySectionSuccess

RemoveSectionFromStoryPayload

Possible types

• RemoveSectionFromStoryFailure
• RemoveSectionFromStorySuccess

ReorderStoryItemsPayload

Possible types

• ReorderStoryItemsFailure
• ReorderStoryItemsSuccess

ReorderStorySectionsPayload

Possible types

• ReorderStorySectionsFailure
• ReorderStorySectionsSuccess

StoryItemMedia

Possible types

• StoryItemMediaFile
• StoryItemMediaImage
• StoryItemMediaVideo

StoryItemResource

Possible types

• StoryItemAsset
• StoryItemProduct

UpdateStoryItemPayload

Possible types

• UpdateStoryItemFailure
• UpdateStoryItemSuccess

UpdateStoryPayload

Possible types

• UpdateStoryFailure
• UpdateStorySuccess

UpdateStorySectionPayload

Possible types

• UpdateStorySectionFailure
• UpdateStorySectionSuccess

Input Objects

StoryItemInput

An item for a Story

Fields

• comments (String) — The comments of the StoryItem
• resource (StoryItemResourceInput) — The resource of the StoryItem
• title (String) — The title of the StoryItem
• use_for_cover_photo (Boolean) — Whether to use this item for the cover photo of the Story

StoryItemResourceInput

A resource for a StoryItem

Fields

• asset_id (ID) — The ID of an Asset
• image_source_url (HTTPURL!) — The URL of an image associated to the resource
• product_variant_id (ID) — The ID of a ProductVariant

Enums

AddSectionToStoryErrorCode

Values

• CONCURRENCY_ERROR — The story has been updated since this request was initiated
• FORBIDDEN — You do not have permission to perform this action
• STORY_NOT_FOUND — The story was not found
• STORY_SECTION_LIMIT_REACHED — The story has reached the maximum number of sections allowed

CreateStoryErrorCode

Values

• ASSET_NOT_FOUND — The asset was not found
• CHECKOUT_INTEGRATION_NOT_ENABLED — The checkout integration is not enabled
• CHECKOUT_INTEGRATION_NOT_FOUND — The checkout integration was not found
• FORBIDDEN — You do not have permission to perform this action
• INVALID_ITEM_RESOURCE — The item resource is invalid
• PRODUCT_VARIANT_NOT_FOUND — The product variant was not found

RemoveItemFromStorySectionErrorCode

Values

• CONCURRENCY_ERROR — The story section has been updated since this request was initiated
• FORBIDDEN — You do not have permission to perform this action
• STORY_SECTION_NOT_FOUND — The story section was not found

RemoveSectionFromStoryErrorCode

Values

• CONCURRENCY_ERROR — The story has been updated since this request was initiated
• FORBIDDEN — You do not have permission to perform this action
• STORY_NOT_FOUND — The story was not found

ReorderStoryItemsErrorCode

Values

• CONCURRENCY_ERROR — The story section has been updated since this request was initiated
• FORBIDDEN — You do not have permission to perform this action
• STORY_ITEM_NOT_FOUND — The story item was not found

ReorderStorySectionsErrorCode

Values

• CONCURRENCY_ERROR — The story has been updated since this request was initiated
• FORBIDDEN — You do not have permission to perform this action
• STORY_SECTION_NOT_FOUND — The story section was not found

SortStoriesBy

The available keys to sort Stories

Values

• CREATED_AT
• UPDATED_AT

SortStoryItemsBy

The available keys to sort StoryItems

Values

• POSITION

StoryItemAssetType

Values

• GIF
• IMAGE
• OTHER
• PDF
• VIDEO

UpdateStoryErrorCode

Values

• CONCURRENCY_ERROR — The story has been updated since this request was initiated
• FORBIDDEN — You do not have permission to perform this action
• STORY_NOT_FOUND — The story was not found

UpdateStoryItemErrorCode

Values

• CONCURRENCY_ERROR — The story item has been updated since this request was initiated
• FORBIDDEN — You do not have permission to perform this action
• STORY_ITEM_NOT_FOUND — The story item was not found
• STORY_NOT_FOUND — The story was not found

UpdateStorySectionErrorCode

Values

• CONCURRENCY_ERROR — The story section has been updated since this request was initiated
• FORBIDDEN — You do not have permission to perform this action
• STORY_NOT_FOUND — The story was not found
• STORY_SECTION_NOT_FOUND — The story section was not found