GiftCardCreateInput Input Type

input GiftCardCreateInput {
  addTags: [String!]
  expiryDate: Date
  metadata: [MetadataInput!]
  privateMetadata: [MetadataInput!]
  startDate: Date @deprecated
  endDate: Date @deprecated(reason: "Use `expiryDate` from `expirySettings` instead.")
  balance: PriceInput!
  userEmail: String
  channel: String
  isActive: Boolean!
  code: String @deprecated(reason: "The code is now auto generated.")
  note: String
  assignedTo: ID
}

Fields

addTags

addTags · [String!]

The gift card tags to add.

expiryDate

expiryDate · Date

The gift card expiry date.

metadata

metadata · [MetadataInput!]

Gift Card public metadata.

Can be read by any API client authorized to read the object it’s attached to.

Warning: never store sensitive information, including financial data such as credit card details.

privateMetadata

privateMetadata · [MetadataInput!]

Gift Card private metadata.

Requires permissions to modify and to read the metadata of the object it’s attached to.

Warning: never store sensitive information, including financial data such as credit card details.

startDate

startDate · Date

Start date of the gift card in ISO 8601 format.

endDate

endDate · Date

End date of the gift card in ISO 8601 format.

balance

balance · PriceInput!

Balance of the gift card.

userEmail

userEmail · String

Email of the customer to whom gift card will be sent.

channel

channel · String

Slug of a channel from which the email should be sent.

isActive

isActive · Boolean!

Determine if gift card is active.

code

code · String

Code to use the gift card.

note

note · String

The gift card note from the staff member.

assignedTo

assignedTo · ID

ID of the customer the gift card is restricted to.

Used by

• giftCardCreate (mutations)

Schema: Saleor 3.23.43. Download SDL.