docs.jsonld
type: ApiDocumentation
title: DataCandy API
entrypoint: /
supported class: Error
supported class: ConstraintViolation
supported class: GiftAccountType
supported class: LoyaltyAccountType
supported class: PromoAccountType
supported class: Merchant
supported class: Client
supported class: BalancePortal
supported class: MemberPortal
supported class: User
supported class: Contact
supported class: Item
supported class: Reward
supported class: LoyaltyTransaction
supported class: PrepaidTransaction
supported class: Webhook
supported class: Entrypoint
supported class: ConstraintViolationList

Error
type: Class
title: Error
supported property: SupportedProperty
  property: Error/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/title
  title: title
  required: false
  readable: true
  writeable: false
  description: A short, human-readable summary of the problem.
supported property: SupportedProperty
  property: Error/detail
  title: detail
  required: false
  readable: true
  writeable: false
  description: A human-readable explanation specific to this occurrence of the problem.
supported property: SupportedProperty
  property: Error/instance
  title: instance
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
supported property: SupportedProperty
  property: Error/type
  title: type
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the problem type
supported property: SupportedProperty
  property: Error/meta
  title: meta
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/source
  title: source
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/message
  title: message
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Error resource.
  method: GET
  title: getError
  returns: Error
description: A representation of common errors.
sub class of: Error

Error/id
type: Property
domain: Error
the hydra core vocabulary: id
range: string

Error/title
type: Property
domain: Error
the hydra core vocabulary: title
range: string

Error/detail
type: Property
domain: Error
the hydra core vocabulary: detail
range: string

Error/instance
type: Property
domain: Error
the hydra core vocabulary: instance
range: string

Error/type
type: Property
domain: Error
the hydra core vocabulary: type
range: string

Error/meta
type: Property
domain: Error
the hydra core vocabulary: meta

Error/source
type: Property
domain: Error
the hydra core vocabulary: source

Error/description
type: Property
domain: Error
the hydra core vocabulary: description
range: string

Error/trace
type: Property
domain: Error
the hydra core vocabulary: trace

Error/message
type: Property
domain: Error
the hydra core vocabulary: message
range: string

Error/code
type: Property
domain: Error
the hydra core vocabulary: code
range: integer

Error/file
type: Property
domain: Error
the hydra core vocabulary: file
range: string

Error/line
type: Property
domain: Error
the hydra core vocabulary: line
range: integer

ConstraintViolation
type: Class
title: ConstraintViolation
supported property: SupportedProperty
  property: ConstraintViolation/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/errorTitle
  title: errorTitle
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/violations
  title: violations
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/detail
  title: detail
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/instance
  title: instance
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/statusCode
  title: statusCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/headers
  title: headers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/previous
  title: previous
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  title: getConstraintViolation
  returns: ConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  title: getConstraintViolation
  returns: ConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  title: getConstraintViolation
  returns: ConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  title: getConstraintViolation
  returns: ConstraintViolation
description: Unprocessable entity
sub class of: Error

ConstraintViolation/status
type: Property
domain: ConstraintViolation
the hydra core vocabulary: status
range: integer

ConstraintViolation/errorTitle
type: Property
domain: ConstraintViolation
the hydra core vocabulary: errorTitle
range: string

ConstraintViolation/violations
type: Property
domain: ConstraintViolation
the hydra core vocabulary: violations
range: ConstraintViolationList

ConstraintViolation/detail
type: Property
domain: ConstraintViolation
the hydra core vocabulary: detail
range: string

ConstraintViolation/message
type: Property
domain: ConstraintViolation
the hydra core vocabulary: message
range: string

ConstraintViolation/code
type: Property
domain: ConstraintViolation
the hydra core vocabulary: code
range: string
range: integer

ConstraintViolation/file
type: Property
domain: ConstraintViolation
the hydra core vocabulary: file
range: string

ConstraintViolation/line
type: Property
domain: ConstraintViolation
the hydra core vocabulary: line
range: integer

ConstraintViolation/description
type: Property
domain: ConstraintViolation
the hydra core vocabulary: description
range: string

ConstraintViolation/type
type: Property
domain: ConstraintViolation
the hydra core vocabulary: type
range: string

ConstraintViolation/title
type: Property
domain: ConstraintViolation
the hydra core vocabulary: title
range: string

ConstraintViolation/instance
type: Property
domain: ConstraintViolation
the hydra core vocabulary: instance
range: string

ConstraintViolation/statusCode
type: Property
domain: ConstraintViolation
the hydra core vocabulary: statusCode
range: integer

ConstraintViolation/headers
type: Property
domain: ConstraintViolation
the hydra core vocabulary: headers

ConstraintViolation/trace
type: Property
domain: ConstraintViolation
the hydra core vocabulary: trace

ConstraintViolation/previous
type: Property
domain: ConstraintViolation
the hydra core vocabulary: previous
range: integer

GiftAccountType
type: Class
title: GiftAccountType
supported property: SupportedProperty
  property: GiftAccountType/isRechargeable
  title: isRechargeable
  required: false
  readable: true
  writeable: true
  description: Whether the account is rechargeable
supported property: SupportedProperty
  property: GiftAccountType/isTransferable
  title: isTransferable
  required: false
  readable: true
  writeable: true
  description: Whether the account is transferable between cards
supported property: SupportedProperty
  property: GiftAccountType/isRestrictedToWhereActivated
  title: isRestrictedToWhereActivated
  required: false
  readable: true
  writeable: true
  description: Whether the account is restricted to the location where it was activated
supported property: SupportedProperty
  property: GiftAccountType/minimumBalance
  title: minimumBalance
  required: false
  readable: true
  writeable: true
  description: Minimum balance allowed on the account
supported property: SupportedProperty
  property: GiftAccountType/maximumBalance
  title: maximumBalance
  required: false
  readable: true
  writeable: true
  description: Maximum balance allowed on the account
supported property: SupportedProperty
  property: GiftAccountType/minimumActivation
  title: minimumActivation
  required: false
  readable: true
  writeable: true
  description: Minimum amount for card activation
supported property: SupportedProperty
  property: GiftAccountType/maximumActivation
  title: maximumActivation
  required: false
  readable: true
  writeable: true
  description: Maximum amount for card activation
supported property: SupportedProperty
  property: GiftAccountType/minimumRedeem
  title: minimumRedeem
  required: false
  readable: true
  writeable: true
  description: Minimum redemption amount
supported property: SupportedProperty
  property: GiftAccountType/minimumReload
  title: minimumReload
  required: false
  readable: true
  writeable: true
  description: Minimum reload (recharge) amount
supported property: SupportedProperty
  property: GiftAccountType/maximumReload
  title: maximumReload
  required: false
  readable: true
  writeable: true
  description: Maximum reload (recharge) amount
supported property: SupportedProperty
  property: GiftAccountType/id
  title: id
  required: false
  readable: true
  writeable: true
  description: Account type ID
supported property: SupportedProperty
  property: GiftAccountType/name
  title: name
  required: false
  readable: true
  writeable: true
  description: Account Type name by language code
supported property: SupportedProperty
  property: GiftAccountType/isActive
  title: isActive
  required: false
  readable: true
  writeable: true
  description: Whether the account type is active
supported property: SupportedProperty
  property: GiftAccountType/program
  title: program
  required: false
  readable: true
  writeable: true
  description: Program type
supported property: SupportedProperty
  property: GiftAccountType/category
  title: category
  required: false
  readable: true
  writeable: true
  description: Account type category
supported operation: Operation
  type: FindAction
  description: Retrieves a GiftAccountType resource.
  method: GET
  title: getGiftAccountType
  returns: GiftAccountType

GiftAccountType/isRechargeable
type: Property
domain: GiftAccountType
the hydra core vocabulary: isRechargeable
range: boolean

GiftAccountType/isTransferable
type: Property
domain: GiftAccountType
the hydra core vocabulary: isTransferable
range: boolean

GiftAccountType/isRestrictedToWhereActivated
type: Property
domain: GiftAccountType
the hydra core vocabulary: isRestrictedToWhereActivated
range: boolean

GiftAccountType/minimumBalance
type: Property
domain: GiftAccountType
the hydra core vocabulary: minimumBalance

GiftAccountType/maximumBalance
type: Property
domain: GiftAccountType
the hydra core vocabulary: maximumBalance

GiftAccountType/minimumActivation
type: Property
domain: GiftAccountType
the hydra core vocabulary: minimumActivation

GiftAccountType/maximumActivation
type: Property
domain: GiftAccountType
the hydra core vocabulary: maximumActivation

GiftAccountType/minimumRedeem
type: Property
domain: GiftAccountType
the hydra core vocabulary: minimumRedeem

GiftAccountType/minimumReload
type: Property
domain: GiftAccountType
the hydra core vocabulary: minimumReload

GiftAccountType/maximumReload
type: Property
domain: GiftAccountType
the hydra core vocabulary: maximumReload

GiftAccountType/id
type: Property
domain: GiftAccountType
the hydra core vocabulary: id
range: integer

GiftAccountType/name
type: Property
domain: GiftAccountType
the hydra core vocabulary: name

GiftAccountType/isActive
type: Property
domain: GiftAccountType
the hydra core vocabulary: isActive
range: boolean

GiftAccountType/program
type: Property
domain: GiftAccountType
the hydra core vocabulary: program
range: string

GiftAccountType/category
type: Property
domain: GiftAccountType
the hydra core vocabulary: category
range: string

LoyaltyAccountType
type: Class
title: LoyaltyAccountType
supported property: SupportedProperty
  property: LoyaltyAccountType/accumulationRatioNumerator
  title: accumulationRatioNumerator
  required: false
  readable: true
  writeable: true
  description: Accumulation ratio numerator (points earned per dollar unit)
supported property: SupportedProperty
  property: LoyaltyAccountType/accumulationRatioDenominator
  title: accumulationRatioDenominator
  required: false
  readable: true
  writeable: true
  description: Accumulation ratio denominator (dollar unit for accumulation)
supported property: SupportedProperty
  property: LoyaltyAccountType/debitRatioNumerator
  title: debitRatioNumerator
  required: false
  readable: true
  writeable: true
  description: Debit ratio numerator (points spent per dollar unit)
supported property: SupportedProperty
  property: LoyaltyAccountType/debitRatioDenominator
  title: debitRatioDenominator
  required: false
  readable: true
  writeable: true
  description: Debit ratio denominator (dollar unit for redemption)
supported property: SupportedProperty
  property: LoyaltyAccountType/id
  title: id
  required: false
  readable: true
  writeable: true
  description: Account type ID
supported property: SupportedProperty
  property: LoyaltyAccountType/name
  title: name
  required: false
  readable: true
  writeable: true
  description: Account Type name by language code
supported property: SupportedProperty
  property: LoyaltyAccountType/isActive
  title: isActive
  required: false
  readable: true
  writeable: true
  description: Whether the account type is active
supported property: SupportedProperty
  property: LoyaltyAccountType/program
  title: program
  required: false
  readable: true
  writeable: true
  description: Program type
supported property: SupportedProperty
  property: LoyaltyAccountType/category
  title: category
  required: false
  readable: true
  writeable: true
  description: Account type category
supported operation: Operation
  type: FindAction
  description: Retrieves a LoyaltyAccountType resource.
  method: GET
  title: getLoyaltyAccountType
  returns: LoyaltyAccountType

LoyaltyAccountType/accumulationRatioNumerator
type: Property
domain: LoyaltyAccountType
the hydra core vocabulary: accumulationRatioNumerator
range: integer

LoyaltyAccountType/accumulationRatioDenominator
type: Property
domain: LoyaltyAccountType
the hydra core vocabulary: accumulationRatioDenominator
range: integer

LoyaltyAccountType/debitRatioNumerator
type: Property
domain: LoyaltyAccountType
the hydra core vocabulary: debitRatioNumerator
range: integer

LoyaltyAccountType/debitRatioDenominator
type: Property
domain: LoyaltyAccountType
the hydra core vocabulary: debitRatioDenominator
range: integer

LoyaltyAccountType/id
type: Property
domain: LoyaltyAccountType
the hydra core vocabulary: id
range: integer

LoyaltyAccountType/name
type: Property
domain: LoyaltyAccountType
the hydra core vocabulary: name

LoyaltyAccountType/isActive
type: Property
domain: LoyaltyAccountType
the hydra core vocabulary: isActive
range: boolean

LoyaltyAccountType/program
type: Property
domain: LoyaltyAccountType
the hydra core vocabulary: program
range: string

LoyaltyAccountType/category
type: Property
domain: LoyaltyAccountType
the hydra core vocabulary: category
range: string

PromoAccountType
type: Class
title: PromoAccountType
supported property: SupportedProperty
  property: PromoAccountType/isRechargeable
  title: isRechargeable
  required: false
  readable: true
  writeable: true
  description: Whether the account is rechargeable
supported property: SupportedProperty
  property: PromoAccountType/isTransferable
  title: isTransferable
  required: false
  readable: true
  writeable: true
  description: Whether the account is transferable between cards
supported property: SupportedProperty
  property: PromoAccountType/isRestrictedToWhereActivated
  title: isRestrictedToWhereActivated
  required: false
  readable: true
  writeable: true
  description: Whether the account is restricted to the location where it was activated
supported property: SupportedProperty
  property: PromoAccountType/minimumBalance
  title: minimumBalance
  required: false
  readable: true
  writeable: true
  description: Minimum balance allowed on the account
supported property: SupportedProperty
  property: PromoAccountType/maximumBalance
  title: maximumBalance
  required: false
  readable: true
  writeable: true
  description: Maximum balance allowed on the account
supported property: SupportedProperty
  property: PromoAccountType/minimumActivation
  title: minimumActivation
  required: false
  readable: true
  writeable: true
  description: Minimum amount for card activation
supported property: SupportedProperty
  property: PromoAccountType/maximumActivation
  title: maximumActivation
  required: false
  readable: true
  writeable: true
  description: Maximum amount for card activation
supported property: SupportedProperty
  property: PromoAccountType/minimumRedeem
  title: minimumRedeem
  required: false
  readable: true
  writeable: true
  description: Minimum redemption amount
supported property: SupportedProperty
  property: PromoAccountType/minimumReload
  title: minimumReload
  required: false
  readable: true
  writeable: true
  description: Minimum reload (recharge) amount
supported property: SupportedProperty
  property: PromoAccountType/maximumReload
  title: maximumReload
  required: false
  readable: true
  writeable: true
  description: Maximum reload (recharge) amount
supported property: SupportedProperty
  property: PromoAccountType/startDate
  title: startDate
  required: false
  readable: true
  writeable: true
  description: Start rule (null = at activation, YYYY-MM-DD = fixed date, e.g. "+30 days" = relative)
supported property: SupportedProperty
  property: PromoAccountType/expiryDate
  title: expiryDate
  required: false
  readable: true
  writeable: true
  description: Expiry rule (YYYY-MM-DD = fixed date, e.g. "+90 days" = relative from start)
supported property: SupportedProperty
  property: PromoAccountType/id
  title: id
  required: false
  readable: true
  writeable: true
  description: Account type ID
supported property: SupportedProperty
  property: PromoAccountType/name
  title: name
  required: false
  readable: true
  writeable: true
  description: Account Type name by language code
supported property: SupportedProperty
  property: PromoAccountType/isActive
  title: isActive
  required: false
  readable: true
  writeable: true
  description: Whether the account type is active
supported property: SupportedProperty
  property: PromoAccountType/program
  title: program
  required: false
  readable: true
  writeable: true
  description: Program type
supported property: SupportedProperty
  property: PromoAccountType/category
  title: category
  required: false
  readable: true
  writeable: true
  description: Account type category
supported operation: Operation
  type: FindAction
  description: Retrieves a PromoAccountType resource.
  method: GET
  title: getPromoAccountType
  returns: PromoAccountType

PromoAccountType/isRechargeable
type: Property
domain: PromoAccountType
the hydra core vocabulary: isRechargeable
range: boolean

PromoAccountType/isTransferable
type: Property
domain: PromoAccountType
the hydra core vocabulary: isTransferable
range: boolean

PromoAccountType/isRestrictedToWhereActivated
type: Property
domain: PromoAccountType
the hydra core vocabulary: isRestrictedToWhereActivated
range: boolean

PromoAccountType/minimumBalance
type: Property
domain: PromoAccountType
the hydra core vocabulary: minimumBalance

PromoAccountType/maximumBalance
type: Property
domain: PromoAccountType
the hydra core vocabulary: maximumBalance

PromoAccountType/minimumActivation
type: Property
domain: PromoAccountType
the hydra core vocabulary: minimumActivation

PromoAccountType/maximumActivation
type: Property
domain: PromoAccountType
the hydra core vocabulary: maximumActivation

PromoAccountType/minimumRedeem
type: Property
domain: PromoAccountType
the hydra core vocabulary: minimumRedeem

PromoAccountType/minimumReload
type: Property
domain: PromoAccountType
the hydra core vocabulary: minimumReload

PromoAccountType/maximumReload
type: Property
domain: PromoAccountType
the hydra core vocabulary: maximumReload

PromoAccountType/startDate
type: Property
domain: PromoAccountType
the hydra core vocabulary: startDate
range: string

PromoAccountType/expiryDate
type: Property
domain: PromoAccountType
the hydra core vocabulary: expiryDate
range: string

PromoAccountType/id
type: Property
domain: PromoAccountType
the hydra core vocabulary: id
range: integer

PromoAccountType/name
type: Property
domain: PromoAccountType
the hydra core vocabulary: name

PromoAccountType/isActive
type: Property
domain: PromoAccountType
the hydra core vocabulary: isActive
range: boolean

PromoAccountType/program
type: Property
domain: PromoAccountType
the hydra core vocabulary: program
range: string

PromoAccountType/category
type: Property
domain: PromoAccountType
the hydra core vocabulary: category
range: string

Merchant
type: Class
title: Merchant
supported property: SupportedProperty
  property: Merchant/name
  title: name
  required: false
  readable: true
  writeable: true
  description: Name of the merchant
supported property: SupportedProperty
  property: Merchant/storeNumber
  title: storeNumber
  required: false
  readable: true
  writeable: true
  description: Unique store number within the client
supported property: SupportedProperty
  property: Merchant/type
  title: type
  required: false
  readable: true
  writeable: true
  description: Merchant type (point_of_sale, head_office, e-commerce, web_pos, third_party, other)
supported property: SupportedProperty
  property: Merchant/language
  title: language
  required: false
  readable: true
  writeable: true
  description: Language code (en or fr)
supported property: SupportedProperty
  property: Merchant/timezone
  title: timezone
  required: false
  readable: true
  writeable: true
  description: Timezone (e.g., America/Toronto)
supported property: SupportedProperty
  property: Merchant/password
  title: password
  required: false
  readable: false
  writeable: true
  description: Merchant password (8 digits, 1-9 only)
supported property: SupportedProperty
  property: Merchant/email
  title: email
  required: false
  readable: true
  writeable: true
  description: Email address
supported property: SupportedProperty
  property: Merchant/phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
  description: Phone number
supported property: SupportedProperty
  property: Merchant/faxNumber
  title: faxNumber
  required: false
  readable: true
  writeable: true
  description: Fax number
supported property: SupportedProperty
  property: Merchant/contactName
  title: contactName
  required: false
  readable: true
  writeable: true
  description: Contact name
supported property: SupportedProperty
  property: Merchant/externalReference
  title: externalReference
  required: false
  readable: true
  writeable: true
  description: External reference ID
supported property: SupportedProperty
  property: Merchant/address
  title: address
  required: false
  readable: true
  writeable: true
  description: Address information
supported property: SupportedProperty
  property: Merchant/parent
  title: parent
  required: false
  readable: true
  writeable: true
  description: Parent merchant ID
supported property: SupportedProperty
  property: Merchant/latitude
  title: latitude
  required: false
  readable: true
  writeable: true
  description: Latitude coordinate (-90 to 90)
supported property: SupportedProperty
  property: Merchant/longitude
  title: longitude
  required: false
  readable: true
  writeable: true
  description: Longitude coordinate (-180 to 180)
supported property: SupportedProperty
  property: Merchant/terminalInitializationCode
  title: terminalInitializationCode
  required: false
  readable: true
  writeable: false
  description: Terminal initialization code
supported operation: Operation
  type: FindAction
  description: Retrieves a Merchant resource.
  method: GET
  title: getMerchant
  returns: Merchant
supported operation: Operation
  type: FindAction
  description: Retrieves a Merchant resource.
  method: GET
  title: getMerchant
  returns: Merchant
supported operation: Operation
  type: FindAction
  description: Retrieves a Merchant resource.
  method: GET
  title: getMerchant
  returns: Merchant
supported operation: Operation
  expects: Merchant
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  description: Updates the Merchant resource.
  method: PATCH
  title: patchMerchant
  returns: Merchant
supported operation: Operation
  expects: Merchant
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  description: Updates the Merchant resource.
  method: PATCH
  title: patchMerchant
  returns: Merchant

Merchant/name
type: Property
domain: Merchant
the hydra core vocabulary: name
range: string

Merchant/storeNumber
type: Property
domain: Merchant
the hydra core vocabulary: storeNumber
range: string

Merchant/type
type: Property
domain: Merchant
the hydra core vocabulary: type
range: string

Merchant/language
type: Property
domain: Merchant
the hydra core vocabulary: language
range: string

Merchant/timezone
type: Property
domain: Merchant
the hydra core vocabulary: timezone
range: string

Merchant/password
type: Property
domain: Merchant
the hydra core vocabulary: password
range: string

Merchant/email
type: Property
domain: Merchant
the hydra core vocabulary: email
range: string

Merchant/phoneNumber
type: Property
domain: Merchant
the hydra core vocabulary: phoneNumber
range: string

Merchant/faxNumber
type: Property
domain: Merchant
the hydra core vocabulary: faxNumber
range: string

Merchant/contactName
type: Property
domain: Merchant
the hydra core vocabulary: contactName
range: string

Merchant/externalReference
type: Property
domain: Merchant
the hydra core vocabulary: externalReference
range: string

Merchant/address
type: Property
domain: Merchant
the hydra core vocabulary: address

Merchant/parent
type: Property
domain: Merchant
the hydra core vocabulary: parent
range: integer

Merchant/latitude
type: Property
domain: Merchant
the hydra core vocabulary: latitude
range: decimal

Merchant/longitude
type: Property
domain: Merchant
the hydra core vocabulary: longitude
range: decimal

Merchant/terminalInitializationCode
type: Property
domain: Merchant
the hydra core vocabulary: terminalInitializationCode
range: string

Client
type: Class
title: Client
supported property: SupportedProperty
  property: Client/name
  title: name
  required: false
  readable: true
  writeable: true
  description: Name representing the client
supported property: SupportedProperty
  property: Client/hostname
  title: hostname
  required: false
  readable: true
  writeable: true
  description: Hostname for SBO client portals (lowercase letters, numbers and dashes only)
supported property: SupportedProperty
  property: Client/accessKey
  title: accessKey
  required: false
  readable: true
  writeable: true
  description: Access key for the created client
supported property: SupportedProperty
  property: Client/status
  title: status
  required: false
  readable: true
  writeable: true
  description: Client status. On PATCH only "active" or "suspended" are accepted.
supported property: SupportedProperty
  property: Client/externalReference
  title: externalReference
  required: false
  readable: true
  writeable: true
  description: Client's own reference id
supported property: SupportedProperty
  property: Client/country
  title: country
  required: false
  readable: true
  writeable: true
  description: Country code (CA or US)
supported property: SupportedProperty
  property: Client/timeZone
  title: timeZone
  required: false
  readable: true
  writeable: true
  description: Client timezone (e.g., America/Toronto)
supported property: SupportedProperty
  property: Client/currency
  title: currency
  required: false
  readable: true
  writeable: true
  description: Currency code (CAD or USD)
supported property: SupportedProperty
  property: Client/productPackage
  title: productPackage
  required: false
  readable: true
  writeable: true
  description: Product package name
supported property: SupportedProperty
  property: Client/billingPackages
  title: billingPackages
  required: false
  readable: true
  writeable: true
  description: Billing package names
supported property: SupportedProperty
  property: Client/languages
  title: languages
  required: false
  readable: true
  writeable: true
  description: Languages supported by the client (en, fr)
supported property: SupportedProperty
  property: Client/programs
  title: programs
  required: false
  readable: true
  writeable: true
  description: Programs enabled for the client (loyalty, gift)
supported property: SupportedProperty
  property: Client/creationDate
  title: creationDate
  required: false
  readable: true
  writeable: true
  description: Creation date
supported property: SupportedProperty
  property: Client/modificationDate
  title: modificationDate
  required: false
  readable: true
  writeable: true
  description: Modification date
supported property: SupportedProperty
  property: Client/accumulationRatioNumerator
  title: accumulationRatioNumerator
  required: false
  readable: true
  writeable: true
  description: Accumulation ratio numerator
supported property: SupportedProperty
  property: Client/accumulationRatioDenominator
  title: accumulationRatioDenominator
  required: false
  readable: true
  writeable: true
  description: Accumulation ratio denominator
supported property: SupportedProperty
  property: Client/debitRatioNumerator
  title: debitRatioNumerator
  required: false
  readable: true
  writeable: true
  description: Debit ratio numerator
supported property: SupportedProperty
  property: Client/debitRatioDenominator
  title: debitRatioDenominator
  required: false
  readable: true
  writeable: true
  description: Debit ratio denominator
supported property: SupportedProperty
  property: Client/allowRedemptionWhenProfileCompleted
  title: allowRedemptionWhenProfileCompleted
  required: false
  readable: true
  writeable: true
  description: Allow redemption when profile completed
supported property: SupportedProperty
  property: Client/cardStatusAfterFirstAccumulation
  title: cardStatusAfterFirstAccumulation
  required: false
  readable: true
  writeable: true
  description: Card status after first accumulation (ACTIVE or ACTIVE_NO_REDEEM)
supported property: SupportedProperty
  property: Client/reverseTransactionForExpiredCards
  title: reverseTransactionForExpiredCards
  required: false
  readable: true
  writeable: true
  description: Reverse transaction for expired cards
supported property: SupportedProperty
  property: Client/pointsCalculationMethod
  title: pointsCalculationMethod
  required: false
  readable: true
  writeable: true
  description: Points calculation method
supported property: SupportedProperty
  property: Client/smallBusinessOffering
  title: smallBusinessOffering
  required: false
  readable: true
  writeable: true
  description: Small business offering enabled
supported property: SupportedProperty
  property: Client/memberProfileAnonymization
  title: memberProfileAnonymization
  required: false
  readable: true
  writeable: true
  description: Member profile anonymization enabled
supported property: SupportedProperty
  property: Client/memberProfileAnonymizationDurationMonths
  title: memberProfileAnonymizationDurationMonths
  required: false
  readable: true
  writeable: true
  description: Member profile anonymization duration in months
supported property: SupportedProperty
  property: Client/memberProfileCreationRestriction
  title: memberProfileCreationRestriction
  required: false
  readable: true
  writeable: true
  description: Member profile creation age restriction enabled
supported property: SupportedProperty
  property: Client/memberAgeRestriction
  title: memberAgeRestriction
  required: false
  readable: true
  writeable: true
  description: Minimum age required for member profile creation
supported property: SupportedProperty
  property: Client/completeProfileRequiredFields
  title: completeProfileRequiredFields
  required: false
  readable: true
  writeable: true
  description: Complete profile mandatory fields
supported property: SupportedProperty
  property: Client/uniqueEmail
  title: uniqueEmail
  required: false
  readable: true
  writeable: true
  description: Unique email required for contacts
supported operation: Operation

Client/name
type: Property
domain: Client
the hydra core vocabulary: name
range: string

Client/hostname
type: Property
domain: Client
the hydra core vocabulary: hostname
range: string

Client/accessKey
type: Property
domain: Client
the hydra core vocabulary: accessKey
range: string

Client/status
type: Property
domain: Client
the hydra core vocabulary: status

Client/externalReference
type: Property
domain: Client
the hydra core vocabulary: externalReference
range: string

Client/country
type: Property
domain: Client
the hydra core vocabulary: country
range: string

Client/timeZone
type: Property
domain: Client
the hydra core vocabulary: timeZone
range: string

Client/currency
type: Property
domain: Client
the hydra core vocabulary: currency
range: string

Client/productPackage
type: Property
domain: Client
the hydra core vocabulary: productPackage
range: string

Client/billingPackages
type: Property
domain: Client
the hydra core vocabulary: billingPackages

Client/languages
type: Property
domain: Client
the hydra core vocabulary: languages

Client/programs
type: Property
domain: Client
the hydra core vocabulary: programs

Client/creationDate
type: Property
domain: Client
the hydra core vocabulary: creationDate
range: string

Client/modificationDate
type: Property
domain: Client
the hydra core vocabulary: modificationDate
range: string

Client/accumulationRatioNumerator
type: Property
domain: Client
the hydra core vocabulary: accumulationRatioNumerator
range: integer

Client/accumulationRatioDenominator
type: Property
domain: Client
the hydra core vocabulary: accumulationRatioDenominator
range: integer

Client/debitRatioNumerator
type: Property
domain: Client
the hydra core vocabulary: debitRatioNumerator
range: integer

Client/debitRatioDenominator
type: Property
domain: Client
the hydra core vocabulary: debitRatioDenominator
range: integer

Client/allowRedemptionWhenProfileCompleted
type: Property
domain: Client
the hydra core vocabulary: allowRedemptionWhenProfileCompleted
range: boolean

Client/cardStatusAfterFirstAccumulation
type: Property
domain: Client
the hydra core vocabulary: cardStatusAfterFirstAccumulation

Client/reverseTransactionForExpiredCards
type: Property
domain: Client
the hydra core vocabulary: reverseTransactionForExpiredCards
range: boolean

Client/pointsCalculationMethod
type: Property
domain: Client
the hydra core vocabulary: pointsCalculationMethod
range: string

Client/smallBusinessOffering
type: Property
domain: Client
the hydra core vocabulary: smallBusinessOffering
range: boolean

Client/memberProfileAnonymization
type: Property
domain: Client
the hydra core vocabulary: memberProfileAnonymization
range: boolean

Client/memberProfileAnonymizationDurationMonths
type: Property
domain: Client
the hydra core vocabulary: memberProfileAnonymizationDurationMonths
range: integer

Client/memberProfileCreationRestriction
type: Property
domain: Client
the hydra core vocabulary: memberProfileCreationRestriction
range: boolean

Client/memberAgeRestriction
type: Property
domain: Client
the hydra core vocabulary: memberAgeRestriction
range: integer

Client/completeProfileRequiredFields
type: Property
domain: Client
the hydra core vocabulary: completeProfileRequiredFields

Client/uniqueEmail
type: Property
domain: Client
the hydra core vocabulary: uniqueEmail
range: boolean

Client/uniquePhoneNumber
type: Property
domain: Client
the hydra core vocabulary: uniquePhoneNumber
range: boolean

Client/emailCampaign
type: Property
domain: Client
the hydra core vocabulary: emailCampaign
range: boolean

Client/lightsOut
type: Property
domain: Client
the hydra core vocabulary: lightsOut
range: boolean

Client/singleSignOn
type: Property
domain: Client
the hydra core vocabulary: singleSignOn
range: boolean

Client/identityProviderSettings
type: Property
domain: Client
the hydra core vocabulary: identityProviderSettings
range: string

Client/giftCardOrdersAnonymization
type: Property
domain: Client
the hydra core vocabulary: giftCardOrdersAnonymization
range: boolean

Client/giftCardOrdersAnonymizationDurationMonths
type: Property
domain: Client
the hydra core vocabulary: giftCardOrdersAnonymizationDurationMonths
range: integer

Client/configureEgift
type: Property
domain: Client
the hydra core vocabulary: configureEgift
range: boolean

Client/giftCardsRestrictedWhereActivated
type: Property
domain: Client
the hydra core vocabulary: giftCardsRestrictedWhereActivated
range: boolean

Client/configureEloyalty
type: Property
domain: Client
the hydra core vocabulary: configureEloyalty
range: boolean

Client/configureMemberPortal
type: Property
domain: Client
the hydra core vocabulary: configureMemberPortal
range: boolean

Client/enableSboEmailAndSms
type: Property
domain: Client
the hydra core vocabulary: enableSboEmailAndSms
range: boolean

Client/completedOn
type: Property
domain: Client
the hydra core vocabulary: completedOn
range: string

BalancePortal
type: Class
title: BalancePortal
supported property: SupportedProperty
  property: BalancePortal/isActive
  title: isActive
  required: false
  readable: true
  writeable: true
  description: Whether the balance portal is active
supported property: SupportedProperty
  property: BalancePortal/hasSecurityCode
  title: hasSecurityCode
  required: false
  readable: true
  writeable: true
  description: Whether security code (PIN) is required
supported property: SupportedProperty
  property: BalancePortal/isGiftcardOrderEnabled
  title: isGiftcardOrderEnabled
  required: false
  readable: true
  writeable: true
  description: Whether gift card ordering is enabled
supported property: SupportedProperty
  property: BalancePortal/isOnlineGiftcardEnabled
  title: isOnlineGiftcardEnabled
  required: false
  readable: true
  writeable: true
  description: Whether online gifting portal is enabled
supported property: SupportedProperty
  property: BalancePortal/isOnlineGiftcardHomepageEnabled
  title: isOnlineGiftcardHomepageEnabled
  required: false
  readable: true
  writeable: true
  description: Whether online gift card is shown on homepage (only when online gifting portal is enabled)
supported property: SupportedProperty
  property: BalancePortal/isRegiftEnabled
  title: isRegiftEnabled
  required: false
  readable: true
  writeable: true
  description: Whether regift functionality is enabled (only when online gifting portal is enabled)
supported property: SupportedProperty
  property: BalancePortal/balancePortalUrls
  title: balancePortalUrls
  required: false
  readable: true
  writeable: true
  description: Check your card balance site URLs by language code
supported property: SupportedProperty
  property: BalancePortal/onlineGiftcardPortalUrls
  title: onlineGiftcardPortalUrls
  required: false
  readable: true
  writeable: true
  description: Online gifting portal URLs by language code (only when online gifting portal is enabled)
supported property: SupportedProperty
  property: BalancePortal/displayName
  title: displayName
  required: false
  readable: true
  writeable: true
  description: Display name by language code
supported property: SupportedProperty
  property: BalancePortal/termsConditionsUrl
  title: termsConditionsUrl
  required: false
  readable: true
  writeable: true
  description: Terms and conditions URL by language code
supported property: SupportedProperty
  property: BalancePortal/privacyPolicyUrl
  title: privacyPolicyUrl
  required: false
  readable: true
  writeable: true
  description: Privacy policy URL by language code
supported operation: Operation
  type: FindAction
  description: Retrieves a BalancePortal resource.
  method: GET
  title: getBalancePortal
  returns: owl:Nothing

BalancePortal/isActive
type: Property
domain: BalancePortal
the hydra core vocabulary: isActive
range: boolean

BalancePortal/hasSecurityCode
type: Property
domain: BalancePortal
the hydra core vocabulary: hasSecurityCode
range: boolean

BalancePortal/isGiftcardOrderEnabled
type: Property
domain: BalancePortal
the hydra core vocabulary: isGiftcardOrderEnabled
range: boolean

BalancePortal/isOnlineGiftcardEnabled
type: Property
domain: BalancePortal
the hydra core vocabulary: isOnlineGiftcardEnabled
range: boolean

BalancePortal/isOnlineGiftcardHomepageEnabled
type: Property
domain: BalancePortal
the hydra core vocabulary: isOnlineGiftcardHomepageEnabled
range: boolean

BalancePortal/isRegiftEnabled
type: Property
domain: BalancePortal
the hydra core vocabulary: isRegiftEnabled
range: boolean

BalancePortal/balancePortalUrls
type: Property
domain: BalancePortal
the hydra core vocabulary: balancePortalUrls

BalancePortal/onlineGiftcardPortalUrls
type: Property
domain: BalancePortal
the hydra core vocabulary: onlineGiftcardPortalUrls

BalancePortal/displayName
type: Property
domain: BalancePortal
the hydra core vocabulary: displayName

BalancePortal/termsConditionsUrl
type: Property
domain: BalancePortal
the hydra core vocabulary: termsConditionsUrl

BalancePortal/privacyPolicyUrl
type: Property
domain: BalancePortal
the hydra core vocabulary: privacyPolicyUrl

MemberPortal
type: Class
title: MemberPortal
supported property: SupportedProperty
  property: MemberPortal/displayName
  title: displayName
  required: false
  readable: true
  writeable: true
  description: Display name per language
supported property: SupportedProperty
  property: MemberPortal/url
  title: url
  required: false
  readable: true
  writeable: true
  description: Member portal URL per language
supported property: SupportedProperty
  property: MemberPortal/isActive
  title: isActive
  required: false
  readable: true
  writeable: true
  description: Whether the member portal is active
supported property: SupportedProperty
  property: MemberPortal/allowDigitalCardCreation
  title: allowDigitalCardCreation
  required: false
  readable: true
  writeable: true
  description: Whether digital card creation is allowed
supported property: SupportedProperty
  property: MemberPortal/termsConditionsUrl
  title: termsConditionsUrl
  required: false
  readable: true
  writeable: true
  description: Terms and conditions URL per language
supported property: SupportedProperty
  property: MemberPortal/privacyPolicyUrl
  title: privacyPolicyUrl
  required: false
  readable: true
  writeable: true
  description: Privacy policy URL per language
supported operation: Operation
  type: FindAction
  description: Retrieves a MemberPortal resource.
  method: GET
  title: getMemberPortal
  returns: owl:Nothing

MemberPortal/displayName
type: Property
domain: MemberPortal
the hydra core vocabulary: displayName

MemberPortal/url
type: Property
domain: MemberPortal
the hydra core vocabulary: url

MemberPortal/isActive
type: Property
domain: MemberPortal
the hydra core vocabulary: isActive
range: boolean

MemberPortal/allowDigitalCardCreation
type: Property
domain: MemberPortal
the hydra core vocabulary: allowDigitalCardCreation
range: boolean

MemberPortal/termsConditionsUrl
type: Property
domain: MemberPortal
the hydra core vocabulary: termsConditionsUrl

MemberPortal/privacyPolicyUrl
type: Property
domain: MemberPortal
the hydra core vocabulary: privacyPolicyUrl

User
type: Class
title: User
supported property: SupportedProperty
  property: User/accessKey
  title: accessKey
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: User/username
  title: username
  required: false
  readable: true
  writeable: true
  description: Unique username for the user
supported property: SupportedProperty
  property: User/name
  title: name
  required: false
  readable: true
  writeable: true
  description: Full name of the user
supported property: SupportedProperty
  property: User/email
  title: email
  required: false
  readable: true
  writeable: true
  description: Email address of the user
supported property: SupportedProperty
  property: User/password
  title: password
  required: false
  readable: true
  writeable: true
  description: Password (HIGH complexity required: min 10 chars, uppercase, lowercase, number, special character)
supported property: SupportedProperty
  property: User/userGroupIds
  title: userGroupIds
  required: false
  readable: true
  writeable: true
  description: IDs of the user groups to assign to this user
supported property: SupportedProperty
  property: User/roles
  title: roles
  required: false
  readable: true
  writeable: true
  description: Role codes assigned to this user
supported property: SupportedProperty
  property: User/accessGroupId
  title: accessGroupId
  required: false
  readable: true
  writeable: true
  description: Restrict user access to a merchant access group by ID
supported property: SupportedProperty
  property: User/merchantId
  title: merchantId
  required: false
  readable: true
  writeable: true
  description: Restrict user access to a single merchant by ID
supported property: SupportedProperty
  property: User/isActive
  title: isActive
  required: false
  readable: true
  writeable: true
  description: Whether the user is active
supported property: SupportedProperty
  property: User/enforceTwoFactorAuth
  title: enforceTwoFactorAuth
  required: false
  readable: true
  writeable: true
  description: Whether to enforce two-factor authentication
supported property: SupportedProperty
  property: User/language
  title: language
  required: false
  readable: true
  writeable: true
  description: User language preference (en or fr)
supported property: SupportedProperty
  property: User/creationDate
  title: creationDate
  required: false
  readable: true
  writeable: true
  description: Date and time the user was created
supported property: SupportedProperty
  property: User/modificationDate
  title: modificationDate
  required: false
  readable: true
  writeable: true
  description: Date and time the user was last modified
supported property: SupportedProperty
  property: User/userGroups
  title: userGroups
  required: false
  readable: true
  writeable: true
  description: User groups assigned to this user, with their IDs and names
supported property: SupportedProperty
  property: User/twoFactorAuthEnabled
  title: twoFactorAuthEnabled
  required: false
  readable: true
  writeable: true
  description: Whether two-factor authentication is enabled for the user
supported property: SupportedProperty
  property: User/merchantAccessLevel
  title: merchantAccessLevel
  required: false
  readable: true
  writeable: true
  description: Merchant access: "all" grants access to all merchants, or an array of merchant IDs the user can access
supported operation: Operation
  type: FindAction
  description: Retrieves a User resource.
  method: GET
  title: getUser
  returns: User
supported operation: Operation
  expects: User
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  description: Updates the User resource.
  method: PATCH
  title: patchUser
  returns: User

User/accessKey
type: Property
domain: User
the hydra core vocabulary: accessKey
range: string

User/username
type: Property
domain: User
the hydra core vocabulary: username
range: string

User/name
type: Property
domain: User
the hydra core vocabulary: name
range: string

User/email
type: Property
domain: User
the hydra core vocabulary: email
range: string

User/password
type: Property
domain: User
the hydra core vocabulary: password
range: string

User/userGroupIds
type: Property
domain: User
the hydra core vocabulary: userGroupIds

User/roles
type: Property
domain: User
the hydra core vocabulary: roles

User/accessGroupId
type: Property
domain: User
the hydra core vocabulary: accessGroupId
range: integer

User/merchantId
type: Property
domain: User
the hydra core vocabulary: merchantId
range: integer

User/isActive
type: Property
domain: User
the hydra core vocabulary: isActive
range: boolean

User/enforceTwoFactorAuth
type: Property
domain: User
the hydra core vocabulary: enforceTwoFactorAuth
range: boolean

User/language
type: Property
domain: User
the hydra core vocabulary: language
range: string

User/creationDate
type: Property
domain: User
the hydra core vocabulary: creationDate
range: dateTime

User/modificationDate
type: Property
domain: User
the hydra core vocabulary: modificationDate
range: dateTime

User/userGroups
type: Property
domain: User
the hydra core vocabulary: userGroups

User/twoFactorAuthEnabled
type: Property
domain: User
the hydra core vocabulary: twoFactorAuthEnabled
range: boolean

User/merchantAccessLevel
type: Property
domain: User
the hydra core vocabulary: merchantAccessLevel

Contact
type: Class
title: Contact
supported property: SupportedProperty
  property: Contact/externalReference
  title: externalReference
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Contact/firstName
  title: firstName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Contact/lastName
  title: lastName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Contact/isActive
  title: isActive
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Contact/isComplete
  title: isComplete
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Contact/language
  title: language
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Contact/gender
  title: gender
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Contact/birthdate
  title: birthdate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Contact/email
  title: email
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Contact/phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Contact/phoneType
  title: phoneType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Contact/phoneNumberVerified
  title: phoneNumberVerified
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Contact/address
  title: address
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Contact/communicationPreference
  title: communicationPreference
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Contact/termsAndConditionsAcceptanceDate
  title: termsAndConditionsAcceptanceDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Contact/creationDate
  title: creationDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Contact/modificationDate
  title: modificationDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Contact/completionDate
  title: completionDate
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Contact resource.
  method: GET
  title: getContact
  returns: Contact

Contact/externalReference
type: Property
domain: Contact
the hydra core vocabulary: externalReference
range: string

Contact/firstName
type: Property
domain: Contact
the hydra core vocabulary: firstName
range: string

Contact/lastName
type: Property
domain: Contact
the hydra core vocabulary: lastName
range: string

Contact/isActive
type: Property
domain: Contact
the hydra core vocabulary: isActive
range: boolean

Contact/isComplete
type: Property
domain: Contact
the hydra core vocabulary: isComplete
range: boolean

Contact/language
type: Property
domain: Contact
the hydra core vocabulary: language
range: string

Contact/gender
type: Property
domain: Contact
the hydra core vocabulary: gender
range: string

Contact/birthdate
type: Property
domain: Contact
the hydra core vocabulary: birthdate
range: dateTime

Contact/email
type: Property
domain: Contact
the hydra core vocabulary: email
range: string

Contact/phoneNumber
type: Property
domain: Contact
the hydra core vocabulary: phoneNumber
range: string

Contact/phoneType
type: Property
domain: Contact
the hydra core vocabulary: phoneType

Contact/phoneNumberVerified
type: Property
domain: Contact
the hydra core vocabulary: phoneNumberVerified
range: boolean

Contact/address
type: Property
domain: Contact
the hydra core vocabulary: address

Contact/communicationPreference
type: Property
domain: Contact
the hydra core vocabulary: communicationPreference

Contact/termsAndConditionsAcceptanceDate
type: Property
domain: Contact
the hydra core vocabulary: termsAndConditionsAcceptanceDate
range: dateTime

Contact/creationDate
type: Property
domain: Contact
the hydra core vocabulary: creationDate
range: dateTime

Contact/modificationDate
type: Property
domain: Contact
the hydra core vocabulary: modificationDate
range: dateTime

Contact/completionDate
type: Property
domain: Contact
the hydra core vocabulary: completionDate
range: dateTime

Item
type: Class
title: Item
supported property: SupportedProperty
  property: Item/lineNumber
  title: lineNumber
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Item/quantity
  title: quantity
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Item/currentQuantity
  title: currentQuantity
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Item/amount
  title: amount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Item/points
  title: points
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Item/ipc
  title: ipc
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Item/upc
  title: upc
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Item/eligibleForAccumulation
  title: eligibleForAccumulation
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Item/transaction
  title: transaction
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Item resource.
  method: GET
  title: getItem
  returns: Item

Item/lineNumber
type: Property
domain: Item
the hydra core vocabulary: lineNumber
range: string

Item/quantity
type: Property
domain: Item
the hydra core vocabulary: quantity
range: string

Item/currentQuantity
type: Property
domain: Item
the hydra core vocabulary: currentQuantity
range: string

Item/amount
type: Property
domain: Item
the hydra core vocabulary: amount

Item/points
type: Property
domain: Item
the hydra core vocabulary: points
range: string

Item/ipc
type: Property
domain: Item
the hydra core vocabulary: ipc
range: string

Item/upc
type: Property
domain: Item
the hydra core vocabulary: upc
range: string

Item/eligibleForAccumulation
type: Property
domain: Item
the hydra core vocabulary: eligibleForAccumulation
range: boolean

Item/transaction
type: Property
domain: Item
the hydra core vocabulary: transaction

Reward
type: Class
title: Reward
supported property: SupportedProperty
  property: Reward/isActive
  title: isActive
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Reward/creationDate
  title: creationDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Reward/expireOnDate
  title: expireOnDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Reward/card
  title: card
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Reward/prototype
  title: prototype
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Reward/transactions
  title: transactions
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Reward/rewardValue
  title: rewardValue
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Reward/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Reward/sku
  title: sku
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Reward/quantity
  title: quantity
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Reward/labelEn
  title: labelEn
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Reward/labelFr
  title: labelFr
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Reward/redeemableItems
  title: redeemableItems
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Reward resource.
  method: GET
  title: getReward
  returns: Reward

Reward/isActive
type: Property
domain: Reward
the hydra core vocabulary: isActive
range: boolean

Reward/creationDate
type: Property
domain: Reward
the hydra core vocabulary: creationDate
range: dateTime

Reward/expireOnDate
type: Property
domain: Reward
the hydra core vocabulary: expireOnDate
range: dateTime

Reward/card
type: Property
domain: Reward
the hydra core vocabulary: card

Reward/prototype
type: Property
domain: Reward
the hydra core vocabulary: prototype

Reward/transactions
type: Property
domain: Reward
the hydra core vocabulary: transactions
range: LoyaltyTransaction

Reward/rewardValue
type: Property
domain: Reward
the hydra core vocabulary: rewardValue
range: decimal

Reward/type
type: Property
domain: Reward
the hydra core vocabulary: type
range: string

Reward/sku
type: Property
domain: Reward
the hydra core vocabulary: sku
range: string

Reward/quantity
type: Property
domain: Reward
the hydra core vocabulary: quantity
range: integer

Reward/labelEn
type: Property
domain: Reward
the hydra core vocabulary: labelEn
range: string

Reward/labelFr
type: Property
domain: Reward
the hydra core vocabulary: labelFr
range: string

Reward/redeemableItems
type: Property
domain: Reward
the hydra core vocabulary: redeemableItems

LoyaltyTransaction
type: Class
title: LoyaltyTransaction
supported property: SupportedProperty
  property: LoyaltyTransaction/amount
  title: amount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/currentAmount
  title: currentAmount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/points
  title: points
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/currentPoints
  title: currentPoints
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/rewards
  title: rewards
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/program
  title: program
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/confirmationNumber
  title: confirmationNumber
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/operation
  title: operation
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/originalOperation
  title: originalOperation
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/originalTransaction
  title: originalTransaction
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/invoiceNumber
  title: invoiceNumber
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/extendedInvoiceNumber
  title: extendedInvoiceNumber
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/workstationNumber
  title: workstationNumber
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/waiterNumber
  title: waiterNumber
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/commitStatus
  title: commitStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/clearinghouseStatus
  title: clearinghouseStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/cancellationStatus
  title: cancellationStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/batchStatus
  title: batchStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/errorCode
  title: errorCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/card
  title: card
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/merchant
  title: merchant
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/items
  title: items
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LoyaltyTransaction/creationDate
  title: creationDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LoyaltyTransaction/modificationDate
  title: modificationDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LoyaltyTransaction/contact
  title: contact
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a LoyaltyTransaction resource.
  method: GET
  title: getLoyaltyTransaction
  returns: LoyaltyTransaction

LoyaltyTransaction/amount
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: amount

LoyaltyTransaction/currentAmount
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: currentAmount

LoyaltyTransaction/points
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: points
range: decimal

LoyaltyTransaction/currentPoints
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: currentPoints
range: decimal

LoyaltyTransaction/rewards
type: Link
domain: LoyaltyTransaction
the hydra core vocabulary: rewards
range: Reward

LoyaltyTransaction/program
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: program

LoyaltyTransaction/confirmationNumber
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: confirmationNumber
range: integer

LoyaltyTransaction/operation
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: operation

LoyaltyTransaction/originalOperation
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: originalOperation

LoyaltyTransaction/originalTransaction
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: originalTransaction

LoyaltyTransaction/invoiceNumber
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: invoiceNumber
range: string

LoyaltyTransaction/extendedInvoiceNumber
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: extendedInvoiceNumber
range: string

LoyaltyTransaction/workstationNumber
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: workstationNumber
range: string

LoyaltyTransaction/waiterNumber
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: waiterNumber
range: string

LoyaltyTransaction/commitStatus
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: commitStatus

LoyaltyTransaction/clearinghouseStatus
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: clearinghouseStatus

LoyaltyTransaction/cancellationStatus
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: cancellationStatus

LoyaltyTransaction/batchStatus
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: batchStatus

LoyaltyTransaction/errorCode
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: errorCode
range: integer

LoyaltyTransaction/card
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: card

LoyaltyTransaction/merchant
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: merchant

LoyaltyTransaction/items
type: Link
domain: LoyaltyTransaction
the hydra core vocabulary: items
range: Item

LoyaltyTransaction/creationDate
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: creationDate
range: dateTime

LoyaltyTransaction/modificationDate
type: Property
domain: LoyaltyTransaction
the hydra core vocabulary: modificationDate
range: dateTime

LoyaltyTransaction/contact
type: Link
domain: LoyaltyTransaction
the hydra core vocabulary: contact
max cardinality: 1
range: Contact

PrepaidTransaction
type: Class
title: PrepaidTransaction
supported property: SupportedProperty
  property: PrepaidTransaction/amount
  title: amount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrepaidTransaction/currentAmount
  title: currentAmount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrepaidTransaction/program
  title: program
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrepaidTransaction/confirmationNumber
  title: confirmationNumber
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrepaidTransaction/operation
  title: operation
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrepaidTransaction/originalOperation
  title: originalOperation
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrepaidTransaction/originalTransaction
  title: originalTransaction
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrepaidTransaction/invoiceNumber
  title: invoiceNumber
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrepaidTransaction/extendedInvoiceNumber
  title: extendedInvoiceNumber
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrepaidTransaction/workstationNumber
  title: workstationNumber
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrepaidTransaction/waiterNumber
  title: waiterNumber
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrepaidTransaction/commitStatus
  title: commitStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrepaidTransaction/clearinghouseStatus
  title: clearinghouseStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrepaidTransaction/cancellationStatus
  title: cancellationStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrepaidTransaction/batchStatus
  title: batchStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrepaidTransaction/errorCode
  title: errorCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrepaidTransaction/card
  title: card
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrepaidTransaction/merchant
  title: merchant
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrepaidTransaction/items
  title: items
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrepaidTransaction/creationDate
  title: creationDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrepaidTransaction/modificationDate
  title: modificationDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrepaidTransaction/contact
  title: contact
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a PrepaidTransaction resource.
  method: GET
  title: getPrepaidTransaction
  returns: PrepaidTransaction

PrepaidTransaction/amount
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: amount

PrepaidTransaction/currentAmount
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: currentAmount

PrepaidTransaction/program
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: program

PrepaidTransaction/confirmationNumber
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: confirmationNumber
range: integer

PrepaidTransaction/operation
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: operation

PrepaidTransaction/originalOperation
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: originalOperation

PrepaidTransaction/originalTransaction
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: originalTransaction

PrepaidTransaction/invoiceNumber
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: invoiceNumber
range: string

PrepaidTransaction/extendedInvoiceNumber
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: extendedInvoiceNumber
range: string

PrepaidTransaction/workstationNumber
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: workstationNumber
range: string

PrepaidTransaction/waiterNumber
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: waiterNumber
range: string

PrepaidTransaction/commitStatus
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: commitStatus

PrepaidTransaction/clearinghouseStatus
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: clearinghouseStatus

PrepaidTransaction/cancellationStatus
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: cancellationStatus

PrepaidTransaction/batchStatus
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: batchStatus

PrepaidTransaction/errorCode
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: errorCode
range: integer

PrepaidTransaction/card
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: card

PrepaidTransaction/merchant
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: merchant

PrepaidTransaction/items
type: Link
domain: PrepaidTransaction
the hydra core vocabulary: items
range: Item

PrepaidTransaction/creationDate
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: creationDate
range: dateTime

PrepaidTransaction/modificationDate
type: Property
domain: PrepaidTransaction
the hydra core vocabulary: modificationDate
range: dateTime

PrepaidTransaction/contact
type: Link
domain: PrepaidTransaction
the hydra core vocabulary: contact
max cardinality: 1
range: Contact

Webhook
type: Class
title: Webhook
supported property: SupportedProperty
  property: Webhook/name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/callbackUrl
  title: callbackUrl
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/secretToken
  title: secretToken
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/events
  title: events
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/merchants
  title: merchants
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/creationDate
  title: creationDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Webhook/modificationDate
  title: modificationDate
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Webhook resource.
  method: GET
  title: getWebhook
  returns: Webhook
supported operation: Operation
  expects: Webhook
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  description: Updates the Webhook resource.
  method: PATCH
  title: patchWebhook
  returns: Webhook
supported operation: Operation
  type: ReplaceAction
  expects: Webhook
  description: Replaces the Webhook resource.
  method: PUT
  title: putWebhook
  returns: Webhook
description: Webhooks let you subscribe to certain events and be notified

Webhook/name
type: Property
domain: Webhook
the hydra core vocabulary: name
range: string

Webhook/active
type: Property
domain: Webhook
the hydra core vocabulary: active
range: boolean

Webhook/callbackUrl
type: Property
domain: Webhook
the hydra core vocabulary: callbackUrl
range: string

Webhook/secretToken
type: Property
domain: Webhook
the hydra core vocabulary: secretToken
range: string

Webhook/events
type: Property
domain: Webhook
the hydra core vocabulary: events

Webhook/merchants
type: Property
domain: Webhook
the hydra core vocabulary: merchants

Webhook/creationDate
type: Property
domain: Webhook
the hydra core vocabulary: creationDate
range: dateTime

Webhook/modificationDate
type: Property
domain: Webhook
the hydra core vocabulary: modificationDate
range: dateTime

Entrypoint
type: Class
title: Entrypoint
supported property: SupportedProperty
  property: Entrypoint/giftAccountType
  title: getGiftAccountTypeCollection
  description: The collection of GiftAccountType resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/loyaltyAccountType
  title: getLoyaltyAccountTypeCollection
  description: The collection of LoyaltyAccountType resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/promoAccountType
  title: getPromoAccountTypeCollection
  description: The collection of PromoAccountType resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/merchant
  title: getMerchantCollection
  description: The collection of Merchant resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/client
  title: getClientCollection
  description: The collection of Client resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/balancePortal
  title: getBalancePortalCollection
  description: The collection of BalancePortal resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/memberPortal
  title: getMemberPortalCollection
  description: The collection of MemberPortal resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/user
  title: getUserCollection
  description: The collection of User resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/contact
  title: getContactCollection
  description: The collection of Contact resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/loyaltyTransaction
  title: getLoyaltyTransactionCollection
  description: The collection of LoyaltyTransaction resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/prepaidTransaction
  title: getPrepaidTransactionCollection
  description: The collection of PrepaidTransaction resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/webhook
  title: getWebhookCollection
  description: The collection of Webhook resources
  readable: true
  writeable: false
supported operation: Operation
  method: GET
  title: index
  description: The API Entrypoint.
  returns: Entrypoint

Entrypoint/giftAccountType
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: GiftAccountType
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of GiftAccountType resources.
  method: GET
  title: getGiftAccountTypeCollection
  returns: hydra:Collection

Entrypoint/loyaltyAccountType
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: LoyaltyAccountType
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of LoyaltyAccountType resources.
  method: GET
  title: getLoyaltyAccountTypeCollection
  returns: hydra:Collection

Entrypoint/promoAccountType
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: PromoAccountType
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of PromoAccountType resources.
  method: GET
  title: getPromoAccountTypeCollection
  returns: hydra:Collection

Entrypoint/merchant
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Merchant
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Merchant resources.
  method: GET
  title: getMerchantCollection
  returns: hydra:Collection
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Merchant resources.
  method: GET
  title: getMerchantCollection
  returns: hydra:Collection
supported operation: Operation
  type: CreateAction
  expects: Merchant
  description: Creates a Merchant resource.
  method: POST
  title: postMerchant
  returns: Merchant

Entrypoint/client
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Client
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Client resources.
  method: GET
  title: getClientCollection
  returns: hydra:Collection
supported operation: Operation
  type: CreateAction
  expects: Client
  description: Creates a Client resource.
  method: POST
  title: postClient
  returns: Client
supported operation: Operation
  type: CreateAction
  expects: Client
  description: Creates a Client resource.
  method: POST
  title: postClient
  returns: Client

Entrypoint/balancePortal
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: BalancePortal
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of BalancePortal resources.
  method: GET
  title: getBalancePortalCollection
  returns: hydra:Collection

Entrypoint/memberPortal
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: MemberPortal
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of MemberPortal resources.
  method: GET
  title: getMemberPortalCollection
  returns: hydra:Collection

Entrypoint/user
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of User resources.
  method: GET
  title: getUserCollection
  returns: hydra:Collection
supported operation: Operation
  type: CreateAction
  expects: User
  description: Creates a User resource.
  method: POST
  title: postUser
  returns: User

Entrypoint/contact
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Contact
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Contact resources.
  method: GET
  title: getContactCollection
  returns: hydra:Collection

Entrypoint/loyaltyTransaction
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: LoyaltyTransaction
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of LoyaltyTransaction resources.
  method: GET
  title: getLoyaltyTransactionCollection
  returns: hydra:Collection

Entrypoint/prepaidTransaction
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: PrepaidTransaction
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of PrepaidTransaction resources.
  method: GET
  title: getPrepaidTransactionCollection
  returns: hydra:Collection

Entrypoint/webhook
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Webhook
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Webhook resources.
  method: GET
  title: getWebhookCollection
  returns: hydra:Collection
supported operation: Operation
  type: CreateAction
  expects: Webhook
  description: Creates a Webhook resource.
  method: POST
  title: postWebhook
  returns: Webhook

ConstraintViolationList
type: Class
title: ConstraintViolationList
description: A constraint violation List.
supported property: SupportedProperty
  property: ConstraintViolationList/propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolationList/message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

ConstraintViolationList/propertyPath
type: Property
label: propertyPath
domain: ConstraintViolationList
range: string

ConstraintViolationList/message
type: Property
label: message
domain: ConstraintViolationList
range: string

SupportedProperty
property: Client/uniquePhoneNumber
title: uniquePhoneNumber
required: false
readable: true
writeable: true
description: Unique phone number required for contacts

SupportedProperty
property: Client/emailCampaign
title: emailCampaign
required: false
readable: true
writeable: true
description: Email campaign enabled

SupportedProperty
property: Client/lightsOut
title: lightsOut
required: false
readable: true
writeable: true
description: Lights out mode enabled

SupportedProperty
property: Client/singleSignOn
title: singleSignOn
required: false
readable: true
writeable: true
description: Single sign-on enabled

SupportedProperty
property: Client/identityProviderSettings
title: identityProviderSettings
required: false
readable: true
writeable: true
description: Identity provider settings for SSO

SupportedProperty
property: Client/giftCardOrdersAnonymization
title: giftCardOrdersAnonymization
required: false
readable: true
writeable: true
description: Gift card orders anonymization enabled

SupportedProperty
property: Client/giftCardOrdersAnonymizationDurationMonths
title: giftCardOrdersAnonymizationDurationMonths
required: false
readable: true
writeable: true
description: Gift card orders anonymization duration in months

SupportedProperty
property: Client/configureEgift
title: configureEgift
required: false
readable: true
writeable: true
description: Only used when Portfolio is Moneris

SupportedProperty
property: Client/giftCardsRestrictedWhereActivated
title: giftCardsRestrictedWhereActivated
required: false
readable: true
writeable: true
description: Only used when Portfolio is Moneris

SupportedProperty
property: Client/configureEloyalty
title: configureEloyalty
required: false
readable: true
writeable: true
description: Only used when Portfolio is Moneris

SupportedProperty
property: Client/configureMemberPortal
title: configureMemberPortal
required: false
readable: true
writeable: true
description: Only used when Portfolio is Moneris

SupportedProperty
property: Client/enableSboEmailAndSms
title: enableSboEmailAndSms
required: false
readable: true
writeable: true
description: Only used when Portfolio is Moneris

SupportedProperty
property: Client/completedOn
title: completedOn
required: false
readable: true
writeable: true
description: Date when client onboarding was completed

Operation
type: FindAction
description: Retrieves a Client resource.
method: GET
title: getClient
returns: Client

Operation
expects: Client
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
description: Updates the Client resource.
method: PATCH
title: patchClient
returns: Client