Set up order attribute override (Shopify only)
The order attribute override lets you keep an order attributed to the ambassador who drove it, while skipping the commission (or points) for that one order. You tell Roster which attribute to watch for, and any Shopify order that carries a matching attribute is still credited to the ambassador but creates no reward.
This is useful when you want the ambassador to get credit for the sale, but you do not want to pay a commission on it. Common examples are internal or employee orders, wholesale orders, gifted orders, or orders from a specific sales channel.
Shopify only. This override is available for Shopify-connected brands, and the setting only appears when your store is connected to Shopify.
How it works
You set up the override in Roster with an attribute name and an attribute value.
- On your Shopify store, you add that same attribute to the cart before the customer checks out.
- When the order reaches Roster, it checks the order's attributes. If it finds one whose name and value both match what you set up, the order is attributed to the ambassador but no commission is created.
The name and value are matched ignoring upper or lower case and ignoring any spaces before or after. So "Source" and " source " are treated as the same. Both the name and the value have to match for the override to apply.
Important: the attribute must be on the cart before the order is placed
In Shopify, this kind of data is called a cart attribute. A cart attribute has to be added to the cart before the customer completes checkout. Once the order has been created, it is too late to add it, and the override will not apply to that order.
Set it on the cart, not the order. The attribute needs to be set while the shopper is still on your store (on the product page, the cart page, or during checkout). An attribute added after the order exists will not count.
Step-by-step instructions
Step 1: Set up the override in Roster
- Go to your Roster referral tab in your program settings and open referral commissions to find the order attribute override.
- Enter the attribute name you want Roster to watch for, for example commission.
- Enter the attribute value that should trigger the skip, for example skip.
- Save.
Write down the exact name and value you used. You will need to match them precisely in Shopify in the next step.
Step 2: Add the cart attribute in Shopify
You have a few options here depending on how your store is set up. All of them do the same thing: they attach your chosen name and value to the cart so it carries through to the order.
Option A: Add it through your theme (cart page field)
Your developer can add a field to the cart that sets the attribute. The field uses the name format attributes[your-attribute-name] and is tied to the cart form. For example, to always set a commission attribute with a value of skip, they can add a hidden field to the cart page:
Keep in mind a field like this applies to every order. If you only want to skip commission on certain orders, use a method that sets the attribute conditionally, such as Option B.
Option B: Set it with the cart API (for conditional logic)
If you only want the attribute added to some orders (for example only when the shopper came from a certain page or picked a certain option), your developer can set it with the Shopify cart API before checkout:
This lets you decide, in your own logic, exactly which carts get the attribute.
Option C: Use an app
If you use a Shopify app that can add cart or order attributes (for example a product personalization, wholesale, or checkout customization app), you can have it write the attribute name and value you set up in Roster. Look in the app's settings for "cart attributes," "order attributes," or "custom fields."
Want to hide the attribute from shoppers? Shopify lets you hide an attribute at checkout by starting its name with an underscore, for example _commission. If you do this, enter the name with the underscore in Roster too, so the still match exactly.
Step 3: Checking that it worked
After a test order that should be excluded:
- Open the order in Shopify and confirm the attribute appears on it. Shopify shows cart attributes in the order's additional details.
- In Roster, confirm the order is attributed to the ambassador and that no commission was created for it.
If the order got a commission anyway, the most common cause is that the attribute was added after the order was created, or that the name or value does not match what you set up in Roster.
FAQ
Does the ambassador still get credit for the sale? Yes. The order is still attributed to the ambassador. Only the commission or points reward is skipped.
What if the attribute does not match exactly? The override only applies when both the name and the value match. Case and surrounding spaces are ignored, but otherwise they need to match what you entered in Roster.
Can I use this on a non-Shopify store? No. The order attribute override is available for Shopify-connected brands only.
Next steps
Need help?
If you have any questions or need assistance with commission overrides, contact our customer success team at [email protected]. We're here to help!