Publish a product to a channel
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/products/1/publications/1';const options = { method: 'PUT', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"published_at":"example","is_listed":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://apibase.ecomweb.app/api/v1/stores/example/products/1/publications/1 \ --header 'Content-Type: application/json' \ --header 'x-api-key: <x-api-key>' \ --data '{ "published_at": "example", "is_listed": true }'Publishes the product to the channel, or updates an existing publication. published_at defaults to now, and a future value schedules the publication. Search results update shortly afterwards. Returns the product’s publications after the change.
Required scopes: write:products
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The product ID.
The sales channel installation ID, as returned in store_sales_channel_id by the product’s publications.
The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
When the product goes live on this channel. Defaults to now. A future value schedules the publication.
False hides the product from listings and search on this channel while keeping its direct URL reachable.
Example generated
{ "published_at": "example", "is_listed": true}Responses
Section titled “Responses”object
ID of the channel installation in this store. Use it as channelId to change the publication.
Code of the channel, such as online_store.
Display name of the channel.
When the product goes or went live on the channel, as an ISO 8601 timestamp.
Whether the product appears in listings and search on the channel.
Whether published_at has already passed.
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.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
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.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The resource does not exist in this store.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}