Skip to content

Copy a product's services to other products

POST
/stores/{storeRef}/products/{productId}/services/bulk-copy
curl --request POST \
--url https://apibase.ecomweb.app/api/v1/stores/example/products/1/services/bulk-copy \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{ "scope": "all" }'

Replaces the services of every other active product in the scope with this product’s services. scope=all targets every other active product; scope=category targets those in the same category and is refused with a 400 error if this product has no category. Products that fail are counted in failed and do not stop the rest.

Required scopes: write:products

productId
required
integer

The product ID.

storeRef
required
string

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

Media typeapplication/json
object
scope
required

Scope of bulk copy operation

string
Allowed values: all category

Example

all
Media typeapplication/json
object
processed
required

Total number of products processed

number
succeeded
required

Number of products successfully updated

number
failed
required

Number of products that failed to update

number

Example

{
"processed": 42,
"succeeded": 40,
"failed": 2
}

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"
}