Skip to main content

orderlistUpdate

Update an existing order list's configuration.

Modifies order list details including name, description, and settings. Only provided fields will be updated, others remain unchanged.

Possible errors:

  • ORDERLIST_NOT_FOUND_ERROR: Order list with the specified ID does not exist
  • ORDERLIST_UPDATE_ERROR: Failed to update the order list
  • ORDERLIST_VALIDATION_ERROR: Updated order list data validation failed
  • ORDERLIST_NAME_EXISTS_ERROR: Updated name conflicts with existing order list
  • FORBIDDEN: Insufficient permissions to update order lists

AUTH: Role=[shop.OWNER,shop.EDITOR]

orderlistUpdate(
  id: Int!
  input: OrderlistUpdateInput!
): Orderlist!

Arguments​

orderlistUpdate.id ● Int! non-null scalar​

Unique identifier of the order list to update.

Must be a positive integer representing a valid order list ID in the system.

orderlistUpdate.input ● OrderlistUpdateInput! non-null input​

Updated order list information.

Contains the order list properties to update. Only provided fields will be changed, others remain unchanged.

Type​

Orderlist object​

Orderlist entity for GraphQL federation.

Represents a curated list of products and clusters that customers are authorized to view and purchase. Used for implementing customer-specific product catalogs, restricted access controls, and personalized product visibility.