Nation

Read one customer by id with contact details, addresses, marketing consent, tags and note.

get_customer

Read one variant's inventory row by variant id: price, SKU and stock overall and per location.

get_inventory

Read one object by id or handle with every field.

get_object

Read one order by id with every field. Amounts are integers in minor units of the order's currency.

get_order

Read one product by id or handle with every field, its options and its variants.

get_product

Read the store this connection belongs to: name, currency (every money amount of this store is in its minor units), language, logo, address and phone (the merchant's business contact, which a domain purchase needs), fulfillment mode, weight unit and the backup shipping rate.

get_store_info

Read one site by id. built is true once a builder agent has written the site at least once (false while it is still the bare template); busy is true while any builder chat of the site is mid-run; agent { status running | idle, chat_id, last_reply, updated_at } is the site's builder agent for this key's user (null before its first message); unpublished_changes { total, paths, versions } is what changed since the live deployment; live { deployment_id, built_at, preview_url } is what serves the site now (null before the first publish); latest_deployment { id, status, live, error } is the newest build: status queued | building | ready | failed, live true when this build serves the site.

get_storefront

List customers filtered by text (email, name, company, phone) or marketing consent. Returns { rows, total, next }; pass next back as after for the following page.

list_customers

List discounts filtered by title or code, status or method (code or automatic). Returns { rows, total, next }; pass next back as after for the following page.

list_discounts

List variants as inventory rows: product title, SKU, price and stock (on hand, committed, available, and per location), filtered by product title, handle or SKU. Returns { rows, total, next }; pass next back as after for the following page.

list_inventory

List objects of a type with optional filters. Returns { rows, total, next }. total: Rows matching the filters from this page on (after the cursor), this page included. next: Pass it as after to read the next page; null on the last page. A list is paged by a cursor on its own order, so editing rows you already read never skips the rest; to follow every change to a type, read the events list instead; after is a key of filters. The Objects section of your instructions documents every type, its filters and fields.

list_objects

List orders filtered by order number or customer email, status, payment status, fulfillment status, customer or location. Returns { rows, total, next }; pass next back as after for the following page.

list_orders

List the store's saved analytics reports with their ids. Returns { rows, total, next }; pass next back as after for the following page.

list_reports

List the store's sites with their live address, whether a publish is running and their latest deployment. Returns { rows, total, next }; pass next back as after for the following page.

list_storefronts

Send a message to a site's builder agent (id = the site id; message = what to build or change). The agent edits the site's files in the background and never publishes. Returns { chat_id, started: true } as soon as the turn starts; answers 409 while the agent is still working on an earlier message.

message_storefront_agent

Put a site live, exactly like the Publish button (id = the site id): it builds the site's current files in the background and returns { deployment_id, status: "queued", live: false }. Answers 409 while the builder agent works or another publish runs. With deployment_id, an earlier ready build of the site, it rolls back to that build instead and returns it live at once. A live site is public on the internet.

publish_storefront

Run a named action on one object, for the changes a field patch cannot express. The Objects section lists each type's actions and their input. Returns the object after the action.

run_object_action

Run one saved report by id and return its numbers: the current period rows and totals, and the previous period when the report compares. Money is in minor units, percents are ratios. time_zone (IANA) sets where days are cut; default UTC.

run_report

Search the store's collections by text or status. Returns { rows, total, next }; pass next back as after for the following page.

search_collections

Search the store's products by text (title, handle or variant SKU), status or collection. Returns { rows, total, next }; pass next back as after for the following page.

search_products

Set a variant's stock at one or more locations to an absolute quantity (id = the variant id). With compare_quantity, the value previously read, the call answers 409 and writes nothing when stock moved at any listed location; read again and resend every location.

set_inventory

Set the same status (active, draft or archived) on several products at once, by id. Each product is updated on its own: the result lists { id, ok, error? } per id plus updated and failed counts, so one bad id never blocks the rest.

bulk_update_product_status

Change fields of one collection by id or handle. Pass only what changes; products move in and out through add_product_ids / remove_product_ids. Returns the collection after the change.

update_collection

Update fields of one object. Pass only what changes; array fields (tags, images) are replaced whole; memberships move through add_collection_ids / remove_collection_ids on a product and add_product_ids / remove_product_ids on a collection.

update_object

Change fields of one product by id or handle. Only the fields passed change; arrays (tags, images, variants) are replaced whole, so an array sent without some of its entries drops them, and collection membership moves through add_collection_ids / remove_collection_ids. Returns the product after the change.

update_product