Help Center › Partner API

Overview

The NFC Tagify Partner API allows approved integration partners to place NFC card orders, check product availability and pricing, and retrieve order status programmatically. It is designed for businesses that need to automate fulfilment or integrate NFC card ordering into an existing e-commerce or back-office system.

API access is available to partners who have completed the NFC Tagify partner onboarding process. If you have not yet done this, see the [Partner Portal](../help-pages/partner-portal.md) page for how to request access.

---

What the Partner API Does

The Partner API allows you to:

  • Create orders — submit NFC card orders programmatically, including product type, quantity, and delivery details.
  • List available products — retrieve the current catalogue of NFC card products available to your partner account.
  • Get pricing — retrieve the prices applicable to your account, including any custom pricing overrides configured for you.
  • Check order status — retrieve the current status of an existing order and its individual line items.
  • List orders — retrieve a paginated list of your order history with filtering options.

All endpoints are under the /api/partner/ base path.

---

Authentication

The Partner API uses API key authentication. Your API key is generated when your partner account is created and can be found in the Partner Portal under API Keys.

Include your API key in the Authorization header of every request:

`

Authorization: Bearer YOUR_API_KEY

`

API keys are long-lived but can be rotated at any time from the Partner Portal. If you suspect your key has been compromised, rotate it immediately — the old key will be invalidated as soon as a new one is generated.

Keep your API key secure. Do not include it in client-side code, commit it to version control, or share it with third parties.

---

Key Endpoints

All endpoints accept and return JSON. All requests must use HTTPS.

List Products

`

GET /api/partner/products

`

Returns the list of NFC card products available to your account, including product IDs, names, descriptions, and your applicable price for each.

Response (example)

`json

{

"success": true,

"data": [

{

"product_id": "prod_abc123",

"name": "NFC Business Card — Standard",

"description": "85.6 × 54 mm PVC card with NFC chip",

"price": 3.50,

"currency": "GBP",

"min_quantity": 1

}

]

}

`

---

Get Pricing

`

GET /api/partner/pricing

`

Returns the pricing schedule applicable to your partner account. If you have custom pricing overrides, they will be reflected here. See the [Pricing Overrides](#pricing-overrides) section below.

---

Create Order

`

POST /api/partner/orders

`

Submits a new NFC card order.

Request body (example)

`json

{

"product_id": "prod_abc123",

"quantity": 50,

"customer_reference": "YOUR-ORDER-REF-001",

"shipping": {

"name": "Jane Smith",

"address_line1": "12 Example Street",

"city": "London",

"postcode": "EC1A 1BB",

"country": "GB"

}

}

`

Response (example)

`json

{

"success": true,

"data": {

"order_id": "ord_xyz789",

"status": "pending",

"created_at": "2026-05-25T09:00:00Z"

}

}

`

[NEEDS VERIFICATION: full list of required and optional fields for order creation]

---

Get Order Status

`

GET /api/partner/orders/:order_id

`

Returns the current status of a specific order, including line-item card status where applicable.

Possible order statuses:

| Status | Meaning |

|--------|---------|

| pending | Order received, awaiting processing |

| processing | Order is being prepared |

| dispatched | Order has been shipped |

| delivered | Order confirmed as delivered |

| cancelled | Order was cancelled |

---

List Orders

`

GET /api/partner/orders

`

Returns a paginated list of all orders placed by your account. Supports the following query parameters:

| Parameter | Type | Description |

|-----------|------|-------------|

| page | integer | Page number (default: 1) |

| per_page | integer | Results per page (default: 20, max: 100) |

| status | string | Filter by order status |

| from | ISO date | Filter orders placed on or after this date |

| to | ISO date | Filter orders placed on or before this date |

---

Pricing Overrides

Partner pricing overrides allow NFC Tagify to configure a custom price schedule for your account that differs from the standard published pricing. This is useful for partners with higher order volumes, long-term agreements, or special product bundles.

Pricing overrides are configured by the NFC Tagify admin team — they are not self-service. To request a pricing review or enquire about a custom pricing arrangement, contact your NFC Tagify account manager or email [NEEDS VERIFICATION: partner pricing contact email].

When overrides are in place:

  • The /api/partner/pricing endpoint will return your custom rates, not the standard rates.
  • The /api/partner/products endpoint will also reflect your custom pricing in the price field.
  • Pricing overrides are per-product and can apply to some or all products in your catalogue.

---

Rate Limits

The Partner API enforces rate limits to ensure fair usage across all partners.

| Limit type | Default limit |

|------------|--------------|

| Requests per minute | [NEEDS VERIFICATION: e.g. 60 requests/min] |

| Orders per day | [NEEDS VERIFICATION: e.g. 500 orders/day] |

When you exceed a rate limit, the API returns a 429 Too Many Requests response with a Retry-After header indicating how many seconds to wait before retrying.

If your integration regularly hits rate limits, contact NFC Tagify to discuss a higher limit for your account.

---

Error Handling

All error responses follow a consistent format:

`json

{

"success": false,

"error": "Human-readable description of the error",

"code": "ERROR_CODE"

}

`

Common HTTP status codes:

| Code | Meaning |

|------|---------|

| 400 | Bad request — check your request body for missing or invalid fields |

| 401 | Unauthorised — your API key is missing or invalid |

| 403 | Forbidden — your account does not have permission for this action |

| 404 | Not found — the specified resource does not exist |

| 429 | Too many requests — you have exceeded the rate limit |

| 500 | Server error — something went wrong on the NFC Tagify side |

---

Support

For integration questions or technical issues, contact NFC Tagify partner support at [NEEDS VERIFICATION: partner support email]. When raising a support request, include:

  • Your partner account ID
  • The endpoint you are calling
  • The full request body (with any sensitive data removed)
  • The full response body and HTTP status code
  • A timestamp for the request

---

Frequently Asked Questions

Can I use the API to provision profiles or manage users, or just orders?

The Partner API is focused on order management. Profile and user management is handled through the standard portal. [NEEDS VERIFICATION: whether any profile/user management endpoints are exposed via the partner API]

Can I test the API before going live?

[NEEDS VERIFICATION: whether a sandbox or test environment is available for partner API testing]

How do I rotate my API key?

Log in to the Partner Portal, go to API Keys, and click Rotate Key. Your old key is immediately invalidated, so make sure to update your integration with the new key before rotating.

Are webhooks available for order status updates?

[NEEDS VERIFICATION: whether the Partner API supports outbound webhooks for order status change events]

---

Related: [Partner Portal](../help-pages/partner-portal.md) · [NFC Card Setup](../help-pages/nfc-card-setup.md) · [Reseller Portal Overview](../help-pages/reseller-portal-overview.md)