Get Related Transactions (Partner API)
Kintsugi Partner API — Retrieve transactions related to a specific transaction by its ID.
Documentation Index
Fetch the complete documentation index at: https://docs.trykintsugi.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Headers
The unique identifier for the organization making the request
Path Parameters
Response
Successful Response
Unique identifier of the organization. This field is deprecated, and should no longer be used. The value is populated through the 'x-organization-id' header.
External identifier of the transaction.
1Transaction date and time
The unique transaction identifier.
List of addresses associated.
List of items in the transaction.
The type of transaction (e.g., SALE, REFUND, PARTIAL_CREDIT_NOTE).
SALE, FULL_CREDIT_NOTE, PARTIAL_CREDIT_NOTE, TAX_REFUND, ARCHIVE Indicates if transaction requires tax exemption.
Transaction date in the shop's local timezone
Timezone of the shop
Description of the transaction.
Status of refund, if applicable
FULLY_REFUNDED, PARTIALLY_REFUNDED Total amount of the transaction.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)Unique identifier of the customer.
Indicates if transaction is marketplace-based.
Exemption status (e.g., NOT_EXEMPT)
NOT_EXEMPT, PARTIALLY_EXEMPT, FULLY_EXEMPT, ZERO_RATE_NOT_EXEMPT List of exemptions applied (if any).
Related transaction identifier.
Secondary External Identifier.
Secondary source information
Friendly identifier of the original item.
Imported tax amount.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)Imported tax rate.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,3}|(?=[\d.]{1,13}0*$)\d{0,3}\.\d{0,9}0*$)Calculated tax amount.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)Calculated tax rate.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,3}|(?=[\d.]{1,13}0*$)\d{0,3}\.\d{0,9}0*$)Total tax liability amount.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)Source of tax liability.
CALCULATED, COLLECTED Taxable amount.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)Currency code (ISO 4217, e.g., USD)
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SPL, SRD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TVD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, YER, ZAR, ZMW, ZWD Transaction lock status.
Source platform (e.g., STRIPE)
BIGCOMMERCE, BESTBUY, BUNNY, CHARGEBEE, SHOPIFY, SHOPLINE, STRIPE, AMAZON, TIKTOK, CUSTOM, UNKNOWN, IMPORT, ZUORA, APIDECK, QUICKBOOKS, API, APPLE_APP_STORE, GOOGLE_APP_STORE, WALMART, PAYPAL, NETSUITE, XERO, MAXIO, RECURLY, SALESFORCE, ETSY, EBAY, WIX, SQUARESPACE, WOOCOMMERCE, MAGENTO, BILLING_PLATFORM, DEEL, RIPPLING, GUSTO, FACEBOOK, OTHER, ORDWAY, INSTAGRAM, PINTEREST, WAYFAIR, WISH, POS, TARGET, NEWEGG, GROUPON, GOOGLE_EXPRESS, NOCNOC, MERCADO_LIBRE, MODALYST, NORDSTROM, FAIRE, SHOPWARE, ZOHO, SAGE-INTACCT, AIRWALLEX, ORB, ZENSKAR, MICROSOFT_DYNAMICS_365, KICKSTARTER, INTERNAL_ERP, RILLET, CAMPFIRE, PROVISION, VERTEX_O_SERIES, CHECKOUTCHAMP, DUALENTRY Connection Identifier
Filing identifier.
City of the transaction address.
County of the transaction address.
State of the transaction address.
Country code (ISO Alpha-2).
AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, XK, ZZ_EU Postal code of the transaction.
Tax ID associated with the transaction. DEPRECATED: This field is only populated for QuickBooks integrations and will be removed in a future version.
Transaction status (e.g., COMMITTED)
PENDING, COMMITTED, CANCELLED, FULLY_REFUNDED, PARTIALLY_REFUNDED, INVALID, ARCHIVED Document type distinguishing invoices from sales orders.
INVOICE, SALES_ORDER Identifier of the invoice that created from a sales order.
Address verification status (e.g., VERIFIED).
UNVERIFIED, INVALID, PARTIALLY_VERIFIED, VERIFIED, UNVERIFIABLE, BLANK Status of processing (e.g., ADDRESS_DONE)
NEW, UPDATED, QUEUED, ADDRESS_DONE, EXEMPT_DONE, NEXUS_DONE, PROCESSED, FILING_STARTED, FILING_DONE, LOCKED, PENDING, ARCHIVED, NEEDS_REFETCH, EXCLUDED_IN_CALCULATION Destination currency code (ISO 4217, e.g., USD)
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SPL, SRD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TVD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, YER, ZAR, ZMW, ZWD Converted total amount.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)Converted imported tax amount.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)Converted calculated tax amount.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)Currency conversion rate.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,12}|(?=[\d.]{1,22}0*$)\d{0,12}\.\d{0,9}0*$)Converted taxable amount.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)Converted total discount amount.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)Converted subtotal amount.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)Converted total tax liability amount.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)Display name of the store when the organization has multiple stores for a source.
SALE, PURCHASE 100Customer information associated with the transaction.
Total amount of all discounts applied to the transaction.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)Subtotal amount before any discounts are applied.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)Final total amount including tax liability.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)Converted final total amount including tax liability.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)