> ## Documentation Index > Fetch the complete documentation index at: https://docs.alura.io/llms.txt > Use this file to discover all available pages before exploring further. # Add saved items > Saves up to 100 products, shops and keywords in a list, all or nothing. An item already in the list is left as it is. Only items Alura already has: anything else is 422 `unprocessable`, naming it, and nothing is added (nothing is ever fetched from Etsy). The workspace's plan caps its saved items (Free: none, 403 `plan_required`). Free. Retry safely with `Idempotency-Key`. Cost: free. ## OpenAPI ````yaml /openapi.json post /v1/research/saved/lists/{id}/items openapi: 3.1.0 info: title: Alura API version: 1.0.0 description: Etsy market research for scripts and AI assistants. servers: - url: https://api.alura.io security: - apiKey: [] paths: /v1/research/saved/lists/{id}/items: post: summary: Add saved items description: >- Saves up to 100 products, shops and keywords in a list, all or nothing. An item already in the list is left as it is. Only items Alura already has: anything else is 422 `unprocessable`, naming it, and nothing is added (nothing is ever fetched from Etsy). The workspace's plan caps its saved items (Free: none, 403 `plan_required`). Free. Retry safely with `Idempotency-Key`. Cost: free. operationId: research.saved.items.add parameters: - name: id in: path required: true schema: type: string minLength: 1 maxLength: 64 description: The list ID (`lst_...`). example: lst_0000000000000000000000001B - name: Idempotency-Key in: header required: false description: >- Makes a retry safe: the same key with the same request within 24 hours returns the first result (with `Idempotent-Replayed: true`) instead of writing again. The same key with a different request is a 409 `conflict`; while the first request still runs, 409 `idempotency_processing`. schema: type: string minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object properties: items: minItems: 1 maxItems: 100 type: array items: type: object properties: type: type: string enum: - product - shop - keyword description: '`product`, `shop` or `keyword`.' ref_id: type: string pattern: ^[1-9][0-9]{0,19}$ description: >- The Etsy listing ID (product), the Etsy shop ID (shop) or Alura's keyword ID (keyword, the `id` a keyword lookup returns), as a string. required: - type - ref_id additionalProperties: false description: >- The products, shops and keywords to save, 1-100; types can be mixed. required: - items additionalProperties: false example: items: - type: product ref_id: '4524717183' - type: keyword ref_id: '88123' responses: '200': description: OK headers: Request-Id: $ref: '#/components/headers/Request-Id' Alura-Credits-Cost: $ref: '#/components/headers/Alura-Credits-Cost' Alura-Credits-Remaining: $ref: '#/components/headers/Alura-Credits-Remaining' content: application/json: schema: type: object properties: object: type: string const: research.saved_items_added list_id: type: string description: The list (`lst_...`). added: type: integer minimum: 0 description: Items newly saved. unchanged: type: integer minimum: 0 description: >- Items that were in the list already; adding them again changed nothing. items: type: array items: type: object properties: id: type: string description: The saved item ID (`itm_...`). type: type: string enum: - product - shop - keyword ref_id: type: string required: - id - type - ref_id additionalProperties: false description: Every item sent, once, with its saved item ID. required: - object - list_id - added - unchanged - items additionalProperties: false example: object: research.saved_items_added list_id: lst_0000000000000000000000001B added: 2 unchanged: 0 items: - id: itm_00000000000000000004000034 type: product ref_id: '4524717183' - id: itm_0000000000000000000C000035 type: keyword ref_id: '88123' '400': $ref: '#/components/responses/Problem400' '401': $ref: '#/components/responses/Problem401' '402': $ref: '#/components/responses/Problem402' '403': $ref: '#/components/responses/Problem403' '404': $ref: '#/components/responses/Problem404' '405': $ref: '#/components/responses/Problem405' '409': $ref: '#/components/responses/Problem409' '429': $ref: '#/components/responses/Problem429' '500': $ref: '#/components/responses/Problem500' '503': $ref: '#/components/responses/Problem503' x-codeSamples: - lang: bash label: cURL source: >- curl -X POST "https://api.alura.io/v1/research/saved/lists/lst_0000000000000000000000001B/items" \ -H "Authorization: Bearer $ALURA_API_KEY" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: 5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c" \ -d '{"items":[{"type":"product","ref_id":"4524717183"},{"type":"keyword","ref_id":"88123"}]}' - lang: typescript label: TypeScript source: >- const res = await fetch('https://api.alura.io/v1/research/saved/lists/lst_0000000000000000000000001B/items', { method: 'POST', headers: { Authorization: `Bearer ${process.env.ALURA_API_KEY}`, 'Content-Type': 'application/json', 'Idempotency-Key': '5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c', }, body: JSON.stringify({ "items": [ { "type": "product", "ref_id": "4524717183" }, { "type": "keyword", "ref_id": "88123" } ] }), }); console.log(await res.json()); - lang: python label: Python source: |- import json import os import urllib.request request = urllib.request.Request( "https://api.alura.io/v1/research/saved/lists/lst_0000000000000000000000001B/items", method="POST", data=json.dumps({ "items": [ { "type": "product", "ref_id": "4524717183" }, { "type": "keyword", "ref_id": "88123" } ] }).encode(), headers={ "Authorization": f"Bearer {os.environ['ALURA_API_KEY']}", "Content-Type": "application/json", "Idempotency-Key": "5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c", }, ) with urllib.request.urlopen(request) as response: print(json.load(response)) components: headers: Request-Id: description: '`req_` + ULID; quote it when reporting a problem.' schema: type: string Alura-Credits-Cost: description: API credits this call cost. schema: type: integer Alura-Credits-Remaining: description: >- API credits left in the workspace's monthly allowance, counting calls still in flight. Absent when it cannot be read right now. schema: type: integer responses: Problem400: description: Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: type: https://docs.alura.io/errors/invalid_request title: Invalid request status: 400 code: invalid_request detail: Invalid request suggestion: Fix the request as the detail says, then send it again. retryable: false request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B Problem401: description: Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: type: https://docs.alura.io/errors/unauthorized title: Unauthorized status: 401 code: unauthorized detail: Unauthorized suggestion: 'Send a valid API key as `Authorization: Bearer alura_sk_...`.' retryable: false request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B Problem402: description: Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: type: https://docs.alura.io/errors/credits_exhausted title: API credits exhausted status: 402 code: credits_exhausted detail: API credits exhausted suggestion: Upgrade the plan or wait for the monthly reset. retryable: false request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B Problem403: description: Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: type: https://docs.alura.io/errors/plan_required title: Plan required status: 403 code: plan_required detail: Plan required suggestion: Upgrade the workspace plan to use this operation. retryable: false request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B Problem404: description: Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: type: https://docs.alura.io/errors/not_found title: Not found status: 404 code: not_found detail: Not found suggestion: Check the ID, or search for it first. retryable: false request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B Problem405: description: Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: type: https://docs.alura.io/errors/method_not_allowed title: Method not allowed status: 405 code: method_not_allowed detail: Method not allowed suggestion: Use one of the methods in the Allow header. retryable: false request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B Problem409: description: Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: type: https://docs.alura.io/errors/conflict title: Conflict status: 409 code: conflict detail: Conflict suggestion: Reload the resource and retry with its current state. retryable: false request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B Problem429: description: Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: type: https://docs.alura.io/errors/rate_limited title: Rate limited status: 429 code: rate_limited detail: Rate limited suggestion: Wait for Retry-After, then retry. retryable: true request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B Problem500: description: Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: type: https://docs.alura.io/errors/internal_error title: Internal error status: 500 code: internal_error detail: Internal error suggestion: Retry; if it keeps failing, report the request_id. retryable: true request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B Problem503: description: Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: type: https://docs.alura.io/errors/credits_unavailable title: API credits unavailable status: 503 code: credits_unavailable detail: API credits unavailable suggestion: Retry shortly. retryable: true request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B schemas: Problem: type: object description: RFC 9457 problem details. properties: type: type: string format: uri title: type: string status: type: integer code: type: string description: A code from the error catalog; new codes may be added. x-extensible-enum: - invalid_request - unknown_parameter - invalid_cursor - cursor_window_exceeded - id_type_mismatch - invalid_keyword - unauthorized - credits_exhausted - plan_required - insufficient_scope - workspace_required - workspace_locked - browser_refused - role_required - impersonation_refused - recent_sign_in_required - not_found - not_found_on_etsy - shop_opted_out - method_not_allowed - conflict - key_limit_reached - idempotency_processing - unprocessable - rate_limited - throttled - daily_credit_cap_exceeded - credits_reserved - fetch_limit_reached - internal_error - upstream_unavailable - credits_unavailable - service_unavailable - fetch_unavailable - upstream_timeout detail: type: string suggestion: type: string retryable: type: boolean request_id: type: string upgrade_url: type: string format: uri description: 'credits_exhausted and plan_required: where to upgrade the plan.' credits_needed: type: integer description: 'API credit refusals: what the call needed.' credits_remaining: type: integer description: >- API credit refusals: what is left (of the month, or of the day for daily_credit_cap_exceeded). resets_at: type: string format: date-time description: >- credits_exhausted and daily_credit_cap_exceeded: when the limit resets. required: - type - title - status - code - detail - suggestion - retryable - request_id securitySchemes: apiKey: type: http scheme: bearer description: 'An API key: `Authorization: Bearer alura_sk_...`.' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.