Partner API

Early beta

Partner API

Order hardware, price connectivity and track fulfillment directly from your own systems — the same operations you already run in the Partner Portal, over HTTP.

Base URL

https://api.mergewifi.com

Available now

50 endpoints · 0 coming

Specification

OpenAPI 3.1.0

What “early beta” means

Endpoints marked available are implemented, tested and safe to build against. We will not remove or rename a field on an available endpoint without telling you first.

Coverage is still growing and response times are not yet under an SLA. Please tell us what you need next — it genuinely changes the order we build in.

Quickstart

Three requests to your first order. Create a key in the Partner Portal first — keys look like mwf_live_… and are shown only once.

1
Verify your key
Every request carries a bearer token. This endpoint needs no permissions, so it is the quickest way to confirm a key works and see what it can reach.
```
curl https://api.mergewifi.com/v1/me \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"
```
2
Browse your catalog
Returns the hardware available to you with your pricing. Take a product id from here for the next step.
```
curl https://api.mergewifi.com/v1/products \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"
```
3
Look up your orders
Every order your organization has placed, newest first. Sales made through checkout sessions show up here too, and the same id works on the single-order endpoint.
```
curl https://api.mergewifi.com/v1/orders \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"
```

How the API behaves

Authentication

Send Authorization: Bearer <key> on every request. Keys are shown once when created and stored only as a hash, so a lost key is replaced rather than recovered. Keys are for server-to-server use — never place one in browser or mobile app code, and this API sends no CORS headers by design.

GuidesFrom a new key to your first order Going live: errors, retries, pagination and rate limits

Errors

Every failure returns the same shape: a type, a stable code, a human-readable message, and a request_id also returned in the x-request-id header. Quote that id to support and we can find the exact request. Validation failures also name the offending field in param.

GuidesRun your own checkout: quotes, sessions and payment Going live: errors, retries, pagination and rate limits

Retries and duplicates

Write requests take an Idempotency-Key. Retrying with the same key returns the original result instead of creating a second record, so a timeout or dropped connection is always safe to retry. Reusing a key with genuinely different data returns 409 rather than quietly handing you the wrong record. Use a fresh UUID per operation.

GuidesFrom a new key to your first order Run your own checkout: quotes, sessions and payment Going live: errors, retries, pagination and rate limits

Pagination

Lists use cursors. Pass limit, then follow next_cursor as starting_after while has_more is true. Cursors stay correct even when new records arrive mid-pagination, which page numbers cannot. An out-of-range limit is rejected rather than clamped, so you never silently get fewer rows than you asked for.

GuidesTrack orders and the devices they ship Look up your customers Going live: errors, retries, pagination and rate limits

Rate limits

Applied per key and reported on every response via X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. A 429 includes Retry-After — honour it and back off. If your integration needs a higher ceiling, ask and we will raise it.

GuidesGoing live: errors, retries, pagination and rate limits

Endpoints

Authentication

Confirm a key works and see what it can do.

get

/v1/me

Available

Describe the current API key

Returns the organization, environment, and scopes the presented key carries. Requires no scopes of its own, so a misconfigured key still gets a useful answer instead of a 403.

GuidesFrom a new key to your first order Manage a device: Wi-Fi, settings, restarts and firmware Start service: data plans, network groups and LAN settings Port forwarding, dedicated IPs and bridged IPs Going live: errors, retries, pagination and rate limits

Scopeany valid key

curl https://api.mergewifi.com/v1/me \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

Catalog

The hardware and plans available to your organization, with your pricing.

get

/v1/products

Available

List orderable products

The hardware available to your organization, with your pricing. Returned in full rather than paginated, so one request gives you everything you need to build a product picker. Use a product id from here when placing an order.

GuidesFrom a new key to your first order Run your own checkout: quotes, sessions and payment

Scopecatalog:read

curl https://api.mergewifi.com/v1/products \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

get

/v1/plans

Available

List service plans

The service plans available to your organization to sell alongside hardware, with their monthly pricing. Returned in full rather than paginated, like the product catalog — one request gives you everything needed to build a picker.

GuidesFrom a new key to your first order Run your own checkout: quotes, sessions and payment Start service: data plans, network groups and LAN settings

Scopecatalog:read

curl https://api.mergewifi.com/v1/plans \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

Quotes

Price a basket before committing to it.

post

/v1/quotes

Available

Price a basket

Returns what a basket would cost, with no side effects — nothing is created, nothing is reserved, and a quote cannot be redeemed. Call it as often as a cart changes. Lines are itemized by kind. Read activation lines carefully: those charges are **not** in due_now and begin when the device is activated. A plan sold on warehouse-shipped hardware always defers this way, because its service line does not exist until fulfillment picks a unit and its serial is known. Hardware the customer already holds (source: "provided") bills its plan today instead. Amounts are estimates. The authoritative figure is totals.due_now on a checkout session.

GuidesFrom a new key to your first order Run your own checkout: quotes, sessions and payment

Scopequotes:write

curl https://api.mergewifi.com/v1/quotes \
  -X POST \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "packages": [
    {
      "package_id": "pkg_1",
      "device": {
        "product_id": "1",
        "quantity": 1,
        "billing": "purchase",
        "source": "warehouse"
      },
      "plan": {
        "plan_id": "12"
      },
      "addons": []
    }
  ],
  "shipping_address": {
    "line1": "100 Congress Ave",
    "city": "Austin",
    "state": "TX",
    "postal_code": "78701"
  }
}'

Field types in openapi.json

Orders

Place hardware orders and track their status.

get

/v1/orders

Available

List orders

Your organization's orders, newest first. Line items are omitted to keep responses small — fetch a single order to see them.

GuidesTrack orders and the devices they ship

Scopeorders:read

Parameter	Description
`limit` query	Rows to return, 1–100. Defaults to 25. Out-of-range values are rejected rather than clamped, so a client cannot silently receive fewer rows than it asked for.
`starting_after` query	Opaque cursor from a previous response's `next_cursor`. Cursors rather than page numbers: rows inserted between requests would shift an offset and silently skip records.
`status` query	Exact match on order status, e.g. `pending`, `processing`, `cancelled`.
`order_type` query	Exact match, e.g. `residential`, `business`, `iot`, `wholesale`. Orders placed in the Partner Portal may carry other values, so this is matched literally rather than restricted to a fixed list — a value with no matches returns an empty list rather than an error.

curl https://api.mergewifi.com/v1/orders \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

get

/v1/orders/{id}

Available

Retrieve an order

A single order with its line items, including any devices and plans on it. Orders are scoped to your organization — an id you do not own returns a 404.

GuidesFrom a new key to your first order Track orders and the devices they ship

Scopeorders:read

Parameter	Description
`id` path · required	The order id.

curl https://api.mergewifi.com/v1/orders/<id> \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

Checkout

Point-of-sale: open a session, tokenize a card in your own front end, and settle it.

get

/v1/payment_config

Available

Get publishable payment credentials

The credentials your own front end needs to tokenize a card. The billing platform accepts only an opaque, single-use nonce, and that nonce can only be minted by the payment gateway's browser SDK — so a card must be tokenized in a browser. These values let it be tokenized in **your** browser, against our gateway, which means card details never reach your servers or ours. Fetch this from your backend, then pass client_key and api_login_id to your page and hand them to the gateway SDK as clientKey and apiLoginID. Both are publishable and safe to expose. **Your API key is not** — it must never appear in browser code, and this API sends no CORS headers, so a browser cannot call it directly. Send payment_type_id back when settling a session.

GuidesFrom a new key to your first order Run your own checkout: quotes, sessions and payment

Scopeorders:write

curl https://api.mergewifi.com/v1/payment_config \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

post

/v1/checkout_sessions

Available

Open a point-of-sale session

Starts a retail sale: creates the customer's billing account if it does not exist, registers any equipment they already hold, builds the order and prices it with tax. **Nothing is charged.** The session returns awaiting_payment with the authoritative totals.due_now; settle it with the pay action once you have tokenized a card for exactly that amount. Payment is a second call on purpose. A gateway nonce is single-use, so combining the two would burn one on a total you had not yet seen — and an integration has no one to re-key a card when that happens. Creating the session first means you always tokenize against the real number. The request carries no prices: every amount is resolved from the same catalog /v1/products and /v1/plans serve.

GuidesFrom a new key to your first order Run your own checkout: quotes, sessions and payment

Scopeorders:write

Required headers

Idempotency-Key

A fresh unique value (a UUID) per sale. Replaying it with the same basket returns the original session with a 200; reusing it for a different basket is a 409.

curl https://api.mergewifi.com/v1/checkout_sessions \
  -X POST \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "customer": {
    "first_name": "Dana",
    "last_name": "Reyes",
    "email": "dana@example.com",
    "phone": "5125550142"
  },
  "shipping_address": {
    "line1": "100 Congress Ave",
    "city": "Austin",
    "state": "TX",
    "postal_code": "78701"
  },
  "packages": [
    {
      "package_id": "pkg_1",
      "device": {
        "product_id": "1",
        "quantity": 1,
        "billing": "purchase",
        "source": "warehouse"
      },
      "plan": {
        "plan_id": "12"
      },
      "addons": []
    }
  ]
}'

Field types in openapi.json

get

/v1/checkout_sessions/{id}

Available

Retrieve a checkout session

The current state of a sale. Poll this after a timeout to find out whether a payment landed before deciding to retry it. totals.due_now here is authoritative — it is what the billing platform will accept, and what expected_total must match when paying. A session and an order are the same record: this id also works on GET /v1/orders/{id}, which reports what was bought rather than what is left to do.

GuidesRun your own checkout: quotes, sessions and payment

Scopeorders:read

Parameter	Description
`id` path	The checkout session `id`.

curl https://api.mergewifi.com/v1/checkout_sessions/<id> \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

post

/v1/checkout_sessions/{id}/actions/pay

Available

Pay a checkout session

Charges the card and submits the order. **This is the step that moves money.** Send a nonce your front end just minted with the gateway SDK, using the credentials from GET /v1/payment_config. A nonce is single-use and short-lived: mint one per attempt and never store one. expected_total must equal the session's current totals.due_now. It is you stating the amount you believe you are authorizing — if the total has moved, the charge is refused rather than billing a figure nobody agreed to. On success the session is submitted. A submit_failed session **was charged** — handoff to fulfillment is being retried for you, so do not pay again. A decline returns 402 and leaves the session payable: mint a fresh nonce and call this again.

GuidesFrom a new key to your first order Run your own checkout: quotes, sessions and payment

Scopeorders:write

Parameter	Description
`id` path	The checkout session `id`.

curl https://api.mergewifi.com/v1/checkout_sessions/<id>/actions/pay \
  -X POST \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "payment": {
    "nonce": "eyJjb2RlIjoiNTBfMl8wNjAwMDUyN0…",
    "data_descriptor": "COMMON.ACCEPT.INAPP.PAYMENT",
    "payment_type_id": 7
  },
  "expected_total": "412.87"
}'

Field types in openapi.json

post

/v1/checkout_sessions/{id}/actions/cancel

Available

Cancel a checkout session

Abandons an unpaid sale and cancels the draft order behind it. Worth calling rather than walking away: an abandoned session leaves a draft order, and for provided equipment a draft service line, on the customer's account. They are harmless and a later sale reuses them, but a cancelled session is far easier to reconcile than a stalled one. Only unpaid sessions can be cancelled. Once the card has been charged this returns 409 — reversing a payment is a refund, which this API does not do.

GuidesRun your own checkout: quotes, sessions and payment

Scopeorders:write

Parameter	Description
`id` path	The checkout session `id`.

curl https://api.mergewifi.com/v1/checkout_sessions/<id>/actions/cancel \
  -X POST \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

Devices

Inventory, configuration and lifecycle for devices on your account.

get

/v1/devices

Available

List devices

The devices on your account, newest first. Filter with activated, reachable, serial, data_plan, model, or free text via q. Rows reflect the most recent inventory sync, so a device added in the last few minutes may not appear yet; retrieving a device by id always reads current state. Usage is reported in **bytes**.

GuidesTrack orders and the devices they ship Manage a device: Wi-Fi, settings, restarts and firmware Start service: data plans, network groups and LAN settings Port forwarding, dedicated IPs and bridged IPs Diagnose a device: connectivity, events and tests

Scopedevices:read

Parameter	Description
`limit` query	Rows to return, 1–100. Defaults to 25. Out-of-range values are rejected rather than clamped, so a client cannot silently receive fewer rows than it asked for.
`starting_after` query	Opaque cursor from a previous response's `next_cursor`. Cursors rather than page numbers: rows inserted between requests would shift an offset and silently skip records.
`activated` query	`true` or `false`. Omit for both.
`reachable` query	`true` or `false`. Reachability is independent of activation — a device can be activated and powered off.
`serial` query	Exact match on the device serial.
`data_plan` query	Exact match on the plan name, or `unassigned` for devices with none.
`model` query	Exact match on the hardware model.
`q` query	Free-text search across serial, label, and id.

curl https://api.mergewifi.com/v1/devices \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

get

/v1/devices/{uuid}

Available

Retrieve a device

A single device. Devices are scoped to your organization — an id you do not own returns a 404, indistinguishable from one that does not exist.

GuidesTrack orders and the devices they ship Start service: data plans, network groups and LAN settings

Scopedevices:read

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid> \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

post

/v1/devices/{uuid}/actions/restart

Available

Restart a device

Reboots the device. It is unreachable for a minute or so afterwards.

GuidesManage a device: Wi-Fi, settings, restarts and firmware

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/actions/restart \
  -X POST \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

post

/v1/devices/{uuid}/actions/activate

Available

Activate a device

Brings a device into service on a network group. Activation is billable and requires the activation capability on your account.

GuidesStart service: data plans, network groups and LAN settings

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/actions/activate \
  -X POST \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "network_group_id": "5"
}'

Field types in openapi.json

post

/v1/devices/{uuid}/actions/deactivate

Available

Deactivate a device

Takes a device out of service. It remains assigned to your organization.

GuidesStart service: data plans, network groups and LAN settings

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/actions/deactivate \
  -X POST \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

post

/v1/devices/{uuid}/actions/update_firmware

Available

Update device firmware

Asks the device to fetch and apply the latest firmware. It downloads on its own schedule and is unreachable while it reboots.

GuidesManage a device: Wi-Fi, settings, restarts and firmware

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/actions/update_firmware \
  -X POST \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

post

/v1/devices/{uuid}/actions/factory_reset

Available

Reset a device to factory configuration

Restores the factory configuration, discarding the SSID, LAN addressing and any networking rules on the device. This cannot be undone.

GuidesManage a device: Wi-Fi, settings, restarts and firmware

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/actions/factory_reset \
  -X POST \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

patch

/v1/devices/{uuid}

Available

Update a device

Changes the label, data plan, or network group. Change data_plan_id and network_group_id in SEPARATE requests — they are applied independently upstream, so a combined request could half-succeed.

GuidesManage a device: Wi-Fi, settings, restarts and firmware Start service: data plans, network groups and LAN settings

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid> \
  -X PATCH \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "Warehouse dock 3"
}'

Field types in openapi.json

get

/v1/devices/{uuid}/wifi

Available

Retrieve Wi-Fi settings

The network name, and whether a password is set. The password itself is never returned. Read live from the device, so a device that is powered off or out of coverage returns 409 device_unreachable — or 503 if it does not answer in time.

GuidesManage a device: Wi-Fi, settings, restarts and firmware

Scopedevices:read

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/wifi \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

patch

/v1/devices/{uuid}/wifi

Available

Update Wi-Fi settings

Applied to the hardware, so it takes effect when the device next checks in. Passwords must be at least 8 characters.

GuidesManage a device: Wi-Fi, settings, restarts and firmware

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/wifi \
  -X PATCH \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "ssid": "Acme-Warehouse"
}'

Field types in openapi.json

get

/v1/devices/{uuid}/network

Available

Retrieve LAN settings

The device's LAN address and MTU. Read live from the device, so a device that is powered off or out of coverage returns 409 device_unreachable — or 503 if it does not answer in time.

GuidesStart service: data plans, network groups and LAN settings

Scopedevices:read

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/network \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

patch

/v1/devices/{uuid}/network

Available

Update LAN settings

lan_ip and mtu are applied by separate upstream calls, so a request setting both can partially succeed; the error names which one failed. MTU must be between 1000 and 1500.

GuidesStart service: data plans, network groups and LAN settings

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/network \
  -X PATCH \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "mtu": 1400
}'

Field types in openapi.json

patch

/v1/devices/{uuid}/restart_schedule

Available

Set a restart schedule

A device has at most one schedule, so this creates or replaces it. time is 24-hour HH:MM in the device's local time. day is an integer and is required unless frequency is daily: the day of the month for a monthly schedule, and the device platform's own weekday index for a weekly one. It is passed through to the platform unchanged.

GuidesManage a device: Wi-Fi, settings, restarts and firmware

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/restart_schedule \
  -X PATCH \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "frequency": "daily",
  "time": "03:00"
}'

Field types in openapi.json

delete

/v1/devices/{uuid}/restart_schedule

Available

Cancel the restart schedule

Idempotent — cancelling when nothing is scheduled succeeds.

GuidesManage a device: Wi-Fi, settings, restarts and firmware

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/restart_schedule \
  -X DELETE \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

get

/v1/devices/{uuid}/connectivity

Available

Retrieve live connectivity

How many clients are attached, who they are, and recent uptime. Read live from the device platform rather than from synced inventory. A field is null when that source was unavailable, so a partial outage degrades the response instead of failing it.

GuidesDiagnose a device: connectivity, events and tests

Scopedevices:read

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/connectivity \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

get

/v1/devices/{uuid}/events

Available

List device events

What has been done to this device, most recent first.

GuidesDiagnose a device: connectivity, events and tests

Scopedevices:read

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/events \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

get

/v1/devices/{uuid}/notes

Available

List device notes

Notes attached to the device. The author is not returned — it is frequently a member of our own or the platform's staff.

GuidesManage a device: Wi-Fi, settings, restarts and firmware

Scopedevices:read

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/notes \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

post

/v1/devices/{uuid}/notes

Available

Add a device note

Attaches a note to the device.

GuidesManage a device: Wi-Fi, settings, restarts and firmware

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/notes \
  -X POST \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "note": "Relocated to dock 3"
}'

Field types in openapi.json

get

/v1/devices/{uuid}/config_backups

Available

List configuration backups

Backups taken of this device's configuration. Restoring is a support operation and is not available through the API.

GuidesManage a device: Wi-Fi, settings, restarts and firmware

Scopedevices:read

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/config_backups \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

post

/v1/devices/{uuid}/config_backups

Available

Take a configuration backup

Captures the device's current configuration. Completes asynchronously, so acceptance is not completion — poll the list endpoint. Taking a second backup is harmless, so retries are safe without an idempotency key.

GuidesManage a device: Wi-Fi, settings, restarts and firmware

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/config_backups \
  -X POST \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

get

/v1/data_plans

Available

List data plans

The data plans a device can be assigned. Distinct from /v1/plans, which lists the SERVICE plans sold to end customers.

GuidesStart service: data plans, network groups and LAN settings

Scopedevices:read

curl https://api.mergewifi.com/v1/data_plans \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

Device networking

Port forwarding, dedicated and bridged IP addresses.

get

/v1/devices/{uuid}/port_forwards

Available

List port forwarding rules

Rules currently applied to this device.

GuidesPort forwarding, dedicated IPs and bridged IPs

Scopedevices:read

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/port_forwards \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

post

/v1/devices/{uuid}/port_forwards

Available

Create a port forwarding rule

Ports must be 1-65535. protocol is TCP, UDP or BOTH; application_protocol is HTTP, HTTPS or OTHER. Returns the device's full rule set. Sending an identical rule again is a no-op, so retries are safe without an idempotency key.

GuidesPort forwarding, dedicated IPs and bridged IPs

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/port_forwards \
  -X POST \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "inbound_ip": "203.0.113.10",
  "inbound_port": 8080,
  "internal_ip": "192.168.1.50",
  "internal_port": 80,
  "protocol": "TCP",
  "application_protocol": "HTTP"
}'

Field types in openapi.json

delete

/v1/devices/{uuid}/port_forwards/{rule_id}

Available

Delete a port forwarding rule

Removes the port forwarding rule. The rule is confirmed to belong to this device first, so an id from another device returns 404.

GuidesPort forwarding, dedicated IPs and bridged IPs

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.
`rule_id` path · required	The rule id, from the list endpoint.

curl https://api.mergewifi.com/v1/devices/<uuid>/port_forwards/<rule_id> \
  -X DELETE \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

get

/v1/devices/{uuid}/dedicated_ips

Available

List dedicated IP rules

Dedicated inbound addresses assigned to this device.

GuidesPort forwarding, dedicated IPs and bridged IPs

Scopedevices:read

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/dedicated_ips \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

post

/v1/devices/{uuid}/dedicated_ips

Available

Assign a dedicated IP

Returns the device's full set of dedicated addresses. Sending an identical rule again is a no-op, so retries are safe without an idempotency key.

GuidesPort forwarding, dedicated IPs and bridged IPs

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/dedicated_ips \
  -X POST \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "inbound_ip": "203.0.113.10"
}'

Field types in openapi.json

delete

/v1/devices/{uuid}/dedicated_ips/{rule_id}

Available

Delete a dedicated IP rule

Removes the dedicated IP rule. The rule is confirmed to belong to this device first, so an id from another device returns 404.

GuidesPort forwarding, dedicated IPs and bridged IPs

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.
`rule_id` path · required	The rule id, from the list endpoint.

curl https://api.mergewifi.com/v1/devices/<uuid>/dedicated_ips/<rule_id> \
  -X DELETE \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

get

/v1/devices/{uuid}/bridged_ips

Available

List bridged IP rules

Bridged addresses assigned to this device.

GuidesPort forwarding, dedicated IPs and bridged IPs

Scopedevices:read

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/bridged_ips \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

post

/v1/devices/{uuid}/bridged_ips

Available

Assign a bridged IP

Returns the device's full set of bridged addresses. Sending an identical rule again is a no-op, so retries are safe without an idempotency key.

GuidesPort forwarding, dedicated IPs and bridged IPs

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/bridged_ips \
  -X POST \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "inbound_ip": "203.0.113.20"
}'

Field types in openapi.json

delete

/v1/devices/{uuid}/bridged_ips/{rule_id}

Available

Delete a bridged IP rule

Removes the bridged IP rule. The rule is confirmed to belong to this device first, so an id from another device returns 404.

GuidesPort forwarding, dedicated IPs and bridged IPs

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.
`rule_id` path · required	The rule id, from the list endpoint.

curl https://api.mergewifi.com/v1/devices/<uuid>/bridged_ips/<rule_id> \
  -X DELETE \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

get

/v1/network_groups

Available

List network groups

The network groups a device can be activated on or moved between. Take an id from here for activate or a network group change.

GuidesStart service: data plans, network groups and LAN settings Diagnose a device: connectivity, events and tests

Scopedevices:read

curl https://api.mergewifi.com/v1/network_groups \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

Device diagnostics

Speed tests, network scans and diagnostics.

post

/v1/devices/{uuid}/actions/speed_test

Available

Start a speed test

Starts a speed test on the device. Results arrive asynchronously — poll the matching read endpoint. type is rapid (the default) or full.

GuidesDiagnose a device: connectivity, events and tests

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/actions/speed_test \
  -X POST \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "rapid"
}'

Field types in openapi.json

get

/v1/devices/{uuid}/speed_tests

Available

List speed test results

Completed speed test results, most recent first. The payload is returned as an opaque data object — its shape is undocumented upstream and varies by hardware model.

GuidesDiagnose a device: connectivity, events and tests

Scopedevices:read

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/speed_tests \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

post

/v1/devices/{uuid}/actions/network_scan

Available

Start a network scan

Starts a network scan on the device. Results arrive asynchronously — poll the matching read endpoint.

GuidesDiagnose a device: connectivity, events and tests

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/actions/network_scan \
  -X POST \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

get

/v1/devices/{uuid}/network_scans

Available

List network scan results

Completed network scan results, most recent first. The payload is returned as an opaque data object — its shape is undocumented upstream and varies by hardware model.

GuidesDiagnose a device: connectivity, events and tests

Scopedevices:read

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/network_scans \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

post

/v1/devices/{uuid}/actions/network_diagnostic

Available

Start a network diagnostic

Starts a network diagnostic on the device. Results arrive asynchronously — poll the matching read endpoint. The diagnostic runs against a network group. It defaults to the one the device is on; pass network_group_id to test a different one.

GuidesDiagnose a device: connectivity, events and tests

Scopedevices:write

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/actions/network_diagnostic \
  -X POST \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Field types in openapi.json

get

/v1/devices/{uuid}/network_diagnostics

Available

List network diagnostic results

Completed network diagnostic results, most recent first. The payload is returned as an opaque data object — its shape is undocumented upstream and varies by hardware model.

GuidesDiagnose a device: connectivity, events and tests

Scopedevices:read

Parameter	Description
`uuid` path · required	The device id.

curl https://api.mergewifi.com/v1/devices/<uuid>/network_diagnostics \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

Customers

The end customers you sell to.

get

/v1/customers

Available

List customers

The end customers on your account, newest first. Search across name, email and phone with q, or filter by status. Pass an id from here as customer_id when opening a checkout session to bind the sale to that customer's existing billing account instead of matching on their email address.

GuidesLook up your customers

Scopecustomers:read

Parameter	Description
`limit` query	Rows to return, 1–100. Defaults to 25. Out-of-range values are rejected rather than clamped, so a client cannot silently receive fewer rows than it asked for.
`page` query	1-based page number. This collection pages by number rather than by cursor, so `next_cursor` is always null.
`q` query	Free-text match across first name, last name, email and phone.
`status` query	Exact match, e.g. `active`, `paused`, `cancelled`. Customers synced from billing carry that platform's own states.

curl https://api.mergewifi.com/v1/customers \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

get

/v1/customers/{id}

Available

Retrieve a customer

One end customer on your account.

GuidesLook up your customers

Scopecustomers:read

Parameter	Description
`id` path	The customer `id`.

curl https://api.mergewifi.com/v1/customers/<id> \
  -H "Authorization: Bearer $MERGEWIFI_API_KEY"

Field types in openapi.json

Getting a key

API keys are created and managed in the Partner Portal, scoped to your organization. A key is shown once when you create it and stored only as a hash, so keep it somewhere safe — if it is lost, revoke it and create another. If the operations you need are not available yet, tell us: that list is what decides what we build next.

Partner API

Quickstart

Verify your key

Browse your catalog

Look up your orders

How the API behaves

Authentication

Errors

Retries and duplicates

Pagination

Rate limits

Endpoints

Authentication

Describe the current API key

Catalog

List orderable products

List service plans

Quotes

Price a basket

Orders

List orders

Retrieve an order

Checkout

Get publishable payment credentials

Open a point-of-sale session

Retrieve a checkout session

Pay a checkout session

Cancel a checkout session

Devices

List devices

Retrieve a device

Restart a device

Activate a device

Deactivate a device

Update device firmware

Reset a device to factory configuration

Update a device

Retrieve Wi-Fi settings

Update Wi-Fi settings

Retrieve LAN settings

Update LAN settings

Set a restart schedule

Cancel the restart schedule

Retrieve live connectivity

List device events

List device notes

Add a device note

List configuration backups

Take a configuration backup

List data plans

Device networking

List port forwarding rules

Create a port forwarding rule

Delete a port forwarding rule

List dedicated IP rules

Assign a dedicated IP

Delete a dedicated IP rule

List bridged IP rules

Assign a bridged IP

Delete a bridged IP rule

List network groups

Device diagnostics

Start a speed test

List speed test results

Start a network scan

List network scan results

Start a network diagnostic

List network diagnostic results

Customers

List customers

Retrieve a customer