addMediaObjectsToList

mutation

Requires commerce.product:write.

Add media objects to an existing List.

Required headers

Header	Required	Description
`x-store-id`	Yes	ID of the store the operation targets. Omitting it returns HTTP 200 with a GraphQL error: `extensions.code: "UNAUTHENTICATED"`.

Go to Authentication for credential setup.

Arguments

id String! required
input MutationAddMediaObjectsToListInput! required
- mediaObjects [CreateMediaObjectInput!]! required
  - type String! required — The type of the media, one of PHOTO, VIDEO, IMAGE, AUDIO.
  - url String! required
  - label String optional
  - metafields [CreateMetafieldInput!] optional
    - key String! required
    - namespace String! required
    - type String! required — Metafield value type. Live catalog validation accepts lowercase values such as boolean, string, stringMultiLine, number, numberDecimal, date, dateTime, json, measurement, url, reference, money, list.string, list.number, list.numberDecimal. Uppercase STRING is rejected.
    - value String! required
  - name String optional
  - position Int optional

Possible returns

List List — A list is a group of SKU groups that are generally organized by similar characteristics.

mutation RunAddMediaObjectsToList($id: String!, $input: MutationAddMediaObjectsToListInput!) {  addMediaObjectsToList(id: $id, input: $input) {    id    name    status    label    createdAt    updatedAt  }}

{  "data": {    "addMediaObjectsToList": {      "id": "ID_VALUE",      "name": "Example",      "status": "ACTIVE",      "label": "Example",      "createdAt": "2026-01-15T12:00:00.000Z",      "updatedAt": "2026-01-15T12:00:00.000Z"    }  }}

Last updated on