Sign in

v2

latestOpenAPI 3.1.02026-07-264249163.7 KB
Reports

Order Reports

Get a detailed list of orders across all order types within a date range.

get/v2/orders/report

Query parameters

start-datestring yyyy-mm-dd required

The UTC start date for the report. Must be in yyyy-mm-dd format.

end-datestring yyyy-mm-dd required

The UTC end date for the report. Must be in yyyy-mm-dd format. Must be on or after start-date and no more than 7 days after it (maximum reportable range: 7 days). Both start-date and end-date are inclusive.

Response

Successful Operation

created_atstring date-time required

The UTC date and time the order was created.

order_uuidstring required

The Sezzle-assigned order identifier. This is the same order ID merchants see in the Merchant Dashboard, and is distinct from order_platform_uuid (the platform-specific identifier).

order_platform_uuidstring

The platform-specific identifier for the order.

customer_namestring

The shopper's name as captured at checkout.

customer_emailstring

The shopper's email as captured at checkout.

external_reference_idstring

The merchant-supplied reference for the order.

customer_currency_codestring required

The ISO-4217 currency the shopper paid in.

merchant_currency_codestring required

The ISO-4217 currency the merchant settles in.

order_amount_in_centsinteger required

The gross order amount, in cents.

captured_amount_in_centsinteger required

The amount captured against the order so far, in cents.

uncaptured_amount_in_centsinteger required

The authorized amount not yet captured, in cents.

total_fees_in_centsinteger required

The total Sezzle fees on captured amounts, in cents.

net_amount_in_centsinteger required

The captured amount minus fees and refunds, in cents.

refund_fee_in_centsinteger

The portion of fees refunded back to the merchant, in cents. Not the order refund amount itself.

released_amount_in_centsinteger

The authorized amount released without being captured, in cents.

order_type'Standard Checkout' | 'Virtual Card' | 'Express Checkout' | 'Affiliate' | 'Gift Card' | 'Pay In Full' | 'Six Pay Monthly' | 'Four Pay Monthly' | 'Long Term Lending' required

The display label for the order type.

financing_option'4-pay-biweekly' | '4-pay-monthly' | '6-pay-monthly' | '2-pay-biweekly' | '5-pay-biweekly' | 'pay-in-full'

The installment plan applied to the order. Empty for order types without an installment plan.