Storefront API
- Authentication
- Account
- Account / Address
- Account / Credit Cards
- Account / Orders
- Order Status
- Cart
- Cart / Line Items
- Cart / Other
- Cart / Coupons
- Checkout
- Checkout / State
- Checkout / Shipments
- Checkout / Payments
- Checkout / Store Credit
- Stripe
- Products
- Vendors
- Stores
- Taxons
- Countries
- CMS Pages
- Menus
- Wishlists
- Wishlists / Wished Items
- Digital Downloads
Platform API
- Authentication
- Addresses
- Adjustments
- Classifications
- CMS Pages
- CMS Sections
- Countries
- Data Feeds
- Digital Links
- Digital Assets
- Line Items
- Menu Items
- Menus
- Option Types
- Option Values
- Orders
- Payment Methods
- Payments
- Products
- Promotion Actions
- Promotion Categories
- Promotion Rules
- Promotions
- Roles
- Shipments
- Shipping Categories
- Shipping Methods
- States
- Stock Items
- Stock Locations
- Store Credit Categories
- Store Credit Types
- Store Credits
- Tax Categories
- Tax Rates
- Taxonomies
- Taxons
- Users
- Variants
- Vendors
- Webhook Events
- Webhook Subscribers
- Wished Items
- Wishlists
- Zones
Products
Return a list of Products
Returns a list of Products
GET
/
api
/
v2
/
platform
/
products
curl --request GET \
--url http://{defaultHost}/api/v2/platform/products \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "164",
"type": "product",
"attributes": {
"name": "Product 1648238",
"description": "Expedita a doloribus dolorum possimus architecto eligendi sunt quod. Officiis rerum nostrum incidunt delectus sint reiciendis doloribus ut. Atque voluptate nostrum voluptas unde repellendus.\nCum natus a id amet eos eligendi laborum. Minus itaque culpa aliquid repudiandae est odio reiciendis temporibus. Nesciunt cum voluptas veniam excepturi ducimus explicabo recusandae. Error quos voluptate reiciendis numquam dicta.",
"available_on": "2021-11-08T19:34:52.496Z",
"deleted_at": null,
"slug": "product-1648238",
"meta_description": null,
"meta_keywords": null,
"created_at": "2022-11-08T19:34:52.514Z",
"updated_at": "2022-11-08T19:34:52.520Z",
"promotionable": true,
"meta_title": null,
"discontinue_on": null,
"public_metadata": {},
"private_metadata": {},
"status": "active",
"make_active_at": "2021-11-08T19:34:52.496Z",
"display_compare_at_price": null,
"display_price": "$19.99",
"purchasable": true,
"in_stock": false,
"backorderable": true,
"available": true,
"currency": "USD",
"price": "19.99",
"compare_at_price": null
},
"relationships": {
"tax_category": {
"data": {
"id": "108",
"type": "tax_category"
}
},
"primary_variant": {
"data": {
"id": "231",
"type": "variant"
}
},
"default_variant": {
"data": {
"id": "231",
"type": "variant"
}
},
"variants": {
"data": []
},
"option_types": {
"data": []
},
"product_properties": {
"data": []
},
"taxons": {
"data": []
},
"images": {
"data": []
}
}
},
{
"id": "165",
"type": "product",
"attributes": {
"name": "Product 1653934",
"description": "Blanditiis deleniti tempora provident culpa id doloremque. Quibusdam commodi minus magni asperiores nemo odio. Laborum mollitia alias quisquam exercitationem aliquam ex occaecati doloremque. Quos optio voluptatum suscipit soluta assumenda quaerat maxime fugit. In saepe quaerat exercitationem earum sequi.\nQuidem nesciunt provident dicta explicabo autem nemo sunt. Iusto in provident officiis sed. Eveniet quam distinctio ipsam optio sint. Et autem ducimus vel voluptas facere.\nEarum inventore ut eum eos numquam. Omnis nam provident atque temporibus. Natus illo voluptas enim ex optio eveniet ullam. Labore repudiandae laudantium non suscipit est quae. Odio provident a ad fuga accusamus distinctio vitae.\nDoloremque quod similique ipsa quas perferendis rerum earum excepturi. Minus explicabo autem quod incidunt. Earum magnam voluptatem expedita eveniet reiciendis dolores atque et.\nInventore odio voluptate dicta dolore natus aut occaecati molestiae. Aut eum consequatur soluta voluptatum animi delectus accusantium asperiores. Facere exercitationem consequuntur adipisci nulla similique perferendis ullam. Illo ad aliquid maiores non ea.",
"available_on": "2021-11-08T19:34:52.538Z",
"deleted_at": null,
"slug": "product-1653934",
"meta_description": null,
"meta_keywords": null,
"created_at": "2022-11-08T19:34:52.549Z",
"updated_at": "2022-11-08T19:34:52.555Z",
"promotionable": true,
"meta_title": null,
"discontinue_on": null,
"public_metadata": {},
"private_metadata": {},
"status": "active",
"make_active_at": "2021-11-08T19:34:52.538Z",
"display_compare_at_price": null,
"display_price": "$19.99",
"purchasable": true,
"in_stock": false,
"backorderable": true,
"available": true,
"currency": "USD",
"price": "19.99",
"compare_at_price": null
},
"relationships": {
"tax_category": {
"data": {
"id": "108",
"type": "tax_category"
}
},
"primary_variant": {
"data": {
"id": "232",
"type": "variant"
}
},
"default_variant": {
"data": {
"id": "232",
"type": "variant"
}
},
"variants": {
"data": []
},
"option_types": {
"data": []
},
"product_properties": {
"data": []
},
"taxons": {
"data": []
},
"images": {
"data": []
}
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/products?page=1&per_page=&include=&filter[name_eq]=",
"next": "http://www.example.com/api/v2/platform/products?filter%5Bname_eq%5D=&include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/products?filter%5Bname_eq%5D=&include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/products?filter%5Bname_eq%5D=&include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/products?filter%5Bname_eq%5D=&include=&page=1&per_page="
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>
Response
200
application/vnd.api+json
Records returned
The response is of type object
.
Was this page helpful?
curl --request GET \
--url http://{defaultHost}/api/v2/platform/products \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "164",
"type": "product",
"attributes": {
"name": "Product 1648238",
"description": "Expedita a doloribus dolorum possimus architecto eligendi sunt quod. Officiis rerum nostrum incidunt delectus sint reiciendis doloribus ut. Atque voluptate nostrum voluptas unde repellendus.\nCum natus a id amet eos eligendi laborum. Minus itaque culpa aliquid repudiandae est odio reiciendis temporibus. Nesciunt cum voluptas veniam excepturi ducimus explicabo recusandae. Error quos voluptate reiciendis numquam dicta.",
"available_on": "2021-11-08T19:34:52.496Z",
"deleted_at": null,
"slug": "product-1648238",
"meta_description": null,
"meta_keywords": null,
"created_at": "2022-11-08T19:34:52.514Z",
"updated_at": "2022-11-08T19:34:52.520Z",
"promotionable": true,
"meta_title": null,
"discontinue_on": null,
"public_metadata": {},
"private_metadata": {},
"status": "active",
"make_active_at": "2021-11-08T19:34:52.496Z",
"display_compare_at_price": null,
"display_price": "$19.99",
"purchasable": true,
"in_stock": false,
"backorderable": true,
"available": true,
"currency": "USD",
"price": "19.99",
"compare_at_price": null
},
"relationships": {
"tax_category": {
"data": {
"id": "108",
"type": "tax_category"
}
},
"primary_variant": {
"data": {
"id": "231",
"type": "variant"
}
},
"default_variant": {
"data": {
"id": "231",
"type": "variant"
}
},
"variants": {
"data": []
},
"option_types": {
"data": []
},
"product_properties": {
"data": []
},
"taxons": {
"data": []
},
"images": {
"data": []
}
}
},
{
"id": "165",
"type": "product",
"attributes": {
"name": "Product 1653934",
"description": "Blanditiis deleniti tempora provident culpa id doloremque. Quibusdam commodi minus magni asperiores nemo odio. Laborum mollitia alias quisquam exercitationem aliquam ex occaecati doloremque. Quos optio voluptatum suscipit soluta assumenda quaerat maxime fugit. In saepe quaerat exercitationem earum sequi.\nQuidem nesciunt provident dicta explicabo autem nemo sunt. Iusto in provident officiis sed. Eveniet quam distinctio ipsam optio sint. Et autem ducimus vel voluptas facere.\nEarum inventore ut eum eos numquam. Omnis nam provident atque temporibus. Natus illo voluptas enim ex optio eveniet ullam. Labore repudiandae laudantium non suscipit est quae. Odio provident a ad fuga accusamus distinctio vitae.\nDoloremque quod similique ipsa quas perferendis rerum earum excepturi. Minus explicabo autem quod incidunt. Earum magnam voluptatem expedita eveniet reiciendis dolores atque et.\nInventore odio voluptate dicta dolore natus aut occaecati molestiae. Aut eum consequatur soluta voluptatum animi delectus accusantium asperiores. Facere exercitationem consequuntur adipisci nulla similique perferendis ullam. Illo ad aliquid maiores non ea.",
"available_on": "2021-11-08T19:34:52.538Z",
"deleted_at": null,
"slug": "product-1653934",
"meta_description": null,
"meta_keywords": null,
"created_at": "2022-11-08T19:34:52.549Z",
"updated_at": "2022-11-08T19:34:52.555Z",
"promotionable": true,
"meta_title": null,
"discontinue_on": null,
"public_metadata": {},
"private_metadata": {},
"status": "active",
"make_active_at": "2021-11-08T19:34:52.538Z",
"display_compare_at_price": null,
"display_price": "$19.99",
"purchasable": true,
"in_stock": false,
"backorderable": true,
"available": true,
"currency": "USD",
"price": "19.99",
"compare_at_price": null
},
"relationships": {
"tax_category": {
"data": {
"id": "108",
"type": "tax_category"
}
},
"primary_variant": {
"data": {
"id": "232",
"type": "variant"
}
},
"default_variant": {
"data": {
"id": "232",
"type": "variant"
}
},
"variants": {
"data": []
},
"option_types": {
"data": []
},
"product_properties": {
"data": []
},
"taxons": {
"data": []
},
"images": {
"data": []
}
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/products?page=1&per_page=&include=&filter[name_eq]=",
"next": "http://www.example.com/api/v2/platform/products?filter%5Bname_eq%5D=&include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/products?filter%5Bname_eq%5D=&include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/products?filter%5Bname_eq%5D=&include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/products?filter%5Bname_eq%5D=&include=&page=1&per_page="
}
}