Invoices
Get Invoices
Retrieves the invoices.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptional0string"STRIPE" | "SQUARE" | "SUMUP" | "MOLLIE" | "SKRILL" | "AUTHORIZENET" | "LEMONSQUEEZY" | "NMI" | "ADYEN" | "SHOPIFY" | "MAZONPS" | "PAYPAL" | "PAYPALFF" | "CASHAPP" | "VENMO" | "BTC" | "LTC" | "MANUAL" | "Stripe" | "Square" | "SumUp" | "Mollie" | "Skrill" | "AuthorizeNet" | "LemonSqueezy" | "NMI" | "AmazonPS" | "PayPal" | "PayPalFF" | "Cashapp" | "Venmo" | "BTC" | "LTC"pageintegerperPageintegerMust be at least 1. Must not be greater than 100.
orderColumnstring"id" | "price_usd" | "paid_usd" | "created_at" | "completed_at"orderDirectionstring"asc" | "desc"idstringstatusesarray<string>emailstringgatewaysobjectcreated_at_startstringMust be a valid date.
created_at_endstringMust be a valid date. Must be a date after created_at_start.
completed_at_startstringMust be a valid date.
completed_at_endstringMust be a valid date. Must be a date after completed_at_start.
product_namestringvariant_namestringcoupon_codestringipstringdiscord_idstringdiscord_usernamestringdeliverablestringcustom_fieldstringarchivedstringmanualstringstripe_pi_idstringpaypal_order_idstringcashapp_notestringpaypalff_notestringvenmo_notestringcustomer_idstringPath Parameters
shopIdRequiredintegerGet Invoice
Retrieves a specific invoice.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerinvoiceIdRequiredstringArchive Invoice
Marks an invoice as archived.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerinvoiceIdRequiredstringUnarchive Invoice
Marks an invoice as unarchived.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerinvoiceIdRequiredstringCancel Invoice
Marks an invoice as cancelled.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerinvoiceIdRequiredstringRefund Invoice
Marks an invoice as refunded.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerinvoiceIdRequiredstringUnrefund Invoice
Unmarks an invoice as refunded.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerinvoiceIdRequiredstringUpdate Invoice Dashboard Note
Updates the invoice dashboard note.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerinvoiceIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerinvoiceIdRequiredstringProcess Invoice
Processes an invoice.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerinvoiceIdRequiredstringReplace Delivered
Replaces the delivered items of an invoice.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredinvoice_item_idRequiredintegerreplacementsRequiredobjectPath Parameters
shopIdRequiredintegerinvoiceIdRequiredstring