Discount types

This list contains all query and input types for the discount endpoints.


Discount

Fields

  • Name
    active
    Type
    Boolean!
    Description

    The discount active boolean.

  • Name
    code
    Type
    String!
    Description

    The discount code.

  • Name
    created_at
    Label
    TimeStamp!
    Description

    Timestamp of when the discount was created. Arguments: format: String = "fromNow", suffix: Boolean = true

  • Name
    expired_at
    Label
    TimeStamp
    Description

    Timestamp of when the discount will expire. Arguments: format: String = "YYYY-MM-DD HH:mm:ss"

  • Name
    id
    Type
    ID!
    Description

    Unique identifier for the discount.

  • Name
    limited_usage
    Type
    Boolean!
    Description

    The discount limited usage boolean.

  • Name
    one_time_usage_per_customer
    Type
    Boolean!
    Description

    The discount one time usage per customer boolean.

  • Name
    products_ids
    Type
    [ID!]!
    Description
  • Name
    started_at
    Label
    TimeStamp
    Description

    Timestamp of when the discount will start. Arguments: format: String = "YYYY-MM-DD HH:mm:ss"

  • Name
    tags
    Type
    [String!]!
    Description

    The discount tags.

  • Name
    type
    Label
    DiscountType!
    Description

    The discount type.

  • Name
    updated_at
    Label
    TimeStamp!
    Description

    Timestamp of when the discount was updated. Arguments: format: String = "fromNow", suffix: Boolean = true

  • Name
    usage
    Type
    Int
    Description

    The discount usage.

  • Name
    usage_limit
    Type
    Int!
    Description

    The discount usage limit.

  • Name
    value
    Type
    Float!
    Description

    The discount value.


InputDiscount

Fields

  • Name
    active
    Type
    Boolean
    Description

    The discount active boolean.

  • Name
    code
    Type
    String!
    Description

    The discount code.

  • Name
    expired_at
    Label
    TimeStamp
    Description

    Timestamp of when the discount will expire.

  • Name
    limited_usage
    Type
    Boolean!
    Description

    The discount limited usage option.

  • Name
    one_time_usage_per_customer
    Type
    Boolean!
    Description

    The discount one time usage per customer option.

  • Name
    products_ids
    Type
    [ID!]
    Description
  • Name
    started_at
    Label
    TimeStamp
    Description

    Timestamp of when the discount will start.

  • Name
    tags
    Type
    [String!]
    Description

    The discount tags.

  • Name
    type
    Label
    DiscountType!
    Description

    The discount type.

  • Name
    usage_limit
    Type
    Int!
    Description

    The discount usage limit.

  • Name
    value
    Type
    Float!
    Description

    The discount value.


InputUpdateDiscount

Fields

  • Name
    active
    Type
    Boolean
    Description

    The discount active option.

  • Name
    code
    Type
    String
    Description

    The discount code.

  • Name
    expired_at
    Label
    TimeStamp
    Description

    Timestamp of when the discount will expire.

  • Name
    limited_usage
    Type
    Boolean
    Description

    The discount limited usage option.

  • Name
    one_time_usage_per_customer
    Type
    Boolean
    Description

    The discount one time usage per customer option.

  • Name
    products_ids
    Type
    [ID!]
    Description
  • Name
    started_at
    Label
    TimeStamp
    Description

    Timestamp of when the discount will start.

  • Name
    tags
    Type
    [String!]
    Description

    The discount tags.

  • Name
    type
    Label
    DiscountType
    Description

    The discount type.

  • Name
    usage_limit
    Type
    Int
    Description

    The discount usage limit.

  • Name
    value
    Type
    Float
    Description

    The discount value.


updateDiscountMutationInput

Fields

  • Name
    clientMutationId
    Type
    String
    Description
  • Name
    id
    Type
    ID!
    Description
  • Name
    node
    Label
    InputUpdateDiscount!
    Description

createDiscountMutationInput

Fields

  • Name
    clientMutationId
    Type
    String
    Description
  • Name
    node
    Label
    InputDiscount!
    Description

updateDiscountMutationPayload

Fields

  • Name
    clientMutationId
    Type
    String
    Description
  • Name
    discount
    Label
    Discount
    Description

createDiscountMutationPayload

Fields

  • Name
    clientMutationId
    Type
    String
    Description
  • Name
    node
    Label
    Discount!
    Description

DiscountConnection

A connection to a list of items.

Fields

  • Name
    edges
    Label
    [DiscountEdge]
    Description

    A list of edges.

  • Name
    pageInfo
    Label
    PageInfo!
    Description

    Information to aid in pagination.


DiscountEdge

An edge in a connection.

Fields

  • Name
    cursor
    Type
    String!
    Description

    A cursor for use in pagination

  • Name
    node
    Label
    Discount
    Description

    The item at the end of the edge


DiscountType

Values

  • Name
    fixed
    Description
  • Name
    percentage
    Description