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
- Products
- 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
- Webhook Events
- Webhook Subscribers
- Wished Items
- Wishlists
- Zones
Products
Return a Product
Returns a Product
GET
/
api
/
v2
/
platform
/
products
/
{id}
Copy
curl --request GET \
--url http://{defaultHost}/api/v2/platform/products/{id} \
--header 'Authorization: Bearer <token>'
Copy
{
"data": {
"id": "169",
"type": "product",
"attributes": {
"name": "Product 1682525",
"description": "Enim quibusdam et quis in iste. Eius labore corporis tempora suscipit molestiae sunt. Omnis vero numquam nostrum totam illum consectetur similique corporis.\nIusto neque beatae consequatur consequuntur soluta pariatur at. Magnam numquam nisi voluptatem ipsa blanditiis ullam iste mollitia. Incidunt totam earum perferendis eveniet iusto ea. Sapiente est quam corporis veniam eveniet itaque.\nRepudiandae autem cumque hic nisi perferendis cum quod nostrum. Voluptatem ipsam esse provident itaque similique quia. Nobis quod blanditiis atque cupiditate eaque perspiciatis ullam in. Sequi aspernatur eaque reiciendis error illo dolorum pariatur.\nSit recusandae reiciendis magni ipsam repudiandae est dolor quae. Veritatis possimus eveniet iusto dignissimos quasi consequatur temporibus. Magni asperiores officiis occaecati provident velit quos a voluptate.",
"available_on": "2021-11-08T19:34:53.563Z",
"deleted_at": null,
"slug": "product-1682525",
"meta_description": null,
"meta_keywords": null,
"created_at": "2022-11-08T19:34:53.582Z",
"updated_at": "2022-11-08T19:34:53.588Z",
"promotionable": true,
"meta_title": null,
"discontinue_on": null,
"public_metadata": {},
"private_metadata": {},
"status": "active",
"make_active_at": "2021-11-08T19:34:53.563Z",
"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": "110",
"type": "tax_category"
}
},
"primary_variant": {
"data": {
"id": "236",
"type": "variant"
}
},
"default_variant": {
"data": {
"id": "236",
"type": "variant"
}
},
"variants": {
"data": []
},
"option_types": {
"data": []
},
"product_properties": {
"data": []
},
"taxons": {
"data": []
},
"images": {
"data": []
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
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
Record found
The response is of type object
.
Was this page helpful?
Copy
curl --request GET \
--url http://{defaultHost}/api/v2/platform/products/{id} \
--header 'Authorization: Bearer <token>'
Copy
{
"data": {
"id": "169",
"type": "product",
"attributes": {
"name": "Product 1682525",
"description": "Enim quibusdam et quis in iste. Eius labore corporis tempora suscipit molestiae sunt. Omnis vero numquam nostrum totam illum consectetur similique corporis.\nIusto neque beatae consequatur consequuntur soluta pariatur at. Magnam numquam nisi voluptatem ipsa blanditiis ullam iste mollitia. Incidunt totam earum perferendis eveniet iusto ea. Sapiente est quam corporis veniam eveniet itaque.\nRepudiandae autem cumque hic nisi perferendis cum quod nostrum. Voluptatem ipsam esse provident itaque similique quia. Nobis quod blanditiis atque cupiditate eaque perspiciatis ullam in. Sequi aspernatur eaque reiciendis error illo dolorum pariatur.\nSit recusandae reiciendis magni ipsam repudiandae est dolor quae. Veritatis possimus eveniet iusto dignissimos quasi consequatur temporibus. Magni asperiores officiis occaecati provident velit quos a voluptate.",
"available_on": "2021-11-08T19:34:53.563Z",
"deleted_at": null,
"slug": "product-1682525",
"meta_description": null,
"meta_keywords": null,
"created_at": "2022-11-08T19:34:53.582Z",
"updated_at": "2022-11-08T19:34:53.588Z",
"promotionable": true,
"meta_title": null,
"discontinue_on": null,
"public_metadata": {},
"private_metadata": {},
"status": "active",
"make_active_at": "2021-11-08T19:34:53.563Z",
"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": "110",
"type": "tax_category"
}
},
"primary_variant": {
"data": {
"id": "236",
"type": "variant"
}
},
"default_variant": {
"data": {
"id": "236",
"type": "variant"
}
},
"variants": {
"data": []
},
"option_types": {
"data": []
},
"product_properties": {
"data": []
},
"taxons": {
"data": []
},
"images": {
"data": []
}
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.