List products
Products of the workspace’s stores, by title, in a locale. Search matches the title, vendor, handle or a variant’s SKU. Without a status filter, removed products are left out. A Shopify app session sees its own store only.
Products of the workspace’s stores, by title, in a locale. Search matches the title, vendor, handle or a variant’s SKU. Without a status filter, removed products are left out. A Shopify app session sees its own store only.
apiKey readAuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
page?integerStarts at 1
1 <= value1pageSize?numberOne of 10, 25, 50, 100
25q?stringSearch
1 <= length <= 200locale?stringContent locale; the workspace default without one
length <= 35store?stringComma-separated ids
status?stringComma-separated, any of: active, unlisted, draft, archived, removed
stock?stringComma-separated, any of: in_stock, out_of_stock, not_tracked
sort?stringOne of title, price, inventory, changedAt; prefix with - for descending
"title""title""-title""price""-price""inventory""-inventory""changedAt""-changedAt"OK
application/json- response
items*array<>total*integerpage*integerpageSize*integerall*integercurl -X GET 'https://api.postforge.dev/v1/products'{ "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c", "externalId": "string", "locale": "string", "title": "string", "missing": [ "title" ], "published": true, "handle": "string", "status": "active", "removedAt": "2019-08-24T14:15:22Z", "vendor": "string", "productType": "string", "image": { "url": "http://example.com", "alt": "string" }, "price": { "min": { "amount": 0, "currency": "str" }, "max": { "amount": 0, "currency": "str" } }, "compareAtPrice": { "amount": 0, "currency": "str" }, "variantCount": 0, "stock": "in_stock", "inventory": 0, "changedAt": "2019-08-24T14:15:22Z" } ], "total": 0, "page": 0, "pageSize": 0, "all": 0}