Suppliers

GET/v1/shops/{id}/suppliers

Who delivers to one shop, and the days a delivery takes from each.

What it does

A key whose maker is limited to chosen categories sees no suppliers, as in the app.

Who may call it

A key whose maker's role holds figures (see the figures), after the fence, for the shop or category it names.

Request

HTTP
GET https://panlytics.net/api/v1/shops/{id}/suppliers

Parameters

NameInTypeRequiredWhat it is
idpathintegerYesThe shop's id.
cursorquerystringNoThe nextCursor of the page before. Leave it out for the first page. Treat it as an opaque string.
limitqueryintegerNoHow many rows on one page: 1 to 200, 50 when left out.
AuthorizationheaderstringYesBearer, a space, then the key.

Example request

curl https://panlytics.net/api/v1/shops/12/suppliers \
  -H "Authorization: Bearer $PANLYTICS_KEY"

Response

200: The answer, as JSON.

FieldTypeAlways thereWhat it is
data[]object[]YesThe rows of this page.
data[].idintegerYesThe supplier's id.
data[].shopIdintegerYesThe shop the supplier delivers to.
data[].namestringYesThe supplier's name.
data[].leadTimeDaysintegerYesThe days a delivery takes from this supplier.
data[].categoryIds[]integer[]YesThe categories this supplier delivers.
data[].createdAtstring (ISO 8601)YesWhen the supplier was added, in UTC.
data[].updatedAtstring (ISO 8601)YesWhen the supplier last changed, in UTC.
nextCursorstring or nullYesSend it as cursor for the next page. Null on the last page.
totalintegerYesHow many rows the whole list has.

Example response

200
{
  "data": [
    {
      "id": 5,
      "shopId": 12,
      "name": "Example Wholesale",
      "leadTimeDays": 2,
      "categoryIds": [
        40
      ],
      "createdAt": "2026-10-01T08:00:00.000Z",
      "updatedAt": "2026-10-01T08:00:00.000Z"
    }
  ],
  "nextCursor": null,
  "total": 1
}

Errors

A refusal is JSON with a code, a sentence in error, and a requestId when the fault is ours. Read the code, not the sentence. Every code is listed on Errors.

StatusCodeWhenWhat to do
400api.invalidA path id, a query parameter, a header or a body field is missing or not valid. detail names the field.Read that endpoint in the API reference, correct the field and call again.
401api.key_missingThe call had no Authorization header.Send the key in the Authorization header as Bearer, then call again.
401api.key_refusedThe key is wrong, revoked, past its end, or its maker or company no longer allows it (developer mode off, the maker removed or switched off, or the maker's role lost the developer ability).Ask the person who gave you the key to make a new one.
401api.wrong_key_kindThis key does not open these endpoints.Use the key these endpoints were made for, or ask the person who gave you the key.
403refusedThe key's maker may not do this here: their role lacks the ability, or the shop or category is outside their reach.Ask the CEO for a role that allows it, or call it for a shop or category the role reaches.
403auth.not_freshThis step needs you to prove it is you.Confirm your password or passkey, then try again.
404not_found.saidNothing with that id in the key's company. An id of another company answers the same.Check the id. List the shop or category it belongs to and take the id from there.
429api.rate_limitedThe key made more than 120 calls in this minute. Wait the seconds in Retry-After.Wait the seconds in Retry-After, then call again.
500serverSomething failed on our side. The answer carries a requestId to quote.Try again in a minute; if it keeps happening, report it.
503developer.unavailableAPI keys are not set up on this deployment yet.Report it, and we will switch them on.