Skip to main content

Terminology

Here' you'll find an index of important terminology we use throughout the documentation.

Transaction

A transaction represents a single workflow experience for a customer. It's used as a handle by Spiff Commerce to the design of the customer. You can use a transaction ID to place an order, pull metadata about the design or to re-open the design experience for the customer to make changes.

Order

An order consists of a set of line items which each have a transaction ID, along with a quantity of each to order. If an order exists it means the customer has indicated they are happy with all of their designs and have paid for them. When using an official plguni you'll have the order created for you automatically when the cart is checkout in your e-commerce store. Otherwise you need to place the order youself when it makes sense. Learn more about orders here.

Metadata

Metadata is a set of key value pairs that can be attached to a transaction. It's used to store information about the design, such as the selections made by the customer.

Theme

A theme relates to the look and feel of the design experience. We're provide a number of themes out of the box, but you can also create your own. Learn more about themes here.