API referenceHardware

Hardware

1 operation. Every schema and example on this page is generated from the platform contract.

List a store's hardware assets (NFC auth cards + stamp stickers).

Merchant browses their hardware inventory, every NFC auth card and stamp sticker for the store, ordered newest-first, each row enriched with its linked staff token (name, public id, active state) and hardware order (number, status, tracking), plus per-row freeze / unfreeze / replace affordances and a rollup summary of active, frozen, needs-action, ready-to-activate, and replacement-pending counts.

Parameters

store_idstring · uuidqueryrequired

Store whose hardware assets to list (also authorises the merchant).

Response, 200

storeobjectrequired
3 child fields
idstringrequired
namestring, nullablerequired
codestring, nullablerequired
summaryobjectrequired
6 child fields
activeAuthCardsnumberrequired
activeStampStickersnumberrequired
frozenItemsnumberrequired
needsActionnumberrequired
readyToActivatenumberrequired
replacementPendingnumberrequired
assetsarray of objectrequired
34 child fields
idstringrequired
store_idstringrequired
asset_typestringrequired
statusstringrequired
display_namestringrequired
tag_uidstring, nullablerequired
key_versionnumber, nullablerequired
staff_token_idstring, nullablerequired
hardware_order_idstring, nullablerequired
replaces_asset_idstring, nullablerequired
replaced_by_asset_idstring, nullablerequired
frozen_atstring, nullablerequired
frozen_reasonstring, nullablerequired
deactivated_atstring, nullablerequired
deactivation_reasonstring, nullablerequired
programmed_atstring, nullablerequired
received_atstring, nullablerequired
activated_atstring, nullablerequired
last_verified_atstring, nullablerequired
last_seen_atstring, nullablerequired
last_seen_counternumberrequired
physical_label_codestring, nullablerequired
created_atstringrequired
updated_atstringrequired
token_namestring, nullablerequired
token_public_idstring, nullablerequired
token_is_activeboolean, nullablerequired
order_numberstring, nullablerequired
order_statusstring, nullablerequired
tracking_numberstring, nullablerequired
tracking_urlstring, nullablerequired
can_freezebooleanrequired
can_unfreezebooleanrequired
can_replacebooleanrequired
curl -G "https://www.membber.com/api/v1/hardware/assets" \
  -H "Authorization: Bearer $MEMBBER_TOKEN" \
  --data-urlencode "store_id=6659c139-0000-4000-8000-d0c500000066"
Response, 200
{
  "store": {
    "id": "00000d1b-0000-4000-8000-d0c500000000",
    "name": "Example name",
    "code": "EXAMPLE10"
  },
  "summary": {
    "activeAuthCards": 1,
    "activeStampStickers": 1,
    "frozenItems": 1,
    "needsAction": 1,
    "readyToActivate": 1,
    "replacementPending": 1
  },
  "assets": [
    {
      "id": "00000d1b-0000-4000-8000-d0c500000000",
      "store_id": "6659c139-0000-4000-8000-d0c500000066",
      "asset_type": "<asset_type>",
      "status": "<status>",
      "display_name": "<display_name>",
      "tag_uid": "<tag_uid>",
      "key_version": 1,
      "staff_token_id": "e04cf3a0-0000-4000-8000-d0c5000000e0",
      "hardware_order_id": "429f7023-0000-4000-8000-d0c500000042",
      "replaces_asset_id": "477844ca-0000-4000-8000-d0c500000047",
      "replaced_by_asset_id": "11eab223-0000-4000-8000-d0c500000011",
      "frozen_at": "<frozen_at>",
      "frozen_reason": "Added at the front desk",
      "deactivated_at": "<deactivated_at>",
      "deactivation_reason": "Added at the front desk",
      "programmed_at": "<programmed_at>",
      "received_at": "<received_at>",
      "activated_at": "<activated_at>",
      "last_verified_at": "<last_verified_at>",
      "last_seen_at": "<last_seen_at>",
      "last_seen_counter": 1,
      "physical_label_code": "EXAMPLE10",
      "created_at": "<created_at>",
      "updated_at": "<updated_at>",
      "token_name": "<token_name>",
      "token_public_id": "58348beb-0000-4000-8000-d0c500000058",
      "token_is_active": true,
      "order_number": "<order_number>",
      "order_status": "<order_status>",
      "tracking_number": "<tracking_number>",
      "tracking_url": "https://example.com/image.jpg",
      "can_freeze": true,
      "can_unfreeze": true,
      "can_replace": true
    }
  ]
}
WhatsApp
Book a Call
Start Free