RegisterCodeInput

Input for registerCode.

input RegisterCodeInput {
  codeId: ID
  pointOfSaleId: ID
}

Fields

RegisterCodeInput.codeId ● ID scalar

ID of an existing code of the current account that is not registered yet, for example a pre-printed one. Omit to generate a new code. An unknown code fails with the error Code not found; a registered code fails with Code already registered.

RegisterCodeInput.pointOfSaleId ● ID scalar

ID of a point of sale of the current account to attach the code to. If omitted: when the account has exactly 1 point of sale, that one is used; when it has none and at most 1 store, a store (if there is none) and a VIRTUAL point of sale are created, both named after the business; when it has more than 1 point of sale, or none and more than 1 store, the call fails with the error Parameter "pointOfSaleId" is required. The automatic choice can still fail as ambiguous after points of sale or stores were deleted.

Member Of

registerCode mutation