Phoneo Partner API

Read-only inventory feed for partner storefronts, plus support tickets · v1 · Updated 2026-10-07

Base URLhttps://super.phoneo.in/api/partner/v1
On this page

What this API is

Phoneo gives your storefront a live, read-only feed of the inventory belonging to the shops Phoneo has assigned to you. If you run an online store at, say, yourstore.in, this is how yourstore.in lists Phoneo stock: your server pulls the catalog, stores it on your side, and renders it.

A shop is only ever assigned to you after its owner has agreed to share their stock with you. To get access, see Getting set up.

The same key can also read a reference catalog of phone specifications — every model of a brand with its colours, colour images, RAM/ROM variants, release date and key specs. That catalog is not shop data, and it needs its own permission.

And it can send the Phoneo team support tickets — bugs you hit and requirements you need built — straight from your own admin panel, then follow them to the fix.

Your key cannot change any of Phoneo's data. Every catalog, shop and phone-specification endpoint is a GET. Your key cannot mark an item sold, change a price, place an order, or edit a shop. This is a property of the API itself, not a permission you were given.

The one place you can write is your own support tickets (/support/*): file, edit, withdraw, reply and reopen. Those endpoints sit behind their own permission, support.tickets.write, and touch nothing but the tickets your key filed.

Base URLhttps://super.phoneo.in/api/partner/v1
AuthHeader X-Partner-Key
FormatJSON — send Accept: application/json
Rate limitPer key, default 120 requests/minute (429 when exceeded)
DirectionYou pull. Phoneo never calls your servers.

Authentication

Send your key on every request:

curl "https://super.phoneo.in/api/partner/v1/ping" \
  -H "X-Partner-Key: phn_live_a1b2c3d4e5f6g7h8_XXXXXXXXXXXX" \
  -H "Accept: application/json"

Keep the key on your server. Never put it in browser JavaScript, a mobile app bundle, or a public repository. Anyone holding it can read the full catalog of every shop mapped to you.

If it leaks, email support@phoneo.in immediately. Phoneo can switch the key off at once and send you a new one.

IP allowlist. If your servers have fixed outbound IPs, send them to support@phoneo.in. The key will then only work from those addresses. Strongly recommended — it turns a leaked key into a useless string.

Errors

StatuserrorWhat happened
401invalid_keyKey is wrong, or the header is missing
401key_revokedKey was revoked or has expired
403ip_not_allowedRequest came from an IP outside your allowlist
403ability_not_registeredThe endpoint exists, but Phoneo has not added it to the permission list yet
403ability_disabledThe permission exists but is currently switched off for everyone
403ability_missingThe permission is live, but your key was not given it
400invalid_key_formatThe product key in the URL is not source_type:id
404not_foundItem does not exist, or is not in your scope
404brand_not_foundPhone specifications: no brand with that slug or name
404model_not_foundPhone specifications: ?model= matched no model of that brand
422—A query parameter failed validation
429—Rate limited — honour Retry-After

The errors in the table with an error code come back as {"success": false, "error": "…", "message": "…"}. Branch on error, never on message — the message is plain English for your logs and its wording may change. Two responses have a different shape:

  • 422 — {"message": "…", "errors": {"limit": ["…"]}}, one entry per failing parameter.
  • 429 — {"message": "Too Many Attempts."} with a Retry-After header in seconds.

The three 403 permission errors are deliberately kept apart, because the fix is different for each — and none of them is something you can fix on your side. Quote the exact error string to support@phoneo.in: ability_not_registered and ability_disabled are settings on Phoneo's end, ability_missing means your key needs that permission added.

Key rotation

When Phoneo rotates your key, the new one reaches you the same way the first one did — a one-time link by email (see Getting set up). Your current key keeps working until you open that link, and for 48 hours after. Deploy the new key inside that window and your site never goes down. Build for this: read the key from config, not from a constant in code.

The three kinds of stock

Phoneo sells three different things, and they behave differently. Your catalog will contain all three mixed together, distinguished by source_type:

source_typeWhat it isNotes
used_phones A second-hand phone Every one is a unique physical handset. Carries condition, battery_health and what came in the box. Usually has a real photo gallery.
new_phone_units One unit of a brand-new phone condition is always "new". variant holds the storage size. Often only one or two catalogue images.
other_item_units One unit of an accessory or other item Chargers, cases, earbuds. condition is "other".

An item appears only when the shop has marked it visible to everyone and it is for sale. Many shops leave that switched off for new phones and accessories, so expect most of your catalog to be used_phones. Code for all three anyway — a shop can switch them on at any time.

Product key

These live in three separate tables, so a plain numeric id is not unique. Every item is identified by a composite key:

used_phones:1042
new_phone_units:88
other_item_units:310

Store this key on your side. It is what you pass to /products/{key} and to the availability check, and it never changes for the life of the item.

Everything is quantity one. Each row is one physical unit with its own history, so stock_quantity is only ever 1 or 0. Five identical chargers are five separate keys, not one row with a quantity of five. If you want to group them on your site into a single product page, group by brand + model + variant + color yourself.

Endpoints

GET /ping

Check your key and IP allowlist. Needs no particular permission — a valid key is enough, so this is the first call to make when setting up.

{
  "success": true,
  "message": "pong",
  "partner": {
    "name": "Your Store",
    "key_id": "a1b2c3d4e5f6g7h8",
    "abilities": ["catalog.*"],
    "rate_limit_per_min": 120
  },
  "shops_available": 2,
  "time": "2026-08-29T12:00:00+05:30"
}

GET /shops

The shops assigned to you. A shop is identified by its handle — that is what you pass to /products?shop=.

{
  "success": true,
  "data": [
    { "handle": "mobile-point", "name": "Mobile Point", "is_online": true }
  ]
}
This list can shrink without warning. If a shop's Phoneo subscription lapses, or the shop is deactivated, it drops out of this list and all of its products disappear from your catalog on the next sync. That is expected behaviour, not an outage.

GET /products

The catalog. This one endpoint does both the initial full import and the incremental delta sync.

ParameterTypeMeaning
shopstringLimit to one shop, by handle
source_typestringused_phones · new_phone_units · other_item_units
main_category_idintFilter by category
updated_sinceISO 8601Delta mode — also returns removed items. Any offset works (Z, +05:30, -04:00); URL-encode the + as %2B. Timestamps Phoneo returns are in IST (+05:30).
cursorintpaging.next_cursor from the previous page
limitintDefault 100, maximum 500
{
  "success": true,
  "data": [
    {
      "key": "used_phones:1042",
      "source_type": "used_phones",
      "status": "active",

      "shop": { "handle": "mobile-point", "name": "Mobile Point", "is_online": true },

      "title": "Apple iPhone 13 128GB Blue",
      "slug": "apple-iphone-13-128gb-blue",
      "brand": "Apple",
      "model": "iPhone 13",
      "variant": "128GB",
      "color": "Blue",
      "condition": "Good",
      "description": "Single owner, no scratches",

      "sale_price": "45999.00",
      "price_hidden": false,
      "currency": "INR",
      "stock_quantity": 1,

      "main_category_id": 3,
      "main_category": {
        "id": 3,
        "name": "Mobiles",
        "thumb": "https://img.phoneo.in/Phoneo/2025/Image/Enjoyer/E5/MainCat/MainCat-3/Thumb/b.jpg"
      },

      "thumb": "https://img.phoneo.in/2026/Image/E5/UsedPhone/UP-1042/Thumb/a.jpg",
      "images": ["https://img.phoneo.in/…", "https://img.phoneo.in/…"],
      "attributes": {
        "battery_health": "89%",
        "bill_box_cable_warranty": "Box only",
        "offer": "Festive"
      },

      "updated_at": "2026-08-29T11:42:10+05:30"
    }
  ],
  "paging": { "limit": 100, "next_cursor": 1042, "has_more": true }
}

Pagination

Pass paging.next_cursor back as cursor on the next request, and stop when has_more is false. The cursor is stable — new items arriving mid-walk will not make you skip or repeat a row.

Removed items — read this part twice.

When a phone sells, is hidden by the shop, or is deleted, it simply stops appearing in /products. A plain re-fetch will never tell you it is gone, so a naïve integration keeps a sold handset on sale forever.

The only way to learn about removals is the delta call:

GET /products?updated_since=2026-08-29T06:00:00%2B05:30

In that response the item comes back with "status": "removed" and "stock_quantity": 0. Take it off your site as soon as you see it.

GET /products/{key}

One item, in the same shape as a listing row. For example /products/used_phones:1042.

An item outside your scope returns 404, the same as one that does not exist — deliberately, so the endpoint cannot be used to probe for other shops' ids.

GET /products/availability

Check up to 200 items at once. Call this before you confirm any order. Your catalog copy may be minutes old, and the same handset can sell over the counter in the shop at any moment.

GET /products/availability?keys=used_phones:1042,other_item_units:310

{
  "success": true,
  "data": [
    { "key": "used_phones:1042", "status": "active", "available": true,
      "sale_price": "45999.00", "price_hidden": false,
      "updated_at": "2026-08-29T11:42:10+05:30" },

    { "key": "other_item_units:310", "status": "removed", "available": false,
      "sale_price": "1499.00", "price_hidden": false,
      "updated_at": "2026-08-29T10:10:00+05:30" }
  ]
}

keys may also be sent as an array (keys[]=…&keys[]=…). A key that is unknown or outside your scope comes back as "status": "unknown" with available: false — for your purposes the decision is the same either way: do not sell it.

GET /categories

The list of categories that currently hold a product you can see — see the Categories section.

Phone specifications

A reference catalog of phone models, by brand: colours with images, RAM/ROM variants, release date, ready-to-render highlight rows, and the full spec sheet on request. Use it to fill product pages — for example, to show the specs of the handset a shop has listed.

Separate permission: phones.specs.read. A key that has catalog.* does not get it automatically. Ask support@phoneo.in to add it to your key; until then these endpoints return 403 ability_missing.

This catalog holds no shop data — no stock, no prices, no shop names. It is the same for every partner.

GET /phones/brands

Every brand in the catalog, alphabetical. Use slug in the next call.

{
  "success": true,
  "data": [
    { "slug": "ai-plus", "name": "Ai+",     "model_count": 3 },
    { "slug": "apple",   "name": "Apple",   "model_count": 142 },
    { "slug": "asus",    "name": "Asus",    "model_count": 154 },
    …
  ]
}

GET /phones/brands/{brand}/models

Every model of one brand, newest release first. {brand} is the slug, or the brand name (case does not matter; URL-encode a + as %2B). An unknown brand returns 404 brand_not_found.

ParameterTypeMeaning
includestringspecs adds the full specifications sheet to every model. Without it the field is not sent — the response is about half the size.
modelstringExact model name, case-insensitive (iPhone 16 Pro). Returns that one model, or 404 model_not_found.
limitintPage size, 1–500. Leave it out to get every model of the brand in one response.
cursorintpaging.next_cursor from the previous page
GET /phones/brands/xiaomi/models?model=Poco%20M7%205G&include=specs

{
  "success": true,
  "brand": { "slug": "xiaomi", "name": "Xiaomi", "model_count": 514 },
  "data": [
    {
      "brand": "Xiaomi",
      "model": "Poco M7 5G",
      "thumbnail": "https://…/xiaomi-poco-m7-5g.jpg",
      "gallery": ["https://…/xiaomi-poco-m7-5g-1.jpg"],

      "release": {
        "status": "released",
        "label": "7 Mar 2025",
        "date": "2025-03-07",
        "year": 2025,
        "month": 3,
        "quarter": null,
        "precision": "day"
      },
      "os": "Android 14, up to 2 major upgrades, HyperOS",

      "variants": [
        { "ram": "6 GB", "storage": "128 GB", "ram_gb": 6, "storage_gb": 128 },
        { "ram": "8 GB", "storage": "128 GB", "ram_gb": 8, "storage_gb": 128 }
      ],

      "colors": [
        { "name": "Ocean Blue",  "images": ["https://img.phoneo.in/Phoneo/PhoneData/Public/xiaomi/Poco%20M7/Ocean%20Blue/6267d229-….jpg"] },
        { "name": "Satin Black", "images": ["https://img.phoneo.in/…"] },
        { "name": "Mint Green",  "images": [] }
      ],

      "highlights": [
        { "key": "memory",       "label": "RAM | ROM",    "value": "6 GB / 8 GB RAM | 128 GB ROM",       "detail": "Expandable storage: microSDXC (dedicated slot)" },
        { "key": "processor",    "label": "Processor",    "value": "Qualcomm SM4450 Snapdragon 4 Gen 2", "detail": "Octa-core · up to 2.2 GHz" },
        { "key": "rear_camera",  "label": "Rear Camera",  "value": "50MP",      "detail": "LED flash, HDR · 1080p video" },
        { "key": "front_camera", "label": "Front Camera", "value": "8MP",       "detail": "1080p video" },
        { "key": "display",      "label": "Display",      "value": "6.88 inch", "detail": "IPS LCD · 120Hz refresh rate · 600 nits peak brightness" },
        { "key": "battery",      "label": "Battery",      "value": "5160 mAh",  "detail": "18W wired charging" },
        { "key": "thickness",    "label": "Thickness",    "value": "8.2 mm",    "detail": "205.4 g" }
      ],

      "key_specs": {
        "memory":       { "ram_gb": [6, 8], "storage_gb": [128], "card_slot": "microSDXC (dedicated slot)" },
        "processor":    { "chipset": "Qualcomm SM4450 Snapdragon 4 Gen 2", "process_nm": 4, "cpu_cores": 8,
                          "cpu_label": "Octa-core", "cpu_max_ghz": 2.2, "gpu": "Adreno 613", "antutu": null },
        "rear_camera":  { "megapixels": [50], "setup": "Single", "features": "LED flash, HDR", "video_max": "1080p" },
        "front_camera": { "megapixels": [8], "setup": "Single", "features": null, "video_max": "1080p" },
        "display":      { "size_inch": 6.88, "type": "IPS LCD", "refresh_rate_hz": 120, "peak_brightness_nits": 600,
                          "resolution": "720 x 1640", "ppi": 260, "protection": null },
        "battery":      { "capacity_mah": 5160, "charging_w": 18, "wireless_charging_w": null },
        "body":         { "thickness_mm": 8.2, "weight_g": 205.4, "dimensions": "171.9 x 77.8 x 8.2 mm" }
      },

      "specifications": [
        { "group": "Network", "items": [
          { "name": "Technology", "values": ["GSM / HSPA / LTE / 5G"] }
        ] }
      ]
    }
  ],
  "paging": { "limit": null, "next_cursor": null, "has_more": false, "total": 1 }
}

Reading the response

  • highlights are display rows, in display order: label is the caption, value the headline, detail the smaller second line. A row only appears when its value is known, so a model can have fewer than seven rows. Every word in them comes from the spec data — there are no marketing lines or estimates.
  • key_specs carries the same facts as numbers, for filters and comparisons. Any field can be null (not known). Render nothing for a null; never show it as 0.
  • variants: ram is null when the maker does not publish it (every Apple model). storage_gb of a 1 TB model is 1024.
  • colors: every known colour is listed, even when it has no image yet — images is then []. Fall back to thumbnail in that case. Colour images are on img.phoneo.in; thumbnail and gallery are absolute URLs that may be on another host.
  • release.status: released · upcoming · cancelled · unannounced · unknown. It is worked out against today's date, so a model that was "expected" on a past date reads released.
  • release.precision says how much of the date is known: day (then date is set), month, quarter or year. Show label as-is — it is already formatted for that precision ("7 Mar 2025", "Sep 2019", "Q3 2014", "2013").
  • specifications (only with include=specs) is the full sheet: groups such as Network, Launch, Body, Display, Platform, Memory, Main Camera, Selfie Camera, Battery, Misc. values is always a list; a value can contain line breaks. A Price row under Misc is an indicative launch price from the spec sheet, not a Phoneo selling price.
  • Some brands also list tablets and watches next to phones.

Pagination

Same shape as /products, plus total. Without limit everything comes in one page. The largest brand is about 1.8 MB without include=specs and 3.5 MB with it — if that is too much for one call, page with limit and cursor.

The catalog changes rarely. Cache it on your side and refresh once a day.

Support tickets

Send the Phoneo team a bug (something is broken) or a requirement (something you need built) from your own admin panel, then follow it: see its status, read the team's replies, add more detail, and reopen it if a fix did not hold. Everything happens through these endpoints — there is no separate portal to log in to.

Two permissions: support.tickets.read (list and open your tickets, download their files) and support.tickets.write (file, edit, withdraw, reply, reopen). Neither is part of catalog.*. Ask support@phoneo.in to add them to your key; until then these endpoints return 403 ability_missing.

Writes are limited to 60 per hour per key (429 with Retry-After beyond that). Reading is not.

Ticket status

statusMeaning
receivedFiled; nobody has picked it up yet. The only status in which you can edit or withdraw it.
in_progressThe team is working on it.
in_reviewA fix or the requested change is ready and being checked. You can reopen it if it is not right.
resolvedDone. You can reopen it until reopen_until (14 days after it was resolved).
declinedPhoneo will not make this change. The latest reply says why.
duplicateAlready tracked in another ticket.
withdrawnYou withdrew it. Kept as history; left out of the list unless you ask for it.

Every ticket carries a can object — {"edit": true, "withdraw": true, "reply": true, "reopen": false} — saying which actions are allowed right now. Drive your buttons from it rather than re-implementing the rules.

POST /support/tickets

File a ticket. Send JSON, or multipart/form-data when attaching files.

FieldNotes
kindrequiredbug or requirement
titlerequiredUp to 200 characters
descriptionUp to 5,000 characters. HTML and code snippets are kept as you sent them.
steps, expected, actualFor a bug: how to reproduce it, what should happen, what happens instead
priorityurgent · high · normal · low — your view; the team sets its own order after reading it
shop_idWhen it is about one shop. Must be one of the shops on your key (GET /shops), otherwise 422.
external_refrecommendedYour own ticket id, up to 100 characters. See Retries below.
reporter_name, reporter_emailThe person on your side who raised it. reporter_email is copied on status emails.
page_url, app_version, deviceWhere it happened
files[]Up to 5 per request. Images (jpg, png, gif, webp, heic, bmp) up to 10 MB, videos (mp4, mov, webm, m4v, 3gp, mkv, avi) up to 25 MB, documents (pdf, txt, log, csv, json, har) up to 20 MB.
curl -X POST "https://super.phoneo.in/api/partner/v1/support/tickets" \
  -H "X-Partner-Key: $PHONEO_KEY" -H "Accept: application/json" \
  -F kind=bug -F "title=Availability says 0 for a phone in stock" \
  -F "steps=GET /products/availability?keys=used_phones:12" \
  -F external_ref=ORD-1042 -F priority=high \
  -F "files[]=@screenshot.png"

Answers 201 with the full ticket (same shape as GET /support/tickets/{id}) and a meta block:

{
  "success": true,
  "data": {
    "id": "01928c4e-7b1a-7c3e-9f00-2a5b6c7d8e9f",
    "code": "BUG-214",
    "kind": "bug",
    "title": "Availability says 0 for a phone in stock",
    "status": "received",
    "priority": "high",
    "external_ref": "ORD-1042",
    "can": { "edit": true, "withdraw": true, "reply": true, "reopen": false },
    "attachments": [
      { "id": "01928c4e-…", "file_name": "screenshot.png", "kind": "image",
        "url": "https://super.phoneo.in/api/partner/v1/support/tickets/01928c4e-…/attachments/01928c4e-…" }
    ],
    …
  },
  "meta": { "duplicate_request": false, "attachments_failed": [] }
}

Retries. Send external_ref on every ticket. If a request times out and you send it again with the same external_ref, you get the ticket that was already made — 200 with "duplicate_request": true — never a second copy. attachments_failed lists the names of any files that could not be stored; the ticket itself was filed, so send those files again with a reply.

Which id to store. Use id as the ticket's key on your side. code is a label for people — BUG-214 for a bug, REQ-215 for a requirement — and its prefix follows kind, so it changes if you edit a ticket from one kind to the other.

GET /support/tickets

Your tickets, most recently changed first. Withdrawn tickets are left out unless you send include_withdrawn=true or status=withdrawn.

ParameterNotes
statusOne of the statuses above
kindbug or requirement
shop_id, external_refExact match
updated_sinceISO 8601. Only tickets where something you can see changed after this moment — a new status word, a reply to you, your own edit. Internal work that does not change what you see does not count.
per_page1–100, default 25
cursorFrom meta.next_cursor of the previous page
{
  "success": true,
  "data": [
    { "id": "…", "code": "BUG-214", "kind": "bug", "title": "…", "status": "in_progress",
      "priority": "high", "shop_id": null, "shop_name": null, "external_ref": "ORD-1042",
      "replies_count": 1, "created_at": "2026-10-07T09:12:44Z", "updated_at": "2026-10-07T11:02:10Z",
      "resolved_at": null, "withdrawn_at": null,
      "can": { "edit": false, "withdraw": false, "reply": true, "reopen": false } }
  ],
  "meta": { "per_page": 25, "next_cursor": null, "prev_cursor": null }
}

GET /support/tickets/{id}

One ticket in full: everything from the list row, plus description, steps, expected, actual, reporter_name, reporter_email, page_url, app_version, device, reopen_until, and:

  • attachments — the files you sent with the ticket, each with a download url.
  • replies — the conversation, oldest first: {"id", "from": "partner" | "phoneo", "author_name", "body", "attachments", "created_at"}. Replies from the team are signed "Phoneo Support".
  • timeline — each status change, oldest first: {"status", "by": "partner" | "phoneo", "note", "at"}. note is your own reason when you reopened or withdrew it.

PUT /support/tickets/{id}

Change any of the fields you filed (not external_ref), as JSON. Only while the ticket is received; after that it answers 409 ticket_locked — the team is already working from what you sent, so add anything new as a reply. Files cannot be sent here; attach them to a reply.

DELETE /support/tickets/{id}

Withdraw the ticket, with an optional reason. Only while it is received (otherwise 409 ticket_locked). The ticket is not erased: it becomes withdrawn and stays readable. A withdrawn ticket cannot be reopened — file a new one.

POST /support/tickets/{id}/replies

body (required, up to 5,000 characters), optional author_name (shown on the reply; defaults to your company name), optional files[] as for a new ticket. Works in every status except withdrawn.

POST /support/tickets/{id}/reopen

"This is not fixed." reason is required — it is what the team reads first. Allowed from in_review at any time, and from resolved until reopen_until. The ticket goes back to in_progress.

GET /support/tickets/{id}/attachments/{attachmentId}

The file itself. Use the url on each attachment rather than building this path. Needs your key like every other call, so fetch it from your server.

Staying up to date

Poll GET /support/tickets?updated_since=<the newest updated_at you hold> every 5–15 minutes. Phoneo also emails your contact address (and reporter_email, when set) whenever a ticket's status changes or the team replies to you.

Support ticket errors

StatuserrorWhat happened
404ticket_not_foundNo ticket with that id was filed with your key
404attachment_not_foundNo such file on that ticket
404attachment_missingThe file is listed but no longer available
409ticket_lockedWork has started — it can no longer be edited or withdrawn
409ticket_withdrawnThe ticket was withdrawn
409reopen_not_allowedOnly an in_review or resolved ticket can be reopened
409reopen_window_closedResolved more than 14 days ago — file a new ticket
422validation_failedA field failed validation
503support_unavailableTickets are briefly unavailable. Retry later — with the same external_ref, so a ticket that did get filed is not filed twice.

On these endpoints a 422 has the same shape as every other error, plus the failing fields: {"success": false, "error": "validation_failed", "message": "…", "errors": {"title": ["…"]}}.

Pricing & the hidden-price rule

sale_price is always a string, and it comes in two shapes:

  • "45999.00" — a real price
  • "X" — the shop has chosen to hide this item's price

So never feed sale_price straight into a number parser. Branch on price_hidden first:

if (product.price_hidden) {
  showEnquiryButton();            // "Price on request"
} else {
  showPrice(parseFloat(product.sale_price));
}

Price-hidden items are still real, in-stock products — list them, just without a number. Currency is always INR. This is the shop's selling price; any margin of yours is yours to add.

Categories

Each shop groups its stock into categories of its own (for example "Mobiles", "Accessories"). A product carries its category twice: as the raw id main_category_id for your own joins, and as a ready-made main_category object with the name and image filled in, so you do not need a second lookup just to render a breadcrumb.

FieldTypeMeaning
main_category.idintSame value as main_category_id
main_category.namestringDisplay name, as the shop wrote it
main_category.thumbstring · nullFull image URL, or null when the shop has not set one

Both main_category_id and main_category are null when a shop has not categorised an item — and today that is most items. Put uncategorised products in a general section rather than hiding them, or they become unreachable on your site.

GET /categories returns every category you can currently see:

{
  "success": true,
  "data": [
    {
      "id": 3,
      "name": "Mobiles",
      "thumb": "https://img.phoneo.in/Phoneo/2025/Image/Enjoyer/E5/MainCat/MainCat-3/Thumb/b.jpg",
      "sub": []
    },
    {
      "id": 7,
      "name": "Accessories",
      "thumb": null,
      "sub": []
    }
  ]
}

Only categories that actually contain a product you can see are listed, so this list shrinks and grows with the catalog. sub is always an empty array — Phoneo no longer has sub-categories. The key is kept so that code written against the earlier nested shape keeps working.

How to keep your site in sync

  1. Once, at setup: walk GET /products with the cursor until has_more is false. Store every item's key and updated_at.
  2. Every 5–15 minutes: call GET /products?updated_since=<the newest updated_at you hold>. Upsert rows with status: "active"; remove rows with status: "removed".
  3. At checkout, every time: GET /products/availability for the items in the basket.
  4. Once a day: re-walk the full catalog and reconcile against your copy. This is the safety net that catches anything the delta missed.
Overlap your updated_since by a few minutes rather than using the exact last timestamp. Re-processing an item you already have costs nothing; missing one costs you a sale or leaves a sold phone on your site.
Phoneo does not reserve stock for you. The same handset is on sale at the shop counter at the same time. Design the unhappy path deliberately: check availability before taking payment, and have a clear flow for "this item just sold".

What you will never receive

These fields are deliberately excluded, and no parameter will turn them on:

  • IMEI and serial numbers (IMEI, SN, WSN)
  • Purchase price, sold price, or any margin figure
  • Supplier, vendor or customer details of any kind
  • Private/internal notes and tags
  • HSN/SAC and other tax fields
  • The shop's numeric id, phone number or address

If your integration genuinely needs something in this list, raise it with Phoneo as a scope question. It is not a setting anyone can flip on the API.

Getting set up

  1. Request access. Email support@phoneo.in with your company name, your website, the email address the key should go to, the Phoneo shops whose stock you want to list, and — if you have them — your servers' fixed outbound IPs.
  2. Shop consent. Phoneo confirms with each shop owner before assigning their shop to you. You only ever see shops that have agreed.
  3. Receive your key. Phoneo emails you a one-time link. Open it and press Reveal my API key. The key is created at that moment and shown once — copy it straight into your server's configuration. It cannot be looked up again, only replaced.
    • The link expires after 24 hours and works only once.
    • If the link says it has already been used and you did not open it, email support@phoneo.in straight away — someone else may have opened it. Phoneo will switch that key off and send you a new link.
    • If it has expired, ask for a new one. Each new link cancels the previous one.
  4. Confirm the connection with GET /ping.
  5. Do the full catalog walk, then put the 5–15 minute delta job on a schedule.

A Postman collection and environment file are available alongside this document. Questions: support@phoneo.in.

Need help?

Write to support@phoneo.in. For a permission error, include the exact error value from the response.