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.| Parameter | Values |
|---|
status | upcoming, active, complete, to_fulfill, to_receive, to_restock, cancelled |
method_type | calendar, subscription, membership, resale |
packing_status | pending, printed, packed |
rental_start_from / rental_start_to | Date range for rental start |
customer_email | Partial match |
item_title | Partial match |
include_customer, include_item, include_order, include_line_item. Get full details of a single cycle by ID.| Parameter | Required | Description |
|---|
id | Yes | Cycle ID (e.g. SC-1234) |
Update a cycle’s packing status, dates, or item assignment. Requires confirmation.| Parameter | Description |
|---|
id | Cycle ID (required) |
packing_status | pending, printed, packed |
item_id | Item ID to assign |
rental_start / rental_end | Reschedule dates (YYYY-MM-DD) |
fulfilled_at / received_at | Mark as fulfilled or received (YYYY-MM-DD) |
Inventory
List inventory items filtered by visibility, status, condition, and availability.| Parameter | Values |
|---|
visibility | available, unavailable, sold, retired |
processing_status | unprocessed, processed |
available | true (not rented), false (currently rented) |
product_title | Partial match |
sku | Partial match |
condition_id | Filter by condition |
Customers
List customers filtered by activity, value, and balance.| Parameter | Description |
|---|
customer_email | Partial match |
name | Partial match |
has_active_rentals | true or false |
lifetime_value_min_cents | Minimum lifetime value |
outstanding_balance_min_cents | Minimum outstanding balance |
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.| Parameter | Values |
|---|
status | requested, expected, received, in_progress, completed, cancelled |
receival_status | unreceived, partially_received, received |
credit_status | uncredited, partially_recredited, recredited |
incomplete | true to show only incomplete returns |
customer_email | Partial match |
include_customer, include_return_lines. Get full details of a single return by ID.| Parameter | Required | Description |
|---|
id | Yes | Return ID (e.g. #2001) |
Create a return order for a customer. Requires confirmation.| Parameter | Required | Description |
|---|
customer_id | Yes | Customer email or Shopify ID |
rental_ids | Yes | Array of rental IDs (e.g. ['SC-1042', 'SC-1043']) |
return_method_type | No | collection or return_label |
Update a return order’s status or return line statuses. Requires confirmation.| Parameter | Description |
|---|
id | Return ID (required) |
status | requested, expected, received, in_progress, completed, cancelled |
return_lines | Array of { id, status } where status is awaiting, received, or missing |
Charges
List charges with optional status filtering.| Parameter | Description |
|---|
status | paid, unpaid, cancelled (default: all) |
customer_email | Partial match |
amount_min_cents / amount_max_cents | Filter by amount |
category_type | Checkout, Generic, BillingCycle |
include_customer, include_dunning.
Pricing
List pricing options for a given method, filtered by product and price range.| Parameter | Required | Description |
|---|
method_type | Yes | subscription, membership, calendar, resale |
product_id | No | Filter by product |
price_min_cents / price_max_cents | No | Filter by price |
