Skip to main content

archiveProductLabelRecipe

Archive a label recipe so it no longer appears in the picker.

Business Rules​

  • Archived recipes stay readable through productLabelRecipes with archiveStatus ARCHIVED or ALL.
  • Archiving an already archived recipe changes nothing and succeeds.

Error Scenarios​

  • **NOT_FOUND**: when the recipe does not exist or belongs to another company

Permissions Required​

  • products:archive_label_recipe permission.
archiveProductLabelRecipe(
  input: ArchiveProductLabelRecipeInput!
): ArchiveProductLabelRecipePayload

Arguments​

archiveProductLabelRecipe.input ● ArchiveProductLabelRecipeInput! non-null input common​

Parameters for ArchiveProductLabelRecipe

Type​

ArchiveProductLabelRecipePayload object common​

Autogenerated return type of ArchiveProductLabelRecipe.