Skip to main content

createProductLabelRecipe

Save the current label settings as a named recipe the whole company can print from.

Business Rules​

  • The name is trimmed, must not be blank, and must be at most 80 characters.
  • The name must be unique among the company's active recipes, ignoring case.
  • Settings may only carry the label keys the client knows about and must serialize to at most 16 KiB. How many copies each row prints is not part of a recipe.

Error Scenarios​

  • **BAD_REQUEST**: when settings is not a JSON object
  • **VALIDATION**: when the name is blank, too long, or already used, or when the settings carry unknown keys or exceed the size cap

Permissions Required​

  • products:create_label_recipe permission.
createProductLabelRecipe(
  input: CreateProductLabelRecipeInput!
): CreateProductLabelRecipePayload

Arguments​

createProductLabelRecipe.input ● CreateProductLabelRecipeInput! non-null input common​

Parameters for CreateProductLabelRecipe

Type​

CreateProductLabelRecipePayload object common​

Autogenerated return type of CreateProductLabelRecipe.