Reference
Items
Overview
Your agent can change the item content a StoreFront displays: the parts of the item record that page elements render. Item content is not part of any theme, so every change is live on the item's own page and on every page that lists it.
This area covers:
- Attributes, one item at a time or across many items from a spreadsheet-style CSV file, with a backup and a restore.
- Title and long description, and SEO fields.
- Images: attaching, detaching and describing an item's images.
- Pricing: price, sale price, MSRP and retail volume pricing.
- Pre-order: turning pre-order on or off for an item or its variations, and the expected availability date.
- Variations: a parent item's axes (such as Size), their options, and the child item each combination sells, plus creating a child item from a parent.
- Default page and related items: which page is an item's default (canonical) page, and its related items.
- Per-item content blocks: content that appears only on one product's page, stored in that item's own container.
Example requests
- "Update the SEO title and description for the waxed field jacket."
- "Set the '# of Holes' attribute to 2 for every item in this CSV, and show me the dry run first."
- "Put the 3T and 4T sizes on pre-order with an expected date of March 1."
- "Change the parka's sale price to $199 and show me the old and new prices before you ask for approval."
- "Add the jacket's product video to this item's media slot only."
Commands
| Command | What it does |
|---|---|
sf items get | Read an item's attributes, images, title, description, SEO fields and tags |
sf items attributes, sf items remove-attribute | Change or remove one item's attributes |
sf items set-attributes, sf items restore-attributes | Change attributes across many items from a CSV, with a dry run and a backup, or put backed-up values back |
sf items content, sf items seo | Change the title and long description, or the search metadata |
sf items images | Attach, detach or describe item images |
sf items pricing get, sf items pricing set | Read or change price, sale, MSRP and volume pricing |
sf items preorder | Read or change pre-order and the expected date |
sf items variations, sf items create-child | Read or change variations, or create a child item |
sf items pages, sf items set-default-page | List an item's pages, or move its default page |
sf items related | Read or replace related items |
sf containers pull, sf containers push with --owner-type item | Edit an item's own content container |
What it cannot do
- Create standalone items or delete items. Items are created and deleted in the Item Editor. The one exception is a child item made from a parent with
sf items create-child. - Change kits, inventory, shipping, tax or wholesale pricing tiers.
- Set a value by editing a page element. Item values shown by elements such as the item attribute element come from the item record. Writing a value into the element's settings and pushing it changes nothing; the agent skill sends the agent to
sf itemsinstead.
What needs approval
sf items pricing set: every price change, shown old to new.sf items set-attributes --apply: each batch of up to 200 items.sf items preorder setwhen it turns pre-order on or off.sf items variations setwhen a change stops a child item selling.sf items set-default-page --plan: each call of up to 200 items.
Other item writes need --live but no approval. See Changes that need approval.
Related documentation
- Product pages: how item pages are built in the Visual Builder
- Pages and themes: the pages items appear on
Was this page helpful?