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.Outbound fulfillments
Outbound fulfillments are the packing queue: each one groups the cycles going out to a customer together, so one update moves every cycle travelling together.- list_outbound_fulfillments
- get_outbound_fulfillment
- update_outbound_fulfillment
List the outbound fulfillment queue with status and date filters.
Sortable by
created_at, fulfill_by, or arrive_by. Each fulfillment carries its schedule dates, customer, and the cycles going out together with their packing statuses.Inbound receivals
Inbound receivals are the receiving queue: each one groups the cycles coming back from a customer together.- list_inbound_receivals
- get_inbound_receival
- update_inbound_receival
List the inbound receival queue with status and date filters.
Sortable by
created_at, receive_by, or return_by. Each receival carries its schedule dates, customer, and the cycles coming back together.Inventory
- list_items
- get_item
- update_item
List inventory items filtered by visibility, status, condition, and availability.
Returns item ID, product/variant title, SKU, serial, visibility, condition, and pick location.
Products
- list_products
- get_product
List catalog products filtered by title, status, and enabled cycle methods.
Sortable by
created_at or title. Returns per-product method flags plus variant and item counts.Customers
- list_customers
- get_customer
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
- get_charge
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
- check_availability
- list_blocked_dates
- create_blocked_date
- delete_blocked_date
Check whether a product or variant can be booked for a date range, accounting for the preparation, delivery, return, and restock time from your logistics buffers around both the proposed booking and existing reservations.
Returns, per variant: a bookable verdict with item counts, the contiguous available windows around the requested dates, and per-item conflicts showing each block’s padded date range and the cycle causing it. When transit time is the only blocker, an alternative verdict for pick-up delivery with drop-off return is included. Checks up to 10 matching variants.
Tags
- add_tag
- remove_tag
Comments
- list_comments
- add_comment
List the comments/notes on a cycle, item, customer, or return, newest first.
Each comment includes its message, author, and timestamp.