Shopping List

Remove a shopping-list item

delete/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

itemIdstring required

Shopping-list item id from GET /api/v1/shopping-list or /sync.

Query parameters

clientMutationIdstring

Optional chef-wide idempotency key for DELETE retries when a client cannot send a JSON body.

Headers

X-Client-Mutation-Idstring

Optional chef-wide idempotency key for this delete. Prefer the JSON body clientMutationId when possible, and use the same value when retrying the exact same request after a timeout.

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

Response

Success

okunknown required
requestIdstring required

Changes

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