List tools support pagination (
page, per_page max 100), sorting (sort, sort_direction), and date filtering (created_after, created_before, updated_after, updated_before) in YYYY-MM-DD format.Cycles
- list_cycles
- get_cycle
- update_cycle
List cycles filtered by status, method, dates, and packing status.
Optionally include related data with
include_customer, include_item, include_order, include_line_item.Inventory
- list_items
List inventory items filtered by visibility, status, condition, and availability.
Returns item ID, product/variant title, SKU, serial, visibility, condition, and pick location.
Customers
- list_customers
List customers filtered by activity, value, and balance.
Sortable by
lifetime_value_cents, rentals_count, outstanding_balance_cents.Returns
- list_returns
- get_return
- create_return
- update_return
List returns filtered by status, receival, and credit status.
Optionally include related data with
include_customer, include_return_lines.Charges
- list_charges
List charges with optional status filtering.
Optionally include related data with
include_customer, include_dunning.Pricing
- list_method_options
List pricing options for a given method, filtered by product and price range.
Returns method-specific fields (e.g. recurring price and billing interval for subscriptions, duration for calendar).
Availability
- create_blocked_date
Block an item, variant, or product from being booked over a date range. Requires confirmation.
At least one of
from or to must be provided. Dates are day-bounded in the shop timezone.Tags
- add_tag
- remove_tag
Comments
- add_comment
Add a comment/note to a cycle, item, customer, or return. Requires confirmation.