---
title: "Set a shopping-list item checked state"
method: PATCH
path: "/api/v1/shopping-list/items/{itemId}"
tags: ["Shopping List"]
---

# Set a shopping-list item checked state

`PATCH /api/v1/shopping-list/items/{itemId}`

## Request

- Base URL: `https://spoonjoy.app`
- URL: `https://spoonjoy.app/api/v1/shopping-list/items/{itemId}`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__session`
  - OAuth 2 (authorization code, authorization URL `https://spoonjoy.app/oauth/authorize`, token URL `https://spoonjoy.app/oauth/token`, scopes: `shopping_list:write`)
  - OAuth 2 (authorization code, authorization URL `https://spoonjoy.app/oauth/authorize`, token URL `https://spoonjoy.app/oauth/token`, scopes: `kitchen:write`)

## Path parameters

- `itemId` string, required

## Headers

- `X-Request-Id` string

## Request body

- CheckShoppingItemRequest
  - `clientMutationId` string, required
  - `checked` boolean, required

## Response `200`

Success

- UpdateShoppingItemEnvelope
  - `ok` unknown, required
  - `requestId` string, required
  - `data` UpdateShoppingItemData, required
    - `item` ShoppingItem, required
      - `id` string, required
      - `name` string, required
      - `quantity` number, nullable, required
      - `unit` string, nullable, required
      - `checked` boolean, required
      - `checkedAt` string, date-time, nullable, required
      - `deletedAt` string, date-time, nullable, required
      - `categoryKey` string, nullable, required
      - `iconKey` string, nullable, required
      - `sortIndex` integer, required
      - `updatedAt` string, date-time, required
    - `mutation` MutationMetadata, required
      - `clientMutationId` string, required
      - `replayed` boolean, required

## Other responses

- `400`: Errors: invalid_json, validation_error
- `401`: Errors: authentication_required, invalid_token
- `403`: Errors: insufficient_scope
- `404`: Errors: not_found
- `405`: Errors: method_not_allowed
- `409`: Errors: idempotency_conflict, idempotency_in_progress
- `429`: Errors: rate_limited
- `500`: Errors: internal_error
- `503`: Errors: temporarily_unavailable

---

[API](https://skmtc.dev/spoonjoy/apis/spoonjoy-api.md) · [All operations](https://skmtc.dev/spoonjoy/apis/spoonjoy-api/llms.txt) · [OpenAPI document](https://skmtc.dev/spoonjoy/apis/spoonjoy-api/revisions/b96eb5d4697d?raw)