Skip to main content

ordersTemplates

Retrieves a paginated list of order templates. Order templates contain predefined enrichment data configurations that can be applied to orders for consistent processing workflows.

Required Permission​

  • orders:read_b2b_templates

Access Control​

  • **Regular users**: Can only access templates from a company they have permissions for
  • **Company requirement**: Non-admin users must have associated a company

Default Behavior​

  • Returns only active templates by default
  • Results are paginated using GraphQL connection pattern
  • Sorted by creation date (newest first)

Possible Errors​

  • **CompanyContextRequired**: Raised when no company context is specified (e.g. through the X-Company-Id header).
  • **AuthorizationError**: When user lacks required permissions or company access
ordersTemplates(
  activeOnly: Boolean = true
  after: String
  before: String
  brandId: ID
  filters: B2BOrderTemplateFilterInput
  first: Int
  last: Int
): OrderTemplateConnection!

Arguments​

ordersTemplates.activeOnly ● Boolean scalar common​

Filter by active templates only.

ordersTemplates.after ● String scalar common​

Returns the elements in the list that come after the specified cursor.

ordersTemplates.before ● String scalar common​

Returns the elements in the list that come before the specified cursor.

ordersTemplates.brandId ● ID deprecated scalar common​

DEPRECATED

This argument will be removed in the future. Brand is becoming a product-only attribute. Use company context instead.

Brand ID to filter templates by.

ordersTemplates.filters ● B2BOrderTemplateFilterInput input orders​

Filtering options for templates.

ordersTemplates.first ● Int scalar common​

Returns the first _n_ elements from the list.

ordersTemplates.last ● Int scalar common​

Returns the last _n_ elements from the list.

Type​

OrderTemplateConnection object common​

The connection type for OrderTemplate.