Skip to content

Unpublish a product from a channel

DELETE
/stores/{storeRef}/products/{productId}/publications/{channelId}
curl --request DELETE \
--url https://apibase.ecomweb.app/api/v1/stores/example/products/1/publications/1 \
--header 'x-api-key: <x-api-key>'

Removes the product from the channel. Unpublishing from the online store is refused with a 400 error while the product has an active promotion. Returns the product’s publications after the change.

Required scopes: write:products

productId
required
integer

The product ID.

channelId
required
integer

The sales channel installation ID, as returned in store_sales_channel_id by the product’s publications.

storeRef
required
string

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

Media typeapplication/json
Array<object>
object
store_sales_channel_id
required

ID of the channel installation in this store. Use it as channelId to change the publication.

string
channel_code
required

Code of the channel, such as online_store.

string
channel_name
required

Display name of the channel.

string
published_at
required

When the product goes or went live on the channel, as an ISO 8601 timestamp.

string
is_listed
required

Whether the product appears in listings and search on the channel.

boolean
is_live
required

Whether published_at has already passed.

boolean

Example generated

[
{
"store_sales_channel_id": "example",
"channel_code": "example",
"channel_name": "example",
"published_at": "example",
"is_listed": true,
"is_live": true
}
]

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