Shopping List

Add or restore a shopping-list item

post/api/v1/shopping-list/items

Request

  • Base URL: https://spoonjoy.app
  • URL: https://spoonjoy.app/api/v1/shopping-list/items
  • 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)

Headers

X-Request-Idstring

Optional client-generated request id. Spoonjoy echoes it in X-Request-Id and the REST envelope for logs, retries, and support.

Request body

clientMutationIdstring required
namestring required
quantitynumber
unitstring nullable
categoryKeystring nullable
iconKeystring nullable

Response

Success

okunknown required
requestIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.