Skip to main content
GET
List products

Authorizations

x-access-token
string
header
required

JWT minted from a merchant API key (mk_live_…) by POST /authenticate. Send the token value directly, with no "Bearer" prefix. Tokens last 14 days and can be renewed at POST /refresh-token; revoking the key refuses the next request made with any token minted from it.

Query Parameters

vendorId
string

Narrow to this vendor. Must be a vendor of this shop (403 otherwise, 400 when malformed).

status
string

One status, several comma-separated (status=active,draft) or the parameter repeated. Values: active, draft, pending, error, deleted, archived. Each matches stored statuses, and rows come back with the stored value: active matches live and active; archived matches archived and disapprove (a product archived on Shopify is stored as archived by PuppetVendors and the legacy sync alike; disapprove is rejected by the merchant, or an older archived row); draft, pending, error and deleted match the same stored value.

inventoryStatus
enum<string>

inStock is a total inventory above 0; outOfStock is 0 or below.

Available options:
inStock,
outOfStock
createdAtMin
string<date-time>

Created at or after this ISO 8601 time.

createdAtMax
string<date-time>

Created at or before this ISO 8601 time.

Full-text search on the product title and vendor name (whole words, not substrings).

Maximum string length: 200
first
integer

Page size when paging forward (default 20). Use with after.

Required range: 1 <= x <= 100
after
string

The pageInfo.endCursor of the previous page.

last
integer

Page size when paging backward. Use with before.

Required range: 1 <= x <= 100
before
string

The pageInfo.startCursor of the page after the one wanted.

sortBy
enum<string>
default:updatedAt
Available options:
title,
totalInventory,
createdAt,
updatedAt
sortOrder
enum<string>
default:desc
Available options:
asc,
desc

Response

One page of products

success
enum<boolean>
required

Indicates the request was successful

Available options:
true
data
any
required

The response payload