PATCH
/
api
/
v2
/
platform
/
stock_items
/
{id}
curl --request PATCH \
  --url http://{defaultHost}/api/v2/platform/stock_items/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "stock_item": {
    "variant_id": "2",
    "stock_location_id": "2",
    "count_on_hand": 200,
    "backorderable": true
  }
}'
{
  "data": {
    "id": "291",
    "type": "stock_item",
    "attributes": {
      "count_on_hand": 200,
      "created_at": "2022-11-08T19:35:29.347Z",
      "updated_at": "2022-11-08T19:35:29.598Z",
      "backorderable": true,
      "deleted_at": null,
      "public_metadata": {},
      "private_metadata": {},
      "is_available": true
    },
    "relationships": {
      "stock_location": {
        "data": {
          "id": "166",
          "type": "stock_location"
        }
      },
      "variant": {
        "data": {
          "id": "279",
          "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: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>

Body

application/json
​
stock_item
object
required

Response

200
application/vnd.api+json
Record updated
​
data
object
required

Was this page helpful?

Suggest editsRaise issue
Delete a Stock ItemReturn a list of Stock Locations