Product Media

Upsert a product image or video

Upsert a product image or video

put/unstable/product-media

Request

  • Base URL
    https://api.authentified.co
  • Auth
    API key in header X-Authentified-API-Key

Request body

idstring required

The Unique Identifier of the image or video in your system

productIdstring required

The Unique Identifier of the product this media belongs to

srcstring uri required

The URL of the image or video

type'IMAGE' | 'VIDEO' required

The type of media

altstring

Alternative text for the image or video, used for accessibility and SEO

widthnumber

Width of the image or video in pixels

heightnumber

Height of the image or video in pixels

createdAtstring date-time

The date and time when the product image/video was created in your system

updatedAtstring date-time

The date and time when the product image/video was updated in your system

Example request

{
  "id": "765325",
  "productId": "458291",
  "src": "https://mydomain.com/images/product-765325.jpg",
  "type": "IMAGE",
  "alt": "A beautiful red dress on a model",
  "width": 800,
  "height": 600,
  "createdAt": "2023-10-01T12:12:00Z",
  "updatedAt": "2023-10-01T18:38:00Z"
}

Response

Product media updated successfully

idstring required

The Unique Identifier of the image or video in your system

productIdstring required

The Unique Identifier of the product this media belongs to

srcstring uri required

The URL of the image or video

type'IMAGE' | 'VIDEO' required

The type of media

altstring

Alternative text for the image or video, used for accessibility and SEO

widthnumber

Width of the image or video in pixels

heightnumber

Height of the image or video in pixels

createdAtstring date-time

The date and time when the product image/video was created in your system

updatedAtstring date-time

The date and time when the product image/video was updated in your system

Example response

{
  "id": "765325",
  "productId": "458291",
  "src": "https://mydomain.com/images/product-765325.jpg",
  "type": "IMAGE",
  "alt": "A beautiful red dress on a model",
  "width": 800,
  "height": 600,
  "createdAt": "2023-10-01T12:12:00Z",
  "updatedAt": "2023-10-01T18:38:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.