Skip to main content

ordersAssignTemplate

DEPRECATED

Legacy Orders V1 mutation. It applies to V1 orders only and will be removed once Orders V1 support ends.

Assigns a template to an existing order. This mutation applies predefined B2B data from a template to streamline order processing with consistent B2B information.

Templates contain preset values for shipping details, packaging requirements, billing information, and routing instructions that are commonly used for specific customers or order types.

Required Permission​

  • orders:assign_template

Order Status Requirements​

Templates can only be assigned to orders with the following statuses:

  • ordered
  • pending
  • allocated

Processing​

This mutation executes asynchronously and returns a processing status. The template assignment happens in the background to avoid blocking the API response.

Possible Errors​

  • **B2BTemplateError**: When order or template validation fails, or operation is not allowed
  • **AuthorizationError**: When user lacks required permissions
  • **RecordNotFoundError**: When the specified order or template does not exist
ordersAssignTemplate(
  input: AssignOrderTemplateInput!
): AsynchronousActionResponse! @deprecated

Arguments​

ordersAssignTemplate.input ● AssignOrderTemplateInput! non-null input common​

Parameters for AssignOrderTemplate

Type​

AsynchronousActionResponse object common​

Asynchronous action response type