UpdatePointOfSaleInput

Input for updatePointOfSale. All fields except id are optional; omitted fields are left unchanged.

input UpdatePointOfSaleInput {
  id: ID!
  storeId: ID
  name: String
  description: String
  manualAmount: Boolean
  requireEmail: Boolean
  requireTaxId: Boolean
  fixedAmount: Int
  fixedCurrency: Currencies
  enabled: Boolean
  includeQRCode: Boolean
  qrCodeText: String
  paymentCallbackUrl: String
  transactionType: TransactionTypes
  paymentMethods: [PaymentMethods!]
  deviceId: String
}

Fields

UpdatePointOfSaleInput.id ● ID! non-null scalar

POS ID to update.

UpdatePointOfSaleInput.storeId ● ID scalar

Parent store ID.

UpdatePointOfSaleInput.name ● String scalar

Display name.

UpdatePointOfSaleInput.description ● String scalar

Free-form description.

UpdatePointOfSaleInput.manualAmount ● Boolean scalar

Allow the operator to enter an arbitrary amount.

UpdatePointOfSaleInput.requireEmail ● Boolean scalar

Require the customer to provide an email address.

UpdatePointOfSaleInput.requireTaxId ● Boolean scalar

Require the customer to provide a tax ID.

UpdatePointOfSaleInput.fixedAmount ● Int scalar

Pre-set amount in the smallest currency unit.

UpdatePointOfSaleInput.fixedCurrency ● Currencies enum

Currency for fixedAmount.

UpdatePointOfSaleInput.enabled ● Boolean scalar

Enabled state.

UpdatePointOfSaleInput.includeQRCode ● Boolean scalar

Embed a QR code with the payment link in the confirmation email.

UpdatePointOfSaleInput.qrCodeText ● String scalar

Caption rendered next to the QR code in the confirmation email.

UpdatePointOfSaleInput.paymentCallbackUrl ● String scalar

Server-to-server HTTP POST URL invoked when a charge succeeds at this POS.

UpdatePointOfSaleInput.transactionType ● TransactionTypes enum

Default transaction type for charges created at this POS.

UpdatePointOfSaleInput.paymentMethods ● [PaymentMethods!] list enum

Allow-list of payment methods.

UpdatePointOfSaleInput.deviceId ● String scalar

Hardware device identifier.

Member Of

updatePointOfSale mutation