Skip to content

Add products to a manual collection

POST
/stores/{storeRef}/collections/{id}/products
curl --request POST \
--url https://apibase.ecomweb.app/api/v1/stores/example/collections/1/products \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{ "product_ids": [ 1 ] }'

Appends the products to the end of a manual collection. Products already in the collection are skipped. The route is refused with a 400 error for a smart collection. Search results update shortly afterwards.

Required scopes: write:categories

id
required
integer

The collection ID.

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
product_ids
required

Product IDs to add to or remove from the collection

Array<number>

Example generated

{
"product_ids": [
1
]
}
Media typeapplication/json
object
added
required

Number of products newly added; products already in the collection are not counted.

number

Example generated

{
"added": 1
}

The request is malformed or failed validation.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}