Skip to main content

ordersUpdateTemplate

Updates an existing order template with new enrichment data configurations. This mutation allows you to modify template properties including name, description, enrichment data, and status settings.

Template updates are useful for maintaining current shipping requirements, updating carrier preferences, adjusting packaging specifications, or modifying routing instructions based on changing business needs.

Required Permission​

  • orders:update_special_templates

Template Data Updates​

The template_data field completely replaces the existing template configuration. Ensure you provide all required enrichment fields, as partial updates are not supported.

Template Status​

You can change template status between active and inactive. Inactive templates cannot be assigned to new orders but existing assignments remain unaffected.

Code Generation​

If the code field is left empty, a new unique code will be automatically generated based on the updated template name.

Possible Errors​

  • **B2BTemplateError**: When template validation fails or business rules are violated
  • **AuthorizationError**: When user lacks required permissions
  • **RecordNotFoundError**: When the specified template or brand does not exist
ordersUpdateTemplate(
  input: UpdateOrderTemplateInput!
): OrderTemplate

Arguments​

ordersUpdateTemplate.input ● UpdateOrderTemplateInput! non-null input​

Parameters for UpdateOrderTemplate

Type​

OrderTemplate object​

Template for special orders that defines standard parameters