Propeller Commerce Docs

📄️ AddressType

Address types [one of 'delivery','invoice' or 'home']

📄️ AdminUserSortField

Available fields for sorting administrative user search results. Enables ordering by temporal attributes for chronological analysis and audit purposes.

📄️ AttributeDescriptionClass

Entity types that the attribute or the attribute description belongs to

📄️ AttributeDescriptionFieldName

No description

📄️ AttributeDescriptionSortField

Available fields for sorting attribute description search results with flexible ordering options

📄️ AttributeFieldName

Available field names for CSV import mapping and attribute data processing with comprehensive field definitions

📄️ Auto

Automatic image format optimization based on browser capabilities

📄️ BulkCostPriceFieldName

Field names for bulk cost price data import and validation operations.

📄️ BulkPriceSortField

Available fields for sorting bulk price search results

📄️ BundleCondition

Determines how bundle discounts are applied to items within the bundle.

📄️ BundleSortField

Available fields for sorting bundle results.

📄️ BusinessRuleArrayExpressionOperators

Logical operators for array-based business rule expressions and collection validation

📄️ BusinessRuleComplexExpressionAction

Aggregation functions available for complex expressions operating on filtered data collections

📄️ BusinessRuleDateExpressionOperators

Temporal comparison operators for date and time-based business rule expressions

📄️ BusinessRuleDecisionTableColumnType

Defines whether a decision table column processes input conditions or generates output results

📄️ BusinessRuleDecisionTableRowReorderDirection

Specifies the direction for reordering decision table rows relative to a target position

📄️ BusinessRuleExpressionGroupOperators

Logical operators for combining multiple expressions within a business rule group

📄️ BusinessRuleExpressionTypes

Data types supported for business rule expressions and field definitions

📄️ BusinessRuleHitPolicyOption

Execution strategy for decision table rules when multiple conditions may match

📄️ BusinessRuleNodeType

Defines the functional role of nodes within a business rule workflow graph

📄️ BusinessRuleNumberExpressionOperators

Mathematical comparison operators for numeric business rule expressions

📄️ BusinessRuleStringExpressionOperators

Comparison and matching operators for string-based business rule expressions

📄️ BusinessRuleType

Classification of business rule contexts that determine the domain and application scope for automated decision-making

📄️ CacheControlType

Cache Control Type [no-store, public or none]

📄️ CarrierSortField

Available fields for sorting carrier search results

📄️ CarrierType

Classification of shipping service delivery methods

📄️ CartAddressType

Address types used in shopping cart operations

📄️ CartSortField

Available fields for sorting cart search results

📄️ CategorySortableFields

Fields available for sorting category results.

📄️ ClusterConfigSettingDisplayType

User interface display types for cluster configuration options.

📄️ ClusterConfigSettingType

Configuration types that define how cluster settings behave and interact with product data.

📄️ ClusterDrillDownDisplayType

User interface display methods for cluster drill-down navigation.

📄️ ClusterFieldName

Fields available for cluster CSV mapping and data import.

📄️ CompanySearchIndexTemplate

Available search index templates for data reindexing and mapping operations

📄️ CompanySearchSortField

Available fields for sorting company search results

📄️ CompanySortableField

Available fields for sorting company search results in queries and listings

📄️ CompanyTermFieldName

Available field names for term-based filtering in company search queries, enabling precise field-specific search operations

📄️ ContactSortableField

Available fields for sorting contact search results

📄️ CostPriceSortField

Available fields for sorting cost price search results

📄️ CrossupsellSortField

Available fields for sorting cross-sell and upsell recommendation results in search and retrieval operations

📄️ CrossupsellType

Classification of cross-sell and upsell recommendation types that determine the relationship and presentation context between products

📄️ CustomerSortableField

Available fields for sorting customer search results in queries and listings

📄️ DiscountSortField

Available fields for sorting discount search results

📄️ DocumentFieldName

Fields available for document CSV mapping.

📄️ EmailEventType

Type of e-mail events that can be triggered

📄️ EventActionConfigSortField

Fields by which EventActionConfig can be sorted in search queries.

📄️ EventTrigger

Events published by the Propeller system where the Event Action Manager can subscribe to and execute an Action.

📄️ FeaturesEnableDisable

Control flags for enabling or disabling specific image transformation features

📄️ Fit

Controls how images are resized and positioned within specified dimensions while maintaining aspect ratio. Only effective when both width and height are specified.

📄️ Format

Output format for the transformed image, determining compression method, quality, and browser compatibility

📄️ ImageMetadata

The metadata parameters controls whether to include metadata in the output image

📄️ IncentiveActions

Available actions that can be executed by incentive business rules to provide customer benefits and promotional offers

📄️ IncentiveDiscountType

Calculation methods for applying discount values in incentive business rules

📄️ InventoryType

Classification of inventory storage and management types

When converting animated GIFs to the MP4 format and when used in conjunction with the profile parameter, the level parameter specifies a set of constraints indicating a degree of required decoder performance for a profile.

📄️ NumberExpressionOperator

Expressions for number fields

📄️ Optimize

The optimize parameter automatically applies optimal quality compression to produce an output image with as much visual fidelity as possible, while minimizing the file size.

📄️ OrderDiscountType

Order discount types

📄️ OrderExportStatus

Available order export statuses

📄️ OrderItemClass

Class of the order item

📄️ OrderItemIncentiveCode

Order item incentive calculation types

📄️ OrderRevisionSortField

Available fields for sorting order revision results in search operations

📄️ OrderSearchFields

Available fields to search for in an order

📄️ OrderSortField

Available fields for sorting order search results

📄️ OrderStatusOrderType

Classification of order types that determine which workflow statuses are applicable for different business processes

📄️ OrderStatusSetSortField

Available fields for sorting order status set search results

📄️ OrderStatusSortField

Available fields for sorting order status search results

📄️ OrderStatusType

Classification of order status origin and management level within the workflow system

📄️ OrderType

Available order types

📄️ OrderlistSortField

Available fields for sorting order list results in search and retrieval operations

📄️ OrderlistType

Order list types that control product visibility and ordering permissions for assigned users/companies

📄️ Orient

The orient parameter controls the cardinal orientation of the image.

📄️ PayMethodSortField

Available fields for sorting payment method results

📄️ PaymentStatuses

Payment processing status indicating the current stage of payment lifecycle and available business actions

📄️ PriceDiscountType

The type of discount calculation used to calculate the price for a product

📄️ PriceDisplay

Frontend price display configuration options for user interface presentation.

📄️ PriceElementType

Classification of price elements used in pricing calculations and display logic.

📄️ PriceFieldName

Price field name

📄️ PriceMode

Indicates where the price is calculated.

📄️ PriceSortField

Available fields for sorting price search results

📄️ PricesheetFieldName

Field names for pricesheet data import and validation operations.

📄️ PricesheetSortField

Available fields for sorting pricesheet search results

📄️ ProductClass

Available product classes

📄️ ProductContainerClass

Classification of container types that can hold and organize products.

📄️ ProductFieldName

Fields available for product CSV mapping.

📄️ ProductSearchableField

Product fields available for a search with configurable boost weights.

📄️ ProductSortField

Available fields for sorting product search results

📄️ ProductStatus

Available product statuses

📄️ PurchaseRole

Purchase role types [one of 'PURCHASER' or 'AUTHORIZATION_MANAGER']

📄️ ResizeFilter

The resize-filter parameter enables control over the resizing filter used to generate a new image with a higher or lower number of pixels.

📄️ RoleAccess

Access permission levels that define the scope of actions a user can perform within a role's domain.

📄️ RoleDefinitionSortableFields

Available fields for sorting role definition search results.

📄️ RoleSortableFields

Available fields for sorting role search results.

📄️ ShipmentItemSortField

Available fields for sorting shipment item results in search operations

📄️ ShipmentSortField

Available fields for sorting shipment results in search operations

📄️ ShipmentStatus

Current status of a shipment in the delivery process

📄️ SortOrder

Order options for sorting

📄️ Sort

Sort order for search results

📄️ SurchargeType

Classification of surcharge calculation methods that determine how additional fees are calculated when associated products are added to order items

📄️ TaxCode

Tax classification codes that determine the applicable tax rates and regulations for surcharges and additional fees

📄️ TaxSortField

Available fields for sorting tax search results

📄️ Taxcode

All supported tax codes

📄️ TemplateErrorLogSortField

Available fields for sorting template error log search results.

📄️ TemplateErrorType

Classification of template processing errors for systematic debugging.

📄️ TemplateSortField

Available fields for sorting template search results.

📄️ TemplateType

Classification of template functionality and output format.

📄️ TenderAddressType

Classification of address types used in tender processing to determine billing and delivery destinations

📄️ TrackAndTraceSortField

Available fields for sorting tracking and trace results in search operations

📄️ TransactionStatuses

Transaction processing status indicating the outcome of payment operations and workflow progression

📄️ TransactionTypes

Transaction operation types representing different payment processing operations with specific business logic

📄️ UploadType

Upload type

📄️ UsergroupSortableField

Available fields for sorting usergroup search results in queries and listings

📄️ ValuesetItemSortField

Available fields for sorting value set item search results to organize dropdown options and configuration data

📄️ ValuesetSortField

Available fields for sorting value set search results to organize data according to specific criteria

📄️ ValuesetSortOrder

Sort order direction for organizing search results in ascending or descending sequence

📄️ ValuesetType

Classification of value sets based on their management and usage scope within the system

📄️ VideoFieldName

Fields available for video CSV mapping.

📄️ WarehouseSortField