DiscountRedeemCode object

A redeem code for a code discount.

Required access

Apps must have read_discounts access scope.

On this page

Fields

  • asyncUsageCount ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
    The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.
  • code ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The code of a discount.
  • createdBy ([App](https://shopify.dev/docs/admin-api/graphql/reference/apps/app))
    The application that created the discount code.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    Globally unique identifier of the discount redeem code.

Types that return DiscountRedeemCode

  • [DiscountCodeBasic.codes](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountcodebasic#codes-2021-01)
  • [DiscountCodeBxgy.codes](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountcodebxgy#codes-2021-01)
  • [DiscountCodeFreeShipping.codes](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountcodefreeshipping#codes-2021-01)

An auto-generated type for paginating through multiple DiscountRedeemCodes.

On this page

Fields

  • edges ([[DiscountRedeemCodeEdge!]!](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountredeemcode))
    A list of edges.
  • pageInfo ([PageInfo!](https://shopify.dev/docs/admin-api/graphql/reference/pageinfo))
    Information to aid in pagination.

An auto-generated type which holds one DiscountRedeemCode and a cursor during pagination.

On this page

Fields

  • cursor ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A cursor for use in pagination.
  • node ([DiscountRedeemCode!](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountredeemcode))
    The item at the end of DiscountRedeemCodeEdge.

Types that return DiscountRedeemCodeEdge

  • [DiscountRedeemCodeConnection.edges](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountredeemcode#edges-2021-01)