Support

Create a new list.

mutation

Requires commerce.product:write.

Create a new list.

Required headers

HeaderRequiredDescription
x-store-idYesID 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

  • input MutationCreateListInput! required
    • label String! required
    • description String optional
    • htmlDescription String optional
    • HTMLDescription String optional — Deprecated: Use htmlDescription instead.
    • mediaObjects [CreateMediaObjectInput!] optional
      • 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
    • 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
    • references [CreateReferenceInput!] optional
      • origin String! required
      • value String! required
    • status String optional — The status of the list, one of ACTIVE, DRAFT, ARCHIVED.

Possible returns

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

Last updated on

How is this guide?