ticketspice_list_forms
List events
List the account's TicketSpice forms (ticketed events / order pages): id, name, status (open, closed, scheduled or archived), created and updated dates. Use the form ids to filter orders, tickets and transactions. GET /forms.
輸入參數sortlimitcreated_afterupdated_aftercreated_beforestarting_afterupdated_before
ticketspice_get_form
Get event
One form by id: name, status, accounting reference, time zone and its field layout. GET /forms/{id}.
輸入參數form_id必填
ticketspice_get_form_inventory
Get form inventory
Inventory items of a form (limited-quantity items): path, name, sold and remaining quantity. GET /forms/{id}/inventory.
輸入參數form_id必填
ticketspice_list_orders
List orders
List orders (one per checkout): order number, buyer billing name and address, form, total, currency and status, newest or oldest first. Filter by event (form), status, buyer email, customer id, order number or dates. GET /search/orders.
輸入參數sortemaillimitstatusform_idcustomer_idorder_numbercreated_afterupdated_aftercreated_beforestarting_afterupdated_before
ticketspice_get_order
Get order
One order by id with the buyer's billing details, event, totals and status. Set include_tickets to embed the order's tickets and include_transactions its payments (charges and refunds). GET /search/orders/{id}.
輸入參數order_id必填include_ticketsinclude_transactions
ticketspice_list_transactions
List transactions
List payment transactions (money movements): amount, currency, type (charge, refund, voucher), payment method, masked card, status, form and buyer email. Filter by type, method, form, order, donor or dates. GET /search/transactions.
輸入參數sorttypeemaillimitstatusform_idorder_idreferencecustomer_idorder_numbercreated_afterupdated_after另有 4 個
ticketspice_get_transaction
Get transaction
One transaction by id: amounts, type, payment method, masked card, gateway message and status. GET /search/transactions/{id}.
輸入參數transaction_id必填
ticketspice_list_tickets
List tickets
List sold tickets (one record per ticket): id, buyer billing name, event, ticket level, amount, fee, total, status, scan count and last scan time, event date. Filter by event (form), status, order, buyer email, customer id or dates. Use it for attendee lists and check-in status. GET /search/tickets.
輸入參數sortemaillimitstatusform_idorder_idcustomer_idorder_numbercreated_afterupdated_aftercreated_beforestarting_after另有 2 個
ticketspice_get_ticket
Get ticket
One ticket by id: buyer, event, level, amount, fee, total, status, scan count, last scan time and the buyer's form answers. GET /search/tickets/{id}.
輸入參數ticket_id必填
ticketspice_list_customers
List customers
List customer records (buyers): id, email, billing name and address, total spent, created and updated dates. Filter by email or dates. New customers can take up to 5 minutes to appear. GET /search/customers.
輸入參數sortemaillimitcreated_afterupdated_aftercreated_beforestarting_afterupdated_before
ticketspice_get_customer
Get customer
One customer record by id: email, billing details and total of the customer's transactions. GET /search/customers/{id}.
輸入參數customer_id必填
ticketspice_list_coupons
List coupons
List TicketSpice coupons: account-wide ones, or only those of one form when form_id is given. Shows discounts, codes, availability, redeemed count and expiry. GET /coupons/global or /coupons/forms/{id}.
輸入參數codesortlimitform_idstarting_after
ticketspice_get_coupon
Get coupon
One coupon by id with its discounts, codes, availability and redeemed counts. GET /coupons/{id}.
輸入參數coupon_id必填
ticketspice_create_coupon
Create coupon
WRITE: create a discount coupon in the live TicketSpice account (it can be redeemed by ticket buyers right away). One discount (fixed amount or percent) and one or more codes; optionally limited to one form, to a number of uses, and to an expiry date. Not idempotent: calling it twice creates two coupons. POST /coupons.
輸入參數name必填codes必填expiresform_idcurrencyavailableper_ticketdiscount_type必填discount_value必填
ticketspice_delete_coupon
Delete coupon
WRITE: permanently delete a coupon from the live TicketSpice account; its codes stop working immediately and this cannot be undone. Show the coupon (ticketspice_get_coupon) and get the user's approval first, then call with confirm: true. GET /coupons/{id}, then DELETE /coupons/{id}.
輸入參數confirm必填coupon_id必填