GET
/
api
/
v2
/
platform
/
products
/
{id}
Return a Product
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/products/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Query Parameters

​
include
string

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.