/v23.1/GiftCards
  • 05 Jun 2024
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

/v23.1/GiftCards

  • Dark
    Light
  • PDF

Article summary

Post
/v23.1/GiftCards
Security
HTTP
Type Bearer

Please enter a valid token

Body parameters
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
companyId
integer (int32)
storeId
integer (int32)
giftCardTypeId
integer (int32)
giftCardDefinitionId
integer (int32)
customerId
integer (int32)
reservationRowId
integer (int32)
cashSaleId
integer (int32)
invoiceSaleId
integer (int32)
prefix
integer (int64)
cardNumber
integer (int64)
suffix
integer (int32)
cardNumberWithSuffix
integer (int64)
email
string
pincode
integer (int32)
verificationCode
string
status
string
Valid values[ "NotSpecified", "Active", "Blocked", "NotActivated" ]
isBlocked
boolean
Default"False"
blockedDescription
string
transactions
integer (int32)
activationDate
string (date-time)
printedDate
string (date-time)
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
companyId
integer (int32)
storeId
integer (int32)
giftCardTypeId
integer (int32)
giftCardDefinitionId
integer (int32)
customerId
integer (int32)
reservationRowId
integer (int32)
cashSaleId
integer (int32)
invoiceSaleId
integer (int32)
prefix
integer (int64)
cardNumber
integer (int64)
suffix
integer (int32)
cardNumberWithSuffix
integer (int64)
email
string
pincode
integer (int32)
verificationCode
string
status
string
Valid values[ "NotSpecified", "Active", "Blocked", "NotActivated" ]
isBlocked
boolean
Default"False"
blockedDescription
string
transactions
integer (int32)
activationDate
string (date-time)
printedDate
string (date-time)
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
companyId
integer (int32)
storeId
integer (int32)
giftCardTypeId
integer (int32)
giftCardDefinitionId
integer (int32)
customerId
integer (int32)
reservationRowId
integer (int32)
cashSaleId
integer (int32)
invoiceSaleId
integer (int32)
prefix
integer (int64)
cardNumber
integer (int64)
suffix
integer (int32)
cardNumberWithSuffix
integer (int64)
email
string
pincode
integer (int32)
verificationCode
string
status
string
Valid values[ "NotSpecified", "Active", "Blocked", "NotActivated" ]
isBlocked
boolean
Default"False"
blockedDescription
string
transactions
integer (int32)
activationDate
string (date-time)
printedDate
string (date-time)
Responses
200

Success

object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
companyId
integer (int32)
storeId
integer (int32)
giftCardTypeId
integer (int32)
giftCardDefinitionId
integer (int32)
customerId
integer (int32)
reservationRowId
integer (int32)
cashSaleId
integer (int32)
invoiceSaleId
integer (int32)
prefix
integer (int64)
cardNumber
integer (int64)
suffix
integer (int32)
cardNumberWithSuffix
integer (int64)
email
string
pincode
integer (int32)
verificationCode
string
status
string
Valid values[ "NotSpecified", "Active", "Blocked", "NotActivated" ]
isBlocked
boolean
Default"False"
blockedDescription
string
transactions
integer (int32)
activationDate
string (date-time)
printedDate
string (date-time)
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
companyId
integer (int32)
storeId
integer (int32)
giftCardTypeId
integer (int32)
giftCardDefinitionId
integer (int32)
customerId
integer (int32)
reservationRowId
integer (int32)
cashSaleId
integer (int32)
invoiceSaleId
integer (int32)
prefix
integer (int64)
cardNumber
integer (int64)
suffix
integer (int32)
cardNumberWithSuffix
integer (int64)
email
string
pincode
integer (int32)
verificationCode
string
status
string
Valid values[ "NotSpecified", "Active", "Blocked", "NotActivated" ]
isBlocked
boolean
Default"False"
blockedDescription
string
transactions
integer (int32)
activationDate
string (date-time)
printedDate
string (date-time)
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
companyId
integer (int32)
storeId
integer (int32)
giftCardTypeId
integer (int32)
giftCardDefinitionId
integer (int32)
customerId
integer (int32)
reservationRowId
integer (int32)
cashSaleId
integer (int32)
invoiceSaleId
integer (int32)
prefix
integer (int64)
cardNumber
integer (int64)
suffix
integer (int32)
cardNumberWithSuffix
integer (int64)
email
string
pincode
integer (int32)
verificationCode
string
status
string
Valid values[ "NotSpecified", "Active", "Blocked", "NotActivated" ]
isBlocked
boolean
Default"False"
blockedDescription
string
transactions
integer (int32)
activationDate
string (date-time)
printedDate
string (date-time)
400

Bad Request

Expand All
object
type
string
message
string
stackTrace
string
validationExceptions
Array of object (ValidationExceptionRow)
object
errorCode
string
errorMessage
string
severity
string
propertyName
string
Expand All
object
type
string
message
string
stackTrace
string
validationExceptions
Array of object (ValidationExceptionRow)
object
errorCode
string
errorMessage
string
severity
string
propertyName
string
Expand All
object
type
string
message
string
stackTrace
string
validationExceptions
Array of object (ValidationExceptionRow)
object
errorCode
string
errorMessage
string
severity
string
propertyName
string
401

Unauthorized

object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
403

Forbidden

object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.