Collection types

This list contains all query and inputs types for the collection endpoints.


Collection

Fields

  • Name
    id
    Type
    ID!
    Description

    Unique identifier for the collection.

  • Name
    uid
    Type
    ID!
    Description

    Unique identifier for the collection.

  • Name
    type
    Type
    CollectionType!
    Description

    The collection type.

    enum CollectionType {
    	specific_funnels
    	specific_keywords
    }
    
  • Name
    products_ids
    Type
    [ID!]!
    Description

    The products unique identifiers for the collection.

  • Name
    tags_ids
    Type
    [String!]!
    Description

    The tags unique identifiers for the collection.

  • Name
    name
    Type
    String!
    Description

    The collection name.

  • Name
    slug
    Type
    String!
    Description

    The collection slug.

  • Name
    image
    Type
    Image
    Description

    The collection image.

  • Name
    image_id
    Type
    ID
    Description

    The collection image unique identifier.

  • Name
    description
    Type
    String!
    Description

    The collection description.

  • Name
    productsCount
    Type
    Int!
    Description

    The collection products count.

  • Name
    result
    Type
    [CollectionResult!]!
    Description

    The collection result.

    Arguments
    
    cursor: String
    
  • Name
    updated_at
    Label
    TimeStamp!
    Description

    Timestamp of when the collection was updated.

  • Name
    created_at
    Label
    TimeStamp!
    Description

    Timestamp of when the collection was created.


CollectionResult

Fields

  • Name
    title
    Type
    String!
    Description

    The collection result title.

  • Name
    price
    Type
    Float!
    Description

    The collection result price.

  • Name
    thumbnail
    Type
    String
    Description

    The collection result thumbnail.

  • Name
    compare_at_price
    Type
    Float!
    Description

    The collection result compare at price.

  • Name
    reviews_value
    Type
    Float!
    Description

    The collection result reviews value.

  • Name
    link
    Type
    String
    Description

    The collection result link.

  • Name
    slug
    Type
    String!
    Description

    The collection result slug.

  • Name
    cursor
    Type
    String!
    Description

    The collection result cursor.


CollectionInput

Fields

  • Name
    type
    Type
    CollectionType!
    Description

    The collection type.

    enum CollectionType {
    	specific_funnels
    	specific_keywords
    }
    
  • Name
    tags_ids
    Type
    [String!]
    Description

    The tags unique identifiers for the collection.

  • Name
    products_ids
    Type
    [ID!]
    Description

    The products unique identifiers for the collection.

  • Name
    slug
    Type
    String!
    Description

    The collection slug.

  • Name
    name
    Type
    String!
    Description

    The collection name.

  • Name
    image_id
    Type
    ID
    Description

    The collection image unique identifier.

  • Name
    description
    Type
    String!
    Description

    The collection description.


CollectionUpdateInput

Fields

  • Name
    type
    Type
    CollectionType
    Description

    The collection type.

    enum CollectionType {
    	specific_funnels
    	specific_keywords
    }
    
  • Name
    tags_ids
    Type
    [String!]
    Description

    The tags unique identifiers for the collection.

  • Name
    products_ids
    Type
    [ID!]
    Description

    The products unique identifiers for the collection.

  • Name
    slug
    Type
    String
    Description

    The collection slug.

  • Name
    name
    Type
    String
    Description

    The collection name.

  • Name
    image_id
    Type
    ID
    Description

    The collection image unique identifier.

  • Name
    description
    Type
    String
    Description

    The collection description.


CollectionConnection

Fields

  • Name
    pageInfo
    Type
    PageInfo!
    Description

    Collection connection page info.

    type PageInfo {
    	hasNextPage: Boolean!
    	hasPreviousPage: Boolean!
    	startCursor: String
    	endCursor: String
    }
    
  • Name
    edges
    Type
    [CollectionEdge]
    Description

    The Collection connection edges.

    type CollectionEdge {
    	node: Collection
    	cursor: String!
    }