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/jsonOptionalpageintegerperPageintegerMust 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>emailstringgatewaysobjectpayment_method_idsobjectcreated_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_fieldstringarchivedstringmanualstringexternal_id_typestringexternal_id_valuestringcashapp_notestringpaypalff_notestringvenmo_notestringcustomer_idstringallbooleanPath Parameters
shopIdRequiredintegerThe shop ID.
Get 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
shopIdRequiredintegerThe shop ID.
invoiceIdRequiredstringThe invoice ID or unique ID.
Archive 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
shopIdRequiredintegerThe shop ID.
invoiceIdRequirednumericThe invoice ID.
Unarchive 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
shopIdRequiredintegerThe shop ID.
invoiceIdRequirednumericThe invoice ID.
Cancel 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
shopIdRequiredintegerThe shop ID.
invoiceIdRequirednumericThe invoice ID.
Refund 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
shopIdRequiredintegerThe shop ID.
invoiceIdRequirednumericThe invoice ID.
Unrefund 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
shopIdRequiredintegerThe shop ID.
invoiceIdRequirednumericThe invoice ID.
Update 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
shopIdRequiredintegerThe shop ID.
invoiceIdRequirednumericThe invoice ID.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerinvoiceIdRequiredintegerProcess 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
shopIdRequiredintegerThe shop ID.
invoiceIdRequirednumericThe invoice ID.
Replace 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
shopIdRequiredintegerThe shop ID.
invoiceIdRequirednumericThe invoice ID.