Skip to content

Assign services to a product

PUT
/stores/{storeRef}/products/{productId}/services
curl --request PUT \
--url https://apibase.ecomweb.app/api/v1/stores/example/products/1/services \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{ "service_ids": [ 1, 2, 3 ] }'

Replaces the product’s assigned services with the IDs you send; send an empty list to clear them. An ID that is not a service of this store is refused with a 400 error.

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
service_ids
required

Array of service IDs to assign to the product

Array<number>

Example

[
1,
2,
3
]
Media typeapplication/json
object
message
required

A readable confirmation of what was done.

string

Example generated

{
"message": "example"
}

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