Skip to main content
Use POST /v1/products/lists/{list_id}/items to append products to an existing list. Pass an array of product IDs in the request body. The response tells you which IDs were successfully added and which were skipped because they were already in the list.
If you submit product IDs that already exist in the list, the API does not return an error. Instead, those IDs appear in ignored_product_ids in the response. Only new IDs are added and appear in added_product_ids.

Request

Endpoint: POST /v1/products/lists/{list_id}/items

Headers

string
required
Your API key as a Bearer token: Bearer {your_api_key}.
string
required
Must be application/json.

Path parameters

string
required
The unique identifier of the list to add products to.

Body parameters

string[]
required
An array of product ID strings to add to the list.

Example request

cURL

Response

A 200 OK response confirms which product IDs were added and which were ignored.

Response fields

string
The ID of the list that was modified.
string[]
Product IDs that were successfully added to the list.
string[]
Product IDs that were not added because they were already present in the list. No error is thrown for these IDs.
object