Products
Products List
Retrieve a list of all products.
Authorization
oauth2 catalogue:readAuthorizationBearer <token>
Generate an Access Token through Settings > API Access for single store access or use the Authorization Code flow with your partner App Client ID. Use required permission scopes for API endpoint access. Example Authorization: Bearer 123
In: header
Scope: catalogue:read
Query Parameters
title?string
category?array<>
range?array<>
is_public?boolean
Is Public
is_gift_card?boolean
Is Gift Card
sku?array<>
cursor?string
The pagination cursor value.
Header Parameters
X-29next-API-Version*string
Default
"2023-02-10"Value in
"2023-02-10"Response Body
application/json
curl -X GET "https://example.29next.store/api/admin/products/" \
-H "X-29next-API-Version: 2023-02-10" \
-H "Authorization: Bearer "{
"next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
"previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
"results": [
{
"categories": [
{
"id": 0,
"name": "string",
"slug": "string"
}
],
"children": [
{
"allow_backorders": true,
"date_created": "2019-08-24T14:15:22Z",
"date_updated": "2019-08-24T14:15:22Z",
"id": 0,
"images": "string",
"inventory_availability": "in_stock",
"metadata": {},
"prices": [
{
"currency": "string",
"price": "string",
"retail": "string",
"subscription": "string",
"subscription_suggested_downsell": "string"
}
],
"product_id": 0,
"purchase_availability": "available",
"requires_shipping": true,
"sku": "string",
"stockrecords": [
{
"id": 0,
"location_id": 0,
"low_stock_threshold": 2147483647,
"num_allocated": 0,
"num_in_stock": -2147483648,
"price": "string",
"price_currency": "string",
"price_retail": "string",
"sku": "string"
}
],
"structure": "standalone",
"title": "string",
"track_stock": true,
"unit_cost": "string",
"upc": "string",
"variant_attribute_values": [
{
"code": "string",
"name": "string",
"value": "string"
}
]
}
],
"date_created": "2019-08-24T14:15:22Z",
"date_updated": "2019-08-24T14:15:22Z",
"enable_subscription": true,
"external_tax_code": "string",
"id": 0,
"images": [
{
"attachment": "string",
"caption": "string",
"display_order": 2147483647,
"file_name": "string",
"id": 0,
"src": "http://example.com"
}
],
"interval": "day",
"interval_counts": [
-2147483648
],
"is_discountable": true,
"is_public": true,
"metadata": {},
"ranking": -2147483648,
"rating": 0,
"recommended_products": [
0
],
"slug": "string",
"structure": "standalone",
"title": "string",
"url": "http://example.com",
"variant_attributes": [
{
"code": "string",
"name": "string",
"values": [
"string"
]
}
]
}
]
}