Connected sources

GET/v1/shops/{id}/shopify/products

The products in the shop's Shopify, fifty at a time, as the Sources page lists them.

What it does

By title. Each call first lets the copy of the Shopify data catch up for a few seconds, at most 120 times an hour per person, so the list is fresh without spending the shop's own Shopify allowance.

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}/shopify/products

Parameters

Name	In	Type	Required	What it is
`id`	path	integer	Yes	The shop's id.
`q`	query	string	No	Only the rows whose title, SKU or barcode (orders: name) contain this.
`cursor`	query	string	No	The `nextCursor` of the page before.
`Authorization`	header	string	Yes	Bearer, a space, then the key.

Example request

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

import os

import requests

response = requests.get(
    "https://panlytics.net/api/v1/shops/12/shopify/products",
    headers={"Authorization": f"Bearer {os.environ['PANLYTICS_KEY']}"},
    timeout=60,
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://panlytics.net/api/v1/shops/12/shopify/products", {
  headers: {
    Authorization: `Bearer ${process.env.PANLYTICS_KEY}`,
  },
});
if (!response.ok) throw new Error(`Panlytics answered ${response.status}`);
console.log(await response.json());

Response

200: The answer, as JSON.

Field	Type	Always there	What it is
`data[]`	object[]	Yes	Up to fifty rows.
`data[].variantId`	string	Yes	Shopify's variant id.
`data[].title`	string	Yes	The product and variant title.
`data[].sku`	string	Yes	The SKU, or empty.
`data[].barcode`	string	Yes	The barcode, or empty.
`data[].productType`	string	Yes	The Shopify product type, or empty.
`data[].status`	string	Yes	active, draft or archived.
`data[].price`	number	Yes	The price.
`data[].cost`	number or null	Yes	The cost price, or null.
`data[].stock`	number	Yes	Pieces in stock.
`data[].tracked`	boolean	Yes	True when Shopify tracks its stock.
`nextCursor`	string or null	Yes	Send it as `cursor` for the next page. Null on the last page.
`currency`	string	Yes	The shop's currency.

Example response

200

{
  "data": [
    {
      "variantId": "4410001",
      "title": "Oat milk 1 l",
      "sku": "OAT-1",
      "barcode": "6410000000017",
      "productType": "Beverages",
      "status": "active",
      "price": 2.49,
      "cost": 1.2,
      "stock": 14,
      "tracked": true
    }
  ],
  "nextCursor": null,
  "currency": "EUR"
}

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.

Status	Code	When	What to do
400	`api.invalid`	A 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.
401	`api.key_missing`	The call had no Authorization header.	Send the key in the Authorization header as Bearer, then call again.
401	`api.key_refused`	The 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.
401	`api.wrong_key_kind`	This key does not open these endpoints.	Use the key these endpoints were made for, or ask the person who gave you the key.
403	`refused`	The 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.
403	`auth.not_fresh`	This step needs you to prove it is you.	Confirm your password or passkey, then try again.
404	`not_found.said`	Nothing 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.
409	`source.none`	No source is connected to this shop.	Connect one from Sources, then try again.
429	`api.rate_limited`	The key made more than 120 calls in this minute. Wait the seconds in Retry-After.	Wait the seconds in Retry-After, then call again.
500	`server`	Something failed on our side. The answer carries a requestId to quote.	Try again in a minute; if it keeps happening, report it.
503	`developer.unavailable`	API keys are not set up on this deployment yet.	Report it, and we will switch them on.