For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get device information

Fetch device info for current device given in token

get
/device
Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Responses
200

Example response

application/json

Info for a device

deviceIdentifierstringRequired
deviceUidstringRequiredPattern: ^[A-Za-z0-9-_]+
namestringRequired
get/device
GET /v2/device HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "availablePaymentMethods": [
    {
      "allowRefund": true,
      "allowSale": true,
      "allowCashback": true,
      "allowPrepayment": true,
      "name": "text",
      "parameters": [
        {
          "name": "text",
          "description": "text",
          "required": true,
          "key": "text",
          "keyType": "TEXT",
          "regex": "text"
        }
      ],
      "paymentCode": "CASH",
      "storePaymentMethodUid": "text",
      "requirements": {
        "requireCustomer": true,
        "requireCustomerMobile": true,
        "requireCustomerEmail": true,
        "requireCustomerType": "ANY",
        "requireCustomerContact": true,
        "requireExclusiveUse": true,
        "requireRefundToSameMethod": true
      },
      "settlementCode": "text",
      "visibility": "FEATURED",
      "position": 1,
      "description": "text",
      "receiptText": "text",
      "amountInput": "NONE",
      "useRounding": true
    }
  ],
  "zeroAmountPaymentMethod": {
    "allowRefund": true,
    "allowSale": true,
    "allowCashback": true,
    "allowPrepayment": true,
    "name": "text",
    "parameters": [
      {
        "name": "text",
        "description": "text",
        "required": true,
        "key": "text",
        "keyType": "TEXT",
        "regex": "text"
      }
    ],
    "paymentCode": "CASH",
    "storePaymentMethodUid": "text",
    "requirements": {
      "requireCustomer": true,
      "requireCustomerMobile": true,
      "requireCustomerEmail": true,
      "requireCustomerType": "ANY",
      "requireCustomerContact": true,
      "requireExclusiveUse": true,
      "requireRefundToSameMethod": true
    },
    "settlementCode": "text",
    "visibility": "FEATURED",
    "position": 1,
    "description": "text",
    "receiptText": "text",
    "amountInput": "NONE",
    "useRounding": true
  },
  "availableReasons": {
    "discount": [
      {
        "code": "text",
        "description": "text",
        "requiresReference": true,
        "reasonUid": "text"
      }
    ],
    "return": [
      {
        "code": "text",
        "description": "text",
        "requiresReference": true,
        "reasonUid": "text"
      }
    ]
  },
  "deviceIdentifier": "text",
  "deviceUid": "text",
  "storeInfo": {
    "address": "text",
    "city": "text",
    "countryCode": "text",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "defaultWarehouseUid": "text",
    "defaultReturnWarehouseUid": "text",
    "defaultDeliveryWarehouseUid": "text",
    "email": "text",
    "externalId": "text",
    "isActive": true,
    "lastModifiedAt": "2026-01-01T00:00:00.000Z",
    "latitude": 1,
    "longitude": 1,
    "name": "text",
    "postalCode": "text",
    "phone": "text",
    "purchaseNumberSeriesUid": "text",
    "internalPurchaseNumberSeriesUid": "text",
    "rmaOrderNumberSeriesUid": "text",
    "customerLedgerNumberSeriesUid": "text",
    "quicksaleCategoryUid": "text",
    "receiptMessage": "text",
    "emailReceiptMessage": "text",
    "exchangenoteMessage": "text",
    "exchangenoteValidDays": 1,
    "salesPriceUid": "text",
    "purchasePriceListUid": "text",
    "appSettings": {
      "hidePurchase": true,
      "hideReceivement": true,
      "enableUnlinkedPayments": true,
      "requireGtinScanBeforeDeliverOut": true
    },
    "storeUid": "text",
    "vatNumber": "text",
    "voucherNumberSeriesUid": "text",
    "serviceNumberSeriesUid": "text",
    "hasWorkShop": true,
    "organizationUid": "text",
    "availableExtensions": [
      {
        "extensionCode": "FLOWGIFTCARD",
        "name": "text"
      }
    ],
    "openingHours": {
      "monday": "text",
      "tuesday": "text",
      "wednesday": "text",
      "thursday": "text",
      "friday": "text",
      "saturday": "text",
      "sunday": "text",
      "note": "text"
    },
    "bankInfo": {
      "accountNumber": "text",
      "bankName": "text",
      "iban": "text",
      "swift": "text",
      "giroAccountNumber": "text"
    },
    "websiteUrl": "text",
    "invoiceFooterText": "text",
    "labelComparisonPricelistUid": "text",
    "addresses": [
      {
        "storeAddressUid": "text",
        "companyName": "text",
        "vatNumber": "text",
        "address": "text",
        "postalCode": "text",
        "city": "text",
        "countryCode": "text",
        "email": "text",
        "phone": "text",
        "type": "PURCHASE_INVOICE_ADDRESS",
        "default": true,
        "createdBy": "text",
        "createdAt": "2026-01-01T00:00:00.000Z",
        "lastModifiedBy": "text",
        "lastModifiedAt": "2026-01-01T00:00:00.000Z"
      }
    ],
    "enableStoreCashReconciliation": true,
    "cashReconciliationCutOffTime": "00:00:00",
    "logoAssetUid": "text",
    "representingCustomerUid": "text",
    "representingSupplierUid": "text",
    "fiscal": {
      "locationId": "text",
      "locationState": ""
    }
  },
  "tenantInfo": {
    "countryCode": "text",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "lastModifiedAt": "2026-01-01T00:00:00.000Z",
    "name": "text",
    "pricelistUid": "text",
    "tenantUid": "text",
    "vatNumber": "text",
    "settings": {
      "allowExternalCashDrawer": false,
      "autoLogout": 1,
      "autoPrintReceipt": true,
      "numericSkuCounter": 1,
      "printCardPaymentDetails": false,
      "sendInvoicesExternally": true,
      "duplicateCheckCustomerPhoneNumber": true,
      "duplicateCheckCustomerVatNumber": true,
      "useOriginalSellerOnCreditLine": true,
      "defaultCustomerGroupUid": "text",
      "printReceiptNumber": true,
      "requiredCustomerFields": [
        "email"
      ],
      "requiredCompanyFields": [
        "email"
      ],
      "requiredCompanyDepartmentFields": [
        "email"
      ],
      "requiredContactFields": [
        "email"
      ],
      "enforceStrongPin": true,
      "customerContactsRequiresEmail": true,
      "customerContactsEmailDuplicateCheck": true
    },
    "appSettings": {
      "showOutOfStockWarning": true,
      "defaultParkedOrderLifespanDays": 1,
      "requirePinCodeForSale": true,
      "requirePinCodeForCredit": true,
      "autoSendWelcomeSms": true,
      "autoSendWelcomeMail": true,
      "defaultCustomerGroupUid": "text",
      "helpUrl": "https://example.com"
    },
    "extensions": [
      {
        "extensionCode": "FLOWGIFTCARD",
        "name": "text",
        "active": true,
        "tenantExtensionUid": "text"
      }
    ],
    "assets": {
      "logo": {
        "url": "text",
        "assetUid": "text"
      },
      "splash": {
        "url": "text",
        "assetUid": "text"
      }
    },
    "timezone": "text",
    "languageCode": "text",
    "currency": {
      "code": "text",
      "name": "text",
      "symbol": "text",
      "symbolPosition": "text",
      "decimalSeparator": "text",
      "thousandSeparator": "text",
      "cashRounding": 1
    }
  },
  "tillInfo": {
    "cashDrawer": "text",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "lastModifiedAt": "2026-01-01T00:00:00.000Z",
    "lastOrderUid": "text",
    "lastOrderNumber": "text",
    "name": "text",
    "paymentTerminal": "NONE",
    "settings": [
      {
        "key": "STRIPE_TERMINAL_ID",
        "value": "text"
      }
    ],
    "status": "OPEN",
    "tillUid": "text",
    "tillNumber": 1,
    "device": {
      "deviceUid": "text",
      "identifier": "text",
      "name": "text"
    },
    "fiscal": {
      "registerId": "text",
      "registerState": "",
      "registerDesignation": "text"
    }
  },
  "currencyDenominations": [
    {
      "currencyCode": "text",
      "denomination": 1,
      "material": "COIN"
    }
  ],
  "name": "text",
  "settings": [
    {
      "key": "text",
      "value": "text",
      "type": "STRING",
      "allowedValues": [
        "text"
      ],
      "validationRegex": "text",
      "name": "text",
      "required": true
    }
  ],
  "printers": [
    {
      "printerUid": "text",
      "name": "text",
      "type": "LABEL",
      "availablePrintActions": [
        "RECEIPT"
      ]
    }
  ]
}

Last updated

Was this helpful?