Skip to main content
GET
/
api
/
v2
/
platform
/
stock_items
/
{id}
Return a Stock Item
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/stock_items/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "287",
    "type": "stock_item",
    "attributes": {
      "count_on_hand": 10,
      "created_at": "2022-11-08T19:35:28.695Z",
      "updated_at": "2022-11-08T19:35:28.707Z",
      "backorderable": true,
      "deleted_at": null,
      "public_metadata": {},
      "private_metadata": {},
      "is_available": true
    },
    "relationships": {
      "stock_location": {
        "data": {
          "id": "162",
          "type": "stock_location"
        }
      },
      "variant": {
        "data": {
          "id": "277",
          "type": "variant"
        }
      }
    }
  }
}

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: https://jsonapi.org/format/#fetching-includes

Response

Record found

​
data
object
required