createList
View as MarkdownCreate a new list.
mutation
Requires commerce.product:write.
Create a new 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
inputMutationCreateListInput!requiredlabelString!requireddescriptionStringoptionalhtmlDescriptionStringoptionalHTMLDescriptionStringoptional — Deprecated: Use htmlDescription instead.mediaObjects[CreateMediaObjectInput!]optionaltypeString!required — The type of the media, one ofPHOTO,VIDEO,IMAGE,AUDIO.urlString!requiredlabelStringoptionalmetafields[CreateMetafieldInput!]optionalkeyString!requirednamespaceString!requiredtypeString!required — Metafield value type. Live catalog validation accepts lowercase values such asboolean,string,stringMultiLine,number,numberDecimal,date,dateTime,json,measurement,url,reference,money,list.string,list.number,list.numberDecimal. UppercaseSTRINGis rejected.valueString!required
nameStringoptionalpositionIntoptional
metafields[CreateMetafieldInput!]optionalkeyString!requirednamespaceString!requiredtypeString!required — Metafield value type. Live catalog validation accepts lowercase values such asboolean,string,stringMultiLine,number,numberDecimal,date,dateTime,json,measurement,url,reference,money,list.string,list.number,list.numberDecimal. UppercaseSTRINGis rejected.valueString!required
nameStringoptionalreferences[CreateReferenceInput!]optionaloriginString!requiredvalueString!required
statusStringoptional — The status of the list, one ofACTIVE,DRAFT,ARCHIVED.
Possible returns
ListList— A list is a group of SKU groups that are generally organized by similar characteristics.
Last updated on
How is this guide?