Contents
On this page

Update Shopping List Item - Plugixa Recipe

PUT /plugixa-recipe/v1/shopping-lists/{id}/items/{item_id}

Change the fields you send on one line, for example to tick it off.

Needs the plugixa_recipe_edit capability, or WordPress’s edit_posts (Contributor and up). Needs Plugixa Recipe Pro with the Shopping Lists app on. Each user only ever sees and changes their own lists: another user’s list answers 404.

Request

PUT https://your-site.example/wp-json/plugixa-recipe/v1/shopping-lists/9/items/55

Path parameters

Name Type Description
id integer The shopping list’s id
item_id integer The line’s id

Request body

Content type: application/json

Field Type Required Description
is_checked integer No 1 to tick the line off, 0 to untick it.
ingredient_name, quantity, unit string No New text.
sort_order integer No New position. 
{
  "is_checked": 1
}

Responses

200 OK. data is the line as stored now.

{
  "success": true,
  "message": "",
  "data": {
    "id": "55",
    "shopping_list_id": "9",
    "recipe_id": "12",
    "ingredient_name": "flour",
    "quantity": "2",
    "unit": "cups",
    "is_checked": true,
    "sort_order": "0",
    "added_at": "2026-11-12 09:30:00"
  }
}
Field Type Meaning
data.is_checked boolean Ticked off

Errors

Status Code When
404 rest_error No such line on a list belonging to the caller.

Plus the errors every endpoint can return.

Examples

curl -s -X PUT "https://your-site.example/wp-json/plugixa-recipe/v1/shopping-lists/9/items/55" \
  -u "admin:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"is_checked":1}'

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-recipe/v1/shopping-lists/9/items/55');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'PUT',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
    CURLOPT_HTTPHEADER     => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'is_checked' => 1,
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const auth = 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`);
const response = await fetch('https://your-site.example/wp-json/plugixa-recipe/v1/shopping-lists/9/items/55', {
  method: 'PUT',
  headers: {
    'Authorization': auth,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"is_checked": 1}),
});
const { data } = await response.json();

Quick Links

Share