GET
/
api
/
v2
/
platform
/
stock_items
Return a list of Stock Items
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/stock_items \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "276",
      "type": "stock_item",
      "attributes": {
        "count_on_hand": 0,
        "created_at": "2022-11-08T19:35:27.570Z",
        "updated_at": "2022-11-08T19:35:27.614Z",
        "backorderable": false,
        "deleted_at": null,
        "public_metadata": {},
        "private_metadata": {},
        "is_available": false
      },
      "relationships": {
        "stock_location": {
          "data": {
            "id": "157",
            "type": "stock_location"
          }
        },
        "variant": {
          "data": {
            "id": "271",
            "type": "variant"
          }
        }
      }
    },
    {
      "id": "278",
      "type": "stock_item",
      "attributes": {
        "count_on_hand": 10,
        "created_at": "2022-11-08T19:35:27.634Z",
        "updated_at": "2022-11-08T19:35:27.644Z",
        "backorderable": true,
        "deleted_at": null,
        "public_metadata": {},
        "private_metadata": {},
        "is_available": true
      },
      "relationships": {
        "stock_location": {
          "data": {
            "id": "157",
            "type": "stock_location"
          }
        },
        "variant": {
          "data": {
            "id": "272",
            "type": "variant"
          }
        }
      }
    }
  ],
  "meta": {
    "count": 2,
    "total_count": 2,
    "total_pages": 1
  },
  "links": {
    "self": "http://www.example.com/api/v2/platform/stock_items?page=1&per_page=&include=",
    "next": "http://www.example.com/api/v2/platform/stock_items?include=&page=1&per_page=",
    "prev": "http://www.example.com/api/v2/platform/stock_items?include=&page=1&per_page=",
    "last": "http://www.example.com/api/v2/platform/stock_items?include=&page=1&per_page=",
    "first": "http://www.example.com/api/v2/platform/stock_items?include=&page=1&per_page="
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer
​
per_page
integer
​
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

Records returned

The response is of type object.