Add groceries atomically

POST

/api/v1/shopping/lists/{list_id}/items

curl --request POST \
  --url http://127.0.0.1:8080/api/v1/shopping/lists/example/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "items": [ { "buy": "example", "category": "example", "id": "example", "name": "example", "note": "example" } ] }'

• A local instance on its default listener.

Authorizations

• bearerToken
• browserSession

Parameters

Path Parameters

list_id

required

string

>= 1 characters <= 100 characters /^[a-zA-Z0-9_-]+$/

Header Parameters

X-Savorum-Library

string

X-Savorum-Principal

string

Idempotency-Key

required

string

<= 200 characters

Request Body^required

Media typeapplication/json

object

items

required

Array<object> | null

>= 1 items

object

buy

string

<= 200 characters

category

string

<= 100 characters

id

required

string

>= 1 characters <= 100 characters

name

required

string

>= 1 characters <= 200 characters

note

string

<= 2000 characters

Example^generated

{
  "items": [
    {
      "buy": "example",
      "category": "example",
      "id": "example",
      "name": "example",
      "note": "example"
    }
  ]
}

Responses

200

OK

Media typeapplication/json

object

applied_revision

integer format: int64

id

required

string

items

required

Array<object> | null

object

arranged

boolean

bought

required

boolean

buy

required

string

category

required

string

deleted

required

boolean

fields

required

object

key

additional properties

integer format: int64

id

required

string

merged_into

string

name

required

string

needed

required

string

note

required

string

revision

required

integer format: int64

sources

required

Array<object> | null

object

again

string

amount

string

dish_id

string

id

required

string

ingredient_id

string

label

required

string

meal_date

string format: date

meal_id

string

name

required

string

note

string

quantity

required

string

recipe_id

string

recipe_revision

integer format: int64

unit

string

key

additional properties

any

key

additional properties

any

name

required

string

requirements

required

object

key

additional properties

object

choice_id

required

string

choices

required

Array<object> | null

object

amount

string

id

required

string

name

required

string

note

required

string

quantity

required

string

unit

string

key

additional properties

any

id

required

string

previous_name

string

previous_quantity

string

reviewed_at

string format: date-time

selected

required

boolean

source

required

object

again

string

amount

string

dish_id

string

id

required

string

ingredient_id

string

label

required

string

meal_date

string format: date

meal_id

string

name

required

string

note

string

quantity

required

string

recipe_id

string

recipe_revision

integer format: int64

unit

string

key

additional properties

any

key

additional properties

any

revision

required

integer format: int64

selections

required

object

key

additional properties

object

choice_id

required

string

id

required

string

selected

required

boolean

key

additional properties

any

Example^generated

{
  "applied_revision": 1,
  "id": "example",
  "items": [
    {
      "arranged": true,
      "bought": true,
      "buy": "example",
      "category": "example",
      "deleted": true,
      "fields": {
        "additionalProperty": 1
      },
      "id": "example",
      "merged_into": "example",
      "name": "example",
      "needed": "example",
      "note": "example",
      "revision": 1,
      "sources": [
        {
          "again": "example",
          "amount": "example",
          "dish_id": "example",
          "id": "example",
          "ingredient_id": "example",
          "label": "example",
          "meal_date": "2026-04-15",
          "meal_id": "example",
          "name": "example",
          "note": "example",
          "quantity": "example",
          "recipe_id": "example",
          "recipe_revision": 1,
          "unit": "example"
        }
      ]
    }
  ],
  "name": "example",
  "requirements": {
    "additionalProperty": {
      "choice_id": "example",
      "choices": [
        {
          "amount": "example",
          "id": "example",
          "name": "example",
          "note": "example",
          "quantity": "example",
          "unit": "example"
        }
      ],
      "id": "example",
      "previous_name": "example",
      "previous_quantity": "example",
      "selected": true,
      "source": {
        "again": "example",
        "amount": "example",
        "dish_id": "example",
        "id": "example",
        "ingredient_id": "example",
        "label": "example",
        "meal_date": "2026-04-15",
        "meal_id": "example",
        "name": "example",
        "note": "example",
        "quantity": "example",
        "recipe_id": "example",
        "recipe_revision": 1,
        "unit": "example"
      }
    }
  },
  "revision": 1,
  "selections": {
    "additionalProperty": {
      "choice_id": "example",
      "id": "example",
      "selected": true
    }
  }
}

401

No valid session or API token (authentication-required), or the credential sent is invalid (invalid-credentials).

Media typeapplication/problem+json

object

code

required

string

detail

required

string

status

required

integer format: int64

title

required

string

type

required

string

key

additional properties

any

Example^generated

{
  "code": "example",
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

409

Conflict

Media typeapplication/problem+json

object

code

Stable application error code; clients may also use the problem type suffix.

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

key

additional properties

any

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

params

Structured context for the stable error code.

object

key

additional properties

any

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

violations

Array<object>

object

code

required

string

location

required

string

params

object

key

additional properties

any

key

additional properties

any

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

422

Unprocessable Entity

Media typeapplication/problem+json

object

code

Stable application error code; clients may also use the problem type suffix.

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

key

additional properties

any

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

params

Structured context for the stable error code.

object

key

additional properties

any

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

violations

Array<object>

object

code

required

string

location

required

string

params

object

key

additional properties

any

key

additional properties

any

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

500

Internal Server Error

Media typeapplication/problem+json

object

code

Stable application error code; clients may also use the problem type suffix.

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

key

additional properties

any

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

params

Structured context for the stable error code.

object

key

additional properties

any

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

violations

Array<object>

object

code

required

string

location

required

string

params

object

key

additional properties

any

key

additional properties

any

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}