Link a video to a product
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/products/1/videos/link';const options = { method: 'POST', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"asset_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","sort_order":0,"is_primary":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://apibase.ecomweb.app/api/v1/stores/example/products/1/videos/link \ --header 'Content-Type: application/json' \ --header 'x-api-key: <x-api-key>' \ --data '{ "asset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "sort_order": 0, "is_primary": true }'Attaches a video that is already uploaded to the store’s media library to the product. Linking the same video again updates the existing link.
Required scopes: write:products
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The product ID.
The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
ID of a video already uploaded to the store’s media library.
Position among the product’s videos. Defaults to 0.
Whether this is the product’s primary video. Defaults to true.
Responses
Section titled “Responses”object
The links that were created or updated.
object
Extra link data, or null.
object
Link ID.
ID of the linked asset.
Always product.
ID of the product.
Always video.
Sort order among the product’s videos.
Whether this is the product’s primary video.
ID of the user that created the link, or null.
When the link was created, as an ISO 8601 timestamp.
A readable result message.
Example generated
{ "links": [ { "extra": {}, "id": "example", "asset_id": "example", "entity_type": "example", "entity_id": "example", "field": "example", "sort_order": 1, "is_primary": true, "created_by": "example", "created_at": "example" } ], "message": "example"}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"}