Support

Update an existing list.

mutation

Requires commerce.product:write.

Update an existing 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

  • id String! required
  • input MutationUpdateListInput! required
    • description String optional
    • htmlDescription String optional
    • HTMLDescription String optional — Deprecated: Use htmlDescription instead.
    • label String optional
    • metafields [UpsertMetafieldInput!] optional
      • key String! required
      • namespace String! required
      • type String! required
      • value String! required
    • name String optional
    • 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?