Skip to content

Add fiscalDeviceIdentifier to the POS Device API - #4682

Open
shopifyzach wants to merge 2 commits into
Shopify:2026-10-rcfrom
shopifyzach:zm/pos-device-fiscal-device-identifier
Open

Add fiscalDeviceIdentifier to the POS Device API#4682
shopifyzach wants to merge 2 commits into
Shopify:2026-10-rcfrom
shopifyzach:zm/pos-device-fiscal-device-identifier

Conversation

@shopifyzach

@shopifyzach shopifyzach commented Sep 10, 2026

Copy link
Copy Markdown

Background

The GraphQL Admin API exposes a PointOfSaleDevice.fiscalDeviceIdentifier (API version 2026-10). Today the only way for a POS UI extension to read it is shopify.session.deviceId → build a GID → query pointOfSaleDevice(id:) via the Direct API. That path is online-only, requires an Admin API access scope, costs a network round-trip.

Solution

Adds an optional, static property to the POS Device API:

shopify.device.fiscalDeviceIdentifier?: string;
  • Lives on device alongside name and registerName, which already mirrors the Admin API's PointOfSaleDevice.handle — same class of Shopify-assigned device identity data. session describes who/where (shop, user, location, staff); device describes the hardware.
  • Same name as the Admin API field, because it is the same value — developers can correlate it across surfaces.
  • Static string rather than a signal: it doesn't change for the lifetime of a device registration (same as registerName).
  • undefined when the device's location doesn't require fiscal device registration. Only available on API version 2026-10 and later; the host exposes it version-gated (same approach as session.deviceId).

Companion changes: the extensibility host devicePlugin reads it from the POS domain bridge and exposes it for 2026-10+; POS Mobile supplies the value it already holds locally after device registration.

Docs generate from the JSDoc; the checked-in generated_docs_data_v2.json is regenerated in the usual docs(pos): generate … PR rather than here.

Checklist

  • I have 🎩'd these changes
    • Can only be tophatted once the host plugin and POS Mobile changes ship
  • I have updated relevant documentation

Assisted-By: devx/1708ff34-a106-41ca-9351-71084c02cdf4
Assisted-By: devx/1708ff34-a106-41ca-9351-71084c02cdf4
@shopifyzach
shopifyzach marked this pull request as ready for review September 10, 2026 16:19
*/
registerName: string;
/**
* The Shopify-assigned fiscal register identifier for the device, such as Sweden's manufacturing number (tillverkningsnummer). It's the same value as the `fiscalDeviceIdentifier` field on the [PointOfSaleDevice](https://shopify.dev/docs/api/admin-graphql/latest/objects/PointOfSaleDevice) object in the GraphQL Admin API, and it's available while the device is offline.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it isn't available on latest as linked, only the RC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants